Carl Woffenden
7c420344d2
To complement the single-file decoder a new script was added to create an amalgamated single-file of all of the Zstd source, along with examples and (simple) tests.
1.7 KiB
Single File Zstandard Decompression Library
The script combine.sh creates an amalgamated source file that can be used with or without zstd.h. This isn't a header-only file but it does offer a similar level of simplicity when integrating into a project.
Create zstddeclib.c from the Zstd source using:
cd zstd/contrib/single_file_decoder
./combine.sh -r ../../lib -r ../../lib/common -r ../../lib/decompress -o zstddeclib.c zstddeclib-in.c
Then add the resulting file to your project (see the example files).
create_single_file_decoder.sh will run the above script, creating file zstddeclib.c.
build_decoder_test.sh will create the decoder, then compile and test the library.
Why?
Because all it now takes to support decompressing Zstd is the addition of a single file, two if using the header, with no configuration or further build steps. The library is small, adding, for example, 26kB to an Emscripten compiled WebAssembly project. Native implementations add a little more, 40-70kB depending on the compiler and platform.
Optional Full Library
The same tool can amalgamate the entire Zstd library for ease of adding both compression and decompression to a project. The roundtrip example uses the original zstd.h with the remaining source files combined into zstd.c (currently just over 1MB) created from zstd-in.c. As with the standalone decoder the most useful compile flags have already been rolled-in and the resulting files can be added to a project as-is.
create_single_file_library.sh will run the script to create zstd.c.
build_library_test.sh will create the library, then compile and test the result.