This is a streaming LZJB decompressor. "Streaming" means that it supports decompressing while reading: all of the input does not have to be be available in order to decompress.
Feature overview:
- Very low memory overhead: ~30 bytes when 32-bit, ~50 bytes when 64-bit.
- Does not do any heap allocations.
- Accepts any number of compressed data bytes at a time, down to single bytes.
- Written in portable C, builds as both C89 and C99.
This is open source software, and licensed under the BSD 2-clause license. Thus, lzjb-stream can be used in commercial software as long as the copyright notice is respected.
Add lzjb-stream to your own project by including these three files:
- lzjb-stream.c - Main library implementation file.
- lzjb-stream.h - Header declaring the public interface (functions and data structures).
- lzjb-stream-config.h - Application-specific configuration. Edit this if using C89.
At the moment, lzjb-stream is not designed to build to a standalone library file, the intention is that the code should be included in your project.
The library is not optimized for performance, but for low memory overhead and internal simplicity. The targeted niche, basically embedded systems maintenance, is not one where performance is super-critical.
In general, it does a function call per generated output byte, which of course is costly. On the author's semi-ancient Core2 Q6600/2.4 GHz, it manages ~40 MB/s decompression speed.
The API is annotated in the source using industry-standard Doxygen comments. After you've cloned the project, run these commands to generate the documentation:
$ cd doc
$ doxygen ./lzjb-stream.doxyfile
Then point your browser at the resulting doc/html/index.html file.
In the meantime, if you're not bothered by the Doxygen markup, you can of course read the header itself.