jpayne@69: /* jpayne@69: * jpeglib.h jpayne@69: * jpayne@69: * Copyright (C) 1991-1998, Thomas G. Lane. jpayne@69: * Modified 2002-2020 by Guido Vollbeding. jpayne@69: * This file is part of the Independent JPEG Group's software. jpayne@69: * For conditions of distribution and use, see the accompanying README file. jpayne@69: * jpayne@69: * This file defines the application interface for the JPEG library. jpayne@69: * Most applications using the library need only include this file, jpayne@69: * and perhaps jerror.h if they want to know the exact error codes. jpayne@69: */ jpayne@69: jpayne@69: #ifndef JPEGLIB_H jpayne@69: #define JPEGLIB_H jpayne@69: jpayne@69: /* jpayne@69: * First we include the configuration files that record how this jpayne@69: * installation of the JPEG library is set up. jconfig.h can be jpayne@69: * generated automatically for many systems. jmorecfg.h contains jpayne@69: * manual configuration options that most people need not worry about. jpayne@69: */ jpayne@69: jpayne@69: #ifndef JCONFIG_INCLUDED /* in case jinclude.h already did */ jpayne@69: #include "jconfig.h" /* widely used configuration options */ jpayne@69: #endif jpayne@69: #include "jmorecfg.h" /* seldom changed options */ jpayne@69: jpayne@69: jpayne@69: #ifdef __cplusplus jpayne@69: #ifndef DONT_USE_EXTERN_C jpayne@69: extern "C" { jpayne@69: #endif jpayne@69: #endif jpayne@69: jpayne@69: /* Version IDs for the JPEG library. jpayne@69: * Might be useful for tests like "#if JPEG_LIB_VERSION >= 90". jpayne@69: */ jpayne@69: jpayne@69: #define JPEG_LIB_VERSION 90 /* Compatibility version 9.0 */ jpayne@69: #define JPEG_LIB_VERSION_MAJOR 9 jpayne@69: #define JPEG_LIB_VERSION_MINOR 5 jpayne@69: jpayne@69: jpayne@69: /* Various constants determining the sizes of things. jpayne@69: * All of these are specified by the JPEG standard, jpayne@69: * so don't change them if you want to be compatible. jpayne@69: */ jpayne@69: jpayne@69: #define DCTSIZE 8 /* The basic DCT block is 8x8 coefficients */ jpayne@69: #define DCTSIZE2 64 /* DCTSIZE squared; # of elements in a block */ jpayne@69: #define NUM_QUANT_TBLS 4 /* Quantization tables are numbered 0..3 */ jpayne@69: #define NUM_HUFF_TBLS 4 /* Huffman tables are numbered 0..3 */ jpayne@69: #define NUM_ARITH_TBLS 16 /* Arith-coding tables are numbered 0..15 */ jpayne@69: #define MAX_COMPS_IN_SCAN 4 /* JPEG limit on # of components in one scan */ jpayne@69: #define MAX_SAMP_FACTOR 4 /* JPEG limit on sampling factors */ jpayne@69: /* Unfortunately, some bozo at Adobe saw no reason to be bound by the standard; jpayne@69: * the PostScript DCT filter can emit files with many more than 10 blocks/MCU. jpayne@69: * If you happen to run across such a file, you can up D_MAX_BLOCKS_IN_MCU jpayne@69: * to handle it. We even let you do this from the jconfig.h file. However, jpayne@69: * we strongly discourage changing C_MAX_BLOCKS_IN_MCU; just because Adobe jpayne@69: * sometimes emits noncompliant files doesn't mean you should too. jpayne@69: */ jpayne@69: #define C_MAX_BLOCKS_IN_MCU 10 /* compressor's limit on blocks per MCU */ jpayne@69: #ifndef D_MAX_BLOCKS_IN_MCU jpayne@69: #define D_MAX_BLOCKS_IN_MCU 10 /* decompressor's limit on blocks per MCU */ jpayne@69: #endif jpayne@69: jpayne@69: jpayne@69: /* Data structures for images (arrays of samples and of DCT coefficients). jpayne@69: * On 80x86 machines, the image arrays are too big for near pointers, jpayne@69: * but the pointer arrays can fit in near memory. jpayne@69: */ jpayne@69: jpayne@69: typedef JSAMPLE FAR *JSAMPROW; /* ptr to one image row of pixel samples. */ jpayne@69: typedef JSAMPROW *JSAMPARRAY; /* ptr to some rows (a 2-D sample array) */ jpayne@69: typedef JSAMPARRAY *JSAMPIMAGE; /* a 3-D sample array: top index is color */ jpayne@69: jpayne@69: typedef JCOEF JBLOCK[DCTSIZE2]; /* one block of coefficients */ jpayne@69: typedef JBLOCK FAR *JBLOCKROW; /* pointer to one row of coefficient blocks */ jpayne@69: typedef JBLOCKROW *JBLOCKARRAY; /* a 2-D array of coefficient blocks */ jpayne@69: typedef JBLOCKARRAY *JBLOCKIMAGE; /* a 3-D array of coefficient blocks */ jpayne@69: jpayne@69: typedef JCOEF FAR *JCOEFPTR; /* useful in a couple of places */ jpayne@69: jpayne@69: jpayne@69: /* Types for JPEG compression parameters and working tables. */ jpayne@69: jpayne@69: jpayne@69: /* DCT coefficient quantization tables. */ jpayne@69: jpayne@69: typedef struct { jpayne@69: /* This array gives the coefficient quantizers in natural array order jpayne@69: * (not the zigzag order in which they are stored in a JPEG DQT marker). jpayne@69: * CAUTION: IJG versions prior to v6a kept this array in zigzag order. jpayne@69: */ jpayne@69: UINT16 quantval[DCTSIZE2]; /* quantization step for each coefficient */ jpayne@69: /* This field is used only during compression. It's initialized FALSE when jpayne@69: * the table is created, and set TRUE when it's been output to the file. jpayne@69: * You could suppress output of a table by setting this to TRUE. jpayne@69: * (See jpeg_suppress_tables for an example.) jpayne@69: */ jpayne@69: boolean sent_table; /* TRUE when table has been output */ jpayne@69: } JQUANT_TBL; jpayne@69: jpayne@69: jpayne@69: /* Huffman coding tables. */ jpayne@69: jpayne@69: typedef struct { jpayne@69: /* These two fields directly represent the contents of a JPEG DHT marker */ jpayne@69: UINT8 bits[17]; /* bits[k] = # of symbols with codes of */ jpayne@69: /* length k bits; bits[0] is unused */ jpayne@69: UINT8 huffval[256]; /* The symbols, in order of incr code length */ jpayne@69: /* This field is used only during compression. It's initialized FALSE when jpayne@69: * the table is created, and set TRUE when it's been output to the file. jpayne@69: * You could suppress output of a table by setting this to TRUE. jpayne@69: * (See jpeg_suppress_tables for an example.) jpayne@69: */ jpayne@69: boolean sent_table; /* TRUE when table has been output */ jpayne@69: } JHUFF_TBL; jpayne@69: jpayne@69: jpayne@69: /* Basic info about one component (color channel). */ jpayne@69: jpayne@69: typedef struct { jpayne@69: /* These values are fixed over the whole image. */ jpayne@69: /* For compression, they must be supplied by parameter setup; */ jpayne@69: /* for decompression, they are read from the SOF marker. */ jpayne@69: int component_id; /* identifier for this component (0..255) */ jpayne@69: int component_index; /* its index in SOF or cinfo->comp_info[] */ jpayne@69: int h_samp_factor; /* horizontal sampling factor (1..4) */ jpayne@69: int v_samp_factor; /* vertical sampling factor (1..4) */ jpayne@69: int quant_tbl_no; /* quantization table selector (0..3) */ jpayne@69: /* These values may vary between scans. */ jpayne@69: /* For compression, they must be supplied by parameter setup; */ jpayne@69: /* for decompression, they are read from the SOS marker. */ jpayne@69: /* The decompressor output side may not use these variables. */ jpayne@69: int dc_tbl_no; /* DC entropy table selector (0..3) */ jpayne@69: int ac_tbl_no; /* AC entropy table selector (0..3) */ jpayne@69: jpayne@69: /* Remaining fields should be treated as private by applications. */ jpayne@69: jpayne@69: /* These values are computed during compression or decompression startup: */ jpayne@69: /* Component's size in DCT blocks. jpayne@69: * Any dummy blocks added to complete an MCU are not counted; therefore jpayne@69: * these values do not depend on whether a scan is interleaved or not. jpayne@69: */ jpayne@69: JDIMENSION width_in_blocks; jpayne@69: JDIMENSION height_in_blocks; jpayne@69: /* Size of a DCT block in samples, jpayne@69: * reflecting any scaling we choose to apply during the DCT step. jpayne@69: * Values from 1 to 16 are supported. jpayne@69: * Note that different components may receive different DCT scalings. jpayne@69: */ jpayne@69: int DCT_h_scaled_size; jpayne@69: int DCT_v_scaled_size; jpayne@69: /* The downsampled dimensions are the component's actual, unpadded number jpayne@69: * of samples at the main buffer (preprocessing/compression interface); jpayne@69: * DCT scaling is included, so jpayne@69: * downsampled_width = jpayne@69: * ceil(image_width * Hi/Hmax * DCT_h_scaled_size/block_size) jpayne@69: * and similarly for height. jpayne@69: */ jpayne@69: JDIMENSION downsampled_width; /* actual width in samples */ jpayne@69: JDIMENSION downsampled_height; /* actual height in samples */ jpayne@69: /* For decompression, in cases where some of the components will be jpayne@69: * ignored (eg grayscale output from YCbCr image), we can skip most jpayne@69: * computations for the unused components. jpayne@69: * For compression, some of the components will need further quantization jpayne@69: * scale by factor of 2 after DCT (eg BG_YCC output from normal RGB input). jpayne@69: * The field is first set TRUE for decompression, FALSE for compression jpayne@69: * in initial_setup, and then adapted in color conversion setup. jpayne@69: */ jpayne@69: boolean component_needed; jpayne@69: jpayne@69: /* These values are computed before starting a scan of the component. */ jpayne@69: /* The decompressor output side may not use these variables. */ jpayne@69: int MCU_width; /* number of blocks per MCU, horizontally */ jpayne@69: int MCU_height; /* number of blocks per MCU, vertically */ jpayne@69: int MCU_blocks; /* MCU_width * MCU_height */ jpayne@69: int MCU_sample_width; /* MCU width in samples: MCU_width * DCT_h_scaled_size */ jpayne@69: int last_col_width; /* # of non-dummy blocks across in last MCU */ jpayne@69: int last_row_height; /* # of non-dummy blocks down in last MCU */ jpayne@69: jpayne@69: /* Saved quantization table for component; NULL if none yet saved. jpayne@69: * See jdinput.c comments about the need for this information. jpayne@69: * This field is currently used only for decompression. jpayne@69: */ jpayne@69: JQUANT_TBL * quant_table; jpayne@69: jpayne@69: /* Private per-component storage for DCT or IDCT subsystem. */ jpayne@69: void * dct_table; jpayne@69: } jpeg_component_info; jpayne@69: jpayne@69: jpayne@69: /* The script for encoding a multiple-scan file is an array of these: */ jpayne@69: jpayne@69: typedef struct { jpayne@69: int comps_in_scan; /* number of components encoded in this scan */ jpayne@69: int component_index[MAX_COMPS_IN_SCAN]; /* their SOF/comp_info[] indexes */ jpayne@69: int Ss, Se; /* progressive JPEG spectral selection parms */ jpayne@69: int Ah, Al; /* progressive JPEG successive approx. parms */ jpayne@69: } jpeg_scan_info; jpayne@69: jpayne@69: /* The decompressor can save APPn and COM markers in a list of these: */ jpayne@69: jpayne@69: typedef struct jpeg_marker_struct FAR * jpeg_saved_marker_ptr; jpayne@69: jpayne@69: struct jpeg_marker_struct { jpayne@69: jpeg_saved_marker_ptr next; /* next in list, or NULL */ jpayne@69: UINT8 marker; /* marker code: JPEG_COM, or JPEG_APP0+n */ jpayne@69: unsigned int original_length; /* # bytes of data in the file */ jpayne@69: unsigned int data_length; /* # bytes of data saved at data[] */ jpayne@69: JOCTET FAR * data; /* the data contained in the marker */ jpayne@69: /* the marker length word is not counted in data_length or original_length */ jpayne@69: }; jpayne@69: jpayne@69: /* Known color spaces. */ jpayne@69: jpayne@69: typedef enum { jpayne@69: JCS_UNKNOWN, /* error/unspecified */ jpayne@69: JCS_GRAYSCALE, /* monochrome */ jpayne@69: JCS_RGB, /* red/green/blue, standard RGB (sRGB) */ jpayne@69: JCS_YCbCr, /* Y/Cb/Cr (also known as YUV), standard YCC */ jpayne@69: JCS_CMYK, /* C/M/Y/K */ jpayne@69: JCS_YCCK, /* Y/Cb/Cr/K */ jpayne@69: JCS_BG_RGB, /* big gamut red/green/blue, bg-sRGB */ jpayne@69: JCS_BG_YCC /* big gamut Y/Cb/Cr, bg-sYCC */ jpayne@69: } J_COLOR_SPACE; jpayne@69: jpayne@69: /* Supported color transforms. */ jpayne@69: jpayne@69: typedef enum { jpayne@69: JCT_NONE = 0, jpayne@69: JCT_SUBTRACT_GREEN = 1 jpayne@69: } J_COLOR_TRANSFORM; jpayne@69: jpayne@69: /* DCT/IDCT algorithm options. */ jpayne@69: jpayne@69: typedef enum { jpayne@69: JDCT_ISLOW, /* slow but accurate integer algorithm */ jpayne@69: JDCT_IFAST, /* faster, less accurate integer method */ jpayne@69: JDCT_FLOAT /* floating-point: accurate, fast on fast HW */ jpayne@69: } J_DCT_METHOD; jpayne@69: jpayne@69: #ifndef JDCT_DEFAULT /* may be overridden in jconfig.h */ jpayne@69: #define JDCT_DEFAULT JDCT_ISLOW jpayne@69: #endif jpayne@69: #ifndef JDCT_FASTEST /* may be overridden in jconfig.h */ jpayne@69: #define JDCT_FASTEST JDCT_IFAST jpayne@69: #endif jpayne@69: jpayne@69: /* Dithering options for decompression. */ jpayne@69: jpayne@69: typedef enum { jpayne@69: JDITHER_NONE, /* no dithering */ jpayne@69: JDITHER_ORDERED, /* simple ordered dither */ jpayne@69: JDITHER_FS /* Floyd-Steinberg error diffusion dither */ jpayne@69: } J_DITHER_MODE; jpayne@69: jpayne@69: jpayne@69: /* Common fields between JPEG compression and decompression master structs. */ jpayne@69: jpayne@69: #define jpeg_common_fields \ jpayne@69: struct jpeg_error_mgr * err; /* Error handler module */\ jpayne@69: struct jpeg_memory_mgr * mem; /* Memory manager module */\ jpayne@69: struct jpeg_progress_mgr * progress; /* Progress monitor, or NULL if none */\ jpayne@69: void * client_data; /* Available for use by application */\ jpayne@69: boolean is_decompressor; /* So common code can tell which is which */\ jpayne@69: int global_state /* For checking call sequence validity */ jpayne@69: jpayne@69: /* Routines that are to be used by both halves of the library are declared jpayne@69: * to receive a pointer to this structure. There are no actual instances of jpayne@69: * jpeg_common_struct, only of jpeg_compress_struct and jpeg_decompress_struct. jpayne@69: */ jpayne@69: struct jpeg_common_struct { jpayne@69: jpeg_common_fields; /* Fields common to both master struct types */ jpayne@69: /* Additional fields follow in an actual jpeg_compress_struct or jpayne@69: * jpeg_decompress_struct. All three structs must agree on these jpayne@69: * initial fields! (This would be a lot cleaner in C++.) jpayne@69: */ jpayne@69: }; jpayne@69: jpayne@69: typedef struct jpeg_common_struct * j_common_ptr; jpayne@69: typedef struct jpeg_compress_struct * j_compress_ptr; jpayne@69: typedef struct jpeg_decompress_struct * j_decompress_ptr; jpayne@69: jpayne@69: jpayne@69: /* Master record for a compression instance */ jpayne@69: jpayne@69: struct jpeg_compress_struct { jpayne@69: jpeg_common_fields; /* Fields shared with jpeg_decompress_struct */ jpayne@69: jpayne@69: /* Destination for compressed data */ jpayne@69: struct jpeg_destination_mgr * dest; jpayne@69: jpayne@69: /* Description of source image --- these fields must be filled in by jpayne@69: * outer application before starting compression. in_color_space must jpayne@69: * be correct before you can even call jpeg_set_defaults(). jpayne@69: */ jpayne@69: jpayne@69: JDIMENSION image_width; /* input image width */ jpayne@69: JDIMENSION image_height; /* input image height */ jpayne@69: int input_components; /* # of color components in input image */ jpayne@69: J_COLOR_SPACE in_color_space; /* colorspace of input image */ jpayne@69: jpayne@69: double input_gamma; /* image gamma of input image */ jpayne@69: jpayne@69: /* Compression parameters --- these fields must be set before calling jpayne@69: * jpeg_start_compress(). We recommend calling jpeg_set_defaults() to jpayne@69: * initialize everything to reasonable defaults, then changing anything jpayne@69: * the application specifically wants to change. That way you won't get jpayne@69: * burnt when new parameters are added. Also note that there are several jpayne@69: * helper routines to simplify changing parameters. jpayne@69: */ jpayne@69: jpayne@69: unsigned int scale_num, scale_denom; /* fraction by which to scale image */ jpayne@69: jpayne@69: JDIMENSION jpeg_width; /* scaled JPEG image width */ jpayne@69: JDIMENSION jpeg_height; /* scaled JPEG image height */ jpayne@69: /* Dimensions of actual JPEG image that will be written to file, jpayne@69: * derived from input dimensions by scaling factors above. jpayne@69: * These fields are computed by jpeg_start_compress(). jpayne@69: * You can also use jpeg_calc_jpeg_dimensions() to determine these values jpayne@69: * in advance of calling jpeg_start_compress(). jpayne@69: */ jpayne@69: jpayne@69: int data_precision; /* bits of precision in image data */ jpayne@69: jpayne@69: int num_components; /* # of color components in JPEG image */ jpayne@69: J_COLOR_SPACE jpeg_color_space; /* colorspace of JPEG image */ jpayne@69: jpayne@69: jpeg_component_info * comp_info; jpayne@69: /* comp_info[i] describes component that appears i'th in SOF */ jpayne@69: jpayne@69: JQUANT_TBL * quant_tbl_ptrs[NUM_QUANT_TBLS]; jpayne@69: int q_scale_factor[NUM_QUANT_TBLS]; jpayne@69: /* ptrs to coefficient quantization tables, or NULL if not defined, jpayne@69: * and corresponding scale factors (percentage, initialized 100). jpayne@69: */ jpayne@69: jpayne@69: JHUFF_TBL * dc_huff_tbl_ptrs[NUM_HUFF_TBLS]; jpayne@69: JHUFF_TBL * ac_huff_tbl_ptrs[NUM_HUFF_TBLS]; jpayne@69: /* ptrs to Huffman coding tables, or NULL if not defined */ jpayne@69: jpayne@69: UINT8 arith_dc_L[NUM_ARITH_TBLS]; /* L values for DC arith-coding tables */ jpayne@69: UINT8 arith_dc_U[NUM_ARITH_TBLS]; /* U values for DC arith-coding tables */ jpayne@69: UINT8 arith_ac_K[NUM_ARITH_TBLS]; /* Kx values for AC arith-coding tables */ jpayne@69: jpayne@69: int num_scans; /* # of entries in scan_info array */ jpayne@69: const jpeg_scan_info * scan_info; /* script for multi-scan file, or NULL */ jpayne@69: /* The default value of scan_info is NULL, which causes a single-scan jpayne@69: * sequential JPEG file to be emitted. To create a multi-scan file, jpayne@69: * set num_scans and scan_info to point to an array of scan definitions. jpayne@69: */ jpayne@69: jpayne@69: boolean raw_data_in; /* TRUE=caller supplies downsampled data */ jpayne@69: boolean arith_code; /* TRUE=arithmetic coding, FALSE=Huffman */ jpayne@69: boolean optimize_coding; /* TRUE=optimize entropy encoding parms */ jpayne@69: boolean CCIR601_sampling; /* TRUE=first samples are cosited */ jpayne@69: boolean do_fancy_downsampling; /* TRUE=apply fancy downsampling */ jpayne@69: int smoothing_factor; /* 1..100, or 0 for no input smoothing */ jpayne@69: J_DCT_METHOD dct_method; /* DCT algorithm selector */ jpayne@69: jpayne@69: /* The restart interval can be specified in absolute MCUs by setting jpayne@69: * restart_interval, or in MCU rows by setting restart_in_rows jpayne@69: * (in which case the correct restart_interval will be figured jpayne@69: * for each scan). jpayne@69: */ jpayne@69: unsigned int restart_interval; /* MCUs per restart, or 0 for no restart */ jpayne@69: int restart_in_rows; /* if > 0, MCU rows per restart interval */ jpayne@69: jpayne@69: /* Parameters controlling emission of special markers. */ jpayne@69: jpayne@69: boolean write_JFIF_header; /* should a JFIF marker be written? */ jpayne@69: UINT8 JFIF_major_version; /* What to write for the JFIF version number */ jpayne@69: UINT8 JFIF_minor_version; jpayne@69: /* These three values are not used by the JPEG code, merely copied */ jpayne@69: /* into the JFIF APP0 marker. density_unit can be 0 for unknown, */ jpayne@69: /* 1 for dots/inch, or 2 for dots/cm. Note that the pixel aspect */ jpayne@69: /* ratio is defined by X_density/Y_density even when density_unit=0. */ jpayne@69: UINT8 density_unit; /* JFIF code for pixel size units */ jpayne@69: UINT16 X_density; /* Horizontal pixel density */ jpayne@69: UINT16 Y_density; /* Vertical pixel density */ jpayne@69: boolean write_Adobe_marker; /* should an Adobe marker be written? */ jpayne@69: jpayne@69: J_COLOR_TRANSFORM color_transform; jpayne@69: /* Color transform identifier, writes LSE marker if nonzero */ jpayne@69: jpayne@69: /* State variable: index of next scanline to be written to jpayne@69: * jpeg_write_scanlines(). Application may use this to control its jpayne@69: * processing loop, e.g., "while (next_scanline < image_height)". jpayne@69: */ jpayne@69: jpayne@69: JDIMENSION next_scanline; /* 0 .. image_height-1 */ jpayne@69: jpayne@69: /* Remaining fields are known throughout compressor, but generally jpayne@69: * should not be touched by a surrounding application. jpayne@69: */ jpayne@69: jpayne@69: /* jpayne@69: * These fields are computed during compression startup jpayne@69: */ jpayne@69: boolean progressive_mode; /* TRUE if scan script uses progressive mode */ jpayne@69: int max_h_samp_factor; /* largest h_samp_factor */ jpayne@69: int max_v_samp_factor; /* largest v_samp_factor */ jpayne@69: jpayne@69: int min_DCT_h_scaled_size; /* smallest DCT_h_scaled_size of any component */ jpayne@69: int min_DCT_v_scaled_size; /* smallest DCT_v_scaled_size of any component */ jpayne@69: jpayne@69: JDIMENSION total_iMCU_rows; /* # of iMCU rows to be input to coef ctlr */ jpayne@69: /* The coefficient controller receives data in units of MCU rows as defined jpayne@69: * for fully interleaved scans (whether the JPEG file is interleaved or not). jpayne@69: * There are v_samp_factor * DCT_v_scaled_size sample rows of each component jpayne@69: * in an "iMCU" (interleaved MCU) row. jpayne@69: */ jpayne@69: jpayne@69: /* jpayne@69: * These fields are valid during any one scan. jpayne@69: * They describe the components and MCUs actually appearing in the scan. jpayne@69: */ jpayne@69: int comps_in_scan; /* # of JPEG components in this scan */ jpayne@69: jpeg_component_info * cur_comp_info[MAX_COMPS_IN_SCAN]; jpayne@69: /* *cur_comp_info[i] describes component that appears i'th in SOS */ jpayne@69: jpayne@69: JDIMENSION MCUs_per_row; /* # of MCUs across the image */ jpayne@69: JDIMENSION MCU_rows_in_scan; /* # of MCU rows in the image */ jpayne@69: jpayne@69: int blocks_in_MCU; /* # of DCT blocks per MCU */ jpayne@69: int MCU_membership[C_MAX_BLOCKS_IN_MCU]; jpayne@69: /* MCU_membership[i] is index in cur_comp_info of component owning */ jpayne@69: /* i'th block in an MCU */ jpayne@69: jpayne@69: int Ss, Se, Ah, Al; /* progressive JPEG parameters for scan */ jpayne@69: jpayne@69: int block_size; /* the basic DCT block size: 1..16 */ jpayne@69: const int * natural_order; /* natural-order position array */ jpayne@69: int lim_Se; /* min( Se, DCTSIZE2-1 ) */ jpayne@69: jpayne@69: /* jpayne@69: * Links to compression subobjects (methods and private variables of modules) jpayne@69: */ jpayne@69: struct jpeg_comp_master * master; jpayne@69: struct jpeg_c_main_controller * main; jpayne@69: struct jpeg_c_prep_controller * prep; jpayne@69: struct jpeg_c_coef_controller * coef; jpayne@69: struct jpeg_marker_writer * marker; jpayne@69: struct jpeg_color_converter * cconvert; jpayne@69: struct jpeg_downsampler * downsample; jpayne@69: struct jpeg_forward_dct * fdct; jpayne@69: struct jpeg_entropy_encoder * entropy; jpayne@69: jpeg_scan_info * script_space; /* workspace for jpeg_simple_progression */ jpayne@69: int script_space_size; jpayne@69: }; jpayne@69: jpayne@69: jpayne@69: /* Master record for a decompression instance */ jpayne@69: jpayne@69: struct jpeg_decompress_struct { jpayne@69: jpeg_common_fields; /* Fields shared with jpeg_compress_struct */ jpayne@69: jpayne@69: /* Source of compressed data */ jpayne@69: struct jpeg_source_mgr * src; jpayne@69: jpayne@69: /* Basic description of image --- filled in by jpeg_read_header(). */ jpayne@69: /* Application may inspect these values to decide how to process image. */ jpayne@69: jpayne@69: JDIMENSION image_width; /* nominal image width (from SOF marker) */ jpayne@69: JDIMENSION image_height; /* nominal image height */ jpayne@69: int num_components; /* # of color components in JPEG image */ jpayne@69: J_COLOR_SPACE jpeg_color_space; /* colorspace of JPEG image */ jpayne@69: jpayne@69: /* Decompression processing parameters --- these fields must be set before jpayne@69: * calling jpeg_start_decompress(). Note that jpeg_read_header() initializes jpayne@69: * them to default values. jpayne@69: */ jpayne@69: jpayne@69: J_COLOR_SPACE out_color_space; /* colorspace for output */ jpayne@69: jpayne@69: unsigned int scale_num, scale_denom; /* fraction by which to scale image */ jpayne@69: jpayne@69: double output_gamma; /* image gamma wanted in output */ jpayne@69: jpayne@69: boolean buffered_image; /* TRUE=multiple output passes */ jpayne@69: boolean raw_data_out; /* TRUE=downsampled data wanted */ jpayne@69: jpayne@69: J_DCT_METHOD dct_method; /* IDCT algorithm selector */ jpayne@69: boolean do_fancy_upsampling; /* TRUE=apply fancy upsampling */ jpayne@69: boolean do_block_smoothing; /* TRUE=apply interblock smoothing */ jpayne@69: jpayne@69: boolean quantize_colors; /* TRUE=colormapped output wanted */ jpayne@69: /* the following are ignored if not quantize_colors: */ jpayne@69: J_DITHER_MODE dither_mode; /* type of color dithering to use */ jpayne@69: boolean two_pass_quantize; /* TRUE=use two-pass color quantization */ jpayne@69: int desired_number_of_colors; /* max # colors to use in created colormap */ jpayne@69: /* these are significant only in buffered-image mode: */ jpayne@69: boolean enable_1pass_quant; /* enable future use of 1-pass quantizer */ jpayne@69: boolean enable_external_quant;/* enable future use of external colormap */ jpayne@69: boolean enable_2pass_quant; /* enable future use of 2-pass quantizer */ jpayne@69: jpayne@69: /* Description of actual output image that will be returned to application. jpayne@69: * These fields are computed by jpeg_start_decompress(). jpayne@69: * You can also use jpeg_calc_output_dimensions() to determine these values jpayne@69: * in advance of calling jpeg_start_decompress(). jpayne@69: */ jpayne@69: jpayne@69: JDIMENSION output_width; /* scaled image width */ jpayne@69: JDIMENSION output_height; /* scaled image height */ jpayne@69: int out_color_components; /* # of color components in out_color_space */ jpayne@69: int output_components; /* # of color components returned */ jpayne@69: /* output_components is 1 (a colormap index) when quantizing colors; jpayne@69: * otherwise it equals out_color_components. jpayne@69: */ jpayne@69: int rec_outbuf_height; /* min recommended height of scanline buffer */ jpayne@69: /* If the buffer passed to jpeg_read_scanlines() is less than this many rows jpayne@69: * high, space and time will be wasted due to unnecessary data copying. jpayne@69: * Usually rec_outbuf_height will be 1 or 2, at most 4. jpayne@69: */ jpayne@69: jpayne@69: /* When quantizing colors, the output colormap is described by these fields. jpayne@69: * The application can supply a colormap by setting colormap non-NULL before jpayne@69: * calling jpeg_start_decompress; otherwise a colormap is created during jpayne@69: * jpeg_start_decompress or jpeg_start_output. jpayne@69: * The map has out_color_components rows and actual_number_of_colors columns. jpayne@69: */ jpayne@69: int actual_number_of_colors; /* number of entries in use */ jpayne@69: JSAMPARRAY colormap; /* The color map as a 2-D pixel array */ jpayne@69: jpayne@69: /* State variables: these variables indicate the progress of decompression. jpayne@69: * The application may examine these but must not modify them. jpayne@69: */ jpayne@69: jpayne@69: /* Row index of next scanline to be read from jpeg_read_scanlines(). jpayne@69: * Application may use this to control its processing loop, e.g., jpayne@69: * "while (output_scanline < output_height)". jpayne@69: */ jpayne@69: JDIMENSION output_scanline; /* 0 .. output_height-1 */ jpayne@69: jpayne@69: /* Current input scan number and number of iMCU rows completed in scan. jpayne@69: * These indicate the progress of the decompressor input side. jpayne@69: */ jpayne@69: int input_scan_number; /* Number of SOS markers seen so far */ jpayne@69: JDIMENSION input_iMCU_row; /* Number of iMCU rows completed */ jpayne@69: jpayne@69: /* The "output scan number" is the notional scan being displayed by the jpayne@69: * output side. The decompressor will not allow output scan/row number jpayne@69: * to get ahead of input scan/row, but it can fall arbitrarily far behind. jpayne@69: */ jpayne@69: int output_scan_number; /* Nominal scan number being displayed */ jpayne@69: JDIMENSION output_iMCU_row; /* Number of iMCU rows read */ jpayne@69: jpayne@69: /* Current progression status. coef_bits[c][i] indicates the precision jpayne@69: * with which component c's DCT coefficient i (in zigzag order) is known. jpayne@69: * It is -1 when no data has yet been received, otherwise it is the point jpayne@69: * transform (shift) value for the most recent scan of the coefficient jpayne@69: * (thus, 0 at completion of the progression). jpayne@69: * This pointer is NULL when reading a non-progressive file. jpayne@69: */ jpayne@69: int (*coef_bits)[DCTSIZE2]; /* -1 or current Al value for each coef */ jpayne@69: jpayne@69: /* Internal JPEG parameters --- the application usually need not look at jpayne@69: * these fields. Note that the decompressor output side may not use jpayne@69: * any parameters that can change between scans. jpayne@69: */ jpayne@69: jpayne@69: /* Quantization and Huffman tables are carried forward across input jpayne@69: * datastreams when processing abbreviated JPEG datastreams. jpayne@69: */ jpayne@69: jpayne@69: JQUANT_TBL * quant_tbl_ptrs[NUM_QUANT_TBLS]; jpayne@69: /* ptrs to coefficient quantization tables, or NULL if not defined */ jpayne@69: jpayne@69: JHUFF_TBL * dc_huff_tbl_ptrs[NUM_HUFF_TBLS]; jpayne@69: JHUFF_TBL * ac_huff_tbl_ptrs[NUM_HUFF_TBLS]; jpayne@69: /* ptrs to Huffman coding tables, or NULL if not defined */ jpayne@69: jpayne@69: /* These parameters are never carried across datastreams, since they jpayne@69: * are given in SOF/SOS markers or defined to be reset by SOI. jpayne@69: */ jpayne@69: jpayne@69: int data_precision; /* bits of precision in image data */ jpayne@69: jpayne@69: jpeg_component_info * comp_info; jpayne@69: /* comp_info[i] describes component that appears i'th in SOF */ jpayne@69: jpayne@69: boolean is_baseline; /* TRUE if Baseline SOF0 encountered */ jpayne@69: boolean progressive_mode; /* TRUE if SOFn specifies progressive mode */ jpayne@69: boolean arith_code; /* TRUE=arithmetic coding, FALSE=Huffman */ jpayne@69: jpayne@69: UINT8 arith_dc_L[NUM_ARITH_TBLS]; /* L values for DC arith-coding tables */ jpayne@69: UINT8 arith_dc_U[NUM_ARITH_TBLS]; /* U values for DC arith-coding tables */ jpayne@69: UINT8 arith_ac_K[NUM_ARITH_TBLS]; /* Kx values for AC arith-coding tables */ jpayne@69: jpayne@69: unsigned int restart_interval; /* MCUs per restart interval, or 0 for no restart */ jpayne@69: jpayne@69: /* These fields record data obtained from optional markers recognized by jpayne@69: * the JPEG library. jpayne@69: */ jpayne@69: boolean saw_JFIF_marker; /* TRUE iff a JFIF APP0 marker was found */ jpayne@69: /* Data copied from JFIF marker; only valid if saw_JFIF_marker is TRUE: */ jpayne@69: UINT8 JFIF_major_version; /* JFIF version number */ jpayne@69: UINT8 JFIF_minor_version; jpayne@69: UINT8 density_unit; /* JFIF code for pixel size units */ jpayne@69: UINT16 X_density; /* Horizontal pixel density */ jpayne@69: UINT16 Y_density; /* Vertical pixel density */ jpayne@69: boolean saw_Adobe_marker; /* TRUE iff an Adobe APP14 marker was found */ jpayne@69: UINT8 Adobe_transform; /* Color transform code from Adobe marker */ jpayne@69: jpayne@69: J_COLOR_TRANSFORM color_transform; jpayne@69: /* Color transform identifier derived from LSE marker, otherwise zero */ jpayne@69: jpayne@69: boolean CCIR601_sampling; /* TRUE=first samples are cosited */ jpayne@69: jpayne@69: /* Aside from the specific data retained from APPn markers known to the jpayne@69: * library, the uninterpreted contents of any or all APPn and COM markers jpayne@69: * can be saved in a list for examination by the application. jpayne@69: */ jpayne@69: jpeg_saved_marker_ptr marker_list; /* Head of list of saved markers */ jpayne@69: jpayne@69: /* Remaining fields are known throughout decompressor, but generally jpayne@69: * should not be touched by a surrounding application. jpayne@69: */ jpayne@69: jpayne@69: /* jpayne@69: * These fields are computed during decompression startup jpayne@69: */ jpayne@69: int max_h_samp_factor; /* largest h_samp_factor */ jpayne@69: int max_v_samp_factor; /* largest v_samp_factor */ jpayne@69: jpayne@69: int min_DCT_h_scaled_size; /* smallest DCT_h_scaled_size of any component */ jpayne@69: int min_DCT_v_scaled_size; /* smallest DCT_v_scaled_size of any component */ jpayne@69: jpayne@69: JDIMENSION total_iMCU_rows; /* # of iMCU rows in image */ jpayne@69: /* The coefficient controller's input and output progress is measured in jpayne@69: * units of "iMCU" (interleaved MCU) rows. These are the same as MCU rows jpayne@69: * in fully interleaved JPEG scans, but are used whether the scan is jpayne@69: * interleaved or not. We define an iMCU row as v_samp_factor DCT block jpayne@69: * rows of each component. Therefore, the IDCT output contains jpayne@69: * v_samp_factor * DCT_v_scaled_size sample rows of a component per iMCU row. jpayne@69: */ jpayne@69: jpayne@69: JSAMPLE * sample_range_limit; /* table for fast range-limiting */ jpayne@69: jpayne@69: /* jpayne@69: * These fields are valid during any one scan. jpayne@69: * They describe the components and MCUs actually appearing in the scan. jpayne@69: * Note that the decompressor output side must not use these fields. jpayne@69: */ jpayne@69: int comps_in_scan; /* # of JPEG components in this scan */ jpayne@69: jpeg_component_info * cur_comp_info[MAX_COMPS_IN_SCAN]; jpayne@69: /* *cur_comp_info[i] describes component that appears i'th in SOS */ jpayne@69: jpayne@69: JDIMENSION MCUs_per_row; /* # of MCUs across the image */ jpayne@69: JDIMENSION MCU_rows_in_scan; /* # of MCU rows in the image */ jpayne@69: jpayne@69: int blocks_in_MCU; /* # of DCT blocks per MCU */ jpayne@69: int MCU_membership[D_MAX_BLOCKS_IN_MCU]; jpayne@69: /* MCU_membership[i] is index in cur_comp_info of component owning */ jpayne@69: /* i'th block in an MCU */ jpayne@69: jpayne@69: int Ss, Se, Ah, Al; /* progressive JPEG parameters for scan */ jpayne@69: jpayne@69: /* These fields are derived from Se of first SOS marker. jpayne@69: */ jpayne@69: int block_size; /* the basic DCT block size: 1..16 */ jpayne@69: const int * natural_order; /* natural-order position array for entropy decode */ jpayne@69: int lim_Se; /* min( Se, DCTSIZE2-1 ) for entropy decode */ jpayne@69: jpayne@69: /* This field is shared between entropy decoder and marker parser. jpayne@69: * It is either zero or the code of a JPEG marker that has been jpayne@69: * read from the data source, but has not yet been processed. jpayne@69: */ jpayne@69: int unread_marker; jpayne@69: jpayne@69: /* jpayne@69: * Links to decompression subobjects (methods, private variables of modules) jpayne@69: */ jpayne@69: struct jpeg_decomp_master * master; jpayne@69: struct jpeg_d_main_controller * main; jpayne@69: struct jpeg_d_coef_controller * coef; jpayne@69: struct jpeg_d_post_controller * post; jpayne@69: struct jpeg_input_controller * inputctl; jpayne@69: struct jpeg_marker_reader * marker; jpayne@69: struct jpeg_entropy_decoder * entropy; jpayne@69: struct jpeg_inverse_dct * idct; jpayne@69: struct jpeg_upsampler * upsample; jpayne@69: struct jpeg_color_deconverter * cconvert; jpayne@69: struct jpeg_color_quantizer * cquantize; jpayne@69: }; jpayne@69: jpayne@69: jpayne@69: /* "Object" declarations for JPEG modules that may be supplied or called jpayne@69: * directly by the surrounding application. jpayne@69: * As with all objects in the JPEG library, these structs only define the jpayne@69: * publicly visible methods and state variables of a module. Additional jpayne@69: * private fields may exist after the public ones. jpayne@69: */ jpayne@69: jpayne@69: jpayne@69: /* Error handler object */ jpayne@69: jpayne@69: struct jpeg_error_mgr { jpayne@69: /* Error exit handler: does not return to caller */ jpayne@69: JMETHOD(noreturn_t, error_exit, (j_common_ptr cinfo)); jpayne@69: /* Conditionally emit a trace or warning message */ jpayne@69: JMETHOD(void, emit_message, (j_common_ptr cinfo, int msg_level)); jpayne@69: /* Routine that actually outputs a trace or error message */ jpayne@69: JMETHOD(void, output_message, (j_common_ptr cinfo)); jpayne@69: /* Format a message string for the most recent JPEG error or message */ jpayne@69: JMETHOD(void, format_message, (j_common_ptr cinfo, char * buffer)); jpayne@69: #define JMSG_LENGTH_MAX 200 /* recommended size of format_message buffer */ jpayne@69: /* Reset error state variables at start of a new image */ jpayne@69: JMETHOD(void, reset_error_mgr, (j_common_ptr cinfo)); jpayne@69: jpayne@69: /* The message ID code and any parameters are saved here. jpayne@69: * A message can have one string parameter or up to 8 int parameters. jpayne@69: */ jpayne@69: int msg_code; jpayne@69: #define JMSG_STR_PARM_MAX 80 jpayne@69: union { jpayne@69: int i[8]; jpayne@69: char s[JMSG_STR_PARM_MAX]; jpayne@69: } msg_parm; jpayne@69: jpayne@69: /* Standard state variables for error facility */ jpayne@69: jpayne@69: int trace_level; /* max msg_level that will be displayed */ jpayne@69: jpayne@69: /* For recoverable corrupt-data errors, we emit a warning message, jpayne@69: * but keep going unless emit_message chooses to abort. emit_message jpayne@69: * should count warnings in num_warnings. The surrounding application jpayne@69: * can check for bad data by seeing if num_warnings is nonzero at the jpayne@69: * end of processing. jpayne@69: */ jpayne@69: long num_warnings; /* number of corrupt-data warnings */ jpayne@69: jpayne@69: /* These fields point to the table(s) of error message strings. jpayne@69: * An application can change the table pointer to switch to a different jpayne@69: * message list (typically, to change the language in which errors are jpayne@69: * reported). Some applications may wish to add additional error codes jpayne@69: * that will be handled by the JPEG library error mechanism; the second jpayne@69: * table pointer is used for this purpose. jpayne@69: * jpayne@69: * First table includes all errors generated by JPEG library itself. jpayne@69: * Error code 0 is reserved for a "no such error string" message. jpayne@69: */ jpayne@69: const char * const * jpeg_message_table; /* Library errors */ jpayne@69: int last_jpeg_message; /* Table contains strings 0..last_jpeg_message */ jpayne@69: /* Second table can be added by application (see cjpeg/djpeg for example). jpayne@69: * It contains strings numbered first_addon_message..last_addon_message. jpayne@69: */ jpayne@69: const char * const * addon_message_table; /* Non-library errors */ jpayne@69: int first_addon_message; /* code for first string in addon table */ jpayne@69: int last_addon_message; /* code for last string in addon table */ jpayne@69: }; jpayne@69: jpayne@69: jpayne@69: /* Progress monitor object */ jpayne@69: jpayne@69: struct jpeg_progress_mgr { jpayne@69: JMETHOD(void, progress_monitor, (j_common_ptr cinfo)); jpayne@69: jpayne@69: long pass_counter; /* work units completed in this pass */ jpayne@69: long pass_limit; /* total number of work units in this pass */ jpayne@69: int completed_passes; /* passes completed so far */ jpayne@69: int total_passes; /* total number of passes expected */ jpayne@69: }; jpayne@69: jpayne@69: jpayne@69: /* Data destination object for compression */ jpayne@69: jpayne@69: struct jpeg_destination_mgr { jpayne@69: JOCTET * next_output_byte; /* => next byte to write in buffer */ jpayne@69: size_t free_in_buffer; /* # of byte spaces remaining in buffer */ jpayne@69: jpayne@69: JMETHOD(void, init_destination, (j_compress_ptr cinfo)); jpayne@69: JMETHOD(boolean, empty_output_buffer, (j_compress_ptr cinfo)); jpayne@69: JMETHOD(void, term_destination, (j_compress_ptr cinfo)); jpayne@69: }; jpayne@69: jpayne@69: jpayne@69: /* Data source object for decompression */ jpayne@69: jpayne@69: struct jpeg_source_mgr { jpayne@69: const JOCTET * next_input_byte; /* => next byte to read from buffer */ jpayne@69: size_t bytes_in_buffer; /* # of bytes remaining in buffer */ jpayne@69: jpayne@69: JMETHOD(void, init_source, (j_decompress_ptr cinfo)); jpayne@69: JMETHOD(boolean, fill_input_buffer, (j_decompress_ptr cinfo)); jpayne@69: JMETHOD(void, skip_input_data, (j_decompress_ptr cinfo, long num_bytes)); jpayne@69: JMETHOD(boolean, resync_to_restart, (j_decompress_ptr cinfo, int desired)); jpayne@69: JMETHOD(void, term_source, (j_decompress_ptr cinfo)); jpayne@69: }; jpayne@69: jpayne@69: jpayne@69: /* Memory manager object. jpayne@69: * Allocates "small" objects (a few K total), "large" objects (tens of K), jpayne@69: * and "really big" objects (virtual arrays with backing store if needed). jpayne@69: * The memory manager does not allow individual objects to be freed; rather, jpayne@69: * each created object is assigned to a pool, and whole pools can be freed jpayne@69: * at once. This is faster and more convenient than remembering exactly what jpayne@69: * to free, especially where malloc()/free() are not too speedy. jpayne@69: * NB: alloc routines never return NULL. They exit to error_exit if not jpayne@69: * successful. jpayne@69: */ jpayne@69: jpayne@69: #define JPOOL_PERMANENT 0 /* lasts until master record is destroyed */ jpayne@69: #define JPOOL_IMAGE 1 /* lasts until done with image/datastream */ jpayne@69: #define JPOOL_NUMPOOLS 2 jpayne@69: jpayne@69: typedef struct jvirt_sarray_control * jvirt_sarray_ptr; jpayne@69: typedef struct jvirt_barray_control * jvirt_barray_ptr; jpayne@69: jpayne@69: jpayne@69: struct jpeg_memory_mgr { jpayne@69: /* Method pointers */ jpayne@69: JMETHOD(void *, alloc_small, (j_common_ptr cinfo, int pool_id, jpayne@69: size_t sizeofobject)); jpayne@69: JMETHOD(void FAR *, alloc_large, (j_common_ptr cinfo, int pool_id, jpayne@69: size_t sizeofobject)); jpayne@69: JMETHOD(JSAMPARRAY, alloc_sarray, (j_common_ptr cinfo, int pool_id, jpayne@69: JDIMENSION samplesperrow, jpayne@69: JDIMENSION numrows)); jpayne@69: JMETHOD(JBLOCKARRAY, alloc_barray, (j_common_ptr cinfo, int pool_id, jpayne@69: JDIMENSION blocksperrow, jpayne@69: JDIMENSION numrows)); jpayne@69: JMETHOD(jvirt_sarray_ptr, request_virt_sarray, (j_common_ptr cinfo, jpayne@69: int pool_id, jpayne@69: boolean pre_zero, jpayne@69: JDIMENSION samplesperrow, jpayne@69: JDIMENSION numrows, jpayne@69: JDIMENSION maxaccess)); jpayne@69: JMETHOD(jvirt_barray_ptr, request_virt_barray, (j_common_ptr cinfo, jpayne@69: int pool_id, jpayne@69: boolean pre_zero, jpayne@69: JDIMENSION blocksperrow, jpayne@69: JDIMENSION numrows, jpayne@69: JDIMENSION maxaccess)); jpayne@69: JMETHOD(void, realize_virt_arrays, (j_common_ptr cinfo)); jpayne@69: JMETHOD(JSAMPARRAY, access_virt_sarray, (j_common_ptr cinfo, jpayne@69: jvirt_sarray_ptr ptr, jpayne@69: JDIMENSION start_row, jpayne@69: JDIMENSION num_rows, jpayne@69: boolean writable)); jpayne@69: JMETHOD(JBLOCKARRAY, access_virt_barray, (j_common_ptr cinfo, jpayne@69: jvirt_barray_ptr ptr, jpayne@69: JDIMENSION start_row, jpayne@69: JDIMENSION num_rows, jpayne@69: boolean writable)); jpayne@69: JMETHOD(void, free_pool, (j_common_ptr cinfo, int pool_id)); jpayne@69: JMETHOD(void, self_destruct, (j_common_ptr cinfo)); jpayne@69: jpayne@69: /* Limit on memory allocation for this JPEG object. (Note that this is jpayne@69: * merely advisory, not a guaranteed maximum; it only affects the space jpayne@69: * used for virtual-array buffers.) May be changed by outer application jpayne@69: * after creating the JPEG object. jpayne@69: */ jpayne@69: long max_memory_to_use; jpayne@69: jpayne@69: /* Maximum allocation request accepted by alloc_large. */ jpayne@69: long max_alloc_chunk; jpayne@69: }; jpayne@69: jpayne@69: jpayne@69: /* Routine signature for application-supplied marker processing methods. jpayne@69: * Need not pass marker code since it is stored in cinfo->unread_marker. jpayne@69: */ jpayne@69: typedef JMETHOD(boolean, jpeg_marker_parser_method, (j_decompress_ptr cinfo)); jpayne@69: jpayne@69: jpayne@69: /* Declarations for routines called by application. jpayne@69: * The JPP macro hides prototype parameters from compilers that can't cope. jpayne@69: * Note JPP requires double parentheses. jpayne@69: */ jpayne@69: jpayne@69: #ifdef HAVE_PROTOTYPES jpayne@69: #define JPP(arglist) arglist jpayne@69: #else jpayne@69: #define JPP(arglist) () jpayne@69: #endif jpayne@69: jpayne@69: jpayne@69: /* Short forms of external names for systems with brain-damaged linkers. jpayne@69: * We shorten external names to be unique in the first six letters, which jpayne@69: * is good enough for all known systems. jpayne@69: * (If your compiler itself needs names to be unique in less than 15 jpayne@69: * characters, you are out of luck. Get a better compiler.) jpayne@69: */ jpayne@69: jpayne@69: #ifdef NEED_SHORT_EXTERNAL_NAMES jpayne@69: #define jpeg_std_error jStdError jpayne@69: #define jpeg_CreateCompress jCreaCompress jpayne@69: #define jpeg_CreateDecompress jCreaDecompress jpayne@69: #define jpeg_destroy_compress jDestCompress jpayne@69: #define jpeg_destroy_decompress jDestDecompress jpayne@69: #define jpeg_stdio_dest jStdDest jpayne@69: #define jpeg_stdio_src jStdSrc jpayne@69: #define jpeg_mem_dest jMemDest jpayne@69: #define jpeg_mem_src jMemSrc jpayne@69: #define jpeg_set_defaults jSetDefaults jpayne@69: #define jpeg_set_colorspace jSetColorspace jpayne@69: #define jpeg_default_colorspace jDefColorspace jpayne@69: #define jpeg_set_quality jSetQuality jpayne@69: #define jpeg_set_linear_quality jSetLQuality jpayne@69: #define jpeg_default_qtables jDefQTables jpayne@69: #define jpeg_add_quant_table jAddQuantTable jpayne@69: #define jpeg_quality_scaling jQualityScaling jpayne@69: #define jpeg_simple_progression jSimProgress jpayne@69: #define jpeg_suppress_tables jSuppressTables jpayne@69: #define jpeg_alloc_quant_table jAlcQTable jpayne@69: #define jpeg_alloc_huff_table jAlcHTable jpayne@69: #define jpeg_std_huff_table jStdHTable jpayne@69: #define jpeg_start_compress jStrtCompress jpayne@69: #define jpeg_write_scanlines jWrtScanlines jpayne@69: #define jpeg_finish_compress jFinCompress jpayne@69: #define jpeg_calc_jpeg_dimensions jCjpegDimensions jpayne@69: #define jpeg_write_raw_data jWrtRawData jpayne@69: #define jpeg_write_marker jWrtMarker jpayne@69: #define jpeg_write_m_header jWrtMHeader jpayne@69: #define jpeg_write_m_byte jWrtMByte jpayne@69: #define jpeg_write_tables jWrtTables jpayne@69: #define jpeg_read_header jReadHeader jpayne@69: #define jpeg_start_decompress jStrtDecompress jpayne@69: #define jpeg_read_scanlines jReadScanlines jpayne@69: #define jpeg_finish_decompress jFinDecompress jpayne@69: #define jpeg_read_raw_data jReadRawData jpayne@69: #define jpeg_has_multiple_scans jHasMultScn jpayne@69: #define jpeg_start_output jStrtOutput jpayne@69: #define jpeg_finish_output jFinOutput jpayne@69: #define jpeg_input_complete jInComplete jpayne@69: #define jpeg_new_colormap jNewCMap jpayne@69: #define jpeg_consume_input jConsumeInput jpayne@69: #define jpeg_core_output_dimensions jCoreDimensions jpayne@69: #define jpeg_calc_output_dimensions jCalcDimensions jpayne@69: #define jpeg_save_markers jSaveMarkers jpayne@69: #define jpeg_set_marker_processor jSetMarker jpayne@69: #define jpeg_read_coefficients jReadCoefs jpayne@69: #define jpeg_write_coefficients jWrtCoefs jpayne@69: #define jpeg_copy_critical_parameters jCopyCrit jpayne@69: #define jpeg_abort_compress jAbrtCompress jpayne@69: #define jpeg_abort_decompress jAbrtDecompress jpayne@69: #define jpeg_abort jAbort jpayne@69: #define jpeg_destroy jDestroy jpayne@69: #define jpeg_resync_to_restart jResyncRestart jpayne@69: #endif /* NEED_SHORT_EXTERNAL_NAMES */ jpayne@69: jpayne@69: jpayne@69: /* Default error-management setup */ jpayne@69: EXTERN(struct jpeg_error_mgr *) jpeg_std_error jpayne@69: JPP((struct jpeg_error_mgr * err)); jpayne@69: jpayne@69: /* Initialization of JPEG compression objects. jpayne@69: * jpeg_create_compress() and jpeg_create_decompress() are the exported jpayne@69: * names that applications should call. These expand to calls on jpayne@69: * jpeg_CreateCompress and jpeg_CreateDecompress with additional information jpayne@69: * passed for version mismatch checking. jpayne@69: * NB: you must set up the error-manager BEFORE calling jpeg_create_xxx. jpayne@69: */ jpayne@69: #define jpeg_create_compress(cinfo) \ jpayne@69: jpeg_CreateCompress((cinfo), JPEG_LIB_VERSION, \ jpayne@69: (size_t) sizeof(struct jpeg_compress_struct)) jpayne@69: #define jpeg_create_decompress(cinfo) \ jpayne@69: jpeg_CreateDecompress((cinfo), JPEG_LIB_VERSION, \ jpayne@69: (size_t) sizeof(struct jpeg_decompress_struct)) jpayne@69: EXTERN(void) jpeg_CreateCompress JPP((j_compress_ptr cinfo, jpayne@69: int version, size_t structsize)); jpayne@69: EXTERN(void) jpeg_CreateDecompress JPP((j_decompress_ptr cinfo, jpayne@69: int version, size_t structsize)); jpayne@69: /* Destruction of JPEG compression objects */ jpayne@69: EXTERN(void) jpeg_destroy_compress JPP((j_compress_ptr cinfo)); jpayne@69: EXTERN(void) jpeg_destroy_decompress JPP((j_decompress_ptr cinfo)); jpayne@69: jpayne@69: /* Standard data source and destination managers: stdio streams. */ jpayne@69: /* Caller is responsible for opening the file before and closing after. */ jpayne@69: EXTERN(void) jpeg_stdio_dest JPP((j_compress_ptr cinfo, FILE * outfile)); jpayne@69: EXTERN(void) jpeg_stdio_src JPP((j_decompress_ptr cinfo, FILE * infile)); jpayne@69: jpayne@69: /* Data source and destination managers: memory buffers. */ jpayne@69: EXTERN(void) jpeg_mem_dest JPP((j_compress_ptr cinfo, jpayne@69: unsigned char ** outbuffer, jpayne@69: size_t * outsize)); jpayne@69: EXTERN(void) jpeg_mem_src JPP((j_decompress_ptr cinfo, jpayne@69: const unsigned char * inbuffer, jpayne@69: size_t insize)); jpayne@69: jpayne@69: /* Default parameter setup for compression */ jpayne@69: EXTERN(void) jpeg_set_defaults JPP((j_compress_ptr cinfo)); jpayne@69: /* Compression parameter setup aids */ jpayne@69: EXTERN(void) jpeg_set_colorspace JPP((j_compress_ptr cinfo, jpayne@69: J_COLOR_SPACE colorspace)); jpayne@69: EXTERN(void) jpeg_default_colorspace JPP((j_compress_ptr cinfo)); jpayne@69: EXTERN(void) jpeg_set_quality JPP((j_compress_ptr cinfo, int quality, jpayne@69: boolean force_baseline)); jpayne@69: EXTERN(void) jpeg_set_linear_quality JPP((j_compress_ptr cinfo, jpayne@69: int scale_factor, jpayne@69: boolean force_baseline)); jpayne@69: EXTERN(void) jpeg_default_qtables JPP((j_compress_ptr cinfo, jpayne@69: boolean force_baseline)); jpayne@69: EXTERN(void) jpeg_add_quant_table JPP((j_compress_ptr cinfo, int which_tbl, jpayne@69: const unsigned int *basic_table, jpayne@69: int scale_factor, jpayne@69: boolean force_baseline)); jpayne@69: EXTERN(int) jpeg_quality_scaling JPP((int quality)); jpayne@69: EXTERN(void) jpeg_simple_progression JPP((j_compress_ptr cinfo)); jpayne@69: EXTERN(void) jpeg_suppress_tables JPP((j_compress_ptr cinfo, jpayne@69: boolean suppress)); jpayne@69: EXTERN(JQUANT_TBL *) jpeg_alloc_quant_table JPP((j_common_ptr cinfo)); jpayne@69: EXTERN(JHUFF_TBL *) jpeg_alloc_huff_table JPP((j_common_ptr cinfo)); jpayne@69: EXTERN(JHUFF_TBL *) jpeg_std_huff_table JPP((j_common_ptr cinfo, jpayne@69: boolean isDC, int tblno)); jpayne@69: jpayne@69: /* Main entry points for compression */ jpayne@69: EXTERN(void) jpeg_start_compress JPP((j_compress_ptr cinfo, jpayne@69: boolean write_all_tables)); jpayne@69: EXTERN(JDIMENSION) jpeg_write_scanlines JPP((j_compress_ptr cinfo, jpayne@69: JSAMPARRAY scanlines, jpayne@69: JDIMENSION num_lines)); jpayne@69: EXTERN(void) jpeg_finish_compress JPP((j_compress_ptr cinfo)); jpayne@69: jpayne@69: /* Precalculate JPEG dimensions for current compression parameters. */ jpayne@69: EXTERN(void) jpeg_calc_jpeg_dimensions JPP((j_compress_ptr cinfo)); jpayne@69: jpayne@69: /* Replaces jpeg_write_scanlines when writing raw downsampled data. */ jpayne@69: EXTERN(JDIMENSION) jpeg_write_raw_data JPP((j_compress_ptr cinfo, jpayne@69: JSAMPIMAGE data, jpayne@69: JDIMENSION num_lines)); jpayne@69: jpayne@69: /* Write a special marker. See libjpeg.txt concerning safe usage. */ jpayne@69: EXTERN(void) jpeg_write_marker jpayne@69: JPP((j_compress_ptr cinfo, int marker, jpayne@69: const JOCTET * dataptr, unsigned int datalen)); jpayne@69: /* Same, but piecemeal. */ jpayne@69: EXTERN(void) jpeg_write_m_header jpayne@69: JPP((j_compress_ptr cinfo, int marker, unsigned int datalen)); jpayne@69: EXTERN(void) jpeg_write_m_byte jpayne@69: JPP((j_compress_ptr cinfo, int val)); jpayne@69: jpayne@69: /* Alternate compression function: just write an abbreviated table file */ jpayne@69: EXTERN(void) jpeg_write_tables JPP((j_compress_ptr cinfo)); jpayne@69: jpayne@69: /* Decompression startup: read start of JPEG datastream to see what's there */ jpayne@69: EXTERN(int) jpeg_read_header JPP((j_decompress_ptr cinfo, jpayne@69: boolean require_image)); jpayne@69: /* Return value is one of: */ jpayne@69: #define JPEG_SUSPENDED 0 /* Suspended due to lack of input data */ jpayne@69: #define JPEG_HEADER_OK 1 /* Found valid image datastream */ jpayne@69: #define JPEG_HEADER_TABLES_ONLY 2 /* Found valid table-specs-only datastream */ jpayne@69: /* If you pass require_image = TRUE (normal case), you need not check for jpayne@69: * a TABLES_ONLY return code; an abbreviated file will cause an error exit. jpayne@69: * JPEG_SUSPENDED is only possible if you use a data source module that can jpayne@69: * give a suspension return (the stdio source module doesn't). jpayne@69: */ jpayne@69: jpayne@69: /* Main entry points for decompression */ jpayne@69: EXTERN(boolean) jpeg_start_decompress JPP((j_decompress_ptr cinfo)); jpayne@69: EXTERN(JDIMENSION) jpeg_read_scanlines JPP((j_decompress_ptr cinfo, jpayne@69: JSAMPARRAY scanlines, jpayne@69: JDIMENSION max_lines)); jpayne@69: EXTERN(boolean) jpeg_finish_decompress JPP((j_decompress_ptr cinfo)); jpayne@69: jpayne@69: /* Replaces jpeg_read_scanlines when reading raw downsampled data. */ jpayne@69: EXTERN(JDIMENSION) jpeg_read_raw_data JPP((j_decompress_ptr cinfo, jpayne@69: JSAMPIMAGE data, jpayne@69: JDIMENSION max_lines)); jpayne@69: jpayne@69: /* Additional entry points for buffered-image mode. */ jpayne@69: EXTERN(boolean) jpeg_has_multiple_scans JPP((j_decompress_ptr cinfo)); jpayne@69: EXTERN(boolean) jpeg_start_output JPP((j_decompress_ptr cinfo, jpayne@69: int scan_number)); jpayne@69: EXTERN(boolean) jpeg_finish_output JPP((j_decompress_ptr cinfo)); jpayne@69: EXTERN(boolean) jpeg_input_complete JPP((j_decompress_ptr cinfo)); jpayne@69: EXTERN(void) jpeg_new_colormap JPP((j_decompress_ptr cinfo)); jpayne@69: EXTERN(int) jpeg_consume_input JPP((j_decompress_ptr cinfo)); jpayne@69: /* Return value is one of: */ jpayne@69: /* #define JPEG_SUSPENDED 0 Suspended due to lack of input data */ jpayne@69: #define JPEG_REACHED_SOS 1 /* Reached start of new scan */ jpayne@69: #define JPEG_REACHED_EOI 2 /* Reached end of image */ jpayne@69: #define JPEG_ROW_COMPLETED 3 /* Completed one iMCU row */ jpayne@69: #define JPEG_SCAN_COMPLETED 4 /* Completed last iMCU row of a scan */ jpayne@69: jpayne@69: /* Precalculate output dimensions for current decompression parameters. */ jpayne@69: EXTERN(void) jpeg_core_output_dimensions JPP((j_decompress_ptr cinfo)); jpayne@69: EXTERN(void) jpeg_calc_output_dimensions JPP((j_decompress_ptr cinfo)); jpayne@69: jpayne@69: /* Control saving of COM and APPn markers into marker_list. */ jpayne@69: EXTERN(void) jpeg_save_markers jpayne@69: JPP((j_decompress_ptr cinfo, int marker_code, jpayne@69: unsigned int length_limit)); jpayne@69: jpayne@69: /* Install a special processing method for COM or APPn markers. */ jpayne@69: EXTERN(void) jpeg_set_marker_processor jpayne@69: JPP((j_decompress_ptr cinfo, int marker_code, jpayne@69: jpeg_marker_parser_method routine)); jpayne@69: jpayne@69: /* Read or write raw DCT coefficients --- useful for lossless transcoding. */ jpayne@69: EXTERN(jvirt_barray_ptr *) jpeg_read_coefficients JPP((j_decompress_ptr cinfo)); jpayne@69: EXTERN(void) jpeg_write_coefficients JPP((j_compress_ptr cinfo, jpayne@69: jvirt_barray_ptr * coef_arrays)); jpayne@69: EXTERN(void) jpeg_copy_critical_parameters JPP((j_decompress_ptr srcinfo, jpayne@69: j_compress_ptr dstinfo)); jpayne@69: jpayne@69: /* If you choose to abort compression or decompression before completing jpayne@69: * jpeg_finish_(de)compress, then you need to clean up to release memory, jpayne@69: * temporary files, etc. You can just call jpeg_destroy_(de)compress jpayne@69: * if you're done with the JPEG object, but if you want to clean it up and jpayne@69: * reuse it, call this: jpayne@69: */ jpayne@69: EXTERN(void) jpeg_abort_compress JPP((j_compress_ptr cinfo)); jpayne@69: EXTERN(void) jpeg_abort_decompress JPP((j_decompress_ptr cinfo)); jpayne@69: jpayne@69: /* Generic versions of jpeg_abort and jpeg_destroy that work on either jpayne@69: * flavor of JPEG object. These may be more convenient in some places. jpayne@69: */ jpayne@69: EXTERN(void) jpeg_abort JPP((j_common_ptr cinfo)); jpayne@69: EXTERN(void) jpeg_destroy JPP((j_common_ptr cinfo)); jpayne@69: jpayne@69: /* Default restart-marker-resync procedure for use by data source modules */ jpayne@69: EXTERN(boolean) jpeg_resync_to_restart JPP((j_decompress_ptr cinfo, jpayne@69: int desired)); jpayne@69: jpayne@69: jpayne@69: /* These marker codes are exported since applications and data source modules jpayne@69: * are likely to want to use them. jpayne@69: */ jpayne@69: jpayne@69: #define JPEG_RST0 0xD0 /* RST0 marker code */ jpayne@69: #define JPEG_EOI 0xD9 /* EOI marker code */ jpayne@69: #define JPEG_APP0 0xE0 /* APP0 marker code */ jpayne@69: #define JPEG_COM 0xFE /* COM marker code */ jpayne@69: jpayne@69: jpayne@69: /* If we have a brain-damaged compiler that emits warnings (or worse, errors) jpayne@69: * for structure definitions that are never filled in, keep it quiet by jpayne@69: * supplying dummy definitions for the various substructures. jpayne@69: */ jpayne@69: jpayne@69: #ifdef INCOMPLETE_TYPES_BROKEN jpayne@69: #ifndef JPEG_INTERNALS /* will be defined in jpegint.h */ jpayne@69: struct jvirt_sarray_control { long dummy; }; jpayne@69: struct jvirt_barray_control { long dummy; }; jpayne@69: struct jpeg_comp_master { long dummy; }; jpayne@69: struct jpeg_c_main_controller { long dummy; }; jpayne@69: struct jpeg_c_prep_controller { long dummy; }; jpayne@69: struct jpeg_c_coef_controller { long dummy; }; jpayne@69: struct jpeg_marker_writer { long dummy; }; jpayne@69: struct jpeg_color_converter { long dummy; }; jpayne@69: struct jpeg_downsampler { long dummy; }; jpayne@69: struct jpeg_forward_dct { long dummy; }; jpayne@69: struct jpeg_entropy_encoder { long dummy; }; jpayne@69: struct jpeg_decomp_master { long dummy; }; jpayne@69: struct jpeg_d_main_controller { long dummy; }; jpayne@69: struct jpeg_d_coef_controller { long dummy; }; jpayne@69: struct jpeg_d_post_controller { long dummy; }; jpayne@69: struct jpeg_input_controller { long dummy; }; jpayne@69: struct jpeg_marker_reader { long dummy; }; jpayne@69: struct jpeg_entropy_decoder { long dummy; }; jpayne@69: struct jpeg_inverse_dct { long dummy; }; jpayne@69: struct jpeg_upsampler { long dummy; }; jpayne@69: struct jpeg_color_deconverter { long dummy; }; jpayne@69: struct jpeg_color_quantizer { long dummy; }; jpayne@69: #endif /* JPEG_INTERNALS */ jpayne@69: #endif /* INCOMPLETE_TYPES_BROKEN */ jpayne@69: jpayne@69: jpayne@69: /* jpayne@69: * The JPEG library modules define JPEG_INTERNALS before including this file. jpayne@69: * The internal structure declarations are read only when that is true. jpayne@69: * Applications using the library should not include jpegint.h, but may wish jpayne@69: * to include jerror.h. jpayne@69: */ jpayne@69: jpayne@69: #ifdef JPEG_INTERNALS jpayne@69: #include "jpegint.h" /* fetch private declarations */ jpayne@69: #include "jerror.h" /* fetch error codes too */ jpayne@69: #endif jpayne@69: jpayne@69: #ifdef __cplusplus jpayne@69: #ifndef DONT_USE_EXTERN_C jpayne@69: } jpayne@69: #endif jpayne@69: #endif jpayne@69: jpayne@69: #endif /* JPEGLIB_H */