jpeglib.h 54 KB

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