media/libjpeg/jpeglib.h

Thu, 22 Jan 2015 13:21:57 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 22 Jan 2015 13:21:57 +0100
branch
TOR_BUG_9701
changeset 15
b8a032363ba2
permissions
-rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

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

mercurial