istereo

annotate libs/libjpeg/jpeglib.h @ 33:33e9eedad390

find changesets by author, revision, files, or words in the commit message
ah.. blunder
author John Tsiombikas <nuclear@mutantstargoat.com>
date Fri, 09 Sep 2011 00:03:37 +0300
parents
children
rev   line source
nuclear@26 1 /*
nuclear@26 2 * jpeglib.h
nuclear@26 3 *
nuclear@26 4 * Copyright (C) 1991-1998, Thomas G. Lane.
nuclear@26 5 * This file is part of the Independent JPEG Group's software.
nuclear@26 6 * For conditions of distribution and use, see the accompanying README file.
nuclear@26 7 *
nuclear@26 8 * This file defines the application interface for the JPEG library.
nuclear@26 9 * Most applications using the library need only include this file,
nuclear@26 10 * and perhaps jerror.h if they want to know the exact error codes.
nuclear@26 11 */
nuclear@26 12
nuclear@26 13 #ifndef JPEGLIB_H
nuclear@26 14 #define JPEGLIB_H
nuclear@26 15
nuclear@26 16 /*
nuclear@26 17 * First we include the configuration files that record how this
nuclear@26 18 * installation of the JPEG library is set up. jconfig.h can be
nuclear@26 19 * generated automatically for many systems. jmorecfg.h contains
nuclear@26 20 * manual configuration options that most people need not worry about.
nuclear@26 21 */
nuclear@26 22
nuclear@26 23 #ifndef JCONFIG_INCLUDED /* in case jinclude.h already did */
nuclear@26 24 #include "jconfig.h" /* widely used configuration options */
nuclear@26 25 #endif
nuclear@26 26 #include "jmorecfg.h" /* seldom changed options */
nuclear@26 27
nuclear@26 28
nuclear@26 29 /* Version ID for the JPEG library.
nuclear@26 30 * Might be useful for tests like "#if JPEG_LIB_VERSION >= 60".
nuclear@26 31 */
nuclear@26 32
nuclear@26 33 #define JPEG_LIB_VERSION 62 /* Version 6b */
nuclear@26 34
nuclear@26 35
nuclear@26 36 /* Various constants determining the sizes of things.
nuclear@26 37 * All of these are specified by the JPEG standard, so don't change them
nuclear@26 38 * if you want to be compatible.
nuclear@26 39 */
nuclear@26 40
nuclear@26 41 #define DCTSIZE 8 /* The basic DCT block is 8x8 samples */
nuclear@26 42 #define DCTSIZE2 64 /* DCTSIZE squared; # of elements in a block */
nuclear@26 43 #define NUM_QUANT_TBLS 4 /* Quantization tables are numbered 0..3 */
nuclear@26 44 #define NUM_HUFF_TBLS 4 /* Huffman tables are numbered 0..3 */
nuclear@26 45 #define NUM_ARITH_TBLS 16 /* Arith-coding tables are numbered 0..15 */
nuclear@26 46 #define MAX_COMPS_IN_SCAN 4 /* JPEG limit on # of components in one scan */
nuclear@26 47 #define MAX_SAMP_FACTOR 4 /* JPEG limit on sampling factors */
nuclear@26 48 /* Unfortunately, some bozo at Adobe saw no reason to be bound by the standard;
nuclear@26 49 * the PostScript DCT filter can emit files with many more than 10 blocks/MCU.
nuclear@26 50 * If you happen to run across such a file, you can up D_MAX_BLOCKS_IN_MCU
nuclear@26 51 * to handle it. We even let you do this from the jconfig.h file. However,
nuclear@26 52 * we strongly discourage changing C_MAX_BLOCKS_IN_MCU; just because Adobe
nuclear@26 53 * sometimes emits noncompliant files doesn't mean you should too.
nuclear@26 54 */
nuclear@26 55 #define C_MAX_BLOCKS_IN_MCU 10 /* compressor's limit on blocks per MCU */
nuclear@26 56 #ifndef D_MAX_BLOCKS_IN_MCU
nuclear@26 57 #define D_MAX_BLOCKS_IN_MCU 10 /* decompressor's limit on blocks per MCU */
nuclear@26 58 #endif
nuclear@26 59
nuclear@26 60
nuclear@26 61 /* Data structures for images (arrays of samples and of DCT coefficients).
nuclear@26 62 * On 80x86 machines, the image arrays are too big for near pointers,
nuclear@26 63 * but the pointer arrays can fit in near memory.
nuclear@26 64 */
nuclear@26 65
nuclear@26 66 typedef JSAMPLE FAR *JSAMPROW; /* ptr to one image row of pixel samples. */
nuclear@26 67 typedef JSAMPROW *JSAMPARRAY; /* ptr to some rows (a 2-D sample array) */
nuclear@26 68 typedef JSAMPARRAY *JSAMPIMAGE; /* a 3-D sample array: top index is color */
nuclear@26 69
nuclear@26 70 typedef JCOEF JBLOCK[DCTSIZE2]; /* one block of coefficients */
nuclear@26 71 typedef JBLOCK FAR *JBLOCKROW; /* pointer to one row of coefficient blocks */
nuclear@26 72 typedef JBLOCKROW *JBLOCKARRAY; /* a 2-D array of coefficient blocks */
nuclear@26 73 typedef JBLOCKARRAY *JBLOCKIMAGE; /* a 3-D array of coefficient blocks */
nuclear@26 74
nuclear@26 75 typedef JCOEF FAR *JCOEFPTR; /* useful in a couple of places */
nuclear@26 76
nuclear@26 77
nuclear@26 78 /* Types for JPEG compression parameters and working tables. */
nuclear@26 79
nuclear@26 80
nuclear@26 81 /* DCT coefficient quantization tables. */
nuclear@26 82
nuclear@26 83 typedef struct {
nuclear@26 84 /* This array gives the coefficient quantizers in natural array order
nuclear@26 85 * (not the zigzag order in which they are stored in a JPEG DQT marker).
nuclear@26 86 * CAUTION: IJG versions prior to v6a kept this array in zigzag order.
nuclear@26 87 */
nuclear@26 88 UINT16 quantval[DCTSIZE2]; /* quantization step for each coefficient */
nuclear@26 89 /* This field is used only during compression. It's initialized FALSE when
nuclear@26 90 * the table is created, and set TRUE when it's been output to the file.
nuclear@26 91 * You could suppress output of a table by setting this to TRUE.
nuclear@26 92 * (See jpeg_suppress_tables for an example.)
nuclear@26 93 */
nuclear@26 94 boolean sent_table; /* TRUE when table has been output */
nuclear@26 95 } JQUANT_TBL;
nuclear@26 96
nuclear@26 97
nuclear@26 98 /* Huffman coding tables. */
nuclear@26 99
nuclear@26 100 typedef struct {
nuclear@26 101 /* These two fields directly represent the contents of a JPEG DHT marker */
nuclear@26 102 UINT8 bits[17]; /* bits[k] = # of symbols with codes of */
nuclear@26 103 /* length k bits; bits[0] is unused */
nuclear@26 104 UINT8 huffval[256]; /* The symbols, in order of incr code length */
nuclear@26 105 /* This field is used only during compression. It's initialized FALSE when
nuclear@26 106 * the table is created, and set TRUE when it's been output to the file.
nuclear@26 107 * You could suppress output of a table by setting this to TRUE.
nuclear@26 108 * (See jpeg_suppress_tables for an example.)
nuclear@26 109 */
nuclear@26 110 boolean sent_table; /* TRUE when table has been output */
nuclear@26 111 } JHUFF_TBL;
nuclear@26 112
nuclear@26 113
nuclear@26 114 /* Basic info about one component (color channel). */
nuclear@26 115
nuclear@26 116 typedef struct {
nuclear@26 117 /* These values are fixed over the whole image. */
nuclear@26 118 /* For compression, they must be supplied by parameter setup; */
nuclear@26 119 /* for decompression, they are read from the SOF marker. */
nuclear@26 120 int component_id; /* identifier for this component (0..255) */
nuclear@26 121 int component_index; /* its index in SOF or cinfo->comp_info[] */
nuclear@26 122 int h_samp_factor; /* horizontal sampling factor (1..4) */
nuclear@26 123 int v_samp_factor; /* vertical sampling factor (1..4) */
nuclear@26 124 int quant_tbl_no; /* quantization table selector (0..3) */
nuclear@26 125 /* These values may vary between scans. */
nuclear@26 126 /* For compression, they must be supplied by parameter setup; */
nuclear@26 127 /* for decompression, they are read from the SOS marker. */
nuclear@26 128 /* The decompressor output side may not use these variables. */
nuclear@26 129 int dc_tbl_no; /* DC entropy table selector (0..3) */
nuclear@26 130 int ac_tbl_no; /* AC entropy table selector (0..3) */
nuclear@26 131
nuclear@26 132 /* Remaining fields should be treated as private by applications. */
nuclear@26 133
nuclear@26 134 /* These values are computed during compression or decompression startup: */
nuclear@26 135 /* Component's size in DCT blocks.
nuclear@26 136 * Any dummy blocks added to complete an MCU are not counted; therefore
nuclear@26 137 * these values do not depend on whether a scan is interleaved or not.
nuclear@26 138 */
nuclear@26 139 JDIMENSION width_in_blocks;
nuclear@26 140 JDIMENSION height_in_blocks;
nuclear@26 141 /* Size of a DCT block in samples. Always DCTSIZE for compression.
nuclear@26 142 * For decompression this is the size of the output from one DCT block,
nuclear@26 143 * reflecting any scaling we choose to apply during the IDCT step.
nuclear@26 144 * Values of 1,2,4,8 are likely to be supported. Note that different
nuclear@26 145 * components may receive different IDCT scalings.
nuclear@26 146 */
nuclear@26 147 int DCT_scaled_size;
nuclear@26 148 /* The downsampled dimensions are the component's actual, unpadded number
nuclear@26 149 * of samples at the main buffer (preprocessing/compression interface), thus
nuclear@26 150 * downsampled_width = ceil(image_width * Hi/Hmax)
nuclear@26 151 * and similarly for height. For decompression, IDCT scaling is included, so
nuclear@26 152 * downsampled_width = ceil(image_width * Hi/Hmax * DCT_scaled_size/DCTSIZE)
nuclear@26 153 */
nuclear@26 154 JDIMENSION downsampled_width; /* actual width in samples */
nuclear@26 155 JDIMENSION downsampled_height; /* actual height in samples */
nuclear@26 156 /* This flag is used only for decompression. In cases where some of the
nuclear@26 157 * components will be ignored (eg grayscale output from YCbCr image),
nuclear@26 158 * we can skip most computations for the unused components.
nuclear@26 159 */
nuclear@26 160 boolean component_needed; /* do we need the value of this component? */
nuclear@26 161
nuclear@26 162 /* These values are computed before starting a scan of the component. */
nuclear@26 163 /* The decompressor output side may not use these variables. */
nuclear@26 164 int MCU_width; /* number of blocks per MCU, horizontally */
nuclear@26 165 int MCU_height; /* number of blocks per MCU, vertically */
nuclear@26 166 int MCU_blocks; /* MCU_width * MCU_height */
nuclear@26 167 int MCU_sample_width; /* MCU width in samples, MCU_width*DCT_scaled_size */
nuclear@26 168 int last_col_width; /* # of non-dummy blocks across in last MCU */
nuclear@26 169 int last_row_height; /* # of non-dummy blocks down in last MCU */
nuclear@26 170
nuclear@26 171 /* Saved quantization table for component; NULL if none yet saved.
nuclear@26 172 * See jdinput.c comments about the need for this information.
nuclear@26 173 * This field is currently used only for decompression.
nuclear@26 174 */
nuclear@26 175 JQUANT_TBL * quant_table;
nuclear@26 176
nuclear@26 177 /* Private per-component storage for DCT or IDCT subsystem. */
nuclear@26 178 void * dct_table;
nuclear@26 179 } jpeg_component_info;
nuclear@26 180
nuclear@26 181
nuclear@26 182 /* The script for encoding a multiple-scan file is an array of these: */
nuclear@26 183
nuclear@26 184 typedef struct {
nuclear@26 185 int comps_in_scan; /* number of components encoded in this scan */
nuclear@26 186 int component_index[MAX_COMPS_IN_SCAN]; /* their SOF/comp_info[] indexes */
nuclear@26 187 int Ss, Se; /* progressive JPEG spectral selection parms */
nuclear@26 188 int Ah, Al; /* progressive JPEG successive approx. parms */
nuclear@26 189 } jpeg_scan_info;
nuclear@26 190
nuclear@26 191 /* The decompressor can save APPn and COM markers in a list of these: */
nuclear@26 192
nuclear@26 193 typedef struct jpeg_marker_struct FAR * jpeg_saved_marker_ptr;
nuclear@26 194
nuclear@26 195 struct jpeg_marker_struct {
nuclear@26 196 jpeg_saved_marker_ptr next; /* next in list, or NULL */
nuclear@26 197 UINT8 marker; /* marker code: JPEG_COM, or JPEG_APP0+n */
nuclear@26 198 unsigned int original_length; /* # bytes of data in the file */
nuclear@26 199 unsigned int data_length; /* # bytes of data saved at data[] */
nuclear@26 200 JOCTET FAR * data; /* the data contained in the marker */
nuclear@26 201 /* the marker length word is not counted in data_length or original_length */
nuclear@26 202 };
nuclear@26 203
nuclear@26 204 /* Known color spaces. */
nuclear@26 205
nuclear@26 206 typedef enum {
nuclear@26 207 JCS_UNKNOWN, /* error/unspecified */
nuclear@26 208 JCS_GRAYSCALE, /* monochrome */
nuclear@26 209 JCS_RGB, /* red/green/blue */
nuclear@26 210 JCS_YCbCr, /* Y/Cb/Cr (also known as YUV) */
nuclear@26 211 JCS_CMYK, /* C/M/Y/K */
nuclear@26 212 JCS_YCCK /* Y/Cb/Cr/K */
nuclear@26 213 } J_COLOR_SPACE;
nuclear@26 214
nuclear@26 215 /* DCT/IDCT algorithm options. */
nuclear@26 216
nuclear@26 217 typedef enum {
nuclear@26 218 JDCT_ISLOW, /* slow but accurate integer algorithm */
nuclear@26 219 JDCT_IFAST, /* faster, less accurate integer method */
nuclear@26 220 JDCT_FLOAT /* floating-point: accurate, fast on fast HW */
nuclear@26 221 } J_DCT_METHOD;
nuclear@26 222
nuclear@26 223 #ifndef JDCT_DEFAULT /* may be overridden in jconfig.h */
nuclear@26 224 #define JDCT_DEFAULT JDCT_ISLOW
nuclear@26 225 #endif
nuclear@26 226 #ifndef JDCT_FASTEST /* may be overridden in jconfig.h */
nuclear@26 227 #define JDCT_FASTEST JDCT_IFAST
nuclear@26 228 #endif
nuclear@26 229
nuclear@26 230 /* Dithering options for decompression. */
nuclear@26 231
nuclear@26 232 typedef enum {
nuclear@26 233 JDITHER_NONE, /* no dithering */
nuclear@26 234 JDITHER_ORDERED, /* simple ordered dither */
nuclear@26 235 JDITHER_FS /* Floyd-Steinberg error diffusion dither */
nuclear@26 236 } J_DITHER_MODE;
nuclear@26 237
nuclear@26 238
nuclear@26 239 /* Common fields between JPEG compression and decompression master structs. */
nuclear@26 240
nuclear@26 241 #define jpeg_common_fields \
nuclear@26 242 struct jpeg_error_mgr * err; /* Error handler module */\
nuclear@26 243 struct jpeg_memory_mgr * mem; /* Memory manager module */\
nuclear@26 244 struct jpeg_progress_mgr * progress; /* Progress monitor, or NULL if none */\
nuclear@26 245 void * client_data; /* Available for use by application */\
nuclear@26 246 boolean is_decompressor; /* So common code can tell which is which */\
nuclear@26 247 int global_state /* For checking call sequence validity */
nuclear@26 248
nuclear@26 249 /* Routines that are to be used by both halves of the library are declared
nuclear@26 250 * to receive a pointer to this structure. There are no actual instances of
nuclear@26 251 * jpeg_common_struct, only of jpeg_compress_struct and jpeg_decompress_struct.
nuclear@26 252 */
nuclear@26 253 struct jpeg_common_struct {
nuclear@26 254 jpeg_common_fields; /* Fields common to both master struct types */
nuclear@26 255 /* Additional fields follow in an actual jpeg_compress_struct or
nuclear@26 256 * jpeg_decompress_struct. All three structs must agree on these
nuclear@26 257 * initial fields! (This would be a lot cleaner in C++.)
nuclear@26 258 */
nuclear@26 259 };
nuclear@26 260
nuclear@26 261 typedef struct jpeg_common_struct * j_common_ptr;
nuclear@26 262 typedef struct jpeg_compress_struct * j_compress_ptr;
nuclear@26 263 typedef struct jpeg_decompress_struct * j_decompress_ptr;
nuclear@26 264
nuclear@26 265
nuclear@26 266 /* Master record for a compression instance */
nuclear@26 267
nuclear@26 268 struct jpeg_compress_struct {
nuclear@26 269 jpeg_common_fields; /* Fields shared with jpeg_decompress_struct */
nuclear@26 270
nuclear@26 271 /* Destination for compressed data */
nuclear@26 272 struct jpeg_destination_mgr * dest;
nuclear@26 273
nuclear@26 274 /* Description of source image --- these fields must be filled in by
nuclear@26 275 * outer application before starting compression. in_color_space must
nuclear@26 276 * be correct before you can even call jpeg_set_defaults().
nuclear@26 277 */
nuclear@26 278
nuclear@26 279 JDIMENSION image_width; /* input image width */
nuclear@26 280 JDIMENSION image_height; /* input image height */
nuclear@26 281 int input_components; /* # of color components in input image */
nuclear@26 282 J_COLOR_SPACE in_color_space; /* colorspace of input image */
nuclear@26 283
nuclear@26 284 double input_gamma; /* image gamma of input image */
nuclear@26 285
nuclear@26 286 /* Compression parameters --- these fields must be set before calling
nuclear@26 287 * jpeg_start_compress(). We recommend calling jpeg_set_defaults() to
nuclear@26 288 * initialize everything to reasonable defaults, then changing anything
nuclear@26 289 * the application specifically wants to change. That way you won't get
nuclear@26 290 * burnt when new parameters are added. Also note that there are several
nuclear@26 291 * helper routines to simplify changing parameters.
nuclear@26 292 */
nuclear@26 293
nuclear@26 294 int data_precision; /* bits of precision in image data */
nuclear@26 295
nuclear@26 296 int num_components; /* # of color components in JPEG image */
nuclear@26 297 J_COLOR_SPACE jpeg_color_space; /* colorspace of JPEG image */
nuclear@26 298
nuclear@26 299 jpeg_component_info * comp_info;
nuclear@26 300 /* comp_info[i] describes component that appears i'th in SOF */
nuclear@26 301
nuclear@26 302 JQUANT_TBL * quant_tbl_ptrs[NUM_QUANT_TBLS];
nuclear@26 303 /* ptrs to coefficient quantization tables, or NULL if not defined */
nuclear@26 304
nuclear@26 305 JHUFF_TBL * dc_huff_tbl_ptrs[NUM_HUFF_TBLS];
nuclear@26 306 JHUFF_TBL * ac_huff_tbl_ptrs[NUM_HUFF_TBLS];
nuclear@26 307 /* ptrs to Huffman coding tables, or NULL if not defined */
nuclear@26 308
nuclear@26 309 UINT8 arith_dc_L[NUM_ARITH_TBLS]; /* L values for DC arith-coding tables */
nuclear@26 310 UINT8 arith_dc_U[NUM_ARITH_TBLS]; /* U values for DC arith-coding tables */
nuclear@26 311 UINT8 arith_ac_K[NUM_ARITH_TBLS]; /* Kx values for AC arith-coding tables */
nuclear@26 312
nuclear@26 313 int num_scans; /* # of entries in scan_info array */
nuclear@26 314 const jpeg_scan_info * scan_info; /* script for multi-scan file, or NULL */
nuclear@26 315 /* The default value of scan_info is NULL, which causes a single-scan
nuclear@26 316 * sequential JPEG file to be emitted. To create a multi-scan file,
nuclear@26 317 * set num_scans and scan_info to point to an array of scan definitions.
nuclear@26 318 */
nuclear@26 319
nuclear@26 320 boolean raw_data_in; /* TRUE=caller supplies downsampled data */
nuclear@26 321 boolean arith_code; /* TRUE=arithmetic coding, FALSE=Huffman */
nuclear@26 322 boolean optimize_coding; /* TRUE=optimize entropy encoding parms */
nuclear@26 323 boolean CCIR601_sampling; /* TRUE=first samples are cosited */
nuclear@26 324 int smoothing_factor; /* 1..100, or 0 for no input smoothing */
nuclear@26 325 J_DCT_METHOD dct_method; /* DCT algorithm selector */
nuclear@26 326
nuclear@26 327 /* The restart interval can be specified in absolute MCUs by setting
nuclear@26 328 * restart_interval, or in MCU rows by setting restart_in_rows
nuclear@26 329 * (in which case the correct restart_interval will be figured
nuclear@26 330 * for each scan).
nuclear@26 331 */
nuclear@26 332 unsigned int restart_interval; /* MCUs per restart, or 0 for no restart */
nuclear@26 333 int restart_in_rows; /* if > 0, MCU rows per restart interval */
nuclear@26 334
nuclear@26 335 /* Parameters controlling emission of special markers. */
nuclear@26 336
nuclear@26 337 boolean write_JFIF_header; /* should a JFIF marker be written? */
nuclear@26 338 UINT8 JFIF_major_version; /* What to write for the JFIF version number */
nuclear@26 339 UINT8 JFIF_minor_version;
nuclear@26 340 /* These three values are not used by the JPEG code, merely copied */
nuclear@26 341 /* into the JFIF APP0 marker. density_unit can be 0 for unknown, */
nuclear@26 342 /* 1 for dots/inch, or 2 for dots/cm. Note that the pixel aspect */
nuclear@26 343 /* ratio is defined by X_density/Y_density even when density_unit=0. */
nuclear@26 344 UINT8 density_unit; /* JFIF code for pixel size units */
nuclear@26 345 UINT16 X_density; /* Horizontal pixel density */
nuclear@26 346 UINT16 Y_density; /* Vertical pixel density */
nuclear@26 347 boolean write_Adobe_marker; /* should an Adobe marker be written? */
nuclear@26 348
nuclear@26 349 /* State variable: index of next scanline to be written to
nuclear@26 350 * jpeg_write_scanlines(). Application may use this to control its
nuclear@26 351 * processing loop, e.g., "while (next_scanline < image_height)".
nuclear@26 352 */
nuclear@26 353
nuclear@26 354 JDIMENSION next_scanline; /* 0 .. image_height-1 */
nuclear@26 355
nuclear@26 356 /* Remaining fields are known throughout compressor, but generally
nuclear@26 357 * should not be touched by a surrounding application.
nuclear@26 358 */
nuclear@26 359
nuclear@26 360 /*
nuclear@26 361 * These fields are computed during compression startup
nuclear@26 362 */
nuclear@26 363 boolean progressive_mode; /* TRUE if scan script uses progressive mode */
nuclear@26 364 int max_h_samp_factor; /* largest h_samp_factor */
nuclear@26 365 int max_v_samp_factor; /* largest v_samp_factor */
nuclear@26 366
nuclear@26 367 JDIMENSION total_iMCU_rows; /* # of iMCU rows to be input to coef ctlr */
nuclear@26 368 /* The coefficient controller receives data in units of MCU rows as defined
nuclear@26 369 * for fully interleaved scans (whether the JPEG file is interleaved or not).
nuclear@26 370 * There are v_samp_factor * DCTSIZE sample rows of each component in an
nuclear@26 371 * "iMCU" (interleaved MCU) row.
nuclear@26 372 */
nuclear@26 373
nuclear@26 374 /*
nuclear@26 375 * These fields are valid during any one scan.
nuclear@26 376 * They describe the components and MCUs actually appearing in the scan.
nuclear@26 377 */
nuclear@26 378 int comps_in_scan; /* # of JPEG components in this scan */
nuclear@26 379 jpeg_component_info * cur_comp_info[MAX_COMPS_IN_SCAN];
nuclear@26 380 /* *cur_comp_info[i] describes component that appears i'th in SOS */
nuclear@26 381
nuclear@26 382 JDIMENSION MCUs_per_row; /* # of MCUs across the image */
nuclear@26 383 JDIMENSION MCU_rows_in_scan; /* # of MCU rows in the image */
nuclear@26 384
nuclear@26 385 int blocks_in_MCU; /* # of DCT blocks per MCU */
nuclear@26 386 int MCU_membership[C_MAX_BLOCKS_IN_MCU];
nuclear@26 387 /* MCU_membership[i] is index in cur_comp_info of component owning */
nuclear@26 388 /* i'th block in an MCU */
nuclear@26 389
nuclear@26 390 int Ss, Se, Ah, Al; /* progressive JPEG parameters for scan */
nuclear@26 391
nuclear@26 392 /*
nuclear@26 393 * Links to compression subobjects (methods and private variables of modules)
nuclear@26 394 */
nuclear@26 395 struct jpeg_comp_master * master;
nuclear@26 396 struct jpeg_c_main_controller * main;
nuclear@26 397 struct jpeg_c_prep_controller * prep;
nuclear@26 398 struct jpeg_c_coef_controller * coef;
nuclear@26 399 struct jpeg_marker_writer * marker;
nuclear@26 400 struct jpeg_color_converter * cconvert;
nuclear@26 401 struct jpeg_downsampler * downsample;
nuclear@26 402 struct jpeg_forward_dct * fdct;
nuclear@26 403 struct jpeg_entropy_encoder * entropy;
nuclear@26 404 jpeg_scan_info * script_space; /* workspace for jpeg_simple_progression */
nuclear@26 405 int script_space_size;
nuclear@26 406 };
nuclear@26 407
nuclear@26 408
nuclear@26 409 /* Master record for a decompression instance */
nuclear@26 410
nuclear@26 411 struct jpeg_decompress_struct {
nuclear@26 412 jpeg_common_fields; /* Fields shared with jpeg_compress_struct */
nuclear@26 413
nuclear@26 414 /* Source of compressed data */
nuclear@26 415 struct jpeg_source_mgr * src;
nuclear@26 416
nuclear@26 417 /* Basic description of image --- filled in by jpeg_read_header(). */
nuclear@26 418 /* Application may inspect these values to decide how to process image. */
nuclear@26 419
nuclear@26 420 JDIMENSION image_width; /* nominal image width (from SOF marker) */
nuclear@26 421 JDIMENSION image_height; /* nominal image height */
nuclear@26 422 int num_components; /* # of color components in JPEG image */
nuclear@26 423 J_COLOR_SPACE jpeg_color_space; /* colorspace of JPEG image */
nuclear@26 424
nuclear@26 425 /* Decompression processing parameters --- these fields must be set before
nuclear@26 426 * calling jpeg_start_decompress(). Note that jpeg_read_header() initializes
nuclear@26 427 * them to default values.
nuclear@26 428 */
nuclear@26 429
nuclear@26 430 J_COLOR_SPACE out_color_space; /* colorspace for output */
nuclear@26 431
nuclear@26 432 unsigned int scale_num, scale_denom; /* fraction by which to scale image */
nuclear@26 433
nuclear@26 434 double output_gamma; /* image gamma wanted in output */
nuclear@26 435
nuclear@26 436 boolean buffered_image; /* TRUE=multiple output passes */
nuclear@26 437 boolean raw_data_out; /* TRUE=downsampled data wanted */
nuclear@26 438
nuclear@26 439 J_DCT_METHOD dct_method; /* IDCT algorithm selector */
nuclear@26 440 boolean do_fancy_upsampling; /* TRUE=apply fancy upsampling */
nuclear@26 441 boolean do_block_smoothing; /* TRUE=apply interblock smoothing */
nuclear@26 442
nuclear@26 443 boolean quantize_colors; /* TRUE=colormapped output wanted */
nuclear@26 444 /* the following are ignored if not quantize_colors: */
nuclear@26 445 J_DITHER_MODE dither_mode; /* type of color dithering to use */
nuclear@26 446 boolean two_pass_quantize; /* TRUE=use two-pass color quantization */
nuclear@26 447 int desired_number_of_colors; /* max # colors to use in created colormap */
nuclear@26 448 /* these are significant only in buffered-image mode: */
nuclear@26 449 boolean enable_1pass_quant; /* enable future use of 1-pass quantizer */
nuclear@26 450 boolean enable_external_quant;/* enable future use of external colormap */
nuclear@26 451 boolean enable_2pass_quant; /* enable future use of 2-pass quantizer */
nuclear@26 452
nuclear@26 453 /* Description of actual output image that will be returned to application.
nuclear@26 454 * These fields are computed by jpeg_start_decompress().
nuclear@26 455 * You can also use jpeg_calc_output_dimensions() to determine these values
nuclear@26 456 * in advance of calling jpeg_start_decompress().
nuclear@26 457 */
nuclear@26 458
nuclear@26 459 JDIMENSION output_width; /* scaled image width */
nuclear@26 460 JDIMENSION output_height; /* scaled image height */
nuclear@26 461 int out_color_components; /* # of color components in out_color_space */
nuclear@26 462 int output_components; /* # of color components returned */
nuclear@26 463 /* output_components is 1 (a colormap index) when quantizing colors;
nuclear@26 464 * otherwise it equals out_color_components.
nuclear@26 465 */
nuclear@26 466 int rec_outbuf_height; /* min recommended height of scanline buffer */
nuclear@26 467 /* If the buffer passed to jpeg_read_scanlines() is less than this many rows
nuclear@26 468 * high, space and time will be wasted due to unnecessary data copying.
nuclear@26 469 * Usually rec_outbuf_height will be 1 or 2, at most 4.
nuclear@26 470 */
nuclear@26 471
nuclear@26 472 /* When quantizing colors, the output colormap is described by these fields.
nuclear@26 473 * The application can supply a colormap by setting colormap non-NULL before
nuclear@26 474 * calling jpeg_start_decompress; otherwise a colormap is created during
nuclear@26 475 * jpeg_start_decompress or jpeg_start_output.
nuclear@26 476 * The map has out_color_components rows and actual_number_of_colors columns.
nuclear@26 477 */
nuclear@26 478 int actual_number_of_colors; /* number of entries in use */
nuclear@26 479 JSAMPARRAY colormap; /* The color map as a 2-D pixel array */
nuclear@26 480
nuclear@26 481 /* State variables: these variables indicate the progress of decompression.
nuclear@26 482 * The application may examine these but must not modify them.
nuclear@26 483 */
nuclear@26 484
nuclear@26 485 /* Row index of next scanline to be read from jpeg_read_scanlines().
nuclear@26 486 * Application may use this to control its processing loop, e.g.,
nuclear@26 487 * "while (output_scanline < output_height)".
nuclear@26 488 */
nuclear@26 489 JDIMENSION output_scanline; /* 0 .. output_height-1 */
nuclear@26 490
nuclear@26 491 /* Current input scan number and number of iMCU rows completed in scan.
nuclear@26 492 * These indicate the progress of the decompressor input side.
nuclear@26 493 */
nuclear@26 494 int input_scan_number; /* Number of SOS markers seen so far */
nuclear@26 495 JDIMENSION input_iMCU_row; /* Number of iMCU rows completed */
nuclear@26 496
nuclear@26 497 /* The "output scan number" is the notional scan being displayed by the
nuclear@26 498 * output side. The decompressor will not allow output scan/row number
nuclear@26 499 * to get ahead of input scan/row, but it can fall arbitrarily far behind.
nuclear@26 500 */
nuclear@26 501 int output_scan_number; /* Nominal scan number being displayed */
nuclear@26 502 JDIMENSION output_iMCU_row; /* Number of iMCU rows read */
nuclear@26 503
nuclear@26 504 /* Current progression status. coef_bits[c][i] indicates the precision
nuclear@26 505 * with which component c's DCT coefficient i (in zigzag order) is known.
nuclear@26 506 * It is -1 when no data has yet been received, otherwise it is the point
nuclear@26 507 * transform (shift) value for the most recent scan of the coefficient
nuclear@26 508 * (thus, 0 at completion of the progression).
nuclear@26 509 * This pointer is NULL when reading a non-progressive file.
nuclear@26 510 */
nuclear@26 511 int (*coef_bits)[DCTSIZE2]; /* -1 or current Al value for each coef */
nuclear@26 512
nuclear@26 513 /* Internal JPEG parameters --- the application usually need not look at
nuclear@26 514 * these fields. Note that the decompressor output side may not use
nuclear@26 515 * any parameters that can change between scans.
nuclear@26 516 */
nuclear@26 517
nuclear@26 518 /* Quantization and Huffman tables are carried forward across input
nuclear@26 519 * datastreams when processing abbreviated JPEG datastreams.
nuclear@26 520 */
nuclear@26 521
nuclear@26 522 JQUANT_TBL * quant_tbl_ptrs[NUM_QUANT_TBLS];
nuclear@26 523 /* ptrs to coefficient quantization tables, or NULL if not defined */
nuclear@26 524
nuclear@26 525 JHUFF_TBL * dc_huff_tbl_ptrs[NUM_HUFF_TBLS];
nuclear@26 526 JHUFF_TBL * ac_huff_tbl_ptrs[NUM_HUFF_TBLS];
nuclear@26 527 /* ptrs to Huffman coding tables, or NULL if not defined */
nuclear@26 528
nuclear@26 529 /* These parameters are never carried across datastreams, since they
nuclear@26 530 * are given in SOF/SOS markers or defined to be reset by SOI.
nuclear@26 531 */
nuclear@26 532
nuclear@26 533 int data_precision; /* bits of precision in image data */
nuclear@26 534
nuclear@26 535 jpeg_component_info * comp_info;
nuclear@26 536 /* comp_info[i] describes component that appears i'th in SOF */
nuclear@26 537
nuclear@26 538 boolean progressive_mode; /* TRUE if SOFn specifies progressive mode */
nuclear@26 539 boolean arith_code; /* TRUE=arithmetic coding, FALSE=Huffman */
nuclear@26 540
nuclear@26 541 UINT8 arith_dc_L[NUM_ARITH_TBLS]; /* L values for DC arith-coding tables */
nuclear@26 542 UINT8 arith_dc_U[NUM_ARITH_TBLS]; /* U values for DC arith-coding tables */
nuclear@26 543 UINT8 arith_ac_K[NUM_ARITH_TBLS]; /* Kx values for AC arith-coding tables */
nuclear@26 544
nuclear@26 545 unsigned int restart_interval; /* MCUs per restart interval, or 0 for no restart */
nuclear@26 546
nuclear@26 547 /* These fields record data obtained from optional markers recognized by
nuclear@26 548 * the JPEG library.
nuclear@26 549 */
nuclear@26 550 boolean saw_JFIF_marker; /* TRUE iff a JFIF APP0 marker was found */
nuclear@26 551 /* Data copied from JFIF marker; only valid if saw_JFIF_marker is TRUE: */
nuclear@26 552 UINT8 JFIF_major_version; /* JFIF version number */
nuclear@26 553 UINT8 JFIF_minor_version;
nuclear@26 554 UINT8 density_unit; /* JFIF code for pixel size units */
nuclear@26 555 UINT16 X_density; /* Horizontal pixel density */
nuclear@26 556 UINT16 Y_density; /* Vertical pixel density */
nuclear@26 557 boolean saw_Adobe_marker; /* TRUE iff an Adobe APP14 marker was found */
nuclear@26 558 UINT8 Adobe_transform; /* Color transform code from Adobe marker */
nuclear@26 559
nuclear@26 560 boolean CCIR601_sampling; /* TRUE=first samples are cosited */
nuclear@26 561
nuclear@26 562 /* Aside from the specific data retained from APPn markers known to the
nuclear@26 563 * library, the uninterpreted contents of any or all APPn and COM markers
nuclear@26 564 * can be saved in a list for examination by the application.
nuclear@26 565 */
nuclear@26 566 jpeg_saved_marker_ptr marker_list; /* Head of list of saved markers */
nuclear@26 567
nuclear@26 568 /* Remaining fields are known throughout decompressor, but generally
nuclear@26 569 * should not be touched by a surrounding application.
nuclear@26 570 */
nuclear@26 571
nuclear@26 572 /*
nuclear@26 573 * These fields are computed during decompression startup
nuclear@26 574 */
nuclear@26 575 int max_h_samp_factor; /* largest h_samp_factor */
nuclear@26 576 int max_v_samp_factor; /* largest v_samp_factor */
nuclear@26 577
nuclear@26 578 int min_DCT_scaled_size; /* smallest DCT_scaled_size of any component */
nuclear@26 579
nuclear@26 580 JDIMENSION total_iMCU_rows; /* # of iMCU rows in image */
nuclear@26 581 /* The coefficient controller's input and output progress is measured in
nuclear@26 582 * units of "iMCU" (interleaved MCU) rows. These are the same as MCU rows
nuclear@26 583 * in fully interleaved JPEG scans, but are used whether the scan is
nuclear@26 584 * interleaved or not. We define an iMCU row as v_samp_factor DCT block
nuclear@26 585 * rows of each component. Therefore, the IDCT output contains
nuclear@26 586 * v_samp_factor*DCT_scaled_size sample rows of a component per iMCU row.
nuclear@26 587 */
nuclear@26 588
nuclear@26 589 JSAMPLE * sample_range_limit; /* table for fast range-limiting */
nuclear@26 590
nuclear@26 591 /*
nuclear@26 592 * These fields are valid during any one scan.
nuclear@26 593 * They describe the components and MCUs actually appearing in the scan.
nuclear@26 594 * Note that the decompressor output side must not use these fields.
nuclear@26 595 */
nuclear@26 596 int comps_in_scan; /* # of JPEG components in this scan */
nuclear@26 597 jpeg_component_info * cur_comp_info[MAX_COMPS_IN_SCAN];
nuclear@26 598 /* *cur_comp_info[i] describes component that appears i'th in SOS */
nuclear@26 599
nuclear@26 600 JDIMENSION MCUs_per_row; /* # of MCUs across the image */
nuclear@26 601 JDIMENSION MCU_rows_in_scan; /* # of MCU rows in the image */
nuclear@26 602
nuclear@26 603 int blocks_in_MCU; /* # of DCT blocks per MCU */
nuclear@26 604 int MCU_membership[D_MAX_BLOCKS_IN_MCU];
nuclear@26 605 /* MCU_membership[i] is index in cur_comp_info of component owning */
nuclear@26 606 /* i'th block in an MCU */
nuclear@26 607
nuclear@26 608 int Ss, Se, Ah, Al; /* progressive JPEG parameters for scan */
nuclear@26 609
nuclear@26 610 /* This field is shared between entropy decoder and marker parser.
nuclear@26 611 * It is either zero or the code of a JPEG marker that has been
nuclear@26 612 * read from the data source, but has not yet been processed.
nuclear@26 613 */
nuclear@26 614 int unread_marker;
nuclear@26 615
nuclear@26 616 /*
nuclear@26 617 * Links to decompression subobjects (methods, private variables of modules)
nuclear@26 618 */
nuclear@26 619 struct jpeg_decomp_master * master;
nuclear@26 620 struct jpeg_d_main_controller * main;
nuclear@26 621 struct jpeg_d_coef_controller * coef;
nuclear@26 622 struct jpeg_d_post_controller * post;
nuclear@26 623 struct jpeg_input_controller * inputctl;
nuclear@26 624 struct jpeg_marker_reader * marker;
nuclear@26 625 struct jpeg_entropy_decoder * entropy;
nuclear@26 626 struct jpeg_inverse_dct * idct;
nuclear@26 627 struct jpeg_upsampler * upsample;
nuclear@26 628 struct jpeg_color_deconverter * cconvert;
nuclear@26 629 struct jpeg_color_quantizer * cquantize;
nuclear@26 630 };
nuclear@26 631
nuclear@26 632
nuclear@26 633 /* "Object" declarations for JPEG modules that may be supplied or called
nuclear@26 634 * directly by the surrounding application.
nuclear@26 635 * As with all objects in the JPEG library, these structs only define the
nuclear@26 636 * publicly visible methods and state variables of a module. Additional
nuclear@26 637 * private fields may exist after the public ones.
nuclear@26 638 */
nuclear@26 639
nuclear@26 640
nuclear@26 641 /* Error handler object */
nuclear@26 642
nuclear@26 643 struct jpeg_error_mgr {
nuclear@26 644 /* Error exit handler: does not return to caller */
nuclear@26 645 JMETHOD(void, error_exit, (j_common_ptr cinfo));
nuclear@26 646 /* Conditionally emit a trace or warning message */
nuclear@26 647 JMETHOD(void, emit_message, (j_common_ptr cinfo, int msg_level));
nuclear@26 648 /* Routine that actually outputs a trace or error message */
nuclear@26 649 JMETHOD(void, output_message, (j_common_ptr cinfo));
nuclear@26 650 /* Format a message string for the most recent JPEG error or message */
nuclear@26 651 JMETHOD(void, format_message, (j_common_ptr cinfo, char * buffer));
nuclear@26 652 #define JMSG_LENGTH_MAX 200 /* recommended size of format_message buffer */
nuclear@26 653 /* Reset error state variables at start of a new image */
nuclear@26 654 JMETHOD(void, reset_error_mgr, (j_common_ptr cinfo));
nuclear@26 655
nuclear@26 656 /* The message ID code and any parameters are saved here.
nuclear@26 657 * A message can have one string parameter or up to 8 int parameters.
nuclear@26 658 */
nuclear@26 659 int msg_code;
nuclear@26 660 #define JMSG_STR_PARM_MAX 80
nuclear@26 661 union {
nuclear@26 662 int i[8];
nuclear@26 663 char s[JMSG_STR_PARM_MAX];
nuclear@26 664 } msg_parm;
nuclear@26 665
nuclear@26 666 /* Standard state variables for error facility */
nuclear@26 667
nuclear@26 668 int trace_level; /* max msg_level that will be displayed */
nuclear@26 669
nuclear@26 670 /* For recoverable corrupt-data errors, we emit a warning message,
nuclear@26 671 * but keep going unless emit_message chooses to abort. emit_message
nuclear@26 672 * should count warnings in num_warnings. The surrounding application
nuclear@26 673 * can check for bad data by seeing if num_warnings is nonzero at the
nuclear@26 674 * end of processing.
nuclear@26 675 */
nuclear@26 676 long num_warnings; /* number of corrupt-data warnings */
nuclear@26 677
nuclear@26 678 /* These fields point to the table(s) of error message strings.
nuclear@26 679 * An application can change the table pointer to switch to a different
nuclear@26 680 * message list (typically, to change the language in which errors are
nuclear@26 681 * reported). Some applications may wish to add additional error codes
nuclear@26 682 * that will be handled by the JPEG library error mechanism; the second
nuclear@26 683 * table pointer is used for this purpose.
nuclear@26 684 *
nuclear@26 685 * First table includes all errors generated by JPEG library itself.
nuclear@26 686 * Error code 0 is reserved for a "no such error string" message.
nuclear@26 687 */
nuclear@26 688 const char * const * jpeg_message_table; /* Library errors */
nuclear@26 689 int last_jpeg_message; /* Table contains strings 0..last_jpeg_message */
nuclear@26 690 /* Second table can be added by application (see cjpeg/djpeg for example).
nuclear@26 691 * It contains strings numbered first_addon_message..last_addon_message.
nuclear@26 692 */
nuclear@26 693 const char * const * addon_message_table; /* Non-library errors */
nuclear@26 694 int first_addon_message; /* code for first string in addon table */
nuclear@26 695 int last_addon_message; /* code for last string in addon table */
nuclear@26 696 };
nuclear@26 697
nuclear@26 698
nuclear@26 699 /* Progress monitor object */
nuclear@26 700
nuclear@26 701 struct jpeg_progress_mgr {
nuclear@26 702 JMETHOD(void, progress_monitor, (j_common_ptr cinfo));
nuclear@26 703
nuclear@26 704 long pass_counter; /* work units completed in this pass */
nuclear@26 705 long pass_limit; /* total number of work units in this pass */
nuclear@26 706 int completed_passes; /* passes completed so far */
nuclear@26 707 int total_passes; /* total number of passes expected */
nuclear@26 708 };
nuclear@26 709
nuclear@26 710
nuclear@26 711 /* Data destination object for compression */
nuclear@26 712
nuclear@26 713 struct jpeg_destination_mgr {
nuclear@26 714 JOCTET * next_output_byte; /* => next byte to write in buffer */
nuclear@26 715 size_t free_in_buffer; /* # of byte spaces remaining in buffer */
nuclear@26 716
nuclear@26 717 JMETHOD(void, init_destination, (j_compress_ptr cinfo));
nuclear@26 718 JMETHOD(boolean, empty_output_buffer, (j_compress_ptr cinfo));
nuclear@26 719 JMETHOD(void, term_destination, (j_compress_ptr cinfo));
nuclear@26 720 };
nuclear@26 721
nuclear@26 722
nuclear@26 723 /* Data source object for decompression */
nuclear@26 724
nuclear@26 725 struct jpeg_source_mgr {
nuclear@26 726 const JOCTET * next_input_byte; /* => next byte to read from buffer */
nuclear@26 727 size_t bytes_in_buffer; /* # of bytes remaining in buffer */
nuclear@26 728
nuclear@26 729 JMETHOD(void, init_source, (j_decompress_ptr cinfo));
nuclear@26 730 JMETHOD(boolean, fill_input_buffer, (j_decompress_ptr cinfo));
nuclear@26 731 JMETHOD(void, skip_input_data, (j_decompress_ptr cinfo, long num_bytes));
nuclear@26 732 JMETHOD(boolean, resync_to_restart, (j_decompress_ptr cinfo, int desired));
nuclear@26 733 JMETHOD(void, term_source, (j_decompress_ptr cinfo));
nuclear@26 734 };
nuclear@26 735
nuclear@26 736
nuclear@26 737 /* Memory manager object.
nuclear@26 738 * Allocates "small" objects (a few K total), "large" objects (tens of K),
nuclear@26 739 * and "really big" objects (virtual arrays with backing store if needed).
nuclear@26 740 * The memory manager does not allow individual objects to be freed; rather,
nuclear@26 741 * each created object is assigned to a pool, and whole pools can be freed
nuclear@26 742 * at once. This is faster and more convenient than remembering exactly what
nuclear@26 743 * to free, especially where malloc()/free() are not too speedy.
nuclear@26 744 * NB: alloc routines never return NULL. They exit to error_exit if not
nuclear@26 745 * successful.
nuclear@26 746 */
nuclear@26 747
nuclear@26 748 #define JPOOL_PERMANENT 0 /* lasts until master record is destroyed */
nuclear@26 749 #define JPOOL_IMAGE 1 /* lasts until done with image/datastream */
nuclear@26 750 #define JPOOL_NUMPOOLS 2
nuclear@26 751
nuclear@26 752 typedef struct jvirt_sarray_control * jvirt_sarray_ptr;
nuclear@26 753 typedef struct jvirt_barray_control * jvirt_barray_ptr;
nuclear@26 754
nuclear@26 755
nuclear@26 756 struct jpeg_memory_mgr {
nuclear@26 757 /* Method pointers */
nuclear@26 758 JMETHOD(void *, alloc_small, (j_common_ptr cinfo, int pool_id,
nuclear@26 759 size_t sizeofobject));
nuclear@26 760 JMETHOD(void FAR *, alloc_large, (j_common_ptr cinfo, int pool_id,
nuclear@26 761 size_t sizeofobject));
nuclear@26 762 JMETHOD(JSAMPARRAY, alloc_sarray, (j_common_ptr cinfo, int pool_id,
nuclear@26 763 JDIMENSION samplesperrow,
nuclear@26 764 JDIMENSION numrows));
nuclear@26 765 JMETHOD(JBLOCKARRAY, alloc_barray, (j_common_ptr cinfo, int pool_id,
nuclear@26 766 JDIMENSION blocksperrow,
nuclear@26 767 JDIMENSION numrows));
nuclear@26 768 JMETHOD(jvirt_sarray_ptr, request_virt_sarray, (j_common_ptr cinfo,
nuclear@26 769 int pool_id,
nuclear@26 770 boolean pre_zero,
nuclear@26 771 JDIMENSION samplesperrow,
nuclear@26 772 JDIMENSION numrows,
nuclear@26 773 JDIMENSION maxaccess));
nuclear@26 774 JMETHOD(jvirt_barray_ptr, request_virt_barray, (j_common_ptr cinfo,
nuclear@26 775 int pool_id,
nuclear@26 776 boolean pre_zero,
nuclear@26 777 JDIMENSION blocksperrow,
nuclear@26 778 JDIMENSION numrows,
nuclear@26 779 JDIMENSION maxaccess));
nuclear@26 780 JMETHOD(void, realize_virt_arrays, (j_common_ptr cinfo));
nuclear@26 781 JMETHOD(JSAMPARRAY, access_virt_sarray, (j_common_ptr cinfo,
nuclear@26 782 jvirt_sarray_ptr ptr,
nuclear@26 783 JDIMENSION start_row,
nuclear@26 784 JDIMENSION num_rows,
nuclear@26 785 boolean writable));
nuclear@26 786 JMETHOD(JBLOCKARRAY, access_virt_barray, (j_common_ptr cinfo,
nuclear@26 787 jvirt_barray_ptr ptr,
nuclear@26 788 JDIMENSION start_row,
nuclear@26 789 JDIMENSION num_rows,
nuclear@26 790 boolean writable));
nuclear@26 791 JMETHOD(void, free_pool, (j_common_ptr cinfo, int pool_id));
nuclear@26 792 JMETHOD(void, self_destruct, (j_common_ptr cinfo));
nuclear@26 793
nuclear@26 794 /* Limit on memory allocation for this JPEG object. (Note that this is
nuclear@26 795 * merely advisory, not a guaranteed maximum; it only affects the space
nuclear@26 796 * used for virtual-array buffers.) May be changed by outer application
nuclear@26 797 * after creating the JPEG object.
nuclear@26 798 */
nuclear@26 799 long max_memory_to_use;
nuclear@26 800
nuclear@26 801 /* Maximum allocation request accepted by alloc_large. */
nuclear@26 802 long max_alloc_chunk;
nuclear@26 803 };
nuclear@26 804
nuclear@26 805
nuclear@26 806 /* Routine signature for application-supplied marker processing methods.
nuclear@26 807 * Need not pass marker code since it is stored in cinfo->unread_marker.
nuclear@26 808 */
nuclear@26 809 typedef JMETHOD(boolean, jpeg_marker_parser_method, (j_decompress_ptr cinfo));
nuclear@26 810
nuclear@26 811
nuclear@26 812 /* Declarations for routines called by application.
nuclear@26 813 * The JPP macro hides prototype parameters from compilers that can't cope.
nuclear@26 814 * Note JPP requires double parentheses.
nuclear@26 815 */
nuclear@26 816
nuclear@26 817 #ifdef HAVE_PROTOTYPES
nuclear@26 818 #define JPP(arglist) arglist
nuclear@26 819 #else
nuclear@26 820 #define JPP(arglist) ()
nuclear@26 821 #endif
nuclear@26 822
nuclear@26 823
nuclear@26 824 /* Short forms of external names for systems with brain-damaged linkers.
nuclear@26 825 * We shorten external names to be unique in the first six letters, which
nuclear@26 826 * is good enough for all known systems.
nuclear@26 827 * (If your compiler itself needs names to be unique in less than 15
nuclear@26 828 * characters, you are out of luck. Get a better compiler.)
nuclear@26 829 */
nuclear@26 830
nuclear@26 831 #ifdef NEED_SHORT_EXTERNAL_NAMES
nuclear@26 832 #define jpeg_std_error jStdError
nuclear@26 833 #define jpeg_CreateCompress jCreaCompress
nuclear@26 834 #define jpeg_CreateDecompress jCreaDecompress
nuclear@26 835 #define jpeg_destroy_compress jDestCompress
nuclear@26 836 #define jpeg_destroy_decompress jDestDecompress
nuclear@26 837 #define jpeg_stdio_dest jStdDest
nuclear@26 838 #define jpeg_stdio_src jStdSrc
nuclear@26 839 #define jpeg_set_defaults jSetDefaults
nuclear@26 840 #define jpeg_set_colorspace jSetColorspace
nuclear@26 841 #define jpeg_default_colorspace jDefColorspace
nuclear@26 842 #define jpeg_set_quality jSetQuality
nuclear@26 843 #define jpeg_set_linear_quality jSetLQuality
nuclear@26 844 #define jpeg_add_quant_table jAddQuantTable
nuclear@26 845 #define jpeg_quality_scaling jQualityScaling
nuclear@26 846 #define jpeg_simple_progression jSimProgress
nuclear@26 847 #define jpeg_suppress_tables jSuppressTables
nuclear@26 848 #define jpeg_alloc_quant_table jAlcQTable
nuclear@26 849 #define jpeg_alloc_huff_table jAlcHTable
nuclear@26 850 #define jpeg_start_compress jStrtCompress
nuclear@26 851 #define jpeg_write_scanlines jWrtScanlines
nuclear@26 852 #define jpeg_finish_compress jFinCompress
nuclear@26 853 #define jpeg_write_raw_data jWrtRawData
nuclear@26 854 #define jpeg_write_marker jWrtMarker
nuclear@26 855 #define jpeg_write_m_header jWrtMHeader
nuclear@26 856 #define jpeg_write_m_byte jWrtMByte
nuclear@26 857 #define jpeg_write_tables jWrtTables
nuclear@26 858 #define jpeg_read_header jReadHeader
nuclear@26 859 #define jpeg_start_decompress jStrtDecompress
nuclear@26 860 #define jpeg_read_scanlines jReadScanlines
nuclear@26 861 #define jpeg_finish_decompress jFinDecompress
nuclear@26 862 #define jpeg_read_raw_data jReadRawData
nuclear@26 863 #define jpeg_has_multiple_scans jHasMultScn
nuclear@26 864 #define jpeg_start_output jStrtOutput
nuclear@26 865 #define jpeg_finish_output jFinOutput
nuclear@26 866 #define jpeg_input_complete jInComplete
nuclear@26 867 #define jpeg_new_colormap jNewCMap
nuclear@26 868 #define jpeg_consume_input jConsumeInput
nuclear@26 869 #define jpeg_calc_output_dimensions jCalcDimensions
nuclear@26 870 #define jpeg_save_markers jSaveMarkers
nuclear@26 871 #define jpeg_set_marker_processor jSetMarker
nuclear@26 872 #define jpeg_read_coefficients jReadCoefs
nuclear@26 873 #define jpeg_write_coefficients jWrtCoefs
nuclear@26 874 #define jpeg_copy_critical_parameters jCopyCrit
nuclear@26 875 #define jpeg_abort_compress jAbrtCompress
nuclear@26 876 #define jpeg_abort_decompress jAbrtDecompress
nuclear@26 877 #define jpeg_abort jAbort
nuclear@26 878 #define jpeg_destroy jDestroy
nuclear@26 879 #define jpeg_resync_to_restart jResyncRestart
nuclear@26 880 #endif /* NEED_SHORT_EXTERNAL_NAMES */
nuclear@26 881
nuclear@26 882
nuclear@26 883 /* Default error-management setup */
nuclear@26 884 EXTERN(struct jpeg_error_mgr *) jpeg_std_error
nuclear@26 885 JPP((struct jpeg_error_mgr * err));
nuclear@26 886
nuclear@26 887 /* Initialization of JPEG compression objects.
nuclear@26 888 * jpeg_create_compress() and jpeg_create_decompress() are the exported
nuclear@26 889 * names that applications should call. These expand to calls on
nuclear@26 890 * jpeg_CreateCompress and jpeg_CreateDecompress with additional information
nuclear@26 891 * passed for version mismatch checking.
nuclear@26 892 * NB: you must set up the error-manager BEFORE calling jpeg_create_xxx.
nuclear@26 893 */
nuclear@26 894 #define jpeg_create_compress(cinfo) \
nuclear@26 895 jpeg_CreateCompress((cinfo), JPEG_LIB_VERSION, \
nuclear@26 896 (size_t) sizeof(struct jpeg_compress_struct))
nuclear@26 897 #define jpeg_create_decompress(cinfo) \
nuclear@26 898 jpeg_CreateDecompress((cinfo), JPEG_LIB_VERSION, \
nuclear@26 899 (size_t) sizeof(struct jpeg_decompress_struct))
nuclear@26 900 EXTERN(void) jpeg_CreateCompress JPP((j_compress_ptr cinfo,
nuclear@26 901 int version, size_t structsize));
nuclear@26 902 EXTERN(void) jpeg_CreateDecompress JPP((j_decompress_ptr cinfo,
nuclear@26 903 int version, size_t structsize));
nuclear@26 904 /* Destruction of JPEG compression objects */
nuclear@26 905 EXTERN(void) jpeg_destroy_compress JPP((j_compress_ptr cinfo));
nuclear@26 906 EXTERN(void) jpeg_destroy_decompress JPP((j_decompress_ptr cinfo));
nuclear@26 907
nuclear@26 908 /* Standard data source and destination managers: stdio streams. */
nuclear@26 909 /* Caller is responsible for opening the file before and closing after. */
nuclear@26 910 EXTERN(void) jpeg_stdio_dest JPP((j_compress_ptr cinfo, FILE * outfile));
nuclear@26 911 EXTERN(void) jpeg_stdio_src JPP((j_decompress_ptr cinfo, FILE * infile));
nuclear@26 912
nuclear@26 913 /* Default parameter setup for compression */
nuclear@26 914 EXTERN(void) jpeg_set_defaults JPP((j_compress_ptr cinfo));
nuclear@26 915 /* Compression parameter setup aids */
nuclear@26 916 EXTERN(void) jpeg_set_colorspace JPP((j_compress_ptr cinfo,
nuclear@26 917 J_COLOR_SPACE colorspace));
nuclear@26 918 EXTERN(void) jpeg_default_colorspace JPP((j_compress_ptr cinfo));
nuclear@26 919 EXTERN(void) jpeg_set_quality JPP((j_compress_ptr cinfo, int quality,
nuclear@26 920 boolean force_baseline));
nuclear@26 921 EXTERN(void) jpeg_set_linear_quality JPP((j_compress_ptr cinfo,
nuclear@26 922 int scale_factor,
nuclear@26 923 boolean force_baseline));
nuclear@26 924 EXTERN(void) jpeg_add_quant_table JPP((j_compress_ptr cinfo, int which_tbl,
nuclear@26 925 const unsigned int *basic_table,
nuclear@26 926 int scale_factor,
nuclear@26 927 boolean force_baseline));
nuclear@26 928 EXTERN(int) jpeg_quality_scaling JPP((int quality));
nuclear@26 929 EXTERN(void) jpeg_simple_progression JPP((j_compress_ptr cinfo));
nuclear@26 930 EXTERN(void) jpeg_suppress_tables JPP((j_compress_ptr cinfo,
nuclear@26 931 boolean suppress));
nuclear@26 932 EXTERN(JQUANT_TBL *) jpeg_alloc_quant_table JPP((j_common_ptr cinfo));
nuclear@26 933 EXTERN(JHUFF_TBL *) jpeg_alloc_huff_table JPP((j_common_ptr cinfo));
nuclear@26 934
nuclear@26 935 /* Main entry points for compression */
nuclear@26 936 EXTERN(void) jpeg_start_compress JPP((j_compress_ptr cinfo,
nuclear@26 937 boolean write_all_tables));
nuclear@26 938 EXTERN(JDIMENSION) jpeg_write_scanlines JPP((j_compress_ptr cinfo,
nuclear@26 939 JSAMPARRAY scanlines,
nuclear@26 940 JDIMENSION num_lines));
nuclear@26 941 EXTERN(void) jpeg_finish_compress JPP((j_compress_ptr cinfo));
nuclear@26 942
nuclear@26 943 /* Replaces jpeg_write_scanlines when writing raw downsampled data. */
nuclear@26 944 EXTERN(JDIMENSION) jpeg_write_raw_data JPP((j_compress_ptr cinfo,
nuclear@26 945 JSAMPIMAGE data,
nuclear@26 946 JDIMENSION num_lines));
nuclear@26 947
nuclear@26 948 /* Write a special marker. See libjpeg.doc concerning safe usage. */
nuclear@26 949 EXTERN(void) jpeg_write_marker
nuclear@26 950 JPP((j_compress_ptr cinfo, int marker,
nuclear@26 951 const JOCTET * dataptr, unsigned int datalen));
nuclear@26 952 /* Same, but piecemeal. */
nuclear@26 953 EXTERN(void) jpeg_write_m_header
nuclear@26 954 JPP((j_compress_ptr cinfo, int marker, unsigned int datalen));
nuclear@26 955 EXTERN(void) jpeg_write_m_byte
nuclear@26 956 JPP((j_compress_ptr cinfo, int val));
nuclear@26 957
nuclear@26 958 /* Alternate compression function: just write an abbreviated table file */
nuclear@26 959 EXTERN(void) jpeg_write_tables JPP((j_compress_ptr cinfo));
nuclear@26 960
nuclear@26 961 /* Decompression startup: read start of JPEG datastream to see what's there */
nuclear@26 962 EXTERN(int) jpeg_read_header JPP((j_decompress_ptr cinfo,
nuclear@26 963 boolean require_image));
nuclear@26 964 /* Return value is one of: */
nuclear@26 965 #define JPEG_SUSPENDED 0 /* Suspended due to lack of input data */
nuclear@26 966 #define JPEG_HEADER_OK 1 /* Found valid image datastream */
nuclear@26 967 #define JPEG_HEADER_TABLES_ONLY 2 /* Found valid table-specs-only datastream */
nuclear@26 968 /* If you pass require_image = TRUE (normal case), you need not check for
nuclear@26 969 * a TABLES_ONLY return code; an abbreviated file will cause an error exit.
nuclear@26 970 * JPEG_SUSPENDED is only possible if you use a data source module that can
nuclear@26 971 * give a suspension return (the stdio source module doesn't).
nuclear@26 972 */
nuclear@26 973
nuclear@26 974 /* Main entry points for decompression */
nuclear@26 975 EXTERN(boolean) jpeg_start_decompress JPP((j_decompress_ptr cinfo));
nuclear@26 976 EXTERN(JDIMENSION) jpeg_read_scanlines JPP((j_decompress_ptr cinfo,
nuclear@26 977 JSAMPARRAY scanlines,
nuclear@26 978 JDIMENSION max_lines));
nuclear@26 979 EXTERN(boolean) jpeg_finish_decompress JPP((j_decompress_ptr cinfo));
nuclear@26 980
nuclear@26 981 /* Replaces jpeg_read_scanlines when reading raw downsampled data. */
nuclear@26 982 EXTERN(JDIMENSION) jpeg_read_raw_data JPP((j_decompress_ptr cinfo,
nuclear@26 983 JSAMPIMAGE data,
nuclear@26 984 JDIMENSION max_lines));
nuclear@26 985
nuclear@26 986 /* Additional entry points for buffered-image mode. */
nuclear@26 987 EXTERN(boolean) jpeg_has_multiple_scans JPP((j_decompress_ptr cinfo));
nuclear@26 988 EXTERN(boolean) jpeg_start_output JPP((j_decompress_ptr cinfo,
nuclear@26 989 int scan_number));
nuclear@26 990 EXTERN(boolean) jpeg_finish_output JPP((j_decompress_ptr cinfo));
nuclear@26 991 EXTERN(boolean) jpeg_input_complete JPP((j_decompress_ptr cinfo));
nuclear@26 992 EXTERN(void) jpeg_new_colormap JPP((j_decompress_ptr cinfo));
nuclear@26 993 EXTERN(int) jpeg_consume_input JPP((j_decompress_ptr cinfo));
nuclear@26 994 /* Return value is one of: */
nuclear@26 995 /* #define JPEG_SUSPENDED 0 Suspended due to lack of input data */
nuclear@26 996 #define JPEG_REACHED_SOS 1 /* Reached start of new scan */
nuclear@26 997 #define JPEG_REACHED_EOI 2 /* Reached end of image */
nuclear@26 998 #define JPEG_ROW_COMPLETED 3 /* Completed one iMCU row */
nuclear@26 999 #define JPEG_SCAN_COMPLETED 4 /* Completed last iMCU row of a scan */
nuclear@26 1000
nuclear@26 1001 /* Precalculate output dimensions for current decompression parameters. */
nuclear@26 1002 EXTERN(void) jpeg_calc_output_dimensions JPP((j_decompress_ptr cinfo));
nuclear@26 1003
nuclear@26 1004 /* Control saving of COM and APPn markers into marker_list. */
nuclear@26 1005 EXTERN(void) jpeg_save_markers
nuclear@26 1006 JPP((j_decompress_ptr cinfo, int marker_code,
nuclear@26 1007 unsigned int length_limit));
nuclear@26 1008
nuclear@26 1009 /* Install a special processing method for COM or APPn markers. */
nuclear@26 1010 EXTERN(void) jpeg_set_marker_processor
nuclear@26 1011 JPP((j_decompress_ptr cinfo, int marker_code,
nuclear@26 1012 jpeg_marker_parser_method routine));
nuclear@26 1013
nuclear@26 1014 /* Read or write raw DCT coefficients --- useful for lossless transcoding. */
nuclear@26 1015 EXTERN(jvirt_barray_ptr *) jpeg_read_coefficients JPP((j_decompress_ptr cinfo));
nuclear@26 1016 EXTERN(void) jpeg_write_coefficients JPP((j_compress_ptr cinfo,
nuclear@26 1017 jvirt_barray_ptr * coef_arrays));
nuclear@26 1018 EXTERN(void) jpeg_copy_critical_parameters JPP((j_decompress_ptr srcinfo,
nuclear@26 1019 j_compress_ptr dstinfo));
nuclear@26 1020
nuclear@26 1021 /* If you choose to abort compression or decompression before completing
nuclear@26 1022 * jpeg_finish_(de)compress, then you need to clean up to release memory,
nuclear@26 1023 * temporary files, etc. You can just call jpeg_destroy_(de)compress
nuclear@26 1024 * if you're done with the JPEG object, but if you want to clean it up and
nuclear@26 1025 * reuse it, call this:
nuclear@26 1026 */
nuclear@26 1027 EXTERN(void) jpeg_abort_compress JPP((j_compress_ptr cinfo));
nuclear@26 1028 EXTERN(void) jpeg_abort_decompress JPP((j_decompress_ptr cinfo));
nuclear@26 1029
nuclear@26 1030 /* Generic versions of jpeg_abort and jpeg_destroy that work on either
nuclear@26 1031 * flavor of JPEG object. These may be more convenient in some places.
nuclear@26 1032 */
nuclear@26 1033 EXTERN(void) jpeg_abort JPP((j_common_ptr cinfo));
nuclear@26 1034 EXTERN(void) jpeg_destroy JPP((j_common_ptr cinfo));
nuclear@26 1035
nuclear@26 1036 /* Default restart-marker-resync procedure for use by data source modules */
nuclear@26 1037 EXTERN(boolean) jpeg_resync_to_restart JPP((j_decompress_ptr cinfo,
nuclear@26 1038 int desired));
nuclear@26 1039
nuclear@26 1040
nuclear@26 1041 /* These marker codes are exported since applications and data source modules
nuclear@26 1042 * are likely to want to use them.
nuclear@26 1043 */
nuclear@26 1044
nuclear@26 1045 #define JPEG_RST0 0xD0 /* RST0 marker code */
nuclear@26 1046 #define JPEG_EOI 0xD9 /* EOI marker code */
nuclear@26 1047 #define JPEG_APP0 0xE0 /* APP0 marker code */
nuclear@26 1048 #define JPEG_COM 0xFE /* COM marker code */
nuclear@26 1049
nuclear@26 1050
nuclear@26 1051 /* If we have a brain-damaged compiler that emits warnings (or worse, errors)
nuclear@26 1052 * for structure definitions that are never filled in, keep it quiet by
nuclear@26 1053 * supplying dummy definitions for the various substructures.
nuclear@26 1054 */
nuclear@26 1055
nuclear@26 1056 #ifdef INCOMPLETE_TYPES_BROKEN
nuclear@26 1057 #ifndef JPEG_INTERNALS /* will be defined in jpegint.h */
nuclear@26 1058 struct jvirt_sarray_control { long dummy; };
nuclear@26 1059 struct jvirt_barray_control { long dummy; };
nuclear@26 1060 struct jpeg_comp_master { long dummy; };
nuclear@26 1061 struct jpeg_c_main_controller { long dummy; };
nuclear@26 1062 struct jpeg_c_prep_controller { long dummy; };
nuclear@26 1063 struct jpeg_c_coef_controller { long dummy; };
nuclear@26 1064 struct jpeg_marker_writer { long dummy; };
nuclear@26 1065 struct jpeg_color_converter { long dummy; };
nuclear@26 1066 struct jpeg_downsampler { long dummy; };
nuclear@26 1067 struct jpeg_forward_dct { long dummy; };
nuclear@26 1068 struct jpeg_entropy_encoder { long dummy; };
nuclear@26 1069 struct jpeg_decomp_master { long dummy; };
nuclear@26 1070 struct jpeg_d_main_controller { long dummy; };
nuclear@26 1071 struct jpeg_d_coef_controller { long dummy; };
nuclear@26 1072 struct jpeg_d_post_controller { long dummy; };
nuclear@26 1073 struct jpeg_input_controller { long dummy; };
nuclear@26 1074 struct jpeg_marker_reader { long dummy; };
nuclear@26 1075 struct jpeg_entropy_decoder { long dummy; };
nuclear@26 1076 struct jpeg_inverse_dct { long dummy; };
nuclear@26 1077 struct jpeg_upsampler { long dummy; };
nuclear@26 1078 struct jpeg_color_deconverter { long dummy; };
nuclear@26 1079 struct jpeg_color_quantizer { long dummy; };
nuclear@26 1080 #endif /* JPEG_INTERNALS */
nuclear@26 1081 #endif /* INCOMPLETE_TYPES_BROKEN */
nuclear@26 1082
nuclear@26 1083
nuclear@26 1084 /*
nuclear@26 1085 * The JPEG library modules define JPEG_INTERNALS before including this file.
nuclear@26 1086 * The internal structure declarations are read only when that is true.
nuclear@26 1087 * Applications using the library should not include jpegint.h, but may wish
nuclear@26 1088 * to include jerror.h.
nuclear@26 1089 */
nuclear@26 1090
nuclear@26 1091 #ifdef JPEG_INTERNALS
nuclear@26 1092 #include "jpegint.h" /* fetch private declarations */
nuclear@26 1093 #include "jerror.h" /* fetch error codes too */
nuclear@26 1094 #endif
nuclear@26 1095
nuclear@26 1096 #endif /* JPEGLIB_H */