630b5084ee
* slimmer stack frames in encoder * fix MSAN problem in hasher_composite (not dangerous, only in large_window mode) * fix JNI decoder wrapper - power-of-two payloads fail to decode sometimes * reformat polyfil.js and decode_test.js |
||
|---|---|---|
| .github/workflows | ||
| c | ||
| csharp | ||
| docs | ||
| fetch-spec | ||
| go | ||
| java | ||
| js | ||
| python | ||
| research | ||
| scripts | ||
| tests | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| .travis.yml | ||
| bootstrap | ||
| BUILD | ||
| CMakeLists.txt | ||
| compiler_config_setting.bzl | ||
| configure | ||
| configure-cmake | ||
| configure.ac | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| Makefile | ||
| Makefile.am | ||
| MANIFEST.in | ||
| premake5.lua | ||
| README | ||
| README.md | ||
| setup.cfg | ||
| setup.py | ||
| WORKSPACE | ||
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
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
- Squash Compression Benchmark / Unstable Squash Compression Benchmark
- Large Text Compression Benchmark
- Lzturbo Benchmark
Related projects
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