History

Yann Collet bfd829f254 minor: DIFF determination use gdiff on SunOS		2019-10-17 14:03:20 -07:00
..
.gitignore	ignore build artifact from educational decoder test	2019-10-17 10:50:39 -07:00
harness.c	minor: DIFF determination	2019-10-17 14:03:20 -07:00
Makefile	minor: DIFF determination	2019-10-17 14:03:20 -07:00
README.md	Merge branch 'dev' into doc	2017-02-23 15:23:24 -08:00
zstd_decompress.c	removed UNALIGNED() macro from educational decoder	2019-10-16 17:27:03 -07:00
zstd_decompress.h	fix eductional decoder	2019-09-06 14:30:13 -07:00

README.md

Educational Decoder

zstd_decompress.c is a self-contained implementation in C99 of a decoder, according to the Zstandard format specification. While it does not implement as many features as the reference decoder, such as the streaming API or content checksums, it is written to be easy to follow and understand, to help understand how the Zstandard format works. It's laid out to match the format specification, so it can be used to understand how complex segments could be implemented. It also contains implementations of Huffman and FSE table decoding.

harness.c provides a simple test harness around the decoder:

harness <input-file> <output-file> [dictionary]

As an additional resource to be used with this decoder, see the decodecorpus tool in the tests directory. It generates valid Zstandard frames that can be used to verify a Zstandard decoder implementation. Note that to use the tool to verify this decoder implementation, the --content-size flag should be set, as this decoder does not handle streaming decoding, and so it must know the decompressed size in advance.