jpeglib.h

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