blob: 1e779c9c3e34a3b5be21a8dced39393f5520c015 [file] [log] [blame]
Erik Andersene49d5ec2000-02-08 19:58:47 +00001/* vi: set sw=4 ts=4: */
Erik Andersen61677fe2000-04-13 01:18:56 +00002/*
3 * Gzip implementation for busybox
Eric Andersencc8ed391999-10-05 16:24:54 +00004 *
Erik Andersen61677fe2000-04-13 01:18:56 +00005 * Based on GNU gzip Copyright (C) 1992-1993 Jean-loup Gailly.
6 *
7 * Originally adjusted for busybox by Charles P. Wright <cpw@unix.asb.com>
Denis Vlasenkodb6a5c32007-01-07 19:45:51 +00008 * "this is a stripped down version of gzip I put into busybox, it does
9 * only standard in to standard out with -9 compression. It also requires
10 * the zcat module for some important functions."
Erik Andersen61677fe2000-04-13 01:18:56 +000011 *
Eric Andersenc7bda1c2004-03-15 08:29:22 +000012 * Adjusted further by Erik Andersen <andersen@codepoet.org> to support
13 * files as well as stdin/stdout, and to generally behave itself wrt
Erik Andersen61677fe2000-04-13 01:18:56 +000014 * command line handling.
15 *
Denys Vlasenko0ef64bd2010-08-16 20:14:46 +020016 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
Eric Andersencc8ed391999-10-05 16:24:54 +000017 */
Denis Vlasenko2f6df7f2007-01-07 19:44:35 +000018/* big objects in bss:
19 * 00000020 b bl_count
20 * 00000074 b base_length
21 * 00000078 b base_dist
22 * 00000078 b static_dtree
23 * 0000009c b bl_tree
24 * 000000f4 b dyn_dtree
25 * 00000100 b length_code
26 * 00000200 b dist_code
27 * 0000023d b depth
28 * 00000400 b flag_buf
Denis Vlasenkodb6a5c32007-01-07 19:45:51 +000029 * 0000047a b heap
Denis Vlasenko2f6df7f2007-01-07 19:44:35 +000030 * 00000480 b static_ltree
31 * 000008f4 b dyn_ltree
Denis Vlasenko2f6df7f2007-01-07 19:44:35 +000032 */
Denis Vlasenkobb119d02006-10-01 16:44:04 +000033/* TODO: full support for -v for DESKTOP
Denis Vlasenkodb6a5c32007-01-07 19:45:51 +000034 * "/usr/bin/gzip -v a bogus aa" should say:
Denis Vlasenkobb119d02006-10-01 16:44:04 +000035a: 85.1% -- replaced with a.gz
36gzip: bogus: No such file or directory
37aa: 85.1% -- replaced with aa.gz
38*/
Denis Vlasenko97a8dd32006-10-01 15:55:11 +000039
maxwen27116ba2015-08-14 21:41:28 +020040//config:config GZIP
41//config: bool "gzip"
42//config: default y
43//config: help
44//config: gzip is used to compress files.
45//config: It's probably the most widely used UNIX compression program.
46//config:
47//config:config FEATURE_GZIP_LONG_OPTIONS
48//config: bool "Enable long options"
49//config: default y
50//config: depends on GZIP && LONG_OPTS
51//config: help
52//config: Enable use of long options, increases size by about 106 Bytes
53//config:
54//config:config GZIP_FAST
55//config: int "Trade memory for gzip speed (0:small,slow - 2:fast,big)"
56//config: default 0
57//config: range 0 2
58//config: depends on GZIP
59//config: help
60//config: Enable big memory options for gzip.
61//config: 0: small buffers, small hash-tables
62//config: 1: larger buffers, larger hash-tables
63//config: 2: larger buffers, largest hash-tables
64//config: Larger models may give slightly better compression
65
66//applet:IF_GZIP(APPLET(gzip, BB_DIR_BIN, BB_SUID_DROP))
67//kbuild:lib-$(CONFIG_GZIP) += gzip.o
68
Pere Orga1f4447b2011-03-27 22:40:30 +020069//usage:#define gzip_trivial_usage
70//usage: "[-cfd] [FILE]..."
71//usage:#define gzip_full_usage "\n\n"
72//usage: "Compress FILEs (or stdin)\n"
Pere Orga1f4447b2011-03-27 22:40:30 +020073//usage: "\n -d Decompress"
74//usage: "\n -c Write to stdout"
75//usage: "\n -f Force"
76//usage:
77//usage:#define gzip_example_usage
78//usage: "$ ls -la /tmp/busybox*\n"
79//usage: "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n"
80//usage: "$ gzip /tmp/busybox.tar\n"
81//usage: "$ ls -la /tmp/busybox*\n"
82//usage: "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
83
Denis Vlasenkob6adbf12007-05-26 19:00:18 +000084#include "libbb.h"
Tanguy Pruvot8a6c2c22012-04-28 00:24:09 +020085#include "bb_archive.h"
Eric Andersencbe31da2001-02-20 06:14:08 +000086
Denis Vlasenkoda31fbc2007-01-07 19:39:02 +000087
88/* ===========================================================================
89 */
90//#define DEBUG 1
91/* Diagnostic functions */
92#ifdef DEBUG
Denis Vlasenko51742f42007-04-12 00:32:05 +000093# define Assert(cond,msg) { if (!(cond)) bb_error_msg(msg); }
Denis Vlasenkoda31fbc2007-01-07 19:39:02 +000094# define Trace(x) fprintf x
Denis Vlasenkob71c6682007-07-21 15:08:09 +000095# define Tracev(x) {if (verbose) fprintf x; }
96# define Tracevv(x) {if (verbose > 1) fprintf x; }
97# define Tracec(c,x) {if (verbose && (c)) fprintf x; }
98# define Tracecv(c,x) {if (verbose > 1 && (c)) fprintf x; }
Denis Vlasenkoda31fbc2007-01-07 19:39:02 +000099#else
100# define Assert(cond,msg)
101# define Trace(x)
102# define Tracev(x)
103# define Tracevv(x)
104# define Tracec(c,x)
105# define Tracecv(c,x)
106#endif
107
108
109/* ===========================================================================
110 */
Tanguy Pruvot8a6c2c22012-04-28 00:24:09 +0200111#if CONFIG_GZIP_FAST == 0
112# define SMALL_MEM
113#elif CONFIG_GZIP_FAST == 1
114# define MEDIUM_MEM
115#elif CONFIG_GZIP_FAST == 2
116# define BIG_MEM
117#else
118# error "Invalid CONFIG_GZIP_FAST value"
119#endif
Denis Vlasenkoda31fbc2007-01-07 19:39:02 +0000120
Denys Vlasenkoe4dcba12010-10-28 18:57:19 +0200121#ifndef INBUFSIZ
Eric Andersencc8ed391999-10-05 16:24:54 +0000122# ifdef SMALL_MEM
Erik Andersene49d5ec2000-02-08 19:58:47 +0000123# define INBUFSIZ 0x2000 /* input buffer size */
Eric Andersencc8ed391999-10-05 16:24:54 +0000124# else
Erik Andersene49d5ec2000-02-08 19:58:47 +0000125# define INBUFSIZ 0x8000 /* input buffer size */
Eric Andersencc8ed391999-10-05 16:24:54 +0000126# endif
127#endif
Denis Vlasenkoad403412007-01-07 19:37:42 +0000128
Denys Vlasenkoe4dcba12010-10-28 18:57:19 +0200129#ifndef OUTBUFSIZ
Eric Andersencc8ed391999-10-05 16:24:54 +0000130# ifdef SMALL_MEM
Erik Andersene49d5ec2000-02-08 19:58:47 +0000131# define OUTBUFSIZ 8192 /* output buffer size */
Eric Andersencc8ed391999-10-05 16:24:54 +0000132# else
Erik Andersene49d5ec2000-02-08 19:58:47 +0000133# define OUTBUFSIZ 16384 /* output buffer size */
Eric Andersencc8ed391999-10-05 16:24:54 +0000134# endif
135#endif
Eric Andersencc8ed391999-10-05 16:24:54 +0000136
137#ifndef DIST_BUFSIZE
138# ifdef SMALL_MEM
Erik Andersene49d5ec2000-02-08 19:58:47 +0000139# define DIST_BUFSIZE 0x2000 /* buffer for distances, see trees.c */
Eric Andersencc8ed391999-10-05 16:24:54 +0000140# else
Erik Andersene49d5ec2000-02-08 19:58:47 +0000141# define DIST_BUFSIZE 0x8000 /* buffer for distances, see trees.c */
Eric Andersencc8ed391999-10-05 16:24:54 +0000142# endif
143#endif
144
Eric Andersencc8ed391999-10-05 16:24:54 +0000145/* gzip flag byte */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000146#define ASCII_FLAG 0x01 /* bit 0 set: file probably ascii text */
147#define CONTINUATION 0x02 /* bit 1 set: continuation of multi-part gzip file */
148#define EXTRA_FIELD 0x04 /* bit 2 set: extra field present */
149#define ORIG_NAME 0x08 /* bit 3 set: original file name present */
150#define COMMENT 0x10 /* bit 4 set: file comment present */
151#define RESERVED 0xC0 /* bit 6,7: reserved */
Eric Andersencc8ed391999-10-05 16:24:54 +0000152
153/* internal file attribute */
154#define UNKNOWN 0xffff
155#define BINARY 0
156#define ASCII 1
157
158#ifndef WSIZE
Denis Vlasenkobb119d02006-10-01 16:44:04 +0000159# define WSIZE 0x8000 /* window size--must be a power of two, and */
160#endif /* at least 32K for zip's deflate method */
Eric Andersencc8ed391999-10-05 16:24:54 +0000161
162#define MIN_MATCH 3
163#define MAX_MATCH 258
164/* The minimum and maximum match lengths */
165
166#define MIN_LOOKAHEAD (MAX_MATCH+MIN_MATCH+1)
167/* Minimum amount of lookahead, except at the end of the input file.
168 * See deflate.c for comments about the MIN_MATCH+1.
169 */
170
171#define MAX_DIST (WSIZE-MIN_LOOKAHEAD)
172/* In order to simplify the code, particularly on 16 bit machines, match
173 * distances are limited to MAX_DIST instead of WSIZE.
174 */
175
Denis Vlasenkoad403412007-01-07 19:37:42 +0000176#ifndef MAX_PATH_LEN
177# define MAX_PATH_LEN 1024 /* max pathname length */
178#endif
Eric Andersencc8ed391999-10-05 16:24:54 +0000179
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000180#define seekable() 0 /* force sequential output */
181#define translate_eol 0 /* no option -a yet */
Eric Andersencc8ed391999-10-05 16:24:54 +0000182
Denis Vlasenkoad403412007-01-07 19:37:42 +0000183#ifndef BITS
184# define BITS 16
185#endif
186#define INIT_BITS 9 /* Initial number of bits per code */
187
188#define BIT_MASK 0x1f /* Mask for 'number of compression bits' */
189/* Mask 0x20 is reserved to mean a fourth header byte, and 0x40 is free.
190 * It's a pity that old uncompress does not check bit 0x20. That makes
191 * extension of the format actually undesirable because old compress
192 * would just crash on the new format instead of giving a meaningful
193 * error message. It does check the number of bits, but it's more
194 * helpful to say "unsupported format, get a new version" than
195 * "can only handle 16 bits".
196 */
197
198#ifdef MAX_EXT_CHARS
199# define MAX_SUFFIX MAX_EXT_CHARS
200#else
201# define MAX_SUFFIX 30
202#endif
203
204
Denis Vlasenkoda31fbc2007-01-07 19:39:02 +0000205/* ===========================================================================
206 * Compile with MEDIUM_MEM to reduce the memory requirements or
207 * with SMALL_MEM to use as little memory as possible. Use BIG_MEM if the
208 * entire input file can be held in memory (not possible on 16 bit systems).
209 * Warning: defining these symbols affects HASH_BITS (see below) and thus
210 * affects the compression ratio. The compressed output
211 * is still correct, and might even be smaller in some cases.
212 */
213
214#ifdef SMALL_MEM
215# define HASH_BITS 13 /* Number of bits used to hash strings */
216#endif
217#ifdef MEDIUM_MEM
218# define HASH_BITS 14
219#endif
220#ifndef HASH_BITS
221# define HASH_BITS 15
222 /* For portability to 16 bit machines, do not use values above 15. */
223#endif
224
Denis Vlasenkoda31fbc2007-01-07 19:39:02 +0000225#define HASH_SIZE (unsigned)(1<<HASH_BITS)
226#define HASH_MASK (HASH_SIZE-1)
227#define WMASK (WSIZE-1)
228/* HASH_SIZE and WSIZE must be powers of two */
229#ifndef TOO_FAR
230# define TOO_FAR 4096
231#endif
232/* Matches of length 3 are discarded if their distance exceeds TOO_FAR */
233
234
235/* ===========================================================================
Denis Vlasenko3ae6f342007-01-07 19:44:57 +0000236 * These types are not really 'char', 'short' and 'long'
Denis Vlasenkoda31fbc2007-01-07 19:39:02 +0000237 */
Denis Vlasenko3ae6f342007-01-07 19:44:57 +0000238typedef uint8_t uch;
239typedef uint16_t ush;
240typedef uint32_t ulg;
Denis Vlasenkodb6a5c32007-01-07 19:45:51 +0000241typedef int32_t lng;
Denis Vlasenkoda31fbc2007-01-07 19:39:02 +0000242
Denis Vlasenkoda31fbc2007-01-07 19:39:02 +0000243typedef ush Pos;
244typedef unsigned IPos;
Denis Vlasenkoda799e82007-03-14 00:06:29 +0000245/* A Pos is an index in the character window. We use short instead of int to
246 * save space in the various tables. IPos is used only for parameter passing.
247 */
Denis Vlasenkoda31fbc2007-01-07 19:39:02 +0000248
Denis Vlasenkoda31fbc2007-01-07 19:39:02 +0000249enum {
250 WINDOW_SIZE = 2 * WSIZE,
251/* window size, 2*WSIZE except for MMAP or BIG_MEM, where it is the
252 * input file length plus MIN_LOOKAHEAD.
253 */
254
255 max_chain_length = 4096,
256/* To speed up deflation, hash chains are never searched beyond this length.
257 * A higher limit improves compression ratio but degrades the speed.
258 */
259
260 max_lazy_match = 258,
261/* Attempt to find a better match only when the current match is strictly
262 * smaller than this value. This mechanism is used only for compression
263 * levels >= 4.
264 */
265
266 max_insert_length = max_lazy_match,
267/* Insert new strings in the hash table only if the match length
268 * is not greater than this length. This saves time but degrades compression.
269 * max_insert_length is used only for compression levels <= 3.
270 */
271
272 good_match = 32,
273/* Use a faster search when the previous match is longer than this */
274
275/* Values for max_lazy_match, good_match and max_chain_length, depending on
276 * the desired pack level (0..9). The values given below have been tuned to
277 * exclude worst case performance for pathological files. Better values may be
278 * found for specific files.
279 */
280
Denis Vlasenkodb6a5c32007-01-07 19:45:51 +0000281 nice_match = 258, /* Stop searching when current match exceeds this */
Denis Vlasenkoda31fbc2007-01-07 19:39:02 +0000282/* Note: the deflate() code requires max_lazy >= MIN_MATCH and max_chain >= 4
283 * For deflate_fast() (levels <= 3) good is ignored and lazy has a different
284 * meaning.
285 */
286};
287
288
Denis Vlasenko972288e2007-03-15 00:57:01 +0000289struct globals {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000290
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000291 lng block_start;
292
293/* window position at the beginning of the current output block. Gets
294 * negative when the window is moved backwards.
295 */
296 unsigned ins_h; /* hash index of string to be inserted */
297
298#define H_SHIFT ((HASH_BITS+MIN_MATCH-1) / MIN_MATCH)
299/* Number of bits by which ins_h and del_h must be shifted at each
300 * input step. It must be such that after MIN_MATCH steps, the oldest
301 * byte no longer takes part in the hash key, that is:
302 * H_SHIFT * MIN_MATCH >= HASH_BITS
303 */
304
305 unsigned prev_length;
306
307/* Length of the best match at previous step. Matches not greater than this
308 * are discarded. This is used in the lazy match evaluation.
309 */
310
311 unsigned strstart; /* start of string to insert */
312 unsigned match_start; /* start of matching string */
313 unsigned lookahead; /* number of valid bytes ahead in window */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000314
Denis Vlasenkodb6a5c32007-01-07 19:45:51 +0000315/* ===========================================================================
316 */
317#define DECLARE(type, array, size) \
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000318 type * array
Denis Vlasenkodb6a5c32007-01-07 19:45:51 +0000319#define ALLOC(type, array, size) \
Denys Vlasenko167cd702009-05-18 13:08:57 +0200320 array = xzalloc((size_t)(((size)+1L)/2) * 2*sizeof(type))
Denis Vlasenkodb6a5c32007-01-07 19:45:51 +0000321#define FREE(array) \
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000322 do { free(array); array = NULL; } while (0)
Denis Vlasenkodb6a5c32007-01-07 19:45:51 +0000323
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000324 /* global buffers */
Eric Andersencc8ed391999-10-05 16:24:54 +0000325
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000326 /* buffer for literals or lengths */
327 /* DECLARE(uch, l_buf, LIT_BUFSIZE); */
328 DECLARE(uch, l_buf, INBUFSIZ);
Eric Andersencc8ed391999-10-05 16:24:54 +0000329
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000330 DECLARE(ush, d_buf, DIST_BUFSIZE);
331 DECLARE(uch, outbuf, OUTBUFSIZ);
Eric Andersencc8ed391999-10-05 16:24:54 +0000332
Denis Vlasenko89af56b2007-01-07 19:40:34 +0000333/* Sliding window. Input bytes are read into the second half of the window,
334 * and move to the first half later to keep a dictionary of at least WSIZE
335 * bytes. With this organization, matches are limited to a distance of
336 * WSIZE-MAX_MATCH bytes, but this ensures that IO is always
337 * performed with a length multiple of the block size. Also, it limits
338 * the window size to 64K, which is quite useful on MSDOS.
339 * To do: limit the window size to WSIZE+BSZ if SMALL_MEM (the code would
340 * be less efficient).
341 */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000342 DECLARE(uch, window, 2L * WSIZE);
Denis Vlasenko89af56b2007-01-07 19:40:34 +0000343
Denis Vlasenko89af56b2007-01-07 19:40:34 +0000344/* Link to older string with same hash index. To limit the size of this
345 * array to 64K, this link is maintained only for the last 32K strings.
346 * An index in this array is thus a window index modulo 32K.
347 */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000348 /* DECLARE(Pos, prev, WSIZE); */
349 DECLARE(ush, prev, 1L << BITS);
Eric Andersencc8ed391999-10-05 16:24:54 +0000350
Denis Vlasenkodb6a5c32007-01-07 19:45:51 +0000351/* Heads of the hash chains or 0. */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000352 /* DECLARE(Pos, head, 1<<HASH_BITS); */
353#define head (G1.prev + WSIZE) /* hash head (see deflate.c) */
Denis Vlasenkodb6a5c32007-01-07 19:45:51 +0000354
Denis Vlasenko3ae6f342007-01-07 19:44:57 +0000355/* number of input bytes */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000356 ulg isize; /* only 32 bits stored in .gz file */
Denis Vlasenkoad403412007-01-07 19:37:42 +0000357
Denis Vlasenkofe42d172007-03-14 00:08:28 +0000358/* bbox always use stdin/stdout */
359#define ifd STDIN_FILENO /* input file descriptor */
360#define ofd STDOUT_FILENO /* output file descriptor */
Denis Vlasenko3ae6f342007-01-07 19:44:57 +0000361
Bernhard Reutner-Fischerd591a362006-08-20 17:35:13 +0000362#ifdef DEBUG
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000363 unsigned insize; /* valid bytes in l_buf */
Bernhard Reutner-Fischerd591a362006-08-20 17:35:13 +0000364#endif
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000365 unsigned outcnt; /* bytes in output buffer */
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000366
Denis Vlasenkofe42d172007-03-14 00:08:28 +0000367 smallint eofile; /* flag set at end of input file */
Denis Vlasenkoad403412007-01-07 19:37:42 +0000368
369/* ===========================================================================
370 * Local data used by the "bit string" routines.
371 */
372
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000373 unsigned short bi_buf;
Denis Vlasenkoad403412007-01-07 19:37:42 +0000374
375/* Output buffer. bits are inserted starting at the bottom (least significant
376 * bits).
377 */
378
379#undef BUF_SIZE
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000380#define BUF_SIZE (8 * sizeof(G1.bi_buf))
Denis Vlasenkoad403412007-01-07 19:37:42 +0000381/* Number of bits used within bi_buf. (bi_buf might be implemented on
382 * more than 16 bits on some systems.)
383 */
384
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000385 int bi_valid;
Denis Vlasenkoad403412007-01-07 19:37:42 +0000386
387/* Current input function. Set to mem_read for in-memory compression */
388
389#ifdef DEBUG
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000390 ulg bits_sent; /* bit length of the compressed data */
Denis Vlasenkoad403412007-01-07 19:37:42 +0000391#endif
392
Denys Vlasenko9ce642f2010-10-27 15:26:45 +0200393 /*uint32_t *crc_32_tab;*/
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000394 uint32_t crc; /* shift register contents */
395};
396
Denis Vlasenko07766bb2007-03-14 00:06:51 +0000397#define G1 (*(ptr_to_globals - 1))
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000398
Denis Vlasenkoad403412007-01-07 19:37:42 +0000399
400/* ===========================================================================
Denis Vlasenkoed0f6db2007-01-07 19:38:26 +0000401 * Write the output buffer outbuf[0..outcnt-1] and update bytes_out.
402 * (used for the compressed data only)
403 */
404static void flush_outbuf(void)
405{
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000406 if (G1.outcnt == 0)
Denis Vlasenkoed0f6db2007-01-07 19:38:26 +0000407 return;
408
Denis Vlasenkofe42d172007-03-14 00:08:28 +0000409 xwrite(ofd, (char *) G1.outbuf, G1.outcnt);
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000410 G1.outcnt = 0;
Denis Vlasenkoed0f6db2007-01-07 19:38:26 +0000411}
412
413
414/* ===========================================================================
Denis Vlasenkoad403412007-01-07 19:37:42 +0000415 */
416/* put_8bit is used for the compressed output */
417#define put_8bit(c) \
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000418do { \
419 G1.outbuf[G1.outcnt++] = (c); \
420 if (G1.outcnt == OUTBUFSIZ) flush_outbuf(); \
421} while (0)
Denis Vlasenkoad403412007-01-07 19:37:42 +0000422
Aaron Lehmannb9df4702001-12-06 03:22:43 +0000423/* Output a 16 bit value, lsb first */
Denis Vlasenkoad403412007-01-07 19:37:42 +0000424static void put_16bit(ush w)
Aaron Lehmannb9df4702001-12-06 03:22:43 +0000425{
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000426 if (G1.outcnt < OUTBUFSIZ - 2) {
427 G1.outbuf[G1.outcnt++] = w;
428 G1.outbuf[G1.outcnt++] = w >> 8;
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000429 } else {
Denis Vlasenkoad403412007-01-07 19:37:42 +0000430 put_8bit(w);
431 put_8bit(w >> 8);
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000432 }
Aaron Lehmannb9df4702001-12-06 03:22:43 +0000433}
434
Denis Vlasenkoad403412007-01-07 19:37:42 +0000435static void put_32bit(ulg n)
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000436{
Denis Vlasenkoad403412007-01-07 19:37:42 +0000437 put_16bit(n);
438 put_16bit(n >> 16);
439}
440
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000441/* ===========================================================================
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000442 * Run a set of bytes through the crc shift register. If s is a NULL
443 * pointer, then initialize the crc shift register contents instead.
444 * Return the current crc in either case.
445 */
Denys Vlasenko9ce642f2010-10-27 15:26:45 +0200446static void updcrc(uch * s, unsigned n)
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000447{
Denys Vlasenko9ce642f2010-10-27 15:26:45 +0200448 G1.crc = crc32_block_endian0(G1.crc, s, n, global_crc32_table /*G1.crc_32_tab*/);
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000449}
450
Denis Vlasenkoed0f6db2007-01-07 19:38:26 +0000451
452/* ===========================================================================
453 * Read a new buffer from the current input file, perform end-of-line
454 * translation, and update the crc and input file size.
455 * IN assertion: size >= 2 (for end-of-line translation)
456 */
457static unsigned file_read(void *buf, unsigned size)
458{
459 unsigned len;
460
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000461 Assert(G1.insize == 0, "l_buf not empty");
Denis Vlasenkoed0f6db2007-01-07 19:38:26 +0000462
Denis Vlasenkofe42d172007-03-14 00:08:28 +0000463 len = safe_read(ifd, buf, size);
Denis Vlasenkoed0f6db2007-01-07 19:38:26 +0000464 if (len == (unsigned)(-1) || len == 0)
465 return len;
466
467 updcrc(buf, len);
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000468 G1.isize += len;
Denis Vlasenkoed0f6db2007-01-07 19:38:26 +0000469 return len;
470}
471
472
Eric Andersencc8ed391999-10-05 16:24:54 +0000473/* ===========================================================================
Eric Andersencc8ed391999-10-05 16:24:54 +0000474 * Send a value on a given number of bits.
475 * IN assertion: length <= 16 and value fits in length bits.
476 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000477static void send_bits(int value, int length)
Eric Andersencc8ed391999-10-05 16:24:54 +0000478{
479#ifdef DEBUG
Erik Andersene49d5ec2000-02-08 19:58:47 +0000480 Tracev((stderr, " l %2d v %4x ", length, value));
481 Assert(length > 0 && length <= 15, "invalid length");
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000482 G1.bits_sent += length;
Eric Andersencc8ed391999-10-05 16:24:54 +0000483#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +0000484 /* If not enough room in bi_buf, use (valid) bits from bi_buf and
485 * (16 - bi_valid) bits from value, leaving (width - (16-bi_valid))
486 * unused bits in value.
487 */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000488 if (G1.bi_valid > (int) BUF_SIZE - length) {
489 G1.bi_buf |= (value << G1.bi_valid);
490 put_16bit(G1.bi_buf);
491 G1.bi_buf = (ush) value >> (BUF_SIZE - G1.bi_valid);
492 G1.bi_valid += length - BUF_SIZE;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000493 } else {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000494 G1.bi_buf |= value << G1.bi_valid;
495 G1.bi_valid += length;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000496 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000497}
498
Denis Vlasenkoda31fbc2007-01-07 19:39:02 +0000499
Eric Andersencc8ed391999-10-05 16:24:54 +0000500/* ===========================================================================
501 * Reverse the first len bits of a code, using straightforward code (a faster
502 * method would use a table)
503 * IN assertion: 1 <= len <= 15
504 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000505static unsigned bi_reverse(unsigned code, int len)
Eric Andersencc8ed391999-10-05 16:24:54 +0000506{
"Robert P. J. Day"68229832006-07-01 13:08:46 +0000507 unsigned res = 0;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000508
Denis Vlasenko89af56b2007-01-07 19:40:34 +0000509 while (1) {
Erik Andersene49d5ec2000-02-08 19:58:47 +0000510 res |= code & 1;
Denis Vlasenko89af56b2007-01-07 19:40:34 +0000511 if (--len <= 0) return res;
512 code >>= 1;
513 res <<= 1;
514 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000515}
516
Denis Vlasenkoda31fbc2007-01-07 19:39:02 +0000517
Eric Andersencc8ed391999-10-05 16:24:54 +0000518/* ===========================================================================
519 * Write out any remaining bits in an incomplete byte.
520 */
Mike Frysinger4e5936e2005-04-16 04:30:38 +0000521static void bi_windup(void)
Eric Andersencc8ed391999-10-05 16:24:54 +0000522{
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000523 if (G1.bi_valid > 8) {
524 put_16bit(G1.bi_buf);
525 } else if (G1.bi_valid > 0) {
526 put_8bit(G1.bi_buf);
Erik Andersene49d5ec2000-02-08 19:58:47 +0000527 }
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000528 G1.bi_buf = 0;
529 G1.bi_valid = 0;
Eric Andersencc8ed391999-10-05 16:24:54 +0000530#ifdef DEBUG
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000531 G1.bits_sent = (G1.bits_sent + 7) & ~7;
Eric Andersencc8ed391999-10-05 16:24:54 +0000532#endif
533}
534
Denis Vlasenkoda31fbc2007-01-07 19:39:02 +0000535
Eric Andersencc8ed391999-10-05 16:24:54 +0000536/* ===========================================================================
537 * Copy a stored block to the zip file, storing first the length and its
538 * one's complement if requested.
539 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000540static void copy_block(char *buf, unsigned len, int header)
Eric Andersencc8ed391999-10-05 16:24:54 +0000541{
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000542 bi_windup(); /* align on byte boundary */
Eric Andersencc8ed391999-10-05 16:24:54 +0000543
Erik Andersene49d5ec2000-02-08 19:58:47 +0000544 if (header) {
Denis Vlasenko30551fd2007-01-07 19:38:06 +0000545 put_16bit(len);
546 put_16bit(~len);
Eric Andersencc8ed391999-10-05 16:24:54 +0000547#ifdef DEBUG
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000548 G1.bits_sent += 2 * 16;
Eric Andersencc8ed391999-10-05 16:24:54 +0000549#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +0000550 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000551#ifdef DEBUG
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000552 G1.bits_sent += (ulg) len << 3;
Eric Andersencc8ed391999-10-05 16:24:54 +0000553#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +0000554 while (len--) {
Denis Vlasenkoad403412007-01-07 19:37:42 +0000555 put_8bit(*buf++);
Erik Andersene49d5ec2000-02-08 19:58:47 +0000556 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000557}
Erik Andersene49d5ec2000-02-08 19:58:47 +0000558
Eric Andersencc8ed391999-10-05 16:24:54 +0000559
560/* ===========================================================================
Denis Vlasenko56c83ea2007-01-07 19:40:50 +0000561 * Fill the window when the lookahead becomes insufficient.
562 * Updates strstart and lookahead, and sets eofile if end of input file.
563 * IN assertion: lookahead < MIN_LOOKAHEAD && strstart + lookahead > 0
564 * OUT assertions: at least one byte has been read, or eofile is set;
565 * file reads are performed for at least two bytes (required for the
566 * translate_eol option).
567 */
568static void fill_window(void)
569{
570 unsigned n, m;
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000571 unsigned more = WINDOW_SIZE - G1.lookahead - G1.strstart;
Denis Vlasenko56c83ea2007-01-07 19:40:50 +0000572 /* Amount of free space at the end of the window. */
573
574 /* If the window is almost full and there is insufficient lookahead,
575 * move the upper half to the lower one to make room in the upper half.
576 */
577 if (more == (unsigned) -1) {
578 /* Very unlikely, but possible on 16 bit machine if strstart == 0
579 * and lookahead == 1 (input done one byte at time)
580 */
581 more--;
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000582 } else if (G1.strstart >= WSIZE + MAX_DIST) {
Denis Vlasenko56c83ea2007-01-07 19:40:50 +0000583 /* By the IN assertion, the window is not empty so we can't confuse
584 * more == 0 with more == 64K on a 16 bit machine.
585 */
586 Assert(WINDOW_SIZE == 2 * WSIZE, "no sliding with BIG_MEM");
587
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000588 memcpy(G1.window, G1.window + WSIZE, WSIZE);
589 G1.match_start -= WSIZE;
590 G1.strstart -= WSIZE; /* we now have strstart >= MAX_DIST: */
Denis Vlasenko56c83ea2007-01-07 19:40:50 +0000591
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000592 G1.block_start -= WSIZE;
Denis Vlasenko56c83ea2007-01-07 19:40:50 +0000593
594 for (n = 0; n < HASH_SIZE; n++) {
595 m = head[n];
596 head[n] = (Pos) (m >= WSIZE ? m - WSIZE : 0);
597 }
598 for (n = 0; n < WSIZE; n++) {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000599 m = G1.prev[n];
600 G1.prev[n] = (Pos) (m >= WSIZE ? m - WSIZE : 0);
Denis Vlasenko56c83ea2007-01-07 19:40:50 +0000601 /* If n is not on any hash chain, prev[n] is garbage but
602 * its value will never be used.
603 */
604 }
605 more += WSIZE;
606 }
607 /* At this point, more >= 2 */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000608 if (!G1.eofile) {
609 n = file_read(G1.window + G1.strstart + G1.lookahead, more);
Denis Vlasenko56c83ea2007-01-07 19:40:50 +0000610 if (n == 0 || n == (unsigned) -1) {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000611 G1.eofile = 1;
Denis Vlasenko56c83ea2007-01-07 19:40:50 +0000612 } else {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000613 G1.lookahead += n;
Denis Vlasenko56c83ea2007-01-07 19:40:50 +0000614 }
615 }
616}
617
618
619/* ===========================================================================
Eric Andersencc8ed391999-10-05 16:24:54 +0000620 * Set match_start to the longest match starting at the given string and
621 * return its length. Matches shorter or equal to prev_length are discarded,
622 * in which case the result is equal to prev_length and match_start is
623 * garbage.
624 * IN assertions: cur_match is the head of the hash chain for the current
625 * string (strstart) and its distance is <= MAX_DIST, and prev_length >= 1
626 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000627
Eric Andersencc8ed391999-10-05 16:24:54 +0000628/* For MSDOS, OS/2 and 386 Unix, an optimized version is in match.asm or
629 * match.s. The code is functionally equivalent, so you can use the C version
630 * if desired.
631 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000632static int longest_match(IPos cur_match)
Eric Andersencc8ed391999-10-05 16:24:54 +0000633{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000634 unsigned chain_length = max_chain_length; /* max hash chain length */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000635 uch *scan = G1.window + G1.strstart; /* current string */
"Robert P. J. Day"68229832006-07-01 13:08:46 +0000636 uch *match; /* matched string */
637 int len; /* length of current match */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000638 int best_len = G1.prev_length; /* best match length so far */
639 IPos limit = G1.strstart > (IPos) MAX_DIST ? G1.strstart - (IPos) MAX_DIST : 0;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000640 /* Stop when cur_match becomes <= limit. To simplify the code,
641 * we prevent matches with the string of window index 0.
642 */
Eric Andersencc8ed391999-10-05 16:24:54 +0000643
644/* The code is optimized for HASH_BITS >= 8 and MAX_MATCH-2 multiple of 16.
645 * It is easy to get rid of this optimization if necessary.
646 */
647#if HASH_BITS < 8 || MAX_MATCH != 258
Eric Andersen3073dfb2001-07-02 17:57:32 +0000648# error Code too clever
Eric Andersencc8ed391999-10-05 16:24:54 +0000649#endif
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000650 uch *strend = G1.window + G1.strstart + MAX_MATCH;
"Robert P. J. Day"68229832006-07-01 13:08:46 +0000651 uch scan_end1 = scan[best_len - 1];
652 uch scan_end = scan[best_len];
Eric Andersencc8ed391999-10-05 16:24:54 +0000653
Erik Andersene49d5ec2000-02-08 19:58:47 +0000654 /* Do not waste too much time if we already have a good match: */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000655 if (G1.prev_length >= good_match) {
Erik Andersene49d5ec2000-02-08 19:58:47 +0000656 chain_length >>= 2;
657 }
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000658 Assert(G1.strstart <= WINDOW_SIZE - MIN_LOOKAHEAD, "insufficient lookahead");
Eric Andersencc8ed391999-10-05 16:24:54 +0000659
Erik Andersene49d5ec2000-02-08 19:58:47 +0000660 do {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000661 Assert(cur_match < G1.strstart, "no future");
662 match = G1.window + cur_match;
Eric Andersencc8ed391999-10-05 16:24:54 +0000663
Erik Andersene49d5ec2000-02-08 19:58:47 +0000664 /* Skip to next match if the match length cannot increase
665 * or if the match length is less than 2:
666 */
Denys Vlasenko6b9f1632010-01-28 02:24:24 +0100667 if (match[best_len] != scan_end
668 || match[best_len - 1] != scan_end1
669 || *match != *scan || *++match != scan[1]
670 ) {
Erik Andersene49d5ec2000-02-08 19:58:47 +0000671 continue;
Denys Vlasenko6b9f1632010-01-28 02:24:24 +0100672 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000673
Erik Andersene49d5ec2000-02-08 19:58:47 +0000674 /* The check at best_len-1 can be removed because it will be made
675 * again later. (This heuristic is not always a win.)
676 * It is not necessary to compare scan[2] and match[2] since they
677 * are always equal when the other bytes match, given that
678 * the hash keys are equal and that HASH_BITS >= 8.
679 */
680 scan += 2, match++;
Eric Andersencc8ed391999-10-05 16:24:54 +0000681
Erik Andersene49d5ec2000-02-08 19:58:47 +0000682 /* We check for insufficient lookahead only every 8th comparison;
683 * the 256th check will be made at strstart+258.
684 */
685 do {
686 } while (*++scan == *++match && *++scan == *++match &&
687 *++scan == *++match && *++scan == *++match &&
688 *++scan == *++match && *++scan == *++match &&
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000689 *++scan == *++match && *++scan == *++match && scan < strend);
Eric Andersencc8ed391999-10-05 16:24:54 +0000690
Erik Andersene49d5ec2000-02-08 19:58:47 +0000691 len = MAX_MATCH - (int) (strend - scan);
692 scan = strend - MAX_MATCH;
Eric Andersencc8ed391999-10-05 16:24:54 +0000693
Erik Andersene49d5ec2000-02-08 19:58:47 +0000694 if (len > best_len) {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000695 G1.match_start = cur_match;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000696 best_len = len;
697 if (len >= nice_match)
698 break;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000699 scan_end1 = scan[best_len - 1];
700 scan_end = scan[best_len];
Erik Andersene49d5ec2000-02-08 19:58:47 +0000701 }
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000702 } while ((cur_match = G1.prev[cur_match & WMASK]) > limit
Erik Andersene49d5ec2000-02-08 19:58:47 +0000703 && --chain_length != 0);
Eric Andersencc8ed391999-10-05 16:24:54 +0000704
Erik Andersene49d5ec2000-02-08 19:58:47 +0000705 return best_len;
Eric Andersencc8ed391999-10-05 16:24:54 +0000706}
Eric Andersencc8ed391999-10-05 16:24:54 +0000707
Denis Vlasenkoda31fbc2007-01-07 19:39:02 +0000708
Eric Andersencc8ed391999-10-05 16:24:54 +0000709#ifdef DEBUG
710/* ===========================================================================
711 * Check that the match at match_start is indeed a match.
712 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000713static void check_match(IPos start, IPos match, int length)
Eric Andersencc8ed391999-10-05 16:24:54 +0000714{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000715 /* check that the match is indeed a match */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000716 if (memcmp(G1.window + match, G1.window + start, length) != 0) {
Manuel Novoa III cad53642003-03-19 09:13:01 +0000717 bb_error_msg(" start %d, match %d, length %d", start, match, length);
718 bb_error_msg("invalid match");
Erik Andersene49d5ec2000-02-08 19:58:47 +0000719 }
720 if (verbose > 1) {
Manuel Novoa III cad53642003-03-19 09:13:01 +0000721 bb_error_msg("\\[%d,%d]", start - match, length);
Erik Andersene49d5ec2000-02-08 19:58:47 +0000722 do {
Denys Vlasenko19ced5c2010-06-06 21:53:09 +0200723 bb_putchar_stderr(G1.window[start++]);
Erik Andersene49d5ec2000-02-08 19:58:47 +0000724 } while (--length != 0);
725 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000726}
727#else
Denis Vlasenkoda31fbc2007-01-07 19:39:02 +0000728# define check_match(start, match, length) ((void)0)
Eric Andersencc8ed391999-10-05 16:24:54 +0000729#endif
730
Denis Vlasenkoda31fbc2007-01-07 19:39:02 +0000731
Eric Andersencc8ed391999-10-05 16:24:54 +0000732/* trees.c -- output deflated data using Huffman coding
733 * Copyright (C) 1992-1993 Jean-loup Gailly
734 * This is free software; you can redistribute it and/or modify it under the
735 * terms of the GNU General Public License, see the file COPYING.
736 */
737
Denis Vlasenko89af56b2007-01-07 19:40:34 +0000738/* PURPOSE
Eric Andersencc8ed391999-10-05 16:24:54 +0000739 * Encode various sets of source values using variable-length
740 * binary code trees.
741 *
742 * DISCUSSION
Eric Andersencc8ed391999-10-05 16:24:54 +0000743 * The PKZIP "deflation" process uses several Huffman trees. The more
744 * common source values are represented by shorter bit sequences.
745 *
746 * Each code tree is stored in the ZIP file in a compressed form
747 * which is itself a Huffman encoding of the lengths of
748 * all the code strings (in ascending order by source values).
749 * The actual code strings are reconstructed from the lengths in
750 * the UNZIP process, as described in the "application note"
751 * (APPNOTE.TXT) distributed as part of PKWARE's PKZIP program.
752 *
753 * REFERENCES
Eric Andersencc8ed391999-10-05 16:24:54 +0000754 * Lynch, Thomas J.
755 * Data Compression: Techniques and Applications, pp. 53-55.
756 * Lifetime Learning Publications, 1985. ISBN 0-534-03418-7.
757 *
758 * Storer, James A.
759 * Data Compression: Methods and Theory, pp. 49-50.
760 * Computer Science Press, 1988. ISBN 0-7167-8156-5.
761 *
762 * Sedgewick, R.
763 * Algorithms, p290.
764 * Addison-Wesley, 1983. ISBN 0-201-06672-6.
765 *
766 * INTERFACE
Denis Vlasenkofe42d172007-03-14 00:08:28 +0000767 * void ct_init()
768 * Allocate the match buffer, initialize the various tables [and save
Eric Andersencc8ed391999-10-05 16:24:54 +0000769 * the location of the internal file attribute (ascii/binary) and
Denis Vlasenkofe42d172007-03-14 00:08:28 +0000770 * method (DEFLATE/STORE) -- deleted in bbox]
Eric Andersencc8ed391999-10-05 16:24:54 +0000771 *
Denis Vlasenko30551fd2007-01-07 19:38:06 +0000772 * void ct_tally(int dist, int lc);
Eric Andersencc8ed391999-10-05 16:24:54 +0000773 * Save the match info and tally the frequency counts.
774 *
Denis Vlasenko3ae6f342007-01-07 19:44:57 +0000775 * ulg flush_block(char *buf, ulg stored_len, int eof)
Eric Andersencc8ed391999-10-05 16:24:54 +0000776 * Determine the best encoding for the current block: dynamic trees,
777 * static trees or store, and output the encoded block to the zip
778 * file. Returns the total compressed length for the file so far.
Eric Andersencc8ed391999-10-05 16:24:54 +0000779 */
780
Eric Andersencc8ed391999-10-05 16:24:54 +0000781#define MAX_BITS 15
782/* All codes must not exceed MAX_BITS bits */
783
784#define MAX_BL_BITS 7
785/* Bit length codes must not exceed MAX_BL_BITS bits */
786
787#define LENGTH_CODES 29
788/* number of length codes, not counting the special END_BLOCK code */
789
790#define LITERALS 256
791/* number of literal bytes 0..255 */
792
793#define END_BLOCK 256
794/* end of block literal code */
795
796#define L_CODES (LITERALS+1+LENGTH_CODES)
797/* number of Literal or Length codes, including the END_BLOCK code */
798
799#define D_CODES 30
800/* number of distance codes */
801
802#define BL_CODES 19
803/* number of codes used to transfer the bit lengths */
804
Eric Andersen39eb0402001-08-22 04:15:47 +0000805/* extra bits for each length code */
Denis Vlasenko6ca409e2007-08-12 20:58:27 +0000806static const uint8_t extra_lbits[LENGTH_CODES] ALIGN1 = {
Denis Vlasenko89af56b2007-01-07 19:40:34 +0000807 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 2, 2, 2, 2, 3, 3, 3, 3, 4, 4,
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000808 4, 4, 5, 5, 5, 5, 0
809};
Eric Andersencc8ed391999-10-05 16:24:54 +0000810
Eric Andersen39eb0402001-08-22 04:15:47 +0000811/* extra bits for each distance code */
Denis Vlasenko6ca409e2007-08-12 20:58:27 +0000812static const uint8_t extra_dbits[D_CODES] ALIGN1 = {
Denis Vlasenko89af56b2007-01-07 19:40:34 +0000813 0, 0, 0, 0, 1, 1, 2, 2, 3, 3, 4, 4, 5, 5, 6, 6, 7, 7, 8, 8, 9, 9,
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000814 10, 10, 11, 11, 12, 12, 13, 13
815};
Eric Andersencc8ed391999-10-05 16:24:54 +0000816
Eric Andersen39eb0402001-08-22 04:15:47 +0000817/* extra bits for each bit length code */
Denis Vlasenko6ca409e2007-08-12 20:58:27 +0000818static const uint8_t extra_blbits[BL_CODES] ALIGN1 = {
Denis Vlasenko89af56b2007-01-07 19:40:34 +0000819 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 3, 7 };
Eric Andersencc8ed391999-10-05 16:24:54 +0000820
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000821/* number of codes at each bit length for an optimal tree */
Denis Vlasenko6ca409e2007-08-12 20:58:27 +0000822static const uint8_t bl_order[BL_CODES] ALIGN1 = {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000823 16, 17, 18, 0, 8, 7, 9, 6, 10, 5, 11, 4, 12, 3, 13, 2, 14, 1, 15 };
824
Eric Andersencc8ed391999-10-05 16:24:54 +0000825#define STORED_BLOCK 0
826#define STATIC_TREES 1
827#define DYN_TREES 2
828/* The three kinds of block type */
829
830#ifndef LIT_BUFSIZE
831# ifdef SMALL_MEM
832# define LIT_BUFSIZE 0x2000
833# else
834# ifdef MEDIUM_MEM
835# define LIT_BUFSIZE 0x4000
836# else
837# define LIT_BUFSIZE 0x8000
838# endif
839# endif
840#endif
841#ifndef DIST_BUFSIZE
842# define DIST_BUFSIZE LIT_BUFSIZE
843#endif
844/* Sizes of match buffers for literals/lengths and distances. There are
845 * 4 reasons for limiting LIT_BUFSIZE to 64K:
846 * - frequencies can be kept in 16 bit counters
847 * - if compression is not successful for the first block, all input data is
848 * still in the window so we can still emit a stored block even when input
849 * comes from standard input. (This can also be done for all blocks if
850 * LIT_BUFSIZE is not greater than 32K.)
851 * - if compression is not successful for a file smaller than 64K, we can
852 * even emit a stored file instead of a stored block (saving 5 bytes).
853 * - creating new Huffman trees less frequently may not provide fast
854 * adaptation to changes in the input data statistics. (Take for
855 * example a binary file with poorly compressible code followed by
856 * a highly compressible string table.) Smaller buffer sizes give
857 * fast adaptation but have of course the overhead of transmitting trees
858 * more frequently.
859 * - I can't count above 4
860 * The current code is general and allows DIST_BUFSIZE < LIT_BUFSIZE (to save
861 * memory at the expense of compression). Some optimizations would be possible
862 * if we rely on DIST_BUFSIZE == LIT_BUFSIZE.
863 */
Eric Andersencc8ed391999-10-05 16:24:54 +0000864#define REP_3_6 16
865/* repeat previous bit length 3-6 times (2 bits of repeat count) */
Eric Andersencc8ed391999-10-05 16:24:54 +0000866#define REPZ_3_10 17
867/* repeat a zero length 3-10 times (3 bits of repeat count) */
Eric Andersencc8ed391999-10-05 16:24:54 +0000868#define REPZ_11_138 18
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000869/* repeat a zero length 11-138 times (7 bits of repeat count) */
870
871/* ===========================================================================
Denis Vlasenko56c83ea2007-01-07 19:40:50 +0000872*/
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000873/* Data structure describing a single value and its code string. */
874typedef struct ct_data {
Erik Andersene49d5ec2000-02-08 19:58:47 +0000875 union {
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000876 ush freq; /* frequency count */
877 ush code; /* bit string */
Erik Andersene49d5ec2000-02-08 19:58:47 +0000878 } fc;
879 union {
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000880 ush dad; /* father node in Huffman tree */
881 ush len; /* length of bit string */
Erik Andersene49d5ec2000-02-08 19:58:47 +0000882 } dl;
Eric Andersencc8ed391999-10-05 16:24:54 +0000883} ct_data;
884
885#define Freq fc.freq
886#define Code fc.code
887#define Dad dl.dad
888#define Len dl.len
889
Denis Vlasenkodb6a5c32007-01-07 19:45:51 +0000890#define HEAP_SIZE (2*L_CODES + 1)
Eric Andersencc8ed391999-10-05 16:24:54 +0000891/* maximum heap size */
892
Eric Andersencc8ed391999-10-05 16:24:54 +0000893typedef struct tree_desc {
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000894 ct_data *dyn_tree; /* the dynamic tree */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000895 ct_data *static_tree; /* corresponding static tree or NULL */
Denis Vlasenko6ca409e2007-08-12 20:58:27 +0000896 const uint8_t *extra_bits; /* extra bits for each code or NULL */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000897 int extra_base; /* base index for extra_bits */
898 int elems; /* max number of elements in the tree */
899 int max_length; /* max bit length for the codes */
900 int max_code; /* largest code with non zero frequency */
Eric Andersencc8ed391999-10-05 16:24:54 +0000901} tree_desc;
902
Denis Vlasenko972288e2007-03-15 00:57:01 +0000903struct globals2 {
Eric Andersencc8ed391999-10-05 16:24:54 +0000904
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000905 ush heap[HEAP_SIZE]; /* heap used to build the Huffman trees */
906 int heap_len; /* number of elements in the heap */
907 int heap_max; /* element of largest frequency */
Eric Andersencc8ed391999-10-05 16:24:54 +0000908
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000909/* The sons of heap[n] are heap[2*n] and heap[2*n+1]. heap[0] is not used.
910 * The same heap array is used to build all trees.
911 */
Eric Andersencc8ed391999-10-05 16:24:54 +0000912
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000913 ct_data dyn_ltree[HEAP_SIZE]; /* literal and length tree */
914 ct_data dyn_dtree[2 * D_CODES + 1]; /* distance tree */
Eric Andersencc8ed391999-10-05 16:24:54 +0000915
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000916 ct_data static_ltree[L_CODES + 2];
Erik Andersene49d5ec2000-02-08 19:58:47 +0000917
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000918/* The static literal tree. Since the bit lengths are imposed, there is no
919 * need for the L_CODES extra codes used during heap construction. However
920 * The codes 286 and 287 are needed to build a canonical tree (see ct_init
921 * below).
922 */
Eric Andersencc8ed391999-10-05 16:24:54 +0000923
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000924 ct_data static_dtree[D_CODES];
925
926/* The static distance tree. (Actually a trivial tree since all codes use
927 * 5 bits.)
928 */
929
930 ct_data bl_tree[2 * BL_CODES + 1];
931
932/* Huffman tree for the bit lengths */
933
934 tree_desc l_desc;
935 tree_desc d_desc;
936 tree_desc bl_desc;
937
938 ush bl_count[MAX_BITS + 1];
Erik Andersene49d5ec2000-02-08 19:58:47 +0000939
Eric Andersencc8ed391999-10-05 16:24:54 +0000940/* The lengths of the bit length codes are sent in order of decreasing
941 * probability, to avoid transmitting the lengths for unused bit length codes.
942 */
943
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000944 uch depth[2 * L_CODES + 1];
Erik Andersene49d5ec2000-02-08 19:58:47 +0000945
Eric Andersencc8ed391999-10-05 16:24:54 +0000946/* Depth of each subtree used as tie breaker for trees of equal frequency */
947
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000948 uch length_code[MAX_MATCH - MIN_MATCH + 1];
Erik Andersene49d5ec2000-02-08 19:58:47 +0000949
Eric Andersencc8ed391999-10-05 16:24:54 +0000950/* length code for each normalized match length (0 == MIN_MATCH) */
951
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000952 uch dist_code[512];
Erik Andersene49d5ec2000-02-08 19:58:47 +0000953
Eric Andersencc8ed391999-10-05 16:24:54 +0000954/* distance codes. The first 256 values correspond to the distances
955 * 3 .. 258, the last 256 values correspond to the top 8 bits of
956 * the 15 bit distances.
957 */
958
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000959 int base_length[LENGTH_CODES];
Erik Andersene49d5ec2000-02-08 19:58:47 +0000960
Eric Andersencc8ed391999-10-05 16:24:54 +0000961/* First normalized length for each code (0 = MIN_MATCH) */
962
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000963 int base_dist[D_CODES];
Erik Andersene49d5ec2000-02-08 19:58:47 +0000964
Eric Andersencc8ed391999-10-05 16:24:54 +0000965/* First normalized distance for each code (0 = distance of 1) */
966
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000967 uch flag_buf[LIT_BUFSIZE / 8];
Erik Andersene49d5ec2000-02-08 19:58:47 +0000968
Eric Andersencc8ed391999-10-05 16:24:54 +0000969/* flag_buf is a bit array distinguishing literals from lengths in
970 * l_buf, thus indicating the presence or absence of a distance.
971 */
972
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000973 unsigned last_lit; /* running index in l_buf */
974 unsigned last_dist; /* running index in d_buf */
975 unsigned last_flags; /* running index in flag_buf */
976 uch flags; /* current flags not yet saved in flag_buf */
977 uch flag_bit; /* current bit used in flags */
Erik Andersene49d5ec2000-02-08 19:58:47 +0000978
Eric Andersencc8ed391999-10-05 16:24:54 +0000979/* bits are filled in flags starting at bit 0 (least significant).
980 * Note: these flags are overkill in the current code since we don't
981 * take advantage of DIST_BUFSIZE == LIT_BUFSIZE.
982 */
983
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000984 ulg opt_len; /* bit length of current block with optimal trees */
985 ulg static_len; /* bit length of current block with static trees */
Eric Andersencc8ed391999-10-05 16:24:54 +0000986
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000987 ulg compressed_len; /* total bit length of compressed file */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000988};
989
Denis Vlasenko972288e2007-03-15 00:57:01 +0000990#define G2ptr ((struct globals2*)(ptr_to_globals))
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000991#define G2 (*G2ptr)
Denis Vlasenkoe930fe12007-03-14 00:06:10 +0000992
Eric Andersencc8ed391999-10-05 16:24:54 +0000993
994/* ===========================================================================
Eric Andersencc8ed391999-10-05 16:24:54 +0000995 */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000996static void gen_codes(ct_data * tree, int max_code);
997static void build_tree(tree_desc * desc);
998static void scan_tree(ct_data * tree, int max_code);
999static void send_tree(ct_data * tree, int max_code);
1000static int build_bl_tree(void);
1001static void send_all_trees(int lcodes, int dcodes, int blcodes);
1002static void compress_block(ct_data * ltree, ct_data * dtree);
Eric Andersencc8ed391999-10-05 16:24:54 +00001003
1004
1005#ifndef DEBUG
Denis Vlasenkof8241362007-01-07 19:38:42 +00001006/* Send a code of the given tree. c and tree must not have side effects */
Denis Vlasenko89af56b2007-01-07 19:40:34 +00001007# define SEND_CODE(c, tree) send_bits(tree[c].Code, tree[c].Len)
1008#else
1009# define SEND_CODE(c, tree) \
Denis Vlasenkof8241362007-01-07 19:38:42 +00001010{ \
Denys Vlasenko083e1722010-01-28 12:30:24 +01001011 if (verbose > 1) bb_error_msg("\ncd %3d ", (c)); \
Denis Vlasenko150f4022007-01-13 21:06:21 +00001012 send_bits(tree[c].Code, tree[c].Len); \
Denis Vlasenkof8241362007-01-07 19:38:42 +00001013}
Eric Andersencc8ed391999-10-05 16:24:54 +00001014#endif
1015
Denis Vlasenko89af56b2007-01-07 19:40:34 +00001016#define D_CODE(dist) \
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001017 ((dist) < 256 ? G2.dist_code[dist] : G2.dist_code[256 + ((dist)>>7)])
Eric Andersencc8ed391999-10-05 16:24:54 +00001018/* Mapping from a distance to a distance code. dist is the distance - 1 and
1019 * must not have side effects. dist_code[256] and dist_code[257] are never
1020 * used.
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001021 * The arguments must not have side effects.
Eric Andersencc8ed391999-10-05 16:24:54 +00001022 */
1023
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001024
1025/* ===========================================================================
1026 * Initialize a new block.
1027 */
1028static void init_block(void)
1029{
1030 int n; /* iterates over tree elements */
1031
1032 /* Initialize the trees. */
1033 for (n = 0; n < L_CODES; n++)
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001034 G2.dyn_ltree[n].Freq = 0;
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001035 for (n = 0; n < D_CODES; n++)
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001036 G2.dyn_dtree[n].Freq = 0;
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001037 for (n = 0; n < BL_CODES; n++)
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001038 G2.bl_tree[n].Freq = 0;
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001039
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001040 G2.dyn_ltree[END_BLOCK].Freq = 1;
1041 G2.opt_len = G2.static_len = 0;
1042 G2.last_lit = G2.last_dist = G2.last_flags = 0;
1043 G2.flags = 0;
1044 G2.flag_bit = 1;
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001045}
Eric Andersencc8ed391999-10-05 16:24:54 +00001046
Denis Vlasenkof8241362007-01-07 19:38:42 +00001047
Eric Andersencc8ed391999-10-05 16:24:54 +00001048/* ===========================================================================
Eric Andersencc8ed391999-10-05 16:24:54 +00001049 * Restore the heap property by moving down the tree starting at node k,
1050 * exchanging a node with the smallest of its two sons if necessary, stopping
1051 * when the heap property is re-established (each father smaller than its
1052 * two sons).
1053 */
Denis Vlasenkof8241362007-01-07 19:38:42 +00001054
1055/* Compares to subtrees, using the tree depth as tie breaker when
Denis Vlasenko89af56b2007-01-07 19:40:34 +00001056 * the subtrees have equal frequency. This minimizes the worst case length. */
1057#define SMALLER(tree, n, m) \
Denis Vlasenkof8241362007-01-07 19:38:42 +00001058 (tree[n].Freq < tree[m].Freq \
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001059 || (tree[n].Freq == tree[m].Freq && G2.depth[n] <= G2.depth[m]))
Denis Vlasenkof8241362007-01-07 19:38:42 +00001060
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001061static void pqdownheap(ct_data * tree, int k)
Eric Andersencc8ed391999-10-05 16:24:54 +00001062{
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001063 int v = G2.heap[k];
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001064 int j = k << 1; /* left son of k */
Eric Andersencc8ed391999-10-05 16:24:54 +00001065
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001066 while (j <= G2.heap_len) {
Erik Andersene49d5ec2000-02-08 19:58:47 +00001067 /* Set j to the smallest of the two sons: */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001068 if (j < G2.heap_len && SMALLER(tree, G2.heap[j + 1], G2.heap[j]))
Erik Andersene49d5ec2000-02-08 19:58:47 +00001069 j++;
Eric Andersencc8ed391999-10-05 16:24:54 +00001070
Erik Andersene49d5ec2000-02-08 19:58:47 +00001071 /* Exit if v is smaller than both sons */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001072 if (SMALLER(tree, v, G2.heap[j]))
Erik Andersene49d5ec2000-02-08 19:58:47 +00001073 break;
Eric Andersencc8ed391999-10-05 16:24:54 +00001074
Erik Andersene49d5ec2000-02-08 19:58:47 +00001075 /* Exchange v with the smallest son */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001076 G2.heap[k] = G2.heap[j];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001077 k = j;
1078
1079 /* And continue down the tree, setting j to the left son of k */
1080 j <<= 1;
1081 }
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001082 G2.heap[k] = v;
Eric Andersencc8ed391999-10-05 16:24:54 +00001083}
1084
Denis Vlasenkof8241362007-01-07 19:38:42 +00001085
Eric Andersencc8ed391999-10-05 16:24:54 +00001086/* ===========================================================================
1087 * Compute the optimal bit lengths for a tree and update the total bit length
1088 * for the current block.
1089 * IN assertion: the fields freq and dad are set, heap[heap_max] and
1090 * above are the tree nodes sorted by increasing frequency.
1091 * OUT assertions: the field len is set to the optimal bit length, the
1092 * array bl_count contains the frequencies for each bit length.
1093 * The length opt_len is updated; static_len is also updated if stree is
1094 * not null.
1095 */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001096static void gen_bitlen(tree_desc * desc)
Eric Andersencc8ed391999-10-05 16:24:54 +00001097{
Eric Andersen3073dfb2001-07-02 17:57:32 +00001098 ct_data *tree = desc->dyn_tree;
Denis Vlasenko6ca409e2007-08-12 20:58:27 +00001099 const uint8_t *extra = desc->extra_bits;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001100 int base = desc->extra_base;
1101 int max_code = desc->max_code;
1102 int max_length = desc->max_length;
Eric Andersen3073dfb2001-07-02 17:57:32 +00001103 ct_data *stree = desc->static_tree;
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001104 int h; /* heap index */
1105 int n, m; /* iterate over the tree elements */
1106 int bits; /* bit length */
1107 int xbits; /* extra bits */
1108 ush f; /* frequency */
1109 int overflow = 0; /* number of elements with bit length too large */
Eric Andersencc8ed391999-10-05 16:24:54 +00001110
Erik Andersene49d5ec2000-02-08 19:58:47 +00001111 for (bits = 0; bits <= MAX_BITS; bits++)
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001112 G2.bl_count[bits] = 0;
Eric Andersencc8ed391999-10-05 16:24:54 +00001113
Erik Andersene49d5ec2000-02-08 19:58:47 +00001114 /* In a first pass, compute the optimal bit lengths (which may
1115 * overflow in the case of the bit length tree).
1116 */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001117 tree[G2.heap[G2.heap_max]].Len = 0; /* root of the heap */
Eric Andersencc8ed391999-10-05 16:24:54 +00001118
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001119 for (h = G2.heap_max + 1; h < HEAP_SIZE; h++) {
1120 n = G2.heap[h];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001121 bits = tree[tree[n].Dad].Len + 1;
Denis Vlasenkof8241362007-01-07 19:38:42 +00001122 if (bits > max_length) {
1123 bits = max_length;
1124 overflow++;
1125 }
Erik Andersene49d5ec2000-02-08 19:58:47 +00001126 tree[n].Len = (ush) bits;
1127 /* We overwrite tree[n].Dad which is no longer needed */
Eric Andersencc8ed391999-10-05 16:24:54 +00001128
Erik Andersene49d5ec2000-02-08 19:58:47 +00001129 if (n > max_code)
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001130 continue; /* not a leaf node */
Eric Andersencc8ed391999-10-05 16:24:54 +00001131
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001132 G2.bl_count[bits]++;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001133 xbits = 0;
1134 if (n >= base)
1135 xbits = extra[n - base];
1136 f = tree[n].Freq;
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001137 G2.opt_len += (ulg) f *(bits + xbits);
Eric Andersencc8ed391999-10-05 16:24:54 +00001138
Erik Andersene49d5ec2000-02-08 19:58:47 +00001139 if (stree)
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001140 G2.static_len += (ulg) f * (stree[n].Len + xbits);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001141 }
1142 if (overflow == 0)
1143 return;
Eric Andersencc8ed391999-10-05 16:24:54 +00001144
Erik Andersene49d5ec2000-02-08 19:58:47 +00001145 Trace((stderr, "\nbit length overflow\n"));
1146 /* This happens for example on obj2 and pic of the Calgary corpus */
Eric Andersencc8ed391999-10-05 16:24:54 +00001147
Erik Andersene49d5ec2000-02-08 19:58:47 +00001148 /* Find the first bit length which could increase: */
1149 do {
1150 bits = max_length - 1;
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001151 while (G2.bl_count[bits] == 0)
Erik Andersene49d5ec2000-02-08 19:58:47 +00001152 bits--;
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001153 G2.bl_count[bits]--; /* move one leaf down the tree */
1154 G2.bl_count[bits + 1] += 2; /* move one overflow item as its brother */
1155 G2.bl_count[max_length]--;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001156 /* The brother of the overflow item also moves one step up,
1157 * but this does not affect bl_count[max_length]
1158 */
1159 overflow -= 2;
1160 } while (overflow > 0);
1161
1162 /* Now recompute all bit lengths, scanning in increasing frequency.
1163 * h is still equal to HEAP_SIZE. (It is simpler to reconstruct all
1164 * lengths instead of fixing only the wrong ones. This idea is taken
1165 * from 'ar' written by Haruhiko Okumura.)
1166 */
1167 for (bits = max_length; bits != 0; bits--) {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001168 n = G2.bl_count[bits];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001169 while (n != 0) {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001170 m = G2.heap[--h];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001171 if (m > max_code)
1172 continue;
1173 if (tree[m].Len != (unsigned) bits) {
Denis Vlasenko1a03c212007-01-07 19:39:34 +00001174 Trace((stderr, "code %d bits %d->%d\n", m, tree[m].Len, bits));
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001175 G2.opt_len += ((int32_t) bits - tree[m].Len) * tree[m].Freq;
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001176 tree[m].Len = bits;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001177 }
1178 n--;
1179 }
1180 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001181}
1182
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001183
Eric Andersencc8ed391999-10-05 16:24:54 +00001184/* ===========================================================================
1185 * Generate the codes for a given tree and bit counts (which need not be
1186 * optimal).
1187 * IN assertion: the array bl_count contains the bit length statistics for
1188 * the given tree and the field len is set for all tree elements.
1189 * OUT assertion: the field code is set for all tree elements of non
1190 * zero code length.
1191 */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001192static void gen_codes(ct_data * tree, int max_code)
Eric Andersencc8ed391999-10-05 16:24:54 +00001193{
Erik Andersene49d5ec2000-02-08 19:58:47 +00001194 ush next_code[MAX_BITS + 1]; /* next code value for each bit length */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001195 ush code = 0; /* running code value */
1196 int bits; /* bit index */
1197 int n; /* code index */
Eric Andersencc8ed391999-10-05 16:24:54 +00001198
Erik Andersene49d5ec2000-02-08 19:58:47 +00001199 /* The distribution counts are first used to generate the code values
1200 * without bit reversal.
1201 */
1202 for (bits = 1; bits <= MAX_BITS; bits++) {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001203 next_code[bits] = code = (code + G2.bl_count[bits - 1]) << 1;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001204 }
1205 /* Check that the bit counts in bl_count are consistent. The last code
1206 * must be all ones.
1207 */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001208 Assert(code + G2.bl_count[MAX_BITS] - 1 == (1 << MAX_BITS) - 1,
Tanguy Pruvot823694d2012-11-18 13:20:29 +01001209 "inconsistent bit counts");
Erik Andersene49d5ec2000-02-08 19:58:47 +00001210 Tracev((stderr, "\ngen_codes: max_code %d ", max_code));
Eric Andersencc8ed391999-10-05 16:24:54 +00001211
Erik Andersene49d5ec2000-02-08 19:58:47 +00001212 for (n = 0; n <= max_code; n++) {
1213 int len = tree[n].Len;
Eric Andersencc8ed391999-10-05 16:24:54 +00001214
Erik Andersene49d5ec2000-02-08 19:58:47 +00001215 if (len == 0)
1216 continue;
1217 /* Now reverse the bits */
1218 tree[n].Code = bi_reverse(next_code[len]++, len);
1219
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001220 Tracec(tree != G2.static_ltree,
Erik Andersene49d5ec2000-02-08 19:58:47 +00001221 (stderr, "\nn %3d %c l %2d c %4x (%x) ", n,
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001222 (n > ' ' ? n : ' '), len, tree[n].Code,
Erik Andersene49d5ec2000-02-08 19:58:47 +00001223 next_code[len] - 1));
1224 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001225}
1226
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001227
Eric Andersencc8ed391999-10-05 16:24:54 +00001228/* ===========================================================================
1229 * Construct one Huffman tree and assigns the code bit strings and lengths.
1230 * Update the total bit length for the current block.
1231 * IN assertion: the field freq is set for all tree elements.
1232 * OUT assertions: the fields len and code are set to the optimal bit length
1233 * and corresponding code. The length opt_len is updated; static_len is
1234 * also updated if stree is not null. The field max_code is set.
1235 */
Denis Vlasenko89af56b2007-01-07 19:40:34 +00001236
1237/* Remove the smallest element from the heap and recreate the heap with
1238 * one less element. Updates heap and heap_len. */
1239
1240#define SMALLEST 1
1241/* Index within the heap array of least frequent node in the Huffman tree */
1242
1243#define PQREMOVE(tree, top) \
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001244do { \
1245 top = G2.heap[SMALLEST]; \
1246 G2.heap[SMALLEST] = G2.heap[G2.heap_len--]; \
Denis Vlasenko89af56b2007-01-07 19:40:34 +00001247 pqdownheap(tree, SMALLEST); \
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001248} while (0)
Denis Vlasenko89af56b2007-01-07 19:40:34 +00001249
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001250static void build_tree(tree_desc * desc)
Eric Andersencc8ed391999-10-05 16:24:54 +00001251{
Eric Andersen3073dfb2001-07-02 17:57:32 +00001252 ct_data *tree = desc->dyn_tree;
1253 ct_data *stree = desc->static_tree;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001254 int elems = desc->elems;
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001255 int n, m; /* iterate over heap elements */
1256 int max_code = -1; /* largest code with non zero frequency */
1257 int node = elems; /* next internal node of the tree */
Eric Andersencc8ed391999-10-05 16:24:54 +00001258
Erik Andersene49d5ec2000-02-08 19:58:47 +00001259 /* Construct the initial heap, with least frequent element in
1260 * heap[SMALLEST]. The sons of heap[n] are heap[2*n] and heap[2*n+1].
1261 * heap[0] is not used.
1262 */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001263 G2.heap_len = 0;
1264 G2.heap_max = HEAP_SIZE;
Eric Andersencc8ed391999-10-05 16:24:54 +00001265
Erik Andersene49d5ec2000-02-08 19:58:47 +00001266 for (n = 0; n < elems; n++) {
1267 if (tree[n].Freq != 0) {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001268 G2.heap[++G2.heap_len] = max_code = n;
1269 G2.depth[n] = 0;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001270 } else {
1271 tree[n].Len = 0;
1272 }
1273 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001274
Erik Andersene49d5ec2000-02-08 19:58:47 +00001275 /* The pkzip format requires that at least one distance code exists,
1276 * and that at least one bit should be sent even if there is only one
1277 * possible code. So to avoid special checks later on we force at least
1278 * two codes of non zero frequency.
1279 */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001280 while (G2.heap_len < 2) {
1281 int new = G2.heap[++G2.heap_len] = (max_code < 2 ? ++max_code : 0);
Eric Andersencc8ed391999-10-05 16:24:54 +00001282
Erik Andersene49d5ec2000-02-08 19:58:47 +00001283 tree[new].Freq = 1;
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001284 G2.depth[new] = 0;
1285 G2.opt_len--;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001286 if (stree)
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001287 G2.static_len -= stree[new].Len;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001288 /* new is 0 or 1 so it does not have extra bits */
1289 }
1290 desc->max_code = max_code;
Eric Andersencc8ed391999-10-05 16:24:54 +00001291
Erik Andersene49d5ec2000-02-08 19:58:47 +00001292 /* The elements heap[heap_len/2+1 .. heap_len] are leaves of the tree,
1293 * establish sub-heaps of increasing lengths:
1294 */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001295 for (n = G2.heap_len / 2; n >= 1; n--)
Erik Andersene49d5ec2000-02-08 19:58:47 +00001296 pqdownheap(tree, n);
Eric Andersencc8ed391999-10-05 16:24:54 +00001297
Erik Andersene49d5ec2000-02-08 19:58:47 +00001298 /* Construct the Huffman tree by repeatedly combining the least two
1299 * frequent nodes.
1300 */
1301 do {
Denis Vlasenko89af56b2007-01-07 19:40:34 +00001302 PQREMOVE(tree, n); /* n = node of least frequency */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001303 m = G2.heap[SMALLEST]; /* m = node of next least frequency */
Eric Andersencc8ed391999-10-05 16:24:54 +00001304
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001305 G2.heap[--G2.heap_max] = n; /* keep the nodes sorted by frequency */
1306 G2.heap[--G2.heap_max] = m;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001307
1308 /* Create a new node father of n and m */
1309 tree[node].Freq = tree[n].Freq + tree[m].Freq;
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001310 G2.depth[node] = MAX(G2.depth[n], G2.depth[m]) + 1;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001311 tree[n].Dad = tree[m].Dad = (ush) node;
Eric Andersencc8ed391999-10-05 16:24:54 +00001312#ifdef DUMP_BL_TREE
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001313 if (tree == G2.bl_tree) {
Manuel Novoa III cad53642003-03-19 09:13:01 +00001314 bb_error_msg("\nnode %d(%d), sons %d(%d) %d(%d)",
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001315 node, tree[node].Freq, n, tree[n].Freq, m, tree[m].Freq);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001316 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001317#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +00001318 /* and insert the new node in the heap */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001319 G2.heap[SMALLEST] = node++;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001320 pqdownheap(tree, SMALLEST);
Eric Andersencc8ed391999-10-05 16:24:54 +00001321
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001322 } while (G2.heap_len >= 2);
Eric Andersencc8ed391999-10-05 16:24:54 +00001323
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001324 G2.heap[--G2.heap_max] = G2.heap[SMALLEST];
Eric Andersencc8ed391999-10-05 16:24:54 +00001325
Erik Andersene49d5ec2000-02-08 19:58:47 +00001326 /* At this point, the fields freq and dad are set. We can now
1327 * generate the bit lengths.
1328 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001329 gen_bitlen((tree_desc *) desc);
Eric Andersencc8ed391999-10-05 16:24:54 +00001330
Erik Andersene49d5ec2000-02-08 19:58:47 +00001331 /* The field len is now set, we can generate the bit codes */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001332 gen_codes((ct_data *) tree, max_code);
Eric Andersencc8ed391999-10-05 16:24:54 +00001333}
1334
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001335
Eric Andersencc8ed391999-10-05 16:24:54 +00001336/* ===========================================================================
1337 * Scan a literal or distance tree to determine the frequencies of the codes
1338 * in the bit length tree. Updates opt_len to take into account the repeat
1339 * counts. (The contribution of the bit length codes will be added later
1340 * during the construction of bl_tree.)
1341 */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001342static void scan_tree(ct_data * tree, int max_code)
Eric Andersencc8ed391999-10-05 16:24:54 +00001343{
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001344 int n; /* iterates over all tree elements */
1345 int prevlen = -1; /* last emitted length */
1346 int curlen; /* length of current code */
Erik Andersene49d5ec2000-02-08 19:58:47 +00001347 int nextlen = tree[0].Len; /* length of next code */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001348 int count = 0; /* repeat count of the current code */
1349 int max_count = 7; /* max repeat count */
1350 int min_count = 4; /* min repeat count */
Eric Andersencc8ed391999-10-05 16:24:54 +00001351
Denis Vlasenko1a03c212007-01-07 19:39:34 +00001352 if (nextlen == 0) {
1353 max_count = 138;
1354 min_count = 3;
1355 }
Denis Vlasenko2f6df7f2007-01-07 19:44:35 +00001356 tree[max_code + 1].Len = 0xffff; /* guard */
Eric Andersencc8ed391999-10-05 16:24:54 +00001357
Erik Andersene49d5ec2000-02-08 19:58:47 +00001358 for (n = 0; n <= max_code; n++) {
1359 curlen = nextlen;
1360 nextlen = tree[n + 1].Len;
Denis Vlasenko2f6df7f2007-01-07 19:44:35 +00001361 if (++count < max_count && curlen == nextlen)
Erik Andersene49d5ec2000-02-08 19:58:47 +00001362 continue;
Denis Vlasenko2f6df7f2007-01-07 19:44:35 +00001363
1364 if (count < min_count) {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001365 G2.bl_tree[curlen].Freq += count;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001366 } else if (curlen != 0) {
1367 if (curlen != prevlen)
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001368 G2.bl_tree[curlen].Freq++;
1369 G2.bl_tree[REP_3_6].Freq++;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001370 } else if (count <= 10) {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001371 G2.bl_tree[REPZ_3_10].Freq++;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001372 } else {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001373 G2.bl_tree[REPZ_11_138].Freq++;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001374 }
1375 count = 0;
1376 prevlen = curlen;
Denis Vlasenko2f6df7f2007-01-07 19:44:35 +00001377
1378 max_count = 7;
1379 min_count = 4;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001380 if (nextlen == 0) {
Denis Vlasenko1a03c212007-01-07 19:39:34 +00001381 max_count = 138;
1382 min_count = 3;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001383 } else if (curlen == nextlen) {
Denis Vlasenko1a03c212007-01-07 19:39:34 +00001384 max_count = 6;
1385 min_count = 3;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001386 }
1387 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001388}
1389
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001390
Eric Andersencc8ed391999-10-05 16:24:54 +00001391/* ===========================================================================
1392 * Send a literal or distance tree in compressed form, using the codes in
1393 * bl_tree.
1394 */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001395static void send_tree(ct_data * tree, int max_code)
Eric Andersencc8ed391999-10-05 16:24:54 +00001396{
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001397 int n; /* iterates over all tree elements */
1398 int prevlen = -1; /* last emitted length */
1399 int curlen; /* length of current code */
Erik Andersene49d5ec2000-02-08 19:58:47 +00001400 int nextlen = tree[0].Len; /* length of next code */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001401 int count = 0; /* repeat count of the current code */
1402 int max_count = 7; /* max repeat count */
1403 int min_count = 4; /* min repeat count */
Eric Andersencc8ed391999-10-05 16:24:54 +00001404
Erik Andersene49d5ec2000-02-08 19:58:47 +00001405/* tree[max_code+1].Len = -1; *//* guard already set */
1406 if (nextlen == 0)
1407 max_count = 138, min_count = 3;
Eric Andersencc8ed391999-10-05 16:24:54 +00001408
Erik Andersene49d5ec2000-02-08 19:58:47 +00001409 for (n = 0; n <= max_code; n++) {
1410 curlen = nextlen;
1411 nextlen = tree[n + 1].Len;
1412 if (++count < max_count && curlen == nextlen) {
1413 continue;
1414 } else if (count < min_count) {
1415 do {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001416 SEND_CODE(curlen, G2.bl_tree);
Denis Vlasenko1a03c212007-01-07 19:39:34 +00001417 } while (--count);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001418 } else if (curlen != 0) {
1419 if (curlen != prevlen) {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001420 SEND_CODE(curlen, G2.bl_tree);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001421 count--;
1422 }
1423 Assert(count >= 3 && count <= 6, " 3_6?");
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001424 SEND_CODE(REP_3_6, G2.bl_tree);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001425 send_bits(count - 3, 2);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001426 } else if (count <= 10) {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001427 SEND_CODE(REPZ_3_10, G2.bl_tree);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001428 send_bits(count - 3, 3);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001429 } else {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001430 SEND_CODE(REPZ_11_138, G2.bl_tree);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001431 send_bits(count - 11, 7);
1432 }
1433 count = 0;
1434 prevlen = curlen;
1435 if (nextlen == 0) {
Denis Vlasenko1a03c212007-01-07 19:39:34 +00001436 max_count = 138;
1437 min_count = 3;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001438 } else if (curlen == nextlen) {
Denis Vlasenko1a03c212007-01-07 19:39:34 +00001439 max_count = 6;
1440 min_count = 3;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001441 } else {
Denis Vlasenko1a03c212007-01-07 19:39:34 +00001442 max_count = 7;
1443 min_count = 4;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001444 }
1445 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001446}
1447
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001448
Eric Andersencc8ed391999-10-05 16:24:54 +00001449/* ===========================================================================
1450 * Construct the Huffman tree for the bit lengths and return the index in
1451 * bl_order of the last bit length code to send.
1452 */
Mike Frysinger4e5936e2005-04-16 04:30:38 +00001453static int build_bl_tree(void)
Eric Andersencc8ed391999-10-05 16:24:54 +00001454{
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001455 int max_blindex; /* index of last bit length code of non zero freq */
Eric Andersencc8ed391999-10-05 16:24:54 +00001456
Erik Andersene49d5ec2000-02-08 19:58:47 +00001457 /* Determine the bit length frequencies for literal and distance trees */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001458 scan_tree(G2.dyn_ltree, G2.l_desc.max_code);
1459 scan_tree(G2.dyn_dtree, G2.d_desc.max_code);
Eric Andersencc8ed391999-10-05 16:24:54 +00001460
Erik Andersene49d5ec2000-02-08 19:58:47 +00001461 /* Build the bit length tree: */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001462 build_tree(&G2.bl_desc);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001463 /* opt_len now includes the length of the tree representations, except
1464 * the lengths of the bit lengths codes and the 5+5+4 bits for the counts.
1465 */
Eric Andersencc8ed391999-10-05 16:24:54 +00001466
Erik Andersene49d5ec2000-02-08 19:58:47 +00001467 /* Determine the number of bit length codes to send. The pkzip format
1468 * requires that at least 4 bit length codes be sent. (appnote.txt says
1469 * 3 but the actual value used is 4.)
1470 */
1471 for (max_blindex = BL_CODES - 1; max_blindex >= 3; max_blindex--) {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001472 if (G2.bl_tree[bl_order[max_blindex]].Len != 0)
Erik Andersene49d5ec2000-02-08 19:58:47 +00001473 break;
1474 }
1475 /* Update opt_len to include the bit length tree and counts */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001476 G2.opt_len += 3 * (max_blindex + 1) + 5 + 5 + 4;
1477 Tracev((stderr, "\ndyn trees: dyn %ld, stat %ld", G2.opt_len, G2.static_len));
Eric Andersencc8ed391999-10-05 16:24:54 +00001478
Erik Andersene49d5ec2000-02-08 19:58:47 +00001479 return max_blindex;
Eric Andersencc8ed391999-10-05 16:24:54 +00001480}
1481
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001482
Eric Andersencc8ed391999-10-05 16:24:54 +00001483/* ===========================================================================
1484 * Send the header for a block using dynamic Huffman trees: the counts, the
1485 * lengths of the bit length codes, the literal tree and the distance tree.
1486 * IN assertion: lcodes >= 257, dcodes >= 1, blcodes >= 4.
1487 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001488static void send_all_trees(int lcodes, int dcodes, int blcodes)
Eric Andersencc8ed391999-10-05 16:24:54 +00001489{
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001490 int rank; /* index in bl_order */
Eric Andersencc8ed391999-10-05 16:24:54 +00001491
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001492 Assert(lcodes >= 257 && dcodes >= 1 && blcodes >= 4, "not enough codes");
Erik Andersene49d5ec2000-02-08 19:58:47 +00001493 Assert(lcodes <= L_CODES && dcodes <= D_CODES
1494 && blcodes <= BL_CODES, "too many codes");
1495 Tracev((stderr, "\nbl counts: "));
1496 send_bits(lcodes - 257, 5); /* not +255 as stated in appnote.txt */
1497 send_bits(dcodes - 1, 5);
1498 send_bits(blcodes - 4, 4); /* not -3 as stated in appnote.txt */
1499 for (rank = 0; rank < blcodes; rank++) {
1500 Tracev((stderr, "\nbl code %2d ", bl_order[rank]));
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001501 send_bits(G2.bl_tree[bl_order[rank]].Len, 3);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001502 }
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001503 Tracev((stderr, "\nbl tree: sent %ld", G1.bits_sent));
Eric Andersencc8ed391999-10-05 16:24:54 +00001504
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001505 send_tree((ct_data *) G2.dyn_ltree, lcodes - 1); /* send the literal tree */
1506 Tracev((stderr, "\nlit tree: sent %ld", G1.bits_sent));
Eric Andersencc8ed391999-10-05 16:24:54 +00001507
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001508 send_tree((ct_data *) G2.dyn_dtree, dcodes - 1); /* send the distance tree */
1509 Tracev((stderr, "\ndist tree: sent %ld", G1.bits_sent));
Eric Andersencc8ed391999-10-05 16:24:54 +00001510}
1511
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001512
Eric Andersencc8ed391999-10-05 16:24:54 +00001513/* ===========================================================================
1514 * Save the match info and tally the frequency counts. Return true if
1515 * the current block must be flushed.
1516 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001517static int ct_tally(int dist, int lc)
Eric Andersencc8ed391999-10-05 16:24:54 +00001518{
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001519 G1.l_buf[G2.last_lit++] = lc;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001520 if (dist == 0) {
1521 /* lc is the unmatched char */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001522 G2.dyn_ltree[lc].Freq++;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001523 } else {
1524 /* Here, lc is the match length - MIN_MATCH */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001525 dist--; /* dist = match distance - 1 */
Denis Vlasenko1a03c212007-01-07 19:39:34 +00001526 Assert((ush) dist < (ush) MAX_DIST
1527 && (ush) lc <= (ush) (MAX_MATCH - MIN_MATCH)
Denis Vlasenko89af56b2007-01-07 19:40:34 +00001528 && (ush) D_CODE(dist) < (ush) D_CODES, "ct_tally: bad match"
Denis Vlasenko1a03c212007-01-07 19:39:34 +00001529 );
Eric Andersencc8ed391999-10-05 16:24:54 +00001530
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001531 G2.dyn_ltree[G2.length_code[lc] + LITERALS + 1].Freq++;
1532 G2.dyn_dtree[D_CODE(dist)].Freq++;
Eric Andersencc8ed391999-10-05 16:24:54 +00001533
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001534 G1.d_buf[G2.last_dist++] = dist;
1535 G2.flags |= G2.flag_bit;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001536 }
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001537 G2.flag_bit <<= 1;
Eric Andersencc8ed391999-10-05 16:24:54 +00001538
Erik Andersene49d5ec2000-02-08 19:58:47 +00001539 /* Output the flags if they fill a byte: */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001540 if ((G2.last_lit & 7) == 0) {
1541 G2.flag_buf[G2.last_flags++] = G2.flags;
1542 G2.flags = 0;
1543 G2.flag_bit = 1;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001544 }
1545 /* Try to guess if it is profitable to stop the current block here */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001546 if ((G2.last_lit & 0xfff) == 0) {
Erik Andersene49d5ec2000-02-08 19:58:47 +00001547 /* Compute an upper bound for the compressed length */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001548 ulg out_length = G2.last_lit * 8L;
1549 ulg in_length = (ulg) G1.strstart - G1.block_start;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001550 int dcode;
1551
1552 for (dcode = 0; dcode < D_CODES; dcode++) {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001553 out_length += G2.dyn_dtree[dcode].Freq * (5L + extra_dbits[dcode]);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001554 }
1555 out_length >>= 3;
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001556 Trace((stderr,
Tanguy Pruvot823694d2012-11-18 13:20:29 +01001557 "\nlast_lit %u, last_dist %u, in %ld, out ~%ld(%ld%%) ",
1558 G2.last_lit, G2.last_dist, in_length, out_length,
1559 100L - out_length * 100L / in_length));
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001560 if (G2.last_dist < G2.last_lit / 2 && out_length < in_length / 2)
Erik Andersene49d5ec2000-02-08 19:58:47 +00001561 return 1;
1562 }
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001563 return (G2.last_lit == LIT_BUFSIZE - 1 || G2.last_dist == DIST_BUFSIZE);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001564 /* We avoid equality with LIT_BUFSIZE because of wraparound at 64K
1565 * on 16 bit machines and because stored blocks are restricted to
1566 * 64K-1 bytes.
1567 */
Eric Andersencc8ed391999-10-05 16:24:54 +00001568}
1569
1570/* ===========================================================================
1571 * Send the block data compressed using the given Huffman trees
1572 */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001573static void compress_block(ct_data * ltree, ct_data * dtree)
Eric Andersencc8ed391999-10-05 16:24:54 +00001574{
Denis Vlasenkodb6a5c32007-01-07 19:45:51 +00001575 unsigned dist; /* distance of matched string */
1576 int lc; /* match length or unmatched char (if dist == 0) */
1577 unsigned lx = 0; /* running index in l_buf */
1578 unsigned dx = 0; /* running index in d_buf */
1579 unsigned fx = 0; /* running index in flag_buf */
1580 uch flag = 0; /* current flags */
1581 unsigned code; /* the code to send */
1582 int extra; /* number of extra bits to send */
Eric Andersencc8ed391999-10-05 16:24:54 +00001583
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001584 if (G2.last_lit != 0) do {
Denis Vlasenkodb6a5c32007-01-07 19:45:51 +00001585 if ((lx & 7) == 0)
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001586 flag = G2.flag_buf[fx++];
1587 lc = G1.l_buf[lx++];
Denis Vlasenkodb6a5c32007-01-07 19:45:51 +00001588 if ((flag & 1) == 0) {
1589 SEND_CODE(lc, ltree); /* send a literal byte */
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001590 Tracecv(lc > ' ', (stderr, " '%c' ", lc));
Denis Vlasenkodb6a5c32007-01-07 19:45:51 +00001591 } else {
1592 /* Here, lc is the match length - MIN_MATCH */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001593 code = G2.length_code[lc];
Denis Vlasenkodb6a5c32007-01-07 19:45:51 +00001594 SEND_CODE(code + LITERALS + 1, ltree); /* send the length code */
1595 extra = extra_lbits[code];
1596 if (extra != 0) {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001597 lc -= G2.base_length[code];
Denis Vlasenkodb6a5c32007-01-07 19:45:51 +00001598 send_bits(lc, extra); /* send the extra length bits */
1599 }
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001600 dist = G1.d_buf[dx++];
Denis Vlasenkodb6a5c32007-01-07 19:45:51 +00001601 /* Here, dist is the match distance - 1 */
1602 code = D_CODE(dist);
1603 Assert(code < D_CODES, "bad d_code");
Eric Andersencc8ed391999-10-05 16:24:54 +00001604
Denis Vlasenkodb6a5c32007-01-07 19:45:51 +00001605 SEND_CODE(code, dtree); /* send the distance code */
1606 extra = extra_dbits[code];
1607 if (extra != 0) {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001608 dist -= G2.base_dist[code];
Denis Vlasenkodb6a5c32007-01-07 19:45:51 +00001609 send_bits(dist, extra); /* send the extra distance bits */
1610 }
1611 } /* literal or match pair ? */
1612 flag >>= 1;
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001613 } while (lx < G2.last_lit);
Eric Andersencc8ed391999-10-05 16:24:54 +00001614
Denis Vlasenko89af56b2007-01-07 19:40:34 +00001615 SEND_CODE(END_BLOCK, ltree);
Eric Andersencc8ed391999-10-05 16:24:54 +00001616}
1617
Erik Andersene49d5ec2000-02-08 19:58:47 +00001618
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001619/* ===========================================================================
1620 * Determine the best encoding for the current block: dynamic trees, static
1621 * trees or store, and output the encoded block to the zip file. This function
1622 * returns the total compressed length for the file so far.
1623 */
1624static ulg flush_block(char *buf, ulg stored_len, int eof)
1625{
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001626 ulg opt_lenb, static_lenb; /* opt_len and static_len in bytes */
1627 int max_blindex; /* index of last bit length code of non zero freq */
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001628
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001629 G2.flag_buf[G2.last_flags] = G2.flags; /* Save the flags for the last 8 items */
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001630
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001631 /* Construct the literal and distance trees */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001632 build_tree(&G2.l_desc);
1633 Tracev((stderr, "\nlit data: dyn %ld, stat %ld", G2.opt_len, G2.static_len));
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001634
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001635 build_tree(&G2.d_desc);
1636 Tracev((stderr, "\ndist data: dyn %ld, stat %ld", G2.opt_len, G2.static_len));
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001637 /* At this point, opt_len and static_len are the total bit lengths of
1638 * the compressed block data, excluding the tree representations.
1639 */
1640
1641 /* Build the bit length tree for the above two trees, and get the index
1642 * in bl_order of the last bit length code to send.
1643 */
1644 max_blindex = build_bl_tree();
1645
1646 /* Determine the best encoding. Compute first the block length in bytes */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001647 opt_lenb = (G2.opt_len + 3 + 7) >> 3;
1648 static_lenb = (G2.static_len + 3 + 7) >> 3;
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001649
1650 Trace((stderr,
Tanguy Pruvot823694d2012-11-18 13:20:29 +01001651 "\nopt %lu(%lu) stat %lu(%lu) stored %lu lit %u dist %u ",
1652 opt_lenb, G2.opt_len, static_lenb, G2.static_len, stored_len,
1653 G2.last_lit, G2.last_dist));
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001654
1655 if (static_lenb <= opt_lenb)
1656 opt_lenb = static_lenb;
1657
1658 /* If compression failed and this is the first and last block,
1659 * and if the zip file can be seeked (to rewrite the local header),
1660 * the whole file is transformed into a stored file:
1661 */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001662 if (stored_len <= opt_lenb && eof && G2.compressed_len == 0L && seekable()) {
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001663 /* Since LIT_BUFSIZE <= 2*WSIZE, the input data must be there: */
1664 if (buf == NULL)
1665 bb_error_msg("block vanished");
1666
1667 copy_block(buf, (unsigned) stored_len, 0); /* without header */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001668 G2.compressed_len = stored_len << 3;
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001669
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001670 } else if (stored_len + 4 <= opt_lenb && buf != NULL) {
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001671 /* 4: two words for the lengths */
1672 /* The test buf != NULL is only necessary if LIT_BUFSIZE > WSIZE.
1673 * Otherwise we can't have processed more than WSIZE input bytes since
1674 * the last block flush, because compression would have been
1675 * successful. If LIT_BUFSIZE <= WSIZE, it is never too late to
1676 * transform a block into a stored block.
1677 */
1678 send_bits((STORED_BLOCK << 1) + eof, 3); /* send block type */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001679 G2.compressed_len = (G2.compressed_len + 3 + 7) & ~7L;
1680 G2.compressed_len += (stored_len + 4) << 3;
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001681
1682 copy_block(buf, (unsigned) stored_len, 1); /* with header */
1683
1684 } else if (static_lenb == opt_lenb) {
1685 send_bits((STATIC_TREES << 1) + eof, 3);
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001686 compress_block((ct_data *) G2.static_ltree, (ct_data *) G2.static_dtree);
1687 G2.compressed_len += 3 + G2.static_len;
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001688 } else {
1689 send_bits((DYN_TREES << 1) + eof, 3);
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001690 send_all_trees(G2.l_desc.max_code + 1, G2.d_desc.max_code + 1,
Tanguy Pruvot823694d2012-11-18 13:20:29 +01001691 max_blindex + 1);
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001692 compress_block((ct_data *) G2.dyn_ltree, (ct_data *) G2.dyn_dtree);
1693 G2.compressed_len += 3 + G2.opt_len;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001694 }
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001695 Assert(G2.compressed_len == G1.bits_sent, "bad compressed size");
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001696 init_block();
1697
1698 if (eof) {
1699 bi_windup();
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001700 G2.compressed_len += 7; /* align on byte boundary */
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001701 }
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001702 Tracev((stderr, "\ncomprlen %lu(%lu) ", G2.compressed_len >> 3,
1703 G2.compressed_len - 7 * eof));
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001704
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001705 return G2.compressed_len >> 3;
Eric Andersencc8ed391999-10-05 16:24:54 +00001706}
Erik Andersene49d5ec2000-02-08 19:58:47 +00001707
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001708
1709/* ===========================================================================
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001710 * Update a hash value with the given input byte
Marek Polacekb0b88842011-04-16 17:33:43 +02001711 * IN assertion: all calls to UPDATE_HASH are made with consecutive
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001712 * input characters, so that a running hash key can be computed from the
1713 * previous key instead of complete recalculation each time.
1714 */
1715#define UPDATE_HASH(h, c) (h = (((h)<<H_SHIFT) ^ (c)) & HASH_MASK)
1716
1717
1718/* ===========================================================================
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001719 * Same as above, but achieves better compression. We use a lazy
1720 * evaluation for matches: a match is finally adopted only if there is
1721 * no better match at the next window position.
1722 *
1723 * Processes a new input file and return its compressed length. Sets
1724 * the compressed length, crc, deflate flags and internal file
1725 * attributes.
1726 */
1727
1728/* Flush the current block, with given end-of-file flag.
1729 * IN assertion: strstart is set to the end of the current match. */
1730#define FLUSH_BLOCK(eof) \
1731 flush_block( \
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001732 G1.block_start >= 0L \
1733 ? (char*)&G1.window[(unsigned)G1.block_start] \
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001734 : (char*)NULL, \
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001735 (ulg)G1.strstart - G1.block_start, \
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001736 (eof) \
1737 )
1738
1739/* Insert string s in the dictionary and set match_head to the previous head
1740 * of the hash chain (the most recent string with same hash key). Return
1741 * the previous length of the hash chain.
Marek Polacekb0b88842011-04-16 17:33:43 +02001742 * IN assertion: all calls to INSERT_STRING are made with consecutive
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001743 * input characters and the first MIN_MATCH bytes of s are valid
1744 * (except for the last MIN_MATCH-1 bytes of the input file). */
1745#define INSERT_STRING(s, match_head) \
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001746do { \
1747 UPDATE_HASH(G1.ins_h, G1.window[(s) + MIN_MATCH-1]); \
1748 G1.prev[(s) & WMASK] = match_head = head[G1.ins_h]; \
1749 head[G1.ins_h] = (s); \
1750} while (0)
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001751
1752static ulg deflate(void)
1753{
1754 IPos hash_head; /* head of hash chain */
1755 IPos prev_match; /* previous match */
1756 int flush; /* set if current block must be flushed */
1757 int match_available = 0; /* set if previous match exists */
1758 unsigned match_length = MIN_MATCH - 1; /* length of best match */
1759
1760 /* Process the input block. */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001761 while (G1.lookahead != 0) {
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001762 /* Insert the string window[strstart .. strstart+2] in the
1763 * dictionary, and set hash_head to the head of the hash chain:
1764 */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001765 INSERT_STRING(G1.strstart, hash_head);
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001766
1767 /* Find the longest match, discarding those <= prev_length.
1768 */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001769 G1.prev_length = match_length;
1770 prev_match = G1.match_start;
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001771 match_length = MIN_MATCH - 1;
1772
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001773 if (hash_head != 0 && G1.prev_length < max_lazy_match
1774 && G1.strstart - hash_head <= MAX_DIST
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001775 ) {
1776 /* To simplify the code, we prevent matches with the string
1777 * of window index 0 (in particular we have to avoid a match
1778 * of the string with itself at the start of the input file).
1779 */
1780 match_length = longest_match(hash_head);
1781 /* longest_match() sets match_start */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001782 if (match_length > G1.lookahead)
1783 match_length = G1.lookahead;
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001784
1785 /* Ignore a length 3 match if it is too distant: */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001786 if (match_length == MIN_MATCH && G1.strstart - G1.match_start > TOO_FAR) {
1787 /* If prev_match is also MIN_MATCH, G1.match_start is garbage
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001788 * but we will ignore the current match anyway.
1789 */
1790 match_length--;
1791 }
1792 }
1793 /* If there was a match at the previous step and the current
1794 * match is not better, output the previous match:
1795 */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001796 if (G1.prev_length >= MIN_MATCH && match_length <= G1.prev_length) {
1797 check_match(G1.strstart - 1, prev_match, G1.prev_length);
1798 flush = ct_tally(G1.strstart - 1 - prev_match, G1.prev_length - MIN_MATCH);
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001799
1800 /* Insert in hash table all strings up to the end of the match.
1801 * strstart-1 and strstart are already inserted.
1802 */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001803 G1.lookahead -= G1.prev_length - 1;
1804 G1.prev_length -= 2;
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001805 do {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001806 G1.strstart++;
1807 INSERT_STRING(G1.strstart, hash_head);
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001808 /* strstart never exceeds WSIZE-MAX_MATCH, so there are
1809 * always MIN_MATCH bytes ahead. If lookahead < MIN_MATCH
1810 * these bytes are garbage, but it does not matter since the
1811 * next lookahead bytes will always be emitted as literals.
1812 */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001813 } while (--G1.prev_length != 0);
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001814 match_available = 0;
1815 match_length = MIN_MATCH - 1;
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001816 G1.strstart++;
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001817 if (flush) {
1818 FLUSH_BLOCK(0);
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001819 G1.block_start = G1.strstart;
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001820 }
1821 } else if (match_available) {
1822 /* If there was no match at the previous position, output a
1823 * single literal. If there was a match but the current match
1824 * is longer, truncate the previous match to a single literal.
1825 */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001826 Tracevv((stderr, "%c", G1.window[G1.strstart - 1]));
1827 if (ct_tally(0, G1.window[G1.strstart - 1])) {
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001828 FLUSH_BLOCK(0);
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001829 G1.block_start = G1.strstart;
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001830 }
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001831 G1.strstart++;
1832 G1.lookahead--;
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001833 } else {
1834 /* There is no previous match to compare with, wait for
1835 * the next step to decide.
1836 */
1837 match_available = 1;
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001838 G1.strstart++;
1839 G1.lookahead--;
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001840 }
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001841 Assert(G1.strstart <= G1.isize && lookahead <= G1.isize, "a bit too far");
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001842
1843 /* Make sure that we always have enough lookahead, except
1844 * at the end of the input file. We need MAX_MATCH bytes
1845 * for the next match, plus MIN_MATCH bytes to insert the
1846 * string following the next match.
1847 */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001848 while (G1.lookahead < MIN_LOOKAHEAD && !G1.eofile)
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001849 fill_window();
1850 }
1851 if (match_available)
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001852 ct_tally(0, G1.window[G1.strstart - 1]);
Denis Vlasenko56c83ea2007-01-07 19:40:50 +00001853
1854 return FLUSH_BLOCK(1); /* eof */
1855}
1856
1857
Eric Andersencc8ed391999-10-05 16:24:54 +00001858/* ===========================================================================
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001859 * Initialize the bit string routines.
1860 */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001861static void bi_init(void)
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001862{
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001863 G1.bi_buf = 0;
1864 G1.bi_valid = 0;
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001865#ifdef DEBUG
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001866 G1.bits_sent = 0L;
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001867#endif
1868}
1869
1870
1871/* ===========================================================================
1872 * Initialize the "longest match" routines for a new file
1873 */
Denis Vlasenkodb6a5c32007-01-07 19:45:51 +00001874static void lm_init(ush * flagsp)
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001875{
1876 unsigned j;
1877
1878 /* Initialize the hash table. */
1879 memset(head, 0, HASH_SIZE * sizeof(*head));
1880 /* prev will be initialized on the fly */
1881
Denis Vlasenkodb6a5c32007-01-07 19:45:51 +00001882 /* speed options for the general purpose bit flag */
1883 *flagsp |= 2; /* FAST 4, SLOW 2 */
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001884 /* ??? reduce max_chain_length for binary files */
1885
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001886 G1.strstart = 0;
1887 G1.block_start = 0L;
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001888
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001889 G1.lookahead = file_read(G1.window,
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001890 sizeof(int) <= 2 ? (unsigned) WSIZE : 2 * WSIZE);
1891
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001892 if (G1.lookahead == 0 || G1.lookahead == (unsigned) -1) {
1893 G1.eofile = 1;
1894 G1.lookahead = 0;
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001895 return;
1896 }
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001897 G1.eofile = 0;
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001898 /* Make sure that we always have enough lookahead. This is important
1899 * if input comes from a device such as a tty.
1900 */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001901 while (G1.lookahead < MIN_LOOKAHEAD && !G1.eofile)
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001902 fill_window();
1903
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001904 G1.ins_h = 0;
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001905 for (j = 0; j < MIN_MATCH - 1; j++)
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001906 UPDATE_HASH(G1.ins_h, G1.window[j]);
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001907 /* If lookahead < MIN_MATCH, ins_h is garbage, but this is
1908 * not important since only literal bytes will be emitted.
1909 */
1910}
1911
1912
1913/* ===========================================================================
1914 * Allocate the match buffer, initialize the various tables and save the
1915 * location of the internal file attribute (ascii/binary) and method
1916 * (DEFLATE/STORE).
1917 * One callsite in zip()
1918 */
Denis Vlasenkofe42d172007-03-14 00:08:28 +00001919static void ct_init(void)
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001920{
1921 int n; /* iterates over tree elements */
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001922 int length; /* length value */
1923 int code; /* code value */
1924 int dist; /* distance index */
1925
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001926 G2.compressed_len = 0L;
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001927
1928#ifdef NOT_NEEDED
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001929 if (G2.static_dtree[0].Len != 0)
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001930 return; /* ct_init already called */
1931#endif
1932
1933 /* Initialize the mapping length (0..255) -> length code (0..28) */
1934 length = 0;
1935 for (code = 0; code < LENGTH_CODES - 1; code++) {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001936 G2.base_length[code] = length;
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001937 for (n = 0; n < (1 << extra_lbits[code]); n++) {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001938 G2.length_code[length++] = code;
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001939 }
1940 }
1941 Assert(length == 256, "ct_init: length != 256");
1942 /* Note that the length 255 (match length 258) can be represented
1943 * in two different ways: code 284 + 5 bits or code 285, so we
1944 * overwrite length_code[255] to use the best encoding:
1945 */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001946 G2.length_code[length - 1] = code;
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001947
1948 /* Initialize the mapping dist (0..32K) -> dist code (0..29) */
1949 dist = 0;
1950 for (code = 0; code < 16; code++) {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001951 G2.base_dist[code] = dist;
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001952 for (n = 0; n < (1 << extra_dbits[code]); n++) {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001953 G2.dist_code[dist++] = code;
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001954 }
1955 }
1956 Assert(dist == 256, "ct_init: dist != 256");
1957 dist >>= 7; /* from now on, all distances are divided by 128 */
1958 for (; code < D_CODES; code++) {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001959 G2.base_dist[code] = dist << 7;
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001960 for (n = 0; n < (1 << (extra_dbits[code] - 7)); n++) {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001961 G2.dist_code[256 + dist++] = code;
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001962 }
1963 }
1964 Assert(dist == 256, "ct_init: 256+dist != 512");
1965
1966 /* Construct the codes of the static literal tree */
1967 /* already zeroed - it's in bss
Denis Vlasenkodb6a5c32007-01-07 19:45:51 +00001968 for (n = 0; n <= MAX_BITS; n++)
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001969 G2.bl_count[n] = 0; */
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001970
1971 n = 0;
1972 while (n <= 143) {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001973 G2.static_ltree[n++].Len = 8;
1974 G2.bl_count[8]++;
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001975 }
1976 while (n <= 255) {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001977 G2.static_ltree[n++].Len = 9;
1978 G2.bl_count[9]++;
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001979 }
1980 while (n <= 279) {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001981 G2.static_ltree[n++].Len = 7;
1982 G2.bl_count[7]++;
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001983 }
1984 while (n <= 287) {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001985 G2.static_ltree[n++].Len = 8;
1986 G2.bl_count[8]++;
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001987 }
1988 /* Codes 286 and 287 do not exist, but we must include them in the
1989 * tree construction to get a canonical Huffman tree (longest code
1990 * all ones)
1991 */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001992 gen_codes((ct_data *) G2.static_ltree, L_CODES + 1);
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001993
1994 /* The static distance tree is trivial: */
1995 for (n = 0; n < D_CODES; n++) {
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00001996 G2.static_dtree[n].Len = 5;
1997 G2.static_dtree[n].Code = bi_reverse(n, 5);
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00001998 }
1999
2000 /* Initialize the first block of the first file: */
2001 init_block();
2002}
2003
2004
2005/* ===========================================================================
Eric Andersencc8ed391999-10-05 16:24:54 +00002006 * Deflate in to out.
2007 * IN assertions: the input and output buffers are cleared.
Eric Andersencc8ed391999-10-05 16:24:54 +00002008 */
Denis Vlasenko3ae6f342007-01-07 19:44:57 +00002009
Denis Vlasenkofe42d172007-03-14 00:08:28 +00002010static void zip(ulg time_stamp)
Eric Andersencc8ed391999-10-05 16:24:54 +00002011{
Denis Vlasenkodb6a5c32007-01-07 19:45:51 +00002012 ush deflate_flags = 0; /* pkzip -es, -en or -ex equivalent */
Eric Andersencc8ed391999-10-05 16:24:54 +00002013
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00002014 G1.outcnt = 0;
Eric Andersencc8ed391999-10-05 16:24:54 +00002015
Erik Andersene49d5ec2000-02-08 19:58:47 +00002016 /* Write the header to the gzip file. See algorithm.doc for the format */
Denis Vlasenkoda799e82007-03-14 00:06:29 +00002017 /* magic header for gzip files: 1F 8B */
Denis Vlasenkofe42d172007-03-14 00:08:28 +00002018 /* compression method: 8 (DEFLATED) */
Denis Vlasenkoda799e82007-03-14 00:06:29 +00002019 /* general flags: 0 */
2020 put_32bit(0x00088b1f);
Denis Vlasenkofe42d172007-03-14 00:08:28 +00002021 put_32bit(time_stamp);
Eric Andersencc8ed391999-10-05 16:24:54 +00002022
Erik Andersene49d5ec2000-02-08 19:58:47 +00002023 /* Write deflated file to zip file */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00002024 G1.crc = ~0;
Eric Andersencc8ed391999-10-05 16:24:54 +00002025
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00002026 bi_init();
Denis Vlasenkofe42d172007-03-14 00:08:28 +00002027 ct_init();
Erik Andersene49d5ec2000-02-08 19:58:47 +00002028 lm_init(&deflate_flags);
Eric Andersencc8ed391999-10-05 16:24:54 +00002029
Denis Vlasenkoda31fbc2007-01-07 19:39:02 +00002030 put_8bit(deflate_flags); /* extra flags */
Denis Vlasenkoad403412007-01-07 19:37:42 +00002031 put_8bit(3); /* OS identifier = 3 (Unix) */
Eric Andersencc8ed391999-10-05 16:24:54 +00002032
Denis Vlasenkoed0f6db2007-01-07 19:38:26 +00002033 deflate();
Eric Andersencc8ed391999-10-05 16:24:54 +00002034
Erik Andersene49d5ec2000-02-08 19:58:47 +00002035 /* Write the crc and uncompressed size */
Denis Vlasenkoe930fe12007-03-14 00:06:10 +00002036 put_32bit(~G1.crc);
2037 put_32bit(G1.isize);
Eric Andersencc8ed391999-10-05 16:24:54 +00002038
Erik Andersene49d5ec2000-02-08 19:58:47 +00002039 flush_outbuf();
Eric Andersencc8ed391999-10-05 16:24:54 +00002040}
Denis Vlasenko52933d42007-01-07 19:40:13 +00002041
2042
2043/* ======================================================================== */
Denis Vlasenko75605782007-03-14 00:07:51 +00002044static
Tanguy Pruvot8a6c2c22012-04-28 00:24:09 +02002045IF_DESKTOP(long long) int FAST_FUNC pack_gzip(transformer_aux_data_t *aux UNUSED_PARAM)
Denis Vlasenko75605782007-03-14 00:07:51 +00002046{
2047 struct stat s;
Denis Vlasenkoc86e0522007-03-20 11:30:28 +00002048
Denys Vlasenko167cd702009-05-18 13:08:57 +02002049 /* Clear input and output buffers */
2050 G1.outcnt = 0;
2051#ifdef DEBUG
2052 G1.insize = 0;
2053#endif
2054 G1.isize = 0;
2055
2056 /* Reinit G2.xxx */
2057 memset(&G2, 0, sizeof(G2));
2058 G2.l_desc.dyn_tree = G2.dyn_ltree;
2059 G2.l_desc.static_tree = G2.static_ltree;
2060 G2.l_desc.extra_bits = extra_lbits;
2061 G2.l_desc.extra_base = LITERALS + 1;
2062 G2.l_desc.elems = L_CODES;
2063 G2.l_desc.max_length = MAX_BITS;
2064 //G2.l_desc.max_code = 0;
2065 G2.d_desc.dyn_tree = G2.dyn_dtree;
2066 G2.d_desc.static_tree = G2.static_dtree;
2067 G2.d_desc.extra_bits = extra_dbits;
2068 //G2.d_desc.extra_base = 0;
2069 G2.d_desc.elems = D_CODES;
2070 G2.d_desc.max_length = MAX_BITS;
2071 //G2.d_desc.max_code = 0;
2072 G2.bl_desc.dyn_tree = G2.bl_tree;
2073 //G2.bl_desc.static_tree = NULL;
2074 G2.bl_desc.extra_bits = extra_blbits,
2075 //G2.bl_desc.extra_base = 0;
2076 G2.bl_desc.elems = BL_CODES;
2077 G2.bl_desc.max_length = MAX_BL_BITS;
2078 //G2.bl_desc.max_code = 0;
2079
Denis Vlasenkofe42d172007-03-14 00:08:28 +00002080 s.st_ctime = 0;
2081 fstat(STDIN_FILENO, &s);
2082 zip(s.st_ctime);
Denis Vlasenko75605782007-03-14 00:07:51 +00002083 return 0;
2084}
2085
Matheus Izvekov839fd712010-01-06 08:54:49 +01002086#if ENABLE_FEATURE_GZIP_LONG_OPTIONS
2087static const char gzip_longopts[] ALIGN1 =
2088 "stdout\0" No_argument "c"
2089 "to-stdout\0" No_argument "c"
2090 "force\0" No_argument "f"
2091 "verbose\0" No_argument "v"
2092#if ENABLE_GUNZIP
2093 "decompress\0" No_argument "d"
2094 "uncompress\0" No_argument "d"
2095 "test\0" No_argument "t"
2096#endif
2097 "quiet\0" No_argument "q"
2098 "fast\0" No_argument "1"
2099 "best\0" No_argument "9"
2100 ;
2101#endif
2102
Denis Vlasenko52978092008-03-30 13:11:47 +00002103/*
Denys Vlasenko39a04f72010-05-31 14:18:57 +02002104 * Linux kernel build uses gzip -d -n. We accept and ignore -n.
Denis Vlasenko52978092008-03-30 13:11:47 +00002105 * Man page says:
2106 * -n --no-name
2107 * gzip: do not save the original file name and time stamp.
2108 * (The original name is always saved if the name had to be truncated.)
2109 * gunzip: do not restore the original file name/time even if present
2110 * (remove only the gzip suffix from the compressed file name).
2111 * This option is the default when decompressing.
2112 * -N --name
2113 * gzip: always save the original file name and time stamp (this is the default)
2114 * gunzip: restore the original file name and time stamp if present.
2115 */
2116
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +00002117int gzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko85c24712008-03-17 09:04:04 +00002118#if ENABLE_GUNZIP
Denis Vlasenko75605782007-03-14 00:07:51 +00002119int gzip_main(int argc, char **argv)
Denis Vlasenko85c24712008-03-17 09:04:04 +00002120#else
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00002121int gzip_main(int argc UNUSED_PARAM, char **argv)
Denis Vlasenko85c24712008-03-17 09:04:04 +00002122#endif
Denis Vlasenko75605782007-03-14 00:07:51 +00002123{
2124 unsigned opt;
2125
Matheus Izvekov839fd712010-01-06 08:54:49 +01002126#if ENABLE_FEATURE_GZIP_LONG_OPTIONS
2127 applet_long_options = gzip_longopts;
2128#endif
Denis Vlasenko75605782007-03-14 00:07:51 +00002129 /* Must match bbunzip's constants OPT_STDOUT, OPT_FORCE! */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00002130 opt = getopt32(argv, "cfv" IF_GUNZIP("dt") "q123456789n");
Denis Vlasenko77f1ec12007-10-13 03:36:03 +00002131#if ENABLE_GUNZIP /* gunzip_main may not be visible... */
Denis Vlasenko55da0be2008-06-27 21:52:41 +00002132 if (opt & 0x18) // -d and/or -t
Denis Vlasenko77f1ec12007-10-13 03:36:03 +00002133 return gunzip_main(argc, argv);
2134#endif
2135 option_mask32 &= 0x7; /* ignore -q, -0..9 */
Denis Vlasenko75605782007-03-14 00:07:51 +00002136 //if (opt & 0x1) // -c
2137 //if (opt & 0x2) // -f
2138 //if (opt & 0x4) // -v
Denis Vlasenkocbcff292007-03-22 18:56:23 +00002139 argv += optind;
Denis Vlasenko75605782007-03-14 00:07:51 +00002140
Denys Vlasenko90a99042009-09-06 02:36:23 +02002141 SET_PTR_TO_GLOBALS((char *)xzalloc(sizeof(struct globals)+sizeof(struct globals2))
Denis Vlasenko574f2f42008-02-27 18:41:59 +00002142 + sizeof(struct globals));
Denis Vlasenko75605782007-03-14 00:07:51 +00002143
2144 /* Allocate all global buffers (for DYN_ALLOC option) */
2145 ALLOC(uch, G1.l_buf, INBUFSIZ);
2146 ALLOC(uch, G1.outbuf, OUTBUFSIZ);
2147 ALLOC(ush, G1.d_buf, DIST_BUFSIZE);
2148 ALLOC(uch, G1.window, 2L * WSIZE);
2149 ALLOC(ush, G1.prev, 1L << BITS);
2150
Denys Vlasenko9ce642f2010-10-27 15:26:45 +02002151 /* Initialize the CRC32 table */
2152 global_crc32_table = crc32_filltable(NULL, 0);
Denis Vlasenko75605782007-03-14 00:07:51 +00002153
Denys Vlasenko39a04f72010-05-31 14:18:57 +02002154 return bbunpack(argv, pack_gzip, append_ext, "gz");
Denis Vlasenko75605782007-03-14 00:07:51 +00002155}