1 /* deflate.c -- compress data using the deflation algorithm
2 * Copyright (C) 1995-2017 Jean-loup Gailly and Mark Adler
3 * For conditions of distribution and use, see copyright notice in zlib.h
9 * The "deflation" process depends on being able to identify portions
10 * of the input text which are identical to earlier input (within a
11 * sliding window trailing behind the input currently being processed).
13 * The most straightforward technique turns out to be the fastest for
14 * most input files: try all possible matches and select the longest.
15 * The key feature of this algorithm is that insertions into the string
16 * dictionary are very simple and thus fast, and deletions are avoided
17 * completely. Insertions are performed at each input character, whereas
18 * string matches are performed only when the previous match ends. So it
19 * is preferable to spend more time in matches to allow very fast string
20 * insertions and avoid deletions. The matching algorithm for small
21 * strings is inspired from that of Rabin & Karp. A brute force approach
22 * is used to find longer strings when a small match has been found.
23 * A similar algorithm is used in comic (by Jan-Mark Wams) and freeze
24 * (by Leonid Broukhis).
25 * A previous version of this file used a more sophisticated algorithm
26 * (by Fiala and Greene) which is guaranteed to run in linear amortized
27 * time, but has a larger average cost, uses more memory and is patented.
28 * However the F&G algorithm may be faster for some highly redundant
29 * files if the parameter max_chain_length (described below) is too large.
33 * The idea of lazy evaluation of matches is due to Jan-Mark Wams, and
34 * I found it in 'freeze' written by Leonid Broukhis.
35 * Thanks to many people for bug reports and testing.
39 * Deutsch, L.P.,"DEFLATE Compressed Data Format Specification".
40 * Available in http://tools.ietf.org/html/rfc1951
42 * A description of the Rabin and Karp algorithm is given in the book
43 * "Algorithms" by R. Sedgewick, Addison-Wesley, p252.
45 * Fiala,E.R., and Greene,D.H.
46 * Data Compression with Finite Windows, Comm.ACM, 32,4 (1989) 490-595
54 const char deflate_copyright[] =
55 " deflate 1.2.11 Copyright 1995-2017 Jean-loup Gailly and Mark Adler ";
57 If you use the zlib library in a product, an acknowledgment is welcome
58 in the documentation of your product. If for some reason you cannot
59 include such an acknowledgment, I would appreciate that you keep this
60 copyright string in the executable of your product.
63 /* ===========================================================================
64 * Function prototypes.
67 need_more, /* block not completed, need more input or more output */
68 block_done, /* block flush performed */
69 finish_started, /* finish started, need only more output at next deflate */
70 finish_done /* finish done, accept no more input or output */
73 typedef block_state (*compress_func) OF((deflate_state *s, int flush));
74 /* Compression function. Returns the block state after the call. */
76 local int deflateStateCheck OF((z_streamp strm));
77 local void slide_hash OF((deflate_state *s));
78 local void fill_window OF((deflate_state *s));
79 local block_state deflate_stored OF((deflate_state *s, int flush));
80 local block_state deflate_fast OF((deflate_state *s, int flush));
82 local block_state deflate_slow OF((deflate_state *s, int flush));
84 local block_state deflate_rle OF((deflate_state *s, int flush));
85 local block_state deflate_huff OF((deflate_state *s, int flush));
86 local void lm_init OF((deflate_state *s));
87 local void putShortMSB OF((deflate_state *s, uInt b));
88 local void flush_pending OF((z_streamp strm));
89 local unsigned read_buf OF((z_streamp strm, Bytef *buf, unsigned size));
91 # pragma message("Assembler code may have bugs -- use at your own risk")
92 void match_init OF((void)); /* asm code initialization */
93 uInt longest_match OF((deflate_state *s, IPos cur_match));
95 local uInt longest_match OF((deflate_state *s, IPos cur_match));
99 local void check_match OF((deflate_state *s, IPos start, IPos match,
103 /* ===========================================================================
108 /* Tail of hash chains */
111 # define TOO_FAR 4096
113 /* Matches of length 3 are discarded if their distance exceeds TOO_FAR */
115 /* Values for max_lazy_match, good_match and max_chain_length, depending on
116 * the desired pack level (0..9). The values given below have been tuned to
117 * exclude worst case performance for pathological files. Better values may be
118 * found for specific files.
120 typedef struct config_s {
121 ush good_length; /* reduce lazy search above this match length */
122 ush max_lazy; /* do not perform lazy search above this match length */
123 ush nice_length; /* quit search above this match length */
129 local const config configuration_table[2] = {
130 /* good lazy nice chain */
131 /* 0 */ {0, 0, 0, 0, deflate_stored}, /* store only */
132 /* 1 */ {4, 4, 8, 4, deflate_fast}}; /* max speed, no lazy matches */
134 local const config configuration_table[10] = {
135 /* good lazy nice chain */
136 /* 0 */ {0, 0, 0, 0, deflate_stored}, /* store only */
137 /* 1 */ {4, 4, 8, 4, deflate_fast}, /* max speed, no lazy matches */
138 /* 2 */ {4, 5, 16, 8, deflate_fast},
139 /* 3 */ {4, 6, 32, 32, deflate_fast},
141 /* 4 */ {4, 4, 16, 16, deflate_slow}, /* lazy matches */
142 /* 5 */ {8, 16, 32, 32, deflate_slow},
143 /* 6 */ {8, 16, 128, 128, deflate_slow},
144 /* 7 */ {8, 32, 128, 256, deflate_slow},
145 /* 8 */ {32, 128, 258, 1024, deflate_slow},
146 /* 9 */ {32, 258, 258, 4096, deflate_slow}}; /* max compression */
149 /* Note: the deflate() code requires max_lazy >= MIN_MATCH and max_chain >= 4
150 * For deflate_fast() (levels <= 3) good is ignored and lazy has a different
154 /* rank Z_BLOCK between Z_NO_FLUSH and Z_PARTIAL_FLUSH */
155 #define RANK(f) (((f) * 2) - ((f) > 4 ? 9 : 0))
157 /* ===========================================================================
158 * Update a hash value with the given input byte
159 * IN assertion: all calls to UPDATE_HASH are made with consecutive input
160 * characters, so that a running hash key can be computed from the previous
161 * key instead of complete recalculation each time.
163 #define UPDATE_HASH(s,h,c) (h = (((h)<<s->hash_shift) ^ (c)) & s->hash_mask)
166 /* ===========================================================================
167 * Insert string str in the dictionary and set match_head to the previous head
168 * of the hash chain (the most recent string with same hash key). Return
169 * the previous length of the hash chain.
170 * If this file is compiled with -DFASTEST, the compression level is forced
171 * to 1, and no hash chains are maintained.
172 * IN assertion: all calls to INSERT_STRING are made with consecutive input
173 * characters and the first MIN_MATCH bytes of str are valid (except for
174 * the last MIN_MATCH-1 bytes of the input file).
177 #define INSERT_STRING(s, str, match_head) \
178 (UPDATE_HASH(s, s->ins_h, s->window[(str) + (MIN_MATCH-1)]), \
179 match_head = s->head[s->ins_h], \
180 s->head[s->ins_h] = (Pos)(str))
182 #define INSERT_STRING(s, str, match_head) \
183 (UPDATE_HASH(s, s->ins_h, s->window[(str) + (MIN_MATCH-1)]), \
184 match_head = s->prev[(str) & s->w_mask] = s->head[s->ins_h], \
185 s->head[s->ins_h] = (Pos)(str))
188 /* ===========================================================================
189 * Initialize the hash table (avoiding 64K overflow for 16 bit systems).
190 * prev[] will be initialized on the fly.
192 #define CLEAR_HASH(s) do { \
193 s->head[s->hash_size-1] = NIL; \
194 zmemzero((Bytef *)s->head, (unsigned)(s->hash_size-1)*sizeof(*s->head)); \
197 /* ===========================================================================
198 * Slide the hash table when sliding the window down (could be avoided with 32
199 * bit values at the expense of memory usage). We slide even when level == 0 to
200 * keep the hash table consistent if we switch back to level > 0 later.
202 local void slide_hash(s)
207 uInt wsize = s->w_size;
213 *p = (Pos)(m >= wsize ? m - wsize : NIL);
220 *p = (Pos)(m >= wsize ? m - wsize : NIL);
221 /* If n is not on any hash chain, prev[n] is garbage but
222 * its value will never be used.
228 /* ========================================================================= */
229 int ZEXPORT deflateInit_(strm, level, version, stream_size)
235 return deflateInit2_(strm, level, Z_DEFLATED, MAX_WBITS, DEF_MEM_LEVEL,
236 Z_DEFAULT_STRATEGY, version, stream_size);
237 /* To do: ignore strm->next_in if we use it as window */
240 /* ========================================================================= */
241 int ZEXPORT deflateInit2_(strm, level, method, windowBits, memLevel, strategy,
242 version, stream_size)
254 static const char my_version[] = ZLIB_VERSION;
257 /* We overlay pending_buf and d_buf+l_buf. This works since the average
258 * output size for (length,distance) codes is <= 24 bits.
261 if (version == Z_NULL || version[0] != my_version[0] ||
262 stream_size != sizeof(z_stream)) {
263 return Z_VERSION_ERROR;
265 if (strm == Z_NULL) return Z_STREAM_ERROR;
268 if (strm->zalloc == (alloc_func)0) {
269 #if defined(Z_SOLO) && !defined(_KERNEL)
270 return Z_STREAM_ERROR;
272 strm->zalloc = zcalloc;
273 strm->opaque = (voidpf)0;
276 if (strm->zfree == (free_func)0)
277 #if defined(Z_SOLO) && !defined(_KERNEL)
278 return Z_STREAM_ERROR;
280 strm->zfree = zcfree;
284 if (level != 0) level = 1;
286 if (level == Z_DEFAULT_COMPRESSION) level = 6;
289 if (windowBits < 0) { /* suppress zlib wrapper */
291 windowBits = -windowBits;
294 else if (windowBits > 15) {
295 wrap = 2; /* write gzip wrapper instead */
299 if (memLevel < 1 || memLevel > MAX_MEM_LEVEL || method != Z_DEFLATED ||
300 windowBits < 8 || windowBits > 15 || level < 0 || level > 9 ||
301 strategy < 0 || strategy > Z_FIXED || (windowBits == 8 && wrap != 1)) {
302 return Z_STREAM_ERROR;
304 if (windowBits == 8) windowBits = 9; /* until 256-byte window bug fixed */
305 s = (deflate_state *) ZALLOC(strm, 1, sizeof(deflate_state));
306 if (s == Z_NULL) return Z_MEM_ERROR;
307 strm->state = (struct internal_state FAR *)s;
309 s->status = INIT_STATE; /* to pass state test in deflateReset() */
313 s->w_bits = (uInt)windowBits;
314 s->w_size = 1 << s->w_bits;
315 s->w_mask = s->w_size - 1;
317 s->hash_bits = (uInt)memLevel + 7;
318 s->hash_size = 1 << s->hash_bits;
319 s->hash_mask = s->hash_size - 1;
320 s->hash_shift = ((s->hash_bits+MIN_MATCH-1)/MIN_MATCH);
322 s->window = (Bytef *) ZALLOC(strm, s->w_size, 2*sizeof(Byte));
323 s->prev = (Posf *) ZALLOC(strm, s->w_size, sizeof(Pos));
324 s->head = (Posf *) ZALLOC(strm, s->hash_size, sizeof(Pos));
326 s->high_water = 0; /* nothing written to s->window yet */
328 s->lit_bufsize = 1 << (memLevel + 6); /* 16K elements by default */
330 overlay = (ushf *) ZALLOC(strm, s->lit_bufsize, sizeof(ush)+2);
331 s->pending_buf = (uchf *) overlay;
332 s->pending_buf_size = (ulg)s->lit_bufsize * (sizeof(ush)+2L);
334 if (s->window == Z_NULL || s->prev == Z_NULL || s->head == Z_NULL ||
335 s->pending_buf == Z_NULL) {
336 s->status = FINISH_STATE;
337 strm->msg = ERR_MSG(Z_MEM_ERROR);
341 s->d_buf = overlay + s->lit_bufsize/sizeof(ush);
342 s->l_buf = s->pending_buf + (1+sizeof(ush))*s->lit_bufsize;
345 s->strategy = strategy;
346 s->method = (Byte)method;
348 return deflateReset(strm);
351 /* =========================================================================
352 * Check for a valid deflate stream state. Return 0 if ok, 1 if not.
354 local int deflateStateCheck (strm)
358 if (strm == Z_NULL ||
359 strm->zalloc == (alloc_func)0 || strm->zfree == (free_func)0)
362 if (s == Z_NULL || s->strm != strm || (s->status != INIT_STATE &&
364 s->status != GZIP_STATE &&
366 s->status != EXTRA_STATE &&
367 s->status != NAME_STATE &&
368 s->status != COMMENT_STATE &&
369 s->status != HCRC_STATE &&
370 s->status != BUSY_STATE &&
371 s->status != FINISH_STATE))
376 /* ========================================================================= */
377 int ZEXPORT deflateSetDictionary (strm, dictionary, dictLength)
379 const Bytef *dictionary;
386 z_const unsigned char *next;
388 if (deflateStateCheck(strm) || dictionary == Z_NULL)
389 return Z_STREAM_ERROR;
392 if (wrap == 2 || (wrap == 1 && s->status != INIT_STATE) || s->lookahead)
393 return Z_STREAM_ERROR;
395 /* when using zlib wrappers, compute Adler-32 for provided dictionary */
397 strm->adler = adler32(strm->adler, dictionary, dictLength);
398 s->wrap = 0; /* avoid computing Adler-32 in read_buf */
400 /* if dictionary would fill window, just replace the history */
401 if (dictLength >= s->w_size) {
402 if (wrap == 0) { /* already empty otherwise */
408 dictionary += dictLength - s->w_size; /* use the tail */
409 dictLength = s->w_size;
412 /* insert dictionary into window and hash */
413 avail = strm->avail_in;
414 next = strm->next_in;
415 strm->avail_in = dictLength;
416 strm->next_in = (z_const Bytef *)dictionary;
418 while (s->lookahead >= MIN_MATCH) {
420 n = s->lookahead - (MIN_MATCH-1);
422 UPDATE_HASH(s, s->ins_h, s->window[str + MIN_MATCH-1]);
424 s->prev[str & s->w_mask] = s->head[s->ins_h];
426 s->head[s->ins_h] = (Pos)str;
430 s->lookahead = MIN_MATCH-1;
433 s->strstart += s->lookahead;
434 s->block_start = (long)s->strstart;
435 s->insert = s->lookahead;
437 s->match_length = s->prev_length = MIN_MATCH-1;
438 s->match_available = 0;
439 strm->next_in = next;
440 strm->avail_in = avail;
445 /* ========================================================================= */
446 int ZEXPORT deflateGetDictionary (strm, dictionary, dictLength)
454 if (deflateStateCheck(strm))
455 return Z_STREAM_ERROR;
457 len = s->strstart + s->lookahead;
460 if (dictionary != Z_NULL && len)
461 zmemcpy(dictionary, s->window + s->strstart + s->lookahead - len, len);
462 if (dictLength != Z_NULL)
467 /* ========================================================================= */
468 int ZEXPORT deflateResetKeep (strm)
473 if (deflateStateCheck(strm)) {
474 return Z_STREAM_ERROR;
477 strm->total_in = strm->total_out = 0;
478 strm->msg = Z_NULL; /* use zfree if we ever allocate msg dynamically */
479 strm->data_type = Z_UNKNOWN;
481 s = (deflate_state *)strm->state;
483 s->pending_out = s->pending_buf;
486 s->wrap = -s->wrap; /* was made negative by deflate(..., Z_FINISH); */
490 s->wrap == 2 ? GZIP_STATE :
492 s->wrap ? INIT_STATE : BUSY_STATE;
495 s->wrap == 2 ? crc32(0L, Z_NULL, 0) :
497 adler32(0L, Z_NULL, 0);
505 /* ========================================================================= */
506 int ZEXPORT deflateReset (strm)
511 ret = deflateResetKeep(strm);
513 lm_init(strm->state);
517 /* ========================================================================= */
518 int ZEXPORT deflateSetHeader (strm, head)
522 if (deflateStateCheck(strm) || strm->state->wrap != 2)
523 return Z_STREAM_ERROR;
524 strm->state->gzhead = head;
528 /* ========================================================================= */
529 int ZEXPORT deflatePending (strm, pending, bits)
534 if (deflateStateCheck(strm)) return Z_STREAM_ERROR;
535 if (pending != Z_NULL)
536 *pending = strm->state->pending;
538 *bits = strm->state->bi_valid;
542 /* ========================================================================= */
543 int ZEXPORT deflatePrime (strm, bits, value)
551 if (deflateStateCheck(strm)) return Z_STREAM_ERROR;
553 if ((Bytef *)(s->d_buf) < s->pending_out + ((Buf_size + 7) >> 3))
556 put = Buf_size - s->bi_valid;
559 s->bi_buf |= (ush)((value & ((1 << put) - 1)) << s->bi_valid);
568 /* ========================================================================= */
569 int ZEXPORT deflateParams(strm, level, strategy)
577 if (deflateStateCheck(strm)) return Z_STREAM_ERROR;
581 if (level != 0) level = 1;
583 if (level == Z_DEFAULT_COMPRESSION) level = 6;
585 if (level < 0 || level > 9 || strategy < 0 || strategy > Z_FIXED) {
586 return Z_STREAM_ERROR;
588 func = configuration_table[s->level].func;
590 if ((strategy != s->strategy || func != configuration_table[level].func) &&
591 s->last_flush != -2) {
592 /* Flush the last buffer: */
593 int err = deflate(strm, Z_BLOCK);
594 if (err == Z_STREAM_ERROR)
596 if (strm->avail_in || (s->strstart - s->block_start) + s->lookahead)
599 if (s->level != level) {
600 if (s->level == 0 && s->matches != 0) {
608 s->max_lazy_match = configuration_table[level].max_lazy;
609 s->good_match = configuration_table[level].good_length;
610 s->nice_match = configuration_table[level].nice_length;
611 s->max_chain_length = configuration_table[level].max_chain;
613 s->strategy = strategy;
617 /* ========================================================================= */
618 int ZEXPORT deflateTune(strm, good_length, max_lazy, nice_length, max_chain)
627 if (deflateStateCheck(strm)) return Z_STREAM_ERROR;
629 s->good_match = (uInt)good_length;
630 s->max_lazy_match = (uInt)max_lazy;
631 s->nice_match = nice_length;
632 s->max_chain_length = (uInt)max_chain;
636 /* =========================================================================
637 * For the default windowBits of 15 and memLevel of 8, this function returns
638 * a close to exact, as well as small, upper bound on the compressed size.
639 * They are coded as constants here for a reason--if the #define's are
640 * changed, then this function needs to be changed as well. The return
641 * value for 15 and 8 only works for those exact settings.
643 * For any setting other than those defaults for windowBits and memLevel,
644 * the value returned is a conservative worst case for the maximum expansion
645 * resulting from using fixed blocks instead of stored blocks, which deflate
646 * can emit on compressed data for some combinations of the parameters.
648 * This function could be more sophisticated to provide closer upper bounds for
649 * every combination of windowBits and memLevel. But even the conservative
650 * upper bound of about 14% expansion does not seem onerous for output buffer
653 uLong ZEXPORT deflateBound(strm, sourceLen)
658 uLong complen, wraplen;
660 /* conservative upper bound for compressed data */
661 complen = sourceLen +
662 ((sourceLen + 7) >> 3) + ((sourceLen + 63) >> 6) + 5;
664 /* if can't get parameters, return conservative bound plus zlib wrapper */
665 if (deflateStateCheck(strm))
668 /* compute wrapper length */
671 case 0: /* raw deflate */
674 case 1: /* zlib wrapper */
675 wraplen = 6 + (s->strstart ? 4 : 0);
678 case 2: /* gzip wrapper */
680 if (s->gzhead != Z_NULL) { /* user-supplied gzip header */
682 if (s->gzhead->extra != Z_NULL)
683 wraplen += 2 + s->gzhead->extra_len;
684 str = s->gzhead->name;
689 str = s->gzhead->comment;
699 default: /* for compiler happiness */
703 /* if not default parameters, return conservative bound */
704 if (s->w_bits != 15 || s->hash_bits != 8 + 7)
705 return complen + wraplen;
707 /* default settings: return tight bound for that case */
708 return sourceLen + (sourceLen >> 12) + (sourceLen >> 14) +
709 (sourceLen >> 25) + 13 - 6 + wraplen;
712 /* =========================================================================
713 * Put a short in the pending buffer. The 16-bit value is put in MSB order.
714 * IN assertion: the stream state is correct and there is enough room in
717 local void putShortMSB (s, b)
721 put_byte(s, (Byte)(b >> 8));
722 put_byte(s, (Byte)(b & 0xff));
725 /* =========================================================================
726 * Flush as much pending output as possible. All deflate() output, except for
727 * some deflate_stored() output, goes through this function so some
728 * applications may wish to modify it to avoid allocating a large
729 * strm->next_out buffer and copying into it. (See also read_buf()).
731 local void flush_pending(strm)
735 deflate_state *s = strm->state;
739 if (len > strm->avail_out) len = strm->avail_out;
740 if (len == 0) return;
742 zmemcpy(strm->next_out, s->pending_out, len);
743 strm->next_out += len;
744 s->pending_out += len;
745 strm->total_out += len;
746 strm->avail_out -= len;
748 if (s->pending == 0) {
749 s->pending_out = s->pending_buf;
753 /* ===========================================================================
754 * Update the header CRC with the bytes s->pending_buf[beg..s->pending - 1].
756 #define HCRC_UPDATE(beg) \
758 if (s->gzhead->hcrc && s->pending > (beg)) \
759 strm->adler = crc32(strm->adler, s->pending_buf + (beg), \
760 s->pending - (beg)); \
763 /* ========================================================================= */
764 int ZEXPORT deflate (strm, flush)
768 int old_flush; /* value of flush param for previous deflate call */
771 if (deflateStateCheck(strm) || flush > Z_BLOCK || flush < 0) {
772 return Z_STREAM_ERROR;
776 if (strm->next_out == Z_NULL ||
777 (strm->avail_in != 0 && strm->next_in == Z_NULL) ||
778 (s->status == FINISH_STATE && flush != Z_FINISH)) {
779 ERR_RETURN(strm, Z_STREAM_ERROR);
781 if (strm->avail_out == 0) ERR_RETURN(strm, Z_BUF_ERROR);
783 old_flush = s->last_flush;
784 s->last_flush = flush;
786 /* Flush as much pending output as possible */
787 if (s->pending != 0) {
789 if (strm->avail_out == 0) {
790 /* Since avail_out is 0, deflate will be called again with
791 * more output space, but possibly with both pending and
792 * avail_in equal to zero. There won't be anything to do,
793 * but this is not an error situation so make sure we
794 * return OK instead of BUF_ERROR at next call of deflate:
800 /* Make sure there is something to do and avoid duplicate consecutive
801 * flushes. For repeated and useless calls with Z_FINISH, we keep
802 * returning Z_STREAM_END instead of Z_BUF_ERROR.
804 } else if (strm->avail_in == 0 && RANK(flush) <= RANK(old_flush) &&
806 ERR_RETURN(strm, Z_BUF_ERROR);
809 /* User must not provide more input after the first FINISH: */
810 if (s->status == FINISH_STATE && strm->avail_in != 0) {
811 ERR_RETURN(strm, Z_BUF_ERROR);
814 /* Write the header */
815 if (s->status == INIT_STATE) {
817 uInt header = (Z_DEFLATED + ((s->w_bits-8)<<4)) << 8;
820 if (s->strategy >= Z_HUFFMAN_ONLY || s->level < 2)
822 else if (s->level < 6)
824 else if (s->level == 6)
828 header |= (level_flags << 6);
829 if (s->strstart != 0) header |= PRESET_DICT;
830 header += 31 - (header % 31);
832 putShortMSB(s, header);
834 /* Save the adler32 of the preset dictionary: */
835 if (s->strstart != 0) {
836 putShortMSB(s, (uInt)(strm->adler >> 16));
837 putShortMSB(s, (uInt)(strm->adler & 0xffff));
839 strm->adler = adler32(0L, Z_NULL, 0);
840 s->status = BUSY_STATE;
842 /* Compression must start with an empty pending buffer */
844 if (s->pending != 0) {
850 if (s->status == GZIP_STATE) {
852 strm->adler = crc32(0L, Z_NULL, 0);
856 if (s->gzhead == Z_NULL) {
862 put_byte(s, s->level == 9 ? 2 :
863 (s->strategy >= Z_HUFFMAN_ONLY || s->level < 2 ?
865 put_byte(s, OS_CODE);
866 s->status = BUSY_STATE;
868 /* Compression must start with an empty pending buffer */
870 if (s->pending != 0) {
876 put_byte(s, (s->gzhead->text ? 1 : 0) +
877 (s->gzhead->hcrc ? 2 : 0) +
878 (s->gzhead->extra == Z_NULL ? 0 : 4) +
879 (s->gzhead->name == Z_NULL ? 0 : 8) +
880 (s->gzhead->comment == Z_NULL ? 0 : 16)
882 put_byte(s, (Byte)(s->gzhead->time & 0xff));
883 put_byte(s, (Byte)((s->gzhead->time >> 8) & 0xff));
884 put_byte(s, (Byte)((s->gzhead->time >> 16) & 0xff));
885 put_byte(s, (Byte)((s->gzhead->time >> 24) & 0xff));
886 put_byte(s, s->level == 9 ? 2 :
887 (s->strategy >= Z_HUFFMAN_ONLY || s->level < 2 ?
889 put_byte(s, s->gzhead->os & 0xff);
890 if (s->gzhead->extra != Z_NULL) {
891 put_byte(s, s->gzhead->extra_len & 0xff);
892 put_byte(s, (s->gzhead->extra_len >> 8) & 0xff);
895 strm->adler = crc32(strm->adler, s->pending_buf,
898 s->status = EXTRA_STATE;
901 if (s->status == EXTRA_STATE) {
902 if (s->gzhead->extra != Z_NULL) {
903 ulg beg = s->pending; /* start of bytes to update crc */
904 uInt left = (s->gzhead->extra_len & 0xffff) - s->gzindex;
905 while (s->pending + left > s->pending_buf_size) {
906 uInt copy = s->pending_buf_size - s->pending;
907 zmemcpy(s->pending_buf + s->pending,
908 s->gzhead->extra + s->gzindex, copy);
909 s->pending = s->pending_buf_size;
913 if (s->pending != 0) {
920 zmemcpy(s->pending_buf + s->pending,
921 s->gzhead->extra + s->gzindex, left);
926 s->status = NAME_STATE;
928 if (s->status == NAME_STATE) {
929 if (s->gzhead->name != Z_NULL) {
930 ulg beg = s->pending; /* start of bytes to update crc */
933 if (s->pending == s->pending_buf_size) {
936 if (s->pending != 0) {
942 val = s->gzhead->name[s->gzindex++];
948 s->status = COMMENT_STATE;
950 if (s->status == COMMENT_STATE) {
951 if (s->gzhead->comment != Z_NULL) {
952 ulg beg = s->pending; /* start of bytes to update crc */
955 if (s->pending == s->pending_buf_size) {
958 if (s->pending != 0) {
964 val = s->gzhead->comment[s->gzindex++];
969 s->status = HCRC_STATE;
971 if (s->status == HCRC_STATE) {
972 if (s->gzhead->hcrc) {
973 if (s->pending + 2 > s->pending_buf_size) {
975 if (s->pending != 0) {
980 put_byte(s, (Byte)(strm->adler & 0xff));
981 put_byte(s, (Byte)((strm->adler >> 8) & 0xff));
982 strm->adler = crc32(0L, Z_NULL, 0);
984 s->status = BUSY_STATE;
986 /* Compression must start with an empty pending buffer */
988 if (s->pending != 0) {
995 /* Start a new block or continue the current one.
997 if (strm->avail_in != 0 || s->lookahead != 0 ||
998 (flush != Z_NO_FLUSH && s->status != FINISH_STATE)) {
1001 bstate = s->level == 0 ? deflate_stored(s, flush) :
1002 s->strategy == Z_HUFFMAN_ONLY ? deflate_huff(s, flush) :
1003 s->strategy == Z_RLE ? deflate_rle(s, flush) :
1004 (*(configuration_table[s->level].func))(s, flush);
1006 if (bstate == finish_started || bstate == finish_done) {
1007 s->status = FINISH_STATE;
1009 if (bstate == need_more || bstate == finish_started) {
1010 if (strm->avail_out == 0) {
1011 s->last_flush = -1; /* avoid BUF_ERROR next call, see above */
1014 /* If flush != Z_NO_FLUSH && avail_out == 0, the next call
1015 * of deflate should use the same flush parameter to make sure
1016 * that the flush is complete. So we don't have to output an
1017 * empty block here, this will be done at next call. This also
1018 * ensures that for a very small output buffer, we emit at most
1022 if (bstate == block_done) {
1023 if (flush == Z_PARTIAL_FLUSH) {
1025 } else if (flush != Z_BLOCK) { /* FULL_FLUSH or SYNC_FLUSH */
1026 _tr_stored_block(s, (char*)0, 0L, 0);
1027 /* For a full flush, this empty block will be recognized
1028 * as a special marker by inflate_sync().
1030 if (flush == Z_FULL_FLUSH) {
1031 CLEAR_HASH(s); /* forget history */
1032 if (s->lookahead == 0) {
1034 s->block_start = 0L;
1039 flush_pending(strm);
1040 if (strm->avail_out == 0) {
1041 s->last_flush = -1; /* avoid BUF_ERROR at next call, see above */
1047 if (flush != Z_FINISH) return Z_OK;
1048 if (s->wrap <= 0) return Z_STREAM_END;
1050 /* Write the trailer */
1053 put_byte(s, (Byte)(strm->adler & 0xff));
1054 put_byte(s, (Byte)((strm->adler >> 8) & 0xff));
1055 put_byte(s, (Byte)((strm->adler >> 16) & 0xff));
1056 put_byte(s, (Byte)((strm->adler >> 24) & 0xff));
1057 put_byte(s, (Byte)(strm->total_in & 0xff));
1058 put_byte(s, (Byte)((strm->total_in >> 8) & 0xff));
1059 put_byte(s, (Byte)((strm->total_in >> 16) & 0xff));
1060 put_byte(s, (Byte)((strm->total_in >> 24) & 0xff));
1065 putShortMSB(s, (uInt)(strm->adler >> 16));
1066 putShortMSB(s, (uInt)(strm->adler & 0xffff));
1068 flush_pending(strm);
1069 /* If avail_out is zero, the application will call deflate again
1070 * to flush the rest.
1072 if (s->wrap > 0) s->wrap = -s->wrap; /* write the trailer only once! */
1073 return s->pending != 0 ? Z_OK : Z_STREAM_END;
1076 /* ========================================================================= */
1077 int ZEXPORT deflateEnd (strm)
1082 if (deflateStateCheck(strm)) return Z_STREAM_ERROR;
1084 status = strm->state->status;
1086 /* Deallocate in reverse order of allocations: */
1087 TRY_FREE(strm, strm->state->pending_buf);
1088 TRY_FREE(strm, strm->state->head);
1089 TRY_FREE(strm, strm->state->prev);
1090 TRY_FREE(strm, strm->state->window);
1092 ZFREE(strm, strm->state);
1093 strm->state = Z_NULL;
1095 return status == BUSY_STATE ? Z_DATA_ERROR : Z_OK;
1098 /* =========================================================================
1099 * Copy the source state to the destination state.
1100 * To simplify the source, this is not supported for 16-bit MSDOS (which
1101 * doesn't have enough memory anyway to duplicate compression states).
1103 int ZEXPORT deflateCopy (dest, source)
1108 return Z_STREAM_ERROR;
1115 if (deflateStateCheck(source) || dest == Z_NULL) {
1116 return Z_STREAM_ERROR;
1121 zmemcpy((voidpf)dest, (voidpf)source, sizeof(z_stream));
1123 ds = (deflate_state *) ZALLOC(dest, 1, sizeof(deflate_state));
1124 if (ds == Z_NULL) return Z_MEM_ERROR;
1125 dest->state = (struct internal_state FAR *) ds;
1126 zmemcpy((voidpf)ds, (voidpf)ss, sizeof(deflate_state));
1129 ds->window = (Bytef *) ZALLOC(dest, ds->w_size, 2*sizeof(Byte));
1130 ds->prev = (Posf *) ZALLOC(dest, ds->w_size, sizeof(Pos));
1131 ds->head = (Posf *) ZALLOC(dest, ds->hash_size, sizeof(Pos));
1132 overlay = (ushf *) ZALLOC(dest, ds->lit_bufsize, sizeof(ush)+2);
1133 ds->pending_buf = (uchf *) overlay;
1135 if (ds->window == Z_NULL || ds->prev == Z_NULL || ds->head == Z_NULL ||
1136 ds->pending_buf == Z_NULL) {
1140 /* following zmemcpy do not work for 16-bit MSDOS */
1141 zmemcpy(ds->window, ss->window, ds->w_size * 2 * sizeof(Byte));
1142 zmemcpy((voidpf)ds->prev, (voidpf)ss->prev, ds->w_size * sizeof(Pos));
1143 zmemcpy((voidpf)ds->head, (voidpf)ss->head, ds->hash_size * sizeof(Pos));
1144 zmemcpy(ds->pending_buf, ss->pending_buf, (uInt)ds->pending_buf_size);
1146 ds->pending_out = ds->pending_buf + (ss->pending_out - ss->pending_buf);
1147 ds->d_buf = overlay + ds->lit_bufsize/sizeof(ush);
1148 ds->l_buf = ds->pending_buf + (1+sizeof(ush))*ds->lit_bufsize;
1150 ds->l_desc.dyn_tree = ds->dyn_ltree;
1151 ds->d_desc.dyn_tree = ds->dyn_dtree;
1152 ds->bl_desc.dyn_tree = ds->bl_tree;
1155 #endif /* MAXSEG_64K */
1158 /* ===========================================================================
1159 * Read a new buffer from the current input stream, update the adler32
1160 * and total number of bytes read. All deflate() input goes through
1161 * this function so some applications may wish to modify it to avoid
1162 * allocating a large strm->next_in buffer and copying from it.
1163 * (See also flush_pending()).
1165 local unsigned read_buf(strm, buf, size)
1170 unsigned len = strm->avail_in;
1172 if (len > size) len = size;
1173 if (len == 0) return 0;
1175 strm->avail_in -= len;
1177 zmemcpy(buf, strm->next_in, len);
1178 if (strm->state->wrap == 1) {
1179 strm->adler = adler32(strm->adler, buf, len);
1182 else if (strm->state->wrap == 2) {
1183 strm->adler = crc32(strm->adler, buf, len);
1186 strm->next_in += len;
1187 strm->total_in += len;
1192 /* ===========================================================================
1193 * Initialize the "longest match" routines for a new zlib stream
1195 local void lm_init (s)
1198 s->window_size = (ulg)2L*s->w_size;
1202 /* Set the default configuration parameters:
1204 s->max_lazy_match = configuration_table[s->level].max_lazy;
1205 s->good_match = configuration_table[s->level].good_length;
1206 s->nice_match = configuration_table[s->level].nice_length;
1207 s->max_chain_length = configuration_table[s->level].max_chain;
1210 s->block_start = 0L;
1213 s->match_length = s->prev_length = MIN_MATCH-1;
1214 s->match_available = 0;
1218 match_init(); /* initialize the asm code */
1224 /* ===========================================================================
1225 * Set match_start to the longest match starting at the given string and
1226 * return its length. Matches shorter or equal to prev_length are discarded,
1227 * in which case the result is equal to prev_length and match_start is
1229 * IN assertions: cur_match is the head of the hash chain for the current
1230 * string (strstart) and its distance is <= MAX_DIST, and prev_length >= 1
1231 * OUT assertion: the match length is not greater than s->lookahead.
1234 /* For 80x86 and 680x0, an optimized version will be provided in match.asm or
1235 * match.S. The code will be functionally equivalent.
1237 local uInt longest_match(s, cur_match)
1239 IPos cur_match; /* current match */
1241 unsigned chain_length = s->max_chain_length;/* max hash chain length */
1242 register Bytef *scan = s->window + s->strstart; /* current string */
1243 register Bytef *match; /* matched string */
1244 register int len; /* length of current match */
1245 int best_len = (int)s->prev_length; /* best match length so far */
1246 int nice_match = s->nice_match; /* stop if match long enough */
1247 IPos limit = s->strstart > (IPos)MAX_DIST(s) ?
1248 s->strstart - (IPos)MAX_DIST(s) : NIL;
1249 /* Stop when cur_match becomes <= limit. To simplify the code,
1250 * we prevent matches with the string of window index 0.
1252 Posf *prev = s->prev;
1253 uInt wmask = s->w_mask;
1256 /* Compare two bytes at a time. Note: this is not always beneficial.
1257 * Try with and without -DUNALIGNED_OK to check.
1259 register Bytef *strend = s->window + s->strstart + MAX_MATCH - 1;
1260 register ush scan_start = *(ushf*)scan;
1261 register ush scan_end = *(ushf*)(scan+best_len-1);
1263 register Bytef *strend = s->window + s->strstart + MAX_MATCH;
1264 register Byte scan_end1 = scan[best_len-1];
1265 register Byte scan_end = scan[best_len];
1268 /* The code is optimized for HASH_BITS >= 8 and MAX_MATCH-2 multiple of 16.
1269 * It is easy to get rid of this optimization if necessary.
1271 Assert(s->hash_bits >= 8 && MAX_MATCH == 258, "Code too clever");
1273 /* Do not waste too much time if we already have a good match: */
1274 if (s->prev_length >= s->good_match) {
1277 /* Do not look for matches beyond the end of the input. This is necessary
1278 * to make deflate deterministic.
1280 if ((uInt)nice_match > s->lookahead) nice_match = (int)s->lookahead;
1282 Assert((ulg)s->strstart <= s->window_size-MIN_LOOKAHEAD, "need lookahead");
1285 Assert(cur_match < s->strstart, "no future");
1286 match = s->window + cur_match;
1288 /* Skip to next match if the match length cannot increase
1289 * or if the match length is less than 2. Note that the checks below
1290 * for insufficient lookahead only occur occasionally for performance
1291 * reasons. Therefore uninitialized memory will be accessed, and
1292 * conditional jumps will be made that depend on those values.
1293 * However the length of the match is limited to the lookahead, so
1294 * the output of deflate is not affected by the uninitialized values.
1296 #if (defined(UNALIGNED_OK) && MAX_MATCH == 258)
1297 /* This code assumes sizeof(unsigned short) == 2. Do not use
1298 * UNALIGNED_OK if your compiler uses a different size.
1300 if (*(ushf*)(match+best_len-1) != scan_end ||
1301 *(ushf*)match != scan_start) continue;
1303 /* It is not necessary to compare scan[2] and match[2] since they are
1304 * always equal when the other bytes match, given that the hash keys
1305 * are equal and that HASH_BITS >= 8. Compare 2 bytes at a time at
1306 * strstart+3, +5, ... up to strstart+257. We check for insufficient
1307 * lookahead only every 4th comparison; the 128th check will be made
1308 * at strstart+257. If MAX_MATCH-2 is not a multiple of 8, it is
1309 * necessary to put more guard bytes at the end of the window, or
1310 * to check more often for insufficient lookahead.
1312 Assert(scan[2] == match[2], "scan[2]?");
1315 } while (*(ushf*)(scan+=2) == *(ushf*)(match+=2) &&
1316 *(ushf*)(scan+=2) == *(ushf*)(match+=2) &&
1317 *(ushf*)(scan+=2) == *(ushf*)(match+=2) &&
1318 *(ushf*)(scan+=2) == *(ushf*)(match+=2) &&
1320 /* The funny "do {}" generates better code on most compilers */
1322 /* Here, scan <= window+strstart+257 */
1323 Assert(scan <= s->window+(unsigned)(s->window_size-1), "wild scan");
1324 if (*scan == *match) scan++;
1326 len = (MAX_MATCH - 1) - (int)(strend-scan);
1327 scan = strend - (MAX_MATCH-1);
1329 #else /* UNALIGNED_OK */
1331 if (match[best_len] != scan_end ||
1332 match[best_len-1] != scan_end1 ||
1334 *++match != scan[1]) continue;
1336 /* The check at best_len-1 can be removed because it will be made
1337 * again later. (This heuristic is not always a win.)
1338 * It is not necessary to compare scan[2] and match[2] since they
1339 * are always equal when the other bytes match, given that
1340 * the hash keys are equal and that HASH_BITS >= 8.
1343 Assert(*scan == *match, "match[2]?");
1345 /* We check for insufficient lookahead only every 8th comparison;
1346 * the 256th check will be made at strstart+258.
1349 } while (*++scan == *++match && *++scan == *++match &&
1350 *++scan == *++match && *++scan == *++match &&
1351 *++scan == *++match && *++scan == *++match &&
1352 *++scan == *++match && *++scan == *++match &&
1355 Assert(scan <= s->window+(unsigned)(s->window_size-1), "wild scan");
1357 len = MAX_MATCH - (int)(strend - scan);
1358 scan = strend - MAX_MATCH;
1360 #endif /* UNALIGNED_OK */
1362 if (len > best_len) {
1363 s->match_start = cur_match;
1365 if (len >= nice_match) break;
1367 scan_end = *(ushf*)(scan+best_len-1);
1369 scan_end1 = scan[best_len-1];
1370 scan_end = scan[best_len];
1373 } while ((cur_match = prev[cur_match & wmask]) > limit
1374 && --chain_length != 0);
1376 if ((uInt)best_len <= s->lookahead) return (uInt)best_len;
1377 return s->lookahead;
1383 /* ---------------------------------------------------------------------------
1384 * Optimized version for FASTEST only
1386 local uInt longest_match(s, cur_match)
1388 IPos cur_match; /* current match */
1390 register Bytef *scan = s->window + s->strstart; /* current string */
1391 register Bytef *match; /* matched string */
1392 register int len; /* length of current match */
1393 register Bytef *strend = s->window + s->strstart + MAX_MATCH;
1395 /* The code is optimized for HASH_BITS >= 8 and MAX_MATCH-2 multiple of 16.
1396 * It is easy to get rid of this optimization if necessary.
1398 Assert(s->hash_bits >= 8 && MAX_MATCH == 258, "Code too clever");
1400 Assert((ulg)s->strstart <= s->window_size-MIN_LOOKAHEAD, "need lookahead");
1402 Assert(cur_match < s->strstart, "no future");
1404 match = s->window + cur_match;
1406 /* Return failure if the match length is less than 2:
1408 if (match[0] != scan[0] || match[1] != scan[1]) return MIN_MATCH-1;
1410 /* The check at best_len-1 can be removed because it will be made
1411 * again later. (This heuristic is not always a win.)
1412 * It is not necessary to compare scan[2] and match[2] since they
1413 * are always equal when the other bytes match, given that
1414 * the hash keys are equal and that HASH_BITS >= 8.
1416 scan += 2, match += 2;
1417 Assert(*scan == *match, "match[2]?");
1419 /* We check for insufficient lookahead only every 8th comparison;
1420 * the 256th check will be made at strstart+258.
1423 } while (*++scan == *++match && *++scan == *++match &&
1424 *++scan == *++match && *++scan == *++match &&
1425 *++scan == *++match && *++scan == *++match &&
1426 *++scan == *++match && *++scan == *++match &&
1429 Assert(scan <= s->window+(unsigned)(s->window_size-1), "wild scan");
1431 len = MAX_MATCH - (int)(strend - scan);
1433 if (len < MIN_MATCH) return MIN_MATCH - 1;
1435 s->match_start = cur_match;
1436 return (uInt)len <= s->lookahead ? (uInt)len : s->lookahead;
1439 #endif /* FASTEST */
1444 /* result of memcmp for equal strings */
1446 /* ===========================================================================
1447 * Check that the match at match_start is indeed a match.
1449 local void check_match(s, start, match, length)
1454 /* check that the match is indeed a match */
1455 if (zmemcmp(s->window + match,
1456 s->window + start, length) != EQUAL) {
1457 fprintf(stderr, " start %u, match %u, length %d\n",
1458 start, match, length);
1460 fprintf(stderr, "%c%c", s->window[match++], s->window[start++]);
1461 } while (--length != 0);
1462 z_error("invalid match");
1464 if (z_verbose > 1) {
1465 fprintf(stderr,"\\[%d,%d]", start-match, length);
1466 do { putc(s->window[start++], stderr); } while (--length != 0);
1470 # define check_match(s, start, match, length)
1471 #endif /* ZLIB_DEBUG */
1473 /* ===========================================================================
1474 * Fill the window when the lookahead becomes insufficient.
1475 * Updates strstart and lookahead.
1477 * IN assertion: lookahead < MIN_LOOKAHEAD
1478 * OUT assertions: strstart <= window_size-MIN_LOOKAHEAD
1479 * At least one byte has been read, or avail_in == 0; reads are
1480 * performed for at least two bytes (required for the zip translate_eol
1481 * option -- not supported here).
1483 local void fill_window(s)
1487 unsigned more; /* Amount of free space at the end of the window. */
1488 uInt wsize = s->w_size;
1490 Assert(s->lookahead < MIN_LOOKAHEAD, "already enough lookahead");
1493 more = (unsigned)(s->window_size -(ulg)s->lookahead -(ulg)s->strstart);
1495 /* Deal with !@#$% 64K limit: */
1496 if (sizeof(int) <= 2) {
1497 if (more == 0 && s->strstart == 0 && s->lookahead == 0) {
1500 } else if (more == (unsigned)(-1)) {
1501 /* Very unlikely, but possible on 16 bit machine if
1502 * strstart == 0 && lookahead == 1 (input done a byte at time)
1508 /* If the window is almost full and there is insufficient lookahead,
1509 * move the upper half to the lower one to make room in the upper half.
1511 if (s->strstart >= wsize+MAX_DIST(s)) {
1513 zmemcpy(s->window, s->window+wsize, (unsigned)wsize - more);
1514 s->match_start -= wsize;
1515 s->strstart -= wsize; /* we now have strstart >= MAX_DIST */
1516 s->block_start -= (long) wsize;
1520 if (s->strm->avail_in == 0) break;
1522 /* If there was no sliding:
1523 * strstart <= WSIZE+MAX_DIST-1 && lookahead <= MIN_LOOKAHEAD - 1 &&
1524 * more == window_size - lookahead - strstart
1525 * => more >= window_size - (MIN_LOOKAHEAD-1 + WSIZE + MAX_DIST-1)
1526 * => more >= window_size - 2*WSIZE + 2
1527 * In the BIG_MEM or MMAP case (not yet supported),
1528 * window_size == input_size + MIN_LOOKAHEAD &&
1529 * strstart + s->lookahead <= input_size => more >= MIN_LOOKAHEAD.
1530 * Otherwise, window_size == 2*WSIZE so more >= 2.
1531 * If there was sliding, more >= WSIZE. So in all cases, more >= 2.
1533 Assert(more >= 2, "more < 2");
1535 n = read_buf(s->strm, s->window + s->strstart + s->lookahead, more);
1538 /* Initialize the hash value now that we have some input: */
1539 if (s->lookahead + s->insert >= MIN_MATCH) {
1540 uInt str = s->strstart - s->insert;
1541 s->ins_h = s->window[str];
1542 UPDATE_HASH(s, s->ins_h, s->window[str + 1]);
1544 Call UPDATE_HASH() MIN_MATCH-3 more times
1547 UPDATE_HASH(s, s->ins_h, s->window[str + MIN_MATCH-1]);
1549 s->prev[str & s->w_mask] = s->head[s->ins_h];
1551 s->head[s->ins_h] = (Pos)str;
1554 if (s->lookahead + s->insert < MIN_MATCH)
1558 /* If the whole input has less than MIN_MATCH bytes, ins_h is garbage,
1559 * but this is not important since only literal bytes will be emitted.
1562 } while (s->lookahead < MIN_LOOKAHEAD && s->strm->avail_in != 0);
1564 /* If the WIN_INIT bytes after the end of the current data have never been
1565 * written, then zero those bytes in order to avoid memory check reports of
1566 * the use of uninitialized (or uninitialised as Julian writes) bytes by
1567 * the longest match routines. Update the high water mark for the next
1568 * time through here. WIN_INIT is set to MAX_MATCH since the longest match
1569 * routines allow scanning to strstart + MAX_MATCH, ignoring lookahead.
1571 if (s->high_water < s->window_size) {
1572 ulg curr = s->strstart + (ulg)(s->lookahead);
1575 if (s->high_water < curr) {
1576 /* Previous high water mark below current data -- zero WIN_INIT
1577 * bytes or up to end of window, whichever is less.
1579 init = s->window_size - curr;
1580 if (init > WIN_INIT)
1582 zmemzero(s->window + curr, (unsigned)init);
1583 s->high_water = curr + init;
1585 else if (s->high_water < (ulg)curr + WIN_INIT) {
1586 /* High water mark at or above current data, but below current data
1587 * plus WIN_INIT -- zero out to current data plus WIN_INIT, or up
1588 * to end of window, whichever is less.
1590 init = (ulg)curr + WIN_INIT - s->high_water;
1591 if (init > s->window_size - s->high_water)
1592 init = s->window_size - s->high_water;
1593 zmemzero(s->window + s->high_water, (unsigned)init);
1594 s->high_water += init;
1598 Assert((ulg)s->strstart <= s->window_size - MIN_LOOKAHEAD,
1599 "not enough room for search");
1602 /* ===========================================================================
1603 * Flush the current block, with given end-of-file flag.
1604 * IN assertion: strstart is set to the end of the current match.
1606 #define FLUSH_BLOCK_ONLY(s, last) { \
1607 _tr_flush_block(s, (s->block_start >= 0L ? \
1608 (charf *)&s->window[(unsigned)s->block_start] : \
1610 (ulg)((long)s->strstart - s->block_start), \
1612 s->block_start = s->strstart; \
1613 flush_pending(s->strm); \
1614 Tracev((stderr,"[FLUSH]")); \
1617 /* Same but force premature exit if necessary. */
1618 #define FLUSH_BLOCK(s, last) { \
1619 FLUSH_BLOCK_ONLY(s, last); \
1620 if (s->strm->avail_out == 0) return (last) ? finish_started : need_more; \
1623 /* Maximum stored block length in deflate format (not including header). */
1624 #define MAX_STORED 65535
1627 /* Minimum of a and b. */
1628 #define MIN(a, b) ((a) > (b) ? (b) : (a))
1631 /* ===========================================================================
1632 * Copy without compression as much as possible from the input stream, return
1633 * the current block state.
1635 * In case deflateParams() is used to later switch to a non-zero compression
1636 * level, s->matches (otherwise unused when storing) keeps track of the number
1637 * of hash table slides to perform. If s->matches is 1, then one hash table
1638 * slide will be done when switching. If s->matches is 2, the maximum value
1639 * allowed here, then the hash table will be cleared, since two or more slides
1640 * is the same as a clear.
1642 * deflate_stored() is written to minimize the number of times an input byte is
1643 * copied. It is most efficient with large input and output buffers, which
1644 * maximizes the opportunites to have a single copy from next_in to next_out.
1646 local block_state deflate_stored(s, flush)
1650 /* Smallest worthy block size when not flushing or finishing. By default
1651 * this is 32K. This can be as small as 507 bytes for memLevel == 1. For
1652 * large input and output buffers, the stored block size will be larger.
1654 unsigned min_block = MIN(s->pending_buf_size - 5, s->w_size);
1656 /* Copy as many min_block or larger stored blocks directly to next_out as
1657 * possible. If flushing, copy the remaining available input to next_out as
1658 * stored blocks, if there is enough space.
1660 unsigned len, left, have, last = 0;
1661 unsigned used = s->strm->avail_in;
1663 /* Set len to the maximum size block that we can copy directly with the
1664 * available input data and output space. Set left to how much of that
1665 * would be copied from what's left in the window.
1667 len = MAX_STORED; /* maximum deflate stored block length */
1668 have = (s->bi_valid + 42) >> 3; /* number of header bytes */
1669 if (s->strm->avail_out < have) /* need room for header */
1671 /* maximum stored block length that will fit in avail_out: */
1672 have = s->strm->avail_out - have;
1673 left = s->strstart - s->block_start; /* bytes left in window */
1674 if (len > (ulg)left + s->strm->avail_in)
1675 len = left + s->strm->avail_in; /* limit len to the input */
1677 len = have; /* limit len to the output */
1679 /* If the stored block would be less than min_block in length, or if
1680 * unable to copy all of the available input when flushing, then try
1681 * copying to the window and the pending buffer instead. Also don't
1682 * write an empty block when flushing -- deflate() does that.
1684 if (len < min_block && ((len == 0 && flush != Z_FINISH) ||
1685 flush == Z_NO_FLUSH ||
1686 len != left + s->strm->avail_in))
1689 /* Make a dummy stored block in pending to get the header bytes,
1690 * including any pending bits. This also updates the debugging counts.
1692 last = flush == Z_FINISH && len == left + s->strm->avail_in ? 1 : 0;
1693 _tr_stored_block(s, (char *)0, 0L, last);
1695 /* Replace the lengths in the dummy stored block with len. */
1696 s->pending_buf[s->pending - 4] = len;
1697 s->pending_buf[s->pending - 3] = len >> 8;
1698 s->pending_buf[s->pending - 2] = ~len;
1699 s->pending_buf[s->pending - 1] = ~len >> 8;
1701 /* Write the stored block header bytes. */
1702 flush_pending(s->strm);
1705 /* Update debugging counts for the data about to be copied. */
1706 s->compressed_len += len << 3;
1707 s->bits_sent += len << 3;
1710 /* Copy uncompressed bytes from the window to next_out. */
1714 zmemcpy(s->strm->next_out, s->window + s->block_start, left);
1715 s->strm->next_out += left;
1716 s->strm->avail_out -= left;
1717 s->strm->total_out += left;
1718 s->block_start += left;
1722 /* Copy uncompressed bytes directly from next_in to next_out, updating
1726 read_buf(s->strm, s->strm->next_out, len);
1727 s->strm->next_out += len;
1728 s->strm->avail_out -= len;
1729 s->strm->total_out += len;
1731 } while (last == 0);
1733 /* Update the sliding window with the last s->w_size bytes of the copied
1734 * data, or append all of the copied data to the existing window if less
1735 * than s->w_size bytes were copied. Also update the number of bytes to
1736 * insert in the hash tables, in the event that deflateParams() switches to
1737 * a non-zero compression level.
1739 used -= s->strm->avail_in; /* number of input bytes directly copied */
1741 /* If any input was used, then no unused input remains in the window,
1742 * therefore s->block_start == s->strstart.
1744 if (used >= s->w_size) { /* supplant the previous history */
1745 s->matches = 2; /* clear hash */
1746 zmemcpy(s->window, s->strm->next_in - s->w_size, s->w_size);
1747 s->strstart = s->w_size;
1750 if (s->window_size - s->strstart <= used) {
1751 /* Slide the window down. */
1752 s->strstart -= s->w_size;
1753 zmemcpy(s->window, s->window + s->w_size, s->strstart);
1755 s->matches++; /* add a pending slide_hash() */
1757 zmemcpy(s->window + s->strstart, s->strm->next_in - used, used);
1758 s->strstart += used;
1760 s->block_start = s->strstart;
1761 s->insert += MIN(used, s->w_size - s->insert);
1763 if (s->high_water < s->strstart)
1764 s->high_water = s->strstart;
1766 /* If the last block was written to next_out, then done. */
1770 /* If flushing and all input has been consumed, then done. */
1771 if (flush != Z_NO_FLUSH && flush != Z_FINISH &&
1772 s->strm->avail_in == 0 && (long)s->strstart == s->block_start)
1775 /* Fill the window with any remaining input. */
1776 have = s->window_size - s->strstart - 1;
1777 if (s->strm->avail_in > have && s->block_start >= (long)s->w_size) {
1778 /* Slide the window down. */
1779 s->block_start -= s->w_size;
1780 s->strstart -= s->w_size;
1781 zmemcpy(s->window, s->window + s->w_size, s->strstart);
1783 s->matches++; /* add a pending slide_hash() */
1784 have += s->w_size; /* more space now */
1786 if (have > s->strm->avail_in)
1787 have = s->strm->avail_in;
1789 read_buf(s->strm, s->window + s->strstart, have);
1790 s->strstart += have;
1792 if (s->high_water < s->strstart)
1793 s->high_water = s->strstart;
1795 /* There was not enough avail_out to write a complete worthy or flushed
1796 * stored block to next_out. Write a stored block to pending instead, if we
1797 * have enough input for a worthy block, or if flushing and there is enough
1798 * room for the remaining input as a stored block in the pending buffer.
1800 have = (s->bi_valid + 42) >> 3; /* number of header bytes */
1801 /* maximum stored block length that will fit in pending: */
1802 have = MIN(s->pending_buf_size - have, MAX_STORED);
1803 min_block = MIN(have, s->w_size);
1804 left = s->strstart - s->block_start;
1805 if (left >= min_block ||
1806 ((left || flush == Z_FINISH) && flush != Z_NO_FLUSH &&
1807 s->strm->avail_in == 0 && left <= have)) {
1808 len = MIN(left, have);
1809 last = flush == Z_FINISH && s->strm->avail_in == 0 &&
1810 len == left ? 1 : 0;
1811 _tr_stored_block(s, (charf *)s->window + s->block_start, len, last);
1812 s->block_start += len;
1813 flush_pending(s->strm);
1816 /* We've done all we can with the available input and output. */
1817 return last ? finish_started : need_more;
1820 /* ===========================================================================
1821 * Compress as much as possible from the input stream, return the current
1823 * This function does not perform lazy evaluation of matches and inserts
1824 * new strings in the dictionary only for unmatched strings or for short
1825 * matches. It is used only for the fast compression options.
1827 local block_state deflate_fast(s, flush)
1831 IPos hash_head; /* head of the hash chain */
1832 int bflush; /* set if current block must be flushed */
1835 /* Make sure that we always have enough lookahead, except
1836 * at the end of the input file. We need MAX_MATCH bytes
1837 * for the next match, plus MIN_MATCH bytes to insert the
1838 * string following the next match.
1840 if (s->lookahead < MIN_LOOKAHEAD) {
1842 if (s->lookahead < MIN_LOOKAHEAD && flush == Z_NO_FLUSH) {
1845 if (s->lookahead == 0) break; /* flush the current block */
1848 /* Insert the string window[strstart .. strstart+2] in the
1849 * dictionary, and set hash_head to the head of the hash chain:
1852 if (s->lookahead >= MIN_MATCH) {
1853 INSERT_STRING(s, s->strstart, hash_head);
1856 /* Find the longest match, discarding those <= prev_length.
1857 * At this point we have always match_length < MIN_MATCH
1859 if (hash_head != NIL && s->strstart - hash_head <= MAX_DIST(s)) {
1860 /* To simplify the code, we prevent matches with the string
1861 * of window index 0 (in particular we have to avoid a match
1862 * of the string with itself at the start of the input file).
1864 s->match_length = longest_match (s, hash_head);
1865 /* longest_match() sets match_start */
1867 if (s->match_length >= MIN_MATCH) {
1868 check_match(s, s->strstart, s->match_start, s->match_length);
1870 _tr_tally_dist(s, s->strstart - s->match_start,
1871 s->match_length - MIN_MATCH, bflush);
1873 s->lookahead -= s->match_length;
1875 /* Insert new strings in the hash table only if the match length
1876 * is not too large. This saves time but degrades compression.
1879 if (s->match_length <= s->max_insert_length &&
1880 s->lookahead >= MIN_MATCH) {
1881 s->match_length--; /* string at strstart already in table */
1884 INSERT_STRING(s, s->strstart, hash_head);
1885 /* strstart never exceeds WSIZE-MAX_MATCH, so there are
1886 * always MIN_MATCH bytes ahead.
1888 } while (--s->match_length != 0);
1893 s->strstart += s->match_length;
1894 s->match_length = 0;
1895 s->ins_h = s->window[s->strstart];
1896 UPDATE_HASH(s, s->ins_h, s->window[s->strstart+1]);
1898 Call UPDATE_HASH() MIN_MATCH-3 more times
1900 /* If lookahead < MIN_MATCH, ins_h is garbage, but it does not
1901 * matter since it will be recomputed at next deflate call.
1905 /* No match, output a literal byte */
1906 Tracevv((stderr,"%c", s->window[s->strstart]));
1907 _tr_tally_lit (s, s->window[s->strstart], bflush);
1911 if (bflush) FLUSH_BLOCK(s, 0);
1913 s->insert = s->strstart < MIN_MATCH-1 ? s->strstart : MIN_MATCH-1;
1914 if (flush == Z_FINISH) {
1924 /* ===========================================================================
1925 * Same as above, but achieves better compression. We use a lazy
1926 * evaluation for matches: a match is finally adopted only if there is
1927 * no better match at the next window position.
1929 local block_state deflate_slow(s, flush)
1933 IPos hash_head; /* head of hash chain */
1934 int bflush; /* set if current block must be flushed */
1936 /* Process the input block. */
1938 /* Make sure that we always have enough lookahead, except
1939 * at the end of the input file. We need MAX_MATCH bytes
1940 * for the next match, plus MIN_MATCH bytes to insert the
1941 * string following the next match.
1943 if (s->lookahead < MIN_LOOKAHEAD) {
1945 if (s->lookahead < MIN_LOOKAHEAD && flush == Z_NO_FLUSH) {
1948 if (s->lookahead == 0) break; /* flush the current block */
1951 /* Insert the string window[strstart .. strstart+2] in the
1952 * dictionary, and set hash_head to the head of the hash chain:
1955 if (s->lookahead >= MIN_MATCH) {
1956 INSERT_STRING(s, s->strstart, hash_head);
1959 /* Find the longest match, discarding those <= prev_length.
1961 s->prev_length = s->match_length, s->prev_match = s->match_start;
1962 s->match_length = MIN_MATCH-1;
1964 if (hash_head != NIL && s->prev_length < s->max_lazy_match &&
1965 s->strstart - hash_head <= MAX_DIST(s)) {
1966 /* To simplify the code, we prevent matches with the string
1967 * of window index 0 (in particular we have to avoid a match
1968 * of the string with itself at the start of the input file).
1970 s->match_length = longest_match (s, hash_head);
1971 /* longest_match() sets match_start */
1973 if (s->match_length <= 5 && (s->strategy == Z_FILTERED
1974 #if TOO_FAR <= 32767
1975 || (s->match_length == MIN_MATCH &&
1976 s->strstart - s->match_start > TOO_FAR)
1980 /* If prev_match is also MIN_MATCH, match_start is garbage
1981 * but we will ignore the current match anyway.
1983 s->match_length = MIN_MATCH-1;
1986 /* If there was a match at the previous step and the current
1987 * match is not better, output the previous match:
1989 if (s->prev_length >= MIN_MATCH && s->match_length <= s->prev_length) {
1990 uInt max_insert = s->strstart + s->lookahead - MIN_MATCH;
1991 /* Do not insert strings in hash table beyond this. */
1993 check_match(s, s->strstart-1, s->prev_match, s->prev_length);
1995 _tr_tally_dist(s, s->strstart -1 - s->prev_match,
1996 s->prev_length - MIN_MATCH, bflush);
1998 /* Insert in hash table all strings up to the end of the match.
1999 * strstart-1 and strstart are already inserted. If there is not
2000 * enough lookahead, the last two strings are not inserted in
2003 s->lookahead -= s->prev_length-1;
2004 s->prev_length -= 2;
2006 if (++s->strstart <= max_insert) {
2007 INSERT_STRING(s, s->strstart, hash_head);
2009 } while (--s->prev_length != 0);
2010 s->match_available = 0;
2011 s->match_length = MIN_MATCH-1;
2014 if (bflush) FLUSH_BLOCK(s, 0);
2016 } else if (s->match_available) {
2017 /* If there was no match at the previous position, output a
2018 * single literal. If there was a match but the current match
2019 * is longer, truncate the previous match to a single literal.
2021 Tracevv((stderr,"%c", s->window[s->strstart-1]));
2022 _tr_tally_lit(s, s->window[s->strstart-1], bflush);
2024 FLUSH_BLOCK_ONLY(s, 0);
2028 if (s->strm->avail_out == 0) return need_more;
2030 /* There is no previous match to compare with, wait for
2031 * the next step to decide.
2033 s->match_available = 1;
2038 Assert (flush != Z_NO_FLUSH, "no flush?");
2039 if (s->match_available) {
2040 Tracevv((stderr,"%c", s->window[s->strstart-1]));
2041 _tr_tally_lit(s, s->window[s->strstart-1], bflush);
2042 s->match_available = 0;
2044 s->insert = s->strstart < MIN_MATCH-1 ? s->strstart : MIN_MATCH-1;
2045 if (flush == Z_FINISH) {
2053 #endif /* FASTEST */
2055 /* ===========================================================================
2056 * For Z_RLE, simply look for runs of bytes, generate matches only of distance
2057 * one. Do not maintain a hash table. (It will be regenerated if this run of
2058 * deflate switches away from Z_RLE.)
2060 local block_state deflate_rle(s, flush)
2064 int bflush; /* set if current block must be flushed */
2065 uInt prev; /* byte at distance one to match */
2066 Bytef *scan, *strend; /* scan goes up to strend for length of run */
2069 /* Make sure that we always have enough lookahead, except
2070 * at the end of the input file. We need MAX_MATCH bytes
2071 * for the longest run, plus one for the unrolled loop.
2073 if (s->lookahead <= MAX_MATCH) {
2075 if (s->lookahead <= MAX_MATCH && flush == Z_NO_FLUSH) {
2078 if (s->lookahead == 0) break; /* flush the current block */
2081 /* See how many times the previous byte repeats */
2082 s->match_length = 0;
2083 if (s->lookahead >= MIN_MATCH && s->strstart > 0) {
2084 scan = s->window + s->strstart - 1;
2086 if (prev == *++scan && prev == *++scan && prev == *++scan) {
2087 strend = s->window + s->strstart + MAX_MATCH;
2089 } while (prev == *++scan && prev == *++scan &&
2090 prev == *++scan && prev == *++scan &&
2091 prev == *++scan && prev == *++scan &&
2092 prev == *++scan && prev == *++scan &&
2094 s->match_length = MAX_MATCH - (uInt)(strend - scan);
2095 if (s->match_length > s->lookahead)
2096 s->match_length = s->lookahead;
2098 Assert(scan <= s->window+(uInt)(s->window_size-1), "wild scan");
2101 /* Emit match if have run of MIN_MATCH or longer, else emit literal */
2102 if (s->match_length >= MIN_MATCH) {
2103 check_match(s, s->strstart, s->strstart - 1, s->match_length);
2105 _tr_tally_dist(s, 1, s->match_length - MIN_MATCH, bflush);
2107 s->lookahead -= s->match_length;
2108 s->strstart += s->match_length;
2109 s->match_length = 0;
2111 /* No match, output a literal byte */
2112 Tracevv((stderr,"%c", s->window[s->strstart]));
2113 _tr_tally_lit (s, s->window[s->strstart], bflush);
2117 if (bflush) FLUSH_BLOCK(s, 0);
2120 if (flush == Z_FINISH) {
2129 /* ===========================================================================
2130 * For Z_HUFFMAN_ONLY, do not look for matches. Do not maintain a hash table.
2131 * (It will be regenerated if this run of deflate switches away from Huffman.)
2133 local block_state deflate_huff(s, flush)
2137 int bflush; /* set if current block must be flushed */
2140 /* Make sure that we have a literal to write. */
2141 if (s->lookahead == 0) {
2143 if (s->lookahead == 0) {
2144 if (flush == Z_NO_FLUSH)
2146 break; /* flush the current block */
2150 /* Output a literal byte */
2151 s->match_length = 0;
2152 Tracevv((stderr,"%c", s->window[s->strstart]));
2153 _tr_tally_lit (s, s->window[s->strstart], bflush);
2156 if (bflush) FLUSH_BLOCK(s, 0);
2159 if (flush == Z_FINISH) {