istereo2

annotate libs/libjpeg/jdhuff.h @ 35:643f4ab609a4

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