| commit | e9b278ac6e097beb763e8a46eeafcaa3f6f63f18 | [log] [tgz] |
|---|---|---|
| author | Eugene Kliuchnikov <eustas@google.com> | Mon Oct 31 14:33:59 2016 +0100 |
| committer | GitHub <noreply@github.com> | Mon Oct 31 14:33:59 2016 +0100 |
| tree | 15438c3a37a4df3d9bf8e782053d1e42daf44374 | |
| parent | a260b6ba73e0b0eab6d7e7385dbaa476d36f30ab [diff] |
Update docs and add more java tests (#463) * doxygenize and update API documentation * fix spelling * add "fuzz" corpus for java decoder to improve coverage * use upper-case-snake names for dictionary constant definitions * use `LDFLAGS` in conventional `Makefile`
- Makefile[diff]
- common/dictionary.h[diff]
- dec/bit_reader.c[diff]
- dec/bit_reader.h[diff]
- dec/decode.c[diff]
- dec/port.h[diff]
- dec/state.h[diff]
- dec/transform.h[diff]
- enc/backward_references.h[diff]
- enc/backward_references_inc.h[diff]
- enc/block_splitter_inc.h[diff]
- enc/brotli_bit_stream.c[diff]
- enc/compress_fragment.c[diff]
- enc/compress_fragment_two_pass.c[diff]
- enc/encode.c[diff]
- enc/entropy_encode.c[diff]
- enc/entropy_encode.h[diff]
- enc/hash.h[diff]
- enc/hash_forgetful_chain_inc.h[diff]
- enc/hash_longest_match_inc.h[diff]
- enc/hash_longest_match_quickly_inc.h[diff]
- enc/literal_cost.c[diff]
- enc/literal_cost.h[diff]
- enc/metablock.c[diff]
- enc/quality.h[diff]
- enc/ringbuffer.h[diff]
- enc/utf8_util.h[diff]
- include/brotli/decode.h[diff]
- include/brotli/encode.h[diff]
- include/brotli/types.h[diff]
- java/integration/BUILD[diff]
- java/integration/BundleChecker.java[diff]
- java/integration/fuzz_data.zip[Added - diff]
- java/integration/pom.xml[diff]
- appveyor/
- common/
- dec/
- docs/
- enc/
- include/
- java/
- python/
- research/
- tests/
- tools/
- terryfy
- .gitignore
- .gitmodules
- .travis.sh
- .travis.yml
- appveyor.yml
- BUILD
- CMakeLists.txt
- configure
- CONTRIBUTING.md
- LICENSE
- Makefile
- MANIFEST.in
- premake5.lua
- README.md
- setup.cfg
- setup.py
- WORKSPACE
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
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 && 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 && \ cmake .. -DBUILD_SHARED_LIBS=0 -DCMAKE_INSTALL_PREFIX='/my/install/dir/' $ make install
Premake5
See Premake5
Python
The basic commands to build, test, and install the Python module are:
$ python setup.py build test $ python setup.py install
See the Python readme for more details.
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