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