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