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