MCPcopy
hub / github.com/google/brotli

github.com/google/brotli @v1.2.0 sqlite

repository ↗ · DeepWiki ↗ · release v1.2.0 ↗
1,200 symbols 3,141 edges 90 files 318 documented · 26%
README

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

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

Extension points exported contracts — how you extend this code

PreparedDictionary (Interface)
Prepared dictionary data provider. [5 implementers]
java/org/brotli/enc/PreparedDictionary.java
BrotliDecodeOptions (Interface)
(no doc)
js/decode.ts

Core symbols most depended-on inside this repo

checkSynth
called by 46
js/decode_synth_test.ts
checkSynth
called by 46
js/decode_synth_test.js
min
called by 46
java/org/brotli/dec/Utils.java
makeError
called by 38
java/org/brotli/dec/Utils.java
readFewBits
called by 37
js/decode.ts
makeError
called by 37
js/decode.ts
readFewBits
called by 37
js/decode.js
makeError
called by 37
js/decode.js

Shape

Method 549
Function 513
Class 119
Struct 10
Enum 5
Interface 2
TypeAlias 2

Languages

Java34%
TypeScript25%
Python22%
Go19%

Modules by API surface

research/brotlidump.py196 symbols
js/decode.ts78 symbols
go/brotli/decode.go76 symbols
js/decode.js72 symbols
java/org/brotli/dec/SynthTest.java50 symbols
js/decode_synth_test.ts49 symbols
js/decode_synth_test.js49 symbols
go/cbrotli/synth_test.go48 symbols
go/brotli/synth_test.go48 symbols
js/decode.min.js44 symbols
java/org/brotli/dec/Decode.java42 symbols
java/org/brotli/wrapper/enc/EncoderJNI.java25 symbols

Dependencies from manifests, versioned

junit:junit4.13.2 · 1×
org.brotli:dec1.2.0-SNAPSHOT · 1×
yargs8.0.2 · 1×

For agents

$ claude mcp add brotli \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact