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 BSD-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 : [![Build Status][travisDevBadge]][travisLink]   [![Build status][AppveyorDevBadge]][AppveyorLink]   [![Build status][CircleDevBadge]][CircleLink]
  13
  14 [travisDevBadge]: https://travis-ci.org/facebook/zstd.svg?branch=dev "Continuous Integration test suite"
  15 [travisLink]: https://travis-ci.org/facebook/zstd
  16 [AppveyorDevBadge]: https://ci.appveyor.com/api/projects/status/xt38wbdxjk5mrbem/branch/dev?svg=true "Windows test suite"
  17 [AppveyorLink]: https://ci.appveyor.com/project/YannCollet/zstd-p0yf0
  18 [CircleDevBadge]: https://circleci.com/gh/facebook/zstd/tree/dev.svg?style=shield "Short test suite"
  19 [CircleLink]: https://circleci.com/gh/facebook/zstd
  20
  21 ### Benchmarks
  22
  23 For reference, several fast compression algorithms were tested and compared
  24 on a server running Linux Debian (`Linux version 4.14.0-3-amd64`),
  25 with a Core i7-6700K CPU @ 4.0GHz,
  26 using [lzbench], an open-source in-memory benchmark by @inikep
  27 compiled with [gcc] 7.3.0,
  28 on the [Silesia compression corpus].
  29
  30 [lzbench]: https://github.com/inikep/lzbench
  31 [Silesia compression corpus]: http://sun.aei.polsl.pl/~sdeor/index.php?page=silesia
  32 [gcc]: https://gcc.gnu.org/
  33
  34 | Compressor name         | Ratio | Compression| Decompress.|
  35 | ---------------         | ------| -----------| ---------- |
  36 | **zstd 1.3.4 -1**       | 2.877 |   470 MB/s |  1380 MB/s |
  37 | zlib 1.2.11 -1          | 2.743 |   110 MB/s |   400 MB/s |
  38 | brotli 1.0.2 -0         | 2.701 |   410 MB/s |   430 MB/s |
  39 | quicklz 1.5.0 -1        | 2.238 |   550 MB/s |   710 MB/s |
  40 | lzo1x 2.09 -1           | 2.108 |   650 MB/s |   830 MB/s |
  41 | lz4 1.8.1               | 2.101 |   750 MB/s |  3700 MB/s |
  42 | snappy 1.1.4            | 2.091 |   530 MB/s |  1800 MB/s |
  43 | lzf 3.6 -1              | 2.077 |   400 MB/s |   860 MB/s |
  44
  45 [zlib]:http://www.zlib.net/
  46 [LZ4]: http://www.lz4.org/
  47
  48 Zstd can also offer stronger compression ratios at the cost of compression speed.
  49 Speed vs Compression trade-off is configurable by small increments.
  50 Decompression speed is preserved and remains roughly the same at all settings,
  51 a property shared by most LZ compression algorithms, such as [zlib] or lzma.
  52
  53 The following tests were run
  54 on a server running Linux Debian (`Linux version 4.14.0-3-amd64`)
  55 with a Core i7-6700K CPU @ 4.0GHz,
  56 using [lzbench], an open-source in-memory benchmark by @inikep
  57 compiled with [gcc] 7.3.0,
  58 on the [Silesia compression corpus].
  59
  60 Compression Speed vs Ratio | Decompression Speed
  61 ---------------------------|--------------------
  62 ![Compression Speed vs Ratio](doc/images/CSpeed2.png "Compression Speed vs Ratio") | ![Decompression Speed](doc/images/DSpeed3.png "Decompression Speed")
  63
  64 A few other algorithms can produce higher compression ratios at slower speeds, falling outside of the graph.
  65 For a larger picture including slow modes, [click on this link](doc/images/DCspeed5.png).
  66
  67
  68 ### The case for Small Data compression
  69
  70 Previous charts provide results applicable to typical file and stream scenarios (several MB). Small data comes with different perspectives.
  71
  72 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.
  73
  74 To solve this situation, Zstd offers a __training mode__, which can be used to tune the algorithm for a selected type of data.
  75 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.
  76 Using this dictionary, the compression ratio achievable on small data improves dramatically.
  77
  78 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).
  79 It consists of roughly 10K records weighing about 1KB each.
  80
  81 Compression Ratio | Compression Speed | Decompression Speed
  82 ------------------|-------------------|--------------------
  83 ![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")
  84
  85
  86 These compression gains are achieved while simultaneously providing _faster_ compression and decompression speeds.
  87
  88 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_).
  89 Hence, deploying one dictionary per type of data will provide the greatest benefits.
  90 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.
  91
  92 #### Dictionary compression How To:
  93
  94 1) Create the dictionary
  95
  96 `zstd --train FullPathToTrainingSet/* -o dictionaryName`
  97
  98 2) Compress with dictionary
  99
 100 `zstd -D dictionaryName FILE`
 101
 102 3) Decompress with dictionary
 103
 104 `zstd -D dictionaryName --decompress FILE.zst`
 105
 106
 107 ### Build instructions
 108
 109 #### Makefile
 110
 111 If your system is compatible with standard `make` (or `gmake`),
 112 invoking `make` in root directory will generate `zstd` cli in root directory.
 113
 114 Other available options include:
 115 - `make install` : create and install zstd cli, library and man pages
 116 - `make check` : create and run `zstd`, tests its behavior on local platform
 117
 118 #### cmake
 119
 120 A `cmake` project generator is provided within `build/cmake`.
 121 It can generate Makefiles or other build scripts
 122 to create `zstd` binary, and `libzstd` dynamic and static libraries.
 123
 124 #### Meson
 125
 126 A Meson project is provided within `contrib/meson`.
 127
 128 #### Visual Studio (Windows)
 129
 130 Going into `build` directory, you will find additional possibilities:
 131 - Projects for Visual Studio 2005, 2008 and 2010.
 132   + VS2010 project is compatible with VS2012, VS2013, VS2015 and VS2017.
 133 - Automated build scripts for Visual compiler by [@KrzysFR](https://github.com/KrzysFR), in `build/VS_scripts`,
 134   which will build `zstd` cli and `libzstd` library without any need to open Visual Studio solution.
 135
 136
 137 ### Status
 138
 139 Zstandard is currently deployed within Facebook. It is used continuously to compress large amounts of data in multiple formats and use cases.
 140 Zstandard is considered safe for production environments.
 141
 142 ### License
 143
 144 Zstandard is dual-licensed under [BSD](LICENSE) and [GPLv2](COPYING).
 145
 146 ### Contributing
 147
 148 The "dev" branch is the one where all contributions are merged before reaching "master".
 149 If you plan to propose a patch, please commit into the "dev" branch, or its own feature branch.
 150 Direct commit to "master" are not permitted.
 151 For more information, please read [CONTRIBUTING](CONTRIBUTING.md).