https://github.com/facebook/zstd Skip to content Toggle navigation Sign up * Product + Actions Automate any workflow + Packages Host and manage packages + Security Find and fix vulnerabilities + Codespaces Instant dev environments + Copilot Write better code with AI + Code review Manage code changes + Issues Plan and track work + Discussions Collaborate outside of code + Explore + All features + Documentation + GitHub Skills + Blog * Solutions + For + Enterprise + Teams + Startups + Education + By Solution + CI/CD & Automation + DevOps + DevSecOps + Case Studies + Customer Stories + Resources * Open Source + GitHub Sponsors Fund open source developers + The ReadME Project GitHub community articles + Repositories + Topics + Trending + Collections * Pricing [ ] * # In this repository All GitHub | Jump to | * No suggested jump to results * # In this repository All GitHub | Jump to | * # In this organization All GitHub | Jump to | * # In this repository All GitHub | Jump to | Sign in Sign up {{ message }} facebook / zstd Public * Notifications * Fork 1.8k * Star 18.8k Zstandard - Fast real-time compression algorithm www.zstd.net License Unknown, GPL-2.0 licenses found Licenses found Unknown LICENSE GPL-2.0 COPYING 18.8k stars 1.8k forks Star Notifications * Code * Issues 119 * Pull requests 25 * Actions * Projects 0 * Wiki * Security * Insights More * Code * Issues * Pull requests * Actions * Projects * Wiki * Security * Insights facebook/zstd This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. dev Switch branches/tags [ ] Branches Tags Could not load branches Nothing to show {{ refName }} default View all branches Could not load tags Nothing to show {{ refName }} default View all tags Name already in use A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch? Cancel Create 66 branches 67 tags Code * Local * Codespaces * Clone HTTPS GitHub CLI [https://github.com/f] Use Git or checkout with SVN using the web URL. [gh repo clone facebo] Work fast with our official CLI. Learn more. * Open with GitHub Desktop * Download ZIP Sign In Required Please sign in to use Codespaces. Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Launching Xcode If nothing happens, download Xcode and try again. Launching Visual Studio Code Your codespace will open once ready. There was a problem preparing your codespace, please try again. Latest commit @terrelln terrelln [pzstd] Fixes for Windows build ... e9797b5 Dec 19, 2022 [pzstd] Fixes for Windows build * Add `Portability.h` to fix min/max issues. * Fix conversion warnings * Assert that windowLog <= 23, which is currently always the case. This could be loosened, but we aren't looking to add new functionality. Fixes on top of PR #3375 by @eli-schwartz, which added Windows CI for contrib & programs. e9797b5 Git stats * 9,831 commits Files Permalink Failed to load latest commit information. Type Name Latest commit message Commit time .circleci [circleci] Try to re-enable aarch64build Dec 16, 2022 .github CI: build contrib directory on meson-windows Dec 19, 2022 build meson: mark a known test failure on Windows Dec 16, 2022 contrib [pzstd] Fixes for Windows build Dec 19, 2022 doc Update documentation link to html format Dec 15, 2022 examples added a few documentation words about dictionary training Aug 5, 2022 lib minor reformatting Dec 18, 2022 programs Merge branch 'dev' into http-to-https Dec 15, 2022 tests make ZSTD_DECOMPRESSBOUND() compatible with input size 0 Dec 17, 2022 zlibWrapper Convert references to https from http Dec 14, 2022 .buckconfig Update builds to not support legacy v01-v03 Mar 13, 2017 .buckversion Add BUCK files for Nuclide support Jan 27, 2017 .cirrus.yml Unbreak FreeBSD CI May 9, 2022 .gitattributes zstd.exe has FileVersion and ProductVersion Sep 13, 2016 .gitignore [contrib][linux] Add contrib/linux-kernel/linux to .gitignore Sep 23, 2021 .travis.yml Merge pull request #3039 from eli-schwartz/meson Apr 19, 2022 CHANGELOG 1.5.3 version bump Jun 29, 2022 CODE_OF_CONDUCT.md added code of conduct Sep 6, 2018 CONTRIBUTING.md Typo and grammar fixes Mar 12, 2022 COPYING added GPLv2 license Aug 18, 2017 LICENSE added boilerplate Aug 30, 2016 Makefile Fix make variable Aug 19, 2022 Package.swift Update the Swift Package Definition to Reflect Move Jan 5, 2022 README.md added mention of compilation flags Dec 15, 2022 TESTING.md streamline make clean list maintenance Sep 7, 2022 appveyor.yml Add GH Actions windows runtime test Nov 29, 2021 View code [ ] Benchmarks The case for Small Data compression Dictionary compression How To: Build instructions Makefile cmake Meson VCPKG Visual Studio (Windows) Buck Testing Status License Contributing README.md Zstandard Zstandard, or zstd as short version, is a fast lossless compression algorithm, targeting real-time compression scenarios at zlib-level and better compression ratios. It's backed by a very fast entropy stage, provided by Huff0 and FSE library. Zstandard's format is stable and documented in RFC8878. Multiple independent implementations are already available. This repository represents the reference implementation, provided as an open-source dual BSD and GPLv2 licensed C library, and a command line utility producing and decoding .zst, .gz, .xz and .lz4 files. Should your project require another programming language, a list of known ports and bindings is provided on Zstandard homepage. Development branch status: Build Status Build status Build status Build status Fuzzing Status Benchmarks For reference, several fast compression algorithms were tested and compared on a desktop running Ubuntu 20.04 (Linux 5.11.0-41-generic), with a Core i7-9700K CPU @ 4.9GHz, using lzbench, an open-source in-memory benchmark by @inikep compiled with gcc 9.3.0, on the Silesia compression corpus. Compressor name Ratio Compression Decompress. zstd 1.5.1 -1 2.887 530 MB/s 1700 MB/s zlib 1.2.11 -1 2.743 95 MB/s 400 MB/s brotli 1.0.9 -0 2.702 395 MB/s 450 MB/s zstd 1.5.1 --fast=1 2.437 600 MB/s 2150 MB/s zstd 1.5.1 --fast=3 2.239 670 MB/s 2250 MB/s quicklz 1.5.0 -1 2.238 540 MB/s 760 MB/s zstd 1.5.1 --fast=4 2.148 710 MB/s 2300 MB/s lzo1x 2.10 -1 2.106 660 MB/s 845 MB/s lz4 1.9.3 2.101 740 MB/s 4500 MB/s lzf 3.6 -1 2.077 410 MB/s 830 MB/s snappy 1.1.9 2.073 550 MB/s 1750 MB/s The negative compression levels, specified with --fast=#, offer faster compression and decompression speed at the cost of compression ratio (compared to level 1). Zstd can also offer stronger compression ratios at the cost of compression speed. 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. The following tests were run on a server running Linux Debian (Linux version 4.14.0-3-amd64) with a Core i7-6700K CPU @ 4.0GHz, using lzbench, an open-source in-memory benchmark by @inikep compiled with gcc 7.3.0, on the Silesia compression corpus. Compression Speed vs Ratio Decompression Speed Compression Speed vs Ratio Decompression Speed A few other algorithms can produce higher compression ratios at slower speeds, falling outside of the graph. For a larger picture including slow modes, click on this link. The case for Small Data compression Previous charts provide results applicable to typical file and stream scenarios (several MB). Small data comes with different perspectives. 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. To solve this situation, Zstd offers a training mode, which can be used to tune the algorithm for a selected type of data. 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. Using this dictionary, the compression ratio achievable on small data improves dramatically. The following example uses the github-users sample set, created from github public API. It consists of roughly 10K records weighing about 1KB each. Compression Ratio Compression Speed Decompression Speed Compression Ratio Compression Speed Decompression Speed These compression gains are achieved while simultaneously providing faster compression and decompression speeds. 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). Hence, deploying one dictionary per type of data will provide the greatest benefits. 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. Dictionary compression How To: 1. Create the dictionary zstd --train FullPathToTrainingSet/* -o dictionaryName 2. Compress with dictionary zstd -D dictionaryName FILE 3. Decompress with dictionary zstd -D dictionaryName --decompress FILE.zst Build instructions make is the officially maintained build system of this project. All other build systems are "compatible" and 3rd-party maintained, they may feature small differences in advanced options. When your system allows it, prefer using make to build zstd and libzstd. Makefile If your system is compatible with standard make (or gmake), invoking make in root directory will generate zstd cli in root directory. It will also create libzstd into lib/. Other available options include: * make install : create and install zstd cli, library and man pages * make check : create and run zstd, test its behavior on local platform The Makefile follows the GNU Standard Makefile conventions, allowing staged install, standard flags, directory variables and command variables. For advanced use cases, specialized compilation flags which control binary generation are documented in lib/README.md for the libzstd library and in programs/README.md for the zstd CLI. cmake A cmake project generator is provided within build/cmake. It can generate Makefiles or other build scripts to create zstd binary, and libzstd dynamic and static libraries. By default, CMAKE_BUILD_TYPE is set to Release. Meson A Meson project is provided within build/meson. Follow build instructions in that directory. You can also take a look at .travis.yml file for an example about how Meson is used to build this project. Note that default build type is release. VCPKG You can build and install zstd vcpkg dependency manager: git clone https://github.com/Microsoft/vcpkg.git cd vcpkg ./bootstrap-vcpkg.sh ./vcpkg integrate install ./vcpkg install zstd The zstd 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 on the vcpkg repository. Visual Studio (Windows) Going into build directory, you will find additional possibilities: * Projects for Visual Studio 2005, 2008 and 2010. + VS2010 project is compatible with VS2012, VS2013, VS2015 and VS2017. * Automated build scripts for Visual compiler by @KrzysFR, in build /VS_scripts, which will build zstd cli and libzstd library without any need to open Visual Studio solution. Buck You can build the zstd binary via buck by executing: buck build programs:zstd from the root of the repo. The output binary will be in buck-out/gen/programs/. Testing You can run quick local smoke tests by executing the playTest.sh script from the src/tests directory. Two env variables $ZSTD_BIN and $DATAGEN_BIN are needed for the test script to locate the zstd and datagen binary. For information on CI testing, please refer to TESTING.md Status Zstandard is currently deployed within Facebook. It is used continuously to compress large amounts of data in multiple formats and use cases. Zstandard is considered safe for production environments. License Zstandard is dual-licensed under BSD and GPLv2. Contributing The dev branch is the one where all contributions are merged before reaching release. If you plan to propose a patch, please commit into the dev branch, or its own feature branch. Direct commit to release are not permitted. For more information, please read CONTRIBUTING. About Zstandard - Fast real-time compression algorithm www.zstd.net Resources Readme License Unknown, GPL-2.0 licenses found Licenses found Unknown LICENSE GPL-2.0 COPYING Code of conduct Code of conduct Security policy Security policy Stars 18.8k stars Watchers 394 watching Forks 1.8k forks Releases 64 Zstandard v1.5.2 Latest Jan 20, 2022 + 63 releases Packages 0 No packages published Contributors 285 * @Cyan4973 * @terrelln * @inikep * @felixhandte * @senhuang42 * @paulcruz74 * @stellamplau * @sean-purcell * @embg * @tesuji * @GeorgeLu97 + 274 contributors Languages * C 84.0% * C++ 5.9% * Shell 3.1% * Python 2.7% * Makefile 1.9% * CMake 0.7% * Other 1.7% Footer (c) 2022 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Docs * Contact GitHub * Pricing * API * Training * Blog * About You can't perform that action at this time. You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.