jpeglib.h

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