brotli README

The project's README from github.com/google/brotli. As one markdown file: README.md.

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 uncompressed data length. It is possible to modify "raw" ranges of the compressed stream and the decoder will not notice that.

Installation

In most Linux distributions, installing brotli is just a matter of using the package management system. For example in Debian-based distributions: apt install brotli will install brotli. On MacOS, you can use Homebrew: brew install brotli.

brotli packaging status

Of course you can also build brotli from sources.

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 compression framework with fast FFI-based Brotli implementation with ready-to-use prebuilt binaries for Win/Linux/Mac

brotli (google/brotli)

Searching Database…

14.9K ·GitHub
Brotli
What is this?Brotli is Google's general-purpose lossless compression algorithm, combining a modern LZ77 variant, Huffman coding and 2nd order context modeling. It runs at about deflate's speed but compresses denser.
So is it a file format, a library, or a command-line tool?All three: the data format is standardized in RFC 7932, this repo builds a brotli CLI plus libraries, and there are bindings like the official Python module and an npm-installable JS decoder.
Any gotchas I should know about the format itself?Brotli is a pure stream format with no checksums or stored uncompressed length, so modified raw ranges can decode without the decoder noticing. Add your own integrity layer if tampering matters.
Does it work from JavaScript or other languages?The official repo ships the native library plus the Python module; for JS the README points to an independent decoder via npm install brotli, and a Haxe port that also emits PHP, Python, Java and C#.
Is it free to use in commercial projects?Yes — the code is open-sourced under the MIT License.
Where can I see actual benchmark numbers?The README links to third-party benchmarks: the Squash Compression Benchmark, the Large Text Compression Benchmark and the Lzturbo Benchmark.
Are there Brotli implementations for other languages and apps?Yes: a Haxe port that outputs JavaScript, PHP, Python, Java and C#, a Dart compression framework with FFI-based Brotli and prebuilt binaries for Windows, Linux and Mac, a 7Zip plugin, and Mark Adler's independent decoder written from the format spec.
How mature is the project?It has lived under Google's GitHub org since 2014, has about 15k stars, and its CI runs build tests, WASM builds, CodeQL analysis, fuzzing and linting.
What are similar projects?guetzli, zstd, TurboBench, lz4, lossless-cut, headroom, pyrowave, liteparse
Which topics is it in?lossless, codec, pip, compression, algorithm, google, homebrew, performance, command-line-tool, npm, tool, library
Creator
google
Size
41.9 MB
Stars
14.9K
Updated
CommitOct 12Releasev1.2.0Oct 27
Age
12y
Commits · 90 Days