History

Yann Collet 9ffbeea875 API : changed : streaming decompression : implicit reset on starting new frames		2016-12-02 18:37:38 -08:00
..
common	fixed Doxygen trailing comment	2016-12-02 16:13:41 +01:00
compress	introduced HUF_buildCTable_wksp(), to reduce stack memory usage	2016-12-01 17:47:30 -08:00
decompress	API : changed : streaming decompression : implicit reset on starting new frames	2016-12-02 18:37:38 -08:00
dictBuilder	Fix #418 : printing selected segments in zdict debug mode can segfault with certain pathological patterns	2016-11-02 13:57:55 -07:00
dll	lib\README.md: added Using MinGW+MSYS to create DLL	2016-11-21 14:22:08 +01:00
legacy	Merge two memset() calls into one	2016-11-14 17:52:51 -08:00
.gitignore	Added "dictionary decompression" example	2016-07-07 14:08:00 +02:00
libzstd.pc.in	updated pkg config file	2016-11-30 11:06:58 -08:00
Makefile	exclude zbuff_compress.c and zbuff_decompress.c	2016-11-21 14:34:03 +01:00
README.md	lib\README.md: added Using MinGW+MSYS to create DLL	2016-11-21 14:22:08 +01:00
zstd.h	API : changed : streaming decompression : implicit reset on starting new frames	2016-12-02 18:37:38 -08:00

README.md

Zstandard library files

The lib directory contains several directories. Depending on target use case, it's enough to include only files from relevant directories.

API

Zstandard's stable API is exposed within zstd.h, at the root of lib directory.

Advanced API

Some additional API may be useful if you're looking into advanced features :

common/error_public.h : transforms size_t function results into an enum, for precise error handling.
ZSTD_STATIC_LINKING_ONLY : if you define this macro before including zstd.h, it will give access to advanced and experimental API. These APIs shall never be used with dynamic library ! They are not "stable", their definition may change in the future. Only static linking is allowed.

Modular build

Directory common/ is required in all circumstances. You can select to support compression only, by just adding files from the compress/ directory, In a similar way, you can build a decompressor-only library with the decompress/ directory.

Other optional functionalities provided are :

dictBuilder/ : source files to create dictionaries. The API can be consulted in dictBuilder/zdict.h. This module also depends on common/ and compress/ .
legacy/ : source code to decompress previous versions of zstd, starting from v0.1. This module also depends on common/ and decompress/ . Library compilation must include directive ZSTD_LEGACY_SUPPORT = 1 . The main API can be consulted in legacy/zstd_legacy.h. Advanced API from each version can be found in their relevant header file. For example, advanced API for version v0.4 is in legacy/zstd_v04.h .

Using MinGW+MSYS to create DLL

DLL can be created using MinGW+MSYS with the make libzstd command. This command creates dll\libzstd.dll and the import library dll\libzstd.lib. The import library is only required with Visual C++. The header file zstd.h and the dynamic library dll\libzstd.dll are required to compile a project using gcc/MinGW. The dynamic library has to be added to linking options. It means that if a project that uses ZSTD consists of a single test-dll.c file it should be linked with dll\libzstd.dll. For example:

    gcc $(CFLAGS) -Iinclude/ test-dll.c -o test-dll dll\libzstd.dll

The compiled executable will require ZSTD DLL which is available at dll\libzstd.dll.

Obsolete streaming API

Streaming is now provided within zstd.h. Older streaming API is still available within common/zbuff.h. It is now deprecated, and will be removed in a future version. Consider migrating towards newer streaming API in zstd.h.

Miscellaneous

The other files are not source code. There are :

LICENSE : contains the BSD license text
Makefile : script to compile or install zstd library (static and dynamic)
libzstd.pc.in : for pkg-config (make install)
README.md : this file