You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Anonymous Maarten 9801a2c5d6
Wrap interface include directories with BUILD_INTERFACE generator expression (#966)
2 months ago
.github/workflows Migrate to github actions (#920) 10 months ago
c Merge pull request #929 from jbms/fix-vla-parameter 7 months ago
csharp Transpile Java speedup (#548) 5 years ago
docs Strip "./" in includes (#925) 10 months ago
fetch-spec Update shared-brotli-fetch-spec.txt 5 years ago
go Prepare for copybara (#939) 8 months ago
java Prepare for copybara (#939) 8 months ago
js Update (#918) 11 months ago
python Prepare for copybara (#939) 8 months ago
research Prepare for copybara (#939) 8 months ago
scripts Migrate to github actions (#920) 10 months ago
tests Fix build files (#829) 2 years ago
.editorconfig Add an EditorConfig file to provide consistent style across editors. (#579) 5 years ago
.gitattributes Re-add python bindings to sources tarball 2 years ago
.gitignore .gitignore: Ignore .obj files (#805) 2 years ago
BUILD Update (#918) 11 months ago
CMakeLists.txt Wrap interface include directories with BUILD_INTERFACE generator expression (#966) 2 months ago
CONTRIBUTING.md Apply 80-chars limit to CONTRIBUTING.md 6 years ago
LICENSE Prepare to release 0.4.0 6 years ago
MANIFEST.in Change MANIFEST.in to include python regression tests in tarball (#841) 2 years ago
Makefile make/build: ensure NEON is enabled and tested (#718) 4 years ago
Makefile.am Fix missing symbols errors in libbrotlienc and dec (#623) 5 years ago
README Fix #741 3 years ago
README.md Update README.md 10 months ago
WORKSPACE Inverse bazel project/workspace tree (#677) 4 years ago
bootstrap bootstrap: Fix exit code when autoreconf fails (#962) 2 months ago
compiler_config_setting.bzl Update (#807) 2 years ago
configure Update (#620) 5 years ago
configure-cmake Move files & update paths (#541) 5 years ago
configure.ac Migrate to github actions (#920) 10 months ago
premake5.lua Added windows platform support to premake (#567) 5 years ago
setup.cfg Fix for future versions of python (#911) 6 months ago
setup.py Merge-in SharedDictionary feature (#916) 11 months ago

README.md

Brotli

SECURITY NOTE

Please consider updating brotli to version 1.0.9 (latest).

Version 1.0.9 contains a fix to "integer overflow" problem. This happens when "one-shot" decoding API is used (or input chunk for streaming API is not limited), input size (chunk size) is larger than 2GiB, and input contains uncompressed blocks. After the overflow happens, memcpy is invoked with a gigantic num value, that will likely cause the crash.

Introduction

Brotli is a generic-purpose lossless compression algorithm that compresses data using a combination of a modern variant of the LZ77 algorithm, Huffman coding and 2nd order context modeling, with a compression ratio comparable to the best currently available general-purpose compression methods. It is similar in speed with deflate but offers more dense compression.

The specification of the Brotli Compressed Data Format is defined in RFC 7932.

Brotli is open-sourced under the MIT License, see the LICENSE file.

Brotli mailing list: https://groups.google.com/forum/#!forum/brotli

GitHub Actions Build Status Fuzzing Status

Build instructions

Vcpkg

You can download and install brotli using the vcpkg dependency manager:

git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
./bootstrap-vcpkg.sh
./vcpkg integrate install
./vcpkg install brotli

The brotli port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please create an issue or pull request on the vcpkg repository.

Autotools-style CMake

configure-cmake is an autotools-style configure script for CMake-based projects (not supported on Windows).

The basic commands to build, test and install brotli are:

$ mkdir out && cd out
$ ../configure-cmake
$ make
$ make test
$ make install

By default, debug binaries are built. To generate "release" Makefile specify --disable-debug option to configure-cmake.

Bazel

See Bazel

CMake

The basic commands to build and install brotli are:

$ mkdir out && cd out
$ cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=./installed ..
$ cmake --build . --config Release --target install

You can use other CMake configuration.

Premake5

See Premake5

Python

To install the latest release of the Python module, run the following:

$ pip install brotli

To install the tip-of-the-tree version, run:

$ pip install --upgrade git+https://github.com/google/brotli

See the Python readme for more details on installing from source, development, and testing.

Benchmarks

Disclaimer: Brotli authors take no responsibility for the third party projects mentioned in this section.

Independent decoder implementation by Mark Adler, based entirely on format specification.

JavaScript port of brotli decoder. Could be used directly via npm install brotli

Hand ported decoder / encoder in haxe by Dominik Homberger. Output source code: JavaScript, PHP, Python, Java and C#

7Zip plugin

Dart native bindings

Dart compression framework with fast FFI-based Brotli implementation with ready-to-use prebuilt binaries for Win/Linux/Mac