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
Что это такое?Brotli — это универсальный алгоритм сжатия без потерь от Google, сочетающий современный вариант LZ77, кодирование Хаффмана и контекстное моделирование второго порядка. Работает примерно на скорости deflate, но сжимает плотнее.
Так это формат файла, библиотека или утилита командной строки?И то, и другое, и третье: формат данных стандартизирован в RFC 7932, этот репозиторий собирает CLI-утилиту brotli вместе с библиотеками, а ещё есть биндинги — например, официальный модуль для Python и JS-декодер, который ставится через npm.
Есть ли подводные камни в самом формате, о которых стоит знать?Brotli — чисто потоковый формат без контрольных сумм и без хранения длины несжатых данных, поэтому изменённые участки сырого потока могут распаковаться, а декодер этого даже не заметит. Если важна защита от подмены данных, добавьте свой слой проверки целостности.
А можно использовать из JavaScript или других языков?В официальном репозитории лежит нативная библиотека и модуль для Python; для JS в README предложен независимый декодер, который ставится через npm install brotli, а также порт на Haxe, который заодно выдаёт код на PHP, Python, Java и C#.
Можно ли свободно использовать в коммерческих проектах?Да — код открыт под лицензией MIT License.
Где посмотреть реальные цифры из бенчмарков?В README есть ссылки на сторонние бенчмарки: Squash Compression Benchmark, Large Text Compression Benchmark и Lzturbo Benchmark.
Есть ли реализации Brotli для других языков и приложений?Да: порт на Haxe, который выдаёт JavaScript, PHP, Python, Java и C#; фреймворк сжатия для Dart с Brotli через FFI и готовыми бинарниками для Windows, Linux и Mac; плагин для 7Zip; а также независимый декодер Марка Адлера, написанный по спецификации формата.
Насколько проект зрелый?Он живёт в организации Google на GitHub с 2014 года, у него около 15 тысяч звёзд, а в CI гоняются сборочные тесты, WASM-сборки, анализ CodeQL, фаззинг и линтеры.
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