Home | History | Annotate | only in /xsrc/external/mit/brotli/dist
Up to higher level directory
NameDateSize
bootstrap29-Jan-20231.5K
BUILD29-Jan-20232.6K
c/19-Feb-2026
CMakeLists.txt29-Jan-202315K
compiler_config_setting.bzl29-Jan-20231K
configure29-Jan-2023425
configure-cmake29-Jan-202311.1K
configure.ac29-Jan-2023321
CONTRIBUTING.md29-Jan-20231.4K
docs/19-Feb-2026
LICENSE29-Jan-20231.1K
Makefile29-Jan-20231.4K
Makefile.am29-Jan-20231.2K
MANIFEST.in29-Jan-2023361
premake5.lua29-Jan-20231.7K
python/19-Feb-2026
README29-Jan-2023652
README.md29-Jan-20234.2K
scripts/19-Feb-2026
setup.cfg29-Jan-202353
setup.py29-Jan-20239.4K
tests/19-Feb-2026
WORKSPACE29-Jan-2023339

README

      1 BROTLI DATA COMPRESSION LIBRARY
      2 
      3 Brotli is a generic-purpose lossless compression algorithm that compresses data
      4 using a combination of a modern variant of the LZ77 algorithm, Huffman coding
      5 and 2nd order context modeling, with a compression ratio comparable to the best
      6 currently available general-purpose compression methods. It is similar in speed
      7 with deflate but offers more dense compression.
      8 
      9 The specification of the Brotli Compressed Data Format is defined in RFC 7932
     10 https://tools.ietf.org/html/rfc7932
     11 
     12 Brotli is open-sourced under the MIT License, see the LICENSE file.
     13 
     14 Brotli mailing list:
     15 https://groups.google.com/forum/#!forum/brotli
     16 

README.md

      1 <p align="center"><img src="https://brotli.org/brotli.svg" alt="Brotli" width="64"></p>
      2 
      3 # SECURITY NOTE
      4 
      5 Please consider updating brotli to version 1.0.9 (latest).
      6 
      7 Version 1.0.9 contains a fix to "integer overflow" problem. This happens when "one-shot" decoding API is used (or input chunk for streaming API is not limited), input size (chunk size) is larger than 2GiB, and input contains uncompressed blocks. After the overflow happens, `memcpy` is invoked with a gigantic `num` value, that will likely cause the crash.
      8 
      9 ### Introduction
     10 
     11 Brotli is a generic-purpose lossless compression algorithm that compresses data
     12 using a combination of a modern variant of the LZ77 algorithm, Huffman coding
     13 and 2nd order context modeling, with a compression ratio comparable to the best
     14 currently available general-purpose compression methods. It is similar in speed
     15 with deflate but offers more dense compression.
     16 
     17 The specification of the Brotli Compressed Data Format is defined in [RFC 7932](https://tools.ietf.org/html/rfc7932).
     18 
     19 Brotli is open-sourced under the MIT License, see the LICENSE file.
     20 
     21 Brotli mailing list:
     22 https://groups.google.com/forum/#!forum/brotli
     23 
     24 [![TravisCI Build Status](https://travis-ci.org/google/brotli.svg?branch=master)](https://travis-ci.org/google/brotli)
     25 [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/google/brotli?branch=master&svg=true)](https://ci.appveyor.com/project/szabadka/brotli)
     26 [![Fuzzing Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/brotli.svg)](https://oss-fuzz-build-logs.storage.googleapis.com/index.html#brotli)
     27 
     28 ### Build instructions
     29 
     30 #### Vcpkg
     31 
     32 You can download and install brotli using the [vcpkg](https://github.com/Microsoft/vcpkg/) dependency manager:
     33 
     34     git clone https://github.com/Microsoft/vcpkg.git
     35     cd vcpkg
     36     ./bootstrap-vcpkg.sh
     37     ./vcpkg integrate install
     38     vcpkg install brotli
     39 
     40 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](https://github.com/Microsoft/vcpkg) on the vcpkg repository.
     41 
     42 #### Autotools-style CMake
     43 
     44 [configure-cmake](https://github.com/nemequ/configure-cmake) is an
     45 autotools-style configure script for CMake-based projects (not supported on Windows).
     46 
     47 The basic commands to build, test and install brotli are:
     48 
     49     $ mkdir out && cd out
     50     $ ../configure-cmake
     51     $ make
     52     $ make test
     53     $ make install
     54 
     55 By default, debug binaries are built. To generate "release" `Makefile` specify `--disable-debug` option to `configure-cmake`.
     56 
     57 #### Bazel
     58 
     59 See [Bazel](http://www.bazel.build/)
     60 
     61 #### CMake
     62 
     63 The basic commands to build and install brotli are:
     64 
     65     $ mkdir out && cd out
     66     $ cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=./installed ..
     67     $ cmake --build . --config Release --target install
     68 
     69 You can use other [CMake](https://cmake.org/) configuration.
     70 
     71 #### Premake5
     72 
     73 See [Premake5](https://premake.github.io/)
     74 
     75 #### Python
     76 
     77 To install the latest release of the Python module, run the following:
     78 
     79     $ pip install brotli
     80 
     81 To install the tip-of-the-tree version, run:
     82 
     83     $ pip install --upgrade git+https://github.com/google/brotli
     84 
     85 See the [Python readme](python/README.md) for more details on installing
     86 from source, development, and testing.
     87 
     88 ### Benchmarks
     89 * [Squash Compression Benchmark](https://quixdb.github.io/squash-benchmark/) / [Unstable Squash Compression Benchmark](https://quixdb.github.io/squash-benchmark/unstable/)
     90 * [Large Text Compression Benchmark](http://mattmahoney.net/dc/text.html)
     91 * [Lzturbo Benchmark](https://sites.google.com/site/powturbo/home/benchmark)
     92 
     93 ### Related projects
     94 > **Disclaimer:** Brotli authors take no responsibility for the third party projects mentioned in this section.
     95 
     96 Independent [decoder](https://github.com/madler/brotli) implementation by Mark Adler, based entirely on format specification.
     97 
     98 JavaScript port of brotli [decoder](https://github.com/devongovett/brotli.js). Could be used directly via `npm install brotli`
     99 
    100 Hand ported [decoder / encoder](https://github.com/dominikhlbg/BrotliHaxe) in haxe by Dominik Homberger. Output source code: JavaScript, PHP, Python, Java and C#
    101 
    102 7Zip [plugin](https://github.com/mcmilk/7-Zip-Zstd)
    103 
    104 Dart [native bindings](https://github.com/thosakwe/brotli)
    105