nuclear@1: /*
nuclear@1:  * jchuff.c
nuclear@1:  *
nuclear@1:  * Copyright (C) 1991-1997, Thomas G. Lane.
nuclear@1:  * This file is part of the Independent JPEG Group's software.
nuclear@1:  * For conditions of distribution and use, see the accompanying README file.
nuclear@1:  *
nuclear@1:  * This file contains Huffman entropy encoding routines.
nuclear@1:  *
nuclear@1:  * Much of the complexity here has to do with supporting output suspension.
nuclear@1:  * If the data destination module demands suspension, we want to be able to
nuclear@1:  * back up to the start of the current MCU.  To do this, we copy state
nuclear@1:  * variables into local working storage, and update them back to the
nuclear@1:  * permanent JPEG objects only upon successful completion of an MCU.
nuclear@1:  */
nuclear@1: 
nuclear@1: #define JPEG_INTERNALS
nuclear@1: #include "jinclude.h"
nuclear@1: #include "jpeglib.h"
nuclear@1: #include "jchuff.h"		/* Declarations shared with jcphuff.c */
nuclear@1: 
nuclear@1: 
nuclear@1: /* Expanded entropy encoder object for Huffman encoding.
nuclear@1:  *
nuclear@1:  * The savable_state subrecord contains fields that change within an MCU,
nuclear@1:  * but must not be updated permanently until we complete the MCU.
nuclear@1:  */
nuclear@1: 
nuclear@1: typedef struct {
nuclear@1:   INT32 put_buffer;		/* current bit-accumulation buffer */
nuclear@1:   int put_bits;			/* # of bits now in it */
nuclear@1:   int last_dc_val[MAX_COMPS_IN_SCAN]; /* last DC coef for each component */
nuclear@1: } savable_state;
nuclear@1: 
nuclear@1: /* This macro is to work around compilers with missing or broken
nuclear@1:  * structure assignment.  You'll need to fix this code if you have
nuclear@1:  * such a compiler and you change MAX_COMPS_IN_SCAN.
nuclear@1:  */
nuclear@1: 
nuclear@1: #ifndef NO_STRUCT_ASSIGN
nuclear@1: #define ASSIGN_STATE(dest,src)  ((dest) = (src))
nuclear@1: #else
nuclear@1: #if MAX_COMPS_IN_SCAN == 4
nuclear@1: #define ASSIGN_STATE(dest,src)  \
nuclear@1: 	((dest).put_buffer = (src).put_buffer, \
nuclear@1: 	 (dest).put_bits = (src).put_bits, \
nuclear@1: 	 (dest).last_dc_val[0] = (src).last_dc_val[0], \
nuclear@1: 	 (dest).last_dc_val[1] = (src).last_dc_val[1], \
nuclear@1: 	 (dest).last_dc_val[2] = (src).last_dc_val[2], \
nuclear@1: 	 (dest).last_dc_val[3] = (src).last_dc_val[3])
nuclear@1: #endif
nuclear@1: #endif
nuclear@1: 
nuclear@1: 
nuclear@1: typedef struct {
nuclear@1:   struct jpeg_entropy_encoder pub; /* public fields */
nuclear@1: 
nuclear@1:   savable_state saved;		/* Bit buffer & DC state at start of MCU */
nuclear@1: 
nuclear@1:   /* These fields are NOT loaded into local working state. */
nuclear@1:   unsigned int restarts_to_go;	/* MCUs left in this restart interval */
nuclear@1:   int next_restart_num;		/* next restart number to write (0-7) */
nuclear@1: 
nuclear@1:   /* Pointers to derived tables (these workspaces have image lifespan) */
nuclear@1:   c_derived_tbl * dc_derived_tbls[NUM_HUFF_TBLS];
nuclear@1:   c_derived_tbl * ac_derived_tbls[NUM_HUFF_TBLS];
nuclear@1: 
nuclear@1: #ifdef ENTROPY_OPT_SUPPORTED	/* Statistics tables for optimization */
nuclear@1:   long * dc_count_ptrs[NUM_HUFF_TBLS];
nuclear@1:   long * ac_count_ptrs[NUM_HUFF_TBLS];
nuclear@1: #endif
nuclear@1: } huff_entropy_encoder;
nuclear@1: 
nuclear@1: typedef huff_entropy_encoder * huff_entropy_ptr;
nuclear@1: 
nuclear@1: /* Working state while writing an MCU.
nuclear@1:  * This struct contains all the fields that are needed by subroutines.
nuclear@1:  */
nuclear@1: 
nuclear@1: typedef struct {
nuclear@1:   JOCTET * next_output_byte;	/* => next byte to write in buffer */
nuclear@1:   size_t free_in_buffer;	/* # of byte spaces remaining in buffer */
nuclear@1:   savable_state cur;		/* Current bit buffer & DC state */
nuclear@1:   j_compress_ptr cinfo;		/* dump_buffer needs access to this */
nuclear@1: } working_state;
nuclear@1: 
nuclear@1: 
nuclear@1: /* Forward declarations */
nuclear@1: METHODDEF(boolean) encode_mcu_huff JPP((j_compress_ptr cinfo,
nuclear@1: 					JBLOCKROW *MCU_data));
nuclear@1: METHODDEF(void) finish_pass_huff JPP((j_compress_ptr cinfo));
nuclear@1: #ifdef ENTROPY_OPT_SUPPORTED
nuclear@1: METHODDEF(boolean) encode_mcu_gather JPP((j_compress_ptr cinfo,
nuclear@1: 					  JBLOCKROW *MCU_data));
nuclear@1: METHODDEF(void) finish_pass_gather JPP((j_compress_ptr cinfo));
nuclear@1: #endif
nuclear@1: 
nuclear@1: 
nuclear@1: /*
nuclear@1:  * Initialize for a Huffman-compressed scan.
nuclear@1:  * If gather_statistics is TRUE, we do not output anything during the scan,
nuclear@1:  * just count the Huffman symbols used and generate Huffman code tables.
nuclear@1:  */
nuclear@1: 
nuclear@1: METHODDEF(void)
nuclear@1: start_pass_huff (j_compress_ptr cinfo, boolean gather_statistics)
nuclear@1: {
nuclear@1:   huff_entropy_ptr entropy = (huff_entropy_ptr) cinfo->entropy;
nuclear@1:   int ci, dctbl, actbl;
nuclear@1:   jpeg_component_info * compptr;
nuclear@1: 
nuclear@1:   if (gather_statistics) {
nuclear@1: #ifdef ENTROPY_OPT_SUPPORTED
nuclear@1:     entropy->pub.encode_mcu = encode_mcu_gather;
nuclear@1:     entropy->pub.finish_pass = finish_pass_gather;
nuclear@1: #else
nuclear@1:     ERREXIT(cinfo, JERR_NOT_COMPILED);
nuclear@1: #endif
nuclear@1:   } else {
nuclear@1:     entropy->pub.encode_mcu = encode_mcu_huff;
nuclear@1:     entropy->pub.finish_pass = finish_pass_huff;
nuclear@1:   }
nuclear@1: 
nuclear@1:   for (ci = 0; ci < cinfo->comps_in_scan; ci++) {
nuclear@1:     compptr = cinfo->cur_comp_info[ci];
nuclear@1:     dctbl = compptr->dc_tbl_no;
nuclear@1:     actbl = compptr->ac_tbl_no;
nuclear@1:     if (gather_statistics) {
nuclear@1: #ifdef ENTROPY_OPT_SUPPORTED
nuclear@1:       /* Check for invalid table indexes */
nuclear@1:       /* (make_c_derived_tbl does this in the other path) */
nuclear@1:       if (dctbl < 0 || dctbl >= NUM_HUFF_TBLS)
nuclear@1: 	ERREXIT1(cinfo, JERR_NO_HUFF_TABLE, dctbl);
nuclear@1:       if (actbl < 0 || actbl >= NUM_HUFF_TBLS)
nuclear@1: 	ERREXIT1(cinfo, JERR_NO_HUFF_TABLE, actbl);
nuclear@1:       /* Allocate and zero the statistics tables */
nuclear@1:       /* Note that jpeg_gen_optimal_table expects 257 entries in each table! */
nuclear@1:       if (entropy->dc_count_ptrs[dctbl] == NULL)
nuclear@1: 	entropy->dc_count_ptrs[dctbl] = (long *)
nuclear@1: 	  (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_IMAGE,
nuclear@1: 				      257 * SIZEOF(long));
nuclear@1:       MEMZERO(entropy->dc_count_ptrs[dctbl], 257 * SIZEOF(long));
nuclear@1:       if (entropy->ac_count_ptrs[actbl] == NULL)
nuclear@1: 	entropy->ac_count_ptrs[actbl] = (long *)
nuclear@1: 	  (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_IMAGE,
nuclear@1: 				      257 * SIZEOF(long));
nuclear@1:       MEMZERO(entropy->ac_count_ptrs[actbl], 257 * SIZEOF(long));
nuclear@1: #endif
nuclear@1:     } else {
nuclear@1:       /* Compute derived values for Huffman tables */
nuclear@1:       /* We may do this more than once for a table, but it's not expensive */
nuclear@1:       jpeg_make_c_derived_tbl(cinfo, TRUE, dctbl,
nuclear@1: 			      & entropy->dc_derived_tbls[dctbl]);
nuclear@1:       jpeg_make_c_derived_tbl(cinfo, FALSE, actbl,
nuclear@1: 			      & entropy->ac_derived_tbls[actbl]);
nuclear@1:     }
nuclear@1:     /* Initialize DC predictions to 0 */
nuclear@1:     entropy->saved.last_dc_val[ci] = 0;
nuclear@1:   }
nuclear@1: 
nuclear@1:   /* Initialize bit buffer to empty */
nuclear@1:   entropy->saved.put_buffer = 0;
nuclear@1:   entropy->saved.put_bits = 0;
nuclear@1: 
nuclear@1:   /* Initialize restart stuff */
nuclear@1:   entropy->restarts_to_go = cinfo->restart_interval;
nuclear@1:   entropy->next_restart_num = 0;
nuclear@1: }
nuclear@1: 
nuclear@1: 
nuclear@1: /*
nuclear@1:  * Compute the derived values for a Huffman table.
nuclear@1:  * This routine also performs some validation checks on the table.
nuclear@1:  *
nuclear@1:  * Note this is also used by jcphuff.c.
nuclear@1:  */
nuclear@1: 
nuclear@1: GLOBAL(void)
nuclear@1: jpeg_make_c_derived_tbl (j_compress_ptr cinfo, boolean isDC, int tblno,
nuclear@1: 			 c_derived_tbl ** pdtbl)
nuclear@1: {
nuclear@1:   JHUFF_TBL *htbl;
nuclear@1:   c_derived_tbl *dtbl;
nuclear@1:   int p, i, l, lastp, si, maxsymbol;
nuclear@1:   char huffsize[257];
nuclear@1:   unsigned int huffcode[257];
nuclear@1:   unsigned int code;
nuclear@1: 
nuclear@1:   /* Note that huffsize[] and huffcode[] are filled in code-length order,
nuclear@1:    * paralleling the order of the symbols themselves in htbl->huffval[].
nuclear@1:    */
nuclear@1: 
nuclear@1:   /* Find the input Huffman table */
nuclear@1:   if (tblno < 0 || tblno >= NUM_HUFF_TBLS)
nuclear@1:     ERREXIT1(cinfo, JERR_NO_HUFF_TABLE, tblno);
nuclear@1:   htbl =
nuclear@1:     isDC ? cinfo->dc_huff_tbl_ptrs[tblno] : cinfo->ac_huff_tbl_ptrs[tblno];
nuclear@1:   if (htbl == NULL)
nuclear@1:     ERREXIT1(cinfo, JERR_NO_HUFF_TABLE, tblno);
nuclear@1: 
nuclear@1:   /* Allocate a workspace if we haven't already done so. */
nuclear@1:   if (*pdtbl == NULL)
nuclear@1:     *pdtbl = (c_derived_tbl *)
nuclear@1:       (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_IMAGE,
nuclear@1: 				  SIZEOF(c_derived_tbl));
nuclear@1:   dtbl = *pdtbl;
nuclear@1:   
nuclear@1:   /* Figure C.1: make table of Huffman code length for each symbol */
nuclear@1: 
nuclear@1:   p = 0;
nuclear@1:   for (l = 1; l <= 16; l++) {
nuclear@1:     i = (int) htbl->bits[l];
nuclear@1:     if (i < 0 || p + i > 256)	/* protect against table overrun */
nuclear@1:       ERREXIT(cinfo, JERR_BAD_HUFF_TABLE);
nuclear@1:     while (i--)
nuclear@1:       huffsize[p++] = (char) l;
nuclear@1:   }
nuclear@1:   huffsize[p] = 0;
nuclear@1:   lastp = p;
nuclear@1:   
nuclear@1:   /* Figure C.2: generate the codes themselves */
nuclear@1:   /* We also validate that the counts represent a legal Huffman code tree. */
nuclear@1: 
nuclear@1:   code = 0;
nuclear@1:   si = huffsize[0];
nuclear@1:   p = 0;
nuclear@1:   while (huffsize[p]) {
nuclear@1:     while (((int) huffsize[p]) == si) {
nuclear@1:       huffcode[p++] = code;
nuclear@1:       code++;
nuclear@1:     }
nuclear@1:     /* code is now 1 more than the last code used for codelength si; but
nuclear@1:      * it must still fit in si bits, since no code is allowed to be all ones.
nuclear@1:      */
nuclear@1:     if (((INT32) code) >= (((INT32) 1) << si))
nuclear@1:       ERREXIT(cinfo, JERR_BAD_HUFF_TABLE);
nuclear@1:     code <<= 1;
nuclear@1:     si++;
nuclear@1:   }
nuclear@1:   
nuclear@1:   /* Figure C.3: generate encoding tables */
nuclear@1:   /* These are code and size indexed by symbol value */
nuclear@1: 
nuclear@1:   /* Set all codeless symbols to have code length 0;
nuclear@1:    * this lets us detect duplicate VAL entries here, and later
nuclear@1:    * allows emit_bits to detect any attempt to emit such symbols.
nuclear@1:    */
nuclear@1:   MEMZERO(dtbl->ehufsi, SIZEOF(dtbl->ehufsi));
nuclear@1: 
nuclear@1:   /* This is also a convenient place to check for out-of-range
nuclear@1:    * and duplicated VAL entries.  We allow 0..255 for AC symbols
nuclear@1:    * but only 0..15 for DC.  (We could constrain them further
nuclear@1:    * based on data depth and mode, but this seems enough.)
nuclear@1:    */
nuclear@1:   maxsymbol = isDC ? 15 : 255;
nuclear@1: 
nuclear@1:   for (p = 0; p < lastp; p++) {
nuclear@1:     i = htbl->huffval[p];
nuclear@1:     if (i < 0 || i > maxsymbol || dtbl->ehufsi[i])
nuclear@1:       ERREXIT(cinfo, JERR_BAD_HUFF_TABLE);
nuclear@1:     dtbl->ehufco[i] = huffcode[p];
nuclear@1:     dtbl->ehufsi[i] = huffsize[p];
nuclear@1:   }
nuclear@1: }
nuclear@1: 
nuclear@1: 
nuclear@1: /* Outputting bytes to the file */
nuclear@1: 
nuclear@1: /* Emit a byte, taking 'action' if must suspend. */
nuclear@1: #define emit_byte(state,val,action)  \
nuclear@1: 	{ *(state)->next_output_byte++ = (JOCTET) (val);  \
nuclear@1: 	  if (--(state)->free_in_buffer == 0)  \
nuclear@1: 	    if (! dump_buffer(state))  \
nuclear@1: 	      { action; } }
nuclear@1: 
nuclear@1: 
nuclear@1: LOCAL(boolean)
nuclear@1: dump_buffer (working_state * state)
nuclear@1: /* Empty the output buffer; return TRUE if successful, FALSE if must suspend */
nuclear@1: {
nuclear@1:   struct jpeg_destination_mgr * dest = state->cinfo->dest;
nuclear@1: 
nuclear@1:   if (! (*dest->empty_output_buffer) (state->cinfo))
nuclear@1:     return FALSE;
nuclear@1:   /* After a successful buffer dump, must reset buffer pointers */
nuclear@1:   state->next_output_byte = dest->next_output_byte;
nuclear@1:   state->free_in_buffer = dest->free_in_buffer;
nuclear@1:   return TRUE;
nuclear@1: }
nuclear@1: 
nuclear@1: 
nuclear@1: /* Outputting bits to the file */
nuclear@1: 
nuclear@1: /* Only the right 24 bits of put_buffer are used; the valid bits are
nuclear@1:  * left-justified in this part.  At most 16 bits can be passed to emit_bits
nuclear@1:  * in one call, and we never retain more than 7 bits in put_buffer
nuclear@1:  * between calls, so 24 bits are sufficient.
nuclear@1:  */
nuclear@1: 
nuclear@1: INLINE
nuclear@1: LOCAL(boolean)
nuclear@1: emit_bits (working_state * state, unsigned int code, int size)
nuclear@1: /* Emit some bits; return TRUE if successful, FALSE if must suspend */
nuclear@1: {
nuclear@1:   /* This routine is heavily used, so it's worth coding tightly. */
nuclear@1:   register INT32 put_buffer = (INT32) code;
nuclear@1:   register int put_bits = state->cur.put_bits;
nuclear@1: 
nuclear@1:   /* if size is 0, caller used an invalid Huffman table entry */
nuclear@1:   if (size == 0)
nuclear@1:     ERREXIT(state->cinfo, JERR_HUFF_MISSING_CODE);
nuclear@1: 
nuclear@1:   put_buffer &= (((INT32) 1)<<size) - 1; /* mask off any extra bits in code */
nuclear@1:   
nuclear@1:   put_bits += size;		/* new number of bits in buffer */
nuclear@1:   
nuclear@1:   put_buffer <<= 24 - put_bits; /* align incoming bits */
nuclear@1: 
nuclear@1:   put_buffer |= state->cur.put_buffer; /* and merge with old buffer contents */
nuclear@1:   
nuclear@1:   while (put_bits >= 8) {
nuclear@1:     int c = (int) ((put_buffer >> 16) & 0xFF);
nuclear@1:     
nuclear@1:     emit_byte(state, c, return FALSE);
nuclear@1:     if (c == 0xFF) {		/* need to stuff a zero byte? */
nuclear@1:       emit_byte(state, 0, return FALSE);
nuclear@1:     }
nuclear@1:     put_buffer <<= 8;
nuclear@1:     put_bits -= 8;
nuclear@1:   }
nuclear@1: 
nuclear@1:   state->cur.put_buffer = put_buffer; /* update state variables */
nuclear@1:   state->cur.put_bits = put_bits;
nuclear@1: 
nuclear@1:   return TRUE;
nuclear@1: }
nuclear@1: 
nuclear@1: 
nuclear@1: LOCAL(boolean)
nuclear@1: flush_bits (working_state * state)
nuclear@1: {
nuclear@1:   if (! emit_bits(state, 0x7F, 7)) /* fill any partial byte with ones */
nuclear@1:     return FALSE;
nuclear@1:   state->cur.put_buffer = 0;	/* and reset bit-buffer to empty */
nuclear@1:   state->cur.put_bits = 0;
nuclear@1:   return TRUE;
nuclear@1: }
nuclear@1: 
nuclear@1: 
nuclear@1: /* Encode a single block's worth of coefficients */
nuclear@1: 
nuclear@1: LOCAL(boolean)
nuclear@1: encode_one_block (working_state * state, JCOEFPTR block, int last_dc_val,
nuclear@1: 		  c_derived_tbl *dctbl, c_derived_tbl *actbl)
nuclear@1: {
nuclear@1:   register int temp, temp2;
nuclear@1:   register int nbits;
nuclear@1:   register int k, r, i;
nuclear@1:   
nuclear@1:   /* Encode the DC coefficient difference per section F.1.2.1 */
nuclear@1:   
nuclear@1:   temp = temp2 = block[0] - last_dc_val;
nuclear@1: 
nuclear@1:   if (temp < 0) {
nuclear@1:     temp = -temp;		/* temp is abs value of input */
nuclear@1:     /* For a negative input, want temp2 = bitwise complement of abs(input) */
nuclear@1:     /* This code assumes we are on a two's complement machine */
nuclear@1:     temp2--;
nuclear@1:   }
nuclear@1:   
nuclear@1:   /* Find the number of bits needed for the magnitude of the coefficient */
nuclear@1:   nbits = 0;
nuclear@1:   while (temp) {
nuclear@1:     nbits++;
nuclear@1:     temp >>= 1;
nuclear@1:   }
nuclear@1:   /* Check for out-of-range coefficient values.
nuclear@1:    * Since we're encoding a difference, the range limit is twice as much.
nuclear@1:    */
nuclear@1:   if (nbits > MAX_COEF_BITS+1)
nuclear@1:     ERREXIT(state->cinfo, JERR_BAD_DCT_COEF);
nuclear@1:   
nuclear@1:   /* Emit the Huffman-coded symbol for the number of bits */
nuclear@1:   if (! emit_bits(state, dctbl->ehufco[nbits], dctbl->ehufsi[nbits]))
nuclear@1:     return FALSE;
nuclear@1: 
nuclear@1:   /* Emit that number of bits of the value, if positive, */
nuclear@1:   /* or the complement of its magnitude, if negative. */
nuclear@1:   if (nbits)			/* emit_bits rejects calls with size 0 */
nuclear@1:     if (! emit_bits(state, (unsigned int) temp2, nbits))
nuclear@1:       return FALSE;
nuclear@1: 
nuclear@1:   /* Encode the AC coefficients per section F.1.2.2 */
nuclear@1:   
nuclear@1:   r = 0;			/* r = run length of zeros */
nuclear@1:   
nuclear@1:   for (k = 1; k < DCTSIZE2; k++) {
nuclear@1:     if ((temp = block[jpeg_natural_order[k]]) == 0) {
nuclear@1:       r++;
nuclear@1:     } else {
nuclear@1:       /* if run length > 15, must emit special run-length-16 codes (0xF0) */
nuclear@1:       while (r > 15) {
nuclear@1: 	if (! emit_bits(state, actbl->ehufco[0xF0], actbl->ehufsi[0xF0]))
nuclear@1: 	  return FALSE;
nuclear@1: 	r -= 16;
nuclear@1:       }
nuclear@1: 
nuclear@1:       temp2 = temp;
nuclear@1:       if (temp < 0) {
nuclear@1: 	temp = -temp;		/* temp is abs value of input */
nuclear@1: 	/* This code assumes we are on a two's complement machine */
nuclear@1: 	temp2--;
nuclear@1:       }
nuclear@1:       
nuclear@1:       /* Find the number of bits needed for the magnitude of the coefficient */
nuclear@1:       nbits = 1;		/* there must be at least one 1 bit */
nuclear@1:       while ((temp >>= 1))
nuclear@1: 	nbits++;
nuclear@1:       /* Check for out-of-range coefficient values */
nuclear@1:       if (nbits > MAX_COEF_BITS)
nuclear@1: 	ERREXIT(state->cinfo, JERR_BAD_DCT_COEF);
nuclear@1:       
nuclear@1:       /* Emit Huffman symbol for run length / number of bits */
nuclear@1:       i = (r << 4) + nbits;
nuclear@1:       if (! emit_bits(state, actbl->ehufco[i], actbl->ehufsi[i]))
nuclear@1: 	return FALSE;
nuclear@1: 
nuclear@1:       /* Emit that number of bits of the value, if positive, */
nuclear@1:       /* or the complement of its magnitude, if negative. */
nuclear@1:       if (! emit_bits(state, (unsigned int) temp2, nbits))
nuclear@1: 	return FALSE;
nuclear@1:       
nuclear@1:       r = 0;
nuclear@1:     }
nuclear@1:   }
nuclear@1: 
nuclear@1:   /* If the last coef(s) were zero, emit an end-of-block code */
nuclear@1:   if (r > 0)
nuclear@1:     if (! emit_bits(state, actbl->ehufco[0], actbl->ehufsi[0]))
nuclear@1:       return FALSE;
nuclear@1: 
nuclear@1:   return TRUE;
nuclear@1: }
nuclear@1: 
nuclear@1: 
nuclear@1: /*
nuclear@1:  * Emit a restart marker & resynchronize predictions.
nuclear@1:  */
nuclear@1: 
nuclear@1: LOCAL(boolean)
nuclear@1: emit_restart (working_state * state, int restart_num)
nuclear@1: {
nuclear@1:   int ci;
nuclear@1: 
nuclear@1:   if (! flush_bits(state))
nuclear@1:     return FALSE;
nuclear@1: 
nuclear@1:   emit_byte(state, 0xFF, return FALSE);
nuclear@1:   emit_byte(state, JPEG_RST0 + restart_num, return FALSE);
nuclear@1: 
nuclear@1:   /* Re-initialize DC predictions to 0 */
nuclear@1:   for (ci = 0; ci < state->cinfo->comps_in_scan; ci++)
nuclear@1:     state->cur.last_dc_val[ci] = 0;
nuclear@1: 
nuclear@1:   /* The restart counter is not updated until we successfully write the MCU. */
nuclear@1: 
nuclear@1:   return TRUE;
nuclear@1: }
nuclear@1: 
nuclear@1: 
nuclear@1: /*
nuclear@1:  * Encode and output one MCU's worth of Huffman-compressed coefficients.
nuclear@1:  */
nuclear@1: 
nuclear@1: METHODDEF(boolean)
nuclear@1: encode_mcu_huff (j_compress_ptr cinfo, JBLOCKROW *MCU_data)
nuclear@1: {
nuclear@1:   huff_entropy_ptr entropy = (huff_entropy_ptr) cinfo->entropy;
nuclear@1:   working_state state;
nuclear@1:   int blkn, ci;
nuclear@1:   jpeg_component_info * compptr;
nuclear@1: 
nuclear@1:   /* Load up working state */
nuclear@1:   state.next_output_byte = cinfo->dest->next_output_byte;
nuclear@1:   state.free_in_buffer = cinfo->dest->free_in_buffer;
nuclear@1:   ASSIGN_STATE(state.cur, entropy->saved);
nuclear@1:   state.cinfo = cinfo;
nuclear@1: 
nuclear@1:   /* Emit restart marker if needed */
nuclear@1:   if (cinfo->restart_interval) {
nuclear@1:     if (entropy->restarts_to_go == 0)
nuclear@1:       if (! emit_restart(&state, entropy->next_restart_num))
nuclear@1: 	return FALSE;
nuclear@1:   }
nuclear@1: 
nuclear@1:   /* Encode the MCU data blocks */
nuclear@1:   for (blkn = 0; blkn < cinfo->blocks_in_MCU; blkn++) {
nuclear@1:     ci = cinfo->MCU_membership[blkn];
nuclear@1:     compptr = cinfo->cur_comp_info[ci];
nuclear@1:     if (! encode_one_block(&state,
nuclear@1: 			   MCU_data[blkn][0], state.cur.last_dc_val[ci],
nuclear@1: 			   entropy->dc_derived_tbls[compptr->dc_tbl_no],
nuclear@1: 			   entropy->ac_derived_tbls[compptr->ac_tbl_no]))
nuclear@1:       return FALSE;
nuclear@1:     /* Update last_dc_val */
nuclear@1:     state.cur.last_dc_val[ci] = MCU_data[blkn][0][0];
nuclear@1:   }
nuclear@1: 
nuclear@1:   /* Completed MCU, so update state */
nuclear@1:   cinfo->dest->next_output_byte = state.next_output_byte;
nuclear@1:   cinfo->dest->free_in_buffer = state.free_in_buffer;
nuclear@1:   ASSIGN_STATE(entropy->saved, state.cur);
nuclear@1: 
nuclear@1:   /* Update restart-interval state too */
nuclear@1:   if (cinfo->restart_interval) {
nuclear@1:     if (entropy->restarts_to_go == 0) {
nuclear@1:       entropy->restarts_to_go = cinfo->restart_interval;
nuclear@1:       entropy->next_restart_num++;
nuclear@1:       entropy->next_restart_num &= 7;
nuclear@1:     }
nuclear@1:     entropy->restarts_to_go--;
nuclear@1:   }
nuclear@1: 
nuclear@1:   return TRUE;
nuclear@1: }
nuclear@1: 
nuclear@1: 
nuclear@1: /*
nuclear@1:  * Finish up at the end of a Huffman-compressed scan.
nuclear@1:  */
nuclear@1: 
nuclear@1: METHODDEF(void)
nuclear@1: finish_pass_huff (j_compress_ptr cinfo)
nuclear@1: {
nuclear@1:   huff_entropy_ptr entropy = (huff_entropy_ptr) cinfo->entropy;
nuclear@1:   working_state state;
nuclear@1: 
nuclear@1:   /* Load up working state ... flush_bits needs it */
nuclear@1:   state.next_output_byte = cinfo->dest->next_output_byte;
nuclear@1:   state.free_in_buffer = cinfo->dest->free_in_buffer;
nuclear@1:   ASSIGN_STATE(state.cur, entropy->saved);
nuclear@1:   state.cinfo = cinfo;
nuclear@1: 
nuclear@1:   /* Flush out the last data */
nuclear@1:   if (! flush_bits(&state))
nuclear@1:     ERREXIT(cinfo, JERR_CANT_SUSPEND);
nuclear@1: 
nuclear@1:   /* Update state */
nuclear@1:   cinfo->dest->next_output_byte = state.next_output_byte;
nuclear@1:   cinfo->dest->free_in_buffer = state.free_in_buffer;
nuclear@1:   ASSIGN_STATE(entropy->saved, state.cur);
nuclear@1: }
nuclear@1: 
nuclear@1: 
nuclear@1: /*
nuclear@1:  * Huffman coding optimization.
nuclear@1:  *
nuclear@1:  * We first scan the supplied data and count the number of uses of each symbol
nuclear@1:  * that is to be Huffman-coded. (This process MUST agree with the code above.)
nuclear@1:  * Then we build a Huffman coding tree for the observed counts.
nuclear@1:  * Symbols which are not needed at all for the particular image are not
nuclear@1:  * assigned any code, which saves space in the DHT marker as well as in
nuclear@1:  * the compressed data.
nuclear@1:  */
nuclear@1: 
nuclear@1: #ifdef ENTROPY_OPT_SUPPORTED
nuclear@1: 
nuclear@1: 
nuclear@1: /* Process a single block's worth of coefficients */
nuclear@1: 
nuclear@1: LOCAL(void)
nuclear@1: htest_one_block (j_compress_ptr cinfo, JCOEFPTR block, int last_dc_val,
nuclear@1: 		 long dc_counts[], long ac_counts[])
nuclear@1: {
nuclear@1:   register int temp;
nuclear@1:   register int nbits;
nuclear@1:   register int k, r;
nuclear@1:   
nuclear@1:   /* Encode the DC coefficient difference per section F.1.2.1 */
nuclear@1:   
nuclear@1:   temp = block[0] - last_dc_val;
nuclear@1:   if (temp < 0)
nuclear@1:     temp = -temp;
nuclear@1:   
nuclear@1:   /* Find the number of bits needed for the magnitude of the coefficient */
nuclear@1:   nbits = 0;
nuclear@1:   while (temp) {
nuclear@1:     nbits++;
nuclear@1:     temp >>= 1;
nuclear@1:   }
nuclear@1:   /* Check for out-of-range coefficient values.
nuclear@1:    * Since we're encoding a difference, the range limit is twice as much.
nuclear@1:    */
nuclear@1:   if (nbits > MAX_COEF_BITS+1)
nuclear@1:     ERREXIT(cinfo, JERR_BAD_DCT_COEF);
nuclear@1: 
nuclear@1:   /* Count the Huffman symbol for the number of bits */
nuclear@1:   dc_counts[nbits]++;
nuclear@1:   
nuclear@1:   /* Encode the AC coefficients per section F.1.2.2 */
nuclear@1:   
nuclear@1:   r = 0;			/* r = run length of zeros */
nuclear@1:   
nuclear@1:   for (k = 1; k < DCTSIZE2; k++) {
nuclear@1:     if ((temp = block[jpeg_natural_order[k]]) == 0) {
nuclear@1:       r++;
nuclear@1:     } else {
nuclear@1:       /* if run length > 15, must emit special run-length-16 codes (0xF0) */
nuclear@1:       while (r > 15) {
nuclear@1: 	ac_counts[0xF0]++;
nuclear@1: 	r -= 16;
nuclear@1:       }
nuclear@1:       
nuclear@1:       /* Find the number of bits needed for the magnitude of the coefficient */
nuclear@1:       if (temp < 0)
nuclear@1: 	temp = -temp;
nuclear@1:       
nuclear@1:       /* Find the number of bits needed for the magnitude of the coefficient */
nuclear@1:       nbits = 1;		/* there must be at least one 1 bit */
nuclear@1:       while ((temp >>= 1))
nuclear@1: 	nbits++;
nuclear@1:       /* Check for out-of-range coefficient values */
nuclear@1:       if (nbits > MAX_COEF_BITS)
nuclear@1: 	ERREXIT(cinfo, JERR_BAD_DCT_COEF);
nuclear@1:       
nuclear@1:       /* Count Huffman symbol for run length / number of bits */
nuclear@1:       ac_counts[(r << 4) + nbits]++;
nuclear@1:       
nuclear@1:       r = 0;
nuclear@1:     }
nuclear@1:   }
nuclear@1: 
nuclear@1:   /* If the last coef(s) were zero, emit an end-of-block code */
nuclear@1:   if (r > 0)
nuclear@1:     ac_counts[0]++;
nuclear@1: }
nuclear@1: 
nuclear@1: 
nuclear@1: /*
nuclear@1:  * Trial-encode one MCU's worth of Huffman-compressed coefficients.
nuclear@1:  * No data is actually output, so no suspension return is possible.
nuclear@1:  */
nuclear@1: 
nuclear@1: METHODDEF(boolean)
nuclear@1: encode_mcu_gather (j_compress_ptr cinfo, JBLOCKROW *MCU_data)
nuclear@1: {
nuclear@1:   huff_entropy_ptr entropy = (huff_entropy_ptr) cinfo->entropy;
nuclear@1:   int blkn, ci;
nuclear@1:   jpeg_component_info * compptr;
nuclear@1: 
nuclear@1:   /* Take care of restart intervals if needed */
nuclear@1:   if (cinfo->restart_interval) {
nuclear@1:     if (entropy->restarts_to_go == 0) {
nuclear@1:       /* Re-initialize DC predictions to 0 */
nuclear@1:       for (ci = 0; ci < cinfo->comps_in_scan; ci++)
nuclear@1: 	entropy->saved.last_dc_val[ci] = 0;
nuclear@1:       /* Update restart state */
nuclear@1:       entropy->restarts_to_go = cinfo->restart_interval;
nuclear@1:     }
nuclear@1:     entropy->restarts_to_go--;
nuclear@1:   }
nuclear@1: 
nuclear@1:   for (blkn = 0; blkn < cinfo->blocks_in_MCU; blkn++) {
nuclear@1:     ci = cinfo->MCU_membership[blkn];
nuclear@1:     compptr = cinfo->cur_comp_info[ci];
nuclear@1:     htest_one_block(cinfo, MCU_data[blkn][0], entropy->saved.last_dc_val[ci],
nuclear@1: 		    entropy->dc_count_ptrs[compptr->dc_tbl_no],
nuclear@1: 		    entropy->ac_count_ptrs[compptr->ac_tbl_no]);
nuclear@1:     entropy->saved.last_dc_val[ci] = MCU_data[blkn][0][0];
nuclear@1:   }
nuclear@1: 
nuclear@1:   return TRUE;
nuclear@1: }
nuclear@1: 
nuclear@1: 
nuclear@1: /*
nuclear@1:  * Generate the best Huffman code table for the given counts, fill htbl.
nuclear@1:  * Note this is also used by jcphuff.c.
nuclear@1:  *
nuclear@1:  * The JPEG standard requires that no symbol be assigned a codeword of all
nuclear@1:  * one bits (so that padding bits added at the end of a compressed segment
nuclear@1:  * can't look like a valid code).  Because of the canonical ordering of
nuclear@1:  * codewords, this just means that there must be an unused slot in the
nuclear@1:  * longest codeword length category.  Section K.2 of the JPEG spec suggests
nuclear@1:  * reserving such a slot by pretending that symbol 256 is a valid symbol
nuclear@1:  * with count 1.  In theory that's not optimal; giving it count zero but
nuclear@1:  * including it in the symbol set anyway should give a better Huffman code.
nuclear@1:  * But the theoretically better code actually seems to come out worse in
nuclear@1:  * practice, because it produces more all-ones bytes (which incur stuffed
nuclear@1:  * zero bytes in the final file).  In any case the difference is tiny.
nuclear@1:  *
nuclear@1:  * The JPEG standard requires Huffman codes to be no more than 16 bits long.
nuclear@1:  * If some symbols have a very small but nonzero probability, the Huffman tree
nuclear@1:  * must be adjusted to meet the code length restriction.  We currently use
nuclear@1:  * the adjustment method suggested in JPEG section K.2.  This method is *not*
nuclear@1:  * optimal; it may not choose the best possible limited-length code.  But
nuclear@1:  * typically only very-low-frequency symbols will be given less-than-optimal
nuclear@1:  * lengths, so the code is almost optimal.  Experimental comparisons against
nuclear@1:  * an optimal limited-length-code algorithm indicate that the difference is
nuclear@1:  * microscopic --- usually less than a hundredth of a percent of total size.
nuclear@1:  * So the extra complexity of an optimal algorithm doesn't seem worthwhile.
nuclear@1:  */
nuclear@1: 
nuclear@1: GLOBAL(void)
nuclear@1: jpeg_gen_optimal_table (j_compress_ptr cinfo, JHUFF_TBL * htbl, long freq[])
nuclear@1: {
nuclear@1: #define MAX_CLEN 32		/* assumed maximum initial code length */
nuclear@1:   UINT8 bits[MAX_CLEN+1];	/* bits[k] = # of symbols with code length k */
nuclear@1:   int codesize[257];		/* codesize[k] = code length of symbol k */
nuclear@1:   int others[257];		/* next symbol in current branch of tree */
nuclear@1:   int c1, c2;
nuclear@1:   int p, i, j;
nuclear@1:   long v;
nuclear@1: 
nuclear@1:   /* This algorithm is explained in section K.2 of the JPEG standard */
nuclear@1: 
nuclear@1:   MEMZERO(bits, SIZEOF(bits));
nuclear@1:   MEMZERO(codesize, SIZEOF(codesize));
nuclear@1:   for (i = 0; i < 257; i++)
nuclear@1:     others[i] = -1;		/* init links to empty */
nuclear@1:   
nuclear@1:   freq[256] = 1;		/* make sure 256 has a nonzero count */
nuclear@1:   /* Including the pseudo-symbol 256 in the Huffman procedure guarantees
nuclear@1:    * that no real symbol is given code-value of all ones, because 256
nuclear@1:    * will be placed last in the largest codeword category.
nuclear@1:    */
nuclear@1: 
nuclear@1:   /* Huffman's basic algorithm to assign optimal code lengths to symbols */
nuclear@1: 
nuclear@1:   for (;;) {
nuclear@1:     /* Find the smallest nonzero frequency, set c1 = its symbol */
nuclear@1:     /* In case of ties, take the larger symbol number */
nuclear@1:     c1 = -1;
nuclear@1:     v = 1000000000L;
nuclear@1:     for (i = 0; i <= 256; i++) {
nuclear@1:       if (freq[i] && freq[i] <= v) {
nuclear@1: 	v = freq[i];
nuclear@1: 	c1 = i;
nuclear@1:       }
nuclear@1:     }
nuclear@1: 
nuclear@1:     /* Find the next smallest nonzero frequency, set c2 = its symbol */
nuclear@1:     /* In case of ties, take the larger symbol number */
nuclear@1:     c2 = -1;
nuclear@1:     v = 1000000000L;
nuclear@1:     for (i = 0; i <= 256; i++) {
nuclear@1:       if (freq[i] && freq[i] <= v && i != c1) {
nuclear@1: 	v = freq[i];
nuclear@1: 	c2 = i;
nuclear@1:       }
nuclear@1:     }
nuclear@1: 
nuclear@1:     /* Done if we've merged everything into one frequency */
nuclear@1:     if (c2 < 0)
nuclear@1:       break;
nuclear@1:     
nuclear@1:     /* Else merge the two counts/trees */
nuclear@1:     freq[c1] += freq[c2];
nuclear@1:     freq[c2] = 0;
nuclear@1: 
nuclear@1:     /* Increment the codesize of everything in c1's tree branch */
nuclear@1:     codesize[c1]++;
nuclear@1:     while (others[c1] >= 0) {
nuclear@1:       c1 = others[c1];
nuclear@1:       codesize[c1]++;
nuclear@1:     }
nuclear@1:     
nuclear@1:     others[c1] = c2;		/* chain c2 onto c1's tree branch */
nuclear@1:     
nuclear@1:     /* Increment the codesize of everything in c2's tree branch */
nuclear@1:     codesize[c2]++;
nuclear@1:     while (others[c2] >= 0) {
nuclear@1:       c2 = others[c2];
nuclear@1:       codesize[c2]++;
nuclear@1:     }
nuclear@1:   }
nuclear@1: 
nuclear@1:   /* Now count the number of symbols of each code length */
nuclear@1:   for (i = 0; i <= 256; i++) {
nuclear@1:     if (codesize[i]) {
nuclear@1:       /* The JPEG standard seems to think that this can't happen, */
nuclear@1:       /* but I'm paranoid... */
nuclear@1:       if (codesize[i] > MAX_CLEN)
nuclear@1: 	ERREXIT(cinfo, JERR_HUFF_CLEN_OVERFLOW);
nuclear@1: 
nuclear@1:       bits[codesize[i]]++;
nuclear@1:     }
nuclear@1:   }
nuclear@1: 
nuclear@1:   /* JPEG doesn't allow symbols with code lengths over 16 bits, so if the pure
nuclear@1:    * Huffman procedure assigned any such lengths, we must adjust the coding.
nuclear@1:    * Here is what the JPEG spec says about how this next bit works:
nuclear@1:    * Since symbols are paired for the longest Huffman code, the symbols are
nuclear@1:    * removed from this length category two at a time.  The prefix for the pair
nuclear@1:    * (which is one bit shorter) is allocated to one of the pair; then,
nuclear@1:    * skipping the BITS entry for that prefix length, a code word from the next
nuclear@1:    * shortest nonzero BITS entry is converted into a prefix for two code words
nuclear@1:    * one bit longer.
nuclear@1:    */
nuclear@1:   
nuclear@1:   for (i = MAX_CLEN; i > 16; i--) {
nuclear@1:     while (bits[i] > 0) {
nuclear@1:       j = i - 2;		/* find length of new prefix to be used */
nuclear@1:       while (bits[j] == 0)
nuclear@1: 	j--;
nuclear@1:       
nuclear@1:       bits[i] -= 2;		/* remove two symbols */
nuclear@1:       bits[i-1]++;		/* one goes in this length */
nuclear@1:       bits[j+1] += 2;		/* two new symbols in this length */
nuclear@1:       bits[j]--;		/* symbol of this length is now a prefix */
nuclear@1:     }
nuclear@1:   }
nuclear@1: 
nuclear@1:   /* Remove the count for the pseudo-symbol 256 from the largest codelength */
nuclear@1:   while (bits[i] == 0)		/* find largest codelength still in use */
nuclear@1:     i--;
nuclear@1:   bits[i]--;
nuclear@1:   
nuclear@1:   /* Return final symbol counts (only for lengths 0..16) */
nuclear@1:   MEMCOPY(htbl->bits, bits, SIZEOF(htbl->bits));
nuclear@1:   
nuclear@1:   /* Return a list of the symbols sorted by code length */
nuclear@1:   /* It's not real clear to me why we don't need to consider the codelength
nuclear@1:    * changes made above, but the JPEG spec seems to think this works.
nuclear@1:    */
nuclear@1:   p = 0;
nuclear@1:   for (i = 1; i <= MAX_CLEN; i++) {
nuclear@1:     for (j = 0; j <= 255; j++) {
nuclear@1:       if (codesize[j] == i) {
nuclear@1: 	htbl->huffval[p] = (UINT8) j;
nuclear@1: 	p++;
nuclear@1:       }
nuclear@1:     }
nuclear@1:   }
nuclear@1: 
nuclear@1:   /* Set sent_table FALSE so updated table will be written to JPEG file. */
nuclear@1:   htbl->sent_table = FALSE;
nuclear@1: }
nuclear@1: 
nuclear@1: 
nuclear@1: /*
nuclear@1:  * Finish up a statistics-gathering pass and create the new Huffman tables.
nuclear@1:  */
nuclear@1: 
nuclear@1: METHODDEF(void)
nuclear@1: finish_pass_gather (j_compress_ptr cinfo)
nuclear@1: {
nuclear@1:   huff_entropy_ptr entropy = (huff_entropy_ptr) cinfo->entropy;
nuclear@1:   int ci, dctbl, actbl;
nuclear@1:   jpeg_component_info * compptr;
nuclear@1:   JHUFF_TBL **htblptr;
nuclear@1:   boolean did_dc[NUM_HUFF_TBLS];
nuclear@1:   boolean did_ac[NUM_HUFF_TBLS];
nuclear@1: 
nuclear@1:   /* It's important not to apply jpeg_gen_optimal_table more than once
nuclear@1:    * per table, because it clobbers the input frequency counts!
nuclear@1:    */
nuclear@1:   MEMZERO(did_dc, SIZEOF(did_dc));
nuclear@1:   MEMZERO(did_ac, SIZEOF(did_ac));
nuclear@1: 
nuclear@1:   for (ci = 0; ci < cinfo->comps_in_scan; ci++) {
nuclear@1:     compptr = cinfo->cur_comp_info[ci];
nuclear@1:     dctbl = compptr->dc_tbl_no;
nuclear@1:     actbl = compptr->ac_tbl_no;
nuclear@1:     if (! did_dc[dctbl]) {
nuclear@1:       htblptr = & cinfo->dc_huff_tbl_ptrs[dctbl];
nuclear@1:       if (*htblptr == NULL)
nuclear@1: 	*htblptr = jpeg_alloc_huff_table((j_common_ptr) cinfo);
nuclear@1:       jpeg_gen_optimal_table(cinfo, *htblptr, entropy->dc_count_ptrs[dctbl]);
nuclear@1:       did_dc[dctbl] = TRUE;
nuclear@1:     }
nuclear@1:     if (! did_ac[actbl]) {
nuclear@1:       htblptr = & cinfo->ac_huff_tbl_ptrs[actbl];
nuclear@1:       if (*htblptr == NULL)
nuclear@1: 	*htblptr = jpeg_alloc_huff_table((j_common_ptr) cinfo);
nuclear@1:       jpeg_gen_optimal_table(cinfo, *htblptr, entropy->ac_count_ptrs[actbl]);
nuclear@1:       did_ac[actbl] = TRUE;
nuclear@1:     }
nuclear@1:   }
nuclear@1: }
nuclear@1: 
nuclear@1: 
nuclear@1: #endif /* ENTROPY_OPT_SUPPORTED */
nuclear@1: 
nuclear@1: 
nuclear@1: /*
nuclear@1:  * Module initialization routine for Huffman entropy encoding.
nuclear@1:  */
nuclear@1: 
nuclear@1: GLOBAL(void)
nuclear@1: jinit_huff_encoder (j_compress_ptr cinfo)
nuclear@1: {
nuclear@1:   huff_entropy_ptr entropy;
nuclear@1:   int i;
nuclear@1: 
nuclear@1:   entropy = (huff_entropy_ptr)
nuclear@1:     (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_IMAGE,
nuclear@1: 				SIZEOF(huff_entropy_encoder));
nuclear@1:   cinfo->entropy = (struct jpeg_entropy_encoder *) entropy;
nuclear@1:   entropy->pub.start_pass = start_pass_huff;
nuclear@1: 
nuclear@1:   /* Mark tables unallocated */
nuclear@1:   for (i = 0; i < NUM_HUFF_TBLS; i++) {
nuclear@1:     entropy->dc_derived_tbls[i] = entropy->ac_derived_tbls[i] = NULL;
nuclear@1: #ifdef ENTROPY_OPT_SUPPORTED
nuclear@1:     entropy->dc_count_ptrs[i] = entropy->ac_count_ptrs[i] = NULL;
nuclear@1: #endif
nuclear@1:   }
nuclear@1: }