blob: 979ef7c88b519a61480669db5d20a4898700c3eb [file] [log] [blame]
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +00001/*
2 * jpeglib.h
3 *
noel@chromium.org3395bcc2014-04-14 06:56:00 +00004 * This file was part of the Independent JPEG Group's software:
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +00005 * Copyright (C) 1991-1998, Thomas G. Lane.
hbono@chromium.org98626972011-08-03 03:13:08 +00006 * Modified 2002-2009 by Guido Vollbeding.
Tom Hudson0d47d2d2016-05-04 13:22:56 -04007 * libjpeg-turbo Modifications:
Jonathan Wrightbbb82822020-11-25 13:36:43 +00008 * Copyright (C) 2009-2011, 2013-2014, 2016-2017, 2020, D. R. Commander.
Aaron Gablec9c87552015-08-03 09:34:32 -07009 * Copyright (C) 2015, Google, Inc.
Tom Hudson0d47d2d2016-05-04 13:22:56 -040010 * For conditions of distribution and use, see the accompanying README.ijg
11 * file.
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +000012 *
13 * This file defines the application interface for the JPEG library.
14 * Most applications using the library need only include this file,
15 * and perhaps jerror.h if they want to know the exact error codes.
16 */
17
18#ifndef JPEGLIB_H
19#define JPEGLIB_H
20
Keiichi Enomoto7b4981b2021-02-23 20:21:54 +090021/* Begin chromium edits */
22#include "jpeglibmangler.h"
23/* End chromium edits */
24
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +000025/*
26 * First we include the configuration files that record how this
27 * installation of the JPEG library is set up. jconfig.h can be
28 * generated automatically for many systems. jmorecfg.h contains
29 * manual configuration options that most people need not worry about.
30 */
31
Tom Hudson0d47d2d2016-05-04 13:22:56 -040032#ifndef JCONFIG_INCLUDED /* in case jinclude.h already did */
33#include "jconfig.h" /* widely used configuration options */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +000034#endif
Tom Hudson0d47d2d2016-05-04 13:22:56 -040035#include "jmorecfg.h" /* seldom changed options */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +000036
37
hbono@chromium.org98626972011-08-03 03:13:08 +000038#ifdef __cplusplus
39#ifndef DONT_USE_EXTERN_C
40extern "C" {
41#endif
42#endif
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +000043
44
45/* Various constants determining the sizes of things.
46 * All of these are specified by the JPEG standard, so don't change them
47 * if you want to be compatible.
48 */
49
Tom Hudson0d47d2d2016-05-04 13:22:56 -040050#define DCTSIZE 8 /* The basic DCT block is 8x8 samples */
51#define DCTSIZE2 64 /* DCTSIZE squared; # of elements in a block */
52#define NUM_QUANT_TBLS 4 /* Quantization tables are numbered 0..3 */
53#define NUM_HUFF_TBLS 4 /* Huffman tables are numbered 0..3 */
54#define NUM_ARITH_TBLS 16 /* Arith-coding tables are numbered 0..15 */
55#define MAX_COMPS_IN_SCAN 4 /* JPEG limit on # of components in one scan */
56#define MAX_SAMP_FACTOR 4 /* JPEG limit on sampling factors */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +000057/* Unfortunately, some bozo at Adobe saw no reason to be bound by the standard;
58 * the PostScript DCT filter can emit files with many more than 10 blocks/MCU.
59 * If you happen to run across such a file, you can up D_MAX_BLOCKS_IN_MCU
60 * to handle it. We even let you do this from the jconfig.h file. However,
61 * we strongly discourage changing C_MAX_BLOCKS_IN_MCU; just because Adobe
62 * sometimes emits noncompliant files doesn't mean you should too.
63 */
64#define C_MAX_BLOCKS_IN_MCU 10 /* compressor's limit on blocks per MCU */
65#ifndef D_MAX_BLOCKS_IN_MCU
66#define D_MAX_BLOCKS_IN_MCU 10 /* decompressor's limit on blocks per MCU */
67#endif
68
69
70/* Data structures for images (arrays of samples and of DCT coefficients).
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +000071 */
72
Tom Hudson0d47d2d2016-05-04 13:22:56 -040073typedef JSAMPLE *JSAMPROW; /* ptr to one image row of pixel samples. */
74typedef JSAMPROW *JSAMPARRAY; /* ptr to some rows (a 2-D sample array) */
75typedef JSAMPARRAY *JSAMPIMAGE; /* a 3-D sample array: top index is color */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +000076
Tom Hudson0d47d2d2016-05-04 13:22:56 -040077typedef JCOEF JBLOCK[DCTSIZE2]; /* one block of coefficients */
78typedef JBLOCK *JBLOCKROW; /* pointer to one row of coefficient blocks */
79typedef JBLOCKROW *JBLOCKARRAY; /* a 2-D array of coefficient blocks */
80typedef JBLOCKARRAY *JBLOCKIMAGE; /* a 3-D array of coefficient blocks */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +000081
Tom Hudson0d47d2d2016-05-04 13:22:56 -040082typedef JCOEF *JCOEFPTR; /* useful in a couple of places */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +000083
84
85/* Types for JPEG compression parameters and working tables. */
86
87
88/* DCT coefficient quantization tables. */
89
90typedef struct {
91 /* This array gives the coefficient quantizers in natural array order
92 * (not the zigzag order in which they are stored in a JPEG DQT marker).
93 * CAUTION: IJG versions prior to v6a kept this array in zigzag order.
94 */
Tom Hudson0d47d2d2016-05-04 13:22:56 -040095 UINT16 quantval[DCTSIZE2]; /* quantization step for each coefficient */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +000096 /* This field is used only during compression. It's initialized FALSE when
97 * the table is created, and set TRUE when it's been output to the file.
98 * You could suppress output of a table by setting this to TRUE.
99 * (See jpeg_suppress_tables for an example.)
100 */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400101 boolean sent_table; /* TRUE when table has been output */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000102} JQUANT_TBL;
103
104
105/* Huffman coding tables. */
106
107typedef struct {
108 /* These two fields directly represent the contents of a JPEG DHT marker */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400109 UINT8 bits[17]; /* bits[k] = # of symbols with codes of */
110 /* length k bits; bits[0] is unused */
111 UINT8 huffval[256]; /* The symbols, in order of incr code length */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000112 /* This field is used only during compression. It's initialized FALSE when
113 * the table is created, and set TRUE when it's been output to the file.
114 * You could suppress output of a table by setting this to TRUE.
115 * (See jpeg_suppress_tables for an example.)
116 */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400117 boolean sent_table; /* TRUE when table has been output */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000118} JHUFF_TBL;
119
120
121/* Basic info about one component (color channel). */
122
123typedef struct {
124 /* These values are fixed over the whole image. */
125 /* For compression, they must be supplied by parameter setup; */
126 /* for decompression, they are read from the SOF marker. */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400127 int component_id; /* identifier for this component (0..255) */
128 int component_index; /* its index in SOF or cinfo->comp_info[] */
129 int h_samp_factor; /* horizontal sampling factor (1..4) */
130 int v_samp_factor; /* vertical sampling factor (1..4) */
131 int quant_tbl_no; /* quantization table selector (0..3) */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000132 /* These values may vary between scans. */
133 /* For compression, they must be supplied by parameter setup; */
134 /* for decompression, they are read from the SOS marker. */
135 /* The decompressor output side may not use these variables. */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400136 int dc_tbl_no; /* DC entropy table selector (0..3) */
137 int ac_tbl_no; /* AC entropy table selector (0..3) */
138
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000139 /* Remaining fields should be treated as private by applications. */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400140
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000141 /* These values are computed during compression or decompression startup: */
142 /* Component's size in DCT blocks.
143 * Any dummy blocks added to complete an MCU are not counted; therefore
144 * these values do not depend on whether a scan is interleaved or not.
145 */
146 JDIMENSION width_in_blocks;
147 JDIMENSION height_in_blocks;
148 /* Size of a DCT block in samples. Always DCTSIZE for compression.
149 * For decompression this is the size of the output from one DCT block,
150 * reflecting any scaling we choose to apply during the IDCT step.
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400151 * Values from 1 to 16 are supported.
152 * Note that different components may receive different IDCT scalings.
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000153 */
hbono@chromium.org98626972011-08-03 03:13:08 +0000154#if JPEG_LIB_VERSION >= 70
155 int DCT_h_scaled_size;
156 int DCT_v_scaled_size;
157#else
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000158 int DCT_scaled_size;
hbono@chromium.org98626972011-08-03 03:13:08 +0000159#endif
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000160 /* The downsampled dimensions are the component's actual, unpadded number
161 * of samples at the main buffer (preprocessing/compression interface), thus
162 * downsampled_width = ceil(image_width * Hi/Hmax)
163 * and similarly for height. For decompression, IDCT scaling is included, so
hbono@chromium.org98626972011-08-03 03:13:08 +0000164 * downsampled_width = ceil(image_width * Hi/Hmax * DCT_[h_]scaled_size/DCTSIZE)
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000165 */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400166 JDIMENSION downsampled_width; /* actual width in samples */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000167 JDIMENSION downsampled_height; /* actual height in samples */
168 /* This flag is used only for decompression. In cases where some of the
169 * components will be ignored (eg grayscale output from YCbCr image),
170 * we can skip most computations for the unused components.
171 */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400172 boolean component_needed; /* do we need the value of this component? */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000173
174 /* These values are computed before starting a scan of the component. */
175 /* The decompressor output side may not use these variables. */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400176 int MCU_width; /* number of blocks per MCU, horizontally */
177 int MCU_height; /* number of blocks per MCU, vertically */
178 int MCU_blocks; /* MCU_width * MCU_height */
179 int MCU_sample_width; /* MCU width in samples, MCU_width*DCT_[h_]scaled_size */
180 int last_col_width; /* # of non-dummy blocks across in last MCU */
181 int last_row_height; /* # of non-dummy blocks down in last MCU */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000182
183 /* Saved quantization table for component; NULL if none yet saved.
184 * See jdinput.c comments about the need for this information.
185 * This field is currently used only for decompression.
186 */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400187 JQUANT_TBL *quant_table;
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000188
189 /* Private per-component storage for DCT or IDCT subsystem. */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400190 void *dct_table;
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000191} jpeg_component_info;
192
193
194/* The script for encoding a multiple-scan file is an array of these: */
195
196typedef struct {
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400197 int comps_in_scan; /* number of components encoded in this scan */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000198 int component_index[MAX_COMPS_IN_SCAN]; /* their SOF/comp_info[] indexes */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400199 int Ss, Se; /* progressive JPEG spectral selection parms */
200 int Ah, Al; /* progressive JPEG successive approx. parms */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000201} jpeg_scan_info;
202
203/* The decompressor can save APPn and COM markers in a list of these: */
204
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400205typedef struct jpeg_marker_struct *jpeg_saved_marker_ptr;
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000206
207struct jpeg_marker_struct {
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400208 jpeg_saved_marker_ptr next; /* next in list, or NULL */
209 UINT8 marker; /* marker code: JPEG_COM, or JPEG_APP0+n */
210 unsigned int original_length; /* # bytes of data in the file */
211 unsigned int data_length; /* # bytes of data saved at data[] */
212 JOCTET *data; /* the data contained in the marker */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000213 /* the marker length word is not counted in data_length or original_length */
214};
215
216/* Known color spaces. */
217
Chris Blumecca8c4d2019-03-01 01:09:50 -0800218#define JCS_EXTENSIONS 1
219#define JCS_ALPHA_EXTENSIONS 1
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000220
221typedef enum {
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400222 JCS_UNKNOWN, /* error/unspecified */
223 JCS_GRAYSCALE, /* monochrome */
224 JCS_RGB, /* red/green/blue as specified by the RGB_RED,
225 RGB_GREEN, RGB_BLUE, and RGB_PIXELSIZE macros */
226 JCS_YCbCr, /* Y/Cb/Cr (also known as YUV) */
227 JCS_CMYK, /* C/M/Y/K */
228 JCS_YCCK, /* Y/Cb/Cr/K */
229 JCS_EXT_RGB, /* red/green/blue */
230 JCS_EXT_RGBX, /* red/green/blue/x */
231 JCS_EXT_BGR, /* blue/green/red */
232 JCS_EXT_BGRX, /* blue/green/red/x */
233 JCS_EXT_XBGR, /* x/blue/green/red */
234 JCS_EXT_XRGB, /* x/red/green/blue */
235 /* When out_color_space it set to JCS_EXT_RGBX, JCS_EXT_BGRX, JCS_EXT_XBGR,
236 or JCS_EXT_XRGB during decompression, the X byte is undefined, and in
237 order to ensure the best performance, libjpeg-turbo can set that byte to
238 whatever value it wishes. Use the following colorspace constants to
239 ensure that the X byte is set to 0xFF, so that it can be interpreted as an
240 opaque alpha channel. */
241 JCS_EXT_RGBA, /* red/green/blue/alpha */
242 JCS_EXT_BGRA, /* blue/green/red/alpha */
243 JCS_EXT_ABGR, /* alpha/blue/green/red */
244 JCS_EXT_ARGB, /* alpha/red/green/blue */
245 JCS_RGB565 /* 5-bit red/6-bit green/5-bit blue */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000246} J_COLOR_SPACE;
247
248/* DCT/IDCT algorithm options. */
249
250typedef enum {
Jonathan Wrightbbb82822020-11-25 13:36:43 +0000251 JDCT_ISLOW, /* accurate integer method */
252 JDCT_IFAST, /* less accurate integer method [legacy feature] */
253 JDCT_FLOAT /* floating-point method [legacy feature] */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000254} J_DCT_METHOD;
255
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400256#ifndef JDCT_DEFAULT /* may be overridden in jconfig.h */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000257#define JDCT_DEFAULT JDCT_ISLOW
258#endif
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400259#ifndef JDCT_FASTEST /* may be overridden in jconfig.h */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000260#define JDCT_FASTEST JDCT_IFAST
261#endif
262
263/* Dithering options for decompression. */
264
265typedef enum {
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400266 JDITHER_NONE, /* no dithering */
267 JDITHER_ORDERED, /* simple ordered dither */
268 JDITHER_FS /* Floyd-Steinberg error diffusion dither */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000269} J_DITHER_MODE;
270
271
272/* Common fields between JPEG compression and decompression master structs. */
273
274#define jpeg_common_fields \
Chris Blumecca8c4d2019-03-01 01:09:50 -0800275 struct jpeg_error_mgr *err; /* Error handler module */ \
276 struct jpeg_memory_mgr *mem; /* Memory manager module */ \
277 struct jpeg_progress_mgr *progress; /* Progress monitor, or NULL if none */ \
278 void *client_data; /* Available for use by application */ \
279 boolean is_decompressor; /* So common code can tell which is which */ \
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400280 int global_state /* For checking call sequence validity */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000281
282/* Routines that are to be used by both halves of the library are declared
283 * to receive a pointer to this structure. There are no actual instances of
284 * jpeg_common_struct, only of jpeg_compress_struct and jpeg_decompress_struct.
285 */
286struct jpeg_common_struct {
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400287 jpeg_common_fields; /* Fields common to both master struct types */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000288 /* Additional fields follow in an actual jpeg_compress_struct or
289 * jpeg_decompress_struct. All three structs must agree on these
290 * initial fields! (This would be a lot cleaner in C++.)
291 */
292};
293
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400294typedef struct jpeg_common_struct *j_common_ptr;
295typedef struct jpeg_compress_struct *j_compress_ptr;
296typedef struct jpeg_decompress_struct *j_decompress_ptr;
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000297
298
299/* Master record for a compression instance */
300
301struct jpeg_compress_struct {
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400302 jpeg_common_fields; /* Fields shared with jpeg_decompress_struct */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000303
304 /* Destination for compressed data */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400305 struct jpeg_destination_mgr *dest;
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000306
307 /* Description of source image --- these fields must be filled in by
308 * outer application before starting compression. in_color_space must
309 * be correct before you can even call jpeg_set_defaults().
310 */
311
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400312 JDIMENSION image_width; /* input image width */
313 JDIMENSION image_height; /* input image height */
314 int input_components; /* # of color components in input image */
315 J_COLOR_SPACE in_color_space; /* colorspace of input image */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000316
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400317 double input_gamma; /* image gamma of input image */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000318
319 /* Compression parameters --- these fields must be set before calling
320 * jpeg_start_compress(). We recommend calling jpeg_set_defaults() to
321 * initialize everything to reasonable defaults, then changing anything
322 * the application specifically wants to change. That way you won't get
323 * burnt when new parameters are added. Also note that there are several
324 * helper routines to simplify changing parameters.
325 */
326
hbono@chromium.org98626972011-08-03 03:13:08 +0000327#if JPEG_LIB_VERSION >= 70
328 unsigned int scale_num, scale_denom; /* fraction by which to scale image */
329
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400330 JDIMENSION jpeg_width; /* scaled JPEG image width */
331 JDIMENSION jpeg_height; /* scaled JPEG image height */
hbono@chromium.org98626972011-08-03 03:13:08 +0000332 /* Dimensions of actual JPEG image that will be written to file,
333 * derived from input dimensions by scaling factors above.
334 * These fields are computed by jpeg_start_compress().
335 * You can also use jpeg_calc_jpeg_dimensions() to determine these values
336 * in advance of calling jpeg_start_compress().
337 */
338#endif
339
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400340 int data_precision; /* bits of precision in image data */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000341
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400342 int num_components; /* # of color components in JPEG image */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000343 J_COLOR_SPACE jpeg_color_space; /* colorspace of JPEG image */
344
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400345 jpeg_component_info *comp_info;
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000346 /* comp_info[i] describes component that appears i'th in SOF */
hbono@chromium.org98626972011-08-03 03:13:08 +0000347
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400348 JQUANT_TBL *quant_tbl_ptrs[NUM_QUANT_TBLS];
hbono@chromium.org98626972011-08-03 03:13:08 +0000349#if JPEG_LIB_VERSION >= 70
350 int q_scale_factor[NUM_QUANT_TBLS];
351#endif
352 /* ptrs to coefficient quantization tables, or NULL if not defined,
353 * and corresponding scale factors (percentage, initialized 100).
354 */
355
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400356 JHUFF_TBL *dc_huff_tbl_ptrs[NUM_HUFF_TBLS];
357 JHUFF_TBL *ac_huff_tbl_ptrs[NUM_HUFF_TBLS];
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000358 /* ptrs to Huffman coding tables, or NULL if not defined */
hbono@chromium.org98626972011-08-03 03:13:08 +0000359
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000360 UINT8 arith_dc_L[NUM_ARITH_TBLS]; /* L values for DC arith-coding tables */
361 UINT8 arith_dc_U[NUM_ARITH_TBLS]; /* U values for DC arith-coding tables */
362 UINT8 arith_ac_K[NUM_ARITH_TBLS]; /* Kx values for AC arith-coding tables */
363
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400364 int num_scans; /* # of entries in scan_info array */
365 const jpeg_scan_info *scan_info; /* script for multi-scan file, or NULL */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000366 /* The default value of scan_info is NULL, which causes a single-scan
367 * sequential JPEG file to be emitted. To create a multi-scan file,
368 * set num_scans and scan_info to point to an array of scan definitions.
369 */
370
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400371 boolean raw_data_in; /* TRUE=caller supplies downsampled data */
372 boolean arith_code; /* TRUE=arithmetic coding, FALSE=Huffman */
373 boolean optimize_coding; /* TRUE=optimize entropy encoding parms */
374 boolean CCIR601_sampling; /* TRUE=first samples are cosited */
hbono@chromium.org98626972011-08-03 03:13:08 +0000375#if JPEG_LIB_VERSION >= 70
376 boolean do_fancy_downsampling; /* TRUE=apply fancy downsampling */
377#endif
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400378 int smoothing_factor; /* 1..100, or 0 for no input smoothing */
379 J_DCT_METHOD dct_method; /* DCT algorithm selector */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000380
381 /* The restart interval can be specified in absolute MCUs by setting
382 * restart_interval, or in MCU rows by setting restart_in_rows
383 * (in which case the correct restart_interval will be figured
384 * for each scan).
385 */
386 unsigned int restart_interval; /* MCUs per restart, or 0 for no restart */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400387 int restart_in_rows; /* if > 0, MCU rows per restart interval */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000388
389 /* Parameters controlling emission of special markers. */
390
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400391 boolean write_JFIF_header; /* should a JFIF marker be written? */
392 UINT8 JFIF_major_version; /* What to write for the JFIF version number */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000393 UINT8 JFIF_minor_version;
394 /* These three values are not used by the JPEG code, merely copied */
395 /* into the JFIF APP0 marker. density_unit can be 0 for unknown, */
396 /* 1 for dots/inch, or 2 for dots/cm. Note that the pixel aspect */
397 /* ratio is defined by X_density/Y_density even when density_unit=0. */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400398 UINT8 density_unit; /* JFIF code for pixel size units */
399 UINT16 X_density; /* Horizontal pixel density */
400 UINT16 Y_density; /* Vertical pixel density */
401 boolean write_Adobe_marker; /* should an Adobe marker be written? */
402
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000403 /* State variable: index of next scanline to be written to
404 * jpeg_write_scanlines(). Application may use this to control its
405 * processing loop, e.g., "while (next_scanline < image_height)".
406 */
407
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400408 JDIMENSION next_scanline; /* 0 .. image_height-1 */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000409
410 /* Remaining fields are known throughout compressor, but generally
411 * should not be touched by a surrounding application.
412 */
413
414 /*
415 * These fields are computed during compression startup
416 */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400417 boolean progressive_mode; /* TRUE if scan script uses progressive mode */
418 int max_h_samp_factor; /* largest h_samp_factor */
419 int max_v_samp_factor; /* largest v_samp_factor */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000420
hbono@chromium.org98626972011-08-03 03:13:08 +0000421#if JPEG_LIB_VERSION >= 70
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400422 int min_DCT_h_scaled_size; /* smallest DCT_h_scaled_size of any component */
423 int min_DCT_v_scaled_size; /* smallest DCT_v_scaled_size of any component */
hbono@chromium.org98626972011-08-03 03:13:08 +0000424#endif
425
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400426 JDIMENSION total_iMCU_rows; /* # of iMCU rows to be input to coef ctlr */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000427 /* The coefficient controller receives data in units of MCU rows as defined
428 * for fully interleaved scans (whether the JPEG file is interleaved or not).
429 * There are v_samp_factor * DCTSIZE sample rows of each component in an
430 * "iMCU" (interleaved MCU) row.
431 */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400432
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000433 /*
434 * These fields are valid during any one scan.
435 * They describe the components and MCUs actually appearing in the scan.
436 */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400437 int comps_in_scan; /* # of JPEG components in this scan */
438 jpeg_component_info *cur_comp_info[MAX_COMPS_IN_SCAN];
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000439 /* *cur_comp_info[i] describes component that appears i'th in SOS */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400440
441 JDIMENSION MCUs_per_row; /* # of MCUs across the image */
442 JDIMENSION MCU_rows_in_scan; /* # of MCU rows in the image */
443
444 int blocks_in_MCU; /* # of DCT blocks per MCU */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000445 int MCU_membership[C_MAX_BLOCKS_IN_MCU];
446 /* MCU_membership[i] is index in cur_comp_info of component owning */
447 /* i'th block in an MCU */
448
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400449 int Ss, Se, Ah, Al; /* progressive JPEG parameters for scan */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000450
hbono@chromium.org98626972011-08-03 03:13:08 +0000451#if JPEG_LIB_VERSION >= 80
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400452 int block_size; /* the basic DCT block size: 1..16 */
453 const int *natural_order; /* natural-order position array */
454 int lim_Se; /* min( Se, DCTSIZE2-1 ) */
hbono@chromium.org98626972011-08-03 03:13:08 +0000455#endif
456
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000457 /*
458 * Links to compression subobjects (methods and private variables of modules)
459 */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400460 struct jpeg_comp_master *master;
461 struct jpeg_c_main_controller *main;
462 struct jpeg_c_prep_controller *prep;
463 struct jpeg_c_coef_controller *coef;
464 struct jpeg_marker_writer *marker;
465 struct jpeg_color_converter *cconvert;
466 struct jpeg_downsampler *downsample;
467 struct jpeg_forward_dct *fdct;
468 struct jpeg_entropy_encoder *entropy;
469 jpeg_scan_info *script_space; /* workspace for jpeg_simple_progression */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000470 int script_space_size;
471};
472
473
474/* Master record for a decompression instance */
475
476struct jpeg_decompress_struct {
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400477 jpeg_common_fields; /* Fields shared with jpeg_compress_struct */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000478
479 /* Source of compressed data */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400480 struct jpeg_source_mgr *src;
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000481
482 /* Basic description of image --- filled in by jpeg_read_header(). */
483 /* Application may inspect these values to decide how to process image. */
484
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400485 JDIMENSION image_width; /* nominal image width (from SOF marker) */
486 JDIMENSION image_height; /* nominal image height */
487 int num_components; /* # of color components in JPEG image */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000488 J_COLOR_SPACE jpeg_color_space; /* colorspace of JPEG image */
489
490 /* Decompression processing parameters --- these fields must be set before
491 * calling jpeg_start_decompress(). Note that jpeg_read_header() initializes
492 * them to default values.
493 */
494
495 J_COLOR_SPACE out_color_space; /* colorspace for output */
496
497 unsigned int scale_num, scale_denom; /* fraction by which to scale image */
498
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400499 double output_gamma; /* image gamma wanted in output */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000500
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400501 boolean buffered_image; /* TRUE=multiple output passes */
502 boolean raw_data_out; /* TRUE=downsampled data wanted */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000503
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400504 J_DCT_METHOD dct_method; /* IDCT algorithm selector */
505 boolean do_fancy_upsampling; /* TRUE=apply fancy upsampling */
506 boolean do_block_smoothing; /* TRUE=apply interblock smoothing */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000507
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400508 boolean quantize_colors; /* TRUE=colormapped output wanted */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000509 /* the following are ignored if not quantize_colors: */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400510 J_DITHER_MODE dither_mode; /* type of color dithering to use */
511 boolean two_pass_quantize; /* TRUE=use two-pass color quantization */
512 int desired_number_of_colors; /* max # colors to use in created colormap */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000513 /* these are significant only in buffered-image mode: */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400514 boolean enable_1pass_quant; /* enable future use of 1-pass quantizer */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000515 boolean enable_external_quant;/* enable future use of external colormap */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400516 boolean enable_2pass_quant; /* enable future use of 2-pass quantizer */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000517
518 /* Description of actual output image that will be returned to application.
519 * These fields are computed by jpeg_start_decompress().
520 * You can also use jpeg_calc_output_dimensions() to determine these values
521 * in advance of calling jpeg_start_decompress().
522 */
523
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400524 JDIMENSION output_width; /* scaled image width */
525 JDIMENSION output_height; /* scaled image height */
526 int out_color_components; /* # of color components in out_color_space */
527 int output_components; /* # of color components returned */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000528 /* output_components is 1 (a colormap index) when quantizing colors;
529 * otherwise it equals out_color_components.
530 */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400531 int rec_outbuf_height; /* min recommended height of scanline buffer */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000532 /* If the buffer passed to jpeg_read_scanlines() is less than this many rows
533 * high, space and time will be wasted due to unnecessary data copying.
534 * Usually rec_outbuf_height will be 1 or 2, at most 4.
535 */
536
537 /* When quantizing colors, the output colormap is described by these fields.
538 * The application can supply a colormap by setting colormap non-NULL before
539 * calling jpeg_start_decompress; otherwise a colormap is created during
540 * jpeg_start_decompress or jpeg_start_output.
541 * The map has out_color_components rows and actual_number_of_colors columns.
542 */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400543 int actual_number_of_colors; /* number of entries in use */
544 JSAMPARRAY colormap; /* The color map as a 2-D pixel array */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000545
546 /* State variables: these variables indicate the progress of decompression.
547 * The application may examine these but must not modify them.
548 */
549
550 /* Row index of next scanline to be read from jpeg_read_scanlines().
551 * Application may use this to control its processing loop, e.g.,
552 * "while (output_scanline < output_height)".
553 */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400554 JDIMENSION output_scanline; /* 0 .. output_height-1 */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000555
556 /* Current input scan number and number of iMCU rows completed in scan.
557 * These indicate the progress of the decompressor input side.
558 */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400559 int input_scan_number; /* Number of SOS markers seen so far */
560 JDIMENSION input_iMCU_row; /* Number of iMCU rows completed */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000561
562 /* The "output scan number" is the notional scan being displayed by the
563 * output side. The decompressor will not allow output scan/row number
564 * to get ahead of input scan/row, but it can fall arbitrarily far behind.
565 */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400566 int output_scan_number; /* Nominal scan number being displayed */
567 JDIMENSION output_iMCU_row; /* Number of iMCU rows read */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000568
569 /* Current progression status. coef_bits[c][i] indicates the precision
570 * with which component c's DCT coefficient i (in zigzag order) is known.
571 * It is -1 when no data has yet been received, otherwise it is the point
572 * transform (shift) value for the most recent scan of the coefficient
573 * (thus, 0 at completion of the progression).
574 * This pointer is NULL when reading a non-progressive file.
575 */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400576 int (*coef_bits)[DCTSIZE2]; /* -1 or current Al value for each coef */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000577
578 /* Internal JPEG parameters --- the application usually need not look at
579 * these fields. Note that the decompressor output side may not use
580 * any parameters that can change between scans.
581 */
582
583 /* Quantization and Huffman tables are carried forward across input
584 * datastreams when processing abbreviated JPEG datastreams.
585 */
586
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400587 JQUANT_TBL *quant_tbl_ptrs[NUM_QUANT_TBLS];
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000588 /* ptrs to coefficient quantization tables, or NULL if not defined */
589
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400590 JHUFF_TBL *dc_huff_tbl_ptrs[NUM_HUFF_TBLS];
591 JHUFF_TBL *ac_huff_tbl_ptrs[NUM_HUFF_TBLS];
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000592 /* ptrs to Huffman coding tables, or NULL if not defined */
593
594 /* These parameters are never carried across datastreams, since they
595 * are given in SOF/SOS markers or defined to be reset by SOI.
596 */
597
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400598 int data_precision; /* bits of precision in image data */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000599
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400600 jpeg_component_info *comp_info;
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000601 /* comp_info[i] describes component that appears i'th in SOF */
602
hbono@chromium.org98626972011-08-03 03:13:08 +0000603#if JPEG_LIB_VERSION >= 80
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400604 boolean is_baseline; /* TRUE if Baseline SOF0 encountered */
hbono@chromium.org98626972011-08-03 03:13:08 +0000605#endif
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400606 boolean progressive_mode; /* TRUE if SOFn specifies progressive mode */
607 boolean arith_code; /* TRUE=arithmetic coding, FALSE=Huffman */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000608
609 UINT8 arith_dc_L[NUM_ARITH_TBLS]; /* L values for DC arith-coding tables */
610 UINT8 arith_dc_U[NUM_ARITH_TBLS]; /* U values for DC arith-coding tables */
611 UINT8 arith_ac_K[NUM_ARITH_TBLS]; /* Kx values for AC arith-coding tables */
612
613 unsigned int restart_interval; /* MCUs per restart interval, or 0 for no restart */
614
615 /* These fields record data obtained from optional markers recognized by
616 * the JPEG library.
617 */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400618 boolean saw_JFIF_marker; /* TRUE iff a JFIF APP0 marker was found */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000619 /* Data copied from JFIF marker; only valid if saw_JFIF_marker is TRUE: */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400620 UINT8 JFIF_major_version; /* JFIF version number */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000621 UINT8 JFIF_minor_version;
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400622 UINT8 density_unit; /* JFIF code for pixel size units */
623 UINT16 X_density; /* Horizontal pixel density */
624 UINT16 Y_density; /* Vertical pixel density */
625 boolean saw_Adobe_marker; /* TRUE iff an Adobe APP14 marker was found */
626 UINT8 Adobe_transform; /* Color transform code from Adobe marker */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000627
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400628 boolean CCIR601_sampling; /* TRUE=first samples are cosited */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000629
630 /* Aside from the specific data retained from APPn markers known to the
631 * library, the uninterpreted contents of any or all APPn and COM markers
632 * can be saved in a list for examination by the application.
633 */
634 jpeg_saved_marker_ptr marker_list; /* Head of list of saved markers */
635
636 /* Remaining fields are known throughout decompressor, but generally
637 * should not be touched by a surrounding application.
638 */
639
640 /*
641 * These fields are computed during decompression startup
642 */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400643 int max_h_samp_factor; /* largest h_samp_factor */
644 int max_v_samp_factor; /* largest v_samp_factor */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000645
hbono@chromium.org98626972011-08-03 03:13:08 +0000646#if JPEG_LIB_VERSION >= 70
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400647 int min_DCT_h_scaled_size; /* smallest DCT_h_scaled_size of any component */
648 int min_DCT_v_scaled_size; /* smallest DCT_v_scaled_size of any component */
hbono@chromium.org98626972011-08-03 03:13:08 +0000649#else
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400650 int min_DCT_scaled_size; /* smallest DCT_scaled_size of any component */
hbono@chromium.org98626972011-08-03 03:13:08 +0000651#endif
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000652
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400653 JDIMENSION total_iMCU_rows; /* # of iMCU rows in image */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000654 /* The coefficient controller's input and output progress is measured in
655 * units of "iMCU" (interleaved MCU) rows. These are the same as MCU rows
656 * in fully interleaved JPEG scans, but are used whether the scan is
657 * interleaved or not. We define an iMCU row as v_samp_factor DCT block
658 * rows of each component. Therefore, the IDCT output contains
hbono@chromium.org98626972011-08-03 03:13:08 +0000659 * v_samp_factor*DCT_[v_]scaled_size sample rows of a component per iMCU row.
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000660 */
661
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400662 JSAMPLE *sample_range_limit; /* table for fast range-limiting */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000663
664 /*
665 * These fields are valid during any one scan.
666 * They describe the components and MCUs actually appearing in the scan.
667 * Note that the decompressor output side must not use these fields.
668 */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400669 int comps_in_scan; /* # of JPEG components in this scan */
670 jpeg_component_info *cur_comp_info[MAX_COMPS_IN_SCAN];
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000671 /* *cur_comp_info[i] describes component that appears i'th in SOS */
672
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400673 JDIMENSION MCUs_per_row; /* # of MCUs across the image */
674 JDIMENSION MCU_rows_in_scan; /* # of MCU rows in the image */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000675
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400676 int blocks_in_MCU; /* # of DCT blocks per MCU */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000677 int MCU_membership[D_MAX_BLOCKS_IN_MCU];
678 /* MCU_membership[i] is index in cur_comp_info of component owning */
679 /* i'th block in an MCU */
680
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400681 int Ss, Se, Ah, Al; /* progressive JPEG parameters for scan */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000682
hbono@chromium.org98626972011-08-03 03:13:08 +0000683#if JPEG_LIB_VERSION >= 80
684 /* These fields are derived from Se of first SOS marker.
685 */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400686 int block_size; /* the basic DCT block size: 1..16 */
687 const int *natural_order; /* natural-order position array for entropy decode */
688 int lim_Se; /* min( Se, DCTSIZE2-1 ) for entropy decode */
hbono@chromium.org98626972011-08-03 03:13:08 +0000689#endif
690
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000691 /* This field is shared between entropy decoder and marker parser.
692 * It is either zero or the code of a JPEG marker that has been
693 * read from the data source, but has not yet been processed.
694 */
695 int unread_marker;
696
697 /*
698 * Links to decompression subobjects (methods, private variables of modules)
699 */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400700 struct jpeg_decomp_master *master;
701 struct jpeg_d_main_controller *main;
702 struct jpeg_d_coef_controller *coef;
703 struct jpeg_d_post_controller *post;
704 struct jpeg_input_controller *inputctl;
705 struct jpeg_marker_reader *marker;
706 struct jpeg_entropy_decoder *entropy;
707 struct jpeg_inverse_dct *idct;
708 struct jpeg_upsampler *upsample;
709 struct jpeg_color_deconverter *cconvert;
710 struct jpeg_color_quantizer *cquantize;
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000711};
712
713
714/* "Object" declarations for JPEG modules that may be supplied or called
715 * directly by the surrounding application.
716 * As with all objects in the JPEG library, these structs only define the
717 * publicly visible methods and state variables of a module. Additional
718 * private fields may exist after the public ones.
719 */
720
721
722/* Error handler object */
723
724struct jpeg_error_mgr {
725 /* Error exit handler: does not return to caller */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400726 void (*error_exit) (j_common_ptr cinfo);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000727 /* Conditionally emit a trace or warning message */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400728 void (*emit_message) (j_common_ptr cinfo, int msg_level);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000729 /* Routine that actually outputs a trace or error message */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400730 void (*output_message) (j_common_ptr cinfo);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000731 /* Format a message string for the most recent JPEG error or message */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400732 void (*format_message) (j_common_ptr cinfo, char *buffer);
733#define JMSG_LENGTH_MAX 200 /* recommended size of format_message buffer */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000734 /* Reset error state variables at start of a new image */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400735 void (*reset_error_mgr) (j_common_ptr cinfo);
736
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000737 /* The message ID code and any parameters are saved here.
738 * A message can have one string parameter or up to 8 int parameters.
739 */
740 int msg_code;
741#define JMSG_STR_PARM_MAX 80
742 union {
743 int i[8];
744 char s[JMSG_STR_PARM_MAX];
745 } msg_parm;
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400746
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000747 /* Standard state variables for error facility */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400748
749 int trace_level; /* max msg_level that will be displayed */
750
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000751 /* For recoverable corrupt-data errors, we emit a warning message,
752 * but keep going unless emit_message chooses to abort. emit_message
753 * should count warnings in num_warnings. The surrounding application
754 * can check for bad data by seeing if num_warnings is nonzero at the
755 * end of processing.
756 */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400757 long num_warnings; /* number of corrupt-data warnings */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000758
759 /* These fields point to the table(s) of error message strings.
760 * An application can change the table pointer to switch to a different
761 * message list (typically, to change the language in which errors are
762 * reported). Some applications may wish to add additional error codes
763 * that will be handled by the JPEG library error mechanism; the second
764 * table pointer is used for this purpose.
765 *
766 * First table includes all errors generated by JPEG library itself.
767 * Error code 0 is reserved for a "no such error string" message.
768 */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400769 const char * const *jpeg_message_table; /* Library errors */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000770 int last_jpeg_message; /* Table contains strings 0..last_jpeg_message */
771 /* Second table can be added by application (see cjpeg/djpeg for example).
772 * It contains strings numbered first_addon_message..last_addon_message.
773 */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400774 const char * const *addon_message_table; /* Non-library errors */
775 int first_addon_message; /* code for first string in addon table */
776 int last_addon_message; /* code for last string in addon table */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000777};
778
779
780/* Progress monitor object */
781
782struct jpeg_progress_mgr {
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400783 void (*progress_monitor) (j_common_ptr cinfo);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000784
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400785 long pass_counter; /* work units completed in this pass */
786 long pass_limit; /* total number of work units in this pass */
787 int completed_passes; /* passes completed so far */
788 int total_passes; /* total number of passes expected */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000789};
790
791
792/* Data destination object for compression */
793
794struct jpeg_destination_mgr {
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400795 JOCTET *next_output_byte; /* => next byte to write in buffer */
796 size_t free_in_buffer; /* # of byte spaces remaining in buffer */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000797
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400798 void (*init_destination) (j_compress_ptr cinfo);
799 boolean (*empty_output_buffer) (j_compress_ptr cinfo);
800 void (*term_destination) (j_compress_ptr cinfo);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000801};
802
803
804/* Data source object for decompression */
805
806struct jpeg_source_mgr {
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400807 const JOCTET *next_input_byte; /* => next byte to read from buffer */
808 size_t bytes_in_buffer; /* # of bytes remaining in buffer */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000809
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400810 void (*init_source) (j_decompress_ptr cinfo);
811 boolean (*fill_input_buffer) (j_decompress_ptr cinfo);
812 void (*skip_input_data) (j_decompress_ptr cinfo, long num_bytes);
813 boolean (*resync_to_restart) (j_decompress_ptr cinfo, int desired);
814 void (*term_source) (j_decompress_ptr cinfo);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000815};
816
817
818/* Memory manager object.
819 * Allocates "small" objects (a few K total), "large" objects (tens of K),
820 * and "really big" objects (virtual arrays with backing store if needed).
821 * The memory manager does not allow individual objects to be freed; rather,
822 * each created object is assigned to a pool, and whole pools can be freed
823 * at once. This is faster and more convenient than remembering exactly what
824 * to free, especially where malloc()/free() are not too speedy.
825 * NB: alloc routines never return NULL. They exit to error_exit if not
826 * successful.
827 */
828
Chris Blumecca8c4d2019-03-01 01:09:50 -0800829#define JPOOL_PERMANENT 0 /* lasts until master record is destroyed */
830#define JPOOL_IMAGE 1 /* lasts until done with image/datastream */
831#define JPOOL_NUMPOOLS 2
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000832
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400833typedef struct jvirt_sarray_control *jvirt_sarray_ptr;
834typedef struct jvirt_barray_control *jvirt_barray_ptr;
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000835
836
837struct jpeg_memory_mgr {
838 /* Method pointers */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400839 void *(*alloc_small) (j_common_ptr cinfo, int pool_id, size_t sizeofobject);
840 void *(*alloc_large) (j_common_ptr cinfo, int pool_id,
841 size_t sizeofobject);
842 JSAMPARRAY (*alloc_sarray) (j_common_ptr cinfo, int pool_id,
843 JDIMENSION samplesperrow, JDIMENSION numrows);
844 JBLOCKARRAY (*alloc_barray) (j_common_ptr cinfo, int pool_id,
845 JDIMENSION blocksperrow, JDIMENSION numrows);
846 jvirt_sarray_ptr (*request_virt_sarray) (j_common_ptr cinfo, int pool_id,
847 boolean pre_zero,
848 JDIMENSION samplesperrow,
849 JDIMENSION numrows,
850 JDIMENSION maxaccess);
851 jvirt_barray_ptr (*request_virt_barray) (j_common_ptr cinfo, int pool_id,
852 boolean pre_zero,
853 JDIMENSION blocksperrow,
854 JDIMENSION numrows,
855 JDIMENSION maxaccess);
856 void (*realize_virt_arrays) (j_common_ptr cinfo);
857 JSAMPARRAY (*access_virt_sarray) (j_common_ptr cinfo, jvirt_sarray_ptr ptr,
858 JDIMENSION start_row, JDIMENSION num_rows,
859 boolean writable);
860 JBLOCKARRAY (*access_virt_barray) (j_common_ptr cinfo, jvirt_barray_ptr ptr,
861 JDIMENSION start_row, JDIMENSION num_rows,
862 boolean writable);
863 void (*free_pool) (j_common_ptr cinfo, int pool_id);
864 void (*self_destruct) (j_common_ptr cinfo);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000865
866 /* Limit on memory allocation for this JPEG object. (Note that this is
867 * merely advisory, not a guaranteed maximum; it only affects the space
868 * used for virtual-array buffers.) May be changed by outer application
869 * after creating the JPEG object.
870 */
871 long max_memory_to_use;
872
873 /* Maximum allocation request accepted by alloc_large. */
874 long max_alloc_chunk;
875};
876
877
878/* Routine signature for application-supplied marker processing methods.
879 * Need not pass marker code since it is stored in cinfo->unread_marker.
880 */
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400881typedef boolean (*jpeg_marker_parser_method) (j_decompress_ptr cinfo);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000882
883
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400884/* Originally, this macro was used as a way of defining function prototypes
885 * for both modern compilers as well as older compilers that did not support
886 * prototype parameters. libjpeg-turbo has never supported these older,
887 * non-ANSI compilers, but the macro is still included because there is some
888 * software out there that uses it.
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000889 */
890
Tom Hudson0d47d2d2016-05-04 13:22:56 -0400891#define JPP(arglist) arglist
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000892
893
894/* Default error-management setup */
Chris Blumecca8c4d2019-03-01 01:09:50 -0800895EXTERN(struct jpeg_error_mgr *) jpeg_std_error(struct jpeg_error_mgr *err);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000896
897/* Initialization of JPEG compression objects.
898 * jpeg_create_compress() and jpeg_create_decompress() are the exported
899 * names that applications should call. These expand to calls on
900 * jpeg_CreateCompress and jpeg_CreateDecompress with additional information
901 * passed for version mismatch checking.
902 * NB: you must set up the error-manager BEFORE calling jpeg_create_xxx.
903 */
904#define jpeg_create_compress(cinfo) \
Chris Blumecca8c4d2019-03-01 01:09:50 -0800905 jpeg_CreateCompress((cinfo), JPEG_LIB_VERSION, \
906 (size_t)sizeof(struct jpeg_compress_struct))
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000907#define jpeg_create_decompress(cinfo) \
Chris Blumecca8c4d2019-03-01 01:09:50 -0800908 jpeg_CreateDecompress((cinfo), JPEG_LIB_VERSION, \
909 (size_t)sizeof(struct jpeg_decompress_struct))
910EXTERN(void) jpeg_CreateCompress(j_compress_ptr cinfo, int version,
911 size_t structsize);
912EXTERN(void) jpeg_CreateDecompress(j_decompress_ptr cinfo, int version,
913 size_t structsize);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000914/* Destruction of JPEG compression objects */
Chris Blumecca8c4d2019-03-01 01:09:50 -0800915EXTERN(void) jpeg_destroy_compress(j_compress_ptr cinfo);
916EXTERN(void) jpeg_destroy_decompress(j_decompress_ptr cinfo);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000917
918/* Standard data source and destination managers: stdio streams. */
919/* Caller is responsible for opening the file before and closing after. */
Chris Blumecca8c4d2019-03-01 01:09:50 -0800920EXTERN(void) jpeg_stdio_dest(j_compress_ptr cinfo, FILE *outfile);
921EXTERN(void) jpeg_stdio_src(j_decompress_ptr cinfo, FILE *infile);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000922
noel@chromium.org3395bcc2014-04-14 06:56:00 +0000923#if JPEG_LIB_VERSION >= 80 || defined(MEM_SRCDST_SUPPORTED)
hbono@chromium.org98626972011-08-03 03:13:08 +0000924/* Data source and destination managers: memory buffers. */
Chris Blumecca8c4d2019-03-01 01:09:50 -0800925EXTERN(void) jpeg_mem_dest(j_compress_ptr cinfo, unsigned char **outbuffer,
926 unsigned long *outsize);
927EXTERN(void) jpeg_mem_src(j_decompress_ptr cinfo,
928 const unsigned char *inbuffer, unsigned long insize);
hbono@chromium.org98626972011-08-03 03:13:08 +0000929#endif
930
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000931/* Default parameter setup for compression */
Chris Blumecca8c4d2019-03-01 01:09:50 -0800932EXTERN(void) jpeg_set_defaults(j_compress_ptr cinfo);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000933/* Compression parameter setup aids */
Chris Blumecca8c4d2019-03-01 01:09:50 -0800934EXTERN(void) jpeg_set_colorspace(j_compress_ptr cinfo,
935 J_COLOR_SPACE colorspace);
936EXTERN(void) jpeg_default_colorspace(j_compress_ptr cinfo);
937EXTERN(void) jpeg_set_quality(j_compress_ptr cinfo, int quality,
938 boolean force_baseline);
939EXTERN(void) jpeg_set_linear_quality(j_compress_ptr cinfo, int scale_factor,
940 boolean force_baseline);
hbono@chromium.org98626972011-08-03 03:13:08 +0000941#if JPEG_LIB_VERSION >= 70
Chris Blumecca8c4d2019-03-01 01:09:50 -0800942EXTERN(void) jpeg_default_qtables(j_compress_ptr cinfo,
943 boolean force_baseline);
hbono@chromium.org98626972011-08-03 03:13:08 +0000944#endif
Chris Blumecca8c4d2019-03-01 01:09:50 -0800945EXTERN(void) jpeg_add_quant_table(j_compress_ptr cinfo, int which_tbl,
946 const unsigned int *basic_table,
947 int scale_factor, boolean force_baseline);
948EXTERN(int) jpeg_quality_scaling(int quality);
949EXTERN(void) jpeg_simple_progression(j_compress_ptr cinfo);
950EXTERN(void) jpeg_suppress_tables(j_compress_ptr cinfo, boolean suppress);
951EXTERN(JQUANT_TBL *) jpeg_alloc_quant_table(j_common_ptr cinfo);
952EXTERN(JHUFF_TBL *) jpeg_alloc_huff_table(j_common_ptr cinfo);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000953
954/* Main entry points for compression */
Chris Blumecca8c4d2019-03-01 01:09:50 -0800955EXTERN(void) jpeg_start_compress(j_compress_ptr cinfo,
956 boolean write_all_tables);
957EXTERN(JDIMENSION) jpeg_write_scanlines(j_compress_ptr cinfo,
958 JSAMPARRAY scanlines,
959 JDIMENSION num_lines);
960EXTERN(void) jpeg_finish_compress(j_compress_ptr cinfo);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000961
hbono@chromium.org98626972011-08-03 03:13:08 +0000962#if JPEG_LIB_VERSION >= 70
963/* Precalculate JPEG dimensions for current compression parameters. */
Chris Blumecca8c4d2019-03-01 01:09:50 -0800964EXTERN(void) jpeg_calc_jpeg_dimensions(j_compress_ptr cinfo);
hbono@chromium.org98626972011-08-03 03:13:08 +0000965#endif
966
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000967/* Replaces jpeg_write_scanlines when writing raw downsampled data. */
Chris Blumecca8c4d2019-03-01 01:09:50 -0800968EXTERN(JDIMENSION) jpeg_write_raw_data(j_compress_ptr cinfo, JSAMPIMAGE data,
969 JDIMENSION num_lines);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000970
hbono@chromium.org98626972011-08-03 03:13:08 +0000971/* Write a special marker. See libjpeg.txt concerning safe usage. */
Chris Blumecca8c4d2019-03-01 01:09:50 -0800972EXTERN(void) jpeg_write_marker(j_compress_ptr cinfo, int marker,
973 const JOCTET *dataptr, unsigned int datalen);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000974/* Same, but piecemeal. */
Chris Blumecca8c4d2019-03-01 01:09:50 -0800975EXTERN(void) jpeg_write_m_header(j_compress_ptr cinfo, int marker,
976 unsigned int datalen);
977EXTERN(void) jpeg_write_m_byte(j_compress_ptr cinfo, int val);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000978
979/* Alternate compression function: just write an abbreviated table file */
Chris Blumecca8c4d2019-03-01 01:09:50 -0800980EXTERN(void) jpeg_write_tables(j_compress_ptr cinfo);
981
982/* Write ICC profile. See libjpeg.txt for usage information. */
983EXTERN(void) jpeg_write_icc_profile(j_compress_ptr cinfo,
984 const JOCTET *icc_data_ptr,
985 unsigned int icc_data_len);
986
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000987
988/* Decompression startup: read start of JPEG datastream to see what's there */
Chris Blumecca8c4d2019-03-01 01:09:50 -0800989EXTERN(int) jpeg_read_header(j_decompress_ptr cinfo, boolean require_image);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000990/* Return value is one of: */
Chris Blumecca8c4d2019-03-01 01:09:50 -0800991#define JPEG_SUSPENDED 0 /* Suspended due to lack of input data */
992#define JPEG_HEADER_OK 1 /* Found valid image datastream */
993#define JPEG_HEADER_TABLES_ONLY 2 /* Found valid table-specs-only datastream */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +0000994/* If you pass require_image = TRUE (normal case), you need not check for
995 * a TABLES_ONLY return code; an abbreviated file will cause an error exit.
996 * JPEG_SUSPENDED is only possible if you use a data source module that can
997 * give a suspension return (the stdio source module doesn't).
998 */
999
1000/* Main entry points for decompression */
Chris Blumecca8c4d2019-03-01 01:09:50 -08001001EXTERN(boolean) jpeg_start_decompress(j_decompress_ptr cinfo);
1002EXTERN(JDIMENSION) jpeg_read_scanlines(j_decompress_ptr cinfo,
1003 JSAMPARRAY scanlines,
1004 JDIMENSION max_lines);
1005EXTERN(JDIMENSION) jpeg_skip_scanlines(j_decompress_ptr cinfo,
1006 JDIMENSION num_lines);
1007EXTERN(void) jpeg_crop_scanline(j_decompress_ptr cinfo, JDIMENSION *xoffset,
1008 JDIMENSION *width);
1009EXTERN(boolean) jpeg_finish_decompress(j_decompress_ptr cinfo);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +00001010
1011/* Replaces jpeg_read_scanlines when reading raw downsampled data. */
Chris Blumecca8c4d2019-03-01 01:09:50 -08001012EXTERN(JDIMENSION) jpeg_read_raw_data(j_decompress_ptr cinfo, JSAMPIMAGE data,
1013 JDIMENSION max_lines);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +00001014
1015/* Additional entry points for buffered-image mode. */
Chris Blumecca8c4d2019-03-01 01:09:50 -08001016EXTERN(boolean) jpeg_has_multiple_scans(j_decompress_ptr cinfo);
1017EXTERN(boolean) jpeg_start_output(j_decompress_ptr cinfo, int scan_number);
1018EXTERN(boolean) jpeg_finish_output(j_decompress_ptr cinfo);
1019EXTERN(boolean) jpeg_input_complete(j_decompress_ptr cinfo);
1020EXTERN(void) jpeg_new_colormap(j_decompress_ptr cinfo);
1021EXTERN(int) jpeg_consume_input(j_decompress_ptr cinfo);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +00001022/* Return value is one of: */
Tom Hudson0d47d2d2016-05-04 13:22:56 -04001023/* #define JPEG_SUSPENDED 0 Suspended due to lack of input data */
1024#define JPEG_REACHED_SOS 1 /* Reached start of new scan */
1025#define JPEG_REACHED_EOI 2 /* Reached end of image */
1026#define JPEG_ROW_COMPLETED 3 /* Completed one iMCU row */
1027#define JPEG_SCAN_COMPLETED 4 /* Completed last iMCU row of a scan */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +00001028
1029/* Precalculate output dimensions for current decompression parameters. */
hbono@chromium.org98626972011-08-03 03:13:08 +00001030#if JPEG_LIB_VERSION >= 80
Chris Blumecca8c4d2019-03-01 01:09:50 -08001031EXTERN(void) jpeg_core_output_dimensions(j_decompress_ptr cinfo);
hbono@chromium.org98626972011-08-03 03:13:08 +00001032#endif
Chris Blumecca8c4d2019-03-01 01:09:50 -08001033EXTERN(void) jpeg_calc_output_dimensions(j_decompress_ptr cinfo);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +00001034
1035/* Control saving of COM and APPn markers into marker_list. */
Chris Blumecca8c4d2019-03-01 01:09:50 -08001036EXTERN(void) jpeg_save_markers(j_decompress_ptr cinfo, int marker_code,
1037 unsigned int length_limit);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +00001038
1039/* Install a special processing method for COM or APPn markers. */
Chris Blumecca8c4d2019-03-01 01:09:50 -08001040EXTERN(void) jpeg_set_marker_processor(j_decompress_ptr cinfo,
1041 int marker_code,
1042 jpeg_marker_parser_method routine);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +00001043
1044/* Read or write raw DCT coefficients --- useful for lossless transcoding. */
Chris Blumecca8c4d2019-03-01 01:09:50 -08001045EXTERN(jvirt_barray_ptr *) jpeg_read_coefficients(j_decompress_ptr cinfo);
1046EXTERN(void) jpeg_write_coefficients(j_compress_ptr cinfo,
1047 jvirt_barray_ptr *coef_arrays);
1048EXTERN(void) jpeg_copy_critical_parameters(j_decompress_ptr srcinfo,
1049 j_compress_ptr dstinfo);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +00001050
1051/* If you choose to abort compression or decompression before completing
1052 * jpeg_finish_(de)compress, then you need to clean up to release memory,
1053 * temporary files, etc. You can just call jpeg_destroy_(de)compress
1054 * if you're done with the JPEG object, but if you want to clean it up and
1055 * reuse it, call this:
1056 */
Chris Blumecca8c4d2019-03-01 01:09:50 -08001057EXTERN(void) jpeg_abort_compress(j_compress_ptr cinfo);
1058EXTERN(void) jpeg_abort_decompress(j_decompress_ptr cinfo);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +00001059
1060/* Generic versions of jpeg_abort and jpeg_destroy that work on either
1061 * flavor of JPEG object. These may be more convenient in some places.
1062 */
Chris Blumecca8c4d2019-03-01 01:09:50 -08001063EXTERN(void) jpeg_abort(j_common_ptr cinfo);
1064EXTERN(void) jpeg_destroy(j_common_ptr cinfo);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +00001065
1066/* Default restart-marker-resync procedure for use by data source modules */
Chris Blumecca8c4d2019-03-01 01:09:50 -08001067EXTERN(boolean) jpeg_resync_to_restart(j_decompress_ptr cinfo, int desired);
1068
1069/* Read ICC profile. See libjpeg.txt for usage information. */
1070EXTERN(boolean) jpeg_read_icc_profile(j_decompress_ptr cinfo,
1071 JOCTET **icc_data_ptr,
1072 unsigned int *icc_data_len);
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +00001073
1074
1075/* These marker codes are exported since applications and data source modules
1076 * are likely to want to use them.
1077 */
1078
Tom Hudson0d47d2d2016-05-04 13:22:56 -04001079#define JPEG_RST0 0xD0 /* RST0 marker code */
1080#define JPEG_EOI 0xD9 /* EOI marker code */
1081#define JPEG_APP0 0xE0 /* APP0 marker code */
1082#define JPEG_COM 0xFE /* COM marker code */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +00001083
1084
1085/* If we have a brain-damaged compiler that emits warnings (or worse, errors)
1086 * for structure definitions that are never filled in, keep it quiet by
1087 * supplying dummy definitions for the various substructures.
1088 */
1089
1090#ifdef INCOMPLETE_TYPES_BROKEN
Tom Hudson0d47d2d2016-05-04 13:22:56 -04001091#ifndef JPEG_INTERNALS /* will be defined in jpegint.h */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +00001092struct jvirt_sarray_control { long dummy; };
1093struct jvirt_barray_control { long dummy; };
1094struct jpeg_comp_master { long dummy; };
1095struct jpeg_c_main_controller { long dummy; };
1096struct jpeg_c_prep_controller { long dummy; };
1097struct jpeg_c_coef_controller { long dummy; };
1098struct jpeg_marker_writer { long dummy; };
1099struct jpeg_color_converter { long dummy; };
1100struct jpeg_downsampler { long dummy; };
1101struct jpeg_forward_dct { long dummy; };
1102struct jpeg_entropy_encoder { long dummy; };
1103struct jpeg_decomp_master { long dummy; };
1104struct jpeg_d_main_controller { long dummy; };
1105struct jpeg_d_coef_controller { long dummy; };
1106struct jpeg_d_post_controller { long dummy; };
1107struct jpeg_input_controller { long dummy; };
1108struct jpeg_marker_reader { long dummy; };
1109struct jpeg_entropy_decoder { long dummy; };
1110struct jpeg_inverse_dct { long dummy; };
1111struct jpeg_upsampler { long dummy; };
1112struct jpeg_color_deconverter { long dummy; };
1113struct jpeg_color_quantizer { long dummy; };
1114#endif /* JPEG_INTERNALS */
1115#endif /* INCOMPLETE_TYPES_BROKEN */
1116
1117
1118/*
1119 * The JPEG library modules define JPEG_INTERNALS before including this file.
1120 * The internal structure declarations are read only when that is true.
1121 * Applications using the library should not include jpegint.h, but may wish
1122 * to include jerror.h.
1123 */
1124
1125#ifdef JPEG_INTERNALS
Tom Hudson0d47d2d2016-05-04 13:22:56 -04001126#include "jpegint.h" /* fetch private declarations */
1127#include "jerror.h" /* fetch error codes too */
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +00001128#endif
1129
1130#ifdef __cplusplus
hbono@chromium.org98626972011-08-03 03:13:08 +00001131#ifndef DONT_USE_EXTERN_C
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +00001132}
1133#endif
hbono@chromium.org98626972011-08-03 03:13:08 +00001134#endif
hbono@chromium.orgf0c4f332010-11-01 05:14:55 +00001135
1136#endif /* JPEGLIB_H */