Brotli compression format
Go to file
Evgenii Kliuchnikov 0dff3e5b0d fix CI workflows
PiperOrigin-RevId: 585630137
2023-11-27 06:09:48 -08:00
.github fix CI workflows 2023-11-27 06:09:48 -08:00
c fix wording 2023-10-26 02:03:20 -07:00
csharp Transpile Java speedup (#548) 2017-05-07 17:40:12 +02:00
docs simplify CMake build 2023-07-30 03:45:11 -07:00
fetch-spec Update shared-brotli-fetch-spec.txt 2017-11-17 01:38:05 +01:00
go more sophisticated golang TestEncoderFlush 2023-08-29 04:00:29 -07:00
java Replace TS strict_checks with source-level suppressions. 2023-08-10 04:46:01 -07:00
js Replace TS strict_checks with source-level suppressions. 2023-08-10 04:46:01 -07:00
python Small Python modernization of Brotli code. 2023-07-19 05:44:36 -07:00
research fix wording 2023-10-26 02:03:20 -07:00
scripts upload full testdata archive 2023-09-13 05:13:57 -07:00
tests reword cmake test generator warning 2023-09-11 07:08:50 -07:00
.editorconfig Add an EditorConfig file to provide consistent style across editors. (#579) 2017-08-02 16:58:43 +02:00
.gitattributes upload full testdata archive 2023-09-13 05:13:57 -07:00
.gitignore Add *.d to gitignore (#975) 2022-12-21 09:52:31 +01:00
BUILD.bazel simplify building of fuzzer 2023-07-10 11:43:27 +00:00
CHANGELOG.md prepare for 1.1.0rc 2023-08-21 03:35:01 -07:00
CMakeLists.txt add an option to disable brotli tools 2023-11-27 03:13:14 -08:00
compiler_config_setting.bzl Internal changes 2023-07-04 07:55:25 +00:00
CONTRIBUTING.md mention used code style 2023-08-02 03:47:37 -07:00
LICENSE Prepare to release 0.4.0 2016-06-14 15:07:13 +02:00
MANIFEST.in Change MANIFEST.in to include python regression tests in tarball (#841) 2020-09-21 13:24:13 +02:00
pyproject.toml add pyproject.toml (#987) 2022-11-15 18:39:13 +01:00
README Fix #741 2019-02-18 11:31:48 +01:00
README.md add links to other pages to README.md 2023-08-03 01:15:22 -07:00
SECURITY.md Add security policy (#996) 2023-01-03 18:24:47 +01:00
setup.cfg Fix for future versions of python (#911) 2022-01-10 13:08:10 +03:00
setup.py setup.py: add long_description (#1073) 2023-09-07 11:28:09 +02:00
WORKSPACE.bazel simplify building of fuzzer 2023-07-10 11:43:27 +00:00

GitHub Actions Build Status Fuzzing Status

Brotli

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.

Please note: brotli is a "stream" format; it does not contain meta-information, like checksums or uncompresssed data length. It is possible to modify "raw" ranges of the compressed stream and the decoder will not notice that.

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.

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.

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.

Contributing

We glad to answer/library related questions in brotli mailing list.

Regular issues / feature requests should be reported in issue tracker.

For reporting vulnerability please read SECURITY.

For contributing changes please read CONTRIBUTING.

Benchmarks

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