Skip to content
/ ztml Public

Extreme inline text compression for HTML / JS. A custom pipeline that generates stand-alone HTML or JS files which embed competitively compressed self-extracting text, with file sizes of 25% - 40% the original.

License

Notifications You must be signed in to change notification settings

eyaler/ztml

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ZTML

Extreme inline text compression for HTML / JS

Partially made at Stochastic Labs

On-chain media storage can require efficient compression for text embedded inline in HTML / JS. ZTML is a custom pipeline that generates stand-alone HTML or JS files which embed competitively compressed self-extracting text, with file sizes of 25% - 40% the original. These file sizes include the decoder code which is 1.5 - 2 kB (including auxiliary indices and tables). The approach makes sense and is optimized for small texts, but performs quite well also on large texts. The pipeline includes efficient alternatives to base64 which are also useful for inline images.

File format War and Peace (en) Micromegas (en)
Project Gutenberg plain text utf8 txt 3.2 MB 63.7 kB
7-Zip 22.01 9 Ultra PPMd (excluding decoder) 7z 746 kB (23%) 20.8 kB (32%)
7-Zip 22.01 9 Ultra PPMd (self extracting) exe 958 kB (29%) 232 kB (364%)
Roadroller 2.1.0 -O2 js 1.0 MB (30%) 26.5 kB (42%)
ZTML Base125 (keep whitespace and punctuation) html (utf8) 910 kB (28%) using mtf=80 26.2 kB (41%) using mtf=0
ZTML crEnc (keep whitespace and punctuation) html (cp1252) 813 kB (25%) using mtf=80 23.4 kB (37%) using mtf=0

Usage

A standard simplified pipeline can be run by calling ztml() or running python ztml.py from the command line. See ztml.py.

crEnc gives better compression but requires setting the HTML or JS charset to cp1252. Base125 is the second best option if one must stick with utf8.

See example.py for a complete example reproducing the above benchmark.

Caveats:

  1. Files larger than a few MB might not work on iOS Safari or macOS Safari 15.
  2. This solution favors compression rate over compression and decompression times. Use mtf=None for faster decompression of large files.
  3. For compressing word lists (sorted lexicographically), solutions as Roadroller do a much better job.

ZTML pipeline breakdown:

  1. Text normalization (irreversible; reduce whitespace, substitute unicode punctuation)
  2. Text condensation (reversible; lowercase with automatic capitalization*, substitute common strings as: the, qu)
  3. Burrows–Wheeler + Move-to-front transforms on text with some optional variants, including some new ones (beneficial for large texts)
  4. Huffman encoding (with a codebook-free decoder, beneficial even as followed by DEFLATE)
  5. Burrows–Wheeler transform on bits (beneficial for large texts)
  6. PNG / DEFLATE compression (allowing native decompression, aspect ratio optimized for minimal padding, Zopfli optimization)
  7. Binary to text encoding embedded in JS template literals:
    1. crEnc encoding (a yEnc variant with 1.6% overhead, to be used with single-byte charset)
    2. Base125 encoding (a Base122 variant with 15% overhead, to be used with utf8 charset)
  8. Uglification of the generated JS (substitute recurring element, attribute and function names with short aliases)

*Automatic capitalization recovery is currently only partial. Use caps=raw or caps_fallback=True to preserve original capitalization.

Projects using this:

fragium

About

Extreme inline text compression for HTML / JS. A custom pipeline that generates stand-alone HTML or JS files which embed competitively compressed self-extracting text, with file sizes of 25% - 40% the original.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

 

Packages

No packages published