MirrorSave
/
nodemcu-firmware
mirror of https://github.com/nodemcu/nodemcu-firmware.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
nodemcu-firmware/app/uzlib
History
Andreas Deininger bf13302d12 Fix several typos (#3491) 2024-02-25 10:08:08 +01:00
..
host trailing spaces cleanup (#2659) 2019-02-17 18:26:29 +00:00
Makefile Dev make cleanup (#2842) 2019-07-23 18:47:18 +03:00
README.md Add compression to LFS images (#2448) 2018-09-29 16:57:51 +03:00
crc32.c Add compression to LFS images (#2448) 2018-09-29 16:57:51 +03:00
uzlib.h Major cleanup - c_whatever is finally history. (#2838) 2019-07-22 00:58:21 +03:00
uzlib_deflate.c Fix several typos (#3491) 2024-02-25 10:08:08 +01:00
uzlib_inflate.c Fix several typos (#3491) 2024-02-25 10:08:08 +01:00

README.md

uzlib - Deflate/Zlib-compatible LZ77 compression library

This is a heavily modified and cut down version of Paul Sokolovsky's uzlib library. This library has exported routines which

  • Can compress data to a Deflate-compatible bitstream, albeit with lower compression ratio than the Zlib Deflate algorithm as a static Deflate Huffman tree encoding is used for bitstream). Note that since this compression is in RAM and requires ~4 bytes per byte of the input record, should only be called for compressing small records on the ESP8266.

  • Can decompress any valid Deflate, Zlib, and Gzip (further called just "Deflate") bitstream less than 16Kb, and any arbitrary length stream compressed by the uzlib compressor.

uzlib aims for minimal code size and runtime memory requirements, and thus is suitable for embedded systems and IoT devices such as the ESP8266.

uzlib is based on:

  • tinf library by Joergen Ibsen (Deflate decompression)
  • Deflate Static Huffman tree routines by Simon Tatham
  • LZ77 compressor by Paul Sokolovsky provided my initial inspiration, but I ended up rewriting this following RFC 1951 to get improved compression performance.

The above 16Kb limitation arises from the RFC 1951 use of a 32Kb dictionary, which is impractical on a chipset with only ~40 Kb RAM avialable to applications.

The relevant copyright statements are provided in the source files which use this code.

uzlib library is licensed under Zlib license.