trees.c revision 42471
117651Speter/* trees.c -- output deflated data using Huffman coding 233908Ssteve * Copyright (C) 1995-1998 Jean-loup Gailly 317651Speter * For conditions of distribution and use, see copyright notice in zlib.h 417651Speter */ 517651Speter 617651Speter/* 717651Speter * ALGORITHM 817651Speter * 917651Speter * The "deflation" process uses several Huffman trees. The more 1017651Speter * common source values are represented by shorter bit sequences. 1117651Speter * 1217651Speter * Each code tree is stored in a compressed form which is itself 1317651Speter * a Huffman encoding of the lengths of all the code strings (in 1417651Speter * ascending order by source values). The actual code strings are 1517651Speter * reconstructed from the lengths in the inflate process, as described 1617651Speter * in the deflate specification. 1717651Speter * 1817651Speter * REFERENCES 1917651Speter * 2017651Speter * Deutsch, L.P.,"'Deflate' Compressed Data Format Specification". 2117651Speter * Available in ftp.uu.net:/pub/archiving/zip/doc/deflate-1.1.doc 2217651Speter * 2317651Speter * Storer, James A. 2417651Speter * Data Compression: Methods and Theory, pp. 49-50. 2517651Speter * Computer Science Press, 1988. ISBN 0-7167-8156-5. 2617651Speter * 2717651Speter * Sedgewick, R. 2817651Speter * Algorithms, p290. 2917651Speter * Addison-Wesley, 1983. ISBN 0-201-06672-6. 3017651Speter */ 3117651Speter 3242471Speter/* @(#) $Id: trees.c,v 1.1.1.3 1999/01/10 09:46:57 peter Exp $ */ 3317651Speter 3433908Ssteve/* #define GEN_TREES_H */ 3533908Ssteve 3617651Speter#include "deflate.h" 3717651Speter 3817651Speter#ifdef DEBUG 3917651Speter# include <ctype.h> 4017651Speter#endif 4117651Speter 4217651Speter/* =========================================================================== 4317651Speter * Constants 4417651Speter */ 4517651Speter 4617651Speter#define MAX_BL_BITS 7 4717651Speter/* Bit length codes must not exceed MAX_BL_BITS bits */ 4817651Speter 4917651Speter#define END_BLOCK 256 5017651Speter/* end of block literal code */ 5117651Speter 5217651Speter#define REP_3_6 16 5317651Speter/* repeat previous bit length 3-6 times (2 bits of repeat count) */ 5417651Speter 5517651Speter#define REPZ_3_10 17 5617651Speter/* repeat a zero length 3-10 times (3 bits of repeat count) */ 5717651Speter 5817651Speter#define REPZ_11_138 18 5917651Speter/* repeat a zero length 11-138 times (7 bits of repeat count) */ 6017651Speter 6133908Sstevelocal const int extra_lbits[LENGTH_CODES] /* extra bits for each length code */ 6217651Speter = {0,0,0,0,0,0,0,0,1,1,1,1,2,2,2,2,3,3,3,3,4,4,4,4,5,5,5,5,0}; 6317651Speter 6433908Sstevelocal const int extra_dbits[D_CODES] /* extra bits for each distance code */ 6517651Speter = {0,0,0,0,1,1,2,2,3,3,4,4,5,5,6,6,7,7,8,8,9,9,10,10,11,11,12,12,13,13}; 6617651Speter 6733908Sstevelocal const int extra_blbits[BL_CODES]/* extra bits for each bit length code */ 6817651Speter = {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,2,3,7}; 6917651Speter 7033908Sstevelocal const uch bl_order[BL_CODES] 7117651Speter = {16,17,18,0,8,7,9,6,10,5,11,4,12,3,13,2,14,1,15}; 7217651Speter/* The lengths of the bit length codes are sent in order of decreasing 7317651Speter * probability, to avoid transmitting the lengths for unused bit length codes. 7417651Speter */ 7517651Speter 7617651Speter#define Buf_size (8 * 2*sizeof(char)) 7717651Speter/* Number of bits used within bi_buf. (bi_buf might be implemented on 7817651Speter * more than 16 bits on some systems.) 7917651Speter */ 8017651Speter 8117651Speter/* =========================================================================== 8217651Speter * Local data. These are initialized only once. 8317651Speter */ 8417651Speter 8533908Ssteve#define DIST_CODE_LEN 512 /* see definition of array dist_code below */ 8633908Ssteve 8733908Ssteve#if defined(GEN_TREES_H) || !defined(STDC) 8833908Ssteve/* non ANSI compilers may not accept trees.h */ 8933908Ssteve 9017651Speterlocal ct_data static_ltree[L_CODES+2]; 9117651Speter/* The static literal tree. Since the bit lengths are imposed, there is no 9217651Speter * need for the L_CODES extra codes used during heap construction. However 9317651Speter * The codes 286 and 287 are needed to build a canonical tree (see _tr_init 9417651Speter * below). 9517651Speter */ 9617651Speter 9717651Speterlocal ct_data static_dtree[D_CODES]; 9817651Speter/* The static distance tree. (Actually a trivial tree since all codes use 9917651Speter * 5 bits.) 10017651Speter */ 10117651Speter 10233908Ssteveuch _dist_code[DIST_CODE_LEN]; 10333908Ssteve/* Distance codes. The first 256 values correspond to the distances 10417651Speter * 3 .. 258, the last 256 values correspond to the top 8 bits of 10517651Speter * the 15 bit distances. 10617651Speter */ 10717651Speter 10833908Ssteveuch _length_code[MAX_MATCH-MIN_MATCH+1]; 10917651Speter/* length code for each normalized match length (0 == MIN_MATCH) */ 11017651Speter 11117651Speterlocal int base_length[LENGTH_CODES]; 11217651Speter/* First normalized length for each code (0 = MIN_MATCH) */ 11317651Speter 11417651Speterlocal int base_dist[D_CODES]; 11517651Speter/* First normalized distance for each code (0 = distance of 1) */ 11617651Speter 11733908Ssteve#else 11833908Ssteve# include "trees.h" 11933908Ssteve#endif /* GEN_TREES_H */ 12033908Ssteve 12117651Speterstruct static_tree_desc_s { 12233908Ssteve const ct_data *static_tree; /* static tree or NULL */ 12333908Ssteve const intf *extra_bits; /* extra bits for each code or NULL */ 12417651Speter int extra_base; /* base index for extra_bits */ 12517651Speter int elems; /* max number of elements in the tree */ 12617651Speter int max_length; /* max bit length for the codes */ 12717651Speter}; 12817651Speter 12917651Speterlocal static_tree_desc static_l_desc = 13017651Speter{static_ltree, extra_lbits, LITERALS+1, L_CODES, MAX_BITS}; 13117651Speter 13217651Speterlocal static_tree_desc static_d_desc = 13317651Speter{static_dtree, extra_dbits, 0, D_CODES, MAX_BITS}; 13417651Speter 13517651Speterlocal static_tree_desc static_bl_desc = 13633908Ssteve{(const ct_data *)0, extra_blbits, 0, BL_CODES, MAX_BL_BITS}; 13717651Speter 13817651Speter/* =========================================================================== 13917651Speter * Local (static) routines in this file. 14017651Speter */ 14117651Speter 14217651Speterlocal void tr_static_init OF((void)); 14317651Speterlocal void init_block OF((deflate_state *s)); 14417651Speterlocal void pqdownheap OF((deflate_state *s, ct_data *tree, int k)); 14517651Speterlocal void gen_bitlen OF((deflate_state *s, tree_desc *desc)); 14617651Speterlocal void gen_codes OF((ct_data *tree, int max_code, ushf *bl_count)); 14717651Speterlocal void build_tree OF((deflate_state *s, tree_desc *desc)); 14817651Speterlocal void scan_tree OF((deflate_state *s, ct_data *tree, int max_code)); 14917651Speterlocal void send_tree OF((deflate_state *s, ct_data *tree, int max_code)); 15017651Speterlocal int build_bl_tree OF((deflate_state *s)); 15117651Speterlocal void send_all_trees OF((deflate_state *s, int lcodes, int dcodes, 15217651Speter int blcodes)); 15317651Speterlocal void compress_block OF((deflate_state *s, ct_data *ltree, 15417651Speter ct_data *dtree)); 15517651Speterlocal void set_data_type OF((deflate_state *s)); 15617651Speterlocal unsigned bi_reverse OF((unsigned value, int length)); 15717651Speterlocal void bi_windup OF((deflate_state *s)); 15817651Speterlocal void bi_flush OF((deflate_state *s)); 15917651Speterlocal void copy_block OF((deflate_state *s, charf *buf, unsigned len, 16017651Speter int header)); 16117651Speter 16233908Ssteve#ifdef GEN_TREES_H 16333908Sstevelocal void gen_trees_header OF((void)); 16433908Ssteve#endif 16533908Ssteve 16617651Speter#ifndef DEBUG 16717651Speter# define send_code(s, c, tree) send_bits(s, tree[c].Code, tree[c].Len) 16817651Speter /* Send a code of the given tree. c and tree must not have side effects */ 16917651Speter 17017651Speter#else /* DEBUG */ 17117651Speter# define send_code(s, c, tree) \ 17233908Ssteve { if (z_verbose>2) fprintf(stderr,"\ncd %3d ",(c)); \ 17317651Speter send_bits(s, tree[c].Code, tree[c].Len); } 17417651Speter#endif 17517651Speter 17617651Speter/* =========================================================================== 17717651Speter * Output a short LSB first on the stream. 17817651Speter * IN assertion: there is enough room in pendingBuf. 17917651Speter */ 18017651Speter#define put_short(s, w) { \ 18117651Speter put_byte(s, (uch)((w) & 0xff)); \ 18217651Speter put_byte(s, (uch)((ush)(w) >> 8)); \ 18317651Speter} 18417651Speter 18517651Speter/* =========================================================================== 18617651Speter * Send a value on a given number of bits. 18717651Speter * IN assertion: length <= 16 and value fits in length bits. 18817651Speter */ 18917651Speter#ifdef DEBUG 19017651Speterlocal void send_bits OF((deflate_state *s, int value, int length)); 19117651Speter 19217651Speterlocal void send_bits(s, value, length) 19317651Speter deflate_state *s; 19417651Speter int value; /* value to send */ 19517651Speter int length; /* number of bits */ 19617651Speter{ 19717651Speter Tracevv((stderr," l %2d v %4x ", length, value)); 19817651Speter Assert(length > 0 && length <= 15, "invalid length"); 19917651Speter s->bits_sent += (ulg)length; 20017651Speter 20117651Speter /* If not enough room in bi_buf, use (valid) bits from bi_buf and 20217651Speter * (16 - bi_valid) bits from value, leaving (width - (16-bi_valid)) 20317651Speter * unused bits in value. 20417651Speter */ 20517651Speter if (s->bi_valid > (int)Buf_size - length) { 20617651Speter s->bi_buf |= (value << s->bi_valid); 20717651Speter put_short(s, s->bi_buf); 20817651Speter s->bi_buf = (ush)value >> (Buf_size - s->bi_valid); 20917651Speter s->bi_valid += length - Buf_size; 21017651Speter } else { 21117651Speter s->bi_buf |= value << s->bi_valid; 21217651Speter s->bi_valid += length; 21317651Speter } 21417651Speter} 21517651Speter#else /* !DEBUG */ 21617651Speter 21717651Speter#define send_bits(s, value, length) \ 21817651Speter{ int len = length;\ 21917651Speter if (s->bi_valid > (int)Buf_size - len) {\ 22017651Speter int val = value;\ 22117651Speter s->bi_buf |= (val << s->bi_valid);\ 22217651Speter put_short(s, s->bi_buf);\ 22317651Speter s->bi_buf = (ush)val >> (Buf_size - s->bi_valid);\ 22417651Speter s->bi_valid += len - Buf_size;\ 22517651Speter } else {\ 22617651Speter s->bi_buf |= (value) << s->bi_valid;\ 22717651Speter s->bi_valid += len;\ 22817651Speter }\ 22917651Speter} 23017651Speter#endif /* DEBUG */ 23117651Speter 23217651Speter 23317651Speter#define MAX(a,b) (a >= b ? a : b) 23417651Speter/* the arguments must not have side effects */ 23517651Speter 23617651Speter/* =========================================================================== 23733908Ssteve * Initialize the various 'constant' tables. 23817651Speter */ 23917651Speterlocal void tr_static_init() 24017651Speter{ 24133908Ssteve#if defined(GEN_TREES_H) || !defined(STDC) 24217651Speter static int static_init_done = 0; 24317651Speter int n; /* iterates over tree elements */ 24417651Speter int bits; /* bit counter */ 24517651Speter int length; /* length value */ 24617651Speter int code; /* code value */ 24717651Speter int dist; /* distance index */ 24817651Speter ush bl_count[MAX_BITS+1]; 24917651Speter /* number of codes at each bit length for an optimal tree */ 25017651Speter 25117651Speter if (static_init_done) return; 25217651Speter 25342471Speter /* For some embedded targets, global variables are not initialized: */ 25442471Speter static_l_desc.static_tree = static_ltree; 25542471Speter static_l_desc.extra_bits = extra_lbits; 25642471Speter static_d_desc.static_tree = static_dtree; 25742471Speter static_d_desc.extra_bits = extra_dbits; 25842471Speter static_bl_desc.extra_bits = extra_blbits; 25942471Speter 26017651Speter /* Initialize the mapping length (0..255) -> length code (0..28) */ 26117651Speter length = 0; 26217651Speter for (code = 0; code < LENGTH_CODES-1; code++) { 26317651Speter base_length[code] = length; 26417651Speter for (n = 0; n < (1<<extra_lbits[code]); n++) { 26533908Ssteve _length_code[length++] = (uch)code; 26617651Speter } 26717651Speter } 26817651Speter Assert (length == 256, "tr_static_init: length != 256"); 26917651Speter /* Note that the length 255 (match length 258) can be represented 27017651Speter * in two different ways: code 284 + 5 bits or code 285, so we 27117651Speter * overwrite length_code[255] to use the best encoding: 27217651Speter */ 27333908Ssteve _length_code[length-1] = (uch)code; 27417651Speter 27517651Speter /* Initialize the mapping dist (0..32K) -> dist code (0..29) */ 27617651Speter dist = 0; 27717651Speter for (code = 0 ; code < 16; code++) { 27817651Speter base_dist[code] = dist; 27917651Speter for (n = 0; n < (1<<extra_dbits[code]); n++) { 28033908Ssteve _dist_code[dist++] = (uch)code; 28117651Speter } 28217651Speter } 28317651Speter Assert (dist == 256, "tr_static_init: dist != 256"); 28417651Speter dist >>= 7; /* from now on, all distances are divided by 128 */ 28517651Speter for ( ; code < D_CODES; code++) { 28617651Speter base_dist[code] = dist << 7; 28717651Speter for (n = 0; n < (1<<(extra_dbits[code]-7)); n++) { 28833908Ssteve _dist_code[256 + dist++] = (uch)code; 28917651Speter } 29017651Speter } 29117651Speter Assert (dist == 256, "tr_static_init: 256+dist != 512"); 29217651Speter 29317651Speter /* Construct the codes of the static literal tree */ 29417651Speter for (bits = 0; bits <= MAX_BITS; bits++) bl_count[bits] = 0; 29517651Speter n = 0; 29617651Speter while (n <= 143) static_ltree[n++].Len = 8, bl_count[8]++; 29717651Speter while (n <= 255) static_ltree[n++].Len = 9, bl_count[9]++; 29817651Speter while (n <= 279) static_ltree[n++].Len = 7, bl_count[7]++; 29917651Speter while (n <= 287) static_ltree[n++].Len = 8, bl_count[8]++; 30017651Speter /* Codes 286 and 287 do not exist, but we must include them in the 30117651Speter * tree construction to get a canonical Huffman tree (longest code 30217651Speter * all ones) 30317651Speter */ 30417651Speter gen_codes((ct_data *)static_ltree, L_CODES+1, bl_count); 30517651Speter 30617651Speter /* The static distance tree is trivial: */ 30717651Speter for (n = 0; n < D_CODES; n++) { 30817651Speter static_dtree[n].Len = 5; 30917651Speter static_dtree[n].Code = bi_reverse((unsigned)n, 5); 31017651Speter } 31117651Speter static_init_done = 1; 31233908Ssteve 31333908Ssteve# ifdef GEN_TREES_H 31433908Ssteve gen_trees_header(); 31533908Ssteve# endif 31633908Ssteve#endif /* defined(GEN_TREES_H) || !defined(STDC) */ 31717651Speter} 31817651Speter 31917651Speter/* =========================================================================== 32033908Ssteve * Genererate the file trees.h describing the static trees. 32133908Ssteve */ 32233908Ssteve#ifdef GEN_TREES_H 32333908Ssteve# ifndef DEBUG 32433908Ssteve# include <stdio.h> 32533908Ssteve# endif 32633908Ssteve 32733908Ssteve# define SEPARATOR(i, last, width) \ 32833908Ssteve ((i) == (last)? "\n};\n\n" : \ 32933908Ssteve ((i) % (width) == (width)-1 ? ",\n" : ", ")) 33033908Ssteve 33133908Sstevevoid gen_trees_header() 33233908Ssteve{ 33333908Ssteve FILE *header = fopen("trees.h", "w"); 33433908Ssteve int i; 33533908Ssteve 33633908Ssteve Assert (header != NULL, "Can't open trees.h"); 33733908Ssteve fprintf(header, 33833908Ssteve "/* header created automatically with -DGEN_TREES_H */\n\n"); 33933908Ssteve 34033908Ssteve fprintf(header, "local const ct_data static_ltree[L_CODES+2] = {\n"); 34133908Ssteve for (i = 0; i < L_CODES+2; i++) { 34233908Ssteve fprintf(header, "{{%3u},{%3u}}%s", static_ltree[i].Code, 34333908Ssteve static_ltree[i].Len, SEPARATOR(i, L_CODES+1, 5)); 34433908Ssteve } 34533908Ssteve 34633908Ssteve fprintf(header, "local const ct_data static_dtree[D_CODES] = {\n"); 34733908Ssteve for (i = 0; i < D_CODES; i++) { 34833908Ssteve fprintf(header, "{{%2u},{%2u}}%s", static_dtree[i].Code, 34933908Ssteve static_dtree[i].Len, SEPARATOR(i, D_CODES-1, 5)); 35033908Ssteve } 35133908Ssteve 35233908Ssteve fprintf(header, "const uch _dist_code[DIST_CODE_LEN] = {\n"); 35333908Ssteve for (i = 0; i < DIST_CODE_LEN; i++) { 35433908Ssteve fprintf(header, "%2u%s", _dist_code[i], 35533908Ssteve SEPARATOR(i, DIST_CODE_LEN-1, 20)); 35633908Ssteve } 35733908Ssteve 35833908Ssteve fprintf(header, "const uch _length_code[MAX_MATCH-MIN_MATCH+1]= {\n"); 35933908Ssteve for (i = 0; i < MAX_MATCH-MIN_MATCH+1; i++) { 36033908Ssteve fprintf(header, "%2u%s", _length_code[i], 36133908Ssteve SEPARATOR(i, MAX_MATCH-MIN_MATCH, 20)); 36233908Ssteve } 36333908Ssteve 36433908Ssteve fprintf(header, "local const int base_length[LENGTH_CODES] = {\n"); 36533908Ssteve for (i = 0; i < LENGTH_CODES; i++) { 36633908Ssteve fprintf(header, "%1u%s", base_length[i], 36733908Ssteve SEPARATOR(i, LENGTH_CODES-1, 20)); 36833908Ssteve } 36933908Ssteve 37033908Ssteve fprintf(header, "local const int base_dist[D_CODES] = {\n"); 37133908Ssteve for (i = 0; i < D_CODES; i++) { 37233908Ssteve fprintf(header, "%5u%s", base_dist[i], 37333908Ssteve SEPARATOR(i, D_CODES-1, 10)); 37433908Ssteve } 37533908Ssteve 37633908Ssteve fclose(header); 37733908Ssteve} 37833908Ssteve#endif /* GEN_TREES_H */ 37933908Ssteve 38033908Ssteve/* =========================================================================== 38117651Speter * Initialize the tree data structures for a new zlib stream. 38217651Speter */ 38317651Spetervoid _tr_init(s) 38417651Speter deflate_state *s; 38517651Speter{ 38617651Speter tr_static_init(); 38717651Speter 38817651Speter s->l_desc.dyn_tree = s->dyn_ltree; 38917651Speter s->l_desc.stat_desc = &static_l_desc; 39017651Speter 39117651Speter s->d_desc.dyn_tree = s->dyn_dtree; 39217651Speter s->d_desc.stat_desc = &static_d_desc; 39317651Speter 39417651Speter s->bl_desc.dyn_tree = s->bl_tree; 39517651Speter s->bl_desc.stat_desc = &static_bl_desc; 39617651Speter 39717651Speter s->bi_buf = 0; 39817651Speter s->bi_valid = 0; 39917651Speter s->last_eob_len = 8; /* enough lookahead for inflate */ 40017651Speter#ifdef DEBUG 40142471Speter s->compressed_len = 0L; 40217651Speter s->bits_sent = 0L; 40317651Speter#endif 40417651Speter 40517651Speter /* Initialize the first block of the first file: */ 40617651Speter init_block(s); 40717651Speter} 40817651Speter 40917651Speter/* =========================================================================== 41017651Speter * Initialize a new block. 41117651Speter */ 41217651Speterlocal void init_block(s) 41317651Speter deflate_state *s; 41417651Speter{ 41517651Speter int n; /* iterates over tree elements */ 41617651Speter 41717651Speter /* Initialize the trees. */ 41817651Speter for (n = 0; n < L_CODES; n++) s->dyn_ltree[n].Freq = 0; 41917651Speter for (n = 0; n < D_CODES; n++) s->dyn_dtree[n].Freq = 0; 42017651Speter for (n = 0; n < BL_CODES; n++) s->bl_tree[n].Freq = 0; 42117651Speter 42217651Speter s->dyn_ltree[END_BLOCK].Freq = 1; 42317651Speter s->opt_len = s->static_len = 0L; 42417651Speter s->last_lit = s->matches = 0; 42517651Speter} 42617651Speter 42717651Speter#define SMALLEST 1 42817651Speter/* Index within the heap array of least frequent node in the Huffman tree */ 42917651Speter 43017651Speter 43117651Speter/* =========================================================================== 43217651Speter * Remove the smallest element from the heap and recreate the heap with 43317651Speter * one less element. Updates heap and heap_len. 43417651Speter */ 43517651Speter#define pqremove(s, tree, top) \ 43617651Speter{\ 43717651Speter top = s->heap[SMALLEST]; \ 43817651Speter s->heap[SMALLEST] = s->heap[s->heap_len--]; \ 43917651Speter pqdownheap(s, tree, SMALLEST); \ 44017651Speter} 44117651Speter 44217651Speter/* =========================================================================== 44317651Speter * Compares to subtrees, using the tree depth as tie breaker when 44417651Speter * the subtrees have equal frequency. This minimizes the worst case length. 44517651Speter */ 44617651Speter#define smaller(tree, n, m, depth) \ 44717651Speter (tree[n].Freq < tree[m].Freq || \ 44817651Speter (tree[n].Freq == tree[m].Freq && depth[n] <= depth[m])) 44917651Speter 45017651Speter/* =========================================================================== 45117651Speter * Restore the heap property by moving down the tree starting at node k, 45217651Speter * exchanging a node with the smallest of its two sons if necessary, stopping 45317651Speter * when the heap property is re-established (each father smaller than its 45417651Speter * two sons). 45517651Speter */ 45617651Speterlocal void pqdownheap(s, tree, k) 45717651Speter deflate_state *s; 45817651Speter ct_data *tree; /* the tree to restore */ 45917651Speter int k; /* node to move down */ 46017651Speter{ 46117651Speter int v = s->heap[k]; 46217651Speter int j = k << 1; /* left son of k */ 46317651Speter while (j <= s->heap_len) { 46417651Speter /* Set j to the smallest of the two sons: */ 46517651Speter if (j < s->heap_len && 46617651Speter smaller(tree, s->heap[j+1], s->heap[j], s->depth)) { 46717651Speter j++; 46817651Speter } 46917651Speter /* Exit if v is smaller than both sons */ 47017651Speter if (smaller(tree, v, s->heap[j], s->depth)) break; 47117651Speter 47217651Speter /* Exchange v with the smallest son */ 47317651Speter s->heap[k] = s->heap[j]; k = j; 47417651Speter 47517651Speter /* And continue down the tree, setting j to the left son of k */ 47617651Speter j <<= 1; 47717651Speter } 47817651Speter s->heap[k] = v; 47917651Speter} 48017651Speter 48117651Speter/* =========================================================================== 48217651Speter * Compute the optimal bit lengths for a tree and update the total bit length 48317651Speter * for the current block. 48417651Speter * IN assertion: the fields freq and dad are set, heap[heap_max] and 48517651Speter * above are the tree nodes sorted by increasing frequency. 48617651Speter * OUT assertions: the field len is set to the optimal bit length, the 48717651Speter * array bl_count contains the frequencies for each bit length. 48817651Speter * The length opt_len is updated; static_len is also updated if stree is 48917651Speter * not null. 49017651Speter */ 49117651Speterlocal void gen_bitlen(s, desc) 49217651Speter deflate_state *s; 49317651Speter tree_desc *desc; /* the tree descriptor */ 49417651Speter{ 49533908Ssteve ct_data *tree = desc->dyn_tree; 49633908Ssteve int max_code = desc->max_code; 49733908Ssteve const ct_data *stree = desc->stat_desc->static_tree; 49833908Ssteve const intf *extra = desc->stat_desc->extra_bits; 49933908Ssteve int base = desc->stat_desc->extra_base; 50033908Ssteve int max_length = desc->stat_desc->max_length; 50117651Speter int h; /* heap index */ 50217651Speter int n, m; /* iterate over the tree elements */ 50317651Speter int bits; /* bit length */ 50417651Speter int xbits; /* extra bits */ 50517651Speter ush f; /* frequency */ 50617651Speter int overflow = 0; /* number of elements with bit length too large */ 50717651Speter 50817651Speter for (bits = 0; bits <= MAX_BITS; bits++) s->bl_count[bits] = 0; 50917651Speter 51017651Speter /* In a first pass, compute the optimal bit lengths (which may 51117651Speter * overflow in the case of the bit length tree). 51217651Speter */ 51317651Speter tree[s->heap[s->heap_max]].Len = 0; /* root of the heap */ 51417651Speter 51517651Speter for (h = s->heap_max+1; h < HEAP_SIZE; h++) { 51617651Speter n = s->heap[h]; 51717651Speter bits = tree[tree[n].Dad].Len + 1; 51817651Speter if (bits > max_length) bits = max_length, overflow++; 51917651Speter tree[n].Len = (ush)bits; 52017651Speter /* We overwrite tree[n].Dad which is no longer needed */ 52117651Speter 52217651Speter if (n > max_code) continue; /* not a leaf node */ 52317651Speter 52417651Speter s->bl_count[bits]++; 52517651Speter xbits = 0; 52617651Speter if (n >= base) xbits = extra[n-base]; 52717651Speter f = tree[n].Freq; 52817651Speter s->opt_len += (ulg)f * (bits + xbits); 52917651Speter if (stree) s->static_len += (ulg)f * (stree[n].Len + xbits); 53017651Speter } 53117651Speter if (overflow == 0) return; 53217651Speter 53317651Speter Trace((stderr,"\nbit length overflow\n")); 53417651Speter /* This happens for example on obj2 and pic of the Calgary corpus */ 53517651Speter 53617651Speter /* Find the first bit length which could increase: */ 53717651Speter do { 53817651Speter bits = max_length-1; 53917651Speter while (s->bl_count[bits] == 0) bits--; 54017651Speter s->bl_count[bits]--; /* move one leaf down the tree */ 54117651Speter s->bl_count[bits+1] += 2; /* move one overflow item as its brother */ 54217651Speter s->bl_count[max_length]--; 54317651Speter /* The brother of the overflow item also moves one step up, 54417651Speter * but this does not affect bl_count[max_length] 54517651Speter */ 54617651Speter overflow -= 2; 54717651Speter } while (overflow > 0); 54817651Speter 54917651Speter /* Now recompute all bit lengths, scanning in increasing frequency. 55017651Speter * h is still equal to HEAP_SIZE. (It is simpler to reconstruct all 55117651Speter * lengths instead of fixing only the wrong ones. This idea is taken 55217651Speter * from 'ar' written by Haruhiko Okumura.) 55317651Speter */ 55417651Speter for (bits = max_length; bits != 0; bits--) { 55517651Speter n = s->bl_count[bits]; 55617651Speter while (n != 0) { 55717651Speter m = s->heap[--h]; 55817651Speter if (m > max_code) continue; 55917651Speter if (tree[m].Len != (unsigned) bits) { 56017651Speter Trace((stderr,"code %d bits %d->%d\n", m, tree[m].Len, bits)); 56117651Speter s->opt_len += ((long)bits - (long)tree[m].Len) 56217651Speter *(long)tree[m].Freq; 56317651Speter tree[m].Len = (ush)bits; 56417651Speter } 56517651Speter n--; 56617651Speter } 56717651Speter } 56817651Speter} 56917651Speter 57017651Speter/* =========================================================================== 57117651Speter * Generate the codes for a given tree and bit counts (which need not be 57217651Speter * optimal). 57317651Speter * IN assertion: the array bl_count contains the bit length statistics for 57417651Speter * the given tree and the field len is set for all tree elements. 57517651Speter * OUT assertion: the field code is set for all tree elements of non 57617651Speter * zero code length. 57717651Speter */ 57817651Speterlocal void gen_codes (tree, max_code, bl_count) 57917651Speter ct_data *tree; /* the tree to decorate */ 58017651Speter int max_code; /* largest code with non zero frequency */ 58117651Speter ushf *bl_count; /* number of codes at each bit length */ 58217651Speter{ 58317651Speter ush next_code[MAX_BITS+1]; /* next code value for each bit length */ 58417651Speter ush code = 0; /* running code value */ 58517651Speter int bits; /* bit index */ 58617651Speter int n; /* code index */ 58717651Speter 58817651Speter /* The distribution counts are first used to generate the code values 58917651Speter * without bit reversal. 59017651Speter */ 59117651Speter for (bits = 1; bits <= MAX_BITS; bits++) { 59217651Speter next_code[bits] = code = (code + bl_count[bits-1]) << 1; 59317651Speter } 59417651Speter /* Check that the bit counts in bl_count are consistent. The last code 59517651Speter * must be all ones. 59617651Speter */ 59717651Speter Assert (code + bl_count[MAX_BITS]-1 == (1<<MAX_BITS)-1, 59817651Speter "inconsistent bit counts"); 59917651Speter Tracev((stderr,"\ngen_codes: max_code %d ", max_code)); 60017651Speter 60117651Speter for (n = 0; n <= max_code; n++) { 60217651Speter int len = tree[n].Len; 60317651Speter if (len == 0) continue; 60417651Speter /* Now reverse the bits */ 60517651Speter tree[n].Code = bi_reverse(next_code[len]++, len); 60617651Speter 60717651Speter Tracecv(tree != static_ltree, (stderr,"\nn %3d %c l %2d c %4x (%x) ", 60817651Speter n, (isgraph(n) ? n : ' '), len, tree[n].Code, next_code[len]-1)); 60917651Speter } 61017651Speter} 61117651Speter 61217651Speter/* =========================================================================== 61317651Speter * Construct one Huffman tree and assigns the code bit strings and lengths. 61417651Speter * Update the total bit length for the current block. 61517651Speter * IN assertion: the field freq is set for all tree elements. 61617651Speter * OUT assertions: the fields len and code are set to the optimal bit length 61717651Speter * and corresponding code. The length opt_len is updated; static_len is 61817651Speter * also updated if stree is not null. The field max_code is set. 61917651Speter */ 62017651Speterlocal void build_tree(s, desc) 62117651Speter deflate_state *s; 62217651Speter tree_desc *desc; /* the tree descriptor */ 62317651Speter{ 62433908Ssteve ct_data *tree = desc->dyn_tree; 62533908Ssteve const ct_data *stree = desc->stat_desc->static_tree; 62633908Ssteve int elems = desc->stat_desc->elems; 62717651Speter int n, m; /* iterate over heap elements */ 62817651Speter int max_code = -1; /* largest code with non zero frequency */ 62917651Speter int node; /* new node being created */ 63017651Speter 63117651Speter /* Construct the initial heap, with least frequent element in 63217651Speter * heap[SMALLEST]. The sons of heap[n] are heap[2*n] and heap[2*n+1]. 63317651Speter * heap[0] is not used. 63417651Speter */ 63517651Speter s->heap_len = 0, s->heap_max = HEAP_SIZE; 63617651Speter 63717651Speter for (n = 0; n < elems; n++) { 63817651Speter if (tree[n].Freq != 0) { 63917651Speter s->heap[++(s->heap_len)] = max_code = n; 64017651Speter s->depth[n] = 0; 64117651Speter } else { 64217651Speter tree[n].Len = 0; 64317651Speter } 64417651Speter } 64517651Speter 64617651Speter /* The pkzip format requires that at least one distance code exists, 64717651Speter * and that at least one bit should be sent even if there is only one 64817651Speter * possible code. So to avoid special checks later on we force at least 64917651Speter * two codes of non zero frequency. 65017651Speter */ 65117651Speter while (s->heap_len < 2) { 65217651Speter node = s->heap[++(s->heap_len)] = (max_code < 2 ? ++max_code : 0); 65317651Speter tree[node].Freq = 1; 65417651Speter s->depth[node] = 0; 65517651Speter s->opt_len--; if (stree) s->static_len -= stree[node].Len; 65617651Speter /* node is 0 or 1 so it does not have extra bits */ 65717651Speter } 65817651Speter desc->max_code = max_code; 65917651Speter 66017651Speter /* The elements heap[heap_len/2+1 .. heap_len] are leaves of the tree, 66117651Speter * establish sub-heaps of increasing lengths: 66217651Speter */ 66317651Speter for (n = s->heap_len/2; n >= 1; n--) pqdownheap(s, tree, n); 66417651Speter 66517651Speter /* Construct the Huffman tree by repeatedly combining the least two 66617651Speter * frequent nodes. 66717651Speter */ 66817651Speter node = elems; /* next internal node of the tree */ 66917651Speter do { 67017651Speter pqremove(s, tree, n); /* n = node of least frequency */ 67117651Speter m = s->heap[SMALLEST]; /* m = node of next least frequency */ 67217651Speter 67317651Speter s->heap[--(s->heap_max)] = n; /* keep the nodes sorted by frequency */ 67417651Speter s->heap[--(s->heap_max)] = m; 67517651Speter 67617651Speter /* Create a new node father of n and m */ 67717651Speter tree[node].Freq = tree[n].Freq + tree[m].Freq; 67817651Speter s->depth[node] = (uch) (MAX(s->depth[n], s->depth[m]) + 1); 67917651Speter tree[n].Dad = tree[m].Dad = (ush)node; 68017651Speter#ifdef DUMP_BL_TREE 68117651Speter if (tree == s->bl_tree) { 68217651Speter fprintf(stderr,"\nnode %d(%d), sons %d(%d) %d(%d)", 68317651Speter node, tree[node].Freq, n, tree[n].Freq, m, tree[m].Freq); 68417651Speter } 68517651Speter#endif 68617651Speter /* and insert the new node in the heap */ 68717651Speter s->heap[SMALLEST] = node++; 68817651Speter pqdownheap(s, tree, SMALLEST); 68917651Speter 69017651Speter } while (s->heap_len >= 2); 69117651Speter 69217651Speter s->heap[--(s->heap_max)] = s->heap[SMALLEST]; 69317651Speter 69417651Speter /* At this point, the fields freq and dad are set. We can now 69517651Speter * generate the bit lengths. 69617651Speter */ 69717651Speter gen_bitlen(s, (tree_desc *)desc); 69817651Speter 69917651Speter /* The field len is now set, we can generate the bit codes */ 70017651Speter gen_codes ((ct_data *)tree, max_code, s->bl_count); 70117651Speter} 70217651Speter 70317651Speter/* =========================================================================== 70417651Speter * Scan a literal or distance tree to determine the frequencies of the codes 70517651Speter * in the bit length tree. 70617651Speter */ 70717651Speterlocal void scan_tree (s, tree, max_code) 70817651Speter deflate_state *s; 70917651Speter ct_data *tree; /* the tree to be scanned */ 71017651Speter int max_code; /* and its largest code of non zero frequency */ 71117651Speter{ 71217651Speter int n; /* iterates over all tree elements */ 71317651Speter int prevlen = -1; /* last emitted length */ 71417651Speter int curlen; /* length of current code */ 71517651Speter int nextlen = tree[0].Len; /* length of next code */ 71617651Speter int count = 0; /* repeat count of the current code */ 71717651Speter int max_count = 7; /* max repeat count */ 71817651Speter int min_count = 4; /* min repeat count */ 71917651Speter 72017651Speter if (nextlen == 0) max_count = 138, min_count = 3; 72117651Speter tree[max_code+1].Len = (ush)0xffff; /* guard */ 72217651Speter 72317651Speter for (n = 0; n <= max_code; n++) { 72417651Speter curlen = nextlen; nextlen = tree[n+1].Len; 72517651Speter if (++count < max_count && curlen == nextlen) { 72617651Speter continue; 72717651Speter } else if (count < min_count) { 72817651Speter s->bl_tree[curlen].Freq += count; 72917651Speter } else if (curlen != 0) { 73017651Speter if (curlen != prevlen) s->bl_tree[curlen].Freq++; 73117651Speter s->bl_tree[REP_3_6].Freq++; 73217651Speter } else if (count <= 10) { 73317651Speter s->bl_tree[REPZ_3_10].Freq++; 73417651Speter } else { 73517651Speter s->bl_tree[REPZ_11_138].Freq++; 73617651Speter } 73717651Speter count = 0; prevlen = curlen; 73817651Speter if (nextlen == 0) { 73917651Speter max_count = 138, min_count = 3; 74017651Speter } else if (curlen == nextlen) { 74117651Speter max_count = 6, min_count = 3; 74217651Speter } else { 74317651Speter max_count = 7, min_count = 4; 74417651Speter } 74517651Speter } 74617651Speter} 74717651Speter 74817651Speter/* =========================================================================== 74917651Speter * Send a literal or distance tree in compressed form, using the codes in 75017651Speter * bl_tree. 75117651Speter */ 75217651Speterlocal void send_tree (s, tree, max_code) 75317651Speter deflate_state *s; 75417651Speter ct_data *tree; /* the tree to be scanned */ 75517651Speter int max_code; /* and its largest code of non zero frequency */ 75617651Speter{ 75717651Speter int n; /* iterates over all tree elements */ 75817651Speter int prevlen = -1; /* last emitted length */ 75917651Speter int curlen; /* length of current code */ 76017651Speter int nextlen = tree[0].Len; /* length of next code */ 76117651Speter int count = 0; /* repeat count of the current code */ 76217651Speter int max_count = 7; /* max repeat count */ 76317651Speter int min_count = 4; /* min repeat count */ 76417651Speter 76517651Speter /* tree[max_code+1].Len = -1; */ /* guard already set */ 76617651Speter if (nextlen == 0) max_count = 138, min_count = 3; 76717651Speter 76817651Speter for (n = 0; n <= max_code; n++) { 76917651Speter curlen = nextlen; nextlen = tree[n+1].Len; 77017651Speter if (++count < max_count && curlen == nextlen) { 77117651Speter continue; 77217651Speter } else if (count < min_count) { 77317651Speter do { send_code(s, curlen, s->bl_tree); } while (--count != 0); 77417651Speter 77517651Speter } else if (curlen != 0) { 77617651Speter if (curlen != prevlen) { 77717651Speter send_code(s, curlen, s->bl_tree); count--; 77817651Speter } 77917651Speter Assert(count >= 3 && count <= 6, " 3_6?"); 78017651Speter send_code(s, REP_3_6, s->bl_tree); send_bits(s, count-3, 2); 78117651Speter 78217651Speter } else if (count <= 10) { 78317651Speter send_code(s, REPZ_3_10, s->bl_tree); send_bits(s, count-3, 3); 78417651Speter 78517651Speter } else { 78617651Speter send_code(s, REPZ_11_138, s->bl_tree); send_bits(s, count-11, 7); 78717651Speter } 78817651Speter count = 0; prevlen = curlen; 78917651Speter if (nextlen == 0) { 79017651Speter max_count = 138, min_count = 3; 79117651Speter } else if (curlen == nextlen) { 79217651Speter max_count = 6, min_count = 3; 79317651Speter } else { 79417651Speter max_count = 7, min_count = 4; 79517651Speter } 79617651Speter } 79717651Speter} 79817651Speter 79917651Speter/* =========================================================================== 80017651Speter * Construct the Huffman tree for the bit lengths and return the index in 80117651Speter * bl_order of the last bit length code to send. 80217651Speter */ 80317651Speterlocal int build_bl_tree(s) 80417651Speter deflate_state *s; 80517651Speter{ 80617651Speter int max_blindex; /* index of last bit length code of non zero freq */ 80717651Speter 80817651Speter /* Determine the bit length frequencies for literal and distance trees */ 80917651Speter scan_tree(s, (ct_data *)s->dyn_ltree, s->l_desc.max_code); 81017651Speter scan_tree(s, (ct_data *)s->dyn_dtree, s->d_desc.max_code); 81117651Speter 81217651Speter /* Build the bit length tree: */ 81317651Speter build_tree(s, (tree_desc *)(&(s->bl_desc))); 81417651Speter /* opt_len now includes the length of the tree representations, except 81517651Speter * the lengths of the bit lengths codes and the 5+5+4 bits for the counts. 81617651Speter */ 81717651Speter 81817651Speter /* Determine the number of bit length codes to send. The pkzip format 81917651Speter * requires that at least 4 bit length codes be sent. (appnote.txt says 82017651Speter * 3 but the actual value used is 4.) 82117651Speter */ 82217651Speter for (max_blindex = BL_CODES-1; max_blindex >= 3; max_blindex--) { 82317651Speter if (s->bl_tree[bl_order[max_blindex]].Len != 0) break; 82417651Speter } 82517651Speter /* Update opt_len to include the bit length tree and counts */ 82617651Speter s->opt_len += 3*(max_blindex+1) + 5+5+4; 82717651Speter Tracev((stderr, "\ndyn trees: dyn %ld, stat %ld", 82817651Speter s->opt_len, s->static_len)); 82917651Speter 83017651Speter return max_blindex; 83117651Speter} 83217651Speter 83317651Speter/* =========================================================================== 83417651Speter * Send the header for a block using dynamic Huffman trees: the counts, the 83517651Speter * lengths of the bit length codes, the literal tree and the distance tree. 83617651Speter * IN assertion: lcodes >= 257, dcodes >= 1, blcodes >= 4. 83717651Speter */ 83817651Speterlocal void send_all_trees(s, lcodes, dcodes, blcodes) 83917651Speter deflate_state *s; 84017651Speter int lcodes, dcodes, blcodes; /* number of codes for each tree */ 84117651Speter{ 84217651Speter int rank; /* index in bl_order */ 84317651Speter 84417651Speter Assert (lcodes >= 257 && dcodes >= 1 && blcodes >= 4, "not enough codes"); 84517651Speter Assert (lcodes <= L_CODES && dcodes <= D_CODES && blcodes <= BL_CODES, 84617651Speter "too many codes"); 84717651Speter Tracev((stderr, "\nbl counts: ")); 84817651Speter send_bits(s, lcodes-257, 5); /* not +255 as stated in appnote.txt */ 84917651Speter send_bits(s, dcodes-1, 5); 85017651Speter send_bits(s, blcodes-4, 4); /* not -3 as stated in appnote.txt */ 85117651Speter for (rank = 0; rank < blcodes; rank++) { 85217651Speter Tracev((stderr, "\nbl code %2d ", bl_order[rank])); 85317651Speter send_bits(s, s->bl_tree[bl_order[rank]].Len, 3); 85417651Speter } 85517651Speter Tracev((stderr, "\nbl tree: sent %ld", s->bits_sent)); 85617651Speter 85717651Speter send_tree(s, (ct_data *)s->dyn_ltree, lcodes-1); /* literal tree */ 85817651Speter Tracev((stderr, "\nlit tree: sent %ld", s->bits_sent)); 85917651Speter 86017651Speter send_tree(s, (ct_data *)s->dyn_dtree, dcodes-1); /* distance tree */ 86117651Speter Tracev((stderr, "\ndist tree: sent %ld", s->bits_sent)); 86217651Speter} 86317651Speter 86417651Speter/* =========================================================================== 86517651Speter * Send a stored block 86617651Speter */ 86717651Spetervoid _tr_stored_block(s, buf, stored_len, eof) 86817651Speter deflate_state *s; 86917651Speter charf *buf; /* input block */ 87017651Speter ulg stored_len; /* length of input block */ 87117651Speter int eof; /* true if this is the last block for a file */ 87217651Speter{ 87317651Speter send_bits(s, (STORED_BLOCK<<1)+eof, 3); /* send block type */ 87442471Speter#ifdef DEBUG 87517651Speter s->compressed_len = (s->compressed_len + 3 + 7) & (ulg)~7L; 87617651Speter s->compressed_len += (stored_len + 4) << 3; 87742471Speter#endif 87817651Speter copy_block(s, buf, (unsigned)stored_len, 1); /* with header */ 87917651Speter} 88017651Speter 88117651Speter/* =========================================================================== 88217651Speter * Send one empty static block to give enough lookahead for inflate. 88317651Speter * This takes 10 bits, of which 7 may remain in the bit buffer. 88417651Speter * The current inflate code requires 9 bits of lookahead. If the 88517651Speter * last two codes for the previous block (real code plus EOB) were coded 88617651Speter * on 5 bits or less, inflate may have only 5+3 bits of lookahead to decode 88717651Speter * the last real code. In this case we send two empty static blocks instead 88817651Speter * of one. (There are no problems if the previous block is stored or fixed.) 88917651Speter * To simplify the code, we assume the worst case of last real code encoded 89017651Speter * on one bit only. 89117651Speter */ 89217651Spetervoid _tr_align(s) 89317651Speter deflate_state *s; 89417651Speter{ 89517651Speter send_bits(s, STATIC_TREES<<1, 3); 89617651Speter send_code(s, END_BLOCK, static_ltree); 89742471Speter#ifdef DEBUG 89817651Speter s->compressed_len += 10L; /* 3 for block type, 7 for EOB */ 89942471Speter#endif 90017651Speter bi_flush(s); 90117651Speter /* Of the 10 bits for the empty block, we have already sent 90217651Speter * (10 - bi_valid) bits. The lookahead for the last real code (before 90317651Speter * the EOB of the previous block) was thus at least one plus the length 90417651Speter * of the EOB plus what we have just sent of the empty static block. 90517651Speter */ 90617651Speter if (1 + s->last_eob_len + 10 - s->bi_valid < 9) { 90717651Speter send_bits(s, STATIC_TREES<<1, 3); 90817651Speter send_code(s, END_BLOCK, static_ltree); 90942471Speter#ifdef DEBUG 91017651Speter s->compressed_len += 10L; 91142471Speter#endif 91217651Speter bi_flush(s); 91317651Speter } 91417651Speter s->last_eob_len = 7; 91517651Speter} 91617651Speter 91717651Speter/* =========================================================================== 91817651Speter * Determine the best encoding for the current block: dynamic trees, static 91942471Speter * trees or store, and output the encoded block to the zip file. 92017651Speter */ 92142471Spetervoid _tr_flush_block(s, buf, stored_len, eof) 92217651Speter deflate_state *s; 92317651Speter charf *buf; /* input block, or NULL if too old */ 92417651Speter ulg stored_len; /* length of input block */ 92517651Speter int eof; /* true if this is the last block for a file */ 92617651Speter{ 92717651Speter ulg opt_lenb, static_lenb; /* opt_len and static_len in bytes */ 92817651Speter int max_blindex = 0; /* index of last bit length code of non zero freq */ 92917651Speter 93017651Speter /* Build the Huffman trees unless a stored block is forced */ 93117651Speter if (s->level > 0) { 93217651Speter 93317651Speter /* Check if the file is ascii or binary */ 93417651Speter if (s->data_type == Z_UNKNOWN) set_data_type(s); 93517651Speter 93617651Speter /* Construct the literal and distance trees */ 93717651Speter build_tree(s, (tree_desc *)(&(s->l_desc))); 93817651Speter Tracev((stderr, "\nlit data: dyn %ld, stat %ld", s->opt_len, 93917651Speter s->static_len)); 94017651Speter 94117651Speter build_tree(s, (tree_desc *)(&(s->d_desc))); 94217651Speter Tracev((stderr, "\ndist data: dyn %ld, stat %ld", s->opt_len, 94317651Speter s->static_len)); 94417651Speter /* At this point, opt_len and static_len are the total bit lengths of 94517651Speter * the compressed block data, excluding the tree representations. 94617651Speter */ 94717651Speter 94817651Speter /* Build the bit length tree for the above two trees, and get the index 94917651Speter * in bl_order of the last bit length code to send. 95017651Speter */ 95117651Speter max_blindex = build_bl_tree(s); 95217651Speter 95317651Speter /* Determine the best encoding. Compute first the block length in bytes*/ 95417651Speter opt_lenb = (s->opt_len+3+7)>>3; 95517651Speter static_lenb = (s->static_len+3+7)>>3; 95617651Speter 95717651Speter Tracev((stderr, "\nopt %lu(%lu) stat %lu(%lu) stored %lu lit %u ", 95817651Speter opt_lenb, s->opt_len, static_lenb, s->static_len, stored_len, 95917651Speter s->last_lit)); 96017651Speter 96117651Speter if (static_lenb <= opt_lenb) opt_lenb = static_lenb; 96217651Speter 96317651Speter } else { 96417651Speter Assert(buf != (char*)0, "lost buf"); 96517651Speter opt_lenb = static_lenb = stored_len + 5; /* force a stored block */ 96617651Speter } 96717651Speter 96817651Speter#ifdef FORCE_STORED 96917651Speter if (buf != (char*)0) { /* force stored block */ 97017651Speter#else 97117651Speter if (stored_len+4 <= opt_lenb && buf != (char*)0) { 97217651Speter /* 4: two words for the lengths */ 97317651Speter#endif 97417651Speter /* The test buf != NULL is only necessary if LIT_BUFSIZE > WSIZE. 97517651Speter * Otherwise we can't have processed more than WSIZE input bytes since 97617651Speter * the last block flush, because compression would have been 97717651Speter * successful. If LIT_BUFSIZE <= WSIZE, it is never too late to 97817651Speter * transform a block into a stored block. 97917651Speter */ 98017651Speter _tr_stored_block(s, buf, stored_len, eof); 98117651Speter 98217651Speter#ifdef FORCE_STATIC 98317651Speter } else if (static_lenb >= 0) { /* force static trees */ 98417651Speter#else 98517651Speter } else if (static_lenb == opt_lenb) { 98617651Speter#endif 98717651Speter send_bits(s, (STATIC_TREES<<1)+eof, 3); 98817651Speter compress_block(s, (ct_data *)static_ltree, (ct_data *)static_dtree); 98942471Speter#ifdef DEBUG 99017651Speter s->compressed_len += 3 + s->static_len; 99142471Speter#endif 99217651Speter } else { 99317651Speter send_bits(s, (DYN_TREES<<1)+eof, 3); 99417651Speter send_all_trees(s, s->l_desc.max_code+1, s->d_desc.max_code+1, 99517651Speter max_blindex+1); 99617651Speter compress_block(s, (ct_data *)s->dyn_ltree, (ct_data *)s->dyn_dtree); 99742471Speter#ifdef DEBUG 99817651Speter s->compressed_len += 3 + s->opt_len; 99942471Speter#endif 100017651Speter } 100117651Speter Assert (s->compressed_len == s->bits_sent, "bad compressed size"); 100242471Speter /* The above check is made mod 2^32, for files larger than 512 MB 100342471Speter * and uLong implemented on 32 bits. 100442471Speter */ 100517651Speter init_block(s); 100617651Speter 100717651Speter if (eof) { 100817651Speter bi_windup(s); 100942471Speter#ifdef DEBUG 101017651Speter s->compressed_len += 7; /* align on byte boundary */ 101142471Speter#endif 101217651Speter } 101317651Speter Tracev((stderr,"\ncomprlen %lu(%lu) ", s->compressed_len>>3, 101417651Speter s->compressed_len-7*eof)); 101517651Speter} 101617651Speter 101717651Speter/* =========================================================================== 101817651Speter * Save the match info and tally the frequency counts. Return true if 101917651Speter * the current block must be flushed. 102017651Speter */ 102117651Speterint _tr_tally (s, dist, lc) 102217651Speter deflate_state *s; 102317651Speter unsigned dist; /* distance of matched string */ 102417651Speter unsigned lc; /* match length-MIN_MATCH or unmatched char (if dist==0) */ 102517651Speter{ 102617651Speter s->d_buf[s->last_lit] = (ush)dist; 102717651Speter s->l_buf[s->last_lit++] = (uch)lc; 102817651Speter if (dist == 0) { 102917651Speter /* lc is the unmatched char */ 103017651Speter s->dyn_ltree[lc].Freq++; 103117651Speter } else { 103217651Speter s->matches++; 103317651Speter /* Here, lc is the match length - MIN_MATCH */ 103417651Speter dist--; /* dist = match distance - 1 */ 103517651Speter Assert((ush)dist < (ush)MAX_DIST(s) && 103617651Speter (ush)lc <= (ush)(MAX_MATCH-MIN_MATCH) && 103717651Speter (ush)d_code(dist) < (ush)D_CODES, "_tr_tally: bad match"); 103817651Speter 103933908Ssteve s->dyn_ltree[_length_code[lc]+LITERALS+1].Freq++; 104017651Speter s->dyn_dtree[d_code(dist)].Freq++; 104117651Speter } 104217651Speter 104333908Ssteve#ifdef TRUNCATE_BLOCK 104417651Speter /* Try to guess if it is profitable to stop the current block here */ 104533908Ssteve if ((s->last_lit & 0x1fff) == 0 && s->level > 2) { 104617651Speter /* Compute an upper bound for the compressed length */ 104717651Speter ulg out_length = (ulg)s->last_lit*8L; 104817651Speter ulg in_length = (ulg)((long)s->strstart - s->block_start); 104917651Speter int dcode; 105017651Speter for (dcode = 0; dcode < D_CODES; dcode++) { 105117651Speter out_length += (ulg)s->dyn_dtree[dcode].Freq * 105217651Speter (5L+extra_dbits[dcode]); 105317651Speter } 105417651Speter out_length >>= 3; 105517651Speter Tracev((stderr,"\nlast_lit %u, in %ld, out ~%ld(%ld%%) ", 105617651Speter s->last_lit, in_length, out_length, 105717651Speter 100L - out_length*100L/in_length)); 105817651Speter if (s->matches < s->last_lit/2 && out_length < in_length/2) return 1; 105917651Speter } 106033908Ssteve#endif 106117651Speter return (s->last_lit == s->lit_bufsize-1); 106217651Speter /* We avoid equality with lit_bufsize because of wraparound at 64K 106317651Speter * on 16 bit machines and because stored blocks are restricted to 106417651Speter * 64K-1 bytes. 106517651Speter */ 106617651Speter} 106717651Speter 106817651Speter/* =========================================================================== 106917651Speter * Send the block data compressed using the given Huffman trees 107017651Speter */ 107117651Speterlocal void compress_block(s, ltree, dtree) 107217651Speter deflate_state *s; 107317651Speter ct_data *ltree; /* literal tree */ 107417651Speter ct_data *dtree; /* distance tree */ 107517651Speter{ 107617651Speter unsigned dist; /* distance of matched string */ 107717651Speter int lc; /* match length or unmatched char (if dist == 0) */ 107817651Speter unsigned lx = 0; /* running index in l_buf */ 107917651Speter unsigned code; /* the code to send */ 108017651Speter int extra; /* number of extra bits to send */ 108117651Speter 108217651Speter if (s->last_lit != 0) do { 108317651Speter dist = s->d_buf[lx]; 108417651Speter lc = s->l_buf[lx++]; 108517651Speter if (dist == 0) { 108617651Speter send_code(s, lc, ltree); /* send a literal byte */ 108717651Speter Tracecv(isgraph(lc), (stderr," '%c' ", lc)); 108817651Speter } else { 108917651Speter /* Here, lc is the match length - MIN_MATCH */ 109033908Ssteve code = _length_code[lc]; 109117651Speter send_code(s, code+LITERALS+1, ltree); /* send the length code */ 109217651Speter extra = extra_lbits[code]; 109317651Speter if (extra != 0) { 109417651Speter lc -= base_length[code]; 109517651Speter send_bits(s, lc, extra); /* send the extra length bits */ 109617651Speter } 109717651Speter dist--; /* dist is now the match distance - 1 */ 109817651Speter code = d_code(dist); 109917651Speter Assert (code < D_CODES, "bad d_code"); 110017651Speter 110117651Speter send_code(s, code, dtree); /* send the distance code */ 110217651Speter extra = extra_dbits[code]; 110317651Speter if (extra != 0) { 110417651Speter dist -= base_dist[code]; 110517651Speter send_bits(s, dist, extra); /* send the extra distance bits */ 110617651Speter } 110717651Speter } /* literal or match pair ? */ 110817651Speter 110917651Speter /* Check that the overlay between pending_buf and d_buf+l_buf is ok: */ 111017651Speter Assert(s->pending < s->lit_bufsize + 2*lx, "pendingBuf overflow"); 111117651Speter 111217651Speter } while (lx < s->last_lit); 111317651Speter 111417651Speter send_code(s, END_BLOCK, ltree); 111517651Speter s->last_eob_len = ltree[END_BLOCK].Len; 111617651Speter} 111717651Speter 111817651Speter/* =========================================================================== 111917651Speter * Set the data type to ASCII or BINARY, using a crude approximation: 112017651Speter * binary if more than 20% of the bytes are <= 6 or >= 128, ascii otherwise. 112117651Speter * IN assertion: the fields freq of dyn_ltree are set and the total of all 112217651Speter * frequencies does not exceed 64K (to fit in an int on 16 bit machines). 112317651Speter */ 112417651Speterlocal void set_data_type(s) 112517651Speter deflate_state *s; 112617651Speter{ 112717651Speter int n = 0; 112817651Speter unsigned ascii_freq = 0; 112917651Speter unsigned bin_freq = 0; 113017651Speter while (n < 7) bin_freq += s->dyn_ltree[n++].Freq; 113117651Speter while (n < 128) ascii_freq += s->dyn_ltree[n++].Freq; 113217651Speter while (n < LITERALS) bin_freq += s->dyn_ltree[n++].Freq; 113317651Speter s->data_type = (Byte)(bin_freq > (ascii_freq >> 2) ? Z_BINARY : Z_ASCII); 113417651Speter} 113517651Speter 113617651Speter/* =========================================================================== 113717651Speter * Reverse the first len bits of a code, using straightforward code (a faster 113817651Speter * method would use a table) 113917651Speter * IN assertion: 1 <= len <= 15 114017651Speter */ 114117651Speterlocal unsigned bi_reverse(code, len) 114217651Speter unsigned code; /* the value to invert */ 114317651Speter int len; /* its bit length */ 114417651Speter{ 114517651Speter register unsigned res = 0; 114617651Speter do { 114717651Speter res |= code & 1; 114817651Speter code >>= 1, res <<= 1; 114917651Speter } while (--len > 0); 115017651Speter return res >> 1; 115117651Speter} 115217651Speter 115317651Speter/* =========================================================================== 115417651Speter * Flush the bit buffer, keeping at most 7 bits in it. 115517651Speter */ 115617651Speterlocal void bi_flush(s) 115717651Speter deflate_state *s; 115817651Speter{ 115917651Speter if (s->bi_valid == 16) { 116017651Speter put_short(s, s->bi_buf); 116117651Speter s->bi_buf = 0; 116217651Speter s->bi_valid = 0; 116317651Speter } else if (s->bi_valid >= 8) { 116417651Speter put_byte(s, (Byte)s->bi_buf); 116517651Speter s->bi_buf >>= 8; 116617651Speter s->bi_valid -= 8; 116717651Speter } 116817651Speter} 116917651Speter 117017651Speter/* =========================================================================== 117117651Speter * Flush the bit buffer and align the output on a byte boundary 117217651Speter */ 117317651Speterlocal void bi_windup(s) 117417651Speter deflate_state *s; 117517651Speter{ 117617651Speter if (s->bi_valid > 8) { 117717651Speter put_short(s, s->bi_buf); 117817651Speter } else if (s->bi_valid > 0) { 117917651Speter put_byte(s, (Byte)s->bi_buf); 118017651Speter } 118117651Speter s->bi_buf = 0; 118217651Speter s->bi_valid = 0; 118317651Speter#ifdef DEBUG 118417651Speter s->bits_sent = (s->bits_sent+7) & ~7; 118517651Speter#endif 118617651Speter} 118717651Speter 118817651Speter/* =========================================================================== 118917651Speter * Copy a stored block, storing first the length and its 119017651Speter * one's complement if requested. 119117651Speter */ 119217651Speterlocal void copy_block(s, buf, len, header) 119317651Speter deflate_state *s; 119417651Speter charf *buf; /* the input data */ 119517651Speter unsigned len; /* its length */ 119617651Speter int header; /* true if block header must be written */ 119717651Speter{ 119817651Speter bi_windup(s); /* align on byte boundary */ 119917651Speter s->last_eob_len = 8; /* enough lookahead for inflate */ 120017651Speter 120117651Speter if (header) { 120217651Speter put_short(s, (ush)len); 120317651Speter put_short(s, (ush)~len); 120417651Speter#ifdef DEBUG 120517651Speter s->bits_sent += 2*16; 120617651Speter#endif 120717651Speter } 120817651Speter#ifdef DEBUG 120917651Speter s->bits_sent += (ulg)len<<3; 121017651Speter#endif 121117651Speter while (len--) { 121217651Speter put_byte(s, *buf++); 121317651Speter } 121417651Speter} 1215