zlib/deflate.h

   1 /*
   2  * Copyright (C) 1995-2002 Jean-loup Gailly
   3  * For conditions of distribution and use, see copyright notice in zlib.h
   4  */
   5
   6 /**
   7  * \file deflate.h
   8  * Internal compression state.
   9  */
  10
  11 /* WARNING: this file should *not* be used by applications. It is
  12    part of the implementation of the compression library and is
  13    subject to change. Applications should only use zlib.h.
  14  */
  15
  16 #ifndef _DEFLATE_H
  17 #define _DEFLATE_H
  18
  19 #include "zutil.h"
  20
  21 /* ===========================================================================
  22  * Internal compression state.
  23  */
  24
  25 #define LENGTH_CODES 29
  26 /*!< number of length codes, not counting the special END_BLOCK code */
  27
  28 #define LITERALS  256
  29 /*!< number of literal bytes 0..255 */
  30
  31 #define L_CODES (LITERALS+1+LENGTH_CODES)
  32 /*!< number of Literal or Length codes, including the END_BLOCK code */
  33
  34 #define D_CODES   30
  35 /*!< number of distance codes */
  36
  37 #define BL_CODES  19
  38 /*!< number of codes used to transfer the bit lengths */
  39
  40 #define HEAP_SIZE (2*L_CODES+1)
  41 /*!< maximum heap size */
  42
  43 #define MAX_BITS 15
  44 /*!< All codes must not exceed MAX_BITS bits */
  45
  46 #define INIT_STATE    42
  47 #define BUSY_STATE   113
  48 #define FINISH_STATE 666
  49 /*!< Stream status */
  50
  51
  52 /** Data structure describing a single value and its code string. */
  53 typedef struct ct_data_s {
  54     union {
  55         ush  freq;       /*!< frequency count */
  56         ush  code;       /*!< bit string */
  57     } fc;
  58     union {
  59         ush  dad;        /*!< father node in Huffman tree */
  60         ush  len;        /*!< length of bit string */
  61     } dl;
  62 } FAR ct_data;
  63
  64 #define Freq fc.freq
  65 #define Code fc.code
  66 #define Dad  dl.dad
  67 #define Len  dl.len
  68
  69 typedef struct static_tree_desc_s  static_tree_desc;
  70
  71 typedef struct tree_desc_s {
  72     ct_data *dyn_tree;           /*!< the dynamic tree */
  73     int     max_code;            /*!< largest code with non zero frequency */
  74     static_tree_desc *stat_desc; /*!< the corresponding static tree */
  75 } FAR tree_desc;
  76
  77 typedef ush Pos;
  78 typedef Pos FAR Posf;
  79 typedef unsigned IPos;
  80
  81 /* A Pos is an index in the character window. We use short instead of int to
  82  * save space in the various tables. IPos is used only for parameter passing.
  83  */
  84
  85 typedef struct internal_state {
  86     z_streamp strm;      /*!< pointer back to this zlib stream */
  87     int   status;        /*!< as the name implies */
  88     Bytef *pending_buf;  /*!< output still pending */
  89     ulg   pending_buf_size; /*!< size of pending_buf */
  90     Bytef *pending_out;  /*!< next pending byte to output to the stream */
  91     int   pending;       /*!< nb of bytes in the pending buffer */
  92     int   noheader;      /*!< suppress zlib header and adler32 */
  93     Byte  data_type;     /*!< UNKNOWN, BINARY or ASCII */
  94     Byte  method;        /*!< STORED (for zip only) or DEFLATED */
  95     int   last_flush;    /*!< value of flush param for previous deflate call */
  96
  97                 /* used by deflate.c: */
  98
  99     uInt  w_size;        /*!< LZ77 window size (32K by default) */
 100     uInt  w_bits;        /*!< log2(w_size)  (8..16) */
 101     uInt  w_mask;        /*!< w_size - 1 */
 102
 103     Bytef *window;
 104     /*!< Sliding window. Input bytes are read into the second half of the window,
 105      * and move to the first half later to keep a dictionary of at least wSize
 106      * bytes. With this organization, matches are limited to a distance of
 107      * wSize-MAX_MATCH bytes, but this ensures that IO is always
 108      * performed with a length multiple of the block size. Also, it limits
 109      * the window size to 64K, which is quite useful on MSDOS.
 110      * To do: use the user input buffer as sliding window.
 111      */
 112
 113     ulg window_size;
 114     /*!< Actual size of window: 2*wSize, except when the user input buffer
 115      * is directly used as sliding window.
 116      */
 117
 118     Posf *prev;
 119     /*!< Link to older string with same hash index. To limit the size of this
 120      * array to 64K, this link is maintained only for the last 32K strings.
 121      * An index in this array is thus a window index modulo 32K.
 122      */
 123
 124     Posf *head; /*!< Heads of the hash chains or NIL. */
 125
 126     uInt  ins_h;          /*!< hash index of string to be inserted */
 127     uInt  hash_size;      /*!< number of elements in hash table */
 128     uInt  hash_bits;      /*!< log2(hash_size) */
 129     uInt  hash_mask;      /*!< hash_size-1 */
 130
 131     uInt  hash_shift;
 132     /*!< Number of bits by which ins_h must be shifted at each input
 133      * step. It must be such that after MIN_MATCH steps, the oldest
 134      * byte no longer takes part in the hash key, that is:
 135      *   hash_shift * MIN_MATCH >= hash_bits
 136      */
 137
 138     long block_start;
 139     /*!< Window position at the beginning of the current output block. Gets
 140      * negative when the window is moved backwards.
 141      */
 142
 143     uInt match_length;           /*!< length of best match */
 144     IPos prev_match;             /*!< previous match */
 145     int match_available;         /*!< set if previous match exists */
 146     uInt strstart;               /*!< start of string to insert */
 147     uInt match_start;            /*!< start of matching string */
 148     uInt lookahead;              /*!< number of valid bytes ahead in window */
 149
 150     uInt prev_length;
 151     /*!< Length of the best match at previous step. Matches not greater than this
 152      * are discarded. This is used in the lazy match evaluation.
 153      */
 154
 155     uInt max_chain_length;
 156     /*!< To speed up deflation, hash chains are never searched beyond this
 157      * length.  A higher limit improves compression ratio but degrades the
 158      * speed.
 159      */
 160
 161     uInt max_lazy_match;
 162     /*!< Attempt to find a better match only when the current match is strictly
 163      * smaller than this value. This mechanism is used only for compression
 164      * levels >= 4.
 165      */
 166 #   define max_insert_length  max_lazy_match
 167     /*!< Insert new strings in the hash table only if the match length is not
 168      * greater than this length. This saves time but degrades compression.
 169      * max_insert_length is used only for compression levels <= 3.
 170      */
 171
 172     int level;    /*!< compression level (1..9) */
 173     int strategy; /*!< favor or force Huffman coding*/
 174
 175     uInt good_match;
 176     /*!< Use a faster search when the previous match is longer than this */
 177
 178     int nice_match; /*!< Stop searching when current match exceeds this */
 179
 180                 /* used by trees.c: */
 181     /* Didn't use ct_data typedef below to supress compiler warning */
 182     struct ct_data_s dyn_ltree[HEAP_SIZE];   /*!< literal and length tree */
 183     struct ct_data_s dyn_dtree[2*D_CODES+1]; /*!< distance tree */
 184     struct ct_data_s bl_tree[2*BL_CODES+1];  /*!< Huffman tree for bit lengths */
 185
 186     struct tree_desc_s l_desc;               /*!< desc. for literal tree */
 187     struct tree_desc_s d_desc;               /*!< desc. for distance tree */
 188     struct tree_desc_s bl_desc;              /*!< desc. for bit length tree */
 189
 190     ush bl_count[MAX_BITS+1];
 191     /*!< number of codes at each bit length for an optimal tree */
 192
 193     int heap[2*L_CODES+1];      /*!< heap used to build the Huffman trees */
 194     int heap_len;               /*!< number of elements in the heap */
 195     int heap_max;               /*!< element of largest frequency */
 196     /*!< The sons of heap[n] are heap[2*n] and heap[2*n+1]. heap[0] is not used.
 197      * The same heap array is used to build all trees.
 198      */
 199
 200     uch depth[2*L_CODES+1];
 201     /*!< Depth of each subtree used as tie breaker for trees of equal frequency
 202      */
 203
 204     uchf *l_buf;          /*!< buffer for literals or lengths */
 205
 206     uInt  lit_bufsize;
 207     /*!< Size of match buffer for literals/lengths.  There are 4 reasons for
 208      * limiting lit_bufsize to 64K:
 209      *   - frequencies can be kept in 16 bit counters
 210      *   - if compression is not successful for the first block, all input
 211      *     data is still in the window so we can still emit a stored block even
 212      *     when input comes from standard input.  (This can also be done for
 213      *     all blocks if lit_bufsize is not greater than 32K.)
 214      *   - if compression is not successful for a file smaller than 64K, we can
 215      *     even emit a stored file instead of a stored block (saving 5 bytes).
 216      *     This is applicable only for zip (not gzip or zlib).
 217      *   - creating new Huffman trees less frequently may not provide fast
 218      *     adaptation to changes in the input data statistics. (Take for
 219      *     example a binary file with poorly compressible code followed by
 220      *     a highly compressible string table.) Smaller buffer sizes give
 221      *     fast adaptation but have of course the overhead of transmitting
 222      *     trees more frequently.
 223      *   - I can't count above 4
 224      */
 225
 226     uInt last_lit;      /*!< running index in l_buf */
 227
 228     ushf *d_buf;
 229     /*!< Buffer for distances. To simplify the code, d_buf and l_buf have
 230      * the same number of elements. To use different lengths, an extra flag
 231      * array would be necessary.
 232      */
 233
 234     ulg opt_len;        /*!< bit length of current block with optimal trees */
 235     ulg static_len;     /*!< bit length of current block with static trees */
 236     uInt matches;       /*!< number of string matches in current block */
 237     int last_eob_len;   /*!< bit length of EOB code for last block */
 238
 239 #ifdef DEBUG
 240     ulg compressed_len; /*!< total bit length of compressed file mod 2^32 */
 241     ulg bits_sent;      /*!< bit length of compressed data sent mod 2^32 */
 242 #endif
 243
 244     ush bi_buf;
 245     /*!< Output buffer. bits are inserted starting at the bottom (least
 246      * significant bits).
 247      */
 248     int bi_valid;
 249     /*!< Number of valid bits in bi_buf.  All bits above the last valid bit
 250      * are always zero.
 251      */
 252
 253 } FAR deflate_state;
 254
 255 /**
 256  * Output a byte on the stream.
 257  * IN assertion: there is enough room in pending_buf.
 258  */
 259 #define put_byte(s, c) {s->pending_buf[s->pending++] = (c);}
 260
 261
 262 #define MIN_LOOKAHEAD (MAX_MATCH+MIN_MATCH+1)
 263 /* Minimum amount of lookahead, except at the end of the input file.
 264  * See deflate.c for comments about the MIN_MATCH+1.
 265  */
 266
 267 #define MAX_DIST(s)  ((s)->w_size-MIN_LOOKAHEAD)
 268 /*!< In order to simplify the code, particularly on 16 bit machines, match
 269  * distances are limited to MAX_DIST instead of WSIZE.
 270  */
 271
 272         /* in trees.c */
 273 void _tr_init         OF((deflate_state *s))
 274         /*@modifies *s @*/;
 275 int  _tr_tally        OF((deflate_state *s, unsigned dist, unsigned lc))
 276         /*@modifies *s @*/;
 277 void _tr_flush_block  OF((deflate_state *s, charf *buf, ulg stored_len,
 278                           int eof))
 279         /*@modifies *s @*/;
 280 void _tr_align        OF((deflate_state *s))
 281         /*@modifies *s @*/;
 282 void _tr_stored_block OF((deflate_state *s, charf *buf, ulg stored_len,
 283                           int eof))
 284         /*@modifies *s @*/;
 285
 286 #define d_code(dist) \
 287    ((dist) < 256 ? _dist_code[dist] : _dist_code[256+((dist)>>7)])
 288 /*!< Mapping from a distance to a distance code. dist is the distance - 1 and
 289  * must not have side effects. _dist_code[256] and _dist_code[257] are never
 290  * used.
 291  */
 292
 293 #ifndef DEBUG
 294 /* Inline versions of _tr_tally for speed: */
 295
 296 #if defined(GEN_TREES_H) || !defined(STDC)
 297 /*@unchecked@*/
 298   extern uch _length_code[];
 299 /*@unchecked@*/
 300   extern uch _dist_code[];
 301 #else
 302 /*@unchecked@*/
 303   extern const uch _length_code[];
 304 /*@unchecked@*/
 305   extern const uch _dist_code[];
 306 #endif
 307
 308 # define _tr_tally_lit(s, c, flush) \
 309   { uch cc = (c); \
 310     s->d_buf[s->last_lit] = 0; \
 311     s->l_buf[s->last_lit++] = cc; \
 312     s->dyn_ltree[cc].Freq++; \
 313     flush = (s->last_lit == s->lit_bufsize-1); \
 314    }
 315 # define _tr_tally_dist(s, distance, length, flush) \
 316   { uch len = (length); \
 317     ush dist = (distance); \
 318     s->d_buf[s->last_lit] = dist; \
 319     s->l_buf[s->last_lit++] = len; \
 320     dist--; \
 321     s->dyn_ltree[_length_code[len]+LITERALS+1].Freq++; \
 322     s->dyn_dtree[d_code(dist)].Freq++; \
 323     flush = (s->last_lit == s->lit_bufsize-1); \
 324   }
 325 #else
 326 # define _tr_tally_lit(s, c, flush) flush = _tr_tally(s, 0, c)
 327 # define _tr_tally_dist(s, distance, length, flush) \
 328               flush = _tr_tally(s, distance, length)
 329 #endif
 330
 331 #endif