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