Coverage Report

Created: 2023-09-24 16:00

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