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

Build instructions

Autotools-style CMake

configure-cmake is an autotools-style configure script for CMake-based projects.

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

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

To build static libraries use --disable-shared-libs argument:

$ mkdir out-static && cd out-static
$ ../configure-cmake --disable-shared-libs
$ make install

Bazel

See Bazel

CMake

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

$ mkdir out && cd out
$ cmake ..
$ make
$ make test
$ make install

You can use other CMake configuration. For example, to build static libraries:

$ mkdir out-static && cd out-static
$ cmake .. -DBUILD_SHARED_LIBS=OFF
$ make

Premake5

See Premake5

Python

To install the Python module from source, run the following:

$ python setup.py install

See the Python readme for more details on testing and development.

Benchmarks

• Squash Compression Benchmark / Unstable Squash Compression Benchmark
• Large Text Compression Benchmark
• Lzturbo Benchmark

Related projects

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#