jpeglib.h

Go to the documentation of this file.
00001 /*
00002  * jpeglib.h
00003  *
00004  * Copyright (C) 1991-1998, Thomas G. Lane.
00005  * Modified 2002-2009 by Guido Vollbeding.
00006  * This file is part of the Independent JPEG Group's software.
00007  * For conditions of distribution and use, see the accompanying README file.
00008  *
00009  * This file defines the application interface for the JPEG library.
00010  * Most applications using the library need only include this file,
00011  * and perhaps jerror.h if they want to know the exact error codes.
00012  */
00013 
00014 #ifndef JPEGLIB_H
00015 #define JPEGLIB_H
00016 
00017 /*
00018  * First we include the configuration files that record how this
00019  * installation of the JPEG library is set up.  jconfig.h can be
00020  * generated automatically for many systems.  jmorecfg.h contains
00021  * manual configuration options that most people need not worry about.
00022  */
00023 
00024 #ifndef JCONFIG_INCLUDED        /* in case jinclude.h already did */
00025 #include "jconfig.h"            /* widely used configuration options */
00026 #endif
00027 #include "jmorecfg.h"           /* seldom changed options */
00028 
00029 
00030 #ifdef __cplusplus
00031 #ifndef DONT_USE_EXTERN_C
00032 extern "C" {
00033 #endif
00034 #endif
00035 
00036 /* Version ID for the JPEG library.
00037  * Might be useful for tests like "#if JPEG_LIB_VERSION >= 80".
00038  */
00039 
00040 #define JPEG_LIB_VERSION  80    /* Version 8.0 */
00041 
00042 
00043 /* Various constants determining the sizes of things.
00044  * All of these are specified by the JPEG standard, so don't change them
00045  * if you want to be compatible.
00046  */
00047 
00048 #define DCTSIZE             8   /* The basic DCT block is 8x8 samples */
00049 #define DCTSIZE2            64  /* DCTSIZE squared; # of elements in a block */
00050 #define NUM_QUANT_TBLS      4   /* Quantization tables are numbered 0..3 */
00051 #define NUM_HUFF_TBLS       4   /* Huffman tables are numbered 0..3 */
00052 #define NUM_ARITH_TBLS      16  /* Arith-coding tables are numbered 0..15 */
00053 #define MAX_COMPS_IN_SCAN   4   /* JPEG limit on # of components in one scan */
00054 #define MAX_SAMP_FACTOR     4   /* JPEG limit on sampling factors */
00055 /* Unfortunately, some bozo at Adobe saw no reason to be bound by the standard;
00056  * the PostScript DCT filter can emit files with many more than 10 blocks/MCU.
00057  * If you happen to run across such a file, you can up D_MAX_BLOCKS_IN_MCU
00058  * to handle it.  We even let you do this from the jconfig.h file.  However,
00059  * we strongly discourage changing C_MAX_BLOCKS_IN_MCU; just because Adobe
00060  * sometimes emits noncompliant files doesn't mean you should too.
00061  */
00062 #define C_MAX_BLOCKS_IN_MCU   10 /* compressor's limit on blocks per MCU */
00063 #ifndef D_MAX_BLOCKS_IN_MCU
00064 #define D_MAX_BLOCKS_IN_MCU   10 /* decompressor's limit on blocks per MCU */
00065 #endif
00066 
00067 
00068 /* Data structures for images (arrays of samples and of DCT coefficients).
00069  * On 80x86 machines, the image arrays are too big for near pointers,
00070  * but the pointer arrays can fit in near memory.
00071  */
00072 
00073 typedef JSAMPLE FAR *JSAMPROW;  /* ptr to one image row of pixel samples. */
00074 typedef JSAMPROW *JSAMPARRAY;   /* ptr to some rows (a 2-D sample array) */
00075 typedef JSAMPARRAY *JSAMPIMAGE; /* a 3-D sample array: top index is color */
00076 
00077 typedef JCOEF JBLOCK[DCTSIZE2]; /* one block of coefficients */
00078 typedef JBLOCK FAR *JBLOCKROW;  /* pointer to one row of coefficient blocks */
00079 typedef JBLOCKROW *JBLOCKARRAY;         /* a 2-D array of coefficient blocks */
00080 typedef JBLOCKARRAY *JBLOCKIMAGE;       /* a 3-D array of coefficient blocks */
00081 
00082 typedef JCOEF FAR *JCOEFPTR;    /* useful in a couple of places */
00083 
00084 
00085 /* Types for JPEG compression parameters and working tables. */
00086 
00087 
00088 /* DCT coefficient quantization tables. */
00089 
00090 typedef struct {
00091   /* This array gives the coefficient quantizers in natural array order
00092    * (not the zigzag order in which they are stored in a JPEG DQT marker).
00093    * CAUTION: IJG versions prior to v6a kept this array in zigzag order.
00094    */
00095   UINT16 quantval[DCTSIZE2];    /* quantization step for each coefficient */
00096   /* This field is used only during compression.  It's initialized FALSE when
00097    * the table is created, and set TRUE when it's been output to the file.
00098    * You could suppress output of a table by setting this to TRUE.
00099    * (See jpeg_suppress_tables for an example.)
00100    */
00101   boolean sent_table;           /* TRUE when table has been output */
00102 } JQUANT_TBL;
00103 
00104 
00105 /* Huffman coding tables. */
00106 
00107 typedef struct {
00108   /* These two fields directly represent the contents of a JPEG DHT marker */
00109   UINT8 bits[17];               /* bits[k] = # of symbols with codes of */
00110                                 /* length k bits; bits[0] is unused */
00111   UINT8 huffval[256];           /* The symbols, in order of incr code length */
00112   /* This field is used only during compression.  It's initialized FALSE when
00113    * the table is created, and set TRUE when it's been output to the file.
00114    * You could suppress output of a table by setting this to TRUE.
00115    * (See jpeg_suppress_tables for an example.)
00116    */
00117   boolean sent_table;           /* TRUE when table has been output */
00118 } JHUFF_TBL;
00119 
00120 
00121 /* Basic info about one component (color channel). */
00122 
00123 typedef struct {
00124   /* These values are fixed over the whole image. */
00125   /* For compression, they must be supplied by parameter setup; */
00126   /* for decompression, they are read from the SOF marker. */
00127   int component_id;             /* identifier for this component (0..255) */
00128   int component_index;          /* its index in SOF or cinfo->comp_info[] */
00129   int h_samp_factor;            /* horizontal sampling factor (1..4) */
00130   int v_samp_factor;            /* vertical sampling factor (1..4) */
00131   int quant_tbl_no;             /* quantization table selector (0..3) */
00132   /* These values may vary between scans. */
00133   /* For compression, they must be supplied by parameter setup; */
00134   /* for decompression, they are read from the SOS marker. */
00135   /* The decompressor output side may not use these variables. */
00136   int dc_tbl_no;                /* DC entropy table selector (0..3) */
00137   int ac_tbl_no;                /* AC entropy table selector (0..3) */
00138   
00139   /* Remaining fields should be treated as private by applications. */
00140   
00141   /* These values are computed during compression or decompression startup: */
00142   /* Component's size in DCT blocks.
00143    * Any dummy blocks added to complete an MCU are not counted; therefore
00144    * these values do not depend on whether a scan is interleaved or not.
00145    */
00146   JDIMENSION width_in_blocks;
00147   JDIMENSION height_in_blocks;
00148   /* Size of a DCT block in samples,
00149    * reflecting any scaling we choose to apply during the DCT step.
00150    * Values from 1 to 16 are supported.
00151    * Note that different components may receive different DCT scalings.
00152    */
00153   int DCT_h_scaled_size;
00154   int DCT_v_scaled_size;
00155   /* The downsampled dimensions are the component's actual, unpadded number
00156    * of samples at the main buffer (preprocessing/compression interface);
00157    * DCT scaling is included, so
00158    * downsampled_width = ceil(image_width * Hi/Hmax * DCT_h_scaled_size/DCTSIZE)
00159    * and similarly for height.
00160    */
00161   JDIMENSION downsampled_width;  /* actual width in samples */
00162   JDIMENSION downsampled_height; /* actual height in samples */
00163   /* This flag is used only for decompression.  In cases where some of the
00164    * components will be ignored (eg grayscale output from YCbCr image),
00165    * we can skip most computations for the unused components.
00166    */
00167   boolean component_needed;     /* do we need the value of this component? */
00168 
00169   /* These values are computed before starting a scan of the component. */
00170   /* The decompressor output side may not use these variables. */
00171   int MCU_width;                /* number of blocks per MCU, horizontally */
00172   int MCU_height;               /* number of blocks per MCU, vertically */
00173   int MCU_blocks;               /* MCU_width * MCU_height */
00174   int MCU_sample_width; /* MCU width in samples: MCU_width * DCT_h_scaled_size */
00175   int last_col_width;           /* # of non-dummy blocks across in last MCU */
00176   int last_row_height;          /* # of non-dummy blocks down in last MCU */
00177 
00178   /* Saved quantization table for component; NULL if none yet saved.
00179    * See jdinput.c comments about the need for this information.
00180    * This field is currently used only for decompression.
00181    */
00182   JQUANT_TBL * quant_table;
00183 
00184   /* Private per-component storage for DCT or IDCT subsystem. */
00185   void * dct_table;
00186 } jpeg_component_info;
00187 
00188 
00189 /* The script for encoding a multiple-scan file is an array of these: */
00190 
00191 typedef struct {
00192   int comps_in_scan;            /* number of components encoded in this scan */
00193   int component_index[MAX_COMPS_IN_SCAN]; /* their SOF/comp_info[] indexes */
00194   int Ss, Se;                   /* progressive JPEG spectral selection parms */
00195   int Ah, Al;                   /* progressive JPEG successive approx. parms */
00196 } jpeg_scan_info;
00197 
00198 /* The decompressor can save APPn and COM markers in a list of these: */
00199 
00200 typedef struct jpeg_marker_struct FAR * jpeg_saved_marker_ptr;
00201 
00202 struct jpeg_marker_struct {
00203   jpeg_saved_marker_ptr next;   /* next in list, or NULL */
00204   UINT8 marker;                 /* marker code: JPEG_COM, or JPEG_APP0+n */
00205   unsigned int original_length; /* # bytes of data in the file */
00206   unsigned int data_length;     /* # bytes of data saved at data[] */
00207   JOCTET FAR * data;            /* the data contained in the marker */
00208   /* the marker length word is not counted in data_length or original_length */
00209 };
00210 
00211 /* Known color spaces. */
00212 
00213 typedef enum {
00214         JCS_UNKNOWN,            /* error/unspecified */
00215         JCS_GRAYSCALE,          /* monochrome */
00216         JCS_RGB,                /* red/green/blue */
00217         JCS_YCbCr,              /* Y/Cb/Cr (also known as YUV) */
00218         JCS_CMYK,               /* C/M/Y/K */
00219         JCS_YCCK                /* Y/Cb/Cr/K */
00220 } J_COLOR_SPACE;
00221 
00222 /* DCT/IDCT algorithm options. */
00223 
00224 typedef enum {
00225         JDCT_ISLOW,             /* slow but accurate integer algorithm */
00226         JDCT_IFAST,             /* faster, less accurate integer method */
00227         JDCT_FLOAT              /* floating-point: accurate, fast on fast HW */
00228 } J_DCT_METHOD;
00229 
00230 #ifndef JDCT_DEFAULT            /* may be overridden in jconfig.h */
00231 #define JDCT_DEFAULT  JDCT_ISLOW
00232 #endif
00233 #ifndef JDCT_FASTEST            /* may be overridden in jconfig.h */
00234 #define JDCT_FASTEST  JDCT_IFAST
00235 #endif
00236 
00237 /* Dithering options for decompression. */
00238 
00239 typedef enum {
00240         JDITHER_NONE,           /* no dithering */
00241         JDITHER_ORDERED,        /* simple ordered dither */
00242         JDITHER_FS              /* Floyd-Steinberg error diffusion dither */
00243 } J_DITHER_MODE;
00244 
00245 
00246 /* Common fields between JPEG compression and decompression master structs. */
00247 
00248 #define jpeg_common_fields \
00249   struct jpeg_error_mgr * err;  /* Error handler module */\
00250   struct jpeg_memory_mgr * mem; /* Memory manager module */\
00251   struct jpeg_progress_mgr * progress; /* Progress monitor, or NULL if none */\
00252   void * client_data;           /* Available for use by application */\
00253   boolean is_decompressor;      /* So common code can tell which is which */\
00254   int global_state              /* For checking call sequence validity */
00255 
00256 /* Routines that are to be used by both halves of the library are declared
00257  * to receive a pointer to this structure.  There are no actual instances of
00258  * jpeg_common_struct, only of jpeg_compress_struct and jpeg_decompress_struct.
00259  */
00260 struct jpeg_common_struct {
00261   jpeg_common_fields;           /* Fields common to both master struct types */
00262   /* Additional fields follow in an actual jpeg_compress_struct or
00263    * jpeg_decompress_struct.  All three structs must agree on these
00264    * initial fields!  (This would be a lot cleaner in C++.)
00265    */
00266 };
00267 
00268 typedef struct jpeg_common_struct * j_common_ptr;
00269 typedef struct jpeg_compress_struct * j_compress_ptr;
00270 typedef struct jpeg_decompress_struct * j_decompress_ptr;
00271 
00272 
00273 /* Master record for a compression instance */
00274 
00275 struct jpeg_compress_struct {
00276   jpeg_common_fields;           /* Fields shared with jpeg_decompress_struct */
00277 
00278   /* Destination for compressed data */
00279   struct jpeg_destination_mgr * dest;
00280 
00281   /* Description of source image --- these fields must be filled in by
00282    * outer application before starting compression.  in_color_space must
00283    * be correct before you can even call jpeg_set_defaults().
00284    */
00285 
00286   JDIMENSION image_width;       /* input image width */
00287   JDIMENSION image_height;      /* input image height */
00288   int input_components;         /* # of color components in input image */
00289   J_COLOR_SPACE in_color_space; /* colorspace of input image */
00290 
00291   double input_gamma;           /* image gamma of input image */
00292 
00293   /* Compression parameters --- these fields must be set before calling
00294    * jpeg_start_compress().  We recommend calling jpeg_set_defaults() to
00295    * initialize everything to reasonable defaults, then changing anything
00296    * the application specifically wants to change.  That way you won't get
00297    * burnt when new parameters are added.  Also note that there are several
00298    * helper routines to simplify changing parameters.
00299    */
00300 
00301   unsigned int scale_num, scale_denom; /* fraction by which to scale image */
00302 
00303   JDIMENSION jpeg_width;        /* scaled JPEG image width */
00304   JDIMENSION jpeg_height;       /* scaled JPEG image height */
00305   /* Dimensions of actual JPEG image that will be written to file,
00306    * derived from input dimensions by scaling factors above.
00307    * These fields are computed by jpeg_start_compress().
00308    * You can also use jpeg_calc_jpeg_dimensions() to determine these values
00309    * in advance of calling jpeg_start_compress().
00310    */
00311 
00312   int data_precision;           /* bits of precision in image data */
00313 
00314   int num_components;           /* # of color components in JPEG image */
00315   J_COLOR_SPACE jpeg_color_space; /* colorspace of JPEG image */
00316 
00317   jpeg_component_info * comp_info;
00318   /* comp_info[i] describes component that appears i'th in SOF */
00319 
00320   JQUANT_TBL * quant_tbl_ptrs[NUM_QUANT_TBLS];
00321   int q_scale_factor[NUM_QUANT_TBLS];
00322   /* ptrs to coefficient quantization tables, or NULL if not defined,
00323    * and corresponding scale factors (percentage, initialized 100).
00324    */
00325 
00326   JHUFF_TBL * dc_huff_tbl_ptrs[NUM_HUFF_TBLS];
00327   JHUFF_TBL * ac_huff_tbl_ptrs[NUM_HUFF_TBLS];
00328   /* ptrs to Huffman coding tables, or NULL if not defined */
00329 
00330   UINT8 arith_dc_L[NUM_ARITH_TBLS]; /* L values for DC arith-coding tables */
00331   UINT8 arith_dc_U[NUM_ARITH_TBLS]; /* U values for DC arith-coding tables */
00332   UINT8 arith_ac_K[NUM_ARITH_TBLS]; /* Kx values for AC arith-coding tables */
00333 
00334   int num_scans;                /* # of entries in scan_info array */
00335   const jpeg_scan_info * scan_info; /* script for multi-scan file, or NULL */
00336   /* The default value of scan_info is NULL, which causes a single-scan
00337    * sequential JPEG file to be emitted.  To create a multi-scan file,
00338    * set num_scans and scan_info to point to an array of scan definitions.
00339    */
00340 
00341   boolean raw_data_in;          /* TRUE=caller supplies downsampled data */
00342   boolean arith_code;           /* TRUE=arithmetic coding, FALSE=Huffman */
00343   boolean optimize_coding;      /* TRUE=optimize entropy encoding parms */
00344   boolean CCIR601_sampling;     /* TRUE=first samples are cosited */
00345   boolean do_fancy_downsampling; /* TRUE=apply fancy downsampling */
00346   int smoothing_factor;         /* 1..100, or 0 for no input smoothing */
00347   J_DCT_METHOD dct_method;      /* DCT algorithm selector */
00348 
00349   /* The restart interval can be specified in absolute MCUs by setting
00350    * restart_interval, or in MCU rows by setting restart_in_rows
00351    * (in which case the correct restart_interval will be figured
00352    * for each scan).
00353    */
00354   unsigned int restart_interval; /* MCUs per restart, or 0 for no restart */
00355   int restart_in_rows;          /* if > 0, MCU rows per restart interval */
00356 
00357   /* Parameters controlling emission of special markers. */
00358 
00359   boolean write_JFIF_header;    /* should a JFIF marker be written? */
00360   UINT8 JFIF_major_version;     /* What to write for the JFIF version number */
00361   UINT8 JFIF_minor_version;
00362   /* These three values are not used by the JPEG code, merely copied */
00363   /* into the JFIF APP0 marker.  density_unit can be 0 for unknown, */
00364   /* 1 for dots/inch, or 2 for dots/cm.  Note that the pixel aspect */
00365   /* ratio is defined by X_density/Y_density even when density_unit=0. */
00366   UINT8 density_unit;           /* JFIF code for pixel size units */
00367   UINT16 X_density;             /* Horizontal pixel density */
00368   UINT16 Y_density;             /* Vertical pixel density */
00369   boolean write_Adobe_marker;   /* should an Adobe marker be written? */
00370   
00371   /* State variable: index of next scanline to be written to
00372    * jpeg_write_scanlines().  Application may use this to control its
00373    * processing loop, e.g., "while (next_scanline < image_height)".
00374    */
00375 
00376   JDIMENSION next_scanline;     /* 0 .. image_height-1  */
00377 
00378   /* Remaining fields are known throughout compressor, but generally
00379    * should not be touched by a surrounding application.
00380    */
00381 
00382   /*
00383    * These fields are computed during compression startup
00384    */
00385   boolean progressive_mode;     /* TRUE if scan script uses progressive mode */
00386   int max_h_samp_factor;        /* largest h_samp_factor */
00387   int max_v_samp_factor;        /* largest v_samp_factor */
00388 
00389   int min_DCT_h_scaled_size;    /* smallest DCT_h_scaled_size of any component */
00390   int min_DCT_v_scaled_size;    /* smallest DCT_v_scaled_size of any component */
00391 
00392   JDIMENSION total_iMCU_rows;   /* # of iMCU rows to be input to coef ctlr */
00393   /* The coefficient controller receives data in units of MCU rows as defined
00394    * for fully interleaved scans (whether the JPEG file is interleaved or not).
00395    * There are v_samp_factor * DCTSIZE sample rows of each component in an
00396    * "iMCU" (interleaved MCU) row.
00397    */
00398   
00399   /*
00400    * These fields are valid during any one scan.
00401    * They describe the components and MCUs actually appearing in the scan.
00402    */
00403   int comps_in_scan;            /* # of JPEG components in this scan */
00404   jpeg_component_info * cur_comp_info[MAX_COMPS_IN_SCAN];
00405   /* *cur_comp_info[i] describes component that appears i'th in SOS */
00406   
00407   JDIMENSION MCUs_per_row;      /* # of MCUs across the image */
00408   JDIMENSION MCU_rows_in_scan;  /* # of MCU rows in the image */
00409   
00410   int blocks_in_MCU;            /* # of DCT blocks per MCU */
00411   int MCU_membership[C_MAX_BLOCKS_IN_MCU];
00412   /* MCU_membership[i] is index in cur_comp_info of component owning */
00413   /* i'th block in an MCU */
00414 
00415   int Ss, Se, Ah, Al;           /* progressive JPEG parameters for scan */
00416 
00417   int block_size;               /* the basic DCT block size: 1..16 */
00418   const int * natural_order;    /* natural-order position array */
00419   int lim_Se;                   /* min( Se, DCTSIZE2-1 ) */
00420 
00421   /*
00422    * Links to compression subobjects (methods and private variables of modules)
00423    */
00424   struct jpeg_comp_master * master;
00425   struct jpeg_c_main_controller * main;
00426   struct jpeg_c_prep_controller * prep;
00427   struct jpeg_c_coef_controller * coef;
00428   struct jpeg_marker_writer * marker;
00429   struct jpeg_color_converter * cconvert;
00430   struct jpeg_downsampler * downsample;
00431   struct jpeg_forward_dct * fdct;
00432   struct jpeg_entropy_encoder * entropy;
00433   jpeg_scan_info * script_space; /* workspace for jpeg_simple_progression */
00434   int script_space_size;
00435 };
00436 
00437 
00438 /* Master record for a decompression instance */
00439 
00440 struct jpeg_decompress_struct {
00441   jpeg_common_fields;           /* Fields shared with jpeg_compress_struct */
00442 
00443   /* Source of compressed data */
00444   struct jpeg_source_mgr * src;
00445 
00446   /* Basic description of image --- filled in by jpeg_read_header(). */
00447   /* Application may inspect these values to decide how to process image. */
00448 
00449   JDIMENSION image_width;       /* nominal image width (from SOF marker) */
00450   JDIMENSION image_height;      /* nominal image height */
00451   int num_components;           /* # of color components in JPEG image */
00452   J_COLOR_SPACE jpeg_color_space; /* colorspace of JPEG image */
00453 
00454   /* Decompression processing parameters --- these fields must be set before
00455    * calling jpeg_start_decompress().  Note that jpeg_read_header() initializes
00456    * them to default values.
00457    */
00458 
00459   J_COLOR_SPACE out_color_space; /* colorspace for output */
00460 
00461   unsigned int scale_num, scale_denom; /* fraction by which to scale image */
00462 
00463   double output_gamma;          /* image gamma wanted in output */
00464 
00465   boolean buffered_image;       /* TRUE=multiple output passes */
00466   boolean raw_data_out;         /* TRUE=downsampled data wanted */
00467 
00468   J_DCT_METHOD dct_method;      /* IDCT algorithm selector */
00469   boolean do_fancy_upsampling;  /* TRUE=apply fancy upsampling */
00470   boolean do_block_smoothing;   /* TRUE=apply interblock smoothing */
00471 
00472   boolean quantize_colors;      /* TRUE=colormapped output wanted */
00473   /* the following are ignored if not quantize_colors: */
00474   J_DITHER_MODE dither_mode;    /* type of color dithering to use */
00475   boolean two_pass_quantize;    /* TRUE=use two-pass color quantization */
00476   int desired_number_of_colors; /* max # colors to use in created colormap */
00477   /* these are significant only in buffered-image mode: */
00478   boolean enable_1pass_quant;   /* enable future use of 1-pass quantizer */
00479   boolean enable_external_quant;/* enable future use of external colormap */
00480   boolean enable_2pass_quant;   /* enable future use of 2-pass quantizer */
00481 
00482   /* Description of actual output image that will be returned to application.
00483    * These fields are computed by jpeg_start_decompress().
00484    * You can also use jpeg_calc_output_dimensions() to determine these values
00485    * in advance of calling jpeg_start_decompress().
00486    */
00487 
00488   JDIMENSION output_width;      /* scaled image width */
00489   JDIMENSION output_height;     /* scaled image height */
00490   int out_color_components;     /* # of color components in out_color_space */
00491   int output_components;        /* # of color components returned */
00492   /* output_components is 1 (a colormap index) when quantizing colors;
00493    * otherwise it equals out_color_components.
00494    */
00495   int rec_outbuf_height;        /* min recommended height of scanline buffer */
00496   /* If the buffer passed to jpeg_read_scanlines() is less than this many rows
00497    * high, space and time will be wasted due to unnecessary data copying.
00498    * Usually rec_outbuf_height will be 1 or 2, at most 4.
00499    */
00500 
00501   /* When quantizing colors, the output colormap is described by these fields.
00502    * The application can supply a colormap by setting colormap non-NULL before
00503    * calling jpeg_start_decompress; otherwise a colormap is created during
00504    * jpeg_start_decompress or jpeg_start_output.
00505    * The map has out_color_components rows and actual_number_of_colors columns.
00506    */
00507   int actual_number_of_colors;  /* number of entries in use */
00508   JSAMPARRAY colormap;          /* The color map as a 2-D pixel array */
00509 
00510   /* State variables: these variables indicate the progress of decompression.
00511    * The application may examine these but must not modify them.
00512    */
00513 
00514   /* Row index of next scanline to be read from jpeg_read_scanlines().
00515    * Application may use this to control its processing loop, e.g.,
00516    * "while (output_scanline < output_height)".
00517    */
00518   JDIMENSION output_scanline;   /* 0 .. output_height-1  */
00519 
00520   /* Current input scan number and number of iMCU rows completed in scan.
00521    * These indicate the progress of the decompressor input side.
00522    */
00523   int input_scan_number;        /* Number of SOS markers seen so far */
00524   JDIMENSION input_iMCU_row;    /* Number of iMCU rows completed */
00525 
00526   /* The "output scan number" is the notional scan being displayed by the
00527    * output side.  The decompressor will not allow output scan/row number
00528    * to get ahead of input scan/row, but it can fall arbitrarily far behind.
00529    */
00530   int output_scan_number;       /* Nominal scan number being displayed */
00531   JDIMENSION output_iMCU_row;   /* Number of iMCU rows read */
00532 
00533   /* Current progression status.  coef_bits[c][i] indicates the precision
00534    * with which component c's DCT coefficient i (in zigzag order) is known.
00535    * It is -1 when no data has yet been received, otherwise it is the point
00536    * transform (shift) value for the most recent scan of the coefficient
00537    * (thus, 0 at completion of the progression).
00538    * This pointer is NULL when reading a non-progressive file.
00539    */
00540   int (*coef_bits)[DCTSIZE2];   /* -1 or current Al value for each coef */
00541 
00542   /* Internal JPEG parameters --- the application usually need not look at
00543    * these fields.  Note that the decompressor output side may not use
00544    * any parameters that can change between scans.
00545    */
00546 
00547   /* Quantization and Huffman tables are carried forward across input
00548    * datastreams when processing abbreviated JPEG datastreams.
00549    */
00550 
00551   JQUANT_TBL * quant_tbl_ptrs[NUM_QUANT_TBLS];
00552   /* ptrs to coefficient quantization tables, or NULL if not defined */
00553 
00554   JHUFF_TBL * dc_huff_tbl_ptrs[NUM_HUFF_TBLS];
00555   JHUFF_TBL * ac_huff_tbl_ptrs[NUM_HUFF_TBLS];
00556   /* ptrs to Huffman coding tables, or NULL if not defined */
00557 
00558   /* These parameters are never carried across datastreams, since they
00559    * are given in SOF/SOS markers or defined to be reset by SOI.
00560    */
00561 
00562   int data_precision;           /* bits of precision in image data */
00563 
00564   jpeg_component_info * comp_info;
00565   /* comp_info[i] describes component that appears i'th in SOF */
00566 
00567   boolean is_baseline;          /* TRUE if Baseline SOF0 encountered */
00568   boolean progressive_mode;     /* TRUE if SOFn specifies progressive mode */
00569   boolean arith_code;           /* TRUE=arithmetic coding, FALSE=Huffman */
00570 
00571   UINT8 arith_dc_L[NUM_ARITH_TBLS]; /* L values for DC arith-coding tables */
00572   UINT8 arith_dc_U[NUM_ARITH_TBLS]; /* U values for DC arith-coding tables */
00573   UINT8 arith_ac_K[NUM_ARITH_TBLS]; /* Kx values for AC arith-coding tables */
00574 
00575   unsigned int restart_interval; /* MCUs per restart interval, or 0 for no restart */
00576 
00577   /* These fields record data obtained from optional markers recognized by
00578    * the JPEG library.
00579    */
00580   boolean saw_JFIF_marker;      /* TRUE iff a JFIF APP0 marker was found */
00581   /* Data copied from JFIF marker; only valid if saw_JFIF_marker is TRUE: */
00582   UINT8 JFIF_major_version;     /* JFIF version number */
00583   UINT8 JFIF_minor_version;
00584   UINT8 density_unit;           /* JFIF code for pixel size units */
00585   UINT16 X_density;             /* Horizontal pixel density */
00586   UINT16 Y_density;             /* Vertical pixel density */
00587   boolean saw_Adobe_marker;     /* TRUE iff an Adobe APP14 marker was found */
00588   UINT8 Adobe_transform;        /* Color transform code from Adobe marker */
00589 
00590   boolean CCIR601_sampling;     /* TRUE=first samples are cosited */
00591 
00592   /* Aside from the specific data retained from APPn markers known to the
00593    * library, the uninterpreted contents of any or all APPn and COM markers
00594    * can be saved in a list for examination by the application.
00595    */
00596   jpeg_saved_marker_ptr marker_list; /* Head of list of saved markers */
00597 
00598   /* Remaining fields are known throughout decompressor, but generally
00599    * should not be touched by a surrounding application.
00600    */
00601 
00602   /*
00603    * These fields are computed during decompression startup
00604    */
00605   int max_h_samp_factor;        /* largest h_samp_factor */
00606   int max_v_samp_factor;        /* largest v_samp_factor */
00607 
00608   int min_DCT_h_scaled_size;    /* smallest DCT_h_scaled_size of any component */
00609   int min_DCT_v_scaled_size;    /* smallest DCT_v_scaled_size of any component */
00610 
00611   JDIMENSION total_iMCU_rows;   /* # of iMCU rows in image */
00612   /* The coefficient controller's input and output progress is measured in
00613    * units of "iMCU" (interleaved MCU) rows.  These are the same as MCU rows
00614    * in fully interleaved JPEG scans, but are used whether the scan is
00615    * interleaved or not.  We define an iMCU row as v_samp_factor DCT block
00616    * rows of each component.  Therefore, the IDCT output contains
00617    * v_samp_factor*DCT_v_scaled_size sample rows of a component per iMCU row.
00618    */
00619 
00620   JSAMPLE * sample_range_limit; /* table for fast range-limiting */
00621 
00622   /*
00623    * These fields are valid during any one scan.
00624    * They describe the components and MCUs actually appearing in the scan.
00625    * Note that the decompressor output side must not use these fields.
00626    */
00627   int comps_in_scan;            /* # of JPEG components in this scan */
00628   jpeg_component_info * cur_comp_info[MAX_COMPS_IN_SCAN];
00629   /* *cur_comp_info[i] describes component that appears i'th in SOS */
00630 
00631   JDIMENSION MCUs_per_row;      /* # of MCUs across the image */
00632   JDIMENSION MCU_rows_in_scan;  /* # of MCU rows in the image */
00633 
00634   int blocks_in_MCU;            /* # of DCT blocks per MCU */
00635   int MCU_membership[D_MAX_BLOCKS_IN_MCU];
00636   /* MCU_membership[i] is index in cur_comp_info of component owning */
00637   /* i'th block in an MCU */
00638 
00639   int Ss, Se, Ah, Al;           /* progressive JPEG parameters for scan */
00640 
00641   /* These fields are derived from Se of first SOS marker.
00642    */
00643   int block_size;               /* the basic DCT block size: 1..16 */
00644   const int * natural_order; /* natural-order position array for entropy decode */
00645   int lim_Se;                   /* min( Se, DCTSIZE2-1 ) for entropy decode */
00646 
00647   /* This field is shared between entropy decoder and marker parser.
00648    * It is either zero or the code of a JPEG marker that has been
00649    * read from the data source, but has not yet been processed.
00650    */
00651   int unread_marker;
00652 
00653   /*
00654    * Links to decompression subobjects (methods, private variables of modules)
00655    */
00656   struct jpeg_decomp_master * master;
00657   struct jpeg_d_main_controller * main;
00658   struct jpeg_d_coef_controller * coef;
00659   struct jpeg_d_post_controller * post;
00660   struct jpeg_input_controller * inputctl;
00661   struct jpeg_marker_reader * marker;
00662   struct jpeg_entropy_decoder * entropy;
00663   struct jpeg_inverse_dct * idct;
00664   struct jpeg_upsampler * upsample;
00665   struct jpeg_color_deconverter * cconvert;
00666   struct jpeg_color_quantizer * cquantize;
00667 };
00668 
00669 
00670 /* "Object" declarations for JPEG modules that may be supplied or called
00671  * directly by the surrounding application.
00672  * As with all objects in the JPEG library, these structs only define the
00673  * publicly visible methods and state variables of a module.  Additional
00674  * private fields may exist after the public ones.
00675  */
00676 
00677 
00678 /* Error handler object */
00679 
00680 struct jpeg_error_mgr {
00681   /* Error exit handler: does not return to caller */
00682   JMETHOD(void, error_exit, (j_common_ptr cinfo));
00683   /* Conditionally emit a trace or warning message */
00684   JMETHOD(void, emit_message, (j_common_ptr cinfo, int msg_level));
00685   /* Routine that actually outputs a trace or error message */
00686   JMETHOD(void, output_message, (j_common_ptr cinfo));
00687   /* Format a message string for the most recent JPEG error or message */
00688   JMETHOD(void, format_message, (j_common_ptr cinfo, char * buffer));
00689 #define JMSG_LENGTH_MAX  200    /* recommended size of format_message buffer */
00690   /* Reset error state variables at start of a new image */
00691   JMETHOD(void, reset_error_mgr, (j_common_ptr cinfo));
00692   
00693   /* The message ID code and any parameters are saved here.
00694    * A message can have one string parameter or up to 8 int parameters.
00695    */
00696   int msg_code;
00697 #define JMSG_STR_PARM_MAX  80
00698   union {
00699     int i[8];
00700     char s[JMSG_STR_PARM_MAX];
00701   } msg_parm;
00702   
00703   /* Standard state variables for error facility */
00704   
00705   int trace_level;              /* max msg_level that will be displayed */
00706   
00707   /* For recoverable corrupt-data errors, we emit a warning message,
00708    * but keep going unless emit_message chooses to abort.  emit_message
00709    * should count warnings in num_warnings.  The surrounding application
00710    * can check for bad data by seeing if num_warnings is nonzero at the
00711    * end of processing.
00712    */
00713   long num_warnings;            /* number of corrupt-data warnings */
00714 
00715   /* These fields point to the table(s) of error message strings.
00716    * An application can change the table pointer to switch to a different
00717    * message list (typically, to change the language in which errors are
00718    * reported).  Some applications may wish to add additional error codes
00719    * that will be handled by the JPEG library error mechanism; the second
00720    * table pointer is used for this purpose.
00721    *
00722    * First table includes all errors generated by JPEG library itself.
00723    * Error code 0 is reserved for a "no such error string" message.
00724    */
00725   const char * const * jpeg_message_table; /* Library errors */
00726   int last_jpeg_message;    /* Table contains strings 0..last_jpeg_message */
00727   /* Second table can be added by application (see cjpeg/djpeg for example).
00728    * It contains strings numbered first_addon_message..last_addon_message.
00729    */
00730   const char * const * addon_message_table; /* Non-library errors */
00731   int first_addon_message;      /* code for first string in addon table */
00732   int last_addon_message;       /* code for last string in addon table */
00733 };
00734 
00735 
00736 /* Progress monitor object */
00737 
00738 struct jpeg_progress_mgr {
00739   JMETHOD(void, progress_monitor, (j_common_ptr cinfo));
00740 
00741   long pass_counter;            /* work units completed in this pass */
00742   long pass_limit;              /* total number of work units in this pass */
00743   int completed_passes;         /* passes completed so far */
00744   int total_passes;             /* total number of passes expected */
00745 };
00746 
00747 
00748 /* Data destination object for compression */
00749 
00750 struct jpeg_destination_mgr {
00751   JOCTET * next_output_byte;    /* => next byte to write in buffer */
00752   size_t free_in_buffer;        /* # of byte spaces remaining in buffer */
00753 
00754   JMETHOD(void, init_destination, (j_compress_ptr cinfo));
00755   JMETHOD(boolean, empty_output_buffer, (j_compress_ptr cinfo));
00756   JMETHOD(void, term_destination, (j_compress_ptr cinfo));
00757 };
00758 
00759 
00760 /* Data source object for decompression */
00761 
00762 struct jpeg_source_mgr {
00763   const JOCTET * next_input_byte; /* => next byte to read from buffer */
00764   size_t bytes_in_buffer;       /* # of bytes remaining in buffer */
00765 
00766   JMETHOD(void, init_source, (j_decompress_ptr cinfo));
00767   JMETHOD(boolean, fill_input_buffer, (j_decompress_ptr cinfo));
00768   JMETHOD(void, skip_input_data, (j_decompress_ptr cinfo, long num_bytes));
00769   JMETHOD(boolean, resync_to_restart, (j_decompress_ptr cinfo, int desired));
00770   JMETHOD(void, term_source, (j_decompress_ptr cinfo));
00771 };
00772 
00773 
00774 /* Memory manager object.
00775  * Allocates "small" objects (a few K total), "large" objects (tens of K),
00776  * and "really big" objects (virtual arrays with backing store if needed).
00777  * The memory manager does not allow individual objects to be freed; rather,
00778  * each created object is assigned to a pool, and whole pools can be freed
00779  * at once.  This is faster and more convenient than remembering exactly what
00780  * to free, especially where malloc()/free() are not too speedy.
00781  * NB: alloc routines never return NULL.  They exit to error_exit if not
00782  * successful.
00783  */
00784 
00785 #define JPOOL_PERMANENT 0       /* lasts until master record is destroyed */
00786 #define JPOOL_IMAGE     1       /* lasts until done with image/datastream */
00787 #define JPOOL_NUMPOOLS  2
00788 
00789 typedef struct jvirt_sarray_control * jvirt_sarray_ptr;
00790 typedef struct jvirt_barray_control * jvirt_barray_ptr;
00791 
00792 
00793 struct jpeg_memory_mgr {
00794   /* Method pointers */
00795   JMETHOD(void *, alloc_small, (j_common_ptr cinfo, int pool_id,
00796                                 size_t sizeofobject));
00797   JMETHOD(void FAR *, alloc_large, (j_common_ptr cinfo, int pool_id,
00798                                      size_t sizeofobject));
00799   JMETHOD(JSAMPARRAY, alloc_sarray, (j_common_ptr cinfo, int pool_id,
00800                                      JDIMENSION samplesperrow,
00801                                      JDIMENSION numrows));
00802   JMETHOD(JBLOCKARRAY, alloc_barray, (j_common_ptr cinfo, int pool_id,
00803                                       JDIMENSION blocksperrow,
00804                                       JDIMENSION numrows));
00805   JMETHOD(jvirt_sarray_ptr, request_virt_sarray, (j_common_ptr cinfo,
00806                                                   int pool_id,
00807                                                   boolean pre_zero,
00808                                                   JDIMENSION samplesperrow,
00809                                                   JDIMENSION numrows,
00810                                                   JDIMENSION maxaccess));
00811   JMETHOD(jvirt_barray_ptr, request_virt_barray, (j_common_ptr cinfo,
00812                                                   int pool_id,
00813                                                   boolean pre_zero,
00814                                                   JDIMENSION blocksperrow,
00815                                                   JDIMENSION numrows,
00816                                                   JDIMENSION maxaccess));
00817   JMETHOD(void, realize_virt_arrays, (j_common_ptr cinfo));
00818   JMETHOD(JSAMPARRAY, access_virt_sarray, (j_common_ptr cinfo,
00819                                            jvirt_sarray_ptr ptr,
00820                                            JDIMENSION start_row,
00821                                            JDIMENSION num_rows,
00822                                            boolean writable));
00823   JMETHOD(JBLOCKARRAY, access_virt_barray, (j_common_ptr cinfo,
00824                                             jvirt_barray_ptr ptr,
00825                                             JDIMENSION start_row,
00826                                             JDIMENSION num_rows,
00827                                             boolean writable));
00828   JMETHOD(void, free_pool, (j_common_ptr cinfo, int pool_id));
00829   JMETHOD(void, self_destruct, (j_common_ptr cinfo));
00830 
00831   /* Limit on memory allocation for this JPEG object.  (Note that this is
00832    * merely advisory, not a guaranteed maximum; it only affects the space
00833    * used for virtual-array buffers.)  May be changed by outer application
00834    * after creating the JPEG object.
00835    */
00836   long max_memory_to_use;
00837 
00838   /* Maximum allocation request accepted by alloc_large. */
00839   long max_alloc_chunk;
00840 };
00841 
00842 
00843 /* Routine signature for application-supplied marker processing methods.
00844  * Need not pass marker code since it is stored in cinfo->unread_marker.
00845  */
00846 typedef JMETHOD(boolean, jpeg_marker_parser_method, (j_decompress_ptr cinfo));
00847 
00848 
00849 /* Declarations for routines called by application.
00850  * The JPP macro hides prototype parameters from compilers that can't cope.
00851  * Note JPP requires double parentheses.
00852  */
00853 
00854 #ifdef HAVE_PROTOTYPES
00855 #define JPP(arglist)    arglist
00856 #else
00857 #define JPP(arglist)    ()
00858 #endif
00859 
00860 
00861 /* Short forms of external names for systems with brain-damaged linkers.
00862  * We shorten external names to be unique in the first six letters, which
00863  * is good enough for all known systems.
00864  * (If your compiler itself needs names to be unique in less than 15 
00865  * characters, you are out of luck.  Get a better compiler.)
00866  */
00867 
00868 #ifdef NEED_SHORT_EXTERNAL_NAMES
00869 #define jpeg_std_error          jStdError
00870 #define jpeg_CreateCompress     jCreaCompress
00871 #define jpeg_CreateDecompress   jCreaDecompress
00872 #define jpeg_destroy_compress   jDestCompress
00873 #define jpeg_destroy_decompress jDestDecompress
00874 #define jpeg_stdio_dest         jStdDest
00875 #define jpeg_stdio_src          jStdSrc
00876 #define jpeg_mem_dest           jMemDest
00877 #define jpeg_mem_src            jMemSrc
00878 #define jpeg_set_defaults       jSetDefaults
00879 #define jpeg_set_colorspace     jSetColorspace
00880 #define jpeg_default_colorspace jDefColorspace
00881 #define jpeg_set_quality        jSetQuality
00882 #define jpeg_set_linear_quality jSetLQuality
00883 #define jpeg_default_qtables    jDefQTables
00884 #define jpeg_add_quant_table    jAddQuantTable
00885 #define jpeg_quality_scaling    jQualityScaling
00886 #define jpeg_simple_progression jSimProgress
00887 #define jpeg_suppress_tables    jSuppressTables
00888 #define jpeg_alloc_quant_table  jAlcQTable
00889 #define jpeg_alloc_huff_table   jAlcHTable
00890 #define jpeg_start_compress     jStrtCompress
00891 #define jpeg_write_scanlines    jWrtScanlines
00892 #define jpeg_finish_compress    jFinCompress
00893 #define jpeg_calc_jpeg_dimensions       jCjpegDimensions
00894 #define jpeg_write_raw_data     jWrtRawData
00895 #define jpeg_write_marker       jWrtMarker
00896 #define jpeg_write_m_header     jWrtMHeader
00897 #define jpeg_write_m_byte       jWrtMByte
00898 #define jpeg_write_tables       jWrtTables
00899 #define jpeg_read_header        jReadHeader
00900 #define jpeg_start_decompress   jStrtDecompress
00901 #define jpeg_read_scanlines     jReadScanlines
00902 #define jpeg_finish_decompress  jFinDecompress
00903 #define jpeg_read_raw_data      jReadRawData
00904 #define jpeg_has_multiple_scans jHasMultScn
00905 #define jpeg_start_output       jStrtOutput
00906 #define jpeg_finish_output      jFinOutput
00907 #define jpeg_input_complete     jInComplete
00908 #define jpeg_new_colormap       jNewCMap
00909 #define jpeg_consume_input      jConsumeInput
00910 #define jpeg_core_output_dimensions     jCoreDimensions
00911 #define jpeg_calc_output_dimensions     jCalcDimensions
00912 #define jpeg_save_markers       jSaveMarkers
00913 #define jpeg_set_marker_processor       jSetMarker
00914 #define jpeg_read_coefficients  jReadCoefs
00915 #define jpeg_write_coefficients jWrtCoefs
00916 #define jpeg_copy_critical_parameters   jCopyCrit
00917 #define jpeg_abort_compress     jAbrtCompress
00918 #define jpeg_abort_decompress   jAbrtDecompress
00919 #define jpeg_abort              jAbort
00920 #define jpeg_destroy            jDestroy
00921 #define jpeg_resync_to_restart  jResyncRestart
00922 #endif /* NEED_SHORT_EXTERNAL_NAMES */
00923 
00924 
00925 /* Default error-management setup */
00926 EXTERN(struct jpeg_error_mgr *) jpeg_std_error
00927         JPP((struct jpeg_error_mgr * err));
00928 
00929 /* Initialization of JPEG compression objects.
00930  * jpeg_create_compress() and jpeg_create_decompress() are the exported
00931  * names that applications should call.  These expand to calls on
00932  * jpeg_CreateCompress and jpeg_CreateDecompress with additional information
00933  * passed for version mismatch checking.
00934  * NB: you must set up the error-manager BEFORE calling jpeg_create_xxx.
00935  */
00936 #define jpeg_create_compress(cinfo) \
00937     jpeg_CreateCompress((cinfo), JPEG_LIB_VERSION, \
00938                         (size_t) sizeof(struct jpeg_compress_struct))
00939 #define jpeg_create_decompress(cinfo) \
00940     jpeg_CreateDecompress((cinfo), JPEG_LIB_VERSION, \
00941                           (size_t) sizeof(struct jpeg_decompress_struct))
00942 EXTERN(void) jpeg_CreateCompress JPP((j_compress_ptr cinfo,
00943                                       int version, size_t structsize));
00944 EXTERN(void) jpeg_CreateDecompress JPP((j_decompress_ptr cinfo,
00945                                         int version, size_t structsize));
00946 /* Destruction of JPEG compression objects */
00947 EXTERN(void) jpeg_destroy_compress JPP((j_compress_ptr cinfo));
00948 EXTERN(void) jpeg_destroy_decompress JPP((j_decompress_ptr cinfo));
00949 
00950 /* Standard data source and destination managers: stdio streams. */
00951 /* Caller is responsible for opening the file before and closing after. */
00952 EXTERN(void) jpeg_stdio_dest JPP((j_compress_ptr cinfo, FILE * outfile));
00953 EXTERN(void) jpeg_stdio_src JPP((j_decompress_ptr cinfo, FILE * infile));
00954 
00955 /* Data source and destination managers: memory buffers. */
00956 EXTERN(void) jpeg_mem_dest JPP((j_compress_ptr cinfo,
00957                                unsigned char ** outbuffer,
00958                                unsigned long * outsize));
00959 EXTERN(void) jpeg_mem_src JPP((j_decompress_ptr cinfo,
00960                               unsigned char * inbuffer,
00961                               unsigned long insize));
00962 
00963 /* Default parameter setup for compression */
00964 EXTERN(void) jpeg_set_defaults JPP((j_compress_ptr cinfo));
00965 /* Compression parameter setup aids */
00966 EXTERN(void) jpeg_set_colorspace JPP((j_compress_ptr cinfo,
00967                                       J_COLOR_SPACE colorspace));
00968 EXTERN(void) jpeg_default_colorspace JPP((j_compress_ptr cinfo));
00969 EXTERN(void) jpeg_set_quality JPP((j_compress_ptr cinfo, int quality,
00970                                    boolean force_baseline));
00971 EXTERN(void) jpeg_set_linear_quality JPP((j_compress_ptr cinfo,
00972                                           int scale_factor,
00973                                           boolean force_baseline));
00974 EXTERN(void) jpeg_default_qtables JPP((j_compress_ptr cinfo,
00975                                        boolean force_baseline));
00976 EXTERN(void) jpeg_add_quant_table JPP((j_compress_ptr cinfo, int which_tbl,
00977                                        const unsigned int *basic_table,
00978                                        int scale_factor,
00979                                        boolean force_baseline));
00980 EXTERN(int) jpeg_quality_scaling JPP((int quality));
00981 EXTERN(void) jpeg_simple_progression JPP((j_compress_ptr cinfo));
00982 EXTERN(void) jpeg_suppress_tables JPP((j_compress_ptr cinfo,
00983                                        boolean suppress));
00984 EXTERN(JQUANT_TBL *) jpeg_alloc_quant_table JPP((j_common_ptr cinfo));
00985 EXTERN(JHUFF_TBL *) jpeg_alloc_huff_table JPP((j_common_ptr cinfo));
00986 
00987 /* Main entry points for compression */
00988 EXTERN(void) jpeg_start_compress JPP((j_compress_ptr cinfo,
00989                                       boolean write_all_tables));
00990 EXTERN(JDIMENSION) jpeg_write_scanlines JPP((j_compress_ptr cinfo,
00991                                              JSAMPARRAY scanlines,
00992                                              JDIMENSION num_lines));
00993 EXTERN(void) jpeg_finish_compress JPP((j_compress_ptr cinfo));
00994 
00995 /* Precalculate JPEG dimensions for current compression parameters. */
00996 EXTERN(void) jpeg_calc_jpeg_dimensions JPP((j_compress_ptr cinfo));
00997 
00998 /* Replaces jpeg_write_scanlines when writing raw downsampled data. */
00999 EXTERN(JDIMENSION) jpeg_write_raw_data JPP((j_compress_ptr cinfo,
01000                                             JSAMPIMAGE data,
01001                                             JDIMENSION num_lines));
01002 
01003 /* Write a special marker.  See libjpeg.txt concerning safe usage. */
01004 EXTERN(void) jpeg_write_marker
01005         JPP((j_compress_ptr cinfo, int marker,
01006              const JOCTET * dataptr, unsigned int datalen));
01007 /* Same, but piecemeal. */
01008 EXTERN(void) jpeg_write_m_header
01009         JPP((j_compress_ptr cinfo, int marker, unsigned int datalen));
01010 EXTERN(void) jpeg_write_m_byte
01011         JPP((j_compress_ptr cinfo, int val));
01012 
01013 /* Alternate compression function: just write an abbreviated table file */
01014 EXTERN(void) jpeg_write_tables JPP((j_compress_ptr cinfo));
01015 
01016 /* Decompression startup: read start of JPEG datastream to see what's there */
01017 EXTERN(int) jpeg_read_header JPP((j_decompress_ptr cinfo,
01018                                   boolean require_image));
01019 /* Return value is one of: */
01020 #define JPEG_SUSPENDED          0 /* Suspended due to lack of input data */
01021 #define JPEG_HEADER_OK          1 /* Found valid image datastream */
01022 #define JPEG_HEADER_TABLES_ONLY 2 /* Found valid table-specs-only datastream */
01023 /* If you pass require_image = TRUE (normal case), you need not check for
01024  * a TABLES_ONLY return code; an abbreviated file will cause an error exit.
01025  * JPEG_SUSPENDED is only possible if you use a data source module that can
01026  * give a suspension return (the stdio source module doesn't).
01027  */
01028 
01029 /* Main entry points for decompression */
01030 EXTERN(boolean) jpeg_start_decompress JPP((j_decompress_ptr cinfo));
01031 EXTERN(JDIMENSION) jpeg_read_scanlines JPP((j_decompress_ptr cinfo,
01032                                             JSAMPARRAY scanlines,
01033                                             JDIMENSION max_lines));
01034 EXTERN(boolean) jpeg_finish_decompress JPP((j_decompress_ptr cinfo));
01035 
01036 /* Replaces jpeg_read_scanlines when reading raw downsampled data. */
01037 EXTERN(JDIMENSION) jpeg_read_raw_data JPP((j_decompress_ptr cinfo,
01038                                            JSAMPIMAGE data,
01039                                            JDIMENSION max_lines));
01040 
01041 /* Additional entry points for buffered-image mode. */
01042 EXTERN(boolean) jpeg_has_multiple_scans JPP((j_decompress_ptr cinfo));
01043 EXTERN(boolean) jpeg_start_output JPP((j_decompress_ptr cinfo,
01044                                        int scan_number));
01045 EXTERN(boolean) jpeg_finish_output JPP((j_decompress_ptr cinfo));
01046 EXTERN(boolean) jpeg_input_complete JPP((j_decompress_ptr cinfo));
01047 EXTERN(void) jpeg_new_colormap JPP((j_decompress_ptr cinfo));
01048 EXTERN(int) jpeg_consume_input JPP((j_decompress_ptr cinfo));
01049 /* Return value is one of: */
01050 /* #define JPEG_SUSPENDED       0    Suspended due to lack of input data */
01051 #define JPEG_REACHED_SOS        1 /* Reached start of new scan */
01052 #define JPEG_REACHED_EOI        2 /* Reached end of image */
01053 #define JPEG_ROW_COMPLETED      3 /* Completed one iMCU row */
01054 #define JPEG_SCAN_COMPLETED     4 /* Completed last iMCU row of a scan */
01055 
01056 /* Precalculate output dimensions for current decompression parameters. */
01057 EXTERN(void) jpeg_core_output_dimensions JPP((j_decompress_ptr cinfo));
01058 EXTERN(void) jpeg_calc_output_dimensions JPP((j_decompress_ptr cinfo));
01059 
01060 /* Control saving of COM and APPn markers into marker_list. */
01061 EXTERN(void) jpeg_save_markers
01062         JPP((j_decompress_ptr cinfo, int marker_code,
01063              unsigned int length_limit));
01064 
01065 /* Install a special processing method for COM or APPn markers. */
01066 EXTERN(void) jpeg_set_marker_processor
01067         JPP((j_decompress_ptr cinfo, int marker_code,
01068              jpeg_marker_parser_method routine));
01069 
01070 /* Read or write raw DCT coefficients --- useful for lossless transcoding. */
01071 EXTERN(jvirt_barray_ptr *) jpeg_read_coefficients JPP((j_decompress_ptr cinfo));
01072 EXTERN(void) jpeg_write_coefficients JPP((j_compress_ptr cinfo,
01073                                           jvirt_barray_ptr * coef_arrays));
01074 EXTERN(void) jpeg_copy_critical_parameters JPP((j_decompress_ptr srcinfo,
01075                                                 j_compress_ptr dstinfo));
01076 
01077 /* If you choose to abort compression or decompression before completing
01078  * jpeg_finish_(de)compress, then you need to clean up to release memory,
01079  * temporary files, etc.  You can just call jpeg_destroy_(de)compress
01080  * if you're done with the JPEG object, but if you want to clean it up and
01081  * reuse it, call this:
01082  */
01083 EXTERN(void) jpeg_abort_compress JPP((j_compress_ptr cinfo));
01084 EXTERN(void) jpeg_abort_decompress JPP((j_decompress_ptr cinfo));
01085 
01086 /* Generic versions of jpeg_abort and jpeg_destroy that work on either
01087  * flavor of JPEG object.  These may be more convenient in some places.
01088  */
01089 EXTERN(void) jpeg_abort JPP((j_common_ptr cinfo));
01090 EXTERN(void) jpeg_destroy JPP((j_common_ptr cinfo));
01091 
01092 /* Default restart-marker-resync procedure for use by data source modules */
01093 EXTERN(boolean) jpeg_resync_to_restart JPP((j_decompress_ptr cinfo,
01094                                             int desired));
01095 
01096 
01097 /* These marker codes are exported since applications and data source modules
01098  * are likely to want to use them.
01099  */
01100 
01101 #define JPEG_RST0       0xD0    /* RST0 marker code */
01102 #define JPEG_EOI        0xD9    /* EOI marker code */
01103 #define JPEG_APP0       0xE0    /* APP0 marker code */
01104 #define JPEG_COM        0xFE    /* COM marker code */
01105 
01106 
01107 /* If we have a brain-damaged compiler that emits warnings (or worse, errors)
01108  * for structure definitions that are never filled in, keep it quiet by
01109  * supplying dummy definitions for the various substructures.
01110  */
01111 
01112 #ifdef INCOMPLETE_TYPES_BROKEN
01113 #ifndef JPEG_INTERNALS          /* will be defined in jpegint.h */
01114 struct jvirt_sarray_control { long dummy; };
01115 struct jvirt_barray_control { long dummy; };
01116 struct jpeg_comp_master { long dummy; };
01117 struct jpeg_c_main_controller { long dummy; };
01118 struct jpeg_c_prep_controller { long dummy; };
01119 struct jpeg_c_coef_controller { long dummy; };
01120 struct jpeg_marker_writer { long dummy; };
01121 struct jpeg_color_converter { long dummy; };
01122 struct jpeg_downsampler { long dummy; };
01123 struct jpeg_forward_dct { long dummy; };
01124 struct jpeg_entropy_encoder { long dummy; };
01125 struct jpeg_decomp_master { long dummy; };
01126 struct jpeg_d_main_controller { long dummy; };
01127 struct jpeg_d_coef_controller { long dummy; };
01128 struct jpeg_d_post_controller { long dummy; };
01129 struct jpeg_input_controller { long dummy; };
01130 struct jpeg_marker_reader { long dummy; };
01131 struct jpeg_entropy_decoder { long dummy; };
01132 struct jpeg_inverse_dct { long dummy; };
01133 struct jpeg_upsampler { long dummy; };
01134 struct jpeg_color_deconverter { long dummy; };
01135 struct jpeg_color_quantizer { long dummy; };
01136 #endif /* JPEG_INTERNALS */
01137 #endif /* INCOMPLETE_TYPES_BROKEN */
01138 
01139 
01140 /*
01141  * The JPEG library modules define JPEG_INTERNALS before including this file.
01142  * The internal structure declarations are read only when that is true.
01143  * Applications using the library should not include jpegint.h, but may wish
01144  * to include jerror.h.
01145  */
01146 
01147 #ifdef JPEG_INTERNALS
01148 #include "jpegint.h"            /* fetch private declarations */
01149 #include "jerror.h"             /* fetch error codes too */
01150 #endif
01151 
01152 #ifdef __cplusplus
01153 #ifndef DONT_USE_EXTERN_C
01154 }
01155 #endif
01156 #endif
01157 
01158 #endif /* JPEGLIB_H */

Generated on Tue Jul 5 14:13:29 2011 for ROOT_528-00b_version by  doxygen 1.5.1