README.md

   1 <p align="center"><img src="https://raw.githubusercontent.com/facebook/zstd/dev/doc/images/zstd_logo86.png" alt="Zstandard"></p>
   2
   3 __Zstandard__, or `zstd` as short version, is a fast lossless compression algorithm,
   4 targeting real-time compression scenarios at zlib-level and better compression ratios.
   5 It's backed by a very fast entropy stage, provided by [Huff0 and FSE library](https://github.com/Cyan4973/FiniteStateEntropy).
   6
   7 The project is provided as an open-source dual [BSD](LICENSE) and [GPLv2](COPYING) licensed **C** library,
   8 and a command line utility producing and decoding `.zst`, `.gz`, `.xz` and `.lz4` files.
   9 Should your project require another programming language,
  10 a list of known ports and bindings is provided on [Zstandard homepage](http://www.zstd.net/#other-languages).
  11
  12 **Development branch status:**
  13
  14 [![Build Status][travisDevBadge]][travisLink]
  15 [![Build status][AppveyorDevBadge]][AppveyorLink]
  16 [![Build status][CircleDevBadge]][CircleLink]
  17 [![Build status][CirrusDevBadge]][CirrusLink]
  18
  19 [travisDevBadge]: https://travis-ci.org/facebook/zstd.svg?branch=dev "Continuous Integration test suite"
  20 [travisLink]: https://travis-ci.org/facebook/zstd
  21 [AppveyorDevBadge]: https://ci.appveyor.com/api/projects/status/xt38wbdxjk5mrbem/branch/dev?svg=true "Windows test suite"
  22 [AppveyorLink]: https://ci.appveyor.com/project/YannCollet/zstd-p0yf0
  23 [CircleDevBadge]: https://circleci.com/gh/facebook/zstd/tree/dev.svg?style=shield "Short test suite"
  24 [CircleLink]: https://circleci.com/gh/facebook/zstd
  25 [CirrusDevBadge]: https://api.cirrus-ci.com/github/facebook/zstd.svg?branch=dev
  26 [CirrusLink]: https://cirrus-ci.com/github/facebook/zstd
  27
  28 ## Benchmarks
  29
  30 For reference, several fast compression algorithms were tested and compared
  31 on a server running Arch Linux (`Linux version 5.0.5-arch1-1`),
  32 with a Core i9-9900K CPU @ 5.0GHz,
  33 using [lzbench], an open-source in-memory benchmark by @inikep
  34 compiled with [gcc] 8.2.1,
  35 on the [Silesia compression corpus].
  36
  37 [lzbench]: https://github.com/inikep/lzbench
  38 [Silesia compression corpus]: http://sun.aei.polsl.pl/~sdeor/index.php?page=silesia
  39 [gcc]: https://gcc.gnu.org/
  40
  41 | Compressor name         | Ratio | Compression| Decompress.|
  42 | ---------------         | ------| -----------| ---------- |
  43 | **zstd 1.4.0 -1**       | 2.884 |   530 MB/s |  1360 MB/s |
  44 | zlib 1.2.11 -1          | 2.743 |   110 MB/s |   440 MB/s |
  45 | brotli 1.0.7 -0         | 2.701 |   430 MB/s |   470 MB/s |
  46 | quicklz 1.5.0 -1        | 2.238 |   600 MB/s |   800 MB/s |
  47 | lzo1x 2.09 -1           | 2.106 |   680 MB/s |   950 MB/s |
  48 | lz4 1.8.3               | 2.101 |   800 MB/s |  4220 MB/s |
  49 | snappy 1.1.4            | 2.073 |   580 MB/s |  2020 MB/s |
  50 | lzf 3.6 -1              | 2.077 |   440 MB/s |   930 MB/s |
  51
  52 [zlib]: http://www.zlib.net/
  53 [LZ4]: http://www.lz4.org/
  54
  55 Zstd can also offer stronger compression ratios at the cost of compression speed.
  56 Speed vs Compression trade-off is configurable by small increments.
  57 Decompression speed is preserved and remains roughly the same at all settings,
  58 a property shared by most LZ compression algorithms, such as [zlib] or lzma.
  59
  60 The following tests were run
  61 on a server running Linux Debian (`Linux version 4.14.0-3-amd64`)
  62 with a Core i7-6700K CPU @ 4.0GHz,
  63 using [lzbench], an open-source in-memory benchmark by @inikep
  64 compiled with [gcc] 7.3.0,
  65 on the [Silesia compression corpus].
  66
  67 Compression Speed vs Ratio | Decompression Speed
  68 ---------------------------|--------------------
  69 ![Compression Speed vs Ratio](doc/images/CSpeed2.png "Compression Speed vs Ratio") | ![Decompression Speed](doc/images/DSpeed3.png "Decompression Speed")
  70
  71 A few other algorithms can produce higher compression ratios at slower speeds, falling outside of the graph.
  72 For a larger picture including slow modes, [click on this link](doc/images/DCspeed5.png).
  73
  74
  75 ## The case for Small Data compression
  76
  77 Previous charts provide results applicable to typical file and stream scenarios (several MB). Small data comes with different perspectives.
  78
  79 The smaller the amount of data to compress, the more difficult it is to compress. This problem is common to all compression algorithms, and reason is, compression algorithms learn from past data how to compress future data. But at the beginning of a new data set, there is no "past" to build upon.
  80
  81 To solve this situation, Zstd offers a __training mode__, which can be used to tune the algorithm for a selected type of data.
  82 Training Zstandard is achieved by providing it with a few samples (one file per sample). The result of this training is stored in a file called "dictionary", which must be loaded before compression and decompression.
  83 Using this dictionary, the compression ratio achievable on small data improves dramatically.
  84
  85 The following example uses the `github-users` [sample set](https://github.com/facebook/zstd/releases/tag/v1.1.3), created from [github public API](https://developer.github.com/v3/users/#get-all-users).
  86 It consists of roughly 10K records weighing about 1KB each.
  87
  88 Compression Ratio | Compression Speed | Decompression Speed
  89 ------------------|-------------------|--------------------
  90 ![Compression Ratio](doc/images/dict-cr.png "Compression Ratio") | ![Compression Speed](doc/images/dict-cs.png "Compression Speed") | ![Decompression Speed](doc/images/dict-ds.png "Decompression Speed")
  91
  92
  93 These compression gains are achieved while simultaneously providing _faster_ compression and decompression speeds.
  94
  95 Training works if there is some correlation in a family of small data samples. The more data-specific a dictionary is, the more efficient it is (there is no _universal dictionary_).
  96 Hence, deploying one dictionary per type of data will provide the greatest benefits.
  97 Dictionary gains are mostly effective in the first few KB. Then, the compression algorithm will gradually use previously decoded content to better compress the rest of the file.
  98
  99 ### Dictionary compression How To:
 100
 101 1. Create the dictionary
 102
 103    `zstd --train FullPathToTrainingSet/* -o dictionaryName`
 104
 105 2. Compress with dictionary
 106
 107    `zstd -D dictionaryName FILE`
 108
 109 3. Decompress with dictionary
 110
 111    `zstd -D dictionaryName --decompress FILE.zst`
 112
 113
 114 ## Build instructions
 115
 116 ### Makefile
 117
 118 If your system is compatible with standard `make` (or `gmake`),
 119 invoking `make` in root directory will generate `zstd` cli in root directory.
 120
 121 Other available options include:
 122 - `make install` : create and install zstd cli, library and man pages
 123 - `make check` : create and run `zstd`, tests its behavior on local platform
 124
 125 ### cmake
 126
 127 A `cmake` project generator is provided within `build/cmake`.
 128 It can generate Makefiles or other build scripts
 129 to create `zstd` binary, and `libzstd` dynamic and static libraries.
 130
 131 By default, `CMAKE_BUILD_TYPE` is set to `Release`.
 132
 133 ### Meson
 134
 135 A Meson project is provided within [`build/meson`](build/meson). Follow
 136 build instructions in that directory.
 137
 138 You can also take a look at [`.travis.yml`](.travis.yml) file for an
 139 example about how Meson is used to build this project.
 140
 141 Note that default build type is **release**.
 142
 143 ### Visual Studio (Windows)
 144
 145 Going into `build` directory, you will find additional possibilities:
 146 - Projects for Visual Studio 2005, 2008 and 2010.
 147   + VS2010 project is compatible with VS2012, VS2013, VS2015 and VS2017.
 148 - Automated build scripts for Visual compiler by [@KrzysFR](https://github.com/KrzysFR), in `build/VS_scripts`,
 149   which will build `zstd` cli and `libzstd` library without any need to open Visual Studio solution.
 150
 151 ### Buck
 152
 153 You can build the zstd binary via buck by executing: `buck build programs:zstd` from the root of the repo.
 154 The output binary will be in `buck-out/gen/programs/`.
 155
 156 ## Status
 157
 158 Zstandard is currently deployed within Facebook. It is used continuously to compress large amounts of data in multiple formats and use cases.
 159 Zstandard is considered safe for production environments.
 160
 161 ## License
 162
 163 Zstandard is dual-licensed under [BSD](LICENSE) and [GPLv2](COPYING).
 164
 165 ## Contributing
 166
 167 The "dev" branch is the one where all contributions are merged before reaching "master".
 168 If you plan to propose a patch, please commit into the "dev" branch, or its own feature branch.
 169 Direct commit to "master" are not permitted.
 170 For more information, please read [CONTRIBUTING](CONTRIBUTING.md).