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 中标准化，这个仓库会构建 brotli 命令行工具和各个库，另外还有绑定，比如官方的 Python 模块，以及可以通过 npm 安装的 JS 解码器。
关于这个格式本身，有什么坑需要提前知道？Brotli 是一种纯流式格式，没有校验和，也不存储未压缩数据的长度，所以原始数据被局部篡改后，解码器可能毫无察觉地正常解码。如果你在意数据是否被篡改，需要自己加一层完整性校验。
能在 JavaScript 或其他语言里用吗？官方仓库提供原生库和 Python 模块；JS 方面，README 指向一个通过 npm install brotli 安装的独立解码器，还有一个 Haxe 移植版，它也能输出 PHP、Python、Java 和 C#。
可以在商业项目里免费使用吗？可以——代码以 MIT 许可证开源。
在哪里能看到真实的跑分数据？README 里链接了第三方测试：Squash Compression Benchmark、Large Text Compression Benchmark 和 Lzturbo Benchmark。
其他语言和应用有 Brotli 的实现吗？有：一个能输出 JavaScript、PHP、Python、Java 和 C# 的 Haxe 移植版；一个带基于 FFI 的 Brotli 并为 Windows、Linux 和 Mac 提供预编译二进制文件的 Dart 压缩框架；一个 7Zip 插件；以及 Mark Adler 从格式规范出发独立编写的解码器。
这个项目成熟度怎么样？从 2014 年起就一直放在 Google 的 GitHub 组织下，大约有 1.5 万颗星，它的 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