inftrees.c

   1 /* inftrees.c -- generate Huffman trees for efficient decoding
   2  * Copyright (C) 1995-1998 Mark Adler
   3  * For conditions of distribution and use, see copyright notice in zlib.h
   4  */
   5
   6 #include "zutil.h"
   7 #include "inftrees.h"
   8
   9 const char inflate_copyright[] =
  10    " inflate 1.0.9 Copyright 1995-1998 Mark Adler ";
  11 /*
  12   If you use the zlib library in a product, an acknowledgment is welcome
  13   in the documentation of your product. If for some reason you cannot
  14   include such an acknowledgment, I would appreciate that you keep this
  15   copyright string in the executable of your product.
  16  */
  17 struct internal_state  {int dummy;}; /* for buggy compilers */
  18
  19 /* simplify the use of the inflate_huft type with some defines */
  20 #define base more.Base
  21 #define next more.Next
  22 #define exop word.what.Exop
  23 #define bits word.what.Bits
  24
  25
  26 local int huft_build OF((
  27     uIntf *,            /* code lengths in bits */
  28     uInt,               /* number of codes */
  29     uInt,               /* number of "simple" codes */
  30     const uIntf *,      /* list of base values for non-simple codes */
  31     const uIntf *,      /* list of extra bits for non-simple codes */
  32     inflate_huft * FAR*,/* result: starting table */
  33     uIntf *,            /* maximum lookup bits (returns actual) */
  34     inflate_huft *,     /* space for trees */
  35     uInt *,             /* hufts used in space */
  36     uIntf * ));         /* space for values */
  37
  38 /* Tables for deflate from PKZIP's appnote.txt. */
  39 local const uInt cplens[31] = { /* Copy lengths for literal codes 257..285 */
  40         3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 15, 17, 19, 23, 27, 31,
  41         35, 43, 51, 59, 67, 83, 99, 115, 131, 163, 195, 227, 258, 0, 0};
  42         /* see note #13 above about 258 */
  43 local const uInt cplext[31] = { /* Extra bits for literal codes 257..285 */
  44         0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 2, 2, 2, 2,
  45         3, 3, 3, 3, 4, 4, 4, 4, 5, 5, 5, 5, 0, 112, 112}; /* 112==invalid */
  46 local const uInt cpdist[30] = { /* Copy offsets for distance codes 0..29 */
  47         1, 2, 3, 4, 5, 7, 9, 13, 17, 25, 33, 49, 65, 97, 129, 193,
  48         257, 385, 513, 769, 1025, 1537, 2049, 3073, 4097, 6145,
  49         8193, 12289, 16385, 24577};
  50 local const uInt cpdext[30] = { /* Extra bits for distance codes */
  51         0, 0, 0, 0, 1, 1, 2, 2, 3, 3, 4, 4, 5, 5, 6, 6,
  52         7, 7, 8, 8, 9, 9, 10, 10, 11, 11,
  53         12, 12, 13, 13};
  54
  55 /*
  56    Huffman code decoding is performed using a multi-level table lookup.
  57    The fastest way to decode is to simply build a lookup table whose
  58    size is determined by the longest code.  However, the time it takes
  59    to build this table can also be a factor if the data being decoded
  60    is not very long.  The most common codes are necessarily the
  61    shortest codes, so those codes dominate the decoding time, and hence
  62    the speed.  The idea is you can have a shorter table that decodes the
  63    shorter, more probable codes, and then point to subsidiary tables for
  64    the longer codes.  The time it costs to decode the longer codes is
  65    then traded against the time it takes to make longer tables.
  66
  67    This results of this trade are in the variables lbits and dbits
  68    below.  lbits is the number of bits the first level table for literal/
  69    length codes can decode in one step, and dbits is the same thing for
  70    the distance codes.  Subsequent tables are also less than or equal to
  71    those sizes.  These values may be adjusted either when all of the
  72    codes are shorter than that, in which case the longest code length in
  73    bits is used, or when the shortest code is *longer* than the requested
  74    table size, in which case the length of the shortest code in bits is
  75    used.
  76
  77    There are two different values for the two tables, since they code a
  78    different number of possibilities each.  The literal/length table
  79    codes 286 possible values, or in a flat code, a little over eight
  80    bits.  The distance table codes 30 possible values, or a little less
  81    than five bits, flat.  The optimum values for speed end up being
  82    about one bit more than those, so lbits is 8+1 and dbits is 5+1.
  83    The optimum values may differ though from machine to machine, and
  84    possibly even between compilers.  Your mileage may vary.
  85  */
  86
  87
  88 /* If BMAX needs to be larger than 16, then h and x[] should be uLong. */
  89 #define BMAX 15         /* maximum bit length of any code */
  90
  91 local int huft_build(b, n, s, d, e, t, m, hp, hn, v)
  92 uIntf *b;               /* code lengths in bits (all assumed <= BMAX) */
  93 uInt n;                 /* number of codes (assumed <= 288) */
  94 uInt s;                 /* number of simple-valued codes (0..s-1) */
  95 const uIntf *d;         /* list of base values for non-simple codes */
  96 const uIntf *e;         /* list of extra bits for non-simple codes */
  97 inflate_huft * FAR *t;  /* result: starting table */
  98 uIntf *m;               /* maximum lookup bits, returns actual */
  99 inflate_huft *hp;       /* space for trees */
 100 uInt *hn;               /* hufts used in space */
 101 uIntf *v;               /* working area: values in order of bit length */
 102 /* Given a list of code lengths and a maximum table size, make a set of
 103    tables to decode that set of codes.  Return Z_OK on success, Z_BUF_ERROR
 104    if the given code set is incomplete (the tables are still built in this
 105    case), Z_DATA_ERROR if the input is invalid (an over-subscribed set of
 106    lengths), or Z_MEM_ERROR if not enough memory. */
 107 {
 108
 109   uInt a;                       /* counter for codes of length k */
 110   uInt c[BMAX+1];               /* bit length count table */
 111   uInt f;                       /* i repeats in table every f entries */
 112   int g;                        /* maximum code length */
 113   int h;                        /* table level */
 114   register uInt i;              /* counter, current code */
 115   register uInt j;              /* counter */
 116   register int k;               /* number of bits in current code */
 117   int l;                        /* bits per table (returned in m) */
 118   uInt mask;                    /* (1 << w) - 1, to avoid cc -O bug on HP */
 119   register uIntf *p;            /* pointer into c[], b[], or v[] */
 120   inflate_huft *q;              /* points to current table */
 121   struct inflate_huft_s r;      /* table entry for structure assignment */
 122   inflate_huft *u[BMAX];        /* table stack */
 123   register int w;               /* bits before this table == (l * h) */
 124   uInt x[BMAX+1];               /* bit offsets, then code stack */
 125   uIntf *xp;                    /* pointer into x */
 126   int y;                        /* number of dummy codes added */
 127   uInt z;                       /* number of entries in current table */
 128
 129
 130   /* Generate counts for each bit length */
 131   p = c;
 132 #define C0 *p++ = 0;
 133 #define C2 C0 C0 C0 C0
 134 #define C4 C2 C2 C2 C2
 135   C4                            /* clear c[]--assume BMAX+1 is 16 */
 136   p = b;  i = n;
 137   do {
 138     c[*p++]++;                  /* assume all entries <= BMAX */
 139   } while (--i);
 140   if (c[0] == n)                /* null input--all zero length codes */
 141   {
 142     *t = (inflate_huft *)Z_NULL;
 143     *m = 0;
 144     return Z_OK;
 145   }
 146
 147
 148   /* Find minimum and maximum length, bound *m by those */
 149   l = *m;
 150   for (j = 1; j <= BMAX; j++)
 151     if (c[j])
 152       break;
 153   k = j;                        /* minimum code length */
 154   if ((uInt)l < j)
 155     l = j;
 156   for (i = BMAX; i; i--)
 157     if (c[i])
 158       break;
 159   g = i;                        /* maximum code length */
 160   if ((uInt)l > i)
 161     l = i;
 162   *m = l;
 163
 164
 165   /* Adjust last length count to fill out codes, if needed */
 166   for (y = 1 << j; j < i; j++, y <<= 1)
 167     if ((y -= c[j]) < 0)
 168       return Z_DATA_ERROR;
 169   if ((y -= c[i]) < 0)
 170     return Z_DATA_ERROR;
 171   c[i] += y;
 172
 173
 174   /* Generate starting offsets into the value table for each length */
 175   x[1] = j = 0;
 176   p = c + 1;  xp = x + 2;
 177   while (--i) {                 /* note that i == g from above */
 178     *xp++ = (j += *p++);
 179   }
 180
 181
 182   /* Make a table of values in order of bit lengths */
 183   p = b;  i = 0;
 184   do {
 185     if ((j = *p++) != 0)
 186       v[x[j]++] = i;
 187   } while (++i < n);
 188   n = x[g];                     /* set n to length of v */
 189
 190
 191   /* Generate the Huffman codes and for each, make the table entries */
 192   x[0] = i = 0;                 /* first Huffman code is zero */
 193   p = v;                        /* grab values in bit order */
 194   h = -1;                       /* no tables yet--level -1 */
 195   w = -l;                       /* bits decoded == (l * h) */
 196   u[0] = (inflate_huft *)Z_NULL;        /* just to keep compilers happy */
 197   q = (inflate_huft *)Z_NULL;   /* ditto */
 198   z = 0;                        /* ditto */
 199
 200   /* go through the bit lengths (k already is bits in shortest code) */
 201   for (; k <= g; k++)
 202   {
 203     a = c[k];
 204     while (a--)
 205     {
 206       /* here i is the Huffman code of length k bits for value *p */
 207       /* make tables up to required level */
 208       while (k > w + l)
 209       {
 210         h++;
 211         w += l;                 /* previous table always l bits */
 212
 213         /* compute minimum size table less than or equal to l bits */
 214         z = g - w;
 215         z = z > (uInt)l ? l : z;        /* table size upper limit */
 216         if ((f = 1 << (j = k - w)) > a + 1)     /* try a k-w bit table */
 217         {                       /* too few codes for k-w bit table */
 218           f -= a + 1;           /* deduct codes from patterns left */
 219           xp = c + k;
 220           if (j < z)
 221             while (++j < z)     /* try smaller tables up to z bits */
 222             {
 223               if ((f <<= 1) <= *++xp)
 224                 break;          /* enough codes to use up j bits */
 225               f -= *xp;         /* else deduct codes from patterns */
 226             }
 227         }
 228         z = 1 << j;             /* table entries for j-bit table */
 229
 230         /* allocate new table */
 231         if (*hn + z > MANY)     /* (note: doesn't matter for fixed) */
 232           return Z_MEM_ERROR;   /* not enough memory */
 233         u[h] = q = hp + *hn;
 234         *hn += z;
 235         if (t != Z_NULL)        /* first table is returned result */
 236         {
 237           *t = q;
 238           t = Z_NULL;
 239         }
 240
 241         /* connect to last table, if there is one */
 242         if (h)
 243         {
 244           x[h] = i;             /* save pattern for backing up */
 245           r.bits = (Byte)l;     /* bits to dump before this table */
 246           r.exop = (Byte)j;     /* bits in this table */
 247           r.next = q;           /* pointer to this table */
 248           j = i >> (w - l);     /* (get around Turbo C bug) */
 249           u[h-1][j] = r;        /* connect to last table */
 250         }
 251       }
 252
 253       /* set up table entry in r */
 254       r.bits = (Byte)(k - w);
 255       if (p >= v + n)
 256         r.exop = 128 + 64;      /* out of values--invalid code */
 257       else if (*p < s)
 258       {
 259         r.exop = (Byte)(*p < 256 ? 0 : 32 + 64);     /* 256 is end-of-block */
 260         r.base = *p++;          /* simple code is just the value */
 261       }
 262       else
 263       {
 264         r.exop = (Byte)(e[*p - s] + 16 + 64);/* non-simple--look up in lists */
 265         r.base = d[*p++ - s];
 266       }
 267
 268       /* fill code-like entries with r */
 269       f = 1 << (k - w);
 270       for (j = i >> w; j < z; j += f)
 271         q[j] = r;
 272
 273       /* backwards increment the k-bit code i */
 274       for (j = 1 << (k - 1); i & j; j >>= 1)
 275         i ^= j;
 276       i ^= j;
 277
 278       /* backup over finished tables */
 279       mask = (1 << w) - 1;      /* needed on HP, cc -O bug */
 280       while ((i & mask) != x[h])
 281       {
 282         h--;                    /* don't need to update q */
 283         w -= l;
 284         mask = (1 << w) - 1;
 285       }
 286     }
 287   }
 288
 289
 290   /* Return Z_BUF_ERROR if we were given an incomplete table */
 291   return y != 0 && g != 1 ? Z_BUF_ERROR : Z_OK;
 292 }
 293
 294
 295 int inflate_trees_bits(c, bb, tb, hp, z)
 296 uIntf *c;               /* 19 code lengths */
 297 uIntf *bb;              /* bits tree desired/actual depth */
 298 inflate_huft * FAR *tb; /* bits tree result */
 299 inflate_huft *hp;       /* space for trees */
 300 z_streamp z;            /* for messages */
 301 {
 302   int r;
 303   uInt hn = 0;          /* hufts used in space */
 304   uIntf *v;             /* work area for huft_build */
 305
 306   if ((v = (uIntf*)ZALLOC(z, 19, sizeof(uInt))) == Z_NULL)
 307     return Z_MEM_ERROR;
 308   r = huft_build(c, 19, 19, (uIntf*)Z_NULL, (uIntf*)Z_NULL,
 309                  tb, bb, hp, &hn, v);
 310   if (r == Z_DATA_ERROR)
 311     z->msg = (char*)"oversubscribed dynamic bit lengths tree";
 312   else if (r == Z_BUF_ERROR || *bb == 0)
 313   {
 314     z->msg = (char*)"incomplete dynamic bit lengths tree";
 315     r = Z_DATA_ERROR;
 316   }
 317   ZFREE(z, v);
 318   return r;
 319 }
 320
 321
 322 int inflate_trees_dynamic(nl, nd, c, bl, bd, tl, td, hp, z)
 323 uInt nl;                /* number of literal/length codes */
 324 uInt nd;                /* number of distance codes */
 325 uIntf *c;               /* that many (total) code lengths */
 326 uIntf *bl;              /* literal desired/actual bit depth */
 327 uIntf *bd;              /* distance desired/actual bit depth */
 328 inflate_huft * FAR *tl; /* literal/length tree result */
 329 inflate_huft * FAR *td; /* distance tree result */
 330 inflate_huft *hp;       /* space for trees */
 331 z_streamp z;            /* for messages */
 332 {
 333   int r;
 334   uInt hn = 0;          /* hufts used in space */
 335   uIntf *v;             /* work area for huft_build */
 336
 337   /* allocate work area */
 338   if ((v = (uIntf*)ZALLOC(z, 288, sizeof(uInt))) == Z_NULL)
 339     return Z_MEM_ERROR;
 340
 341   /* build literal/length tree */
 342   r = huft_build(c, nl, 257, cplens, cplext, tl, bl, hp, &hn, v);
 343   if (r != Z_OK || *bl == 0)
 344   {
 345     if (r == Z_DATA_ERROR)
 346       z->msg = (char*)"oversubscribed literal/length tree";
 347     else if (r != Z_MEM_ERROR)
 348     {
 349       z->msg = (char*)"incomplete literal/length tree";
 350       r = Z_DATA_ERROR;
 351     }
 352     ZFREE(z, v);
 353     return r;
 354   }
 355
 356   /* build distance tree */
 357   r = huft_build(c + nl, nd, 0, cpdist, cpdext, td, bd, hp, &hn, v);
 358   if (r != Z_OK || (*bd == 0 && nl > 257))
 359   {
 360     if (r == Z_DATA_ERROR)
 361       z->msg = (char*)"oversubscribed distance tree";
 362     else if (r == Z_BUF_ERROR) {
 363 #ifdef PKZIP_BUG_WORKAROUND
 364       r = Z_OK;
 365     }
 366 #else
 367       z->msg = (char*)"incomplete distance tree";
 368       r = Z_DATA_ERROR;
 369     }
 370     else if (r != Z_MEM_ERROR)
 371     {
 372       z->msg = (char*)"empty distance tree with lengths";
 373       r = Z_DATA_ERROR;
 374     }
 375     ZFREE(z, v);
 376     return r;
 377 #endif
 378   }
 379
 380   /* done */
 381   ZFREE(z, v);
 382   return Z_OK;
 383 }
 384
 385
 386 /* build fixed tables only once--keep them here */
 387 local int fixed_built = 0;
 388 #define FIXEDH 424      /* number of hufts used by fixed tables */
 389 local inflate_huft fixed_mem[FIXEDH];
 390 local uInt fixed_bl;
 391 local uInt fixed_bd;
 392 local inflate_huft *fixed_tl;
 393 local inflate_huft *fixed_td;
 394
 395
 396 int inflate_trees_fixed(bl, bd, tl, td, z)
 397 uIntf *bl;               /* literal desired/actual bit depth */
 398 uIntf *bd;               /* distance desired/actual bit depth */
 399 inflate_huft * FAR *tl;  /* literal/length tree result */
 400 inflate_huft * FAR *td;  /* distance tree result */
 401 z_streamp z;             /* for memory allocation */
 402 {
 403   /* build fixed tables if not already (multiple overlapped executions ok) */
 404   if (!fixed_built)
 405   {
 406     int k;              /* temporary variable */
 407     uInt f = 0;         /* number of hufts used in fixed_mem */
 408     uIntf *c;           /* length list for huft_build */
 409     uIntf *v;           /* work area for huft_build */
 410
 411     /* allocate memory */
 412     if ((c = (uIntf*)ZALLOC(z, 288, sizeof(uInt))) == Z_NULL)
 413       return Z_MEM_ERROR;
 414     if ((v = (uIntf*)ZALLOC(z, 288, sizeof(uInt))) == Z_NULL)
 415     {
 416       ZFREE(z, c);
 417       return Z_MEM_ERROR;
 418     }
 419
 420     /* literal table */
 421     for (k = 0; k < 144; k++)
 422       c[k] = 8;
 423     for (; k < 256; k++)
 424       c[k] = 9;
 425     for (; k < 280; k++)
 426       c[k] = 7;
 427     for (; k < 288; k++)
 428       c[k] = 8;
 429     fixed_bl = 7;
 430     huft_build(c, 288, 257, cplens, cplext, &fixed_tl, &fixed_bl,
 431                fixed_mem, &f, v);
 432
 433     /* distance table */
 434     for (k = 0; k < 30; k++)
 435       c[k] = 5;
 436     fixed_bd = 5;
 437     huft_build(c, 30, 0, cpdist, cpdext, &fixed_td, &fixed_bd,
 438                fixed_mem, &f, v);
 439
 440     /* done */
 441     ZFREE(z, v);
 442     ZFREE(z, c);
 443     fixed_built = 1;
 444   }
 445   *bl = fixed_bl;
 446   *bd = fixed_bd;
 447   *tl = fixed_tl;
 448   *td = fixed_td;
 449   return Z_OK;
 450 }