blob: 9615c5d0755e02815af660af59157717fcdb716f [file] [log] [blame]
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +00001/*
2 * jpeglib.h
3 *
DRCa73e8702012-12-31 02:52:30 +00004 * This file was part of the Independent JPEG Group's software:
Thomas G. Lane5ead57a1998-03-27 00:00:00 +00005 * Copyright (C) 1991-1998, Thomas G. Lane.
Guido Vollbeding5996a252009-06-27 00:00:00 +00006 * Modified 2002-2009 by Guido Vollbeding.
DRCda13af62014-05-18 17:52:06 +00007 * libjpeg-turbo Modifications:
DRC78df2e62014-05-12 09:23:57 +00008 * Copyright (C) 2009-2011, 2013-2014, D. R. Commander.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +00009 * For conditions of distribution and use, see the accompanying README file.
10 *
11 * This file defines the application interface for the JPEG library.
12 * Most applications using the library need only include this file,
13 * and perhaps jerror.h if they want to know the exact error codes.
14 */
15
Thomas G. Lane9ba2f5e1994-12-07 00:00:00 +000016#ifndef JPEGLIB_H
17#define JPEGLIB_H
18
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000019/*
20 * First we include the configuration files that record how this
21 * installation of the JPEG library is set up. jconfig.h can be
22 * generated automatically for many systems. jmorecfg.h contains
23 * manual configuration options that most people need not worry about.
24 */
25
DRCb7753512014-05-11 09:36:25 +000026#ifndef JCONFIG_INCLUDED /* in case jinclude.h already did */
27#include "jconfig.h" /* widely used configuration options */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000028#endif
DRCb7753512014-05-11 09:36:25 +000029#include "jmorecfg.h" /* seldom changed options */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000030
31
Guido Vollbeding5996a252009-06-27 00:00:00 +000032#ifdef __cplusplus
33#ifndef DONT_USE_EXTERN_C
34extern "C" {
35#endif
36#endif
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000037
38
39/* Various constants determining the sizes of things.
40 * All of these are specified by the JPEG standard, so don't change them
41 * if you want to be compatible.
42 */
43
DRCb7753512014-05-11 09:36:25 +000044#define DCTSIZE 8 /* The basic DCT block is 8x8 samples */
45#define DCTSIZE2 64 /* DCTSIZE squared; # of elements in a block */
46#define NUM_QUANT_TBLS 4 /* Quantization tables are numbered 0..3 */
47#define NUM_HUFF_TBLS 4 /* Huffman tables are numbered 0..3 */
48#define NUM_ARITH_TBLS 16 /* Arith-coding tables are numbered 0..15 */
49#define MAX_COMPS_IN_SCAN 4 /* JPEG limit on # of components in one scan */
50#define MAX_SAMP_FACTOR 4 /* JPEG limit on sampling factors */
Thomas G. Lanebc79e061995-08-02 00:00:00 +000051/* Unfortunately, some bozo at Adobe saw no reason to be bound by the standard;
52 * the PostScript DCT filter can emit files with many more than 10 blocks/MCU.
53 * If you happen to run across such a file, you can up D_MAX_BLOCKS_IN_MCU
54 * to handle it. We even let you do this from the jconfig.h file. However,
55 * we strongly discourage changing C_MAX_BLOCKS_IN_MCU; just because Adobe
56 * sometimes emits noncompliant files doesn't mean you should too.
57 */
58#define C_MAX_BLOCKS_IN_MCU 10 /* compressor's limit on blocks per MCU */
59#ifndef D_MAX_BLOCKS_IN_MCU
60#define D_MAX_BLOCKS_IN_MCU 10 /* decompressor's limit on blocks per MCU */
61#endif
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000062
63
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000064/* Data structures for images (arrays of samples and of DCT coefficients).
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000065 */
66
DRC5033f3e2014-05-18 18:33:44 +000067typedef JSAMPLE *JSAMPROW; /* ptr to one image row of pixel samples. */
DRCb7753512014-05-11 09:36:25 +000068typedef JSAMPROW *JSAMPARRAY; /* ptr to some rows (a 2-D sample array) */
69typedef JSAMPARRAY *JSAMPIMAGE; /* a 3-D sample array: top index is color */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000070
DRCb7753512014-05-11 09:36:25 +000071typedef JCOEF JBLOCK[DCTSIZE2]; /* one block of coefficients */
DRC5033f3e2014-05-18 18:33:44 +000072typedef JBLOCK *JBLOCKROW; /* pointer to one row of coefficient blocks */
DRCb7753512014-05-11 09:36:25 +000073typedef JBLOCKROW *JBLOCKARRAY; /* a 2-D array of coefficient blocks */
74typedef JBLOCKARRAY *JBLOCKIMAGE; /* a 3-D array of coefficient blocks */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000075
DRC5033f3e2014-05-18 18:33:44 +000076typedef JCOEF *JCOEFPTR; /* useful in a couple of places */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000077
78
79/* Types for JPEG compression parameters and working tables. */
80
81
82/* DCT coefficient quantization tables. */
83
84typedef struct {
Thomas G. Lane489583f1996-02-07 00:00:00 +000085 /* This array gives the coefficient quantizers in natural array order
86 * (not the zigzag order in which they are stored in a JPEG DQT marker).
87 * CAUTION: IJG versions prior to v6a kept this array in zigzag order.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000088 */
DRCb7753512014-05-11 09:36:25 +000089 UINT16 quantval[DCTSIZE2]; /* quantization step for each coefficient */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000090 /* This field is used only during compression. It's initialized FALSE when
91 * the table is created, and set TRUE when it's been output to the file.
92 * You could suppress output of a table by setting this to TRUE.
93 * (See jpeg_suppress_tables for an example.)
94 */
DRCb7753512014-05-11 09:36:25 +000095 boolean sent_table; /* TRUE when table has been output */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000096} JQUANT_TBL;
97
98
99/* Huffman coding tables. */
100
101typedef struct {
102 /* These two fields directly represent the contents of a JPEG DHT marker */
DRCb7753512014-05-11 09:36:25 +0000103 UINT8 bits[17]; /* bits[k] = # of symbols with codes of */
104 /* length k bits; bits[0] is unused */
105 UINT8 huffval[256]; /* The symbols, in order of incr code length */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000106 /* This field is used only during compression. It's initialized FALSE when
107 * the table is created, and set TRUE when it's been output to the file.
108 * You could suppress output of a table by setting this to TRUE.
109 * (See jpeg_suppress_tables for an example.)
110 */
DRCb7753512014-05-11 09:36:25 +0000111 boolean sent_table; /* TRUE when table has been output */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000112} JHUFF_TBL;
113
114
115/* Basic info about one component (color channel). */
116
117typedef struct {
118 /* These values are fixed over the whole image. */
119 /* For compression, they must be supplied by parameter setup; */
120 /* for decompression, they are read from the SOF marker. */
DRCb7753512014-05-11 09:36:25 +0000121 int component_id; /* identifier for this component (0..255) */
122 int component_index; /* its index in SOF or cinfo->comp_info[] */
123 int h_samp_factor; /* horizontal sampling factor (1..4) */
124 int v_samp_factor; /* vertical sampling factor (1..4) */
125 int quant_tbl_no; /* quantization table selector (0..3) */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000126 /* These values may vary between scans. */
127 /* For compression, they must be supplied by parameter setup; */
128 /* for decompression, they are read from the SOS marker. */
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000129 /* The decompressor output side may not use these variables. */
DRCb7753512014-05-11 09:36:25 +0000130 int dc_tbl_no; /* DC entropy table selector (0..3) */
131 int ac_tbl_no; /* AC entropy table selector (0..3) */
132
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000133 /* Remaining fields should be treated as private by applications. */
DRCb7753512014-05-11 09:36:25 +0000134
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000135 /* These values are computed during compression or decompression startup: */
136 /* Component's size in DCT blocks.
137 * Any dummy blocks added to complete an MCU are not counted; therefore
138 * these values do not depend on whether a scan is interleaved or not.
139 */
140 JDIMENSION width_in_blocks;
141 JDIMENSION height_in_blocks;
142 /* Size of a DCT block in samples. Always DCTSIZE for compression.
143 * For decompression this is the size of the output from one DCT block,
144 * reflecting any scaling we choose to apply during the IDCT step.
DRCfe9c9072014-04-18 07:58:29 +0000145 * Values from 1 to 16 are supported.
146 * Note that different components may receive different IDCT scalings.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000147 */
DRC10acd812010-10-09 19:24:28 +0000148#if JPEG_LIB_VERSION >= 70
149 int DCT_h_scaled_size;
150 int DCT_v_scaled_size;
151#else
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000152 int DCT_scaled_size;
DRC10acd812010-10-09 19:24:28 +0000153#endif
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000154 /* The downsampled dimensions are the component's actual, unpadded number
155 * of samples at the main buffer (preprocessing/compression interface), thus
156 * downsampled_width = ceil(image_width * Hi/Hmax)
157 * and similarly for height. For decompression, IDCT scaling is included, so
DRC10acd812010-10-09 19:24:28 +0000158 * downsampled_width = ceil(image_width * Hi/Hmax * DCT_[h_]scaled_size/DCTSIZE)
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000159 */
DRCb7753512014-05-11 09:36:25 +0000160 JDIMENSION downsampled_width; /* actual width in samples */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000161 JDIMENSION downsampled_height; /* actual height in samples */
162 /* This flag is used only for decompression. In cases where some of the
163 * components will be ignored (eg grayscale output from YCbCr image),
164 * we can skip most computations for the unused components.
165 */
DRCb7753512014-05-11 09:36:25 +0000166 boolean component_needed; /* do we need the value of this component? */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000167
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000168 /* These values are computed before starting a scan of the component. */
169 /* The decompressor output side may not use these variables. */
DRCb7753512014-05-11 09:36:25 +0000170 int MCU_width; /* number of blocks per MCU, horizontally */
171 int MCU_height; /* number of blocks per MCU, vertically */
172 int MCU_blocks; /* MCU_width * MCU_height */
173 int MCU_sample_width; /* MCU width in samples, MCU_width*DCT_[h_]scaled_size */
174 int last_col_width; /* # of non-dummy blocks across in last MCU */
175 int last_row_height; /* # of non-dummy blocks down in last MCU */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000176
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000177 /* Saved quantization table for component; NULL if none yet saved.
178 * See jdinput.c comments about the need for this information.
Thomas G. Lane489583f1996-02-07 00:00:00 +0000179 * This field is currently used only for decompression.
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000180 */
181 JQUANT_TBL * quant_table;
182
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000183 /* Private per-component storage for DCT or IDCT subsystem. */
184 void * dct_table;
185} jpeg_component_info;
186
187
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000188/* The script for encoding a multiple-scan file is an array of these: */
189
190typedef struct {
DRCb7753512014-05-11 09:36:25 +0000191 int comps_in_scan; /* number of components encoded in this scan */
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000192 int component_index[MAX_COMPS_IN_SCAN]; /* their SOF/comp_info[] indexes */
DRCb7753512014-05-11 09:36:25 +0000193 int Ss, Se; /* progressive JPEG spectral selection parms */
194 int Ah, Al; /* progressive JPEG successive approx. parms */
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000195} jpeg_scan_info;
196
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000197/* The decompressor can save APPn and COM markers in a list of these: */
198
DRC5033f3e2014-05-18 18:33:44 +0000199typedef struct jpeg_marker_struct * jpeg_saved_marker_ptr;
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000200
201struct jpeg_marker_struct {
DRCb7753512014-05-11 09:36:25 +0000202 jpeg_saved_marker_ptr next; /* next in list, or NULL */
203 UINT8 marker; /* marker code: JPEG_COM, or JPEG_APP0+n */
204 unsigned int original_length; /* # bytes of data in the file */
205 unsigned int data_length; /* # bytes of data saved at data[] */
DRC5033f3e2014-05-18 18:33:44 +0000206 JOCTET * data; /* the data contained in the marker */
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000207 /* the marker length word is not counted in data_length or original_length */
208};
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000209
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000210/* Known color spaces. */
211
DRCf25c0712009-04-03 12:00:51 +0000212#define JCS_EXTENSIONS 1
DRC67ce3b22011-12-19 02:21:03 +0000213#define JCS_ALPHA_EXTENSIONS 1
DRCf25c0712009-04-03 12:00:51 +0000214
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000215typedef enum {
DRC333e9182014-05-12 00:34:08 +0000216 JCS_UNKNOWN, /* error/unspecified */
217 JCS_GRAYSCALE, /* monochrome */
218 JCS_RGB, /* red/green/blue as specified by the RGB_RED,
219 RGB_GREEN, RGB_BLUE, and RGB_PIXELSIZE macros */
220 JCS_YCbCr, /* Y/Cb/Cr (also known as YUV) */
221 JCS_CMYK, /* C/M/Y/K */
222 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 */
228 JCS_EXT_XRGB, /* x/red/green/blue */
229 /* When out_color_space it set to JCS_EXT_RGBX, JCS_EXT_BGRX, JCS_EXT_XBGR,
230 or JCS_EXT_XRGB during decompression, the X byte is undefined, and in
231 order to ensure the best performance, libjpeg-turbo can set that byte to
232 whatever value it wishes. Use the following colorspace constants to
233 ensure that the X byte is set to 0xFF, so that it can be interpreted as an
234 opaque alpha channel. */
235 JCS_EXT_RGBA, /* red/green/blue/alpha */
236 JCS_EXT_BGRA, /* blue/green/red/alpha */
237 JCS_EXT_ABGR, /* alpha/blue/green/red */
DRC78df2e62014-05-12 09:23:57 +0000238 JCS_EXT_ARGB, /* alpha/red/green/blue */
239 JCS_RGB565 /* 5-bit red/6-bit green/5-bit blue */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000240} J_COLOR_SPACE;
241
242/* DCT/IDCT algorithm options. */
243
244typedef enum {
DRC333e9182014-05-12 00:34:08 +0000245 JDCT_ISLOW, /* slow but accurate integer algorithm */
246 JDCT_IFAST, /* faster, less accurate integer method */
247 JDCT_FLOAT /* floating-point: accurate, fast on fast HW */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000248} J_DCT_METHOD;
249
DRCb7753512014-05-11 09:36:25 +0000250#ifndef JDCT_DEFAULT /* may be overridden in jconfig.h */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000251#define JDCT_DEFAULT JDCT_ISLOW
252#endif
DRCb7753512014-05-11 09:36:25 +0000253#ifndef JDCT_FASTEST /* may be overridden in jconfig.h */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000254#define JDCT_FASTEST JDCT_IFAST
255#endif
256
257/* Dithering options for decompression. */
258
259typedef enum {
DRC333e9182014-05-12 00:34:08 +0000260 JDITHER_NONE, /* no dithering */
261 JDITHER_ORDERED, /* simple ordered dither */
262 JDITHER_FS /* Floyd-Steinberg error diffusion dither */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000263} J_DITHER_MODE;
264
265
266/* Common fields between JPEG compression and decompression master structs. */
267
268#define jpeg_common_fields \
DRCb7753512014-05-11 09:36:25 +0000269 struct jpeg_error_mgr * err; /* Error handler module */\
270 struct jpeg_memory_mgr * mem; /* Memory manager module */\
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000271 struct jpeg_progress_mgr * progress; /* Progress monitor, or NULL if none */\
DRCb7753512014-05-11 09:36:25 +0000272 void * client_data; /* Available for use by application */\
273 boolean is_decompressor; /* So common code can tell which is which */\
274 int global_state /* For checking call sequence validity */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000275
276/* Routines that are to be used by both halves of the library are declared
277 * to receive a pointer to this structure. There are no actual instances of
278 * jpeg_common_struct, only of jpeg_compress_struct and jpeg_decompress_struct.
279 */
280struct jpeg_common_struct {
DRCb7753512014-05-11 09:36:25 +0000281 jpeg_common_fields; /* Fields common to both master struct types */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000282 /* Additional fields follow in an actual jpeg_compress_struct or
283 * jpeg_decompress_struct. All three structs must agree on these
284 * initial fields! (This would be a lot cleaner in C++.)
285 */
286};
287
288typedef struct jpeg_common_struct * j_common_ptr;
289typedef struct jpeg_compress_struct * j_compress_ptr;
290typedef struct jpeg_decompress_struct * j_decompress_ptr;
291
292
293/* Master record for a compression instance */
294
295struct jpeg_compress_struct {
DRCb7753512014-05-11 09:36:25 +0000296 jpeg_common_fields; /* Fields shared with jpeg_decompress_struct */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000297
298 /* Destination for compressed data */
299 struct jpeg_destination_mgr * dest;
300
301 /* Description of source image --- these fields must be filled in by
302 * outer application before starting compression. in_color_space must
303 * be correct before you can even call jpeg_set_defaults().
304 */
305
DRCb7753512014-05-11 09:36:25 +0000306 JDIMENSION image_width; /* input image width */
307 JDIMENSION image_height; /* input image height */
308 int input_components; /* # of color components in input image */
309 J_COLOR_SPACE in_color_space; /* colorspace of input image */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000310
DRCb7753512014-05-11 09:36:25 +0000311 double input_gamma; /* image gamma of input image */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000312
313 /* Compression parameters --- these fields must be set before calling
314 * jpeg_start_compress(). We recommend calling jpeg_set_defaults() to
315 * initialize everything to reasonable defaults, then changing anything
316 * the application specifically wants to change. That way you won't get
317 * burnt when new parameters are added. Also note that there are several
318 * helper routines to simplify changing parameters.
319 */
320
DRC36a6eec2010-10-08 08:05:44 +0000321#if JPEG_LIB_VERSION >= 70
Guido Vollbeding5996a252009-06-27 00:00:00 +0000322 unsigned int scale_num, scale_denom; /* fraction by which to scale image */
323
DRCb7753512014-05-11 09:36:25 +0000324 JDIMENSION jpeg_width; /* scaled JPEG image width */
325 JDIMENSION jpeg_height; /* scaled JPEG image height */
Guido Vollbeding5996a252009-06-27 00:00:00 +0000326 /* Dimensions of actual JPEG image that will be written to file,
327 * derived from input dimensions by scaling factors above.
328 * These fields are computed by jpeg_start_compress().
329 * You can also use jpeg_calc_jpeg_dimensions() to determine these values
330 * in advance of calling jpeg_start_compress().
331 */
DRC36a6eec2010-10-08 08:05:44 +0000332#endif
Guido Vollbeding5996a252009-06-27 00:00:00 +0000333
DRCb7753512014-05-11 09:36:25 +0000334 int data_precision; /* bits of precision in image data */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000335
DRCb7753512014-05-11 09:36:25 +0000336 int num_components; /* # of color components in JPEG image */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000337 J_COLOR_SPACE jpeg_color_space; /* colorspace of JPEG image */
338
339 jpeg_component_info * comp_info;
340 /* comp_info[i] describes component that appears i'th in SOF */
Guido Vollbeding5996a252009-06-27 00:00:00 +0000341
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000342 JQUANT_TBL * quant_tbl_ptrs[NUM_QUANT_TBLS];
DRC36a6eec2010-10-08 08:05:44 +0000343#if JPEG_LIB_VERSION >= 70
Guido Vollbeding5996a252009-06-27 00:00:00 +0000344 int q_scale_factor[NUM_QUANT_TBLS];
DRC36a6eec2010-10-08 08:05:44 +0000345#endif
Guido Vollbeding5996a252009-06-27 00:00:00 +0000346 /* ptrs to coefficient quantization tables, or NULL if not defined,
347 * and corresponding scale factors (percentage, initialized 100).
348 */
349
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000350 JHUFF_TBL * dc_huff_tbl_ptrs[NUM_HUFF_TBLS];
351 JHUFF_TBL * ac_huff_tbl_ptrs[NUM_HUFF_TBLS];
352 /* ptrs to Huffman coding tables, or NULL if not defined */
Guido Vollbeding5996a252009-06-27 00:00:00 +0000353
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000354 UINT8 arith_dc_L[NUM_ARITH_TBLS]; /* L values for DC arith-coding tables */
355 UINT8 arith_dc_U[NUM_ARITH_TBLS]; /* U values for DC arith-coding tables */
356 UINT8 arith_ac_K[NUM_ARITH_TBLS]; /* Kx values for AC arith-coding tables */
357
DRCb7753512014-05-11 09:36:25 +0000358 int num_scans; /* # of entries in scan_info array */
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000359 const jpeg_scan_info * scan_info; /* script for multi-scan file, or NULL */
360 /* The default value of scan_info is NULL, which causes a single-scan
361 * sequential JPEG file to be emitted. To create a multi-scan file,
362 * set num_scans and scan_info to point to an array of scan definitions.
363 */
364
DRCb7753512014-05-11 09:36:25 +0000365 boolean raw_data_in; /* TRUE=caller supplies downsampled data */
366 boolean arith_code; /* TRUE=arithmetic coding, FALSE=Huffman */
367 boolean optimize_coding; /* TRUE=optimize entropy encoding parms */
368 boolean CCIR601_sampling; /* TRUE=first samples are cosited */
DRC36a6eec2010-10-08 08:05:44 +0000369#if JPEG_LIB_VERSION >= 70
Guido Vollbeding5996a252009-06-27 00:00:00 +0000370 boolean do_fancy_downsampling; /* TRUE=apply fancy downsampling */
DRC36a6eec2010-10-08 08:05:44 +0000371#endif
DRCb7753512014-05-11 09:36:25 +0000372 int smoothing_factor; /* 1..100, or 0 for no input smoothing */
373 J_DCT_METHOD dct_method; /* DCT algorithm selector */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000374
375 /* The restart interval can be specified in absolute MCUs by setting
376 * restart_interval, or in MCU rows by setting restart_in_rows
377 * (in which case the correct restart_interval will be figured
378 * for each scan).
379 */
380 unsigned int restart_interval; /* MCUs per restart, or 0 for no restart */
DRCb7753512014-05-11 09:36:25 +0000381 int restart_in_rows; /* if > 0, MCU rows per restart interval */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000382
383 /* Parameters controlling emission of special markers. */
384
DRCb7753512014-05-11 09:36:25 +0000385 boolean write_JFIF_header; /* should a JFIF marker be written? */
386 UINT8 JFIF_major_version; /* What to write for the JFIF version number */
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000387 UINT8 JFIF_minor_version;
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000388 /* These three values are not used by the JPEG code, merely copied */
389 /* into the JFIF APP0 marker. density_unit can be 0 for unknown, */
390 /* 1 for dots/inch, or 2 for dots/cm. Note that the pixel aspect */
391 /* ratio is defined by X_density/Y_density even when density_unit=0. */
DRCb7753512014-05-11 09:36:25 +0000392 UINT8 density_unit; /* JFIF code for pixel size units */
393 UINT16 X_density; /* Horizontal pixel density */
394 UINT16 Y_density; /* Vertical pixel density */
395 boolean write_Adobe_marker; /* should an Adobe marker be written? */
396
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000397 /* State variable: index of next scanline to be written to
398 * jpeg_write_scanlines(). Application may use this to control its
399 * processing loop, e.g., "while (next_scanline < image_height)".
400 */
401
DRCb7753512014-05-11 09:36:25 +0000402 JDIMENSION next_scanline; /* 0 .. image_height-1 */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000403
404 /* Remaining fields are known throughout compressor, but generally
405 * should not be touched by a surrounding application.
406 */
407
408 /*
409 * These fields are computed during compression startup
410 */
DRCb7753512014-05-11 09:36:25 +0000411 boolean progressive_mode; /* TRUE if scan script uses progressive mode */
412 int max_h_samp_factor; /* largest h_samp_factor */
413 int max_v_samp_factor; /* largest v_samp_factor */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000414
DRC36a6eec2010-10-08 08:05:44 +0000415#if JPEG_LIB_VERSION >= 70
DRCb7753512014-05-11 09:36:25 +0000416 int min_DCT_h_scaled_size; /* smallest DCT_h_scaled_size of any component */
417 int min_DCT_v_scaled_size; /* smallest DCT_v_scaled_size of any component */
DRC36a6eec2010-10-08 08:05:44 +0000418#endif
Guido Vollbeding5996a252009-06-27 00:00:00 +0000419
DRCb7753512014-05-11 09:36:25 +0000420 JDIMENSION total_iMCU_rows; /* # of iMCU rows to be input to coef ctlr */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000421 /* The coefficient controller receives data in units of MCU rows as defined
422 * for fully interleaved scans (whether the JPEG file is interleaved or not).
423 * There are v_samp_factor * DCTSIZE sample rows of each component in an
424 * "iMCU" (interleaved MCU) row.
425 */
DRCb7753512014-05-11 09:36:25 +0000426
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000427 /*
428 * These fields are valid during any one scan.
429 * They describe the components and MCUs actually appearing in the scan.
430 */
DRCb7753512014-05-11 09:36:25 +0000431 int comps_in_scan; /* # of JPEG components in this scan */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000432 jpeg_component_info * cur_comp_info[MAX_COMPS_IN_SCAN];
433 /* *cur_comp_info[i] describes component that appears i'th in SOS */
DRCb7753512014-05-11 09:36:25 +0000434
435 JDIMENSION MCUs_per_row; /* # of MCUs across the image */
436 JDIMENSION MCU_rows_in_scan; /* # of MCU rows in the image */
437
438 int blocks_in_MCU; /* # of DCT blocks per MCU */
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000439 int MCU_membership[C_MAX_BLOCKS_IN_MCU];
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000440 /* MCU_membership[i] is index in cur_comp_info of component owning */
441 /* i'th block in an MCU */
442
DRCb7753512014-05-11 09:36:25 +0000443 int Ss, Se, Ah, Al; /* progressive JPEG parameters for scan */
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000444
DRC36a6eec2010-10-08 08:05:44 +0000445#if JPEG_LIB_VERSION >= 80
DRCb7753512014-05-11 09:36:25 +0000446 int block_size; /* the basic DCT block size: 1..16 */
447 const int * natural_order; /* natural-order position array */
448 int lim_Se; /* min( Se, DCTSIZE2-1 ) */
DRC36a6eec2010-10-08 08:05:44 +0000449#endif
Guido Vollbeding989630f2010-01-10 00:00:00 +0000450
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000451 /*
452 * Links to compression subobjects (methods and private variables of modules)
453 */
454 struct jpeg_comp_master * master;
455 struct jpeg_c_main_controller * main;
456 struct jpeg_c_prep_controller * prep;
457 struct jpeg_c_coef_controller * coef;
458 struct jpeg_marker_writer * marker;
459 struct jpeg_color_converter * cconvert;
460 struct jpeg_downsampler * downsample;
461 struct jpeg_forward_dct * fdct;
462 struct jpeg_entropy_encoder * entropy;
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000463 jpeg_scan_info * script_space; /* workspace for jpeg_simple_progression */
464 int script_space_size;
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000465};
466
467
468/* Master record for a decompression instance */
469
470struct jpeg_decompress_struct {
DRCb7753512014-05-11 09:36:25 +0000471 jpeg_common_fields; /* Fields shared with jpeg_compress_struct */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000472
473 /* Source of compressed data */
474 struct jpeg_source_mgr * src;
475
476 /* Basic description of image --- filled in by jpeg_read_header(). */
477 /* Application may inspect these values to decide how to process image. */
478
DRCb7753512014-05-11 09:36:25 +0000479 JDIMENSION image_width; /* nominal image width (from SOF marker) */
480 JDIMENSION image_height; /* nominal image height */
481 int num_components; /* # of color components in JPEG image */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000482 J_COLOR_SPACE jpeg_color_space; /* colorspace of JPEG image */
483
484 /* Decompression processing parameters --- these fields must be set before
485 * calling jpeg_start_decompress(). Note that jpeg_read_header() initializes
486 * them to default values.
487 */
488
489 J_COLOR_SPACE out_color_space; /* colorspace for output */
490
491 unsigned int scale_num, scale_denom; /* fraction by which to scale image */
492
DRCb7753512014-05-11 09:36:25 +0000493 double output_gamma; /* image gamma wanted in output */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000494
DRCb7753512014-05-11 09:36:25 +0000495 boolean buffered_image; /* TRUE=multiple output passes */
496 boolean raw_data_out; /* TRUE=downsampled data wanted */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000497
DRCb7753512014-05-11 09:36:25 +0000498 J_DCT_METHOD dct_method; /* IDCT algorithm selector */
499 boolean do_fancy_upsampling; /* TRUE=apply fancy upsampling */
500 boolean do_block_smoothing; /* TRUE=apply interblock smoothing */
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000501
DRCb7753512014-05-11 09:36:25 +0000502 boolean quantize_colors; /* TRUE=colormapped output wanted */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000503 /* the following are ignored if not quantize_colors: */
DRCb7753512014-05-11 09:36:25 +0000504 J_DITHER_MODE dither_mode; /* type of color dithering to use */
505 boolean two_pass_quantize; /* TRUE=use two-pass color quantization */
506 int desired_number_of_colors; /* max # colors to use in created colormap */
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000507 /* these are significant only in buffered-image mode: */
DRCb7753512014-05-11 09:36:25 +0000508 boolean enable_1pass_quant; /* enable future use of 1-pass quantizer */
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000509 boolean enable_external_quant;/* enable future use of external colormap */
DRCb7753512014-05-11 09:36:25 +0000510 boolean enable_2pass_quant; /* enable future use of 2-pass quantizer */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000511
512 /* Description of actual output image that will be returned to application.
513 * These fields are computed by jpeg_start_decompress().
514 * You can also use jpeg_calc_output_dimensions() to determine these values
515 * in advance of calling jpeg_start_decompress().
516 */
517
DRCb7753512014-05-11 09:36:25 +0000518 JDIMENSION output_width; /* scaled image width */
519 JDIMENSION output_height; /* scaled image height */
520 int out_color_components; /* # of color components in out_color_space */
521 int output_components; /* # of color components returned */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000522 /* output_components is 1 (a colormap index) when quantizing colors;
523 * otherwise it equals out_color_components.
524 */
DRCb7753512014-05-11 09:36:25 +0000525 int rec_outbuf_height; /* min recommended height of scanline buffer */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000526 /* If the buffer passed to jpeg_read_scanlines() is less than this many rows
527 * high, space and time will be wasted due to unnecessary data copying.
528 * Usually rec_outbuf_height will be 1 or 2, at most 4.
529 */
530
531 /* When quantizing colors, the output colormap is described by these fields.
532 * The application can supply a colormap by setting colormap non-NULL before
533 * calling jpeg_start_decompress; otherwise a colormap is created during
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000534 * jpeg_start_decompress or jpeg_start_output.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000535 * The map has out_color_components rows and actual_number_of_colors columns.
536 */
DRCb7753512014-05-11 09:36:25 +0000537 int actual_number_of_colors; /* number of entries in use */
538 JSAMPARRAY colormap; /* The color map as a 2-D pixel array */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000539
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000540 /* State variables: these variables indicate the progress of decompression.
541 * The application may examine these but must not modify them.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000542 */
543
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000544 /* Row index of next scanline to be read from jpeg_read_scanlines().
545 * Application may use this to control its processing loop, e.g.,
546 * "while (output_scanline < output_height)".
547 */
DRCb7753512014-05-11 09:36:25 +0000548 JDIMENSION output_scanline; /* 0 .. output_height-1 */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000549
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000550 /* Current input scan number and number of iMCU rows completed in scan.
551 * These indicate the progress of the decompressor input side.
552 */
DRCb7753512014-05-11 09:36:25 +0000553 int input_scan_number; /* Number of SOS markers seen so far */
554 JDIMENSION input_iMCU_row; /* Number of iMCU rows completed */
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000555
556 /* The "output scan number" is the notional scan being displayed by the
557 * output side. The decompressor will not allow output scan/row number
558 * to get ahead of input scan/row, but it can fall arbitrarily far behind.
559 */
DRCb7753512014-05-11 09:36:25 +0000560 int output_scan_number; /* Nominal scan number being displayed */
561 JDIMENSION output_iMCU_row; /* Number of iMCU rows read */
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000562
563 /* Current progression status. coef_bits[c][i] indicates the precision
564 * with which component c's DCT coefficient i (in zigzag order) is known.
565 * It is -1 when no data has yet been received, otherwise it is the point
566 * transform (shift) value for the most recent scan of the coefficient
567 * (thus, 0 at completion of the progression).
568 * This pointer is NULL when reading a non-progressive file.
569 */
DRCb7753512014-05-11 09:36:25 +0000570 int (*coef_bits)[DCTSIZE2]; /* -1 or current Al value for each coef */
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000571
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000572 /* Internal JPEG parameters --- the application usually need not look at
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000573 * these fields. Note that the decompressor output side may not use
574 * any parameters that can change between scans.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000575 */
576
577 /* Quantization and Huffman tables are carried forward across input
578 * datastreams when processing abbreviated JPEG datastreams.
579 */
580
581 JQUANT_TBL * quant_tbl_ptrs[NUM_QUANT_TBLS];
582 /* ptrs to coefficient quantization tables, or NULL if not defined */
583
584 JHUFF_TBL * dc_huff_tbl_ptrs[NUM_HUFF_TBLS];
585 JHUFF_TBL * ac_huff_tbl_ptrs[NUM_HUFF_TBLS];
586 /* ptrs to Huffman coding tables, or NULL if not defined */
587
588 /* These parameters are never carried across datastreams, since they
589 * are given in SOF/SOS markers or defined to be reset by SOI.
590 */
591
DRCb7753512014-05-11 09:36:25 +0000592 int data_precision; /* bits of precision in image data */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000593
594 jpeg_component_info * comp_info;
595 /* comp_info[i] describes component that appears i'th in SOF */
596
DRC36a6eec2010-10-08 08:05:44 +0000597#if JPEG_LIB_VERSION >= 80
DRCb7753512014-05-11 09:36:25 +0000598 boolean is_baseline; /* TRUE if Baseline SOF0 encountered */
DRC36a6eec2010-10-08 08:05:44 +0000599#endif
DRCb7753512014-05-11 09:36:25 +0000600 boolean progressive_mode; /* TRUE if SOFn specifies progressive mode */
601 boolean arith_code; /* TRUE=arithmetic coding, FALSE=Huffman */
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000602
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000603 UINT8 arith_dc_L[NUM_ARITH_TBLS]; /* L values for DC arith-coding tables */
604 UINT8 arith_dc_U[NUM_ARITH_TBLS]; /* U values for DC arith-coding tables */
605 UINT8 arith_ac_K[NUM_ARITH_TBLS]; /* Kx values for AC arith-coding tables */
606
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000607 unsigned int restart_interval; /* MCUs per restart interval, or 0 for no restart */
608
609 /* These fields record data obtained from optional markers recognized by
610 * the JPEG library.
611 */
DRCb7753512014-05-11 09:36:25 +0000612 boolean saw_JFIF_marker; /* TRUE iff a JFIF APP0 marker was found */
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000613 /* Data copied from JFIF marker; only valid if saw_JFIF_marker is TRUE: */
DRCb7753512014-05-11 09:36:25 +0000614 UINT8 JFIF_major_version; /* JFIF version number */
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000615 UINT8 JFIF_minor_version;
DRCb7753512014-05-11 09:36:25 +0000616 UINT8 density_unit; /* JFIF code for pixel size units */
617 UINT16 X_density; /* Horizontal pixel density */
618 UINT16 Y_density; /* Vertical pixel density */
619 boolean saw_Adobe_marker; /* TRUE iff an Adobe APP14 marker was found */
620 UINT8 Adobe_transform; /* Color transform code from Adobe marker */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000621
DRCb7753512014-05-11 09:36:25 +0000622 boolean CCIR601_sampling; /* TRUE=first samples are cosited */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000623
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000624 /* Aside from the specific data retained from APPn markers known to the
625 * library, the uninterpreted contents of any or all APPn and COM markers
626 * can be saved in a list for examination by the application.
627 */
628 jpeg_saved_marker_ptr marker_list; /* Head of list of saved markers */
629
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000630 /* Remaining fields are known throughout decompressor, but generally
631 * should not be touched by a surrounding application.
632 */
633
634 /*
635 * These fields are computed during decompression startup
636 */
DRCb7753512014-05-11 09:36:25 +0000637 int max_h_samp_factor; /* largest h_samp_factor */
638 int max_v_samp_factor; /* largest v_samp_factor */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000639
DRC36a6eec2010-10-08 08:05:44 +0000640#if JPEG_LIB_VERSION >= 70
DRCb7753512014-05-11 09:36:25 +0000641 int min_DCT_h_scaled_size; /* smallest DCT_h_scaled_size of any component */
642 int min_DCT_v_scaled_size; /* smallest DCT_v_scaled_size of any component */
DRC36a6eec2010-10-08 08:05:44 +0000643#else
DRCb7753512014-05-11 09:36:25 +0000644 int min_DCT_scaled_size; /* smallest DCT_scaled_size of any component */
DRC36a6eec2010-10-08 08:05:44 +0000645#endif
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000646
DRCb7753512014-05-11 09:36:25 +0000647 JDIMENSION total_iMCU_rows; /* # of iMCU rows in image */
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000648 /* The coefficient controller's input and output progress is measured in
649 * units of "iMCU" (interleaved MCU) rows. These are the same as MCU rows
650 * in fully interleaved JPEG scans, but are used whether the scan is
651 * interleaved or not. We define an iMCU row as v_samp_factor DCT block
652 * rows of each component. Therefore, the IDCT output contains
DRC36a6eec2010-10-08 08:05:44 +0000653 * v_samp_factor*DCT_[v_]scaled_size sample rows of a component per iMCU row.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000654 */
655
656 JSAMPLE * sample_range_limit; /* table for fast range-limiting */
657
658 /*
659 * These fields are valid during any one scan.
660 * They describe the components and MCUs actually appearing in the scan.
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000661 * Note that the decompressor output side must not use these fields.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000662 */
DRCb7753512014-05-11 09:36:25 +0000663 int comps_in_scan; /* # of JPEG components in this scan */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000664 jpeg_component_info * cur_comp_info[MAX_COMPS_IN_SCAN];
665 /* *cur_comp_info[i] describes component that appears i'th in SOS */
666
DRCb7753512014-05-11 09:36:25 +0000667 JDIMENSION MCUs_per_row; /* # of MCUs across the image */
668 JDIMENSION MCU_rows_in_scan; /* # of MCU rows in the image */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000669
DRCb7753512014-05-11 09:36:25 +0000670 int blocks_in_MCU; /* # of DCT blocks per MCU */
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000671 int MCU_membership[D_MAX_BLOCKS_IN_MCU];
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000672 /* MCU_membership[i] is index in cur_comp_info of component owning */
673 /* i'th block in an MCU */
674
DRCb7753512014-05-11 09:36:25 +0000675 int Ss, Se, Ah, Al; /* progressive JPEG parameters for scan */
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000676
DRC36a6eec2010-10-08 08:05:44 +0000677#if JPEG_LIB_VERSION >= 80
Guido Vollbeding989630f2010-01-10 00:00:00 +0000678 /* These fields are derived from Se of first SOS marker.
679 */
DRCb7753512014-05-11 09:36:25 +0000680 int block_size; /* the basic DCT block size: 1..16 */
Guido Vollbeding989630f2010-01-10 00:00:00 +0000681 const int * natural_order; /* natural-order position array for entropy decode */
DRCb7753512014-05-11 09:36:25 +0000682 int lim_Se; /* min( Se, DCTSIZE2-1 ) for entropy decode */
DRC36a6eec2010-10-08 08:05:44 +0000683#endif
Guido Vollbeding989630f2010-01-10 00:00:00 +0000684
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000685 /* This field is shared between entropy decoder and marker parser.
686 * It is either zero or the code of a JPEG marker that has been
687 * read from the data source, but has not yet been processed.
688 */
689 int unread_marker;
690
691 /*
692 * Links to decompression subobjects (methods, private variables of modules)
693 */
694 struct jpeg_decomp_master * master;
695 struct jpeg_d_main_controller * main;
696 struct jpeg_d_coef_controller * coef;
697 struct jpeg_d_post_controller * post;
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000698 struct jpeg_input_controller * inputctl;
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000699 struct jpeg_marker_reader * marker;
700 struct jpeg_entropy_decoder * entropy;
701 struct jpeg_inverse_dct * idct;
702 struct jpeg_upsampler * upsample;
703 struct jpeg_color_deconverter * cconvert;
704 struct jpeg_color_quantizer * cquantize;
705};
706
707
708/* "Object" declarations for JPEG modules that may be supplied or called
709 * directly by the surrounding application.
710 * As with all objects in the JPEG library, these structs only define the
711 * publicly visible methods and state variables of a module. Additional
712 * private fields may exist after the public ones.
713 */
714
715
716/* Error handler object */
717
718struct jpeg_error_mgr {
719 /* Error exit handler: does not return to caller */
DRCbc56b752014-05-16 10:43:44 +0000720 void (*error_exit) (j_common_ptr cinfo);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000721 /* Conditionally emit a trace or warning message */
DRCbc56b752014-05-16 10:43:44 +0000722 void (*emit_message) (j_common_ptr cinfo, int msg_level);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000723 /* Routine that actually outputs a trace or error message */
DRCbc56b752014-05-16 10:43:44 +0000724 void (*output_message) (j_common_ptr cinfo);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000725 /* Format a message string for the most recent JPEG error or message */
DRCbc56b752014-05-16 10:43:44 +0000726 void (*format_message) (j_common_ptr cinfo, char * buffer);
DRCb7753512014-05-11 09:36:25 +0000727#define JMSG_LENGTH_MAX 200 /* recommended size of format_message buffer */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000728 /* Reset error state variables at start of a new image */
DRCbc56b752014-05-16 10:43:44 +0000729 void (*reset_error_mgr) (j_common_ptr cinfo);
DRCb7753512014-05-11 09:36:25 +0000730
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000731 /* The message ID code and any parameters are saved here.
732 * A message can have one string parameter or up to 8 int parameters.
733 */
734 int msg_code;
735#define JMSG_STR_PARM_MAX 80
736 union {
737 int i[8];
738 char s[JMSG_STR_PARM_MAX];
739 } msg_parm;
DRCb7753512014-05-11 09:36:25 +0000740
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000741 /* Standard state variables for error facility */
DRCb7753512014-05-11 09:36:25 +0000742
743 int trace_level; /* max msg_level that will be displayed */
744
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000745 /* For recoverable corrupt-data errors, we emit a warning message,
746 * but keep going unless emit_message chooses to abort. emit_message
747 * should count warnings in num_warnings. The surrounding application
748 * can check for bad data by seeing if num_warnings is nonzero at the
749 * end of processing.
750 */
DRCb7753512014-05-11 09:36:25 +0000751 long num_warnings; /* number of corrupt-data warnings */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000752
753 /* These fields point to the table(s) of error message strings.
754 * An application can change the table pointer to switch to a different
755 * message list (typically, to change the language in which errors are
756 * reported). Some applications may wish to add additional error codes
757 * that will be handled by the JPEG library error mechanism; the second
758 * table pointer is used for this purpose.
759 *
760 * First table includes all errors generated by JPEG library itself.
761 * Error code 0 is reserved for a "no such error string" message.
762 */
763 const char * const * jpeg_message_table; /* Library errors */
764 int last_jpeg_message; /* Table contains strings 0..last_jpeg_message */
765 /* Second table can be added by application (see cjpeg/djpeg for example).
766 * It contains strings numbered first_addon_message..last_addon_message.
767 */
768 const char * const * addon_message_table; /* Non-library errors */
DRCb7753512014-05-11 09:36:25 +0000769 int first_addon_message; /* code for first string in addon table */
770 int last_addon_message; /* code for last string in addon table */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000771};
772
773
774/* Progress monitor object */
775
776struct jpeg_progress_mgr {
DRCbc56b752014-05-16 10:43:44 +0000777 void (*progress_monitor) (j_common_ptr cinfo);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000778
DRCb7753512014-05-11 09:36:25 +0000779 long pass_counter; /* work units completed in this pass */
780 long pass_limit; /* total number of work units in this pass */
781 int completed_passes; /* passes completed so far */
782 int total_passes; /* total number of passes expected */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000783};
784
785
786/* Data destination object for compression */
787
788struct jpeg_destination_mgr {
DRCb7753512014-05-11 09:36:25 +0000789 JOCTET * next_output_byte; /* => next byte to write in buffer */
790 size_t free_in_buffer; /* # of byte spaces remaining in buffer */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000791
DRCbc56b752014-05-16 10:43:44 +0000792 void (*init_destination) (j_compress_ptr cinfo);
793 boolean (*empty_output_buffer) (j_compress_ptr cinfo);
794 void (*term_destination) (j_compress_ptr cinfo);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000795};
796
797
798/* Data source object for decompression */
799
800struct jpeg_source_mgr {
801 const JOCTET * next_input_byte; /* => next byte to read from buffer */
DRCb7753512014-05-11 09:36:25 +0000802 size_t bytes_in_buffer; /* # of bytes remaining in buffer */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000803
DRCbc56b752014-05-16 10:43:44 +0000804 void (*init_source) (j_decompress_ptr cinfo);
805 boolean (*fill_input_buffer) (j_decompress_ptr cinfo);
806 void (*skip_input_data) (j_decompress_ptr cinfo, long num_bytes);
807 boolean (*resync_to_restart) (j_decompress_ptr cinfo, int desired);
808 void (*term_source) (j_decompress_ptr cinfo);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000809};
810
811
812/* Memory manager object.
813 * Allocates "small" objects (a few K total), "large" objects (tens of K),
814 * and "really big" objects (virtual arrays with backing store if needed).
815 * The memory manager does not allow individual objects to be freed; rather,
816 * each created object is assigned to a pool, and whole pools can be freed
817 * at once. This is faster and more convenient than remembering exactly what
818 * to free, especially where malloc()/free() are not too speedy.
819 * NB: alloc routines never return NULL. They exit to error_exit if not
820 * successful.
821 */
822
DRCb7753512014-05-11 09:36:25 +0000823#define JPOOL_PERMANENT 0 /* lasts until master record is destroyed */
824#define JPOOL_IMAGE 1 /* lasts until done with image/datastream */
825#define JPOOL_NUMPOOLS 2
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000826
827typedef struct jvirt_sarray_control * jvirt_sarray_ptr;
828typedef struct jvirt_barray_control * jvirt_barray_ptr;
829
830
831struct jpeg_memory_mgr {
832 /* Method pointers */
DRCbc56b752014-05-16 10:43:44 +0000833 void * (*alloc_small) (j_common_ptr cinfo, int pool_id, size_t sizeofobject);
DRC5033f3e2014-05-18 18:33:44 +0000834 void * (*alloc_large) (j_common_ptr cinfo, int pool_id,
835 size_t sizeofobject);
DRCbc56b752014-05-16 10:43:44 +0000836 JSAMPARRAY (*alloc_sarray) (j_common_ptr cinfo, int pool_id,
837 JDIMENSION samplesperrow, JDIMENSION numrows);
838 JBLOCKARRAY (*alloc_barray) (j_common_ptr cinfo, int pool_id,
839 JDIMENSION blocksperrow, JDIMENSION numrows);
840 jvirt_sarray_ptr (*request_virt_sarray) (j_common_ptr cinfo, int pool_id,
841 boolean pre_zero,
842 JDIMENSION samplesperrow,
843 JDIMENSION numrows,
844 JDIMENSION maxaccess);
845 jvirt_barray_ptr (*request_virt_barray) (j_common_ptr cinfo, int pool_id,
846 boolean pre_zero,
847 JDIMENSION blocksperrow,
848 JDIMENSION numrows,
849 JDIMENSION maxaccess);
850 void (*realize_virt_arrays) (j_common_ptr cinfo);
851 JSAMPARRAY (*access_virt_sarray) (j_common_ptr cinfo, jvirt_sarray_ptr ptr,
852 JDIMENSION start_row, JDIMENSION num_rows,
853 boolean writable);
854 JBLOCKARRAY (*access_virt_barray) (j_common_ptr cinfo, jvirt_barray_ptr ptr,
855 JDIMENSION start_row, JDIMENSION num_rows,
856 boolean writable);
857 void (*free_pool) (j_common_ptr cinfo, int pool_id);
858 void (*self_destruct) (j_common_ptr cinfo);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000859
860 /* Limit on memory allocation for this JPEG object. (Note that this is
861 * merely advisory, not a guaranteed maximum; it only affects the space
862 * used for virtual-array buffers.) May be changed by outer application
863 * after creating the JPEG object.
864 */
865 long max_memory_to_use;
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000866
867 /* Maximum allocation request accepted by alloc_large. */
868 long max_alloc_chunk;
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000869};
870
871
872/* Routine signature for application-supplied marker processing methods.
873 * Need not pass marker code since it is stored in cinfo->unread_marker.
874 */
DRCbc56b752014-05-16 10:43:44 +0000875typedef boolean (*jpeg_marker_parser_method) (j_decompress_ptr cinfo);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000876
877
DRCe2dd3e32014-11-25 09:48:15 +0000878/* Originally, this macro was used as a way of defining function prototypes
879 * for both modern compilers as well as older compilers that did not support
DRC2a6b8312014-11-25 10:07:43 +0000880 * prototype parameters. libjpeg-turbo has never supported these older,
881 * non-ANSI compilers, but the macro is still included because there is some
882 * software out there that uses it.
DRCe2dd3e32014-11-25 09:48:15 +0000883 */
884
885#define JPP(arglist) arglist
886
887
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000888/* Default error-management setup */
DRCbc56b752014-05-16 10:43:44 +0000889EXTERN(struct jpeg_error_mgr *) jpeg_std_error (struct jpeg_error_mgr * err);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000890
Thomas G. Lane489583f1996-02-07 00:00:00 +0000891/* Initialization of JPEG compression objects.
892 * jpeg_create_compress() and jpeg_create_decompress() are the exported
893 * names that applications should call. These expand to calls on
894 * jpeg_CreateCompress and jpeg_CreateDecompress with additional information
895 * passed for version mismatch checking.
896 * NB: you must set up the error-manager BEFORE calling jpeg_create_xxx.
897 */
898#define jpeg_create_compress(cinfo) \
899 jpeg_CreateCompress((cinfo), JPEG_LIB_VERSION, \
DRCb7753512014-05-11 09:36:25 +0000900 (size_t) sizeof(struct jpeg_compress_struct))
Thomas G. Lane489583f1996-02-07 00:00:00 +0000901#define jpeg_create_decompress(cinfo) \
902 jpeg_CreateDecompress((cinfo), JPEG_LIB_VERSION, \
DRCb7753512014-05-11 09:36:25 +0000903 (size_t) sizeof(struct jpeg_decompress_struct))
DRCbc56b752014-05-16 10:43:44 +0000904EXTERN(void) jpeg_CreateCompress (j_compress_ptr cinfo, int version,
905 size_t structsize);
906EXTERN(void) jpeg_CreateDecompress (j_decompress_ptr cinfo, int version,
907 size_t structsize);
Thomas G. Lane489583f1996-02-07 00:00:00 +0000908/* Destruction of JPEG compression objects */
DRCbc56b752014-05-16 10:43:44 +0000909EXTERN(void) jpeg_destroy_compress (j_compress_ptr cinfo);
910EXTERN(void) jpeg_destroy_decompress (j_decompress_ptr cinfo);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000911
912/* Standard data source and destination managers: stdio streams. */
913/* Caller is responsible for opening the file before and closing after. */
DRCbc56b752014-05-16 10:43:44 +0000914EXTERN(void) jpeg_stdio_dest (j_compress_ptr cinfo, FILE * outfile);
915EXTERN(void) jpeg_stdio_src (j_decompress_ptr cinfo, FILE * infile);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000916
DRCab706232013-01-18 23:42:31 +0000917#if JPEG_LIB_VERSION >= 80 || defined(MEM_SRCDST_SUPPORTED)
Guido Vollbeding989630f2010-01-10 00:00:00 +0000918/* Data source and destination managers: memory buffers. */
DRCbc56b752014-05-16 10:43:44 +0000919EXTERN(void) jpeg_mem_dest (j_compress_ptr cinfo, unsigned char ** outbuffer,
920 unsigned long * outsize);
921EXTERN(void) jpeg_mem_src (j_decompress_ptr cinfo, unsigned char * inbuffer,
922 unsigned long insize);
DRC36a6eec2010-10-08 08:05:44 +0000923#endif
Guido Vollbeding989630f2010-01-10 00:00:00 +0000924
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000925/* Default parameter setup for compression */
DRCbc56b752014-05-16 10:43:44 +0000926EXTERN(void) jpeg_set_defaults (j_compress_ptr cinfo);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000927/* Compression parameter setup aids */
DRCbc56b752014-05-16 10:43:44 +0000928EXTERN(void) jpeg_set_colorspace (j_compress_ptr cinfo,
929 J_COLOR_SPACE colorspace);
930EXTERN(void) jpeg_default_colorspace (j_compress_ptr cinfo);
931EXTERN(void) jpeg_set_quality (j_compress_ptr cinfo, int quality,
932 boolean force_baseline);
933EXTERN(void) jpeg_set_linear_quality (j_compress_ptr cinfo, int scale_factor,
934 boolean force_baseline);
DRC36a6eec2010-10-08 08:05:44 +0000935#if JPEG_LIB_VERSION >= 70
DRCbc56b752014-05-16 10:43:44 +0000936EXTERN(void) jpeg_default_qtables (j_compress_ptr cinfo,
937 boolean force_baseline);
DRC36a6eec2010-10-08 08:05:44 +0000938#endif
DRCbc56b752014-05-16 10:43:44 +0000939EXTERN(void) jpeg_add_quant_table (j_compress_ptr cinfo, int which_tbl,
940 const unsigned int *basic_table,
941 int scale_factor, boolean force_baseline);
942EXTERN(int) jpeg_quality_scaling (int quality);
943EXTERN(void) jpeg_simple_progression (j_compress_ptr cinfo);
944EXTERN(void) jpeg_suppress_tables (j_compress_ptr cinfo, boolean suppress);
945EXTERN(JQUANT_TBL *) jpeg_alloc_quant_table (j_common_ptr cinfo);
946EXTERN(JHUFF_TBL *) jpeg_alloc_huff_table (j_common_ptr cinfo);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000947
948/* Main entry points for compression */
DRCbc56b752014-05-16 10:43:44 +0000949EXTERN(void) jpeg_start_compress (j_compress_ptr cinfo,
950 boolean write_all_tables);
951EXTERN(JDIMENSION) jpeg_write_scanlines (j_compress_ptr cinfo,
952 JSAMPARRAY scanlines,
953 JDIMENSION num_lines);
954EXTERN(void) jpeg_finish_compress (j_compress_ptr cinfo);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000955
DRC36a6eec2010-10-08 08:05:44 +0000956#if JPEG_LIB_VERSION >= 70
Guido Vollbeding5996a252009-06-27 00:00:00 +0000957/* Precalculate JPEG dimensions for current compression parameters. */
DRCbc56b752014-05-16 10:43:44 +0000958EXTERN(void) jpeg_calc_jpeg_dimensions (j_compress_ptr cinfo);
DRC36a6eec2010-10-08 08:05:44 +0000959#endif
Guido Vollbeding5996a252009-06-27 00:00:00 +0000960
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000961/* Replaces jpeg_write_scanlines when writing raw downsampled data. */
DRCbc56b752014-05-16 10:43:44 +0000962EXTERN(JDIMENSION) jpeg_write_raw_data (j_compress_ptr cinfo, JSAMPIMAGE data,
963 JDIMENSION num_lines);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000964
Guido Vollbeding5996a252009-06-27 00:00:00 +0000965/* Write a special marker. See libjpeg.txt concerning safe usage. */
DRCbc56b752014-05-16 10:43:44 +0000966EXTERN(void) jpeg_write_marker (j_compress_ptr cinfo, int marker,
967 const JOCTET * dataptr, unsigned int datalen);
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000968/* Same, but piecemeal. */
DRCbc56b752014-05-16 10:43:44 +0000969EXTERN(void) jpeg_write_m_header (j_compress_ptr cinfo, int marker,
970 unsigned int datalen);
971EXTERN(void) jpeg_write_m_byte (j_compress_ptr cinfo, int val);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000972
973/* Alternate compression function: just write an abbreviated table file */
DRCbc56b752014-05-16 10:43:44 +0000974EXTERN(void) jpeg_write_tables (j_compress_ptr cinfo);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000975
976/* Decompression startup: read start of JPEG datastream to see what's there */
DRCbc56b752014-05-16 10:43:44 +0000977EXTERN(int) jpeg_read_header (j_decompress_ptr cinfo, boolean require_image);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000978/* Return value is one of: */
DRCb7753512014-05-11 09:36:25 +0000979#define JPEG_SUSPENDED 0 /* Suspended due to lack of input data */
980#define JPEG_HEADER_OK 1 /* Found valid image datastream */
981#define JPEG_HEADER_TABLES_ONLY 2 /* Found valid table-specs-only datastream */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000982/* If you pass require_image = TRUE (normal case), you need not check for
983 * a TABLES_ONLY return code; an abbreviated file will cause an error exit.
984 * JPEG_SUSPENDED is only possible if you use a data source module that can
985 * give a suspension return (the stdio source module doesn't).
986 */
987
988/* Main entry points for decompression */
DRCbc56b752014-05-16 10:43:44 +0000989EXTERN(boolean) jpeg_start_decompress (j_decompress_ptr cinfo);
990EXTERN(JDIMENSION) jpeg_read_scanlines (j_decompress_ptr cinfo,
991 JSAMPARRAY scanlines,
992 JDIMENSION max_lines);
993EXTERN(boolean) jpeg_finish_decompress (j_decompress_ptr cinfo);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000994
995/* Replaces jpeg_read_scanlines when reading raw downsampled data. */
DRCbc56b752014-05-16 10:43:44 +0000996EXTERN(JDIMENSION) jpeg_read_raw_data (j_decompress_ptr cinfo, JSAMPIMAGE data,
997 JDIMENSION max_lines);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000998
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000999/* Additional entry points for buffered-image mode. */
DRCbc56b752014-05-16 10:43:44 +00001000EXTERN(boolean) jpeg_has_multiple_scans (j_decompress_ptr cinfo);
1001EXTERN(boolean) jpeg_start_output (j_decompress_ptr cinfo, int scan_number);
1002EXTERN(boolean) jpeg_finish_output (j_decompress_ptr cinfo);
1003EXTERN(boolean) jpeg_input_complete (j_decompress_ptr cinfo);
1004EXTERN(void) jpeg_new_colormap (j_decompress_ptr cinfo);
1005EXTERN(int) jpeg_consume_input (j_decompress_ptr cinfo);
Thomas G. Lanebc79e061995-08-02 00:00:00 +00001006/* Return value is one of: */
DRCb7753512014-05-11 09:36:25 +00001007/* #define JPEG_SUSPENDED 0 Suspended due to lack of input data */
1008#define JPEG_REACHED_SOS 1 /* Reached start of new scan */
1009#define JPEG_REACHED_EOI 2 /* Reached end of image */
1010#define JPEG_ROW_COMPLETED 3 /* Completed one iMCU row */
1011#define JPEG_SCAN_COMPLETED 4 /* Completed last iMCU row of a scan */
Thomas G. Lanebc79e061995-08-02 00:00:00 +00001012
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +00001013/* Precalculate output dimensions for current decompression parameters. */
DRC36a6eec2010-10-08 08:05:44 +00001014#if JPEG_LIB_VERSION >= 80
DRCbc56b752014-05-16 10:43:44 +00001015EXTERN(void) jpeg_core_output_dimensions (j_decompress_ptr cinfo);
DRC36a6eec2010-10-08 08:05:44 +00001016#endif
DRCbc56b752014-05-16 10:43:44 +00001017EXTERN(void) jpeg_calc_output_dimensions (j_decompress_ptr cinfo);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +00001018
Thomas G. Lane5ead57a1998-03-27 00:00:00 +00001019/* Control saving of COM and APPn markers into marker_list. */
DRCbc56b752014-05-16 10:43:44 +00001020EXTERN(void) jpeg_save_markers (j_decompress_ptr cinfo, int marker_code,
1021 unsigned int length_limit);
Thomas G. Lane5ead57a1998-03-27 00:00:00 +00001022
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +00001023/* Install a special processing method for COM or APPn markers. */
DRCbc56b752014-05-16 10:43:44 +00001024EXTERN(void) jpeg_set_marker_processor (j_decompress_ptr cinfo,
1025 int marker_code,
1026 jpeg_marker_parser_method routine);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +00001027
Thomas G. Lanebc79e061995-08-02 00:00:00 +00001028/* Read or write raw DCT coefficients --- useful for lossless transcoding. */
DRCbc56b752014-05-16 10:43:44 +00001029EXTERN(jvirt_barray_ptr *) jpeg_read_coefficients (j_decompress_ptr cinfo);
1030EXTERN(void) jpeg_write_coefficients (j_compress_ptr cinfo,
1031 jvirt_barray_ptr * coef_arrays);
1032EXTERN(void) jpeg_copy_critical_parameters (j_decompress_ptr srcinfo,
1033 j_compress_ptr dstinfo);
Thomas G. Lanebc79e061995-08-02 00:00:00 +00001034
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +00001035/* If you choose to abort compression or decompression before completing
1036 * jpeg_finish_(de)compress, then you need to clean up to release memory,
1037 * temporary files, etc. You can just call jpeg_destroy_(de)compress
1038 * if you're done with the JPEG object, but if you want to clean it up and
1039 * reuse it, call this:
1040 */
DRCbc56b752014-05-16 10:43:44 +00001041EXTERN(void) jpeg_abort_compress (j_compress_ptr cinfo);
1042EXTERN(void) jpeg_abort_decompress (j_decompress_ptr cinfo);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +00001043
1044/* Generic versions of jpeg_abort and jpeg_destroy that work on either
1045 * flavor of JPEG object. These may be more convenient in some places.
1046 */
DRCbc56b752014-05-16 10:43:44 +00001047EXTERN(void) jpeg_abort (j_common_ptr cinfo);
1048EXTERN(void) jpeg_destroy (j_common_ptr cinfo);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +00001049
1050/* Default restart-marker-resync procedure for use by data source modules */
DRCbc56b752014-05-16 10:43:44 +00001051EXTERN(boolean) jpeg_resync_to_restart (j_decompress_ptr cinfo, int desired);
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +00001052
1053
1054/* These marker codes are exported since applications and data source modules
1055 * are likely to want to use them.
1056 */
1057
DRCb7753512014-05-11 09:36:25 +00001058#define JPEG_RST0 0xD0 /* RST0 marker code */
1059#define JPEG_EOI 0xD9 /* EOI marker code */
1060#define JPEG_APP0 0xE0 /* APP0 marker code */
1061#define JPEG_COM 0xFE /* COM marker code */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +00001062
1063
1064/* If we have a brain-damaged compiler that emits warnings (or worse, errors)
1065 * for structure definitions that are never filled in, keep it quiet by
1066 * supplying dummy definitions for the various substructures.
1067 */
1068
1069#ifdef INCOMPLETE_TYPES_BROKEN
DRCb7753512014-05-11 09:36:25 +00001070#ifndef JPEG_INTERNALS /* will be defined in jpegint.h */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +00001071struct jvirt_sarray_control { long dummy; };
1072struct jvirt_barray_control { long dummy; };
1073struct jpeg_comp_master { long dummy; };
1074struct jpeg_c_main_controller { long dummy; };
1075struct jpeg_c_prep_controller { long dummy; };
1076struct jpeg_c_coef_controller { long dummy; };
1077struct jpeg_marker_writer { long dummy; };
1078struct jpeg_color_converter { long dummy; };
1079struct jpeg_downsampler { long dummy; };
1080struct jpeg_forward_dct { long dummy; };
1081struct jpeg_entropy_encoder { long dummy; };
1082struct jpeg_decomp_master { long dummy; };
1083struct jpeg_d_main_controller { long dummy; };
1084struct jpeg_d_coef_controller { long dummy; };
1085struct jpeg_d_post_controller { long dummy; };
Thomas G. Lanebc79e061995-08-02 00:00:00 +00001086struct jpeg_input_controller { long dummy; };
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +00001087struct jpeg_marker_reader { long dummy; };
1088struct jpeg_entropy_decoder { long dummy; };
1089struct jpeg_inverse_dct { long dummy; };
1090struct jpeg_upsampler { long dummy; };
1091struct jpeg_color_deconverter { long dummy; };
1092struct jpeg_color_quantizer { long dummy; };
1093#endif /* JPEG_INTERNALS */
1094#endif /* INCOMPLETE_TYPES_BROKEN */
1095
1096
1097/*
1098 * The JPEG library modules define JPEG_INTERNALS before including this file.
1099 * The internal structure declarations are read only when that is true.
1100 * Applications using the library should not include jpegint.h, but may wish
1101 * to include jerror.h.
1102 */
1103
1104#ifdef JPEG_INTERNALS
DRCb7753512014-05-11 09:36:25 +00001105#include "jpegint.h" /* fetch private declarations */
1106#include "jerror.h" /* fetch error codes too */
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +00001107#endif
Thomas G. Lane9ba2f5e1994-12-07 00:00:00 +00001108
DRCca3cebb2010-02-23 08:12:38 +00001109#ifdef __cplusplus
Guido Vollbeding5996a252009-06-27 00:00:00 +00001110#ifndef DONT_USE_EXTERN_C
DRCca3cebb2010-02-23 08:12:38 +00001111}
1112#endif
Guido Vollbeding5996a252009-06-27 00:00:00 +00001113#endif
DRCca3cebb2010-02-23 08:12:38 +00001114
Thomas G. Lane9ba2f5e1994-12-07 00:00:00 +00001115#endif /* JPEGLIB_H */