home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1994 November / macformat-018.iso / Utility Spectacular / Developer / macgzip_022-src / trees.c < prev    next >
Encoding:
C/C++ Source or Header  |  1994-07-26  |  39.8 KB  |  1,081 lines  |  [TEXT/KAHL]
  1. /* trees.c -- output deflated data using Huffman coding
  2.  * Copyright (C) 1992-1993 Jean-loup Gailly
  3.  * This is free software; you can redistribute it and/or modify it under the
  4.  * terms of the GNU General Public License, see the file COPYING.
  5.  */
  6.  
  7. /*
  8.  * Modified:1993 by SPDsoft for MacGzip
  9.  *
  10.  */
  11.  
  12. /*
  13.  *  PURPOSE
  14.  *
  15.  *      Encode various sets of source values using variable-length
  16.  *      binary code trees.
  17.  *
  18.  *  DISCUSSION
  19.  *
  20.  *      The PKZIP "deflation" process uses several Huffman trees. The more
  21.  *      common source values are represented by shorter bit sequences.
  22.  *
  23.  *      Each code tree is stored in the ZIP file in a compressed form
  24.  *      which is itself a Huffman encoding of the lengths of
  25.  *      all the code strings (in ascending order by source values).
  26.  *      The actual code strings are reconstructed from the lengths in
  27.  *      the UNZIP process, as described in the "application note"
  28.  *      (APPNOTE.TXT) distributed as part of PKWARE's PKZIP program.
  29.  *
  30.  *  REFERENCES
  31.  *
  32.  *      Lynch, Thomas J.
  33.  *          Data Compression:  Techniques and Applications, pp. 53-55.
  34.  *          Lifetime Learning Publications, 1985.  ISBN 0-534-03418-7.
  35.  *
  36.  *      Storer, James A.
  37.  *          Data Compression:  Methods and Theory, pp. 49-50.
  38.  *          Computer Science Press, 1988.  ISBN 0-7167-8156-5.
  39.  *
  40.  *      Sedgewick, R.
  41.  *          Algorithms, p290.
  42.  *          Addison-Wesley, 1983. ISBN 0-201-06672-6.
  43.  *
  44.  *  INTERFACE
  45.  *
  46.  *      void ct_init (ush *attr, int *methodp)
  47.  *          Allocate the match buffer, initialize the various tables and save
  48.  *          the location of the internal file attribute (ascii/binary) and
  49.  *          method (DEFLATE/STORE)
  50.  *
  51.  *      void ct_tally (int dist, int lc);
  52.  *          Save the match info and tally the frequency counts.
  53.  *
  54.  *      long flush_block (char *buf, ulg stored_len, int eof)
  55.  *          Determine the best encoding for the current block: dynamic trees,
  56.  *          static trees or store, and output the encoded block to the zip
  57.  *          file. Returns the total compressed length for the file so far.
  58.  *
  59.  */
  60.  
  61. #include <ctype.h>
  62.  
  63. #include "tailor.h"
  64. #include "gzip.h"
  65.  
  66. #ifdef RCSID
  67. static char rcsid[] = "$Id: trees.c,v 0.12 1993/06/10 13:27:54 jloup Exp $";
  68. #endif
  69.  
  70. /* ===========================================================================
  71.  * Constants
  72.  */
  73.  
  74. #define MAX_BITS 15
  75. /* All codes must not exceed MAX_BITS bits */
  76.  
  77. #define MAX_BL_BITS 7
  78. /* Bit length codes must not exceed MAX_BL_BITS bits */
  79.  
  80. #define LENGTH_CODES 29
  81. /* number of length codes, not counting the special END_BLOCK code */
  82.  
  83. #define LITERALS  256
  84. /* number of literal bytes 0..255 */
  85.  
  86. #define END_BLOCK 256
  87. /* end of block literal code */
  88.  
  89. #define L_CODES (LITERALS+1+LENGTH_CODES)
  90. /* number of Literal or Length codes, including the END_BLOCK code */
  91.  
  92. #define D_CODES   30
  93. /* number of distance codes */
  94.  
  95. #define BL_CODES  19
  96. /* number of codes used to transfer the bit lengths */
  97.  
  98.  
  99. local int near extra_lbits[LENGTH_CODES] /* extra bits for each length code */
  100.    = {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};
  101.  
  102. local int near extra_dbits[D_CODES] /* extra bits for each distance code */
  103.    = {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};
  104.  
  105. local int near extra_blbits[BL_CODES]/* extra bits for each bit length code */
  106.    = {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,2,3,7};
  107.  
  108. #define STORED_BLOCK 0
  109. #define STATIC_TREES 1
  110. #define DYN_TREES    2
  111. /* The three kinds of block type */
  112.  
  113. #ifndef LIT_BUFSIZE
  114. #  ifdef SMALL_MEM
  115. #    define LIT_BUFSIZE  0x2000
  116. #  else
  117. #  ifdef MEDIUM_MEM
  118. #    define LIT_BUFSIZE  0x4000
  119. #  else
  120. #    define LIT_BUFSIZE  0x8000
  121. #  endif
  122. #  endif
  123. #endif
  124. #ifndef DIST_BUFSIZE
  125. #  define DIST_BUFSIZE  LIT_BUFSIZE
  126. #endif
  127. /* Sizes of match buffers for literals/lengths and distances.  There are
  128.  * 4 reasons for limiting LIT_BUFSIZE to 64K:
  129.  *   - frequencies can be kept in 16 bit counters
  130.  *   - if compression is not successful for the first block, all input data is
  131.  *     still in the window so we can still emit a stored block even when input
  132.  *     comes from standard input.  (This can also be done for all blocks if
  133.  *     LIT_BUFSIZE is not greater than 32K.)
  134.  *   - if compression is not successful for a file smaller than 64K, we can
  135.  *     even emit a stored file instead of a stored block (saving 5 bytes).
  136.  *   - creating new Huffman trees less frequently may not provide fast
  137.  *     adaptation to changes in the input data statistics. (Take for
  138.  *     example a binary file with poorly compressible code followed by
  139.  *     a highly compressible string table.) Smaller buffer sizes give
  140.  *     fast adaptation but have of course the overhead of transmitting trees
  141.  *     more frequently.
  142.  *   - I can't count above 4
  143.  * The current code is general and allows DIST_BUFSIZE < LIT_BUFSIZE (to save
  144.  * memory at the expense of compression). Some optimizations would be possible
  145.  * if we rely on DIST_BUFSIZE == LIT_BUFSIZE.
  146.  */
  147. #if LIT_BUFSIZE > INBUFSIZ
  148.     error cannot overlay l_buf and inbuf
  149. #endif
  150.  
  151. #define REP_3_6      16
  152. /* repeat previous bit length 3-6 times (2 bits of repeat count) */
  153.  
  154. #define REPZ_3_10    17
  155. /* repeat a zero length 3-10 times  (3 bits of repeat count) */
  156.  
  157. #define REPZ_11_138  18
  158. /* repeat a zero length 11-138 times  (7 bits of repeat count) */
  159.  
  160. /* ===========================================================================
  161.  * Local data
  162.  */
  163.  
  164. /* Data structure describing a single value and its code string. */
  165. typedef struct ct_data {
  166.     union {
  167.         ush  freq;       /* frequency count */
  168.         ush  code;       /* bit string */
  169.     } fc;
  170.     union {
  171.         ush  dad;        /* father node in Huffman tree */
  172.         ush  len;        /* length of bit string */
  173.     } dl;
  174. } ct_data;
  175.  
  176. #define Freq fc.freq
  177. #define Code fc.code
  178. #define Dad  dl.dad
  179. #define Len  dl.len
  180.  
  181. #define HEAP_SIZE (2*L_CODES+1)
  182. /* maximum heap size */
  183.  
  184. local ct_data near dyn_ltree[HEAP_SIZE];   /* literal and length tree */
  185. local ct_data near dyn_dtree[2*D_CODES+1]; /* distance tree */
  186.  
  187. local ct_data near static_ltree[L_CODES+2];
  188. /* The static literal tree. Since the bit lengths are imposed, there is no
  189.  * need for the L_CODES extra codes used during heap construction. However
  190.  * The codes 286 and 287 are needed to build a canonical tree (see ct_init
  191.  * below).
  192.  */
  193.  
  194. local ct_data near static_dtree[D_CODES];
  195. /* The static distance tree. (Actually a trivial tree since all codes use
  196.  * 5 bits.)
  197.  */
  198.  
  199. local ct_data near bl_tree[2*BL_CODES+1];
  200. /* Huffman tree for the bit lengths */
  201.  
  202. typedef struct tree_desc {
  203.     ct_data near *dyn_tree;      /* the dynamic tree */
  204.     ct_data near *static_tree;   /* corresponding static tree or NULL */
  205.     int     near *extra_bits;    /* extra bits for each code or NULL */
  206.     int     extra_base;          /* base index for extra_bits */
  207.     int     elems;               /* max number of elements in the tree */
  208.     int     max_length;          /* max bit length for the codes */
  209.     int     max_code;            /* largest code with non zero frequency */
  210. } tree_desc;
  211.  
  212. local tree_desc near l_desc =
  213. {dyn_ltree, static_ltree, extra_lbits, LITERALS+1, L_CODES, MAX_BITS, 0};
  214.  
  215. local tree_desc near d_desc =
  216. {dyn_dtree, static_dtree, extra_dbits, 0,          D_CODES, MAX_BITS, 0};
  217.  
  218. local tree_desc near bl_desc =
  219. {bl_tree, (ct_data near *)0, extra_blbits, 0,      BL_CODES, MAX_BL_BITS, 0};
  220.  
  221.  
  222. local ush near bl_count[MAX_BITS+1];
  223. /* number of codes at each bit length for an optimal tree */
  224.  
  225. local uch near bl_order[BL_CODES]
  226.    = {16,17,18,0,8,7,9,6,10,5,11,4,12,3,13,2,14,1,15};
  227. /* The lengths of the bit length codes are sent in order of decreasing
  228.  * probability, to avoid transmitting the lengths for unused bit length codes.
  229.  */
  230.  
  231. local int near heap[2*L_CODES+1]; /* heap used to build the Huffman trees */
  232. local int heap_len;               /* number of elements in the heap */
  233. local int heap_max;               /* element of largest frequency */
  234. /* The sons of heap[n] are heap[2*n] and heap[2*n+1]. heap[0] is not used.
  235.  * The same heap array is used to build all trees.
  236.  */
  237.  
  238. local uch near depth[2*L_CODES+1];
  239. /* Depth of each subtree used as tie breaker for trees of equal frequency */
  240.  
  241. local uch length_code[MAX_MATCH-MIN_MATCH+1];
  242. /* length code for each normalized match length (0 == MIN_MATCH) */
  243.  
  244. local uch dist_code[512];
  245. /* distance codes. The first 256 values correspond to the distances
  246.  * 3 .. 258, the last 256 values correspond to the top 8 bits of
  247.  * the 15 bit distances.
  248.  */
  249.  
  250. local int near base_length[LENGTH_CODES];
  251. /* First normalized length for each code (0 = MIN_MATCH) */
  252.  
  253. local int near base_dist[D_CODES];
  254. /* First normalized distance for each code (0 = distance of 1) */
  255.  
  256. #define l_buf inbuf
  257. /* DECLARE(uch, l_buf, LIT_BUFSIZE);  buffer for literals or lengths */
  258.  
  259. /* DECLARE(ush, d_buf, DIST_BUFSIZE); buffer for distances */
  260.  
  261. local uch near flag_buf[(LIT_BUFSIZE/8)];
  262. /* flag_buf is a bit array distinguishing literals from lengths in
  263.  * l_buf, thus indicating the presence or absence of a distance.
  264.  */
  265.  
  266. local unsigned last_lit;    /* running index in l_buf */
  267. local unsigned last_dist;   /* running index in d_buf */
  268. local unsigned last_flags;  /* running index in flag_buf */
  269. local uch flags;            /* current flags not yet saved in flag_buf */
  270. local uch flag_bit;         /* current bit used in flags */
  271. /* bits are filled in flags starting at bit 0 (least significant).
  272.  * Note: these flags are overkill in the current code since we don't
  273.  * take advantage of DIST_BUFSIZE == LIT_BUFSIZE.
  274.  */
  275.  
  276. local ulg opt_len;        /* bit length of current block with optimal trees */
  277. local ulg static_len;     /* bit length of current block with static trees */
  278.  
  279. local ulg compressed_len; /* total bit length of compressed file */
  280.  
  281. local ulg input_len;      /* total byte length of input file */
  282. /* input_len is for debugging only since we can get it by other means. */
  283.  
  284. ush *file_type;        /* pointer to UNKNOWN, BINARY or ASCII */
  285. int *file_method;      /* pointer to DEFLATE or STORE */
  286.  
  287. #ifdef DEBUG
  288. extern ulg bits_sent;  /* bit length of the compressed data */
  289. extern long isize;     /* byte length of input file */
  290. #endif
  291.  
  292. extern long block_start;       /* window offset of current block */
  293. extern unsigned near strstart; /* window offset of current string */
  294.  
  295. /* ===========================================================================
  296.  * Local (static) routines in this file.
  297.  */
  298.  
  299. local void init_block     OF((void));
  300. local void pqdownheap     OF((ct_data near *tree, int k));
  301. local void gen_bitlen     OF((tree_desc near *desc));
  302. local void gen_codes      OF((ct_data near *tree, int max_code));
  303. local void build_tree     OF((tree_desc near *desc));
  304. local void scan_tree      OF((ct_data near *tree, int max_code));
  305. local void send_tree      OF((ct_data near *tree, int max_code));
  306. local int  build_bl_tree  OF((void));
  307. local void send_all_trees OF((int lcodes, int dcodes, int blcodes));
  308. local void compress_block OF((ct_data near *ltree, ct_data near *dtree));
  309. local void set_file_type  OF((void));
  310.  
  311.  
  312. #ifndef DEBUG
  313. #  define send_code(c, tree) send_bits(tree[c].Code, tree[c].Len)
  314.    /* Send a code of the given tree. c and tree must not have side effects */
  315.  
  316. #else /* DEBUG */
  317. #  define send_code(c, tree) \
  318.      { if (verbose>1) fprintf(stderr,"\ncd %3d ",(c)); \
  319.        send_bits(tree[c].Code, tree[c].Len); }
  320. #endif
  321.  
  322. #define d_code(dist) \
  323.    ((dist) < 256 ? dist_code[dist] : dist_code[256+((dist)>>7)])
  324. /* Mapping from a distance to a distance code. dist is the distance - 1 and
  325.  * must not have side effects. dist_code[256] and dist_code[257] are never
  326.  * used.
  327.  */
  328.  
  329. #define MAX(a,b) (a >= b ? a : b)
  330. /* the arguments must not have side effects */
  331.  
  332. /* ===========================================================================
  333.  * Allocate the match buffer, initialize the various tables and save the
  334.  * location of the internal file attribute (ascii/binary) and method
  335.  * (DEFLATE/STORE).
  336.  */
  337. void ct_init(attr, methodp)
  338.     ush  *attr;   /* pointer to internal file attribute */
  339.     int  *methodp; /* pointer to compression method */
  340. {
  341.     int n;        /* iterates over tree elements */
  342.     int bits;     /* bit counter */
  343.     int length;   /* length value */
  344.     int code;     /* code value */
  345.     int dist;     /* distance index */
  346.  
  347.     file_type = attr;
  348.     file_method = methodp;
  349.     compressed_len = input_len = 0L;
  350.         
  351.     if (static_dtree[0].Len != 0) return; /* ct_init already called */
  352.  
  353.     /* Initialize the mapping length (0..255) -> length code (0..28) */
  354.     length = 0;
  355.     for (code = 0; code < LENGTH_CODES-1; code++) {
  356.         base_length[code] = length;
  357.         for (n = 0; n < (1<<extra_lbits[code]); n++) {
  358.             length_code[length++] = (uch)code;
  359.         }
  360.     }
  361.     Assert (length == 256, "ct_init: length != 256");
  362.     /* Note that the length 255 (match length 258) can be represented
  363.      * in two different ways: code 284 + 5 bits or code 285, so we
  364.      * overwrite length_code[255] to use the best encoding:
  365.      */
  366.     length_code[length-1] = (uch)code;
  367.  
  368.     /* Initialize the mapping dist (0..32K) -> dist code (0..29) */
  369.     dist = 0;
  370.     for (code = 0 ; code < 16; code++) {
  371.         base_dist[code] = dist;
  372.         for (n = 0; n < (1<<extra_dbits[code]); n++) {
  373.             dist_code[dist++] = (uch)code;
  374.         }
  375.     }
  376.     Assert (dist == 256, "ct_init: dist != 256");
  377.     dist >>= 7; /* from now on, all distances are divided by 128 */
  378.     for ( ; code < D_CODES; code++) {
  379.         base_dist[code] = dist << 7;
  380.         for (n = 0; n < (1<<(extra_dbits[code]-7)); n++) {
  381.             dist_code[256 + dist++] = (uch)code;
  382.         }
  383.     }
  384.     Assert (dist == 256, "ct_init: 256+dist != 512");
  385.  
  386.     /* Construct the codes of the static literal tree */
  387.     for (bits = 0; bits <= MAX_BITS; bits++) bl_count[bits] = 0;
  388.     n = 0;
  389.     while (n <= 143) static_ltree[n++].Len = 8, bl_count[8]++;
  390.     while (n <= 255) static_ltree[n++].Len = 9, bl_count[9]++;
  391.     while (n <= 279) static_ltree[n++].Len = 7, bl_count[7]++;
  392.     while (n <= 287) static_ltree[n++].Len = 8, bl_count[8]++;
  393.     /* Codes 286 and 287 do not exist, but we must include them in the
  394.      * tree construction to get a canonical Huffman tree (longest code
  395.      * all ones)
  396.      */
  397.     gen_codes((ct_data near *)static_ltree, L_CODES+1);
  398.  
  399.     /* The static distance tree is trivial: */
  400.     for (n = 0; n < D_CODES; n++) {
  401.         static_dtree[n].Len = 5;
  402.         static_dtree[n].Code = bi_reverse(n, 5);
  403.     }
  404.  
  405.     /* Initialize the first block of the first file: */
  406.     init_block();
  407. }
  408.  
  409. /* ===========================================================================
  410.  * Initialize a new block.
  411.  */
  412. local void init_block()
  413. {
  414.     int n; /* iterates over tree elements */
  415.  
  416.     /* Initialize the trees. */
  417.     for (n = 0; n < L_CODES;  n++) dyn_ltree[n].Freq = 0;
  418.     for (n = 0; n < D_CODES;  n++) dyn_dtree[n].Freq = 0;
  419.     for (n = 0; n < BL_CODES; n++) bl_tree[n].Freq = 0;
  420.  
  421.     dyn_ltree[END_BLOCK].Freq = 1;
  422.     opt_len = static_len = 0L;
  423.     last_lit = last_dist = last_flags = 0;
  424.     flags = 0; flag_bit = 1;
  425. }
  426.  
  427. #define SMALLEST 1
  428. /* Index within the heap array of least frequent node in the Huffman tree */
  429.  
  430.  
  431. /* ===========================================================================
  432.  * Remove the smallest element from the heap and recreate the heap with
  433.  * one less element. Updates heap and heap_len.
  434.  */
  435. #define pqremove(tree, top) \
  436. {\
  437.     top = heap[SMALLEST]; \
  438.     heap[SMALLEST] = heap[heap_len--]; \
  439.     pqdownheap(tree, SMALLEST); \
  440. }
  441.  
  442. /* ===========================================================================
  443.  * Compares to subtrees, using the tree depth as tie breaker when
  444.  * the subtrees have equal frequency. This minimizes the worst case length.
  445.  */
  446. #define smaller(tree, n, m) \
  447.    (tree[n].Freq < tree[m].Freq || \
  448.    (tree[n].Freq == tree[m].Freq && depth[n] <= depth[m]))
  449.  
  450. /* ===========================================================================
  451.  * Restore the heap property by moving down the tree starting at node k,
  452.  * exchanging a node with the smallest of its two sons if necessary, stopping
  453.  * when the heap property is re-established (each father smaller than its
  454.  * two sons).
  455.  */
  456. local void pqdownheap(tree, k)
  457.     ct_data near *tree;  /* the tree to restore */
  458.     int k;               /* node to move down */
  459. {
  460.     int v = heap[k];
  461.     int j = k << 1;  /* left son of k */
  462.     while (j <= heap_len) {
  463.         /* Set j to the smallest of the two sons: */
  464.         if (j < heap_len && smaller(tree, heap[j+1], heap[j])) j++;
  465.  
  466.         /* Exit if v is smaller than both sons */
  467.         if (smaller(tree, v, heap[j])) break;
  468.  
  469.         /* Exchange v with the smallest son */
  470.         heap[k] = heap[j];  k = j;
  471.  
  472.         /* And continue down the tree, setting j to the left son of k */
  473.         j <<= 1;
  474.     }
  475.     heap[k] = v;
  476. }
  477.  
  478. /* ===========================================================================
  479.  * Compute the optimal bit lengths for a tree and update the total bit length
  480.  * for the current block.
  481.  * IN assertion: the fields freq and dad are set, heap[heap_max] and
  482.  *    above are the tree nodes sorted by increasing frequency.
  483.  * OUT assertions: the field len is set to the optimal bit length, the
  484.  *     array bl_count contains the frequencies for each bit length.
  485.  *     The length opt_len is updated; static_len is also updated if stree is
  486.  *     not null.
  487.  */
  488. local void gen_bitlen(desc)
  489.     tree_desc near *desc; /* the tree descriptor */
  490. {
  491.     ct_data near *tree  = desc->dyn_tree;
  492.     int near *extra     = desc->extra_bits;
  493.     int base            = desc->extra_base;
  494.     int max_code        = desc->max_code;
  495.     int max_length      = desc->max_length;
  496.     ct_data near *stree = desc->static_tree;
  497.     int h;              /* heap index */
  498.     int n, m;           /* iterate over the tree elements */
  499.     int bits;           /* bit length */
  500.     int xbits;          /* extra bits */
  501.     ush f;              /* frequency */
  502.     int overflow = 0;   /* number of elements with bit length too large */
  503.  
  504.     for (bits = 0; bits <= MAX_BITS; bits++) bl_count[bits] = 0;
  505.  
  506.     /* In a first pass, compute the optimal bit lengths (which may
  507.      * overflow in the case of the bit length tree).
  508.      */
  509.     tree[heap[heap_max]].Len = 0; /* root of the heap */
  510.  
  511.     for (h = heap_max+1; h < HEAP_SIZE; h++) {
  512.         n = heap[h];
  513.         bits = tree[tree[n].Dad].Len + 1;
  514.         if (bits > max_length) bits = max_length, overflow++;
  515.         tree[n].Len = (ush)bits;
  516.         /* We overwrite tree[n].Dad which is no longer needed */
  517.  
  518.         if (n > max_code) continue; /* not a leaf node */
  519.  
  520.         bl_count[bits]++;
  521.         xbits = 0;
  522.         if (n >= base) xbits = extra[n-base];
  523.         f = tree[n].Freq;
  524.         opt_len += (ulg)f * (bits + xbits);
  525.         if (stree) static_len += (ulg)f * (stree[n].Len + xbits);
  526.     }
  527.     if (overflow == 0) return;
  528.  
  529.     Trace((stderr,"\nbit length overflow\n"));
  530.     /* This happens for example on obj2 and pic of the Calgary corpus */
  531.  
  532.     /* Find the first bit length which could increase: */
  533.     do {
  534.         bits = max_length-1;
  535.         while (bl_count[bits] == 0) bits--;
  536.         bl_count[bits]--;      /* move one leaf down the tree */
  537.         bl_count[bits+1] += 2; /* move one overflow item as its brother */
  538.         bl_count[max_length]--;
  539.         /* The brother of the overflow item also moves one step up,
  540.          * but this does not affect bl_count[max_length]
  541.          */
  542.         overflow -= 2;
  543.     } while (overflow > 0);
  544.  
  545.     /* Now recompute all bit lengths, scanning in increasing frequency.
  546.      * h is still equal to HEAP_SIZE. (It is simpler to reconstruct all
  547.      * lengths instead of fixing only the wrong ones. This idea is taken
  548.      * from 'ar' written by Haruhiko Okumura.)
  549.      */
  550.     for (bits = max_length; bits != 0; bits--) {
  551.         n = bl_count[bits];
  552.         while (n != 0) {
  553.             m = heap[--h];
  554.             if (m > max_code) continue;
  555.             if (tree[m].Len != (unsigned) bits) {
  556.                 Trace((stderr,"code %d bits %d->%d\n", m, tree[m].Len, bits));
  557.                 opt_len += ((long)bits-(long)tree[m].Len)*(long)tree[m].Freq;
  558.                 tree[m].Len = (ush)bits;
  559.             }
  560.             n--;
  561.         }
  562.     }
  563. }
  564.  
  565. /* ===========================================================================
  566.  * Generate the codes for a given tree and bit counts (which need not be
  567.  * optimal).
  568.  * IN assertion: the array bl_count contains the bit length statistics for
  569.  * the given tree and the field len is set for all tree elements.
  570.  * OUT assertion: the field code is set for all tree elements of non
  571.  *     zero code length.
  572.  */
  573. local void gen_codes (tree, max_code)
  574.     ct_data near *tree;        /* the tree to decorate */
  575.     int max_code;              /* largest code with non zero frequency */
  576. {
  577.     ush next_code[MAX_BITS+1]; /* next code value for each bit length */
  578.     ush code = 0;              /* running code value */
  579.     int bits;                  /* bit index */
  580.     int n;                     /* code index */
  581.  
  582.     /* The distribution counts are first used to generate the code values
  583.      * without bit reversal.
  584.      */
  585.     for (bits = 1; bits <= MAX_BITS; bits++) {
  586.         next_code[bits] = code = (code + bl_count[bits-1]) << 1;
  587.     }
  588.     /* Check that the bit counts in bl_count are consistent. The last code
  589.      * must be all ones.
  590.      */
  591.     Assert (code + bl_count[MAX_BITS]-1 == (1<<MAX_BITS)-1,
  592.             "inconsistent bit counts");
  593.     Tracev((stderr,"\ngen_codes: max_code %d ", max_code));
  594.  
  595.     for (n = 0;  n <= max_code; n++) {
  596.         int len = tree[n].Len;
  597.         if (len == 0) continue;
  598.         /* Now reverse the bits */
  599.         tree[n].Code = bi_reverse(next_code[len]++, len);
  600.  
  601.         Tracec(tree != static_ltree, (stderr,"\nn %3d %c l %2d c %4x (%x) ",
  602.              n, (isgraph(n) ? n : ' '), len, tree[n].Code, next_code[len]-1));
  603.     }
  604. }
  605.  
  606. /* ===========================================================================
  607.  * Construct one Huffman tree and assigns the code bit strings and lengths.
  608.  * Update the total bit length for the current block.
  609.  * IN assertion: the field freq is set for all tree elements.
  610.  * OUT assertions: the fields len and code are set to the optimal bit length
  611.  *     and corresponding code. The length opt_len is updated; static_len is
  612.  *     also updated if stree is not null. The field max_code is set.
  613.  */
  614. local void build_tree(desc)
  615.     tree_desc near *desc; /* the tree descriptor */
  616. {
  617.     ct_data near *tree   = desc->dyn_tree;
  618.     ct_data near *stree  = desc->static_tree;
  619.     int elems            = desc->elems;
  620.     int n, m;          /* iterate over heap elements */
  621.     int max_code = -1; /* largest code with non zero frequency */
  622.     int node = elems;  /* next internal node of the tree */
  623.  
  624.     /* Construct the initial heap, with least frequent element in
  625.      * heap[SMALLEST]. The sons of heap[n] are heap[2*n] and heap[2*n+1].
  626.      * heap[0] is not used.
  627.      */
  628.     heap_len = 0, heap_max = HEAP_SIZE;
  629.  
  630.     for (n = 0; n < elems; n++) {
  631.         if (tree[n].Freq != 0) {
  632.             heap[++heap_len] = max_code = n;
  633.             depth[n] = 0;
  634.         } else {
  635.             tree[n].Len = 0;
  636.         }
  637.     }
  638.  
  639.     /* The pkzip format requires that at least one distance code exists,
  640.      * and that at least one bit should be sent even if there is only one
  641.      * possible code. So to avoid special checks later on we force at least
  642.      * two codes of non zero frequency.
  643.      */
  644.     while (heap_len < 2) {
  645.         int new = heap[++heap_len] = (max_code < 2 ? ++max_code : 0);
  646.         tree[new].Freq = 1;
  647.         depth[new] = 0;
  648.         opt_len--; if (stree) static_len -= stree[new].Len;
  649.         /* new is 0 or 1 so it does not have extra bits */
  650.     }
  651.     desc->max_code = max_code;
  652.  
  653.     /* The elements heap[heap_len/2+1 .. heap_len] are leaves of the tree,
  654.      * establish sub-heaps of increasing lengths:
  655.      */
  656.     for (n = heap_len/2; n >= 1; n--) pqdownheap(tree, n);
  657.  
  658.     /* Construct the Huffman tree by repeatedly combining the least two
  659.      * frequent nodes.
  660.      */
  661.     do {
  662.         pqremove(tree, n);   /* n = node of least frequency */
  663.         m = heap[SMALLEST];  /* m = node of next least frequency */
  664.  
  665.         heap[--heap_max] = n; /* keep the nodes sorted by frequency */
  666.         heap[--heap_max] = m;
  667.  
  668.         /* Create a new node father of n and m */
  669.         tree[node].Freq = tree[n].Freq + tree[m].Freq;
  670.         depth[node] = (uch) (MAX(depth[n], depth[m]) + 1);
  671.         tree[n].Dad = tree[m].Dad = (ush)node;
  672. #ifdef DUMP_BL_TREE
  673.         if (tree == bl_tree) {
  674.             fprintf(stderr,"\nnode %d(%d), sons %d(%d) %d(%d)",
  675.                     node, tree[node].Freq, n, tree[n].Freq, m, tree[m].Freq);
  676.         }
  677. #endif
  678.         /* and insert the new node in the heap */
  679.         heap[SMALLEST] = node++;
  680.         pqdownheap(tree, SMALLEST);
  681.  
  682.     } while (heap_len >= 2);
  683.  
  684.     heap[--heap_max] = heap[SMALLEST];
  685.  
  686.     /* At this point, the fields freq and dad are set. We can now
  687.      * generate the bit lengths.
  688.      */
  689.     gen_bitlen((tree_desc near *)desc);
  690.  
  691.     /* The field len is now set, we can generate the bit codes */
  692.     gen_codes ((ct_data near *)tree, max_code);
  693. }
  694.  
  695. /* ===========================================================================
  696.  * Scan a literal or distance tree to determine the frequencies of the codes
  697.  * in the bit length tree. Updates opt_len to take into account the repeat
  698.  * counts. (The contribution of the bit length codes will be added later
  699.  * during the construction of bl_tree.)
  700.  */
  701. local void scan_tree (tree, max_code)
  702.     ct_data near *tree; /* the tree to be scanned */
  703.     int max_code;       /* and its largest code of non zero frequency */
  704. {
  705.     int n;                     /* iterates over all tree elements */
  706.     int prevlen = -1;          /* last emitted length */
  707.     int curlen;                /* length of current code */
  708.     int nextlen = tree[0].Len; /* length of next code */
  709.     int count = 0;             /* repeat count of the current code */
  710.     int max_count = 7;         /* max repeat count */
  711.     int min_count = 4;         /* min repeat count */
  712.  
  713.     if (nextlen == 0) max_count = 138, min_count = 3;
  714.     tree[max_code+1].Len = (ush)0xffff; /* guard */
  715.  
  716.     for (n = 0; n <= max_code; n++) {
  717.         curlen = nextlen; nextlen = tree[n+1].Len;
  718.         if (++count < max_count && curlen == nextlen) {
  719.             continue;
  720.         } else if (count < min_count) {
  721.             bl_tree[curlen].Freq += count;
  722.         } else if (curlen != 0) {
  723.             if (curlen != prevlen) bl_tree[curlen].Freq++;
  724.             bl_tree[REP_3_6].Freq++;
  725.         } else if (count <= 10) {
  726.             bl_tree[REPZ_3_10].Freq++;
  727.         } else {
  728.             bl_tree[REPZ_11_138].Freq++;
  729.         }
  730.         count = 0; prevlen = curlen;
  731.         if (nextlen == 0) {
  732.             max_count = 138, min_count = 3;
  733.         } else if (curlen == nextlen) {
  734.             max_count = 6, min_count = 3;
  735.         } else {
  736.             max_count = 7, min_count = 4;
  737.         }
  738.     }
  739. }
  740.  
  741. /* ===========================================================================
  742.  * Send a literal or distance tree in compressed form, using the codes in
  743.  * bl_tree.
  744.  */
  745. local void send_tree (tree, max_code)
  746.     ct_data near *tree; /* the tree to be scanned */
  747.     int max_code;       /* and its largest code of non zero frequency */
  748. {
  749.     int n;                     /* iterates over all tree elements */
  750.     int prevlen = -1;          /* last emitted length */
  751.     int curlen;                /* length of current code */
  752.     int nextlen = tree[0].Len; /* length of next code */
  753.     int count = 0;             /* repeat count of the current code */
  754.     int max_count = 7;         /* max repeat count */
  755.     int min_count = 4;         /* min repeat count */
  756.  
  757.     /* tree[max_code+1].Len = -1; */  /* guard already set */
  758.     if (nextlen == 0) max_count = 138, min_count = 3;
  759.  
  760.     for (n = 0; n <= max_code; n++) {
  761.         curlen = nextlen; nextlen = tree[n+1].Len;
  762.         if (++count < max_count && curlen == nextlen) {
  763.             continue;
  764.         } else if (count < min_count) {
  765.             do { send_code(curlen, bl_tree); } while (--count != 0);
  766.  
  767.         } else if (curlen != 0) {
  768.             if (curlen != prevlen) {
  769.                 send_code(curlen, bl_tree); count--;
  770.             }
  771.             Assert(count >= 3 && count <= 6, " 3_6?");
  772.             send_code(REP_3_6, bl_tree); send_bits(count-3, 2);
  773.  
  774.         } else if (count <= 10) {
  775.             send_code(REPZ_3_10, bl_tree); send_bits(count-3, 3);
  776.  
  777.         } else {
  778.             send_code(REPZ_11_138, bl_tree); send_bits(count-11, 7);
  779.         }
  780.         count = 0; prevlen = curlen;
  781.         if (nextlen == 0) {
  782.             max_count = 138, min_count = 3;
  783.         } else if (curlen == nextlen) {
  784.             max_count = 6, min_count = 3;
  785.         } else {
  786.             max_count = 7, min_count = 4;
  787.         }
  788.     }
  789. }
  790.  
  791. /* ===========================================================================
  792.  * Construct the Huffman tree for the bit lengths and return the index in
  793.  * bl_order of the last bit length code to send.
  794.  */
  795. local int build_bl_tree()
  796. {
  797.     int max_blindex;  /* index of last bit length code of non zero freq */
  798.  
  799.     /* Determine the bit length frequencies for literal and distance trees */
  800.     scan_tree((ct_data near *)dyn_ltree, l_desc.max_code);
  801.     scan_tree((ct_data near *)dyn_dtree, d_desc.max_code);
  802.  
  803.     /* Build the bit length tree: */
  804.     build_tree((tree_desc near *)(&bl_desc));
  805.     /* opt_len now includes the length of the tree representations, except
  806.      * the lengths of the bit lengths codes and the 5+5+4 bits for the counts.
  807.      */
  808.  
  809.     /* Determine the number of bit length codes to send. The pkzip format
  810.      * requires that at least 4 bit length codes be sent. (appnote.txt says
  811.      * 3 but the actual value used is 4.)
  812.      */
  813.     for (max_blindex = BL_CODES-1; max_blindex >= 3; max_blindex--) {
  814.         if (bl_tree[bl_order[max_blindex]].Len != 0) break;
  815.     }
  816.     /* Update opt_len to include the bit length tree and counts */
  817.     opt_len += 3*(max_blindex+1) + 5+5+4;
  818.     Tracev((stderr, "\ndyn trees: dyn %ld, stat %ld", opt_len, static_len));
  819.  
  820.     return max_blindex;
  821. }
  822.  
  823. /* ===========================================================================
  824.  * Send the header for a block using dynamic Huffman trees: the counts, the
  825.  * lengths of the bit length codes, the literal tree and the distance tree.
  826.  * IN assertion: lcodes >= 257, dcodes >= 1, blcodes >= 4.
  827.  */
  828. local void send_all_trees(lcodes, dcodes, blcodes)
  829.     int lcodes, dcodes, blcodes; /* number of codes for each tree */
  830. {
  831.     int rank;                    /* index in bl_order */
  832.  
  833.     Assert (lcodes >= 257 && dcodes >= 1 && blcodes >= 4, "not enough codes");
  834.     Assert (lcodes <= L_CODES && dcodes <= D_CODES && blcodes <= BL_CODES,
  835.             "too many codes");
  836.     Tracev((stderr, "\nbl counts: "));
  837.     send_bits(lcodes-257, 5); /* not +255 as stated in appnote.txt */
  838.     send_bits(dcodes-1,   5);
  839.     send_bits(blcodes-4,  4); /* not -3 as stated in appnote.txt */
  840.     for (rank = 0; rank < blcodes; rank++) {
  841.         Tracev((stderr, "\nbl code %2d ", bl_order[rank]));
  842.         send_bits(bl_tree[bl_order[rank]].Len, 3);
  843.     }
  844.     Tracev((stderr, "\nbl tree: sent %ld", bits_sent));
  845.  
  846.     send_tree((ct_data near *)dyn_ltree, lcodes-1); /* send the literal tree */
  847.     Tracev((stderr, "\nlit tree: sent %ld", bits_sent));
  848.  
  849.     send_tree((ct_data near *)dyn_dtree, dcodes-1); /* send the distance tree */
  850.     Tracev((stderr, "\ndist tree: sent %ld", bits_sent));
  851. }
  852.  
  853. /* ===========================================================================
  854.  * Determine the best encoding for the current block: dynamic trees, static
  855.  * trees or store, and output the encoded block to the zip file. This function
  856.  * returns the total compressed length for the file so far.
  857.  */
  858. ulg flush_block(buf, stored_len, eof)
  859.     char *buf;        /* input block, or NULL if too old */
  860.     ulg stored_len;   /* length of input block */
  861.     int eof;          /* true if this is the last block for a file */
  862. {
  863.     ulg opt_lenb, static_lenb; /* opt_len and static_len in bytes */
  864.     int max_blindex;  /* index of last bit length code of non zero freq */
  865.  
  866.     flag_buf[last_flags] = flags; /* Save the flags for the last 8 items */
  867.  
  868.      /* Check if the file is ascii or binary */
  869.     if (*file_type == (ush)UNKNOWN) set_file_type();
  870.  
  871.     /* Construct the literal and distance trees */
  872.     build_tree((tree_desc near *)(&l_desc));
  873.     Tracev((stderr, "\nlit data: dyn %ld, stat %ld", opt_len, static_len));
  874.  
  875.     build_tree((tree_desc near *)(&d_desc));
  876.     Tracev((stderr, "\ndist data: dyn %ld, stat %ld", opt_len, static_len));
  877.     /* At this point, opt_len and static_len are the total bit lengths of
  878.      * the compressed block data, excluding the tree representations.
  879.      */
  880.  
  881.     /* Build the bit length tree for the above two trees, and get the index
  882.      * in bl_order of the last bit length code to send.
  883.      */
  884.     max_blindex = build_bl_tree();
  885.  
  886.     /* Determine the best encoding. Compute first the block length in bytes */
  887.     opt_lenb = (opt_len+3+7)>>3;
  888.     static_lenb = (static_len+3+7)>>3;
  889.     input_len += stored_len; /* for debugging only */
  890.  
  891.     Trace((stderr, "\nopt %lu(%lu) stat %lu(%lu) stored %lu lit %u dist %u ",
  892.             opt_lenb, opt_len, static_lenb, static_len, stored_len,
  893.             last_lit, last_dist));
  894.  
  895.     if (static_lenb <= opt_lenb) opt_lenb = static_lenb;
  896.  
  897.     /* If compression failed and this is the first and last block,
  898.      * and if the zip file can be seeked (to rewrite the local header),
  899.      * the whole file is transformed into a stored file:
  900.      */
  901. #ifdef FORCE_METHOD
  902.     if (level == 1 && eof && compressed_len == 0L) { /* force stored file */
  903. #else
  904.     if (stored_len <= opt_lenb && eof && compressed_len == 0L && seekable()) {
  905. #endif
  906.         /* Since LIT_BUFSIZE <= 2*WSIZE, the input data must be there: */
  907.         if (buf == (char*)0) error ("block vanished");
  908.  
  909.         copy_block(buf, (unsigned)stored_len, 0); /* without header */
  910.         compressed_len = stored_len << 3;
  911.         *file_method = STORED;
  912.  
  913. #ifdef FORCE_METHOD
  914.     } else if (level == 2 && buf != (char*)0) { /* force stored block */
  915. #else
  916.     } else if (stored_len+4 <= opt_lenb && buf != (char*)0) {
  917.                        /* 4: two words for the lengths */
  918. #endif
  919.         /* The test buf != NULL is only necessary if LIT_BUFSIZE > WSIZE.
  920.          * Otherwise we can't have processed more than WSIZE input bytes since
  921.          * the last block flush, because compression would have been
  922.          * successful. If LIT_BUFSIZE <= WSIZE, it is never too late to
  923.          * transform a block into a stored block.
  924.          */
  925.         send_bits((STORED_BLOCK<<1)+eof, 3);  /* send block type */
  926.         compressed_len = (compressed_len + 3 + 7) & ~7L;
  927.         compressed_len += (stored_len + 4) << 3;
  928.  
  929.         copy_block(buf, (unsigned)stored_len, 1); /* with header */
  930.  
  931. #ifdef FORCE_METHOD
  932.     } else if (level == 3) { /* force static trees */
  933. #else
  934.     } else if (static_lenb == opt_lenb) {
  935. #endif
  936.         send_bits((STATIC_TREES<<1)+eof, 3);
  937.         compress_block((ct_data near *)static_ltree, (ct_data near *)static_dtree);
  938.         compressed_len += 3 + static_len;
  939.     } else {
  940.         send_bits((DYN_TREES<<1)+eof, 3);
  941.         send_all_trees(l_desc.max_code+1, d_desc.max_code+1, max_blindex+1);
  942.         compress_block((ct_data near *)dyn_ltree, (ct_data near *)dyn_dtree);
  943.         compressed_len += 3 + opt_len;
  944.     }
  945.     Assert (compressed_len == bits_sent, "bad compressed size");
  946.     init_block();
  947.  
  948.     if (eof) {
  949.         Assert (input_len == isize, "bad input size");
  950.         bi_windup();
  951.         compressed_len += 7;  /* align on byte boundary */
  952.     }
  953.     Tracev((stderr,"\ncomprlen %lu(%lu) ", compressed_len>>3,
  954.            compressed_len-7*eof));
  955.  
  956.     return compressed_len >> 3;
  957. }
  958.  
  959. /* ===========================================================================
  960.  * Save the match info and tally the frequency counts. Return true if
  961.  * the current block must be flushed.
  962.  */
  963. int ct_tally (dist, lc)
  964.     int dist;  /* distance of matched string */
  965.     int lc;    /* match length-MIN_MATCH or unmatched char (if dist==0) */
  966. {
  967.     l_buf[last_lit++] = (uch)lc;
  968.     if (dist == 0) {
  969.         /* lc is the unmatched char */
  970.         dyn_ltree[lc].Freq++;
  971.     } else {
  972.         /* Here, lc is the match length - MIN_MATCH */
  973.         dist--;             /* dist = match distance - 1 */
  974.         Assert((ush)dist < (ush)MAX_DIST &&
  975.                (ush)lc <= (ush)(MAX_MATCH-MIN_MATCH) &&
  976.                (ush)d_code(dist) < (ush)D_CODES,  "ct_tally: bad match");
  977.  
  978.         dyn_ltree[length_code[lc]+LITERALS+1].Freq++;
  979.         dyn_dtree[d_code(dist)].Freq++;
  980.  
  981.         d_buf[last_dist++] = (ush)dist;
  982.         flags |= flag_bit;
  983.     }
  984.     flag_bit <<= 1;
  985.  
  986.     /* Output the flags if they fill a byte: */
  987.     if ((last_lit & 7) == 0) {
  988.         flag_buf[last_flags++] = flags;
  989.         flags = 0, flag_bit = 1;
  990.     }
  991.     /* Try to guess if it is profitable to stop the current block here */
  992.     if (level > 2 && (last_lit & 0xfff) == 0) {
  993.         /* Compute an upper bound for the compressed length */
  994.         ulg out_length = (ulg)last_lit*8L;
  995.         ulg in_length = (ulg)strstart-block_start;
  996.         int dcode;
  997.         for (dcode = 0; dcode < D_CODES; dcode++) {
  998.             out_length += (ulg)dyn_dtree[dcode].Freq*(5L+extra_dbits[dcode]);
  999.         }
  1000.         out_length >>= 3;
  1001.         Trace((stderr,"\nlast_lit %u, last_dist %u, in %ld, out ~%ld(%ld%%) ",
  1002.                last_lit, last_dist, in_length, out_length,
  1003.                100L - out_length*100L/in_length));
  1004.         if (last_dist < last_lit/2 && out_length < in_length/2) return 1;
  1005.     }
  1006.     return (last_lit == LIT_BUFSIZE-1 || last_dist == DIST_BUFSIZE);
  1007.     /* We avoid equality with LIT_BUFSIZE because of wraparound at 64K
  1008.      * on 16 bit machines and because stored blocks are restricted to
  1009.      * 64K-1 bytes.
  1010.      */
  1011. }
  1012.  
  1013. /* ===========================================================================
  1014.  * Send the block data compressed using the given Huffman trees
  1015.  */
  1016. local void compress_block(ltree, dtree)
  1017.     ct_data near *ltree; /* literal tree */
  1018.     ct_data near *dtree; /* distance tree */
  1019. {
  1020.     unsigned dist;      /* distance of matched string */
  1021.     int lc;             /* match length or unmatched char (if dist == 0) */
  1022.     unsigned lx = 0;    /* running index in l_buf */
  1023.     unsigned dx = 0;    /* running index in d_buf */
  1024.     unsigned fx = 0;    /* running index in flag_buf */
  1025.     uch flag = 0;       /* current flags */
  1026.     unsigned code;      /* the code to send */
  1027.     int extra;          /* number of extra bits to send */
  1028.  
  1029.     if (last_lit != 0) do {
  1030.         if ((lx & 7) == 0) flag = flag_buf[fx++];
  1031.         lc = l_buf[lx++];
  1032.         if ((flag & 1) == 0) {
  1033.             send_code(lc, ltree); /* send a literal byte */
  1034.             Tracecv(isgraph(lc), (stderr," '%c' ", lc));
  1035.         } else {
  1036.             /* Here, lc is the match length - MIN_MATCH */
  1037.             code = length_code[lc];
  1038.             send_code(code+LITERALS+1, ltree); /* send the length code */
  1039.             extra = extra_lbits[code];
  1040.             if (extra != 0) {
  1041.                 lc -= base_length[code];
  1042.                 send_bits(lc, extra);        /* send the extra length bits */
  1043.             }
  1044.             dist = d_buf[dx++];
  1045.             /* Here, dist is the match distance - 1 */
  1046.             code = d_code(dist);
  1047.             Assert (code < D_CODES, "bad d_code");
  1048.  
  1049.             send_code(code, dtree);       /* send the distance code */
  1050.             extra = extra_dbits[code];
  1051.             if (extra != 0) {
  1052.                 dist -= base_dist[code];
  1053.                 send_bits(dist, extra);   /* send the extra distance bits */
  1054.             }
  1055.         } /* literal or match pair ? */
  1056.         flag >>= 1;
  1057.     } while (lx < last_lit);
  1058.  
  1059.     send_code(END_BLOCK, ltree);
  1060. }
  1061.  
  1062. /* ===========================================================================
  1063.  * Set the file type to ASCII or BINARY, using a crude approximation:
  1064.  * binary if more than 20% of the bytes are <= 6 or >= 128, ascii otherwise.
  1065.  * IN assertion: the fields freq of dyn_ltree are set and the total of all
  1066.  * frequencies does not exceed 64K (to fit in an int on 16 bit machines).
  1067.  */
  1068. local void set_file_type()
  1069. {
  1070.     int n = 0;
  1071.     unsigned ascii_freq = 0;
  1072.     unsigned bin_freq = 0;
  1073.     while (n < 7)        bin_freq += dyn_ltree[n++].Freq;
  1074.     while (n < 128)    ascii_freq += dyn_ltree[n++].Freq;
  1075.     while (n < LITERALS) bin_freq += dyn_ltree[n++].Freq;
  1076.     *file_type = bin_freq > (ascii_freq >> 2) ? BINARY : ASCII;
  1077.     if (*file_type == BINARY && translate_eol) {
  1078.         warn("-l used on binary file", "");
  1079.     }
  1080. }
  1081.