deflate.h 13 KB

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