Module provides LZ77 compression algorithm but lets the client to define his algorithm as long as he/she uses shared queue provided in this module.
Lz77 does a compression such as it searches a repeated pattern and emits a
Copy code (see
Queue.cmd) which tells us to copy a previous pattern. For instance, this is an equivalence between a list of
Queue.cmds and a
let cmds = [ `Literal 'a'; `Copy (1, 3) ]
let results = "aaaa"
The goal of
Lz77 is to produce such list from a
string to help then a format such as
DEFLATE to compress inputs.
Def does an huffman compression. From a list of
Queue.cmd, it can calculate frequencies (see
distances) and generate a smaller representation of the given alphabet. Such compression is available via the
Def.Fixed or the
Def.Dynamic block. The
Def.Flat block does a copy of any literals into the output.
NOTE: It's illegal to emit a
Queue.cmd and try to serialize it with a
Queue.eob is required for
Def.Dynamic (to delimit the end of the block) and ignored by the
de wants to be self-contained. By this constraint, it provides convenience values to be used by others (like
zl). The client should not use these functions even if they are available. Others libraries like
Bigstringaf serve the same purpose of a much better way.
The type for
type optint = Optint.t
Type type for optimal integer.
val bigstring_create : int -> bigstring
bigstring_create len returns a uninitialized bigstring of length
val bigstring_length : bigstring -> int
bigstring_length t is the length of the bigstring
t, in bytes.
val make_window : bits:int -> window
make_window allocates a new buffer which represents a window. It used by decoder and LZ77 compressor to keep tracking older inputs and:
val window_bits : window -> int
Decoder of RFC1951 DEFLATE codec.
de provides a
Inf.decoder to decode DEFLATE input and inflate it.
module Inf : sig ... end
DEFLATE encoder needs a compressed input which can be transmited by a shared queue filled by compression algorithm.
B is used between
N and a compression algorithm like
L. It provides a small representation of commands (see
Queue.cmd) emitted by compression algorithm.
N encoder interprets
Queue.cmd as fast as it can. Shared queue can be a bottleneck about the whole compression process. Indeed, it limits encoder on how many bytes it can produce. We recommend to make a queue as large as output buffer.
module Queue : sig ... end
val make_literals : unit -> literals
make_literals allocates a new
literals where frequencies of symbols (expect End Of Block) are set to 0.
val make_distances : unit -> distances
make_distances allocates a new
distances where frequencies of distance symboles are set to 0.
val succ_literal : literals -> char -> unit
succ_literals literals chr increases frequency of
val succ_length : literals -> int -> unit
succ_length literals l increases frequency of
l must be upper than 2 and lower than 259 according DEFLATE codec. Otherwise, it raises an
val succ_distance : distances -> int -> unit
succ_distance distance d increases frequency of
d must be upper than 0 and lower than 32769 according DEFLATE codec. Otherwise, it raises an
module Def : sig ... end
Distribution provides LZ77 compression algorithm which can be used with
N. However, the client must know others algorithms exist. This algorithm is used by
zz to implement ZLIB layer.
module Lz77 : sig ... end
de provides useful but complex API. This sub-module provides an easier way to compress/uncompress DEFLATE codec. Even if the client still can give some details, we recommend to use
Def if you want a precise control about memory consumption.
module Higher : sig ... end
val unsafe_set_cursor : Inf.decoder -> int -> unit
module Lookup : sig ... end
module T : sig ... end