Brotli compression format
Go to file
Eugene Kliuchnikov 11df843cf0 Update encoder (#504)
* pull `BROTLI_MAX_BACKWARD_LIMIT` to constants
 * split generic and Zopfli backward references code
 * pull hashers init and stitch invocation to encoder
 * make `dictionary_hash` a compilation unit
 * add `size hint` parameter
 * add new hasher
 * use `size hint` to pick new hasher for q4
 * modernize clz guard (fix #495)
 * move `hash to binary tree` to separate file
 * add `Initialize` and `Cleanup` to all hashers
 * do not raise OOM if malloc(0) == NULL (fix #500)
2017-02-06 14:20:43 +01:00
appveyor [appveyor/install.ps1] remove unused functions for miniconda 2015-10-07 12:46:16 +01:00
common Update encoder (#504) 2017-02-06 14:20:43 +01:00
dec Added fuzzer and updated decoder (#475) 2016-12-08 12:55:18 +01:00
docs Update the spec reference to RFC 7932, remove the old internet draft. 2016-08-02 13:27:29 +02:00
enc Update encoder (#504) 2017-02-06 14:20:43 +01:00
fuzz Do not assume that bash is installed in /bin (#477) 2016-12-09 08:58:13 +01:00
include/brotli Update encoder (#504) 2017-02-06 14:20:43 +01:00
java Update (#470) 2016-11-30 13:36:20 +01:00
python Python: Create Makefile for development shortcuts (#488) 2016-12-21 10:17:11 +01:00
research Research (#491) 2016-12-22 13:03:28 +01:00
terryfy@8bb673f441 add support for Travis CI (OS X only for now) 2015-08-14 11:28:26 +01:00
tests Do not assume that bash is installed in /bin (#477) 2016-12-09 08:58:13 +01:00
tools bro: check return values of chown and chmod (#465) 2016-11-02 14:03:06 +01:00
.configure-custom.sh Add configure-cmake (#474) (#486) 2016-12-20 17:45:40 +01:00
.gitignore Python: Simplify test suite generation by using unittest discovery (#485) 2016-12-20 14:40:47 +01:00
.gitmodules Replace sais.hxx by submodule hillbig/esaxx. 2016-09-19 19:12:30 +02:00
.travis.sh Python: Use "build" instead of "build_ext" in scripts (#460) 2016-10-31 12:58:45 +01:00
.travis.yml Fix OSX gcc-4.x compilation (#455) 2016-10-20 14:16:00 +02:00
appveyor.yml Python: Run Appveyor tests in CMD mode (#461) 2016-10-27 17:25:05 +02:00
BUILD Remove the underscore in the name of brotli libraries. #326 2016-10-12 18:24:04 +02:00
CMakeLists.txt Update encoder (#504) 2017-02-06 14:20:43 +01:00
configure Do not assume that bash is installed in /bin (#477) 2016-12-09 08:58:13 +01:00
configure-cmake Add configure-cmake (#474) (#486) 2016-12-20 17:45:40 +01:00
CONTRIBUTING.md Apply 80-chars limit to CONTRIBUTING.md 2016-02-18 15:20:59 +01:00
LICENSE Prepare to release 0.4.0 2016-06-14 15:07:13 +02:00
Makefile Update docs and add more java tests (#463) 2016-10-31 14:33:59 +01:00
MANIFEST.in Move "public" to "include/brotli" 2016-08-23 14:40:33 +02:00
premake5.lua Remove the underscore in the name of brotli libraries. #326 2016-10-12 18:24:04 +02:00
README.md Python: Create Makefile for development shortcuts (#488) 2016-12-21 10:17:11 +01:00
setup.cfg Python: Update README with information about code formatting 2016-10-17 13:57:56 -04:00
setup.py Update encoder (#504) 2017-02-06 14:20:43 +01:00
WORKSPACE Add Java port of Brotli decoder. 2016-10-17 14:04:59 +02:00

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

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

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