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