decompress 1.2.0 · OCaml Package

type dst = [

| `Channel of Stdlib.out_channel
| `Buffer of Stdlib.Buffer.t
| `Manual

]

The type for output destinations. With a `Manual destination the client must provide output storage with dst. With `String or `Channel destination the client can safely discard `Flush case (with assert false).

type dynamic

The type for DEFLATE DYNAMIC block.

type kind =

| Flat of int
(*
A Flat len block is a non-compressed block of len byte(s). After a flat block, output is aligned on bytes.
*)
| Fixed
(*
A Fixed block is a compressed block by a precomputed Huffman tree. Any symbols can be encoded with this kind of block - encode should never return `Block with it.
*)
| Dynamic of dynamic
(*
A Dynamic h block is a compressed block by an Huffman tree represented by h. It allows to encode a subset of symbols (or any symbols).
*)

The type for DEFLATE header block.

type block = {

kind : kind;
last : bool;

}

The type for DEFLATE block.

type encode = [

| `Await
| `Flush
| `Block of block

]

The type for user action into encoder:

`Await is expected until encode returns `Ok.
`Flush asks to encoder to produce output as long as it can.
`Block block asks to encoder to produce a new block block - if current block is last block (see block), encode raises an Invalid_argument.

val dynamic_of_frequencies : 
  literals:literals ->
  distances:distances ->
  dynamic

dynamic_of_frequencies ~literals ~distances is a DEFLATE DYNAMIC block header computed from given frequencies. According frequencies, dynamic_of_frequencies makes a Huffman tree which provides smaller representation for symbols which frequency is upper than 0 (others symbols are not a part of resulted Huffman tree). At the end, a dynamic Huffman tree is able to encode a subset of symbols.

If all frequencies are upper than 0, resulted dynamic Huffman tree is able to encode any symbols.

type encoder

The type for DEFLATE encoders.

val encoder : dst -> q:Queue.t -> encoder

encoder dst ~q is an encoder that outputs to dst.

Internal queue.

encoder needs a side-channel about compressed inputs. To pass compression values to encoder, we use a queue q. Length of it can be a bottleneck where a small one will let encode to emit too many `Flush (which is commonly associated to a syscall). We recommend a queue as large as output buffer.

val encode : encoder -> encode -> [ `Ok | `Partial | `Block ]

encode e v is:

`Partial iff e has a `Manual destination and needs more output storage. The client must use dst to provide a new buffer and then call encode with `Await until `Ok is returned.
`Ok when the encoder is ready to encode a new encode action.
`Block when the encoder reachs a Queue.cmd which can not be encoded with the current block. The client must respond with `Block block where block is a new block able to encode current Queue.cmd.

How to signal end of flow?

End of flow is characterized by a block where last = true. Then, the client must emit into the queue q Queue.eob.

val dst : encoder -> bigstring -> int -> int -> unit

dst e s j l provides e with l bytes available to write, starting at j in s. This byte range is read by calls to encode with e until `Flush is returned.

raises Invalid_argument
when j and l do not correspond to a valid range.

val dst_rem : encoder -> int

dst_rem e is how many bytes it remains in given output buffer.

val bits_rem : encoder -> int

bits_rem e is how many bits it remains in given output buffer. A DEFLATE flow is not necessary aligned on bytes. The client can call bits_rem only when he reachs `End case. Otherwise, we raises an Invalid_argument.

package decompress