contrib/zstd/README.md

   1  __Zstandard__, or `zstd` as short version, is a fast lossless compression algorithm,
   2  targeting real-time compression scenarios at zlib-level and better compression ratios.
   3
   4 It is provided as an open-source BSD-licensed **C** library,
   5 and a command line utility producing and decoding `.zst` and `.gz` files.
   6 For other programming languages,
   7 you can consult a list of known ports on [Zstandard homepage](http://www.zstd.net/#other-languages).
   8
   9 |Branch      |Status   |
  10 |------------|---------|
  11 |master      | [![Build Status](https://travis-ci.org/facebook/zstd.svg?branch=master)](https://travis-ci.org/facebook/zstd) |
  12 |dev         | [![Build Status](https://travis-ci.org/facebook/zstd.svg?branch=dev)](https://travis-ci.org/facebook/zstd) |
  13
  14 As a reference, several fast compression algorithms were tested and compared
  15 on a server running Linux Mint Debian Edition (`Linux version 4.8.0-1-amd64`),
  16 with a Core i7-6700K CPU @ 4.0GHz,
  17 using [lzbench v1.6], an open-source in-memory benchmark by @inikep
  18 compiled with GCC 6.3.0,
  19 on the [Silesia compression corpus].
  20
  21 [lzbench v1.6]: https://github.com/inikep/lzbench
  22 [Silesia compression corpus]: http://sun.aei.polsl.pl/~sdeor/index.php?page=silesia
  23
  24 | Compressor name         | Ratio | Compression| Decompress.|
  25 | ---------------         | ------| -----------| ---------- |
  26 | **zstd 1.1.3 -1**       | 2.877 |   430 MB/s |  1110 MB/s |
  27 | zlib 1.2.8 -1           | 2.743 |   110 MB/s |   400 MB/s |
  28 | brotli 0.5.2 -0         | 2.708 |   400 MB/s |   430 MB/s |
  29 | quicklz 1.5.0 -1        | 2.238 |   550 MB/s |   710 MB/s |
  30 | lzo1x 2.09 -1           | 2.108 |   650 MB/s |   830 MB/s |
  31 | lz4 1.7.5               | 2.101 |   720 MB/s |  3600 MB/s |
  32 | snappy 1.1.3            | 2.091 |   500 MB/s |  1650 MB/s |
  33 | lzf 3.6 -1              | 2.077 |   400 MB/s |   860 MB/s |
  34
  35 [zlib]:http://www.zlib.net/
  36 [LZ4]: http://www.lz4.org/
  37
  38 Zstd can also offer stronger compression ratios at the cost of compression speed.
  39 Speed vs Compression trade-off is configurable by small increments. Decompression speed is preserved and remains roughly the same at all settings, a property shared by most LZ compression algorithms, such as [zlib] or lzma.
  40
  41 The following tests were run on a Core i7-3930K CPU @ 4.5GHz, using [lzbench], an open-source in-memory benchmark by @inikep compiled with GCC 5.2.1, on the [Silesia compression corpus].
  42
  43 Compression Speed vs Ratio | Decompression Speed
  44 ---------------------------|--------------------
  45 ![Compression Speed vs Ratio](doc/images/Cspeed4.png "Compression Speed vs Ratio") | ![Decompression Speed](doc/images/Dspeed4.png "Decompression Speed")
  46
  47 Several algorithms can produce higher compression ratios, but at slower speeds, falling outside of the graph.
  48 For a larger picture including very slow modes, [click on this link](doc/images/DCspeed5.png) .
  49
  50
  51 ### The case for Small Data compression
  52
  53 Previous charts provide results applicable to typical file and stream scenarios (several MB). Small data comes with different perspectives.
  54
  55 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.
  56
  57 To solve this situation, Zstd offers a __training mode__, which can be used to tune the algorithm for a selected type of data.
  58 Training Zstandard is achieved by provide 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.
  59 Using this dictionary, the compression ratio achievable on small data improves dramatically.
  60
  61 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).
  62 It consists of roughly 10K records weighting about 1KB each.
  63
  64 Compression Ratio | Compression Speed | Decompression Speed
  65 ------------------|-------------------|--------------------
  66 ![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")
  67
  68
  69 These compression gains are achieved while simultaneously providing _faster_ compression and decompression speeds.
  70
  71 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_).
  72 Hence, deploying one dictionary per type of data will provide the greatest benefits.
  73 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.
  74
  75 #### Dictionary compression How To :
  76
  77 1) Create the dictionary
  78
  79 `zstd --train FullPathToTrainingSet/* -o dictionaryName`
  80
  81 2) Compress with dictionary
  82
  83 `zstd -D dictionaryName FILE`
  84
  85 3) Decompress with dictionary
  86
  87 `zstd -D dictionaryName --decompress FILE.zst`
  88
  89
  90 ### Build
  91
  92 Once you have the repository cloned, there are multiple ways provided to build Zstandard.
  93
  94 #### Makefile
  95
  96 If your system is compatible with a standard `make` (or `gmake`) binary generator,
  97 you can simply run it at the root directory.
  98 It will generate `zstd` within root directory.
  99
 100 Other available options include :
 101 - `make install` : create and install zstd binary, library and man page
 102 - `make test` : create and run `zstd` and test tools on local platform
 103
 104 #### cmake
 105
 106 A `cmake` project generator is provided within `build/cmake`.
 107 It can generate Makefiles or other build scripts
 108 to create `zstd` binary, and `libzstd` dynamic and static libraries.
 109
 110 #### Meson
 111
 112 A Meson project is provided within `contrib/meson`.
 113
 114 #### Visual Studio (Windows)
 115
 116 Going into `build` directory, you will find additional possibilities :
 117 - Projects for Visual Studio 2005, 2008 and 2010
 118   + VS2010 project is compatible with VS2012, VS2013 and VS2015
 119 - Automated build scripts for Visual compiler by @KrzysFR , in `build/VS_scripts`,
 120   which will build `zstd` cli and `libzstd` library without any need to open Visual Studio solution.
 121
 122
 123 ### Status
 124
 125 Zstandard is currently deployed within Facebook. It is used daily to compress and decompress very large amounts of data in multiple formats and use cases.
 126 Zstandard is considered safe for production environments.
 127
 128 ### License
 129
 130 Zstandard is [BSD-licensed](LICENSE). We also provide an [additional patent grant](PATENTS).
 131
 132 ### Contributing
 133
 134 The "dev" branch is the one where all contributions will be merged before reaching "master".
 135 If you plan to propose a patch, please commit into the "dev" branch or its own feature branch.
 136 Direct commit to "master" are not permitted.
 137 For more information, please read [CONTRIBUTING](CONTRIBUTING.md).
 138
 139 ### Miscellaneous
 140
 141 Zstd entropy stage is provided by [Huff0 and FSE, from Finite State Entropy library](https://github.com/Cyan4973/FiniteStateEntropy).