annotate src/zlib-1.2.8/inftrees.h @ 43:5ea0608b923f

Current zlib source
author Chris Cannam
date Tue, 18 Oct 2016 14:33:52 +0100
parents
children
rev   line source
Chris@43 1 /* inftrees.h -- header to use inftrees.c
Chris@43 2 * Copyright (C) 1995-2005, 2010 Mark Adler
Chris@43 3 * For conditions of distribution and use, see copyright notice in zlib.h
Chris@43 4 */
Chris@43 5
Chris@43 6 /* WARNING: this file should *not* be used by applications. It is
Chris@43 7 part of the implementation of the compression library and is
Chris@43 8 subject to change. Applications should only use zlib.h.
Chris@43 9 */
Chris@43 10
Chris@43 11 /* Structure for decoding tables. Each entry provides either the
Chris@43 12 information needed to do the operation requested by the code that
Chris@43 13 indexed that table entry, or it provides a pointer to another
Chris@43 14 table that indexes more bits of the code. op indicates whether
Chris@43 15 the entry is a pointer to another table, a literal, a length or
Chris@43 16 distance, an end-of-block, or an invalid code. For a table
Chris@43 17 pointer, the low four bits of op is the number of index bits of
Chris@43 18 that table. For a length or distance, the low four bits of op
Chris@43 19 is the number of extra bits to get after the code. bits is
Chris@43 20 the number of bits in this code or part of the code to drop off
Chris@43 21 of the bit buffer. val is the actual byte to output in the case
Chris@43 22 of a literal, the base length or distance, or the offset from
Chris@43 23 the current table to the next table. Each entry is four bytes. */
Chris@43 24 typedef struct {
Chris@43 25 unsigned char op; /* operation, extra bits, table bits */
Chris@43 26 unsigned char bits; /* bits in this part of the code */
Chris@43 27 unsigned short val; /* offset in table or code value */
Chris@43 28 } code;
Chris@43 29
Chris@43 30 /* op values as set by inflate_table():
Chris@43 31 00000000 - literal
Chris@43 32 0000tttt - table link, tttt != 0 is the number of table index bits
Chris@43 33 0001eeee - length or distance, eeee is the number of extra bits
Chris@43 34 01100000 - end of block
Chris@43 35 01000000 - invalid code
Chris@43 36 */
Chris@43 37
Chris@43 38 /* Maximum size of the dynamic table. The maximum number of code structures is
Chris@43 39 1444, which is the sum of 852 for literal/length codes and 592 for distance
Chris@43 40 codes. These values were found by exhaustive searches using the program
Chris@43 41 examples/enough.c found in the zlib distribtution. The arguments to that
Chris@43 42 program are the number of symbols, the initial root table size, and the
Chris@43 43 maximum bit length of a code. "enough 286 9 15" for literal/length codes
Chris@43 44 returns returns 852, and "enough 30 6 15" for distance codes returns 592.
Chris@43 45 The initial root table size (9 or 6) is found in the fifth argument of the
Chris@43 46 inflate_table() calls in inflate.c and infback.c. If the root table size is
Chris@43 47 changed, then these maximum sizes would be need to be recalculated and
Chris@43 48 updated. */
Chris@43 49 #define ENOUGH_LENS 852
Chris@43 50 #define ENOUGH_DISTS 592
Chris@43 51 #define ENOUGH (ENOUGH_LENS+ENOUGH_DISTS)
Chris@43 52
Chris@43 53 /* Type of code to build for inflate_table() */
Chris@43 54 typedef enum {
Chris@43 55 CODES,
Chris@43 56 LENS,
Chris@43 57 DISTS
Chris@43 58 } codetype;
Chris@43 59
Chris@43 60 int ZLIB_INTERNAL inflate_table OF((codetype type, unsigned short FAR *lens,
Chris@43 61 unsigned codes, code FAR * FAR *table,
Chris@43 62 unsigned FAR *bits, unsigned short FAR *work));