deflate.h
Go to the documentation of this file.
/* deflate.h -- internal compression state
* Copyright (C) 1995-2016 Jean-loup Gailly
* For conditions of distribution and use, see copyright notice in zlib.h
*/
/* WARNING: this file should *not* be used by applications. It is
part of the implementation of the compression library and is
subject to change. Applications should only use zlib.h.
*/
/* @(#) $Id$ */
#ifndef DEFLATE_H
#define DEFLATE_H
#include "zutil.h"
/* define NO_GZIP when compiling if you want to disable gzip header and
trailer creation by deflate(). NO_GZIP would be used to avoid linking in
the crc code when it is not needed. For shared libraries, gzip encoding
should be left enabled. */
#ifndef NO_GZIP
# define GZIP
#endif
/* ===========================================================================
* Internal compression state.
*/
#define LENGTH_CODES 29
/* number of length codes, not counting the special END_BLOCK code */
#define LITERALS 256
/* number of literal bytes 0..255 */
#define L_CODES (LITERALS+1+LENGTH_CODES)
/* number of Literal or Length codes, including the END_BLOCK code */
#define D_CODES 30
/* number of distance codes */
#define BL_CODES 19
/* number of codes used to transfer the bit lengths */
#define HEAP_SIZE (2*L_CODES+1)
/* maximum heap size */
#define MAX_BITS 15
/* All codes must not exceed MAX_BITS bits */
#define Buf_size 16
/* size of bit buffer in bi_buf */
#define INIT_STATE 42 /* zlib header -> BUSY_STATE */
#ifdef GZIP
# define GZIP_STATE 57 /* gzip header -> BUSY_STATE | EXTRA_STATE */
#endif
#define EXTRA_STATE 69 /* gzip extra block -> NAME_STATE */
#define NAME_STATE 73 /* gzip file name -> COMMENT_STATE */
#define COMMENT_STATE 91 /* gzip comment -> HCRC_STATE */
#define HCRC_STATE 103 /* gzip header CRC -> BUSY_STATE */
#define BUSY_STATE 113 /* deflate -> FINISH_STATE */
#define FINISH_STATE 666 /* stream complete */
/* Stream status */
/* Data structure describing a single value and its code string. */
typedef struct ct_data_s {
union {
ush freq; /* frequency count */
ush code; /* bit string */
} fc;
union {
ush dad; /* father node in Huffman tree */
ush len; /* length of bit string */
} dl;
} FAR ct_data;
#define Freq fc.freq
#define Code fc.code
#define Dad dl.dad
#define Len dl.len
typedef struct static_tree_desc_s static_tree_desc;
typedef struct tree_desc_s {
ct_data *dyn_tree; /* the dynamic tree */
int max_code; /* largest code with non zero frequency */
const static_tree_desc *stat_desc; /* the corresponding static tree */
} FAR tree_desc;
typedef ush Pos;
typedef Pos FAR Posf;
typedef unsigned IPos;
/* A Pos is an index in the character window. We use short instead of int to
* save space in the various tables. IPos is used only for parameter passing.
*/
typedef struct internal_state {
z_streamp strm; /* pointer back to this zlib stream */
int status; /* as the name implies */
Bytef *pending_buf; /* output still pending */
ulg pending_buf_size; /* size of pending_buf */
Bytef *pending_out; /* next pending byte to output to the stream */
ulg pending; /* nb of bytes in the pending buffer */
int wrap; /* bit 0 true for zlib, bit 1 true for gzip */
gz_headerp gzhead; /* gzip header information to write */
ulg gzindex; /* where in extra, name, or comment */
Byte method; /* can only be DEFLATED */
int last_flush; /* value of flush param for previous deflate call */
/* used by deflate.c: */
uInt w_size; /* LZ77 window size (32K by default) */
uInt w_bits; /* log2(w_size) (8..16) */
uInt w_mask; /* w_size - 1 */
Bytef *window;
/* Sliding window. Input bytes are read into the second half of the window,
* and move to the first half later to keep a dictionary of at least wSize
* bytes. With this organization, matches are limited to a distance of
* wSize-MAX_MATCH bytes, but this ensures that IO is always
* performed with a length multiple of the block size. Also, it limits
* the window size to 64K, which is quite useful on MSDOS.
* To do: use the user input buffer as sliding window.
*/
ulg window_size;
/* Actual size of window: 2*wSize, except when the user input buffer
* is directly used as sliding window.
*/
Posf *prev;
/* Link to older string with same hash index. To limit the size of this
* array to 64K, this link is maintained only for the last 32K strings.
* An index in this array is thus a window index modulo 32K.
*/
Posf *head; /* Heads of the hash chains or NIL. */
uInt ins_h; /* hash index of string to be inserted */
uInt hash_size; /* number of elements in hash table */
uInt hash_bits; /* log2(hash_size) */
uInt hash_mask; /* hash_size-1 */
uInt hash_shift;
/* Number of bits by which ins_h must be shifted at each input
* step. It must be such that after MIN_MATCH steps, the oldest
* byte no longer takes part in the hash key, that is:
* hash_shift * MIN_MATCH >= hash_bits
*/
long block_start;
/* Window position at the beginning of the current output block. Gets
* negative when the window is moved backwards.
*/
uInt match_length; /* length of best match */
IPos prev_match; /* previous match */
int match_available; /* set if previous match exists */
uInt strstart; /* start of string to insert */
uInt match_start; /* start of matching string */
uInt lookahead; /* number of valid bytes ahead in window */
uInt prev_length;
/* Length of the best match at previous step. Matches not greater than this
* are discarded. This is used in the lazy match evaluation.
*/
uInt max_chain_length;
/* To speed up deflation, hash chains are never searched beyond this
* length. A higher limit improves compression ratio but degrades the
* speed.
*/
uInt max_lazy_match;
/* Attempt to find a better match only when the current match is strictly
* smaller than this value. This mechanism is used only for compression
* levels >= 4.
*/
# define max_insert_length max_lazy_match
/* Insert new strings in the hash table only if the match length is not
* greater than this length. This saves time but degrades compression.
* max_insert_length is used only for compression levels <= 3.
*/
int level; /* compression level (1..9) */
int strategy; /* favor or force Huffman coding*/
uInt good_match;
/* Use a faster search when the previous match is longer than this */
int nice_match; /* Stop searching when current match exceeds this */
/* used by trees.c: */
/* Didn't use ct_data typedef below to suppress compiler warning */
struct ct_data_s dyn_ltree[HEAP_SIZE]; /* literal and length tree */
struct ct_data_s dyn_dtree[2*D_CODES+1]; /* distance tree */
struct ct_data_s bl_tree[2*BL_CODES+1]; /* Huffman tree for bit lengths */
struct tree_desc_s l_desc; /* desc. for literal tree */
struct tree_desc_s d_desc; /* desc. for distance tree */
struct tree_desc_s bl_desc; /* desc. for bit length tree */
ush bl_count[MAX_BITS+1];
/* number of codes at each bit length for an optimal tree */
int heap[2*L_CODES+1]; /* heap used to build the Huffman trees */
int heap_len; /* number of elements in the heap */
int heap_max; /* element of largest frequency */
/* The sons of heap[n] are heap[2*n] and heap[2*n+1]. heap[0] is not used.
* The same heap array is used to build all trees.
*/
uch depth[2*L_CODES+1];
/* Depth of each subtree used as tie breaker for trees of equal frequency
*/
uchf *l_buf; /* buffer for literals or lengths */
uInt lit_bufsize;
/* Size of match buffer for literals/lengths. There are 4 reasons for
* limiting lit_bufsize to 64K:
* - frequencies can be kept in 16 bit counters
* - if compression is not successful for the first block, all input
* data is still in the window so we can still emit a stored block even
* when input comes from standard input. (This can also be done for
* all blocks if lit_bufsize is not greater than 32K.)
* - if compression is not successful for a file smaller than 64K, we can
* even emit a stored file instead of a stored block (saving 5 bytes).
* This is applicable only for zip (not gzip or zlib).
* - creating new Huffman trees less frequently may not provide fast
* adaptation to changes in the input data statistics. (Take for
* example a binary file with poorly compressible code followed by
* a highly compressible string table.) Smaller buffer sizes give
* fast adaptation but have of course the overhead of transmitting
* trees more frequently.
* - I can't count above 4
*/
uInt last_lit; /* running index in l_buf */
ushf *d_buf;
/* Buffer for distances. To simplify the code, d_buf and l_buf have
* the same number of elements. To use different lengths, an extra flag
* array would be necessary.
*/
ulg opt_len; /* bit length of current block with optimal trees */
ulg static_len; /* bit length of current block with static trees */
uInt matches; /* number of string matches in current block */
uInt insert; /* bytes at end of window left to insert */
#ifdef ZLIB_DEBUG
ulg compressed_len; /* total bit length of compressed file mod 2^32 */
ulg bits_sent; /* bit length of compressed data sent mod 2^32 */
#endif
ush bi_buf;
/* Output buffer. bits are inserted starting at the bottom (least
* significant bits).
*/
int bi_valid;
/* Number of valid bits in bi_buf. All bits above the last valid bit
* are always zero.
*/
ulg high_water;
/* High water mark offset in window for initialized bytes -- bytes above
* this are set to zero in order to avoid memory check warnings when
* longest match routines access bytes past the input. This is then
* updated to the new high water mark.
*/
} FAR deflate_state;
/* Output a byte on the stream.
* IN assertion: there is enough room in pending_buf.
*/
#define put_byte(s, c) {s->pending_buf[s->pending++] = (Bytef)(c);}
#define MIN_LOOKAHEAD (MAX_MATCH+MIN_MATCH+1)
/* Minimum amount of lookahead, except at the end of the input file.
* See deflate.c for comments about the MIN_MATCH+1.
*/
#define MAX_DIST(s) ((s)->w_size-MIN_LOOKAHEAD)
/* In order to simplify the code, particularly on 16 bit machines, match
* distances are limited to MAX_DIST instead of WSIZE.
*/
#define WIN_INIT MAX_MATCH
/* Number of bytes after end of data in window to initialize in order to avoid
memory checker errors from longest match routines */
/* in trees.c */
void ZLIB_INTERNAL _tr_init OF((deflate_state *s));
int ZLIB_INTERNAL _tr_tally OF((deflate_state *s, unsigned dist, unsigned lc));
void ZLIB_INTERNAL _tr_flush_block OF((deflate_state *s, charf *buf,
ulg stored_len, int last));
void ZLIB_INTERNAL _tr_flush_bits OF((deflate_state *s));
void ZLIB_INTERNAL _tr_align OF((deflate_state *s));
void ZLIB_INTERNAL _tr_stored_block OF((deflate_state *s, charf *buf,
ulg stored_len, int last));
#define d_code(dist) \
((dist) < 256 ? _dist_code[dist] : _dist_code[256+((dist)>>7)])
/* Mapping from a distance to a distance code. dist is the distance - 1 and
* must not have side effects. _dist_code[256] and _dist_code[257] are never
* used.
*/
#ifndef ZLIB_DEBUG
/* Inline versions of _tr_tally for speed: */
#if defined(GEN_TREES_H) || !defined(STDC)
extern uch ZLIB_INTERNAL _length_code[];
extern uch ZLIB_INTERNAL _dist_code[];
#else
extern const uch ZLIB_INTERNAL _length_code[];
extern const uch ZLIB_INTERNAL _dist_code[];
#endif
# define _tr_tally_lit(s, c, flush) \
{ uch cc = (c); \
s->d_buf[s->last_lit] = 0; \
s->l_buf[s->last_lit++] = cc; \
s->dyn_ltree[cc].Freq++; \
flush = (s->last_lit == s->lit_bufsize-1); \
}
# define _tr_tally_dist(s, distance, length, flush) \
{ uch len = (uch)(length); \
ush dist = (ush)(distance); \
s->d_buf[s->last_lit] = dist; \
s->l_buf[s->last_lit++] = len; \
dist--; \
s->dyn_ltree[_length_code[len]+LITERALS+1].Freq++; \
s->dyn_dtree[d_code(dist)].Freq++; \
flush = (s->last_lit == s->lit_bufsize-1); \
}
#else
# define _tr_tally_lit(s, c, flush) flush = _tr_tally(s, 0, c)
# define _tr_tally_dist(s, distance, length, flush) \
flush = _tr_tally(s, distance, length)
#endif
#endif /* DEFLATE_H */
ZLIB_INTERNAL
#define ZLIB_INTERNAL
Definition: compress.c:8
ct_data
struct ct_data_s ct_data
OF
void ZLIB_INTERNAL _tr_init OF((deflate_state *s))
HEAP_SIZE
#define HEAP_SIZE
Definition: deflate.h:45
L_CODES
#define L_CODES
Definition: deflate.h:36
MAX_BITS
#define MAX_BITS
Definition: deflate.h:48
Posf
Pos FAR Posf
Definition: deflate.h:93
Pos
ush Pos
Definition: deflate.h:92
D_CODES
#define D_CODES
Definition: deflate.h:39
BL_CODES
#define BL_CODES
Definition: deflate.h:42
_length_code
uch ZLIB_INTERNAL _length_code[]
Definition: trees.c:104
IPos
unsigned IPos
Definition: deflate.h:94
tree_desc
struct tree_desc_s tree_desc
deflate_state
struct internal_state deflate_state
_dist_code
uch ZLIB_INTERNAL _dist_code[]
Definition: trees.c:98
ct_data_s
Definition: deflate.h:68
ct_data_s::code
ush code
Definition: deflate.h:71
ct_data_s::freq
ush freq
Definition: deflate.h:70
ct_data_s::dad
ush dad
Definition: deflate.h:74
ct_data_s::fc
union ct_data_s::@4 fc
ct_data_s::dl
union ct_data_s::@5 dl
ct_data_s::len
ush len
Definition: deflate.h:75
internal_state
Definition: deflate.h:100
internal_state::last_lit
uInt last_lit
Definition: deflate.h:242
internal_state::w_bits
uInt w_bits
Definition: deflate.h:116
internal_state::l_desc
struct tree_desc_s l_desc
Definition: deflate.h:202
internal_state::heap_len
int heap_len
Definition: deflate.h:210
internal_state::prev_match
IPos prev_match
Definition: deflate.h:160
internal_state::w_mask
uInt w_mask
Definition: deflate.h:117
internal_state::bi_valid
int bi_valid
Definition: deflate.h:264
internal_state::lit_bufsize
uInt lit_bufsize
Definition: deflate.h:222
internal_state::opt_len
ulg opt_len
Definition: deflate.h:250
internal_state::insert
uInt insert
Definition: deflate.h:253
internal_state::nice_match
int nice_match
Definition: deflate.h:194
internal_state::lookahead
uInt lookahead
Definition: deflate.h:164
internal_state::dyn_dtree
struct ct_data_s dyn_dtree[2 *D_CODES+1]
Definition: deflate.h:199
internal_state::pending
ulg pending
Definition: deflate.h:106
internal_state::block_start
long block_start
Definition: deflate.h:154
internal_state::window_size
ulg window_size
Definition: deflate.h:129
internal_state::hash_bits
uInt hash_bits
Definition: deflate.h:144
internal_state::l_buf
uchf * l_buf
Definition: deflate.h:220
internal_state::strategy
int strategy
Definition: deflate.h:189
internal_state::bi_buf
ush bi_buf
Definition: deflate.h:260
internal_state::good_match
uInt good_match
Definition: deflate.h:191
internal_state::pending_out
Bytef * pending_out
Definition: deflate.h:105
internal_state::prev_length
uInt prev_length
Definition: deflate.h:166
internal_state::level
int level
Definition: deflate.h:188
internal_state::hash_mask
uInt hash_mask
Definition: deflate.h:145
internal_state::high_water
ulg high_water
Definition: deflate.h:269
internal_state::w_size
uInt w_size
Definition: deflate.h:115
internal_state::status
int status
Definition: deflate.h:102
internal_state::static_len
ulg static_len
Definition: deflate.h:251
internal_state::ins_h
uInt ins_h
Definition: deflate.h:142
internal_state::window
Bytef * window
Definition: deflate.h:119
internal_state::depth
uch depth[2 *L_CODES+1]
Definition: deflate.h:216
internal_state::pending_buf_size
ulg pending_buf_size
Definition: deflate.h:104
internal_state::prev
Posf * prev
Definition: deflate.h:134
internal_state::strstart
uInt strstart
Definition: deflate.h:162
internal_state::bl_tree
struct ct_data_s bl_tree[2 *BL_CODES+1]
Definition: deflate.h:200
internal_state::bl_desc
struct tree_desc_s bl_desc
Definition: deflate.h:204
internal_state::match_length
uInt match_length
Definition: deflate.h:159
internal_state::heap_max
int heap_max
Definition: deflate.h:211
internal_state::last_flush
int last_flush
Definition: deflate.h:111
internal_state::hash_size
uInt hash_size
Definition: deflate.h:143
internal_state::strm
z_streamp strm
Definition: deflate.h:101
internal_state::head
Posf * head
Definition: deflate.h:140
internal_state::max_chain_length
uInt max_chain_length
Definition: deflate.h:171
internal_state::d_desc
struct tree_desc_s d_desc
Definition: deflate.h:203
internal_state::max_lazy_match
uInt max_lazy_match
Definition: deflate.h:177
internal_state::bl_count
ush bl_count[MAX_BITS+1]
Definition: deflate.h:206
internal_state::gzhead
gz_headerp gzhead
Definition: deflate.h:108
internal_state::matches
uInt matches
Definition: deflate.h:252
internal_state::d_buf
ushf * d_buf
Definition: deflate.h:244
internal_state::match_available
int match_available
Definition: deflate.h:161
internal_state::match_start
uInt match_start
Definition: deflate.h:163
internal_state::heap
int heap[2 *L_CODES+1]
Definition: deflate.h:209
internal_state::gzindex
ulg gzindex
Definition: deflate.h:109
internal_state::dyn_ltree
struct ct_data_s dyn_ltree[HEAP_SIZE]
Definition: deflate.h:198
internal_state::pending_buf
Bytef * pending_buf
Definition: deflate.h:103
internal_state::wrap
int wrap
Definition: deflate.h:107
internal_state::method
Byte method
Definition: deflate.h:110
internal_state::hash_shift
uInt hash_shift
Definition: deflate.h:147
static_tree_desc_s
Definition: trees.c:117
tree_desc_s
Definition: deflate.h:86
tree_desc_s::max_code
int max_code
Definition: deflate.h:88
tree_desc_s::dyn_tree
ct_data * dyn_tree
Definition: deflate.h:87
tree_desc_s::stat_desc
const static_tree_desc * stat_desc
Definition: deflate.h:89
_tr_tally
int ZLIB_INTERNAL _tr_tally(deflate_state *s, unsigned dist, unsigned lc)
Definition: trees.c:1014
_tr_init
void ZLIB_INTERNAL _tr_init(deflate_state *s)
Definition: trees.c:379
_tr_stored_block
void ZLIB_INTERNAL _tr_stored_block(deflate_state *s, charf *buf, ulg stored_len, int last)
Definition: trees.c:863
_tr_flush_bits
void ZLIB_INTERNAL _tr_flush_bits(deflate_state *s)
Definition: trees.c:886
_tr_flush_block
void ZLIB_INTERNAL _tr_flush_block(deflate_state *s, charf *buf, ulg stored_len, int last)
Definition: trees.c:911
_tr_align
void ZLIB_INTERNAL _tr_align(deflate_state *s)
Definition: trees.c:896
charf
char FAR charf
Definition: zconf.h:402
uInt
unsigned int uInt
Definition: zconf.h:393
Byte
unsigned char Byte
Definition: zconf.h:391
Bytef
Byte FAR Bytef
Definition: zconf.h:400
FAR
#define FAR
Definition: zconf.h:387
gz_headerp
gz_header FAR * gz_headerp
Definition: zlib.h:131
z_streamp
z_stream FAR * z_streamp
Definition: zlib.h:108
zutil.h
ush
unsigned short ush
Definition: zutil.h:45
uchf
uch FAR uchf
Definition: zutil.h:44
ushf
ush FAR ushf
Definition: zutil.h:46
ulg
unsigned long ulg
Definition: zutil.h:47
uch
unsigned char uch
Definition: zutil.h:43