JPEGLIB.H
上传用户:wep9318
上传日期:2007-01-07
资源大小:893k
文件大小:38k
源码类别:

图片显示

开发平台:

Visual C++

  1. /*
  2.  * jpeglib.h
  3.  *
  4.  * Copyright (C) 1991-1994, 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 defines the application interface for the JPEG library.
  9.  * Most applications using the library need only include this file,
  10.  * and perhaps jerror.h if they want to know the exact error codes.
  11.  */
  12. #ifndef JPEGLIB_H
  13. #define JPEGLIB_H
  14. /*
  15.  * First we include the configuration files that record how this
  16.  * installation of the JPEG library is set up.  jconfig.h can be
  17.  * generated automatically for many systems.  jmorecfg.h contains
  18.  * manual configuration options that most people need not worry about.
  19.  */
  20. #ifndef JCONFIG_INCLUDED /* in case jinclude.h already did */
  21. #include "jconfig.h" /* widely used configuration options */
  22. #endif
  23. #include "jmorecfg.h" /* seldom changed options */
  24. /* Version ID for the JPEG library.
  25.  * Might be useful for tests like "#if JPEG_LIB_VERSION >= 60".
  26.  */
  27. #define JPEG_LIB_VERSION  51 /* Version 5a */
  28. /* Various constants determining the sizes of things.
  29.  * All of these are specified by the JPEG standard, so don't change them
  30.  * if you want to be compatible.
  31.  */
  32. #define DCTSIZE     8 /* The basic DCT block is 8x8 samples */
  33. #define DCTSIZE2     64 /* DCTSIZE squared; # of elements in a block */
  34. #define NUM_QUANT_TBLS      4 /* Quantization tables are numbered 0..3 */
  35. #define NUM_HUFF_TBLS       4 /* Huffman tables are numbered 0..3 */
  36. #define NUM_ARITH_TBLS      16 /* Arith-coding tables are numbered 0..15 */
  37. #define MAX_COMPS_IN_SCAN   4 /* JPEG limit on # of components in one scan */
  38. #define MAX_SAMP_FACTOR     4 /* JPEG limit on sampling factors */
  39. #define MAX_BLOCKS_IN_MCU   10 /* JPEG limit on # of blocks in an MCU */
  40. /* This macro is used to declare a "method", that is, a function pointer.
  41.  * We want to supply prototype parameters if the compiler can cope.
  42.  * Note that the arglist parameter must be parenthesized!
  43.  */
  44. #ifdef HAVE_PROTOTYPES
  45. #define JMETHOD(type,methodname,arglist)  type (*methodname) arglist
  46. #else
  47. #define JMETHOD(type,methodname,arglist)  type (*methodname) ()
  48. #endif
  49. /* Data structures for images (arrays of samples and of DCT coefficients).
  50.  * On 80x86 machines, the image arrays are too big for near pointers,
  51.  * but the pointer arrays can fit in near memory.
  52.  */
  53. typedef JSAMPLE FAR *JSAMPROW; /* ptr to one image row of pixel samples. */
  54. typedef JSAMPROW *JSAMPARRAY; /* ptr to some rows (a 2-D sample array) */
  55. typedef JSAMPARRAY *JSAMPIMAGE; /* a 3-D sample array: top index is color */
  56. typedef JCOEF JBLOCK[DCTSIZE2]; /* one block of coefficients */
  57. typedef JBLOCK FAR *JBLOCKROW; /* pointer to one row of coefficient blocks */
  58. typedef JBLOCKROW *JBLOCKARRAY; /* a 2-D array of coefficient blocks */
  59. typedef JBLOCKARRAY *JBLOCKIMAGE; /* a 3-D array of coefficient blocks */
  60. typedef JCOEF FAR *JCOEFPTR; /* useful in a couple of places */
  61. /* Types for JPEG compression parameters and working tables. */
  62. /* DCT coefficient quantization tables. */
  63. typedef struct {
  64.   /* This field directly represents the contents of a JPEG DQT marker.
  65.    * Note: the values are always given in zigzag order.
  66.    */
  67.   UINT16 quantval[DCTSIZE2]; /* quantization step for each coefficient */
  68.   /* This field is used only during compression.  It's initialized FALSE when
  69.    * the table is created, and set TRUE when it's been output to the file.
  70.    * You could suppress output of a table by setting this to TRUE.
  71.    * (See jpeg_suppress_tables for an example.)
  72.    */
  73.   boolean sent_table; /* TRUE when table has been output */
  74. } JQUANT_TBL;
  75. /* Huffman coding tables. */
  76. typedef struct {
  77.   /* These two fields directly represent the contents of a JPEG DHT marker */
  78.   UINT8 bits[17]; /* bits[k] = # of symbols with codes of */
  79. /* length k bits; bits[0] is unused */
  80.   UINT8 huffval[256]; /* The symbols, in order of incr code length */
  81.   /* This field is used only during compression.  It's initialized FALSE when
  82.    * the table is created, and set TRUE when it's been output to the file.
  83.    * You could suppress output of a table by setting this to TRUE.
  84.    * (See jpeg_suppress_tables for an example.)
  85.    */
  86.   boolean sent_table; /* TRUE when table has been output */
  87. } JHUFF_TBL;
  88. /* Basic info about one component (color channel). */
  89. typedef struct {
  90.   /* These values are fixed over the whole image. */
  91.   /* For compression, they must be supplied by parameter setup; */
  92.   /* for decompression, they are read from the SOF marker. */
  93.   int component_id; /* identifier for this component (0..255) */
  94.   int component_index; /* its index in SOF or cinfo->comp_info[] */
  95.   int h_samp_factor; /* horizontal sampling factor (1..4) */
  96.   int v_samp_factor; /* vertical sampling factor (1..4) */
  97.   int quant_tbl_no; /* quantization table selector (0..3) */
  98.   /* These values may vary between scans. */
  99.   /* For compression, they must be supplied by parameter setup; */
  100.   /* for decompression, they are read from the SOS marker. */
  101.   int dc_tbl_no; /* DC entropy table selector (0..3) */
  102.   int ac_tbl_no; /* AC entropy table selector (0..3) */
  103.   
  104.   /* Remaining fields should be treated as private by applications. */
  105.   
  106.   /* These values are computed during compression or decompression startup: */
  107.   /* Component's size in DCT blocks.
  108.    * Any dummy blocks added to complete an MCU are not counted; therefore
  109.    * these values do not depend on whether a scan is interleaved or not.
  110.    */
  111.   JDIMENSION width_in_blocks;
  112.   JDIMENSION height_in_blocks;
  113.   /* Size of a DCT block in samples.  Always DCTSIZE for compression.
  114.    * For decompression this is the size of the output from one DCT block,
  115.    * reflecting any scaling we choose to apply during the IDCT step.
  116.    * Values of 1,2,4,8 are likely to be supported.  Note that different
  117.    * components may receive different IDCT scalings.
  118.    */
  119.   int DCT_scaled_size;
  120.   /* The downsampled dimensions are the component's actual, unpadded number
  121.    * of samples at the main buffer (preprocessing/compression interface), thus
  122.    * downsampled_width = ceil(image_width * Hi/Hmax)
  123.    * and similarly for height.  For decompression, IDCT scaling is included, so
  124.    * downsampled_width = ceil(image_width * Hi/Hmax * DCT_scaled_size/DCTSIZE)
  125.    */
  126.   JDIMENSION downsampled_width;  /* actual width in samples */
  127.   JDIMENSION downsampled_height; /* actual height in samples */
  128.   /* This flag is used only for decompression.  In cases where some of the
  129.    * components will be ignored (eg grayscale output from YCbCr image),
  130.    * we can skip most computations for the unused components.
  131.    */
  132.   boolean component_needed; /* do we need the value of this component? */
  133.   /* These values are computed before starting a scan of the component: */
  134.   int MCU_width; /* number of blocks per MCU, horizontally */
  135.   int MCU_height; /* number of blocks per MCU, vertically */
  136.   int MCU_blocks; /* MCU_width * MCU_height */
  137.   int MCU_sample_width; /* MCU width in samples, MCU_width*DCT_scaled_size */
  138.   int last_col_width; /* # of non-dummy blocks across in last MCU */
  139.   int last_row_height; /* # of non-dummy blocks down in last MCU */
  140.   /* Private per-component storage for DCT or IDCT subsystem. */
  141.   void * dct_table;
  142. } jpeg_component_info;
  143. /* Known color spaces. */
  144. typedef enum {
  145. JCS_UNKNOWN, /* error/unspecified */
  146. JCS_GRAYSCALE, /* monochrome */
  147. JCS_RGB, /* red/green/blue */
  148. JCS_YCbCr, /* Y/Cb/Cr (also known as YUV) */
  149. JCS_CMYK, /* C/M/Y/K */
  150. JCS_YCCK /* Y/Cb/Cr/K */
  151. } J_COLOR_SPACE;
  152. /* DCT/IDCT algorithm options. */
  153. typedef enum {
  154. JDCT_ISLOW, /* slow but accurate integer algorithm */
  155. JDCT_IFAST, /* faster, less accurate integer method */
  156. JDCT_FLOAT /* floating-point: accurate, fast on fast HW */
  157. } J_DCT_METHOD;
  158. #ifndef JDCT_DEFAULT /* may be overridden in jconfig.h */
  159. #define JDCT_DEFAULT  JDCT_ISLOW
  160. #endif
  161. #ifndef JDCT_FASTEST /* may be overridden in jconfig.h */
  162. #define JDCT_FASTEST  JDCT_IFAST
  163. #endif
  164. /* Dithering options for decompression. */
  165. typedef enum {
  166. JDITHER_NONE, /* no dithering */
  167. JDITHER_ORDERED, /* simple ordered dither */
  168. JDITHER_FS /* Floyd-Steinberg error diffusion dither */
  169. } J_DITHER_MODE;
  170. /* Common fields between JPEG compression and decompression master structs. */
  171. #define jpeg_common_fields 
  172.   struct jpeg_error_mgr * err; /* Error handler module */
  173.   struct jpeg_memory_mgr * mem; /* Memory manager module */
  174.   struct jpeg_progress_mgr * progress; /* Progress monitor, or NULL if none */
  175.   boolean is_decompressor; /* so common code can tell which is which */
  176.   int global_state /* for checking call sequence validity */
  177. /* Routines that are to be used by both halves of the library are declared
  178.  * to receive a pointer to this structure.  There are no actual instances of
  179.  * jpeg_common_struct, only of jpeg_compress_struct and jpeg_decompress_struct.
  180.  */
  181. struct jpeg_common_struct {
  182.   jpeg_common_fields; /* Fields common to both master struct types */
  183.   /* Additional fields follow in an actual jpeg_compress_struct or
  184.    * jpeg_decompress_struct.  All three structs must agree on these
  185.    * initial fields!  (This would be a lot cleaner in C++.)
  186.    */
  187. };
  188. typedef struct jpeg_common_struct * j_common_ptr;
  189. typedef struct jpeg_compress_struct * j_compress_ptr;
  190. typedef struct jpeg_decompress_struct * j_decompress_ptr;
  191. /* Master record for a compression instance */
  192. struct jpeg_compress_struct {
  193.   jpeg_common_fields; /* Fields shared with jpeg_decompress_struct */
  194.   /* Destination for compressed data */
  195.   struct jpeg_destination_mgr * dest;
  196.   /* Description of source image --- these fields must be filled in by
  197.    * outer application before starting compression.  in_color_space must
  198.    * be correct before you can even call jpeg_set_defaults().
  199.    */
  200.   JDIMENSION image_width; /* input image width */
  201.   JDIMENSION image_height; /* input image height */
  202.   int input_components; /* # of color components in input image */
  203.   J_COLOR_SPACE in_color_space; /* colorspace of input image */
  204.   double input_gamma; /* image gamma of input image */
  205.   /* Compression parameters --- these fields must be set before calling
  206.    * jpeg_start_compress().  We recommend calling jpeg_set_defaults() to
  207.    * initialize everything to reasonable defaults, then changing anything
  208.    * the application specifically wants to change.  That way you won't get
  209.    * burnt when new parameters are added.  Also note that there are several
  210.    * helper routines to simplify changing parameters.
  211.    */
  212.   int data_precision; /* bits of precision in image data */
  213.   int num_components; /* # of color components in JPEG image */
  214.   J_COLOR_SPACE jpeg_color_space; /* colorspace of JPEG image */
  215.   jpeg_component_info * comp_info;
  216.   /* comp_info[i] describes component that appears i'th in SOF */
  217.   
  218.   JQUANT_TBL * quant_tbl_ptrs[NUM_QUANT_TBLS];
  219.   /* ptrs to coefficient quantization tables, or NULL if not defined */
  220.   
  221.   JHUFF_TBL * dc_huff_tbl_ptrs[NUM_HUFF_TBLS];
  222.   JHUFF_TBL * ac_huff_tbl_ptrs[NUM_HUFF_TBLS];
  223.   /* ptrs to Huffman coding tables, or NULL if not defined */
  224.   
  225.   UINT8 arith_dc_L[NUM_ARITH_TBLS]; /* L values for DC arith-coding tables */
  226.   UINT8 arith_dc_U[NUM_ARITH_TBLS]; /* U values for DC arith-coding tables */
  227.   UINT8 arith_ac_K[NUM_ARITH_TBLS]; /* Kx values for AC arith-coding tables */
  228.   boolean raw_data_in; /* TRUE=caller supplies downsampled data */
  229.   boolean arith_code; /* TRUE=arithmetic coding, FALSE=Huffman */
  230.   boolean interleave; /* TRUE=interleaved output, FALSE=not */
  231.   boolean optimize_coding; /* TRUE=optimize entropy encoding parms */
  232.   boolean CCIR601_sampling; /* TRUE=first samples are cosited */
  233.   int smoothing_factor; /* 1..100, or 0 for no input smoothing */
  234.   J_DCT_METHOD dct_method; /* DCT algorithm selector */
  235.   /* The restart interval can be specified in absolute MCUs by setting
  236.    * restart_interval, or in MCU rows by setting restart_in_rows
  237.    * (in which case the correct restart_interval will be figured
  238.    * for each scan).
  239.    */
  240.   unsigned int restart_interval; /* MCUs per restart, or 0 for no restart */
  241.   int restart_in_rows; /* if > 0, MCU rows per restart interval */
  242.   /* Parameters controlling emission of special markers. */
  243.   boolean write_JFIF_header; /* should a JFIF marker be written? */
  244.   /* These three values are not used by the JPEG code, merely copied */
  245.   /* into the JFIF APP0 marker.  density_unit can be 0 for unknown, */
  246.   /* 1 for dots/inch, or 2 for dots/cm.  Note that the pixel aspect */
  247.   /* ratio is defined by X_density/Y_density even when density_unit=0. */
  248.   UINT8 density_unit; /* JFIF code for pixel size units */
  249.   UINT16 X_density; /* Horizontal pixel density */
  250.   UINT16 Y_density; /* Vertical pixel density */
  251.   boolean write_Adobe_marker; /* should an Adobe marker be written? */
  252.   
  253.   /* State variable: index of next scanline to be written to
  254.    * jpeg_write_scanlines().  Application may use this to control its
  255.    * processing loop, e.g., "while (next_scanline < image_height)".
  256.    */
  257.   JDIMENSION next_scanline; /* 0 .. image_height-1  */
  258.   /* Remaining fields are known throughout compressor, but generally
  259.    * should not be touched by a surrounding application.
  260.    */
  261.   /*
  262.    * These fields are computed during compression startup
  263.    */
  264.   int max_h_samp_factor; /* largest h_samp_factor */
  265.   int max_v_samp_factor; /* largest v_samp_factor */
  266.   JDIMENSION total_iMCU_rows; /* # of iMCU rows to be input to coef ctlr */
  267.   /* The coefficient controller receives data in units of MCU rows as defined
  268.    * for fully interleaved scans (whether the JPEG file is interleaved or not).
  269.    * There are v_samp_factor * DCTSIZE sample rows of each component in an
  270.    * "iMCU" (interleaved MCU) row.
  271.    */
  272.   
  273.   /*
  274.    * These fields are valid during any one scan.
  275.    * They describe the components and MCUs actually appearing in the scan.
  276.    */
  277.   int comps_in_scan; /* # of JPEG components in this scan */
  278.   jpeg_component_info * cur_comp_info[MAX_COMPS_IN_SCAN];
  279.   /* *cur_comp_info[i] describes component that appears i'th in SOS */
  280.   
  281.   JDIMENSION MCUs_per_row; /* # of MCUs across the image */
  282.   JDIMENSION MCU_rows_in_scan; /* # of MCU rows in the image */
  283.   
  284.   int blocks_in_MCU; /* # of DCT blocks per MCU */
  285.   int MCU_membership[MAX_BLOCKS_IN_MCU];
  286.   /* MCU_membership[i] is index in cur_comp_info of component owning */
  287.   /* i'th block in an MCU */
  288.   /*
  289.    * Links to compression subobjects (methods and private variables of modules)
  290.    */
  291.   struct jpeg_comp_master * master;
  292.   struct jpeg_c_main_controller * main;
  293.   struct jpeg_c_prep_controller * prep;
  294.   struct jpeg_c_coef_controller * coef;
  295.   struct jpeg_marker_writer * marker;
  296.   struct jpeg_color_converter * cconvert;
  297.   struct jpeg_downsampler * downsample;
  298.   struct jpeg_forward_dct * fdct;
  299.   struct jpeg_entropy_encoder * entropy;
  300. };
  301. /* Master record for a decompression instance */
  302. struct jpeg_decompress_struct {
  303.   jpeg_common_fields; /* Fields shared with jpeg_compress_struct */
  304.   /* Source of compressed data */
  305.   struct jpeg_source_mgr * src;
  306.   /* Basic description of image --- filled in by jpeg_read_header(). */
  307.   /* Application may inspect these values to decide how to process image. */
  308.   JDIMENSION image_width; /* nominal image width (from SOF marker) */
  309.   JDIMENSION image_height; /* nominal image height */
  310.   int num_components; /* # of color components in JPEG image */
  311.   J_COLOR_SPACE jpeg_color_space; /* colorspace of JPEG image */
  312.   /* Decompression processing parameters --- these fields must be set before
  313.    * calling jpeg_start_decompress().  Note that jpeg_read_header() initializes
  314.    * them to default values.
  315.    */
  316.   J_COLOR_SPACE out_color_space; /* colorspace for output */
  317.   unsigned int scale_num, scale_denom; /* fraction by which to scale image */
  318.   double output_gamma; /* image gamma wanted in output */
  319.   boolean raw_data_out; /* TRUE=downsampled data wanted */
  320.   boolean quantize_colors; /* TRUE=colormapped output wanted */
  321.   /* the following are ignored if not quantize_colors: */
  322.   boolean two_pass_quantize; /* TRUE=use two-pass color quantization */
  323.   J_DITHER_MODE dither_mode; /* type of color dithering to use */
  324.   int desired_number_of_colors; /* max number of colors to use */
  325.   J_DCT_METHOD dct_method; /* DCT algorithm selector */
  326.   boolean do_fancy_upsampling; /* TRUE=apply fancy upsampling */
  327.   /* Description of actual output image that will be returned to application.
  328.    * These fields are computed by jpeg_start_decompress().
  329.    * You can also use jpeg_calc_output_dimensions() to determine these values
  330.    * in advance of calling jpeg_start_decompress().
  331.    */
  332.   JDIMENSION output_width; /* scaled image width */
  333.   JDIMENSION output_height; /* scaled image height */
  334.   int out_color_components; /* # of color components in out_color_space */
  335.   int output_components; /* # of color components returned */
  336.   /* output_components is 1 (a colormap index) when quantizing colors;
  337.    * otherwise it equals out_color_components.
  338.    */
  339.   int rec_outbuf_height; /* min recommended height of scanline buffer */
  340.   /* If the buffer passed to jpeg_read_scanlines() is less than this many rows
  341.    * high, space and time will be wasted due to unnecessary data copying.
  342.    * Usually rec_outbuf_height will be 1 or 2, at most 4.
  343.    */
  344.   /* When quantizing colors, the output colormap is described by these fields.
  345.    * The application can supply a colormap by setting colormap non-NULL before
  346.    * calling jpeg_start_decompress; otherwise a colormap is created during
  347.    * jpeg_start_decompress.
  348.    * The map has out_color_components rows and actual_number_of_colors columns.
  349.    */
  350.   int actual_number_of_colors; /* number of entries in use */
  351.   JSAMPARRAY colormap; /* The color map as a 2-D pixel array */
  352.   /* State variable: index of next scaled scanline to be read from
  353.    * jpeg_read_scanlines().  Application may use this to control its
  354.    * processing loop, e.g., "while (output_scanline < output_height)".
  355.    */
  356.   JDIMENSION output_scanline; /* 0 .. output_height-1  */
  357.   /* Internal JPEG parameters --- the application usually need not look at
  358.    * these fields.
  359.    */
  360.   /* Quantization and Huffman tables are carried forward across input
  361.    * datastreams when processing abbreviated JPEG datastreams.
  362.    */
  363.   JQUANT_TBL * quant_tbl_ptrs[NUM_QUANT_TBLS];
  364.   /* ptrs to coefficient quantization tables, or NULL if not defined */
  365.   JHUFF_TBL * dc_huff_tbl_ptrs[NUM_HUFF_TBLS];
  366.   JHUFF_TBL * ac_huff_tbl_ptrs[NUM_HUFF_TBLS];
  367.   /* ptrs to Huffman coding tables, or NULL if not defined */
  368.   /* These parameters are never carried across datastreams, since they
  369.    * are given in SOF/SOS markers or defined to be reset by SOI.
  370.    */
  371.   int data_precision; /* bits of precision in image data */
  372.   jpeg_component_info * comp_info;
  373.   /* comp_info[i] describes component that appears i'th in SOF */
  374.   UINT8 arith_dc_L[NUM_ARITH_TBLS]; /* L values for DC arith-coding tables */
  375.   UINT8 arith_dc_U[NUM_ARITH_TBLS]; /* U values for DC arith-coding tables */
  376.   UINT8 arith_ac_K[NUM_ARITH_TBLS]; /* Kx values for AC arith-coding tables */
  377.   boolean arith_code; /* TRUE=arithmetic coding, FALSE=Huffman */
  378.   unsigned int restart_interval; /* MCUs per restart interval, or 0 for no restart */
  379.   /* These fields record data obtained from optional markers recognized by
  380.    * the JPEG library.
  381.    */
  382.   boolean saw_JFIF_marker; /* TRUE iff a JFIF APP0 marker was found */
  383.   /* Data copied from JFIF marker: */
  384.   UINT8 density_unit; /* JFIF code for pixel size units */
  385.   UINT16 X_density; /* Horizontal pixel density */
  386.   UINT16 Y_density; /* Vertical pixel density */
  387.   boolean saw_Adobe_marker; /* TRUE iff an Adobe APP14 marker was found */
  388.   UINT8 Adobe_transform; /* Color transform code from Adobe marker */
  389.   boolean CCIR601_sampling; /* TRUE=first samples are cosited */
  390.   /* Remaining fields are known throughout decompressor, but generally
  391.    * should not be touched by a surrounding application.
  392.    */
  393.   /*
  394.    * These fields are computed during decompression startup
  395.    */
  396.   int max_h_samp_factor; /* largest h_samp_factor */
  397.   int max_v_samp_factor; /* largest v_samp_factor */
  398.   int min_DCT_scaled_size; /* smallest DCT_scaled_size of any component */
  399.   JDIMENSION total_iMCU_rows; /* # of iMCU rows to be output by coef ctlr */
  400.   /* The coefficient controller outputs data in units of MCU rows as defined
  401.    * for fully interleaved scans (whether the JPEG file is interleaved or not).
  402.    * There are v_samp_factor * DCT_scaled_size sample rows of each component
  403.    * in an "iMCU" (interleaved MCU) row.
  404.    */
  405.   JSAMPLE * sample_range_limit; /* table for fast range-limiting */
  406.   /*
  407.    * These fields are valid during any one scan.
  408.    * They describe the components and MCUs actually appearing in the scan.
  409.    */
  410.   int comps_in_scan; /* # of JPEG components in this scan */
  411.   jpeg_component_info * cur_comp_info[MAX_COMPS_IN_SCAN];
  412.   /* *cur_comp_info[i] describes component that appears i'th in SOS */
  413.   JDIMENSION MCUs_per_row; /* # of MCUs across the image */
  414.   JDIMENSION MCU_rows_in_scan; /* # of MCU rows in the image */
  415.   int blocks_in_MCU; /* # of DCT blocks per MCU */
  416.   int MCU_membership[MAX_BLOCKS_IN_MCU];
  417.   /* MCU_membership[i] is index in cur_comp_info of component owning */
  418.   /* i'th block in an MCU */
  419.   /* This field is shared between entropy decoder and marker parser.
  420.    * It is either zero or the code of a JPEG marker that has been
  421.    * read from the data source, but has not yet been processed.
  422.    */
  423.   int unread_marker;
  424.   /*
  425.    * Links to decompression subobjects (methods, private variables of modules)
  426.    */
  427.   struct jpeg_decomp_master * master;
  428.   struct jpeg_d_main_controller * main;
  429.   struct jpeg_d_coef_controller * coef;
  430.   struct jpeg_d_post_controller * post;
  431.   struct jpeg_marker_reader * marker;
  432.   struct jpeg_entropy_decoder * entropy;
  433.   struct jpeg_inverse_dct * idct;
  434.   struct jpeg_upsampler * upsample;
  435.   struct jpeg_color_deconverter * cconvert;
  436.   struct jpeg_color_quantizer * cquantize;
  437. };
  438. /* "Object" declarations for JPEG modules that may be supplied or called
  439.  * directly by the surrounding application.
  440.  * As with all objects in the JPEG library, these structs only define the
  441.  * publicly visible methods and state variables of a module.  Additional
  442.  * private fields may exist after the public ones.
  443.  */
  444. /* Error handler object */
  445. struct jpeg_error_mgr {
  446.   /* Error exit handler: does not return to caller */
  447.   JMETHOD(void, error_exit, (j_common_ptr cinfo));
  448.   /* Conditionally emit a trace or warning message */
  449.   JMETHOD(void, emit_message, (j_common_ptr cinfo, int msg_level));
  450.   /* Routine that actually outputs a trace or error message */
  451.   JMETHOD(void, output_message, (j_common_ptr cinfo));
  452.   /* Format a message string for the most recent JPEG error or message */
  453.   JMETHOD(void, format_message, (j_common_ptr cinfo, char * buffer));
  454. #define JMSG_LENGTH_MAX  200 /* recommended size of format_message buffer */
  455.   /* Reset error state variables at start of a new image */
  456.   JMETHOD(void, reset_error_mgr, (j_common_ptr cinfo));
  457.   
  458.   /* The message ID code and any parameters are saved here.
  459.    * A message can have one string parameter or up to 8 int parameters.
  460.    */
  461.   int msg_code;
  462. #define JMSG_STR_PARM_MAX  80
  463.   union {
  464.     int i[8];
  465.     char s[JMSG_STR_PARM_MAX];
  466.   } msg_parm;
  467.   
  468.   /* Standard state variables for error facility */
  469.   
  470.   int trace_level; /* max msg_level that will be displayed */
  471.   
  472.   /* For recoverable corrupt-data errors, we emit a warning message,
  473.    * but keep going unless emit_message chooses to abort.  emit_message
  474.    * should count warnings in num_warnings.  The surrounding application
  475.    * can check for bad data by seeing if num_warnings is nonzero at the
  476.    * end of processing.
  477.    */
  478.   long num_warnings; /* number of corrupt-data warnings */
  479.   /* These fields point to the table(s) of error message strings.
  480.    * An application can change the table pointer to switch to a different
  481.    * message list (typically, to change the language in which errors are
  482.    * reported).  Some applications may wish to add additional error codes
  483.    * that will be handled by the JPEG library error mechanism; the second
  484.    * table pointer is used for this purpose.
  485.    *
  486.    * First table includes all errors generated by JPEG library itself.
  487.    * Error code 0 is reserved for a "no such error string" message.
  488.    */
  489.   const char * const * jpeg_message_table; /* Library errors */
  490.   int last_jpeg_message;    /* Table contains strings 0..last_jpeg_message */
  491.   /* Second table can be added by application (see cjpeg/djpeg for example).
  492.    * It contains strings numbered first_addon_message..last_addon_message.
  493.    */
  494.   const char * const * addon_message_table; /* Non-library errors */
  495.   int first_addon_message; /* code for first string in addon table */
  496.   int last_addon_message; /* code for last string in addon table */
  497. };
  498. /* Progress monitor object */
  499. struct jpeg_progress_mgr {
  500.   JMETHOD(void, progress_monitor, (j_common_ptr cinfo));
  501.   long pass_counter; /* work units completed in this pass */
  502.   long pass_limit; /* total number of work units in this pass */
  503.   int completed_passes; /* passes completed so far */
  504.   int total_passes; /* total number of passes expected */
  505. };
  506. /* Data destination object for compression */
  507. struct jpeg_destination_mgr {
  508.   JOCTET * next_output_byte; /* => next byte to write in buffer */
  509.   size_t free_in_buffer; /* # of byte spaces remaining in buffer */
  510.   JMETHOD(void, init_destination, (j_compress_ptr cinfo));
  511.   JMETHOD(boolean, empty_output_buffer, (j_compress_ptr cinfo));
  512.   JMETHOD(void, term_destination, (j_compress_ptr cinfo));
  513. };
  514. /* Data source object for decompression */
  515. struct jpeg_source_mgr {
  516.   const JOCTET * next_input_byte; /* => next byte to read from buffer */
  517.   size_t bytes_in_buffer; /* # of bytes remaining in buffer */
  518.   JMETHOD(void, init_source, (j_decompress_ptr cinfo));
  519.   JMETHOD(boolean, fill_input_buffer, (j_decompress_ptr cinfo));
  520.   JMETHOD(void, skip_input_data, (j_decompress_ptr cinfo, long num_bytes));
  521.   JMETHOD(boolean, resync_to_restart, (j_decompress_ptr cinfo));
  522.   JMETHOD(void, term_source, (j_decompress_ptr cinfo));
  523. };
  524. /* Memory manager object.
  525.  * Allocates "small" objects (a few K total), "large" objects (tens of K),
  526.  * and "really big" objects (virtual arrays with backing store if needed).
  527.  * The memory manager does not allow individual objects to be freed; rather,
  528.  * each created object is assigned to a pool, and whole pools can be freed
  529.  * at once.  This is faster and more convenient than remembering exactly what
  530.  * to free, especially where malloc()/free() are not too speedy.
  531.  * NB: alloc routines never return NULL.  They exit to error_exit if not
  532.  * successful.
  533.  */
  534. #define JPOOL_PERMANENT 0 /* lasts until master record is destroyed */
  535. #define JPOOL_IMAGE 1 /* lasts until done with image/datastream */
  536. #define JPOOL_NUMPOOLS 2
  537. typedef struct jvirt_sarray_control * jvirt_sarray_ptr;
  538. typedef struct jvirt_barray_control * jvirt_barray_ptr;
  539. struct jpeg_memory_mgr {
  540.   /* Method pointers */
  541.   JMETHOD(void *, alloc_small, (j_common_ptr cinfo, int pool_id,
  542. size_t sizeofobject));
  543.   JMETHOD(void FAR *, alloc_large, (j_common_ptr cinfo, int pool_id,
  544.      size_t sizeofobject));
  545.   JMETHOD(JSAMPARRAY, alloc_sarray, (j_common_ptr cinfo, int pool_id,
  546.      JDIMENSION samplesperrow,
  547.      JDIMENSION numrows));
  548.   JMETHOD(JBLOCKARRAY, alloc_barray, (j_common_ptr cinfo, int pool_id,
  549.       JDIMENSION blocksperrow,
  550.       JDIMENSION numrows));
  551.   JMETHOD(jvirt_sarray_ptr, request_virt_sarray, (j_common_ptr cinfo,
  552.   int pool_id,
  553.   JDIMENSION samplesperrow,
  554.   JDIMENSION numrows,
  555.   JDIMENSION unitheight));
  556.   JMETHOD(jvirt_barray_ptr, request_virt_barray, (j_common_ptr cinfo,
  557.   int pool_id,
  558.   JDIMENSION blocksperrow,
  559.   JDIMENSION numrows,
  560.   JDIMENSION unitheight));
  561.   JMETHOD(void, realize_virt_arrays, (j_common_ptr cinfo));
  562.   JMETHOD(JSAMPARRAY, access_virt_sarray, (j_common_ptr cinfo,
  563.    jvirt_sarray_ptr ptr,
  564.    JDIMENSION start_row,
  565.    boolean writable));
  566.   JMETHOD(JBLOCKARRAY, access_virt_barray, (j_common_ptr cinfo,
  567.     jvirt_barray_ptr ptr,
  568.     JDIMENSION start_row,
  569.     boolean writable));
  570.   JMETHOD(void, free_pool, (j_common_ptr cinfo, int pool_id));
  571.   JMETHOD(void, self_destruct, (j_common_ptr cinfo));
  572.   /* Limit on memory allocation for this JPEG object.  (Note that this is
  573.    * merely advisory, not a guaranteed maximum; it only affects the space
  574.    * used for virtual-array buffers.)  May be changed by outer application
  575.    * after creating the JPEG object.
  576.    */
  577.   long max_memory_to_use;
  578. };
  579. /* Routine signature for application-supplied marker processing methods.
  580.  * Need not pass marker code since it is stored in cinfo->unread_marker.
  581.  */
  582. typedef JMETHOD(boolean, jpeg_marker_parser_method, (j_decompress_ptr cinfo));
  583. /* Declarations for routines called by application.
  584.  * The JPP macro hides prototype parameters from compilers that can't cope.
  585.  * Note JPP requires double parentheses.
  586.  */
  587. #ifdef HAVE_PROTOTYPES
  588. #define JPP(arglist) arglist
  589. #else
  590. #define JPP(arglist) ()
  591. #endif
  592. /* Short forms of external names for systems with brain-damaged linkers.
  593.  * We shorten external names to be unique in the first six letters, which
  594.  * is good enough for all known systems.
  595.  * (If your compiler itself needs names to be unique in less than 15 
  596.  * characters, you are out of luck.  Get a better compiler.)
  597.  */
  598. #ifdef NEED_SHORT_EXTERNAL_NAMES
  599. #define jpeg_std_error jStdError
  600. #define jpeg_create_compress jCreaCompress
  601. #define jpeg_create_decompress jCreaDecompress
  602. #define jpeg_destroy_compress jDestCompress
  603. #define jpeg_destroy_decompress jDestDecompress
  604. #define jpeg_stdio_dest jStdDest
  605. #define jpeg_stdio_src jStdSrc
  606. #define jpeg_set_defaults jSetDefaults
  607. #define jpeg_set_colorspace jSetColorspace
  608. #define jpeg_default_colorspace jDefColorspace
  609. #define jpeg_set_quality jSetQuality
  610. #define jpeg_set_linear_quality jSetLQuality
  611. #define jpeg_add_quant_table jAddQuantTable
  612. #define jpeg_quality_scaling jQualityScaling
  613. #define jpeg_suppress_tables jSuppressTables
  614. #define jpeg_alloc_quant_table jAlcQTable
  615. #define jpeg_alloc_huff_table jAlcHTable
  616. #define jpeg_start_compress jStrtCompress
  617. #define jpeg_write_scanlines jWrtScanlines
  618. #define jpeg_finish_compress jFinCompress
  619. #define jpeg_write_raw_data jWrtRawData
  620. #define jpeg_write_marker jWrtMarker
  621. #define jpeg_write_tables jWrtTables
  622. #define jpeg_read_header jReadHeader
  623. #define jpeg_start_decompress jStrtDecompress
  624. #define jpeg_read_scanlines jReadScanlines
  625. #define jpeg_finish_decompress jFinDecompress
  626. #define jpeg_read_raw_data jReadRawData
  627. #define jpeg_calc_output_dimensions jCalcDimensions
  628. #define jpeg_set_marker_processor jSetMarker
  629. #define jpeg_abort_compress jAbrtCompress
  630. #define jpeg_abort_decompress jAbrtDecompress
  631. #define jpeg_abort jAbort
  632. #define jpeg_destroy jDestroy
  633. #define jpeg_resync_to_restart jResyncRestart
  634. #endif /* NEED_SHORT_EXTERNAL_NAMES */
  635. /* Default error-management setup */
  636. EXTERN struct jpeg_error_mgr *jpeg_std_error JPP((struct jpeg_error_mgr *err));
  637. /* Initialization and destruction of JPEG compression objects */
  638. /* NB: you must set up the error-manager BEFORE calling jpeg_create_xxx */
  639. EXTERN void jpeg_create_compress JPP((j_compress_ptr cinfo));
  640. EXTERN void jpeg_create_decompress JPP((j_decompress_ptr cinfo));
  641. EXTERN void jpeg_destroy_compress JPP((j_compress_ptr cinfo));
  642. EXTERN void jpeg_destroy_decompress JPP((j_decompress_ptr cinfo));
  643. /* Standard data source and destination managers: stdio streams. */
  644. /* Caller is responsible for opening the file before and closing after. */
  645. EXTERN void jpeg_stdio_dest JPP((j_compress_ptr cinfo, FILE * outfile));
  646. EXTERN void jpeg_stdio_src JPP((j_decompress_ptr cinfo, FILE * infile));
  647. /* Default parameter setup for compression */
  648. EXTERN void jpeg_set_defaults JPP((j_compress_ptr cinfo));
  649. /* Compression parameter setup aids */
  650. EXTERN void jpeg_set_colorspace JPP((j_compress_ptr cinfo,
  651.      J_COLOR_SPACE colorspace));
  652. EXTERN void jpeg_default_colorspace JPP((j_compress_ptr cinfo));
  653. EXTERN void jpeg_set_quality JPP((j_compress_ptr cinfo, int quality,
  654.   boolean force_baseline));
  655. EXTERN void jpeg_set_linear_quality JPP((j_compress_ptr cinfo,
  656.  int scale_factor,
  657.  boolean force_baseline));
  658. EXTERN void jpeg_add_quant_table JPP((j_compress_ptr cinfo, int which_tbl,
  659.       const unsigned int *basic_table,
  660.       int scale_factor,
  661.       boolean force_baseline));
  662. EXTERN int jpeg_quality_scaling JPP((int quality));
  663. EXTERN void jpeg_suppress_tables JPP((j_compress_ptr cinfo,
  664.       boolean suppress));
  665. EXTERN JQUANT_TBL * jpeg_alloc_quant_table JPP((j_common_ptr cinfo));
  666. EXTERN JHUFF_TBL * jpeg_alloc_huff_table JPP((j_common_ptr cinfo));
  667. /* Main entry points for compression */
  668. EXTERN void jpeg_start_compress JPP((j_compress_ptr cinfo,
  669.      boolean write_all_tables));
  670. EXTERN JDIMENSION jpeg_write_scanlines JPP((j_compress_ptr cinfo,
  671.     JSAMPARRAY scanlines,
  672.     JDIMENSION num_lines));
  673. EXTERN void jpeg_finish_compress JPP((j_compress_ptr cinfo));
  674. /* Replaces jpeg_write_scanlines when writing raw downsampled data. */
  675. EXTERN JDIMENSION jpeg_write_raw_data JPP((j_compress_ptr cinfo,
  676.    JSAMPIMAGE data,
  677.    JDIMENSION num_lines));
  678. /* Write a special marker.  See libjpeg.doc concerning safe usage. */
  679. EXTERN void jpeg_write_marker JPP((j_compress_ptr cinfo, int marker,
  680.    const JOCTET *dataptr, unsigned int datalen));
  681. /* Alternate compression function: just write an abbreviated table file */
  682. EXTERN void jpeg_write_tables JPP((j_compress_ptr cinfo));
  683. /* Decompression startup: read start of JPEG datastream to see what's there */
  684. EXTERN int jpeg_read_header JPP((j_decompress_ptr cinfo,
  685.  boolean require_image));
  686. /* Return value is one of: */
  687. #define JPEG_HEADER_OK 0 /* Found valid image datastream */
  688. #define JPEG_HEADER_TABLES_ONLY 1 /* Found valid table-specs-only datastream */
  689. #define JPEG_SUSPENDED 2 /* Had to suspend before end of headers */
  690. /* If you pass require_image = TRUE (normal case), you need not check for
  691.  * a TABLES_ONLY return code; an abbreviated file will cause an error exit.
  692.  * JPEG_SUSPENDED is only possible if you use a data source module that can
  693.  * give a suspension return (the stdio source module doesn't).
  694.  */
  695. /* Main entry points for decompression */
  696. EXTERN void jpeg_start_decompress JPP((j_decompress_ptr cinfo));
  697. EXTERN JDIMENSION jpeg_read_scanlines JPP((j_decompress_ptr cinfo,
  698.    JSAMPARRAY scanlines,
  699.    JDIMENSION max_lines));
  700. EXTERN boolean jpeg_finish_decompress JPP((j_decompress_ptr cinfo));
  701. /* Replaces jpeg_read_scanlines when reading raw downsampled data. */
  702. EXTERN JDIMENSION jpeg_read_raw_data JPP((j_decompress_ptr cinfo,
  703.   JSAMPIMAGE data,
  704.   JDIMENSION max_lines));
  705. /* Precalculate output dimensions for current decompression parameters. */
  706. EXTERN void jpeg_calc_output_dimensions JPP((j_decompress_ptr cinfo));
  707. /* Install a special processing method for COM or APPn markers. */
  708. EXTERN void jpeg_set_marker_processor JPP((j_decompress_ptr cinfo,
  709.    int marker_code,
  710.    jpeg_marker_parser_method routine));
  711. /* If you choose to abort compression or decompression before completing
  712.  * jpeg_finish_(de)compress, then you need to clean up to release memory,
  713.  * temporary files, etc.  You can just call jpeg_destroy_(de)compress
  714.  * if you're done with the JPEG object, but if you want to clean it up and
  715.  * reuse it, call this:
  716.  */
  717. EXTERN void jpeg_abort_compress JPP((j_compress_ptr cinfo));
  718. EXTERN void jpeg_abort_decompress JPP((j_decompress_ptr cinfo));
  719. /* Generic versions of jpeg_abort and jpeg_destroy that work on either
  720.  * flavor of JPEG object.  These may be more convenient in some places.
  721.  */
  722. EXTERN void jpeg_abort JPP((j_common_ptr cinfo));
  723. EXTERN void jpeg_destroy JPP((j_common_ptr cinfo));
  724. /* Default restart-marker-resync procedure for use by data source modules */
  725. EXTERN boolean jpeg_resync_to_restart JPP((j_decompress_ptr cinfo));
  726. /* These marker codes are exported since applications and data source modules
  727.  * are likely to want to use them.
  728.  */
  729. #define JPEG_RST0 0xD0 /* RST0 marker code */
  730. #define JPEG_EOI 0xD9 /* EOI marker code */
  731. #define JPEG_APP0 0xE0 /* APP0 marker code */
  732. #define JPEG_COM 0xFE /* COM marker code */
  733. /* If we have a brain-damaged compiler that emits warnings (or worse, errors)
  734.  * for structure definitions that are never filled in, keep it quiet by
  735.  * supplying dummy definitions for the various substructures.
  736.  */
  737. #ifdef INCOMPLETE_TYPES_BROKEN
  738. #ifndef JPEG_INTERNALS /* will be defined in jpegint.h */
  739. struct jvirt_sarray_control { long dummy; };
  740. struct jvirt_barray_control { long dummy; };
  741. struct jpeg_comp_master { long dummy; };
  742. struct jpeg_c_main_controller { long dummy; };
  743. struct jpeg_c_prep_controller { long dummy; };
  744. struct jpeg_c_coef_controller { long dummy; };
  745. struct jpeg_marker_writer { long dummy; };
  746. struct jpeg_color_converter { long dummy; };
  747. struct jpeg_downsampler { long dummy; };
  748. struct jpeg_forward_dct { long dummy; };
  749. struct jpeg_entropy_encoder { long dummy; };
  750. struct jpeg_decomp_master { long dummy; };
  751. struct jpeg_d_main_controller { long dummy; };
  752. struct jpeg_d_coef_controller { long dummy; };
  753. struct jpeg_d_post_controller { long dummy; };
  754. struct jpeg_marker_reader { long dummy; };
  755. struct jpeg_entropy_decoder { long dummy; };
  756. struct jpeg_inverse_dct { long dummy; };
  757. struct jpeg_upsampler { long dummy; };
  758. struct jpeg_color_deconverter { long dummy; };
  759. struct jpeg_color_quantizer { long dummy; };
  760. #endif /* JPEG_INTERNALS */
  761. #endif /* INCOMPLETE_TYPES_BROKEN */
  762. /*
  763.  * The JPEG library modules define JPEG_INTERNALS before including this file.
  764.  * The internal structure declarations are read only when that is true.
  765.  * Applications using the library should not include jpegint.h, but may wish
  766.  * to include jerror.h.
  767.  */
  768. #ifdef JPEG_INTERNALS
  769. #include "jpegint.h" /* fetch private declarations */
  770. #include "jerror.h" /* fetch error codes too */
  771. #endif
  772. #endif /* JPEGLIB_H */