65f3054f7a16d24fb6abf42f27924ecbb1b1484b
[xonotic/netradiant.git] / libs / jpeg6 / jdhuff.h
1 /*\r
2  * jdhuff.h\r
3  *\r
4  * Copyright (C) 1991-1995, Thomas G. Lane.\r
5  * This file is part of the Independent JPEG Group's software.\r
6  * For conditions of distribution and use, see the accompanying README file.\r
7  *\r
8  * This file contains declarations for Huffman entropy decoding routines\r
9  * that are shared between the sequential decoder (jdhuff.c) and the\r
10  * progressive decoder (jdphuff.c).  No other modules need to see these.\r
11  */\r
12 \r
13 /* Short forms of external names for systems with brain-damaged linkers. */\r
14 \r
15 #ifdef NEED_SHORT_EXTERNAL_NAMES\r
16 #define jpeg_make_d_derived_tbl jMkDDerived\r
17 #define jpeg_fill_bit_buffer    jFilBitBuf\r
18 #define jpeg_huff_decode        jHufDecode\r
19 #endif /* NEED_SHORT_EXTERNAL_NAMES */\r
20 \r
21 \r
22 /* Derived data constructed for each Huffman table */\r
23 \r
24 #define HUFF_LOOKAHEAD  8       /* # of bits of lookahead */\r
25 \r
26 typedef struct {\r
27   /* Basic tables: (element [0] of each array is unused) */\r
28   INT32 mincode[17];            /* smallest code of length k */\r
29   INT32 maxcode[18];            /* largest code of length k (-1 if none) */\r
30   /* (maxcode[17] is a sentinel to ensure jpeg_huff_decode terminates) */\r
31   int valptr[17];               /* huffval[] index of 1st symbol of length k */\r
32 \r
33   /* Link to public Huffman table (needed only in jpeg_huff_decode) */\r
34   JHUFF_TBL *pub;\r
35 \r
36   /* Lookahead tables: indexed by the next HUFF_LOOKAHEAD bits of\r
37    * the input data stream.  If the next Huffman code is no more\r
38    * than HUFF_LOOKAHEAD bits long, we can obtain its length and\r
39    * the corresponding symbol directly from these tables.\r
40    */\r
41   int look_nbits[1<<HUFF_LOOKAHEAD]; /* # bits, or 0 if too long */\r
42   UINT8 look_sym[1<<HUFF_LOOKAHEAD]; /* symbol, or unused */\r
43 } d_derived_tbl;\r
44 \r
45 /* Expand a Huffman table definition into the derived format */\r
46 EXTERN void jpeg_make_d_derived_tbl JPP((j_decompress_ptr cinfo,\r
47                                 JHUFF_TBL * htbl, d_derived_tbl ** pdtbl));\r
48 \r
49 \r
50 /*\r
51  * Fetching the next N bits from the input stream is a time-critical operation\r
52  * for the Huffman decoders.  We implement it with a combination of inline\r
53  * macros and out-of-line subroutines.  Note that N (the number of bits\r
54  * demanded at one time) never exceeds 15 for JPEG use.\r
55  *\r
56  * We read source bytes into get_buffer and dole out bits as needed.\r
57  * If get_buffer already contains enough bits, they are fetched in-line\r
58  * by the macros CHECK_BIT_BUFFER and GET_BITS.  When there aren't enough\r
59  * bits, jpeg_fill_bit_buffer is called; it will attempt to fill get_buffer\r
60  * as full as possible (not just to the number of bits needed; this\r
61  * prefetching reduces the overhead cost of calling jpeg_fill_bit_buffer).\r
62  * Note that jpeg_fill_bit_buffer may return FALSE to indicate suspension.\r
63  * On TRUE return, jpeg_fill_bit_buffer guarantees that get_buffer contains\r
64  * at least the requested number of bits --- dummy zeroes are inserted if\r
65  * necessary.\r
66  */\r
67 \r
68 typedef INT32 bit_buf_type;     /* type of bit-extraction buffer */\r
69 #define BIT_BUF_SIZE  32        /* size of buffer in bits */\r
70 \r
71 /* If long is > 32 bits on your machine, and shifting/masking longs is\r
72  * reasonably fast, making bit_buf_type be long and setting BIT_BUF_SIZE\r
73  * appropriately should be a win.  Unfortunately we can't do this with\r
74  * something like  #define BIT_BUF_SIZE (sizeof(bit_buf_type)*8)\r
75  * because not all machines measure sizeof in 8-bit bytes.\r
76  */\r
77 \r
78 typedef struct {                /* Bitreading state saved across MCUs */\r
79   bit_buf_type get_buffer;      /* current bit-extraction buffer */\r
80   int bits_left;                /* # of unused bits in it */\r
81   boolean printed_eod;          /* flag to suppress multiple warning msgs */\r
82 } bitread_perm_state;\r
83 \r
84 typedef struct {                /* Bitreading working state within an MCU */\r
85   /* current data source state */\r
86   const JOCTET * next_input_byte; /* => next byte to read from source */\r
87   size_t bytes_in_buffer;       /* # of bytes remaining in source buffer */\r
88   int unread_marker;            /* nonzero if we have hit a marker */\r
89   /* bit input buffer --- note these values are kept in register variables,\r
90    * not in this struct, inside the inner loops.\r
91    */\r
92   bit_buf_type get_buffer;      /* current bit-extraction buffer */\r
93   int bits_left;                /* # of unused bits in it */\r
94   /* pointers needed by jpeg_fill_bit_buffer */\r
95   j_decompress_ptr cinfo;       /* back link to decompress master record */\r
96   boolean * printed_eod_ptr;    /* => flag in permanent state */\r
97 } bitread_working_state;\r
98 \r
99 /* Macros to declare and load/save bitread local variables. */\r
100 #define BITREAD_STATE_VARS  \\r
101         register bit_buf_type get_buffer;  \\r
102         register int bits_left;  \\r
103         bitread_working_state br_state\r
104 \r
105 #define BITREAD_LOAD_STATE(cinfop,permstate)  \\r
106         br_state.cinfo = cinfop; \\r
107         br_state.next_input_byte = cinfop->src->next_input_byte; \\r
108         br_state.bytes_in_buffer = cinfop->src->bytes_in_buffer; \\r
109         br_state.unread_marker = cinfop->unread_marker; \\r
110         get_buffer = permstate.get_buffer; \\r
111         bits_left = permstate.bits_left; \\r
112         br_state.printed_eod_ptr = & permstate.printed_eod\r
113 \r
114 #define BITREAD_SAVE_STATE(cinfop,permstate)  \\r
115         cinfop->src->next_input_byte = br_state.next_input_byte; \\r
116         cinfop->src->bytes_in_buffer = br_state.bytes_in_buffer; \\r
117         cinfop->unread_marker = br_state.unread_marker; \\r
118         permstate.get_buffer = get_buffer; \\r
119         permstate.bits_left = bits_left\r
120 \r
121 /*\r
122  * These macros provide the in-line portion of bit fetching.\r
123  * Use CHECK_BIT_BUFFER to ensure there are N bits in get_buffer\r
124  * before using GET_BITS, PEEK_BITS, or DROP_BITS.\r
125  * The variables get_buffer and bits_left are assumed to be locals,\r
126  * but the state struct might not be (jpeg_huff_decode needs this).\r
127  *      CHECK_BIT_BUFFER(state,n,action);\r
128  *              Ensure there are N bits in get_buffer; if suspend, take action.\r
129  *      val = GET_BITS(n);\r
130  *              Fetch next N bits.\r
131  *      val = PEEK_BITS(n);\r
132  *              Fetch next N bits without removing them from the buffer.\r
133  *      DROP_BITS(n);\r
134  *              Discard next N bits.\r
135  * The value N should be a simple variable, not an expression, because it\r
136  * is evaluated multiple times.\r
137  */\r
138 \r
139 #define CHECK_BIT_BUFFER(state,nbits,action) \\r
140         { if (bits_left < (nbits)) {  \\r
141             if (! jpeg_fill_bit_buffer(&(state),get_buffer,bits_left,nbits))  \\r
142               { action; }  \\r
143             get_buffer = (state).get_buffer; bits_left = (state).bits_left; } }\r
144 \r
145 #define GET_BITS(nbits) \\r
146         (((int) (get_buffer >> (bits_left -= (nbits)))) & ((1<<(nbits))-1))\r
147 \r
148 #define PEEK_BITS(nbits) \\r
149         (((int) (get_buffer >> (bits_left -  (nbits)))) & ((1<<(nbits))-1))\r
150 \r
151 #define DROP_BITS(nbits) \\r
152         (bits_left -= (nbits))\r
153 \r
154 /* Load up the bit buffer to a depth of at least nbits */\r
155 EXTERN boolean jpeg_fill_bit_buffer JPP((bitread_working_state * state,\r
156                 register bit_buf_type get_buffer, register int bits_left,\r
157                 int nbits));\r
158 \r
159 \r
160 /*\r
161  * Code for extracting next Huffman-coded symbol from input bit stream.\r
162  * Again, this is time-critical and we make the main paths be macros.\r
163  *\r
164  * We use a lookahead table to process codes of up to HUFF_LOOKAHEAD bits\r
165  * without looping.  Usually, more than 95% of the Huffman codes will be 8\r
166  * or fewer bits long.  The few overlength codes are handled with a loop,\r
167  * which need not be inline code.\r
168  *\r
169  * Notes about the HUFF_DECODE macro:\r
170  * 1. Near the end of the data segment, we may fail to get enough bits\r
171  *    for a lookahead.  In that case, we do it the hard way.\r
172  * 2. If the lookahead table contains no entry, the next code must be\r
173  *    more than HUFF_LOOKAHEAD bits long.\r
174  * 3. jpeg_huff_decode returns -1 if forced to suspend.\r
175  */\r
176 \r
177 #define HUFF_DECODE(result,state,htbl,failaction,slowlabel) \\r
178 { register int nb, look; \\r
179   if (bits_left < HUFF_LOOKAHEAD) { \\r
180     if (! jpeg_fill_bit_buffer(&state,get_buffer,bits_left, 0)) {failaction;} \\r
181     get_buffer = state.get_buffer; bits_left = state.bits_left; \\r
182     if (bits_left < HUFF_LOOKAHEAD) { \\r
183       nb = 1; goto slowlabel; \\r
184     } \\r
185   } \\r
186   look = PEEK_BITS(HUFF_LOOKAHEAD); \\r
187   if ((nb = htbl->look_nbits[look]) != 0) { \\r
188     DROP_BITS(nb); \\r
189     result = htbl->look_sym[look]; \\r
190   } else { \\r
191     nb = HUFF_LOOKAHEAD+1; \\r
192 slowlabel: \\r
193     if ((result=jpeg_huff_decode(&state,get_buffer,bits_left,htbl,nb)) < 0) \\r
194         { failaction; } \\r
195     get_buffer = state.get_buffer; bits_left = state.bits_left; \\r
196   } \\r
197 }\r
198 \r
199 /* Out-of-line case for Huffman code fetching */\r
200 EXTERN int jpeg_huff_decode JPP((bitread_working_state * state,\r
201                 register bit_buf_type get_buffer, register int bits_left,\r
202                 d_derived_tbl * htbl, int min_bits));\r