Brotli compression format
C Java Python C++ CMake Shell Other
Latest commit aaac88a Feb 20, 2017 @eustas eustas committed on GitHub Switch to 0.2.0-SNAPSHOT (#515)
Permalink
Failed to load latest commit information.
appveyor [appveyor/install.ps1] remove unused functions for miniconda Oct 7, 2015
common Update encoder (#504) Feb 6, 2017
dec Fix "zero-distance-code", take 2 (#506) Feb 8, 2017
docs Update the spec reference to RFC 7932, remove the old internet draft. Aug 2, 2016
enc Update encoder (#504) Feb 6, 2017
fuzz Do not assume that bash is installed in /bin (#477) Dec 9, 2016
include/brotli Blacklist PGI from using conformant array parameters. (#511) Feb 19, 2017
java Switch to 0.2.0-SNAPSHOT (#515) Feb 20, 2017
python Python: Create Makefile for development shortcuts (#488) Dec 21, 2016
research Research (#491) Dec 22, 2016
terryfy @ 8bb673f add support for Travis CI (OS X only for now) Aug 14, 2015
tests Do not assume that bash is installed in /bin (#477) Dec 9, 2016
tools bro: check return values of chown and chmod (#465) Nov 2, 2016
.configure-custom.sh Add configure-cmake (#474) (#486) Dec 20, 2016
.gitignore Python: Simplify test suite generation by using unittest discovery (#485 Dec 20, 2016
.gitmodules Replace sais.hxx by submodule hillbig/esaxx. Sep 19, 2016
.travis.sh Blacklist PGI from using conformant array parameters. (#511) Feb 19, 2017
.travis.yml Blacklist PGI from using conformant array parameters. (#511) Feb 19, 2017
BUILD Remove the underscore in the name of brotli libraries. #326 Oct 12, 2016
CMakeLists.txt Update encoder (#504) Feb 6, 2017
CONTRIBUTING.md Apply 80-chars limit to CONTRIBUTING.md Feb 18, 2016
LICENSE Prepare to release 0.4.0 Jun 14, 2016
MANIFEST.in Move "public" to "include/brotli" Aug 23, 2016
Makefile Update docs and add more java tests (#463) Oct 31, 2016
README.md Python: Create Makefile for development shortcuts (#488) Dec 21, 2016
WORKSPACE Add Java port of Brotli decoder. Oct 17, 2016
appveyor.yml Python: Run Appveyor tests in CMD mode (#461) Oct 27, 2016
configure Do not assume that bash is installed in /bin (#477) Dec 9, 2016
configure-cmake Add configure-cmake (#474) (#486) Dec 20, 2016
premake5.lua Remove the underscore in the name of brotli libraries. #326 Oct 12, 2016
setup.cfg Python: Update README with information about code formatting Oct 17, 2016
setup.py Update encoder (#504) Feb 6, 2017

README.md

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 Status

Build instructions

Make

To build and run tests, simply do:

$ ./configure && make

If you want to install brotli, use one of the more advanced build systems below.

Bazel

See Bazel

CMake

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

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

You can use other CMake configuration. For example, to build static libraries and use a custom installation directory:

$ mkdir out-static && \
  cd out-static && \
  ../configure-cmake --disable-shared-libs --prefix='/my/prefix/dir/'
$ make install

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

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