Go to file
Nick Terrell 2fcf8a4b99 Update tests to reflect new default options 2016-09-02 12:59:14 -07:00
contrib/pzstd Update tests to reflect new default options 2016-09-02 12:59:14 -07:00
examples added boilerplate 2016-08-30 11:06:28 -07:00
images updated Dspeed graph 2016-08-11 01:13:15 +02:00
lib bumped version number 2016-09-01 15:49:26 -07:00
programs fixed zstd-pgo (#329) reported by @octoploid 2016-09-02 09:44:00 -07:00
projects Merge pull request #307 from inikep/dev08 2016-08-29 16:32:33 -07:00
tests zbufftest only depends on standard C time.h 2016-09-01 18:11:12 -07:00
zlibWrapper copy zlib license into file header 2016-08-31 07:34:18 -07:00
.coverity.yml fixed issue with small dictionary 2016-07-14 23:27:31 +02:00
.gitattributes `.cmd` files use windows-style eol 2016-06-16 15:53:02 +02:00
.gitignore Merge pull request #325 from terrelln/dev 2016-09-01 17:12:09 -07:00
.travis.yml Clean up compiler warnings + Build pzstd on travis 2016-09-02 12:23:49 -07:00
CONTRIBUTING.md added boilerplate 2016-08-30 11:06:28 -07:00
LICENSE added boilerplate 2016-08-30 11:06:28 -07:00
LICENSE-examples added boilerplate 2016-08-30 11:06:28 -07:00
Makefile minor Makefile updates 2016-08-30 13:33:20 -07:00
NEWS zstd cli correctly detects console on Mac OS-X 2016-09-01 17:14:02 -07:00
PATENTS added boilerplate 2016-08-30 11:06:28 -07:00
README.md Fix build status images 2016-08-31 11:40:22 -07:00
appveyor.yml appveyor.yml working with tests/ 2016-08-18 15:17:18 +02:00
zstd.rb update brew formula 2016-08-31 09:16:19 -07:00
zstd_compression_format.md minor changes in zstd_compression_format.md 2016-08-25 15:19:37 +02:00

README.md

Zstd, short for Zstandard, is a fast lossless compression algorithm, targeting real-time compression scenarios at zlib-level and better compression ratios.

It is provided as an open-source BSD-licensed C library. For other programming languages, you can consult a list of known ports on Zstandard homepage.

Branch Status
master Build Status
dev Build Status

As a reference, several fast compression algorithms were tested and compared on a Core i7-3930K CPU @ 4.5GHz, using lzbench, an open-source in-memory benchmark by @inikep compiled with gcc 5.4.0, with the Silesia compression corpus.

Name Ratio C.speed D.speed
MB/s MB/s
zstd 0.8.2 -1 2.877 330 940
zlib 1.2.8 -1 2.730 95 360
brotli 0.4 -0 2.708 320 375
QuickLZ 1.5 2.237 510 605
LZO 2.09 2.106 610 870
LZ4 r131 2.101 620 3100
Snappy 1.1.3 2.091 480 1600
LZF 3.6 2.077 375 790

Zstd can also offer stronger compression ratios at the cost of compression speed. Speed vs Compression trade-off is configurable by small increment. Decompression speed is preserved and remain roughly the same at all settings, a property shared by most LZ compression algorithms, such as zlib or lzma.

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.

Compression Speed vs Ratio Decompression Speed
Compression Speed vs Ratio Decompression Speed

Several algorithms can produce higher compression ratio but at slower speed, falling outside of the graph. For a larger picture including very slow modes, click on this link .

The case for Small Data compression

Previous charts provide results applicable to typical files and streams scenarios (several MB). Small data come with different perspectives. The smaller the amount of data to compress, the more difficult it is to achieve any significant compression.

This problem is common to any compression algorithm. The reason is, compression algorithms learn from past data how to compress future data. But at the beginning of a new file, there is no "past" to build upon.

To solve this situation, Zstd offers a training mode, which can be used to tune the algorithm for a selected type of data, by providing it with a few samples. The result of the training is stored in a file called "dictionary", which can be loaded before compression and decompression. Using this dictionary, the compression ratio achievable on small data improves dramatically :

Compressing Small Data

These compression gains are achieved while simultaneously providing faster compression and decompression speeds.

Dictionary work if there is some correlation in a family of small data (there is no universal dictionary). Hence, deploying one dictionary per type of data will provide the greater benefits. Dictionary gains are mostly effective in the first few KB. Then, the compression algorithm will rely more and more on previously decoded content to compress the rest of the file.

Dictionary compression How To :

  1. Create the dictionary

zstd --train FullPathToTrainingSet/* -o dictionaryName

  1. Compress with dictionary

zstd FILE -D dictionaryName

  1. Decompress with dictionary

zstd --decompress FILE.zst -D dictionaryName

Status

Zstandard is currently deployed within Facebook. It is used daily to compress and decompress very large amount of data in multiple formats and use cases. Zstandard is considered safe for production environments.

License

Zstandard is BSD-licensed. We also provide an additional patent grant.

Contributing

The "dev" branch is the one where all contributions will be merged before reaching "master". If you plan to propose a patch, please commit into the "dev" branch or its own feature branch. Direct commit to "master" are not permitted. For more information, please read CONTRIBUTING.

Miscellaneous

Zstd entropy stage is provided by Huff0 and FSE, from Finite State Entropy library.