Mercurial > hgrepos > Python2 > PyMuPDF
comparison mupdf-source/thirdparty/libjpeg/libjpeg.txt @ 2:b50eed0cc0ef upstream
ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4.
The directory name has changed: no version number in the expanded directory now.
| author | Franz Glasner <fzglas.hg@dom66.de> |
|---|---|
| date | Mon, 15 Sep 2025 11:43:07 +0200 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 1:1d09e1dec1d9 | 2:b50eed0cc0ef |
|---|---|
| 1 USING THE IJG JPEG LIBRARY | |
| 2 | |
| 3 Copyright (C) 1994-2023, Thomas G. Lane, Guido Vollbeding. | |
| 4 This file is part of the Independent JPEG Group's software. | |
| 5 For conditions of distribution and use, see the accompanying README file. | |
| 6 | |
| 7 | |
| 8 This file describes how to use the IJG JPEG library within an application | |
| 9 program. Read it if you want to write a program that uses the library. | |
| 10 | |
| 11 The file example.c provides heavily commented skeleton code for calling the | |
| 12 JPEG library. Also see jpeglib.h (the include file to be used by application | |
| 13 programs) for full details about data structures and function parameter lists. | |
| 14 The library source code, of course, is the ultimate reference. | |
| 15 | |
| 16 Note that there have been *major* changes from the application interface | |
| 17 presented by IJG version 4 and earlier versions. The old design had several | |
| 18 inherent limitations, and it had accumulated a lot of cruft as we added | |
| 19 features while trying to minimize application-interface changes. We have | |
| 20 sacrificed backward compatibility in the version 5 rewrite, but we think the | |
| 21 improvements justify this. | |
| 22 | |
| 23 | |
| 24 TABLE OF CONTENTS | |
| 25 ----------------- | |
| 26 | |
| 27 Overview: | |
| 28 Functions provided by the library | |
| 29 Outline of typical usage | |
| 30 Basic library usage: | |
| 31 Data formats | |
| 32 Compression details | |
| 33 Decompression details | |
| 34 Mechanics of usage: include files, linking, etc | |
| 35 Advanced features: | |
| 36 Compression parameter selection | |
| 37 Decompression parameter selection | |
| 38 Special color spaces | |
| 39 Error handling | |
| 40 Compressed data handling (source and destination managers) | |
| 41 I/O suspension | |
| 42 Progressive JPEG support | |
| 43 Buffered-image mode | |
| 44 Abbreviated datastreams and multiple images | |
| 45 Special markers | |
| 46 Raw (downsampled) image data | |
| 47 Really raw data: DCT coefficients | |
| 48 Progress monitoring | |
| 49 Memory management | |
| 50 Memory usage | |
| 51 Library compile-time options | |
| 52 Portability considerations | |
| 53 Notes for MS-DOS implementors | |
| 54 | |
| 55 You should read at least the overview and basic usage sections before trying | |
| 56 to program with the library. The sections on advanced features can be read | |
| 57 if and when you need them. | |
| 58 | |
| 59 | |
| 60 OVERVIEW | |
| 61 ======== | |
| 62 | |
| 63 Functions provided by the library | |
| 64 --------------------------------- | |
| 65 | |
| 66 The IJG JPEG library provides C code to read and write JPEG-compressed image | |
| 67 files. The surrounding application program receives or supplies image data a | |
| 68 scanline at a time, using a straightforward uncompressed image format. All | |
| 69 details of color conversion and other preprocessing/postprocessing can be | |
| 70 handled by the library. | |
| 71 | |
| 72 The library includes a substantial amount of code that is not covered by the | |
| 73 JPEG standard but is necessary for typical applications of JPEG. These | |
| 74 functions preprocess the image before JPEG compression or postprocess it after | |
| 75 decompression. They include colorspace conversion, downsampling/upsampling, | |
| 76 and color quantization. The application indirectly selects use of this code | |
| 77 by specifying the format in which it wishes to supply or receive image data. | |
| 78 For example, if colormapped output is requested, then the decompression | |
| 79 library automatically invokes color quantization. | |
| 80 | |
| 81 A wide range of quality vs. speed tradeoffs are possible in JPEG processing, | |
| 82 and even more so in decompression postprocessing. The decompression library | |
| 83 provides multiple implementations that cover most of the useful tradeoffs, | |
| 84 ranging from very-high-quality down to fast-preview operation. On the | |
| 85 compression side we have generally not provided low-quality choices, since | |
| 86 compression is normally less time-critical. It should be understood that the | |
| 87 low-quality modes may not meet the JPEG standard's accuracy requirements; | |
| 88 nonetheless, they are useful for viewers. | |
| 89 | |
| 90 A word about functions *not* provided by the library. We handle a subset of | |
| 91 the ISO JPEG standard; most baseline, extended-sequential, and progressive | |
| 92 JPEG processes are supported. (Our subset includes all features now in common | |
| 93 use.) Unsupported ISO options include: | |
| 94 * Hierarchical storage | |
| 95 * Lossless JPEG | |
| 96 * DNL marker | |
| 97 * Nonintegral subsampling ratios | |
| 98 We support 8-bit to 12-bit data precision, but this is a compile-time choice | |
| 99 rather than a run-time choice; hence it is difficult to use different | |
| 100 precisions in a single application. | |
| 101 | |
| 102 By itself, the library handles only interchange JPEG datastreams --- in | |
| 103 particular the widely used JFIF file format. The library can be used by | |
| 104 surrounding code to process interchange or abbreviated JPEG datastreams that | |
| 105 are embedded in more complex file formats. (For example, this library is | |
| 106 used by the free LIBTIFF library to support JPEG compression in TIFF.) | |
| 107 | |
| 108 | |
| 109 Outline of typical usage | |
| 110 ------------------------ | |
| 111 | |
| 112 The rough outline of a JPEG compression operation is: | |
| 113 | |
| 114 Allocate and initialize a JPEG compression object | |
| 115 Specify the destination for the compressed data (eg, a file) | |
| 116 Set parameters for compression, including image size & colorspace | |
| 117 jpeg_start_compress(...); | |
| 118 while (scan lines remain to be written) | |
| 119 jpeg_write_scanlines(...); | |
| 120 jpeg_finish_compress(...); | |
| 121 Release the JPEG compression object | |
| 122 | |
| 123 A JPEG compression object holds parameters and working state for the JPEG | |
| 124 library. We make creation/destruction of the object separate from starting | |
| 125 or finishing compression of an image; the same object can be re-used for a | |
| 126 series of image compression operations. This makes it easy to re-use the | |
| 127 same parameter settings for a sequence of images. Re-use of a JPEG object | |
| 128 also has important implications for processing abbreviated JPEG datastreams, | |
| 129 as discussed later. | |
| 130 | |
| 131 The image data to be compressed is supplied to jpeg_write_scanlines() from | |
| 132 in-memory buffers. If the application is doing file-to-file compression, | |
| 133 reading image data from the source file is the application's responsibility. | |
| 134 The library emits compressed data by calling a "data destination manager", | |
| 135 which typically will write the data into a file; but the application can | |
| 136 provide its own destination manager to do something else. | |
| 137 | |
| 138 Similarly, the rough outline of a JPEG decompression operation is: | |
| 139 | |
| 140 Allocate and initialize a JPEG decompression object | |
| 141 Specify the source of the compressed data (eg, a file) | |
| 142 Call jpeg_read_header() to obtain image info | |
| 143 Set parameters for decompression | |
| 144 jpeg_start_decompress(...); | |
| 145 while (scan lines remain to be read) | |
| 146 jpeg_read_scanlines(...); | |
| 147 jpeg_finish_decompress(...); | |
| 148 Release the JPEG decompression object | |
| 149 | |
| 150 This is comparable to the compression outline except that reading the | |
| 151 datastream header is a separate step. This is helpful because information | |
| 152 about the image's size, colorspace, etc is available when the application | |
| 153 selects decompression parameters. For example, the application can choose an | |
| 154 output scaling ratio that will fit the image into the available screen size. | |
| 155 | |
| 156 The decompression library obtains compressed data by calling a data source | |
| 157 manager, which typically will read the data from a file; but other behaviors | |
| 158 can be obtained with a custom source manager. Decompressed data is delivered | |
| 159 into in-memory buffers passed to jpeg_read_scanlines(). | |
| 160 | |
| 161 It is possible to abort an incomplete compression or decompression operation | |
| 162 by calling jpeg_abort(); or, if you do not need to retain the JPEG object, | |
| 163 simply release it by calling jpeg_destroy(). | |
| 164 | |
| 165 JPEG compression and decompression objects are two separate struct types. | |
| 166 However, they share some common fields, and certain routines such as | |
| 167 jpeg_destroy() can work on either type of object. | |
| 168 | |
| 169 The JPEG library has no static variables: all state is in the compression | |
| 170 or decompression object. Therefore it is possible to process multiple | |
| 171 compression and decompression operations concurrently, using multiple JPEG | |
| 172 objects. | |
| 173 | |
| 174 Both compression and decompression can be done in an incremental memory-to- | |
| 175 memory fashion, if suitable source/destination managers are used. See the | |
| 176 section on "I/O suspension" for more details. | |
| 177 | |
| 178 | |
| 179 BASIC LIBRARY USAGE | |
| 180 =================== | |
| 181 | |
| 182 Data formats | |
| 183 ------------ | |
| 184 | |
| 185 Before diving into procedural details, it is helpful to understand the | |
| 186 image data format that the JPEG library expects or returns. | |
| 187 | |
| 188 The standard input image format is a rectangular array of pixels, with each | |
| 189 pixel having the same number of "component" or "sample" values (color | |
| 190 channels). You must specify how many components there are and the colorspace | |
| 191 interpretation of the components. Most applications will use RGB data | |
| 192 (three components per pixel) or grayscale data (one component per pixel). | |
| 193 PLEASE NOTE THAT RGB DATA IS THREE SAMPLES PER PIXEL, GRAYSCALE ONLY ONE. | |
| 194 A remarkable number of people manage to miss this, only to find that their | |
| 195 programs don't work with grayscale JPEG files. | |
| 196 | |
| 197 There is no provision for colormapped input. JPEG files are always full-color | |
| 198 or full grayscale (or sometimes another colorspace such as CMYK). You can | |
| 199 feed in a colormapped image by expanding it to full-color format. However | |
| 200 JPEG often doesn't work very well with source data that has been colormapped, | |
| 201 because of dithering noise. This is discussed in more detail in the JPEG FAQ | |
| 202 and the other references mentioned in the README file. | |
| 203 | |
| 204 Pixels are stored by scanlines, with each scanline running from left to | |
| 205 right. The component values for each pixel are adjacent in the row; for | |
| 206 example, R,G,B,R,G,B,R,G,B,... for 24-bit RGB color. Each scanline is an | |
| 207 array of data type JSAMPLE --- which is typically "unsigned char", unless | |
| 208 you've changed jmorecfg.h. (You can also change the RGB pixel layout, say | |
| 209 to B,G,R order, by modifying jmorecfg.h. But see the restrictions listed in | |
| 210 that file before doing so.) | |
| 211 | |
| 212 A 2-D array of pixels is formed by making a list of pointers to the starts of | |
| 213 scanlines; so the scanlines need not be physically adjacent in memory. Even | |
| 214 if you process just one scanline at a time, you must make a one-element | |
| 215 pointer array to conform to this structure. Pointers to JSAMPLE rows are of | |
| 216 type JSAMPROW, and the pointer to the pointer array is of type JSAMPARRAY. | |
| 217 | |
| 218 The library accepts or supplies one or more complete scanlines per call. | |
| 219 It is not possible to process part of a row at a time. Scanlines are always | |
| 220 processed top-to-bottom. You can process an entire image in one call if you | |
| 221 have it all in memory, but usually it's simplest to process one scanline at | |
| 222 a time. | |
| 223 | |
| 224 For best results, source data values should have the precision specified by | |
| 225 BITS_IN_JSAMPLE (normally 8 bits). For instance, if you choose to compress | |
| 226 data that's only 6 bits/channel, you should left-justify each value in a | |
| 227 byte before passing it to the compressor. If you need to compress data | |
| 228 that has more than 8 bits/channel, compile with BITS_IN_JSAMPLE = 9 to 12. | |
| 229 (See "Library compile-time options", later.) | |
| 230 | |
| 231 | |
| 232 The data format returned by the decompressor is the same in all details, | |
| 233 except that colormapped output is supported. (Again, a JPEG file is never | |
| 234 colormapped. But you can ask the decompressor to perform on-the-fly color | |
| 235 quantization to deliver colormapped output.) If you request colormapped | |
| 236 output then the returned data array contains a single JSAMPLE per pixel; | |
| 237 its value is an index into a color map. The color map is represented as | |
| 238 a 2-D JSAMPARRAY in which each row holds the values of one color component, | |
| 239 that is, colormap[i][j] is the value of the i'th color component for pixel | |
| 240 value (map index) j. Note that since the colormap indexes are stored in | |
| 241 JSAMPLEs, the maximum number of colors is limited by the size of JSAMPLE | |
| 242 (ie, at most 256 colors for an 8-bit JPEG library). | |
| 243 | |
| 244 | |
| 245 Compression details | |
| 246 ------------------- | |
| 247 | |
| 248 Here we revisit the JPEG compression outline given in the overview. | |
| 249 | |
| 250 1. Allocate and initialize a JPEG compression object. | |
| 251 | |
| 252 A JPEG compression object is a "struct jpeg_compress_struct". (It also has | |
| 253 a bunch of subsidiary structures which are allocated via malloc(), but the | |
| 254 application doesn't control those directly.) This struct can be just a local | |
| 255 variable in the calling routine, if a single routine is going to execute the | |
| 256 whole JPEG compression sequence. Otherwise it can be static or allocated | |
| 257 from malloc(). | |
| 258 | |
| 259 You will also need a structure representing a JPEG error handler. The part | |
| 260 of this that the library cares about is a "struct jpeg_error_mgr". If you | |
| 261 are providing your own error handler, you'll typically want to embed the | |
| 262 jpeg_error_mgr struct in a larger structure; this is discussed later under | |
| 263 "Error handling". For now we'll assume you are just using the default error | |
| 264 handler. The default error handler will print JPEG error/warning messages | |
| 265 on stderr, and it will call exit() if a fatal error occurs. | |
| 266 | |
| 267 You must initialize the error handler structure, store a pointer to it into | |
| 268 the JPEG object's "err" field, and then call jpeg_create_compress() to | |
| 269 initialize the rest of the JPEG object. | |
| 270 | |
| 271 Typical code for this step, if you are using the default error handler, is | |
| 272 | |
| 273 struct jpeg_compress_struct cinfo; | |
| 274 struct jpeg_error_mgr jerr; | |
| 275 ... | |
| 276 cinfo.err = jpeg_std_error(&jerr); | |
| 277 jpeg_create_compress(&cinfo); | |
| 278 | |
| 279 jpeg_create_compress allocates a small amount of memory, so it could fail | |
| 280 if you are out of memory. In that case it will exit via the error handler; | |
| 281 that's why the error handler must be initialized first. | |
| 282 | |
| 283 | |
| 284 2. Specify the destination for the compressed data (eg, a file). | |
| 285 | |
| 286 As previously mentioned, the JPEG library delivers compressed data to a | |
| 287 "data destination" module. The library includes one data destination | |
| 288 module which knows how to write to memory or to a file (or any stdio stream). | |
| 289 You can use your own destination module if you want to do something else, | |
| 290 as discussed later. | |
| 291 | |
| 292 If you use the standard destination module, you must open the target stdio | |
| 293 stream beforehand. Typical code for this step looks like: | |
| 294 | |
| 295 FILE * outfile; | |
| 296 ... | |
| 297 if ((outfile = fopen(filename, "wb")) == NULL) { | |
| 298 fprintf(stderr, "can't open %s\n", filename); | |
| 299 exit(1); | |
| 300 } | |
| 301 jpeg_stdio_dest(&cinfo, outfile); | |
| 302 | |
| 303 where the last line invokes the standard destination module. | |
| 304 | |
| 305 WARNING: it is critical that the binary compressed data be delivered to the | |
| 306 output file unchanged. On non-Unix systems the stdio library may perform | |
| 307 newline translation or otherwise corrupt binary data. To suppress this | |
| 308 behavior, you may need to use a "b" option to fopen (as shown above), or use | |
| 309 setmode() or another routine to put the stdio stream in binary mode. See | |
| 310 cjpeg.c and djpeg.c for code that has been found to work on many systems. | |
| 311 | |
| 312 You can select the data destination after setting other parameters (step 3), | |
| 313 if that's more convenient. You may not change the destination between | |
| 314 calling jpeg_start_compress() and jpeg_finish_compress(). | |
| 315 | |
| 316 | |
| 317 3. Set parameters for compression, including image size & colorspace. | |
| 318 | |
| 319 You must supply information about the source image by setting the following | |
| 320 fields in the JPEG object (cinfo structure): | |
| 321 | |
| 322 image_width Width of image, in pixels | |
| 323 image_height Height of image, in pixels | |
| 324 input_components Number of color channels (samples per pixel) | |
| 325 in_color_space Color space of source image | |
| 326 | |
| 327 The image dimensions are, hopefully, obvious. JPEG supports image dimensions | |
| 328 of 1 to 64K pixels in either direction. The input color space is typically | |
| 329 RGB or grayscale, and input_components is 3 or 1 accordingly. (See "Special | |
| 330 color spaces", later, for more info.) The in_color_space field must be | |
| 331 assigned one of the J_COLOR_SPACE enum constants, typically JCS_RGB or | |
| 332 JCS_GRAYSCALE. | |
| 333 | |
| 334 JPEG has a large number of compression parameters that determine how the | |
| 335 image is encoded. Most applications don't need or want to know about all | |
| 336 these parameters. You can set all the parameters to reasonable defaults by | |
| 337 calling jpeg_set_defaults(); then, if there are particular values you want | |
| 338 to change, you can do so after that. The "Compression parameter selection" | |
| 339 section tells about all the parameters. | |
| 340 | |
| 341 You must set in_color_space correctly before calling jpeg_set_defaults(), | |
| 342 because the defaults depend on the source image colorspace. However the | |
| 343 other three source image parameters need not be valid until you call | |
| 344 jpeg_start_compress(). There's no harm in calling jpeg_set_defaults() more | |
| 345 than once, if that happens to be convenient. | |
| 346 | |
| 347 Typical code for a 24-bit RGB source image is | |
| 348 | |
| 349 cinfo.image_width = Width; /* image width and height, in pixels */ | |
| 350 cinfo.image_height = Height; | |
| 351 cinfo.input_components = 3; /* # of color components per pixel */ | |
| 352 cinfo.in_color_space = JCS_RGB; /* colorspace of input image */ | |
| 353 | |
| 354 jpeg_set_defaults(&cinfo); | |
| 355 /* Make optional parameter settings here */ | |
| 356 | |
| 357 | |
| 358 4. jpeg_start_compress(...); | |
| 359 | |
| 360 After you have established the data destination and set all the necessary | |
| 361 source image info and other parameters, call jpeg_start_compress() to begin | |
| 362 a compression cycle. This will initialize internal state, allocate working | |
| 363 storage, and emit the first few bytes of the JPEG datastream header. | |
| 364 | |
| 365 Typical code: | |
| 366 | |
| 367 jpeg_start_compress(&cinfo, TRUE); | |
| 368 | |
| 369 The "TRUE" parameter ensures that a complete JPEG interchange datastream | |
| 370 will be written. This is appropriate in most cases. If you think you might | |
| 371 want to use an abbreviated datastream, read the section on abbreviated | |
| 372 datastreams, below. | |
| 373 | |
| 374 Once you have called jpeg_start_compress(), you may not alter any JPEG | |
| 375 parameters or other fields of the JPEG object until you have completed | |
| 376 the compression cycle. | |
| 377 | |
| 378 | |
| 379 5. while (scan lines remain to be written) | |
| 380 jpeg_write_scanlines(...); | |
| 381 | |
| 382 Now write all the required image data by calling jpeg_write_scanlines() | |
| 383 one or more times. You can pass one or more scanlines in each call, up | |
| 384 to the total image height. In most applications it is convenient to pass | |
| 385 just one or a few scanlines at a time. The expected format for the passed | |
| 386 data is discussed under "Data formats", above. | |
| 387 | |
| 388 Image data should be written in top-to-bottom scanline order. The JPEG spec | |
| 389 contains some weasel wording about how top and bottom are application-defined | |
| 390 terms (a curious interpretation of the English language...) but if you want | |
| 391 your files to be compatible with everyone else's, you WILL use top-to-bottom | |
| 392 order. If the source data must be read in bottom-to-top order, you can use | |
| 393 the JPEG library's virtual array mechanism to invert the data efficiently. | |
| 394 Examples of this can be found in the sample application cjpeg. | |
| 395 | |
| 396 The library maintains a count of the number of scanlines written so far | |
| 397 in the next_scanline field of the JPEG object. Usually you can just use | |
| 398 this variable as the loop counter, so that the loop test looks like | |
| 399 "while (cinfo.next_scanline < cinfo.image_height)". | |
| 400 | |
| 401 Code for this step depends heavily on the way that you store the source data. | |
| 402 example.c shows the following code for the case of a full-size 2-D source | |
| 403 array containing 3-byte RGB pixels: | |
| 404 | |
| 405 JSAMPROW row_pointer[1]; /* pointer to a single row */ | |
| 406 int row_stride; /* physical row width in buffer */ | |
| 407 | |
| 408 row_stride = image_width * 3; /* JSAMPLEs per row in image_buffer */ | |
| 409 | |
| 410 while (cinfo.next_scanline < cinfo.image_height) { | |
| 411 row_pointer[0] = & image_buffer[cinfo.next_scanline * row_stride]; | |
| 412 jpeg_write_scanlines(&cinfo, row_pointer, 1); | |
| 413 } | |
| 414 | |
| 415 jpeg_write_scanlines() returns the number of scanlines actually written. | |
| 416 This will normally be equal to the number passed in, so you can usually | |
| 417 ignore the return value. It is different in just two cases: | |
| 418 * If you try to write more scanlines than the declared image height, | |
| 419 the additional scanlines are ignored. | |
| 420 * If you use a suspending data destination manager, output buffer overrun | |
| 421 will cause the compressor to return before accepting all the passed lines. | |
| 422 This feature is discussed under "I/O suspension", below. The normal | |
| 423 stdio destination manager will NOT cause this to happen. | |
| 424 In any case, the return value is the same as the change in the value of | |
| 425 next_scanline. | |
| 426 | |
| 427 | |
| 428 6. jpeg_finish_compress(...); | |
| 429 | |
| 430 After all the image data has been written, call jpeg_finish_compress() to | |
| 431 complete the compression cycle. This step is ESSENTIAL to ensure that the | |
| 432 last bufferload of data is written to the data destination. | |
| 433 jpeg_finish_compress() also releases working memory associated with the JPEG | |
| 434 object. | |
| 435 | |
| 436 Typical code: | |
| 437 | |
| 438 jpeg_finish_compress(&cinfo); | |
| 439 | |
| 440 If using the stdio destination manager, don't forget to close the output | |
| 441 stdio stream (if necessary) afterwards. | |
| 442 | |
| 443 If you have requested a multi-pass operating mode, such as Huffman code | |
| 444 optimization, jpeg_finish_compress() will perform the additional passes using | |
| 445 data buffered by the first pass. In this case jpeg_finish_compress() may take | |
| 446 quite a while to complete. With the default compression parameters, this will | |
| 447 not happen. | |
| 448 | |
| 449 It is an error to call jpeg_finish_compress() before writing the necessary | |
| 450 total number of scanlines. If you wish to abort compression, call | |
| 451 jpeg_abort() as discussed below. | |
| 452 | |
| 453 After completing a compression cycle, you may dispose of the JPEG object | |
| 454 as discussed next, or you may use it to compress another image. In that case | |
| 455 return to step 2, 3, or 4 as appropriate. If you do not change the | |
| 456 destination manager, the new datastream will be written to the same target. | |
| 457 If you do not change any JPEG parameters, the new datastream will be written | |
| 458 with the same parameters as before. Note that you can change the input image | |
| 459 dimensions freely between cycles, but if you change the input colorspace, you | |
| 460 should call jpeg_set_defaults() to adjust for the new colorspace; and then | |
| 461 you'll need to repeat all of step 3. | |
| 462 | |
| 463 | |
| 464 7. Release the JPEG compression object. | |
| 465 | |
| 466 When you are done with a JPEG compression object, destroy it by calling | |
| 467 jpeg_destroy_compress(). This will free all subsidiary memory (regardless of | |
| 468 the previous state of the object). Or you can call jpeg_destroy(), which | |
| 469 works for either compression or decompression objects --- this may be more | |
| 470 convenient if you are sharing code between compression and decompression | |
| 471 cases. (Actually, these routines are equivalent except for the declared type | |
| 472 of the passed pointer. To avoid gripes from ANSI C compilers, jpeg_destroy() | |
| 473 should be passed a j_common_ptr.) | |
| 474 | |
| 475 If you allocated the jpeg_compress_struct structure from malloc(), freeing | |
| 476 it is your responsibility --- jpeg_destroy() won't. Ditto for the error | |
| 477 handler structure. | |
| 478 | |
| 479 Typical code: | |
| 480 | |
| 481 jpeg_destroy_compress(&cinfo); | |
| 482 | |
| 483 | |
| 484 8. Aborting. | |
| 485 | |
| 486 If you decide to abort a compression cycle before finishing, you can clean up | |
| 487 in either of two ways: | |
| 488 | |
| 489 * If you don't need the JPEG object any more, just call | |
| 490 jpeg_destroy_compress() or jpeg_destroy() to release memory. This is | |
| 491 legitimate at any point after calling jpeg_create_compress() --- in fact, | |
| 492 it's safe even if jpeg_create_compress() fails. | |
| 493 | |
| 494 * If you want to re-use the JPEG object, call jpeg_abort_compress(), or call | |
| 495 jpeg_abort() which works on both compression and decompression objects. | |
| 496 This will return the object to an idle state, releasing any working memory. | |
| 497 jpeg_abort() is allowed at any time after successful object creation. | |
| 498 | |
| 499 Note that cleaning up the data destination, if required, is your | |
| 500 responsibility; neither of these routines will call term_destination(). | |
| 501 (See "Compressed data handling", below, for more about that.) | |
| 502 | |
| 503 jpeg_destroy() and jpeg_abort() are the only safe calls to make on a JPEG | |
| 504 object that has reported an error by calling error_exit (see "Error handling" | |
| 505 for more info). The internal state of such an object is likely to be out of | |
| 506 whack. Either of these two routines will return the object to a known state. | |
| 507 | |
| 508 | |
| 509 Decompression details | |
| 510 --------------------- | |
| 511 | |
| 512 Here we revisit the JPEG decompression outline given in the overview. | |
| 513 | |
| 514 1. Allocate and initialize a JPEG decompression object. | |
| 515 | |
| 516 This is just like initialization for compression, as discussed above, | |
| 517 except that the object is a "struct jpeg_decompress_struct" and you | |
| 518 call jpeg_create_decompress(). Error handling is exactly the same. | |
| 519 | |
| 520 Typical code: | |
| 521 | |
| 522 struct jpeg_decompress_struct cinfo; | |
| 523 struct jpeg_error_mgr jerr; | |
| 524 ... | |
| 525 cinfo.err = jpeg_std_error(&jerr); | |
| 526 jpeg_create_decompress(&cinfo); | |
| 527 | |
| 528 (Both here and in the IJG code, we usually use variable name "cinfo" for | |
| 529 both compression and decompression objects.) | |
| 530 | |
| 531 | |
| 532 2. Specify the source of the compressed data (eg, a file). | |
| 533 | |
| 534 As previously mentioned, the JPEG library reads compressed data from a "data | |
| 535 source" module. The library includes one data source module which knows how | |
| 536 to read from memory or from a file (or any stdio stream). You can use your | |
| 537 own source module if you want to do something else, as discussed later. | |
| 538 | |
| 539 If you use the standard source module, you must open the source stdio stream | |
| 540 beforehand. Typical code for this step looks like: | |
| 541 | |
| 542 FILE * infile; | |
| 543 ... | |
| 544 if ((infile = fopen(filename, "rb")) == NULL) { | |
| 545 fprintf(stderr, "can't open %s\n", filename); | |
| 546 exit(1); | |
| 547 } | |
| 548 jpeg_stdio_src(&cinfo, infile); | |
| 549 | |
| 550 where the last line invokes the standard source module. | |
| 551 | |
| 552 WARNING: it is critical that the binary compressed data be read unchanged. | |
| 553 On non-Unix systems the stdio library may perform newline translation or | |
| 554 otherwise corrupt binary data. To suppress this behavior, you may need to use | |
| 555 a "b" option to fopen (as shown above), or use setmode() or another routine to | |
| 556 put the stdio stream in binary mode. See cjpeg.c and djpeg.c for code that | |
| 557 has been found to work on many systems. | |
| 558 | |
| 559 You may not change the data source between calling jpeg_read_header() and | |
| 560 jpeg_finish_decompress(). If you wish to read a series of JPEG images from | |
| 561 a single source file, you should repeat the jpeg_read_header() to | |
| 562 jpeg_finish_decompress() sequence without reinitializing either the JPEG | |
| 563 object or the data source module; this prevents buffered input data from | |
| 564 being discarded. | |
| 565 | |
| 566 | |
| 567 3. Call jpeg_read_header() to obtain image info. | |
| 568 | |
| 569 Typical code for this step is just | |
| 570 | |
| 571 jpeg_read_header(&cinfo, TRUE); | |
| 572 | |
| 573 This will read the source datastream header markers, up to the beginning | |
| 574 of the compressed data proper. On return, the image dimensions and other | |
| 575 info have been stored in the JPEG object. The application may wish to | |
| 576 consult this information before selecting decompression parameters. | |
| 577 | |
| 578 More complex code is necessary if | |
| 579 * A suspending data source is used --- in that case jpeg_read_header() | |
| 580 may return before it has read all the header data. See "I/O suspension", | |
| 581 below. The normal stdio source manager will NOT cause this to happen. | |
| 582 * Abbreviated JPEG files are to be processed --- see the section on | |
| 583 abbreviated datastreams. Standard applications that deal only in | |
| 584 interchange JPEG files need not be concerned with this case either. | |
| 585 | |
| 586 It is permissible to stop at this point if you just wanted to find out the | |
| 587 image dimensions and other header info for a JPEG file. In that case, | |
| 588 call jpeg_destroy() when you are done with the JPEG object, or call | |
| 589 jpeg_abort() to return it to an idle state before selecting a new data | |
| 590 source and reading another header. | |
| 591 | |
| 592 | |
| 593 4. Set parameters for decompression. | |
| 594 | |
| 595 jpeg_read_header() sets appropriate default decompression parameters based on | |
| 596 the properties of the image (in particular, its colorspace). However, you | |
| 597 may well want to alter these defaults before beginning the decompression. | |
| 598 For example, the default is to produce full color output from a color file. | |
| 599 If you want colormapped output you must ask for it. Other options allow the | |
| 600 returned image to be scaled and allow various speed/quality tradeoffs to be | |
| 601 selected. "Decompression parameter selection", below, gives details. | |
| 602 | |
| 603 If the defaults are appropriate, nothing need be done at this step. | |
| 604 | |
| 605 Note that all default values are set by each call to jpeg_read_header(). | |
| 606 If you reuse a decompression object, you cannot expect your parameter | |
| 607 settings to be preserved across cycles, as you can for compression. | |
| 608 You must set desired parameter values each time. | |
| 609 | |
| 610 | |
| 611 5. jpeg_start_decompress(...); | |
| 612 | |
| 613 Once the parameter values are satisfactory, call jpeg_start_decompress() to | |
| 614 begin decompression. This will initialize internal state, allocate working | |
| 615 memory, and prepare for returning data. | |
| 616 | |
| 617 Typical code is just | |
| 618 | |
| 619 jpeg_start_decompress(&cinfo); | |
| 620 | |
| 621 If you have requested a multi-pass operating mode, such as 2-pass color | |
| 622 quantization, jpeg_start_decompress() will do everything needed before data | |
| 623 output can begin. In this case jpeg_start_decompress() may take quite a while | |
| 624 to complete. With a single-scan (non progressive) JPEG file and default | |
| 625 decompression parameters, this will not happen; jpeg_start_decompress() will | |
| 626 return quickly. | |
| 627 | |
| 628 After this call, the final output image dimensions, including any requested | |
| 629 scaling, are available in the JPEG object; so is the selected colormap, if | |
| 630 colormapped output has been requested. Useful fields include | |
| 631 | |
| 632 output_width image width and height, as scaled | |
| 633 output_height | |
| 634 out_color_components # of color components in out_color_space | |
| 635 output_components # of color components returned per pixel | |
| 636 colormap the selected colormap, if any | |
| 637 actual_number_of_colors number of entries in colormap | |
| 638 | |
| 639 output_components is 1 (a colormap index) when quantizing colors; otherwise it | |
| 640 equals out_color_components. It is the number of JSAMPLE values that will be | |
| 641 emitted per pixel in the output arrays. | |
| 642 | |
| 643 Typically you will need to allocate data buffers to hold the incoming image. | |
| 644 You will need output_width * output_components JSAMPLEs per scanline in your | |
| 645 output buffer, and a total of output_height scanlines will be returned. | |
| 646 | |
| 647 Note: if you are using the JPEG library's internal memory manager to allocate | |
| 648 data buffers (as djpeg does), then the manager's protocol requires that you | |
| 649 request large buffers *before* calling jpeg_start_decompress(). This is a | |
| 650 little tricky since the output_XXX fields are not normally valid then. You | |
| 651 can make them valid by calling jpeg_calc_output_dimensions() after setting the | |
| 652 relevant parameters (scaling, output color space, and quantization flag). | |
| 653 | |
| 654 | |
| 655 6. while (scan lines remain to be read) | |
| 656 jpeg_read_scanlines(...); | |
| 657 | |
| 658 Now you can read the decompressed image data by calling jpeg_read_scanlines() | |
| 659 one or more times. At each call, you pass in the maximum number of scanlines | |
| 660 to be read (ie, the height of your working buffer); jpeg_read_scanlines() | |
| 661 will return up to that many lines. The return value is the number of lines | |
| 662 actually read. The format of the returned data is discussed under "Data | |
| 663 formats", above. Don't forget that grayscale and color JPEGs will return | |
| 664 different data formats! | |
| 665 | |
| 666 Image data is returned in top-to-bottom scanline order. If you must write | |
| 667 out the image in bottom-to-top order, you can use the JPEG library's virtual | |
| 668 array mechanism to invert the data efficiently. Examples of this can be | |
| 669 found in the sample application djpeg. | |
| 670 | |
| 671 The library maintains a count of the number of scanlines returned so far | |
| 672 in the output_scanline field of the JPEG object. Usually you can just use | |
| 673 this variable as the loop counter, so that the loop test looks like | |
| 674 "while (cinfo.output_scanline < cinfo.output_height)". (Note that the test | |
| 675 should NOT be against image_height, unless you never use scaling. The | |
| 676 image_height field is the height of the original unscaled image.) | |
| 677 The return value always equals the change in the value of output_scanline. | |
| 678 | |
| 679 If you don't use a suspending data source, it is safe to assume that | |
| 680 jpeg_read_scanlines() reads at least one scanline per call, until the | |
| 681 bottom of the image has been reached. | |
| 682 | |
| 683 If you use a buffer larger than one scanline, it is NOT safe to assume that | |
| 684 jpeg_read_scanlines() fills it. (The current implementation returns only a | |
| 685 few scanlines per call, no matter how large a buffer you pass.) So you must | |
| 686 always provide a loop that calls jpeg_read_scanlines() repeatedly until the | |
| 687 whole image has been read. | |
| 688 | |
| 689 | |
| 690 7. jpeg_finish_decompress(...); | |
| 691 | |
| 692 After all the image data has been read, call jpeg_finish_decompress() to | |
| 693 complete the decompression cycle. This causes working memory associated | |
| 694 with the JPEG object to be released. | |
| 695 | |
| 696 Typical code: | |
| 697 | |
| 698 jpeg_finish_decompress(&cinfo); | |
| 699 | |
| 700 If using the stdio source manager, don't forget to close the source stdio | |
| 701 stream if necessary. | |
| 702 | |
| 703 It is an error to call jpeg_finish_decompress() before reading the correct | |
| 704 total number of scanlines. If you wish to abort decompression, call | |
| 705 jpeg_abort() as discussed below. | |
| 706 | |
| 707 After completing a decompression cycle, you may dispose of the JPEG object as | |
| 708 discussed next, or you may use it to decompress another image. In that case | |
| 709 return to step 2 or 3 as appropriate. If you do not change the source | |
| 710 manager, the next image will be read from the same source. | |
| 711 | |
| 712 | |
| 713 8. Release the JPEG decompression object. | |
| 714 | |
| 715 When you are done with a JPEG decompression object, destroy it by calling | |
| 716 jpeg_destroy_decompress() or jpeg_destroy(). The previous discussion of | |
| 717 destroying compression objects applies here too. | |
| 718 | |
| 719 Typical code: | |
| 720 | |
| 721 jpeg_destroy_decompress(&cinfo); | |
| 722 | |
| 723 | |
| 724 9. Aborting. | |
| 725 | |
| 726 You can abort a decompression cycle by calling jpeg_destroy_decompress() or | |
| 727 jpeg_destroy() if you don't need the JPEG object any more, or | |
| 728 jpeg_abort_decompress() or jpeg_abort() if you want to reuse the object. | |
| 729 The previous discussion of aborting compression cycles applies here too. | |
| 730 | |
| 731 | |
| 732 Mechanics of usage: include files, linking, etc | |
| 733 ----------------------------------------------- | |
| 734 | |
| 735 Applications using the JPEG library should include the header file jpeglib.h | |
| 736 to obtain declarations of data types and routines. Before including | |
| 737 jpeglib.h, include system headers that define at least the typedefs FILE and | |
| 738 size_t. On ANSI-conforming systems, including <stdio.h> is sufficient; on | |
| 739 older Unix systems, you may need <sys/types.h> to define size_t. | |
| 740 | |
| 741 If the application needs to refer to individual JPEG library error codes, also | |
| 742 include jerror.h to define those symbols. | |
| 743 | |
| 744 jpeglib.h indirectly includes the files jconfig.h and jmorecfg.h. If you are | |
| 745 installing the JPEG header files in a system directory, you will want to | |
| 746 install all four files: jpeglib.h, jerror.h, jconfig.h, jmorecfg.h. | |
| 747 | |
| 748 The most convenient way to include the JPEG code into your executable program | |
| 749 is to prepare a library file ("libjpeg.a", or a corresponding name on non-Unix | |
| 750 machines) and reference it at your link step. If you use only half of the | |
| 751 library (only compression or only decompression), only that much code will be | |
| 752 included from the library, unless your linker is hopelessly brain-damaged. | |
| 753 The supplied makefiles build libjpeg.a automatically (see install.txt). | |
| 754 | |
| 755 While you can build the JPEG library as a shared library if the whim strikes | |
| 756 you, we don't really recommend it. The trouble with shared libraries is that | |
| 757 at some point you'll probably try to substitute a new version of the library | |
| 758 without recompiling the calling applications. That generally doesn't work | |
| 759 because the parameter struct declarations usually change with each new | |
| 760 version. In other words, the library's API is *not* guaranteed binary | |
| 761 compatible across versions; we only try to ensure source-code compatibility. | |
| 762 (In hindsight, it might have been smarter to hide the parameter structs from | |
| 763 applications and introduce a ton of access functions instead. Too late now, | |
| 764 however.) | |
| 765 | |
| 766 On some systems your application may need to set up a signal handler to ensure | |
| 767 that temporary files are deleted if the program is interrupted. This is most | |
| 768 critical if you are on MS-DOS and use the jmemdos.c memory manager back end; | |
| 769 it will try to grab extended memory for temp files, and that space will NOT be | |
| 770 freed automatically. See cjpeg.c or djpeg.c for an example signal handler. | |
| 771 | |
| 772 It may be worth pointing out that the core JPEG library does not actually | |
| 773 require the stdio library: only the default source/destination managers and | |
| 774 error handler need it. You can use the library in a stdio-less environment | |
| 775 if you replace those modules and use jmemnobs.c (or another memory manager of | |
| 776 your own devising). More info about the minimum system library requirements | |
| 777 may be found in jinclude.h. | |
| 778 | |
| 779 | |
| 780 ADVANCED FEATURES | |
| 781 ================= | |
| 782 | |
| 783 Compression parameter selection | |
| 784 ------------------------------- | |
| 785 | |
| 786 This section describes all the optional parameters you can set for JPEG | |
| 787 compression, as well as the "helper" routines provided to assist in this | |
| 788 task. Proper setting of some parameters requires detailed understanding | |
| 789 of the JPEG standard; if you don't know what a parameter is for, it's best | |
| 790 not to mess with it! See REFERENCES in the README file for pointers to | |
| 791 more info about JPEG. | |
| 792 | |
| 793 It's a good idea to call jpeg_set_defaults() first, even if you plan to set | |
| 794 all the parameters; that way your code is more likely to work with future JPEG | |
| 795 libraries that have additional parameters. For the same reason, we recommend | |
| 796 you use a helper routine where one is provided, in preference to twiddling | |
| 797 cinfo fields directly. | |
| 798 | |
| 799 The helper routines are: | |
| 800 | |
| 801 jpeg_set_defaults (j_compress_ptr cinfo) | |
| 802 This routine sets all JPEG parameters to reasonable defaults, using | |
| 803 only the input image's color space (field in_color_space, which must | |
| 804 already be set in cinfo). Many applications will only need to use | |
| 805 this routine and perhaps jpeg_set_quality(). | |
| 806 | |
| 807 jpeg_set_colorspace (j_compress_ptr cinfo, J_COLOR_SPACE colorspace) | |
| 808 Sets the JPEG file's colorspace (field jpeg_color_space) as specified, | |
| 809 and sets other color-space-dependent parameters appropriately. See | |
| 810 "Special color spaces", below, before using this. A large number of | |
| 811 parameters, including all per-component parameters, are set by this | |
| 812 routine; if you want to twiddle individual parameters you should call | |
| 813 jpeg_set_colorspace() before rather than after. | |
| 814 | |
| 815 jpeg_default_colorspace (j_compress_ptr cinfo) | |
| 816 Selects an appropriate JPEG colorspace based on cinfo->in_color_space, | |
| 817 and calls jpeg_set_colorspace(). This is actually a subroutine of | |
| 818 jpeg_set_defaults(). It's broken out in case you want to change | |
| 819 just the colorspace-dependent JPEG parameters. | |
| 820 | |
| 821 jpeg_set_quality (j_compress_ptr cinfo, int quality, boolean force_baseline) | |
| 822 Constructs JPEG quantization tables appropriate for the indicated | |
| 823 quality setting. The quality value is expressed on the 0..100 scale | |
| 824 recommended by IJG (cjpeg's "-quality" switch uses this routine). | |
| 825 Note that the exact mapping from quality values to tables may change | |
| 826 in future IJG releases as more is learned about DCT quantization. | |
| 827 If the force_baseline parameter is TRUE, then the quantization table | |
| 828 entries are constrained to the range 1..255 for full JPEG baseline | |
| 829 compatibility. In the current implementation, this only makes a | |
| 830 difference for quality settings below 25, and it effectively prevents | |
| 831 very small/low quality files from being generated. The IJG decoder | |
| 832 is capable of reading the non-baseline files generated at low quality | |
| 833 settings when force_baseline is FALSE, but other decoders may not be. | |
| 834 | |
| 835 jpeg_set_linear_quality (j_compress_ptr cinfo, int scale_factor, | |
| 836 boolean force_baseline) | |
| 837 Same as jpeg_set_quality() except that the generated tables are the | |
| 838 sample tables given in the JPEC spec section K.1, multiplied by the | |
| 839 specified scale factor (which is expressed as a percentage; thus | |
| 840 scale_factor = 100 reproduces the spec's tables). Note that larger | |
| 841 scale factors give lower quality. This entry point is useful for | |
| 842 conforming to the Adobe PostScript DCT conventions, but we do not | |
| 843 recommend linear scaling as a user-visible quality scale otherwise. | |
| 844 force_baseline again constrains the computed table entries to 1..255. | |
| 845 | |
| 846 int jpeg_quality_scaling (int quality) | |
| 847 Converts a value on the IJG-recommended quality scale to a linear | |
| 848 scaling percentage. Note that this routine may change or go away | |
| 849 in future releases --- IJG may choose to adopt a scaling method that | |
| 850 can't be expressed as a simple scalar multiplier, in which case the | |
| 851 premise of this routine collapses. Caveat user. | |
| 852 | |
| 853 jpeg_default_qtables (j_compress_ptr cinfo, boolean force_baseline) | |
| 854 Set default quantization tables with linear q_scale_factor[] values | |
| 855 (see below). | |
| 856 | |
| 857 jpeg_add_quant_table (j_compress_ptr cinfo, int which_tbl, | |
| 858 const unsigned int *basic_table, | |
| 859 int scale_factor, boolean force_baseline) | |
| 860 Allows an arbitrary quantization table to be created. which_tbl | |
| 861 indicates which table slot to fill. basic_table points to an array | |
| 862 of 64 unsigned ints given in normal array order. These values are | |
| 863 multiplied by scale_factor/100 and then clamped to the range 1..65535 | |
| 864 (or to 1..255 if force_baseline is TRUE). | |
| 865 CAUTION: prior to library version 6a, jpeg_add_quant_table expected | |
| 866 the basic table to be given in JPEG zigzag order. If you need to | |
| 867 write code that works with either older or newer versions of this | |
| 868 routine, you must check the library version number. Something like | |
| 869 "#if JPEG_LIB_VERSION >= 61" is the right test. | |
| 870 | |
| 871 jpeg_simple_progression (j_compress_ptr cinfo) | |
| 872 Generates a default scan script for writing a progressive-JPEG file. | |
| 873 This is the recommended method of creating a progressive file, | |
| 874 unless you want to make a custom scan sequence. You must ensure that | |
| 875 the JPEG color space is set correctly before calling this routine. | |
| 876 | |
| 877 | |
| 878 Compression parameters (cinfo fields) include: | |
| 879 | |
| 880 boolean arith_code | |
| 881 If TRUE, use arithmetic coding. | |
| 882 If FALSE, use Huffman coding. | |
| 883 | |
| 884 int block_size | |
| 885 Set DCT block size. All N from 1 to 16 are possible. | |
| 886 Default is 8 (baseline format). | |
| 887 Larger values produce higher compression, | |
| 888 smaller values produce higher quality. | |
| 889 An exact DCT stage is possible with 1 or 2. | |
| 890 With the default quality of 75 and default quantization tables | |
| 891 the DCT+Quantization stage is lossless for value 1. | |
| 892 Note that values other than 8 require a SmartScale capable decoder, | |
| 893 introduced with IJG JPEG 8. Setting the block_size parameter for | |
| 894 compression works with version 8c and later. | |
| 895 | |
| 896 J_DCT_METHOD dct_method | |
| 897 Selects the algorithm used for the DCT step. Choices are: | |
| 898 JDCT_ISLOW: slow but accurate integer algorithm | |
| 899 JDCT_IFAST: faster, less accurate integer method | |
| 900 JDCT_FLOAT: floating-point method | |
| 901 JDCT_DEFAULT: default method (normally JDCT_ISLOW) | |
| 902 JDCT_FASTEST: fastest method (normally JDCT_IFAST) | |
| 903 The FLOAT method is very slightly more accurate than the ISLOW method, | |
| 904 but may give different results on different machines due to varying | |
| 905 roundoff behavior. The integer methods should give the same results | |
| 906 on all machines. On machines with sufficiently fast FP hardware, the | |
| 907 floating-point method may also be the fastest. The IFAST method is | |
| 908 considerably less accurate than the other two; its use is not | |
| 909 recommended if high quality is a concern. JDCT_DEFAULT and | |
| 910 JDCT_FASTEST are macros configurable by each installation. | |
| 911 | |
| 912 unsigned int scale_num, scale_denom | |
| 913 Scale the image by the fraction scale_num/scale_denom. Default is | |
| 914 1/1, or no scaling. Currently, the supported scaling ratios are | |
| 915 M/N with all N from 1 to 16, where M is the destination DCT size, | |
| 916 which is 8 by default (see block_size parameter above). | |
| 917 (The library design allows for arbitrary scaling ratios but this | |
| 918 is not likely to be implemented any time soon.) | |
| 919 | |
| 920 J_COLOR_SPACE jpeg_color_space | |
| 921 int num_components | |
| 922 The JPEG color space and corresponding number of components; see | |
| 923 "Special color spaces", below, for more info. We recommend using | |
| 924 jpeg_set_colorspace() if you want to change these. | |
| 925 | |
| 926 J_COLOR_TRANSFORM color_transform | |
| 927 Internal color transform identifier, writes LSE marker if nonzero | |
| 928 (requires decoder with inverse color transform support, introduced | |
| 929 with IJG JPEG 9). | |
| 930 Two values are currently possible: JCT_NONE and JCT_SUBTRACT_GREEN. | |
| 931 Set this value for lossless RGB application *before* calling | |
| 932 jpeg_set_colorspace(), because entropy table assignment in | |
| 933 jpeg_set_colorspace() depends on color_transform. | |
| 934 | |
| 935 boolean optimize_coding | |
| 936 TRUE causes the compressor to compute optimal Huffman coding tables | |
| 937 for the image. This requires an extra pass over the data and | |
| 938 therefore costs a good deal of space and time. The default is | |
| 939 FALSE, which tells the compressor to use the supplied or default | |
| 940 Huffman tables. In most cases optimal tables save only a few percent | |
| 941 of file size compared to the default tables. Note that when this is | |
| 942 TRUE, you need not supply Huffman tables at all, and any you do | |
| 943 supply will be overwritten. | |
| 944 | |
| 945 unsigned int restart_interval | |
| 946 int restart_in_rows | |
| 947 To emit restart markers in the JPEG file, set one of these nonzero. | |
| 948 Set restart_interval to specify the exact interval in MCU blocks. | |
| 949 Set restart_in_rows to specify the interval in MCU rows. (If | |
| 950 restart_in_rows is not 0, then restart_interval is set after the | |
| 951 image width in MCUs is computed.) Defaults are zero (no restarts). | |
| 952 One restart marker per MCU row is often a good choice. | |
| 953 NOTE: the overhead of restart markers is higher in grayscale JPEG | |
| 954 files than in color files, and MUCH higher in progressive JPEGs. | |
| 955 If you use restarts, you may want to use larger intervals in those | |
| 956 cases. | |
| 957 | |
| 958 const jpeg_scan_info * scan_info | |
| 959 int num_scans | |
| 960 By default, scan_info is NULL; this causes the compressor to write a | |
| 961 single-scan sequential JPEG file. If not NULL, scan_info points to | |
| 962 an array of scan definition records of length num_scans. The | |
| 963 compressor will then write a JPEG file having one scan for each scan | |
| 964 definition record. This is used to generate noninterleaved or | |
| 965 progressive JPEG files. The library checks that the scan array | |
| 966 defines a valid JPEG scan sequence. (jpeg_simple_progression creates | |
| 967 a suitable scan definition array for progressive JPEG.) This is | |
| 968 discussed further under "Progressive JPEG support". | |
| 969 | |
| 970 boolean do_fancy_downsampling | |
| 971 If TRUE, use direct DCT scaling with DCT size > 8 for downsampling | |
| 972 of chroma components. | |
| 973 If FALSE, use only DCT size <= 8 and simple separate downsampling. | |
| 974 Default is TRUE. | |
| 975 For better image stability in multiple generation compression cycles | |
| 976 it is preferable that this value matches the corresponding | |
| 977 do_fancy_upsampling value in decompression. | |
| 978 | |
| 979 int smoothing_factor | |
| 980 If non-zero, the input image is smoothed; the value should be 1 for | |
| 981 minimal smoothing to 100 for maximum smoothing. Consult jcsample.c | |
| 982 for details of the smoothing algorithm. The default is zero. | |
| 983 | |
| 984 boolean write_JFIF_header | |
| 985 If TRUE, a JFIF APP0 marker is emitted. jpeg_set_defaults() and | |
| 986 jpeg_set_colorspace() set this TRUE if a JFIF-legal JPEG color space | |
| 987 (ie, YCbCr or grayscale) is selected, otherwise FALSE. | |
| 988 | |
| 989 UINT8 JFIF_major_version | |
| 990 UINT8 JFIF_minor_version | |
| 991 The version number to be written into the JFIF marker. | |
| 992 jpeg_set_defaults() initializes the version to 1.01 (major=minor=1). | |
| 993 You should set it to 1.02 (major=1, minor=2) if you plan to write | |
| 994 any JFIF 1.02 extension markers. | |
| 995 | |
| 996 UINT8 density_unit | |
| 997 UINT16 X_density | |
| 998 UINT16 Y_density | |
| 999 The resolution information to be written into the JFIF marker; | |
| 1000 not used otherwise. density_unit may be 0 for unknown, | |
| 1001 1 for dots/inch, or 2 for dots/cm. The default values are 0,1,1 | |
| 1002 indicating square pixels of unknown size. | |
| 1003 | |
| 1004 boolean write_Adobe_marker | |
| 1005 If TRUE, an Adobe APP14 marker is emitted. jpeg_set_defaults() and | |
| 1006 jpeg_set_colorspace() set this TRUE if JPEG color space RGB, CMYK, | |
| 1007 or YCCK is selected, otherwise FALSE. It is generally a bad idea | |
| 1008 to set both write_JFIF_header and write_Adobe_marker. In fact, | |
| 1009 you probably shouldn't change the default settings at all --- the | |
| 1010 default behavior ensures that the JPEG file's color space can be | |
| 1011 recognized by the decoder. | |
| 1012 | |
| 1013 JQUANT_TBL * quant_tbl_ptrs[NUM_QUANT_TBLS] | |
| 1014 Pointers to coefficient quantization tables, one per table slot, | |
| 1015 or NULL if no table is defined for a slot. Usually these should | |
| 1016 be set via one of the above helper routines; jpeg_add_quant_table() | |
| 1017 is general enough to define any quantization table. The other | |
| 1018 routines will set up table slot 0 for luminance quality and table | |
| 1019 slot 1 for chrominance. | |
| 1020 | |
| 1021 int q_scale_factor[NUM_QUANT_TBLS] | |
| 1022 Linear quantization scaling factors (percentage, initialized 100) | |
| 1023 for use with jpeg_default_qtables(). | |
| 1024 See rdswitch.c and cjpeg.c for an example of usage. | |
| 1025 Note that the q_scale_factor[] fields are the "linear" scales, so you | |
| 1026 have to convert from user-defined ratings via jpeg_quality_scaling(). | |
| 1027 Here is an example code which corresponds to cjpeg -quality 90,70: | |
| 1028 | |
| 1029 jpeg_set_defaults(cinfo); | |
| 1030 | |
| 1031 /* Set luminance quality 90. */ | |
| 1032 cinfo->q_scale_factor[0] = jpeg_quality_scaling(90); | |
| 1033 /* Set chrominance quality 70. */ | |
| 1034 cinfo->q_scale_factor[1] = jpeg_quality_scaling(70); | |
| 1035 | |
| 1036 jpeg_default_qtables(cinfo, force_baseline); | |
| 1037 | |
| 1038 CAUTION: You must also set 1x1 subsampling for efficient separate | |
| 1039 color quality selection, since the default value used by library | |
| 1040 is 2x2: | |
| 1041 | |
| 1042 cinfo->comp_info[0].v_samp_factor = 1; | |
| 1043 cinfo->comp_info[0].h_samp_factor = 1; | |
| 1044 | |
| 1045 JHUFF_TBL * dc_huff_tbl_ptrs[NUM_HUFF_TBLS] | |
| 1046 JHUFF_TBL * ac_huff_tbl_ptrs[NUM_HUFF_TBLS] | |
| 1047 Pointers to Huffman coding tables, one per table slot, or NULL if | |
| 1048 no table is defined for a slot. Slots 0 and 1 are filled with the | |
| 1049 JPEG sample tables by jpeg_set_defaults(). If you need to allocate | |
| 1050 more table structures, jpeg_alloc_huff_table() may be used. | |
| 1051 Note that optimal Huffman tables can be computed for an image | |
| 1052 by setting optimize_coding, as discussed above; there's seldom | |
| 1053 any need to mess with providing your own Huffman tables. | |
| 1054 | |
| 1055 | |
| 1056 The actual dimensions of the JPEG image that will be written to the file are | |
| 1057 given by the following fields. These are computed from the input image | |
| 1058 dimensions and the compression parameters by jpeg_start_compress(). You can | |
| 1059 also call jpeg_calc_jpeg_dimensions() to obtain the values that will result | |
| 1060 from the current parameter settings. This can be useful if you are trying | |
| 1061 to pick a scaling ratio that will get close to a desired target size. | |
| 1062 | |
| 1063 JDIMENSION jpeg_width Actual dimensions of output image. | |
| 1064 JDIMENSION jpeg_height | |
| 1065 | |
| 1066 | |
| 1067 Per-component parameters are stored in the struct cinfo.comp_info[i] for | |
| 1068 component number i. Note that components here refer to components of the | |
| 1069 JPEG color space, *not* the source image color space. A suitably large | |
| 1070 comp_info[] array is allocated by jpeg_set_defaults(); if you choose not | |
| 1071 to use that routine, it's up to you to allocate the array. | |
| 1072 | |
| 1073 int component_id | |
| 1074 The one-byte identifier code to be recorded in the JPEG file for | |
| 1075 this component. For the standard color spaces, we recommend you | |
| 1076 leave the default values alone. | |
| 1077 | |
| 1078 int h_samp_factor | |
| 1079 int v_samp_factor | |
| 1080 Horizontal and vertical sampling factors for the component; must | |
| 1081 be 1..4 according to the JPEG standard. Note that larger sampling | |
| 1082 factors indicate a higher-resolution component; many people find | |
| 1083 this behavior quite unintuitive. The default values are 2,2 for | |
| 1084 luminance components and 1,1 for chrominance components, except | |
| 1085 for grayscale where 1,1 is used. | |
| 1086 | |
| 1087 int quant_tbl_no | |
| 1088 Quantization table number for component. The default value is | |
| 1089 0 for luminance components and 1 for chrominance components. | |
| 1090 | |
| 1091 int dc_tbl_no | |
| 1092 int ac_tbl_no | |
| 1093 DC and AC entropy coding table numbers. The default values are | |
| 1094 0 for luminance components and 1 for chrominance components. | |
| 1095 | |
| 1096 int component_index | |
| 1097 Must equal the component's index in comp_info[]. (Beginning in | |
| 1098 release v6, the compressor library will fill this in automatically; | |
| 1099 you don't have to.) | |
| 1100 | |
| 1101 | |
| 1102 Decompression parameter selection | |
| 1103 --------------------------------- | |
| 1104 | |
| 1105 Decompression parameter selection is somewhat simpler than compression | |
| 1106 parameter selection, since all of the JPEG internal parameters are | |
| 1107 recorded in the source file and need not be supplied by the application. | |
| 1108 (Unless you are working with abbreviated files, in which case see | |
| 1109 "Abbreviated datastreams", below.) Decompression parameters control | |
| 1110 the postprocessing done on the image to deliver it in a format suitable | |
| 1111 for the application's use. Many of the parameters control speed/quality | |
| 1112 tradeoffs, in which faster decompression may be obtained at the price of | |
| 1113 a poorer-quality image. The defaults select the highest quality (slowest) | |
| 1114 processing. | |
| 1115 | |
| 1116 The following fields in the JPEG object are set by jpeg_read_header() and | |
| 1117 may be useful to the application in choosing decompression parameters: | |
| 1118 | |
| 1119 JDIMENSION image_width Width and height of image | |
| 1120 JDIMENSION image_height | |
| 1121 int num_components Number of color components | |
| 1122 J_COLOR_SPACE jpeg_color_space Colorspace of image | |
| 1123 boolean saw_JFIF_marker TRUE if a JFIF APP0 marker was seen | |
| 1124 UINT8 JFIF_major_version Version information from JFIF marker | |
| 1125 UINT8 JFIF_minor_version | |
| 1126 UINT8 density_unit Resolution data from JFIF marker | |
| 1127 UINT16 X_density | |
| 1128 UINT16 Y_density | |
| 1129 boolean saw_Adobe_marker TRUE if an Adobe APP14 marker was seen | |
| 1130 UINT8 Adobe_transform Color transform code from Adobe marker | |
| 1131 | |
| 1132 The JPEG color space, unfortunately, is something of a guess since the JPEG | |
| 1133 standard proper does not provide a way to record it. In practice most files | |
| 1134 adhere to the JFIF or Adobe conventions, and the decoder will recognize these | |
| 1135 correctly. See "Special color spaces", below, for more info. | |
| 1136 | |
| 1137 | |
| 1138 The decompression parameters that determine the basic properties of the | |
| 1139 returned image are: | |
| 1140 | |
| 1141 J_COLOR_SPACE out_color_space | |
| 1142 Output color space. jpeg_read_header() sets an appropriate default | |
| 1143 based on jpeg_color_space; typically it will be RGB or grayscale. | |
| 1144 The application can change this field to request output in a different | |
| 1145 colorspace. For example, set it to JCS_GRAYSCALE to get grayscale | |
| 1146 output from a color file. (This is useful for previewing: grayscale | |
| 1147 output is faster than full color since the color components need not | |
| 1148 be processed.) Note that not all possible color space transforms are | |
| 1149 currently implemented; you may need to extend jdcolor.c if you want an | |
| 1150 unusual conversion. | |
| 1151 | |
| 1152 unsigned int scale_num, scale_denom | |
| 1153 Scale the image by the fraction scale_num/scale_denom. Currently, | |
| 1154 the supported scaling ratios are M/N with all M from 1 to 16, where | |
| 1155 N is the source DCT size, which is 8 for baseline JPEG. (The library | |
| 1156 design allows for arbitrary scaling ratios but this is not likely | |
| 1157 to be implemented any time soon.) The values are initialized by | |
| 1158 jpeg_read_header() with the source DCT size. For baseline JPEG | |
| 1159 this is 8/8. If you change only the scale_num value while leaving | |
| 1160 the other unchanged, then this specifies the DCT scaled size to be | |
| 1161 applied on the given input. For baseline JPEG this is equivalent | |
| 1162 to M/8 scaling, since the source DCT size for baseline JPEG is 8. | |
| 1163 Smaller scaling ratios permit significantly faster decoding since | |
| 1164 fewer pixels need be processed and a simpler IDCT method can be used. | |
| 1165 | |
| 1166 boolean quantize_colors | |
| 1167 If set TRUE, colormapped output will be delivered. Default is FALSE, | |
| 1168 meaning that full-color output will be delivered. | |
| 1169 | |
| 1170 The next three parameters are relevant only if quantize_colors is TRUE. | |
| 1171 | |
| 1172 int desired_number_of_colors | |
| 1173 Maximum number of colors to use in generating a library-supplied color | |
| 1174 map (the actual number of colors is returned in a different field). | |
| 1175 Default 256. Ignored when the application supplies its own color map. | |
| 1176 | |
| 1177 boolean two_pass_quantize | |
| 1178 If TRUE, an extra pass over the image is made to select a custom color | |
| 1179 map for the image. This usually looks a lot better than the one-size- | |
| 1180 fits-all colormap that is used otherwise. Default is TRUE. Ignored | |
| 1181 when the application supplies its own color map. | |
| 1182 | |
| 1183 J_DITHER_MODE dither_mode | |
| 1184 Selects color dithering method. Supported values are: | |
| 1185 JDITHER_NONE no dithering: fast, very low quality | |
| 1186 JDITHER_ORDERED ordered dither: moderate speed and quality | |
| 1187 JDITHER_FS Floyd-Steinberg dither: slow, high quality | |
| 1188 Default is JDITHER_FS. (At present, ordered dither is implemented | |
| 1189 only in the single-pass, standard-colormap case. If you ask for | |
| 1190 ordered dither when two_pass_quantize is TRUE or when you supply | |
| 1191 an external color map, you'll get F-S dithering.) | |
| 1192 | |
| 1193 When quantize_colors is TRUE, the target color map is described by the next | |
| 1194 two fields. colormap is set to NULL by jpeg_read_header(). The application | |
| 1195 can supply a color map by setting colormap non-NULL and setting | |
| 1196 actual_number_of_colors to the map size. Otherwise, jpeg_start_decompress() | |
| 1197 selects a suitable color map and sets these two fields itself. | |
| 1198 [Implementation restriction: at present, an externally supplied colormap is | |
| 1199 only accepted for 3-component output color spaces.] | |
| 1200 | |
| 1201 JSAMPARRAY colormap | |
| 1202 The color map, represented as a 2-D pixel array of out_color_components | |
| 1203 rows and actual_number_of_colors columns. Ignored if not quantizing. | |
| 1204 CAUTION: if the JPEG library creates its own colormap, the storage | |
| 1205 pointed to by this field is released by jpeg_finish_decompress(). | |
| 1206 Copy the colormap somewhere else first, if you want to save it. | |
| 1207 | |
| 1208 int actual_number_of_colors | |
| 1209 The number of colors in the color map. | |
| 1210 | |
| 1211 Additional decompression parameters that the application may set include: | |
| 1212 | |
| 1213 J_DCT_METHOD dct_method | |
| 1214 Selects the algorithm used for the DCT step. Choices are the same | |
| 1215 as described above for compression. | |
| 1216 | |
| 1217 boolean do_fancy_upsampling | |
| 1218 If TRUE, use direct DCT scaling with DCT size > 8 for upsampling | |
| 1219 of chroma components. | |
| 1220 If FALSE, use only DCT size <= 8 and simple separate upsampling. | |
| 1221 Default is TRUE. | |
| 1222 For better image stability in multiple generation compression cycles | |
| 1223 it is preferable that this value matches the corresponding | |
| 1224 do_fancy_downsampling value in compression. | |
| 1225 | |
| 1226 boolean do_block_smoothing | |
| 1227 If TRUE, interblock smoothing is applied in early stages of decoding | |
| 1228 progressive JPEG files; if FALSE, not. Default is TRUE. Early | |
| 1229 progression stages look "fuzzy" with smoothing, "blocky" without. | |
| 1230 In any case, block smoothing ceases to be applied after the first few | |
| 1231 AC coefficients are known to full accuracy, so it is relevant only | |
| 1232 when using buffered-image mode for progressive images. | |
| 1233 | |
| 1234 boolean enable_1pass_quant | |
| 1235 boolean enable_external_quant | |
| 1236 boolean enable_2pass_quant | |
| 1237 These are significant only in buffered-image mode, which is | |
| 1238 described in its own section below. | |
| 1239 | |
| 1240 | |
| 1241 The output image dimensions are given by the following fields. These are | |
| 1242 computed from the source image dimensions and the decompression parameters | |
| 1243 by jpeg_start_decompress(). You can also call jpeg_calc_output_dimensions() | |
| 1244 to obtain the values that will result from the current parameter settings. | |
| 1245 This can be useful if you are trying to pick a scaling ratio that will get | |
| 1246 close to a desired target size. It's also important if you are using the | |
| 1247 JPEG library's memory manager to allocate output buffer space, because you | |
| 1248 are supposed to request such buffers *before* jpeg_start_decompress(). | |
| 1249 | |
| 1250 JDIMENSION output_width Actual dimensions of output image. | |
| 1251 JDIMENSION output_height | |
| 1252 int out_color_components Number of color components in out_color_space. | |
| 1253 int output_components Number of color components returned. | |
| 1254 int rec_outbuf_height Recommended height of scanline buffer. | |
| 1255 | |
| 1256 When quantizing colors, output_components is 1, indicating a single color map | |
| 1257 index per pixel. Otherwise it equals out_color_components. The output arrays | |
| 1258 are required to be output_width * output_components JSAMPLEs wide. | |
| 1259 | |
| 1260 rec_outbuf_height is the recommended minimum height (in scanlines) of the | |
| 1261 buffer passed to jpeg_read_scanlines(). If the buffer is smaller, the | |
| 1262 library will still work, but time will be wasted due to unnecessary data | |
| 1263 copying. In high-quality modes, rec_outbuf_height is always 1, but some | |
| 1264 faster, lower-quality modes set it to larger values (typically 2 to 4). | |
| 1265 If you are going to ask for a high-speed processing mode, you may as well | |
| 1266 go to the trouble of honoring rec_outbuf_height so as to avoid data copying. | |
| 1267 (An output buffer larger than rec_outbuf_height lines is OK, but won't | |
| 1268 provide any material speed improvement over that height.) | |
| 1269 | |
| 1270 | |
| 1271 Special color spaces | |
| 1272 -------------------- | |
| 1273 | |
| 1274 The JPEG standard itself is "color blind" and doesn't specify any particular | |
| 1275 color space. It is customary to convert color data to a luminance/chrominance | |
| 1276 color space before compressing, since this permits greater compression. The | |
| 1277 existing JPEG file interchange format standards specify YCbCr or GRAYSCALE | |
| 1278 data (JFIF version 1), GRAYSCALE, RGB, YCbCr, CMYK, or YCCK (Adobe), or BG_RGB | |
| 1279 or BG_YCC (big gamut color spaces, JFIF version 2). For special applications | |
| 1280 such as multispectral images, other color spaces can be used, | |
| 1281 but it must be understood that such files will be unportable. | |
| 1282 | |
| 1283 The JPEG library can handle the most common colorspace conversions (namely | |
| 1284 RGB <=> YCbCr and CMYK <=> YCCK). It can also deal with data of an unknown | |
| 1285 color space, passing it through without conversion. If you deal extensively | |
| 1286 with an unusual color space, you can easily extend the library to understand | |
| 1287 additional color spaces and perform appropriate conversions. | |
| 1288 | |
| 1289 For compression, the source data's color space is specified by field | |
| 1290 in_color_space. This is transformed to the JPEG file's color space given | |
| 1291 by jpeg_color_space. jpeg_set_defaults() chooses a reasonable JPEG color | |
| 1292 space depending on in_color_space, but you can override this by calling | |
| 1293 jpeg_set_colorspace(). Of course you must select a supported transformation. | |
| 1294 jccolor.c currently supports the following transformations: | |
| 1295 RGB => YCbCr | |
| 1296 RGB => GRAYSCALE | |
| 1297 RGB => BG_YCC | |
| 1298 YCbCr => GRAYSCALE | |
| 1299 YCbCr => BG_YCC | |
| 1300 CMYK => YCCK | |
| 1301 plus the null transforms: GRAYSCALE => GRAYSCALE, RGB => RGB, | |
| 1302 BG_RGB => BG_RGB, YCbCr => YCbCr, BG_YCC => BG_YCC, CMYK => CMYK, | |
| 1303 YCCK => YCCK, and UNKNOWN => UNKNOWN. | |
| 1304 | |
| 1305 The file interchange format standards (JFIF and Adobe) specify APPn markers | |
| 1306 that indicate the color space of the JPEG file. It is important to ensure | |
| 1307 that these are written correctly, or omitted if the JPEG file's color space | |
| 1308 is not one of the ones supported by the interchange standards. | |
| 1309 jpeg_set_colorspace() will set the compression parameters to include or omit | |
| 1310 the APPn markers properly, so long as it is told the truth about the JPEG | |
| 1311 color space. For example, if you are writing some random 3-component color | |
| 1312 space without conversion, don't try to fake out the library by setting | |
| 1313 in_color_space and jpeg_color_space to JCS_YCbCr; use JCS_UNKNOWN. | |
| 1314 You may want to write an APPn marker of your own devising to identify | |
| 1315 the colorspace --- see "Special markers", below. | |
| 1316 | |
| 1317 When told that the color space is UNKNOWN, the library will default to using | |
| 1318 luminance-quality compression parameters for all color components. You may | |
| 1319 well want to change these parameters. See the source code for | |
| 1320 jpeg_set_colorspace(), in jcparam.c, for details. | |
| 1321 | |
| 1322 For decompression, the JPEG file's color space is given in jpeg_color_space, | |
| 1323 and this is transformed to the output color space out_color_space. | |
| 1324 jpeg_read_header's setting of jpeg_color_space can be relied on if the file | |
| 1325 conforms to JFIF or Adobe conventions, but otherwise it is no better than a | |
| 1326 guess. If you know the JPEG file's color space for certain, you can override | |
| 1327 jpeg_read_header's guess by setting jpeg_color_space. jpeg_read_header also | |
| 1328 selects a default output color space based on (its guess of) jpeg_color_space; | |
| 1329 set out_color_space to override this. Again, you must select a supported | |
| 1330 transformation. jdcolor.c currently supports | |
| 1331 YCbCr => RGB | |
| 1332 YCbCr => GRAYSCALE | |
| 1333 BG_YCC => RGB | |
| 1334 BG_YCC => GRAYSCALE | |
| 1335 RGB => GRAYSCALE | |
| 1336 GRAYSCALE => RGB | |
| 1337 YCCK => CMYK | |
| 1338 as well as the null transforms. (Since GRAYSCALE=>RGB is provided, an | |
| 1339 application can force grayscale JPEGs to look like color JPEGs if it only | |
| 1340 wants to handle one case.) | |
| 1341 | |
| 1342 The two-pass color quantizer, jquant2.c, is specialized to handle RGB data | |
| 1343 (it weights distances appropriately for RGB colors). You'll need to modify | |
| 1344 the code if you want to use it for non-RGB output color spaces. Note that | |
| 1345 jquant2.c is used to map to an application-supplied colormap as well as for | |
| 1346 the normal two-pass colormap selection process. | |
| 1347 | |
| 1348 CAUTION: it appears that Adobe Photoshop writes inverted data in CMYK JPEG | |
| 1349 files: 0 represents 100% ink coverage, rather than 0% ink as you'd expect. | |
| 1350 This is arguably a bug in Photoshop, but if you need to work with Photoshop | |
| 1351 CMYK files, you will have to deal with it in your application. We cannot | |
| 1352 "fix" this in the library by inverting the data during the CMYK<=>YCCK | |
| 1353 transform, because that would break other applications, notably Ghostscript. | |
| 1354 Photoshop versions prior to 3.0 write EPS files containing JPEG-encoded CMYK | |
| 1355 data in the same inverted-YCCK representation used in bare JPEG files, but | |
| 1356 the surrounding PostScript code performs an inversion using the PS image | |
| 1357 operator. I am told that Photoshop 3.0 will write uninverted YCCK in | |
| 1358 EPS/JPEG files, and will omit the PS-level inversion. (But the data | |
| 1359 polarity used in bare JPEG files will not change in 3.0.) In either case, | |
| 1360 the JPEG library must not invert the data itself, or else Ghostscript would | |
| 1361 read these EPS files incorrectly. | |
| 1362 | |
| 1363 | |
| 1364 Error handling | |
| 1365 -------------- | |
| 1366 | |
| 1367 When the default error handler is used, any error detected inside the JPEG | |
| 1368 routines will cause a message to be printed on stderr, followed by exit(). | |
| 1369 You can supply your own error handling routines to override this behavior | |
| 1370 and to control the treatment of nonfatal warnings and trace/debug messages. | |
| 1371 The file example.c illustrates the most common case, which is to have the | |
| 1372 application regain control after an error rather than exiting. | |
| 1373 | |
| 1374 The JPEG library never writes any message directly; it always goes through | |
| 1375 the error handling routines. Three classes of messages are recognized: | |
| 1376 * Fatal errors: the library cannot continue. | |
| 1377 * Warnings: the library can continue, but the data is corrupt, and a | |
| 1378 damaged output image is likely to result. | |
| 1379 * Trace/informational messages. These come with a trace level indicating | |
| 1380 the importance of the message; you can control the verbosity of the | |
| 1381 program by adjusting the maximum trace level that will be displayed. | |
| 1382 | |
| 1383 You may, if you wish, simply replace the entire JPEG error handling module | |
| 1384 (jerror.c) with your own code. However, you can avoid code duplication by | |
| 1385 only replacing some of the routines depending on the behavior you need. | |
| 1386 This is accomplished by calling jpeg_std_error() as usual, but then overriding | |
| 1387 some of the method pointers in the jpeg_error_mgr struct, as illustrated by | |
| 1388 example.c. | |
| 1389 | |
| 1390 All of the error handling routines will receive a pointer to the JPEG object | |
| 1391 (a j_common_ptr which points to either a jpeg_compress_struct or a | |
| 1392 jpeg_decompress_struct; if you need to tell which, test the is_decompressor | |
| 1393 field). This struct includes a pointer to the error manager struct in its | |
| 1394 "err" field. Frequently, custom error handler routines will need to access | |
| 1395 additional data which is not known to the JPEG library or the standard error | |
| 1396 handler. The most convenient way to do this is to embed either the JPEG | |
| 1397 object or the jpeg_error_mgr struct in a larger structure that contains | |
| 1398 additional fields; then casting the passed pointer provides access to the | |
| 1399 additional fields. Again, see example.c for one way to do it. (Beginning | |
| 1400 with IJG version 6b, there is also a void pointer "client_data" in each | |
| 1401 JPEG object, which the application can also use to find related data. | |
| 1402 The library does not touch client_data at all.) | |
| 1403 | |
| 1404 The individual methods that you might wish to override are: | |
| 1405 | |
| 1406 error_exit (j_common_ptr cinfo) | |
| 1407 Receives control for a fatal error. Information sufficient to | |
| 1408 generate the error message has been stored in cinfo->err; call | |
| 1409 output_message to display it. Control must NOT return to the caller; | |
| 1410 generally this routine will exit() or longjmp() somewhere. | |
| 1411 Typically you would override this routine to get rid of the exit() | |
| 1412 default behavior. Note that if you continue processing, you should | |
| 1413 clean up the JPEG object with jpeg_abort() or jpeg_destroy(). | |
| 1414 | |
| 1415 output_message (j_common_ptr cinfo) | |
| 1416 Actual output of any JPEG message. Override this to send messages | |
| 1417 somewhere other than stderr. Note that this method does not know | |
| 1418 how to generate a message, only where to send it. | |
| 1419 | |
| 1420 format_message (j_common_ptr cinfo, char * buffer) | |
| 1421 Constructs a readable error message string based on the error info | |
| 1422 stored in cinfo->err. This method is called by output_message. Few | |
| 1423 applications should need to override this method. One possible | |
| 1424 reason for doing so is to implement dynamic switching of error message | |
| 1425 language. | |
| 1426 | |
| 1427 emit_message (j_common_ptr cinfo, int msg_level) | |
| 1428 Decide whether or not to emit a warning or trace message; if so, | |
| 1429 calls output_message. The main reason for overriding this method | |
| 1430 would be to abort on warnings. msg_level is -1 for warnings, | |
| 1431 0 and up for trace messages. | |
| 1432 | |
| 1433 Only error_exit() and emit_message() are called from the rest of the JPEG | |
| 1434 library; the other two are internal to the error handler. | |
| 1435 | |
| 1436 The actual message texts are stored in an array of strings which is pointed to | |
| 1437 by the field err->jpeg_message_table. The messages are numbered from 0 to | |
| 1438 err->last_jpeg_message, and it is these code numbers that are used in the | |
| 1439 JPEG library code. You could replace the message texts (for instance, with | |
| 1440 messages in French or German) by changing the message table pointer. See | |
| 1441 jerror.h for the default texts. CAUTION: this table will almost certainly | |
| 1442 change or grow from one library version to the next. | |
| 1443 | |
| 1444 It may be useful for an application to add its own message texts that are | |
| 1445 handled by the same mechanism. The error handler supports a second "add-on" | |
| 1446 message table for this purpose. To define an addon table, set the pointer | |
| 1447 err->addon_message_table and the message numbers err->first_addon_message and | |
| 1448 err->last_addon_message. If you number the addon messages beginning at 1000 | |
| 1449 or so, you won't have to worry about conflicts with the library's built-in | |
| 1450 messages. See the sample applications cjpeg/djpeg for an example of using | |
| 1451 addon messages (the addon messages are defined in cderror.h). | |
| 1452 | |
| 1453 Actual invocation of the error handler is done via macros defined in jerror.h: | |
| 1454 ERREXITn(...) for fatal errors | |
| 1455 WARNMSn(...) for corrupt-data warnings | |
| 1456 TRACEMSn(...) for trace and informational messages. | |
| 1457 These macros store the message code and any additional parameters into the | |
| 1458 error handler struct, then invoke the error_exit() or emit_message() method. | |
| 1459 The variants of each macro are for varying numbers of additional parameters. | |
| 1460 The additional parameters are inserted into the generated message using | |
| 1461 standard printf() format codes. | |
| 1462 | |
| 1463 See jerror.h and jerror.c for further details. | |
| 1464 | |
| 1465 | |
| 1466 Compressed data handling (source and destination managers) | |
| 1467 ---------------------------------------------------------- | |
| 1468 | |
| 1469 The JPEG compression library sends its compressed data to a "destination | |
| 1470 manager" module. The default destination manager just writes the data to a | |
| 1471 memory buffer or to a stdio stream, but you can provide your own manager to | |
| 1472 do something else. Similarly, the decompression library calls a "source | |
| 1473 manager" to obtain the compressed data; you can provide your own source | |
| 1474 manager if you want the data to come from somewhere other than a memory | |
| 1475 buffer or a stdio stream. | |
| 1476 | |
| 1477 In both cases, compressed data is processed a bufferload at a time: the | |
| 1478 destination or source manager provides a work buffer, and the library invokes | |
| 1479 the manager only when the buffer is filled or emptied. (You could define a | |
| 1480 one-character buffer to force the manager to be invoked for each byte, but | |
| 1481 that would be rather inefficient.) The buffer's size and location are | |
| 1482 controlled by the manager, not by the library. For example, the memory | |
| 1483 source manager just makes the buffer pointer and length point to the original | |
| 1484 data in memory. In this case the buffer-reload procedure will be invoked | |
| 1485 only if the decompressor ran off the end of the datastream, which would | |
| 1486 indicate an erroneous datastream. | |
| 1487 | |
| 1488 The work buffer is defined as an array of datatype JOCTET, which is generally | |
| 1489 "char" or "unsigned char". On a machine where char is not exactly 8 bits | |
| 1490 wide, you must define JOCTET as a wider data type and then modify the data | |
| 1491 source and destination modules to transcribe the work arrays into 8-bit units | |
| 1492 on external storage. | |
| 1493 | |
| 1494 A data destination manager struct contains a pointer and count defining the | |
| 1495 next byte to write in the work buffer and the remaining free space: | |
| 1496 | |
| 1497 JOCTET * next_output_byte; /* => next byte to write in buffer */ | |
| 1498 size_t free_in_buffer; /* # of byte spaces remaining in buffer */ | |
| 1499 | |
| 1500 The library increments the pointer and decrements the count until the buffer | |
| 1501 is filled. The manager's empty_output_buffer method must reset the pointer | |
| 1502 and count. The manager is expected to remember the buffer's starting address | |
| 1503 and total size in private fields not visible to the library. | |
| 1504 | |
| 1505 A data destination manager provides three methods: | |
| 1506 | |
| 1507 init_destination (j_compress_ptr cinfo) | |
| 1508 Initialize destination. This is called by jpeg_start_compress() | |
| 1509 before any data is actually written. It must initialize | |
| 1510 next_output_byte and free_in_buffer. free_in_buffer must be | |
| 1511 initialized to a positive value. | |
| 1512 | |
| 1513 empty_output_buffer (j_compress_ptr cinfo) | |
| 1514 This is called whenever the buffer has filled (free_in_buffer | |
| 1515 reaches zero). In typical applications, it should write out the | |
| 1516 *entire* buffer (use the saved start address and buffer length; | |
| 1517 ignore the current state of next_output_byte and free_in_buffer). | |
| 1518 Then reset the pointer & count to the start of the buffer, and | |
| 1519 return TRUE indicating that the buffer has been dumped. | |
| 1520 free_in_buffer must be set to a positive value when TRUE is | |
| 1521 returned. A FALSE return should only be used when I/O suspension is | |
| 1522 desired (this operating mode is discussed in the next section). | |
| 1523 | |
| 1524 term_destination (j_compress_ptr cinfo) | |
| 1525 Terminate destination --- called by jpeg_finish_compress() after all | |
| 1526 data has been written. In most applications, this must flush any | |
| 1527 data remaining in the buffer. Use either next_output_byte or | |
| 1528 free_in_buffer to determine how much data is in the buffer. | |
| 1529 | |
| 1530 term_destination() is NOT called by jpeg_abort() or jpeg_destroy(). If you | |
| 1531 want the destination manager to be cleaned up during an abort, you must do it | |
| 1532 yourself. | |
| 1533 | |
| 1534 You will also need code to create a jpeg_destination_mgr struct, fill in its | |
| 1535 method pointers, and insert a pointer to the struct into the "dest" field of | |
| 1536 the JPEG compression object. This can be done in-line in your setup code if | |
| 1537 you like, but it's probably cleaner to provide a separate routine similar to | |
| 1538 the jpeg_stdio_dest() or jpeg_mem_dest() routines of the supplied destination | |
| 1539 managers. | |
| 1540 | |
| 1541 Decompression source managers follow a parallel design, but with some | |
| 1542 additional frammishes. The source manager struct contains a pointer and count | |
| 1543 defining the next byte to read from the work buffer and the number of bytes | |
| 1544 remaining: | |
| 1545 | |
| 1546 const JOCTET * next_input_byte; /* => next byte to read from buffer */ | |
| 1547 size_t bytes_in_buffer; /* # of bytes remaining in buffer */ | |
| 1548 | |
| 1549 The library increments the pointer and decrements the count until the buffer | |
| 1550 is emptied. The manager's fill_input_buffer method must reset the pointer and | |
| 1551 count. In most applications, the manager must remember the buffer's starting | |
| 1552 address and total size in private fields not visible to the library. | |
| 1553 | |
| 1554 A data source manager provides five methods: | |
| 1555 | |
| 1556 init_source (j_decompress_ptr cinfo) | |
| 1557 Initialize source. This is called by jpeg_read_header() before any | |
| 1558 data is actually read. Unlike init_destination(), it may leave | |
| 1559 bytes_in_buffer set to 0 (in which case a fill_input_buffer() call | |
| 1560 will occur immediately). | |
| 1561 | |
| 1562 fill_input_buffer (j_decompress_ptr cinfo) | |
| 1563 This is called whenever bytes_in_buffer has reached zero and more | |
| 1564 data is wanted. In typical applications, it should read fresh data | |
| 1565 into the buffer (ignoring the current state of next_input_byte and | |
| 1566 bytes_in_buffer), reset the pointer & count to the start of the | |
| 1567 buffer, and return TRUE indicating that the buffer has been reloaded. | |
| 1568 It is not necessary to fill the buffer entirely, only to obtain at | |
| 1569 least one more byte. bytes_in_buffer MUST be set to a positive value | |
| 1570 if TRUE is returned. A FALSE return should only be used when I/O | |
| 1571 suspension is desired (this mode is discussed in the next section). | |
| 1572 | |
| 1573 skip_input_data (j_decompress_ptr cinfo, long num_bytes) | |
| 1574 Skip num_bytes worth of data. The buffer pointer and count should | |
| 1575 be advanced over num_bytes input bytes, refilling the buffer as | |
| 1576 needed. This is used to skip over a potentially large amount of | |
| 1577 uninteresting data (such as an APPn marker). In some applications | |
| 1578 it may be possible to optimize away the reading of the skipped data, | |
| 1579 but it's not clear that being smart is worth much trouble; large | |
| 1580 skips are uncommon. bytes_in_buffer may be zero on return. | |
| 1581 A zero or negative skip count should be treated as a no-op. | |
| 1582 | |
| 1583 resync_to_restart (j_decompress_ptr cinfo, int desired) | |
| 1584 This routine is called only when the decompressor has failed to find | |
| 1585 a restart (RSTn) marker where one is expected. Its mission is to | |
| 1586 find a suitable point for resuming decompression. For most | |
| 1587 applications, we recommend that you just use the default resync | |
| 1588 procedure, jpeg_resync_to_restart(). However, if you are able to back | |
| 1589 up in the input data stream, or if you have a-priori knowledge about | |
| 1590 the likely location of restart markers, you may be able to do better. | |
| 1591 Read the read_restart_marker() and jpeg_resync_to_restart() routines | |
| 1592 in jdmarker.c if you think you'd like to implement your own resync | |
| 1593 procedure. | |
| 1594 | |
| 1595 term_source (j_decompress_ptr cinfo) | |
| 1596 Terminate source --- called by jpeg_finish_decompress() after all | |
| 1597 data has been read. Often a no-op. | |
| 1598 | |
| 1599 For both fill_input_buffer() and skip_input_data(), there is no such thing | |
| 1600 as an EOF return. If the end of the file has been reached, the routine has | |
| 1601 a choice of exiting via ERREXIT() or inserting fake data into the buffer. | |
| 1602 In most cases, generating a warning message and inserting a fake EOI marker | |
| 1603 is the best course of action --- this will allow the decompressor to output | |
| 1604 however much of the image is there. In pathological cases, the decompressor | |
| 1605 may swallow the EOI and again demand data ... just keep feeding it fake EOIs. | |
| 1606 jdatasrc.c illustrates the recommended error recovery behavior. | |
| 1607 | |
| 1608 term_source() is NOT called by jpeg_abort() or jpeg_destroy(). If you want | |
| 1609 the source manager to be cleaned up during an abort, you must do it yourself. | |
| 1610 | |
| 1611 You will also need code to create a jpeg_source_mgr struct, fill in its method | |
| 1612 pointers, and insert a pointer to the struct into the "src" field of the JPEG | |
| 1613 decompression object. This can be done in-line in your setup code if you | |
| 1614 like, but it's probably cleaner to provide a separate routine similar to the | |
| 1615 jpeg_stdio_src() or jpeg_mem_src() routines of the supplied source managers. | |
| 1616 | |
| 1617 For more information, consult the memory and stdio source and destination | |
| 1618 managers in jdatasrc.c and jdatadst.c. | |
| 1619 | |
| 1620 | |
| 1621 I/O suspension | |
| 1622 -------------- | |
| 1623 | |
| 1624 Some applications need to use the JPEG library as an incremental memory-to- | |
| 1625 memory filter: when the compressed data buffer is filled or emptied, they want | |
| 1626 control to return to the outer loop, rather than expecting that the buffer can | |
| 1627 be emptied or reloaded within the data source/destination manager subroutine. | |
| 1628 The library supports this need by providing an "I/O suspension" mode, which we | |
| 1629 describe in this section. | |
| 1630 | |
| 1631 The I/O suspension mode is not a panacea: nothing is guaranteed about the | |
| 1632 maximum amount of time spent in any one call to the library, so it will not | |
| 1633 eliminate response-time problems in single-threaded applications. If you | |
| 1634 need guaranteed response time, we suggest you "bite the bullet" and implement | |
| 1635 a real multi-tasking capability. | |
| 1636 | |
| 1637 To use I/O suspension, cooperation is needed between the calling application | |
| 1638 and the data source or destination manager; you will always need a custom | |
| 1639 source/destination manager. (Please read the previous section if you haven't | |
| 1640 already.) The basic idea is that the empty_output_buffer() or | |
| 1641 fill_input_buffer() routine is a no-op, merely returning FALSE to indicate | |
| 1642 that it has done nothing. Upon seeing this, the JPEG library suspends | |
| 1643 operation and returns to its caller. The surrounding application is | |
| 1644 responsible for emptying or refilling the work buffer before calling the | |
| 1645 JPEG library again. | |
| 1646 | |
| 1647 Compression suspension: | |
| 1648 | |
| 1649 For compression suspension, use an empty_output_buffer() routine that returns | |
| 1650 FALSE; typically it will not do anything else. This will cause the | |
| 1651 compressor to return to the caller of jpeg_write_scanlines(), with the return | |
| 1652 value indicating that not all the supplied scanlines have been accepted. | |
| 1653 The application must make more room in the output buffer, adjust the output | |
| 1654 buffer pointer/count appropriately, and then call jpeg_write_scanlines() | |
| 1655 again, pointing to the first unconsumed scanline. | |
| 1656 | |
| 1657 When forced to suspend, the compressor will backtrack to a convenient stopping | |
| 1658 point (usually the start of the current MCU); it will regenerate some output | |
| 1659 data when restarted. Therefore, although empty_output_buffer() is only | |
| 1660 called when the buffer is filled, you should NOT write out the entire buffer | |
| 1661 after a suspension. Write only the data up to the current position of | |
| 1662 next_output_byte/free_in_buffer. The data beyond that point will be | |
| 1663 regenerated after resumption. | |
| 1664 | |
| 1665 Because of the backtracking behavior, a good-size output buffer is essential | |
| 1666 for efficiency; you don't want the compressor to suspend often. (In fact, an | |
| 1667 overly small buffer could lead to infinite looping, if a single MCU required | |
| 1668 more data than would fit in the buffer.) We recommend a buffer of at least | |
| 1669 several Kbytes. You may want to insert explicit code to ensure that you don't | |
| 1670 call jpeg_write_scanlines() unless there is a reasonable amount of space in | |
| 1671 the output buffer; in other words, flush the buffer before trying to compress | |
| 1672 more data. | |
| 1673 | |
| 1674 The compressor does not allow suspension while it is trying to write JPEG | |
| 1675 markers at the beginning and end of the file. This means that: | |
| 1676 * At the beginning of a compression operation, there must be enough free | |
| 1677 space in the output buffer to hold the header markers (typically 600 or | |
| 1678 so bytes). The recommended buffer size is bigger than this anyway, so | |
| 1679 this is not a problem as long as you start with an empty buffer. However, | |
| 1680 this restriction might catch you if you insert large special markers, such | |
| 1681 as a JFIF thumbnail image, without flushing the buffer afterwards. | |
| 1682 * When you call jpeg_finish_compress(), there must be enough space in the | |
| 1683 output buffer to emit any buffered data and the final EOI marker. In the | |
| 1684 current implementation, half a dozen bytes should suffice for this, but | |
| 1685 for safety's sake we recommend ensuring that at least 100 bytes are free | |
| 1686 before calling jpeg_finish_compress(). | |
| 1687 | |
| 1688 A more significant restriction is that jpeg_finish_compress() cannot suspend. | |
| 1689 This means you cannot use suspension with multi-pass operating modes, namely | |
| 1690 Huffman code optimization and multiple-scan output. Those modes write the | |
| 1691 whole file during jpeg_finish_compress(), which will certainly result in | |
| 1692 buffer overrun. (Note that this restriction applies only to compression, | |
| 1693 not decompression. The decompressor supports input suspension in all of its | |
| 1694 operating modes.) | |
| 1695 | |
| 1696 Decompression suspension: | |
| 1697 | |
| 1698 For decompression suspension, use a fill_input_buffer() routine that simply | |
| 1699 returns FALSE (except perhaps during error recovery, as discussed below). | |
| 1700 This will cause the decompressor to return to its caller with an indication | |
| 1701 that suspension has occurred. This can happen at four places: | |
| 1702 * jpeg_read_header(): will return JPEG_SUSPENDED. | |
| 1703 * jpeg_start_decompress(): will return FALSE, rather than its usual TRUE. | |
| 1704 * jpeg_read_scanlines(): will return the number of scanlines already | |
| 1705 completed (possibly 0). | |
| 1706 * jpeg_finish_decompress(): will return FALSE, rather than its usual TRUE. | |
| 1707 The surrounding application must recognize these cases, load more data into | |
| 1708 the input buffer, and repeat the call. In the case of jpeg_read_scanlines(), | |
| 1709 increment the passed pointers past any scanlines successfully read. | |
| 1710 | |
| 1711 Just as with compression, the decompressor will typically backtrack to a | |
| 1712 convenient restart point before suspending. When fill_input_buffer() is | |
| 1713 called, next_input_byte/bytes_in_buffer point to the current restart point, | |
| 1714 which is where the decompressor will backtrack to if FALSE is returned. | |
| 1715 The data beyond that position must NOT be discarded if you suspend; it needs | |
| 1716 to be re-read upon resumption. In most implementations, you'll need to shift | |
| 1717 this data down to the start of your work buffer and then load more data after | |
| 1718 it. Again, this behavior means that a several-Kbyte work buffer is essential | |
| 1719 for decent performance; furthermore, you should load a reasonable amount of | |
| 1720 new data before resuming decompression. (If you loaded, say, only one new | |
| 1721 byte each time around, you could waste a LOT of cycles.) | |
| 1722 | |
| 1723 The skip_input_data() source manager routine requires special care in a | |
| 1724 suspension scenario. This routine is NOT granted the ability to suspend the | |
| 1725 decompressor; it can decrement bytes_in_buffer to zero, but no more. If the | |
| 1726 requested skip distance exceeds the amount of data currently in the input | |
| 1727 buffer, then skip_input_data() must set bytes_in_buffer to zero and record the | |
| 1728 additional skip distance somewhere else. The decompressor will immediately | |
| 1729 call fill_input_buffer(), which should return FALSE, which will cause a | |
| 1730 suspension return. The surrounding application must then arrange to discard | |
| 1731 the recorded number of bytes before it resumes loading the input buffer. | |
| 1732 (Yes, this design is rather baroque, but it avoids complexity in the far more | |
| 1733 common case where a non-suspending source manager is used.) | |
| 1734 | |
| 1735 If the input data has been exhausted, we recommend that you emit a warning | |
| 1736 and insert dummy EOI markers just as a non-suspending data source manager | |
| 1737 would do. This can be handled either in the surrounding application logic or | |
| 1738 within fill_input_buffer(); the latter is probably more efficient. If | |
| 1739 fill_input_buffer() knows that no more data is available, it can set the | |
| 1740 pointer/count to point to a dummy EOI marker and then return TRUE just as | |
| 1741 though it had read more data in a non-suspending situation. | |
| 1742 | |
| 1743 The decompressor does not attempt to suspend within standard JPEG markers; | |
| 1744 instead it will backtrack to the start of the marker and reprocess the whole | |
| 1745 marker next time. Hence the input buffer must be large enough to hold the | |
| 1746 longest standard marker in the file. Standard JPEG markers should normally | |
| 1747 not exceed a few hundred bytes each (DHT tables are typically the longest). | |
| 1748 We recommend at least a 2K buffer for performance reasons, which is much | |
| 1749 larger than any correct marker is likely to be. For robustness against | |
| 1750 damaged marker length counts, you may wish to insert a test in your | |
| 1751 application for the case that the input buffer is completely full and yet | |
| 1752 the decoder has suspended without consuming any data --- otherwise, if this | |
| 1753 situation did occur, it would lead to an endless loop. (The library can't | |
| 1754 provide this test since it has no idea whether "the buffer is full", or | |
| 1755 even whether there is a fixed-size input buffer.) | |
| 1756 | |
| 1757 The input buffer would need to be 64K to allow for arbitrary COM or APPn | |
| 1758 markers, but these are handled specially: they are either saved into allocated | |
| 1759 memory, or skipped over by calling skip_input_data(). In the former case, | |
| 1760 suspension is handled correctly, and in the latter case, the problem of | |
| 1761 buffer overrun is placed on skip_input_data's shoulders, as explained above. | |
| 1762 Note that if you provide your own marker handling routine for large markers, | |
| 1763 you should consider how to deal with buffer overflow. | |
| 1764 | |
| 1765 Multiple-buffer management: | |
| 1766 | |
| 1767 In some applications it is desirable to store the compressed data in a linked | |
| 1768 list of buffer areas, so as to avoid data copying. This can be handled by | |
| 1769 having empty_output_buffer() or fill_input_buffer() set the pointer and count | |
| 1770 to reference the next available buffer; FALSE is returned only if no more | |
| 1771 buffers are available. Although seemingly straightforward, there is a | |
| 1772 pitfall in this approach: the backtrack that occurs when FALSE is returned | |
| 1773 could back up into an earlier buffer. For example, when fill_input_buffer() | |
| 1774 is called, the current pointer & count indicate the backtrack restart point. | |
| 1775 Since fill_input_buffer() will set the pointer and count to refer to a new | |
| 1776 buffer, the restart position must be saved somewhere else. Suppose a second | |
| 1777 call to fill_input_buffer() occurs in the same library call, and no | |
| 1778 additional input data is available, so fill_input_buffer must return FALSE. | |
| 1779 If the JPEG library has not moved the pointer/count forward in the current | |
| 1780 buffer, then *the correct restart point is the saved position in the prior | |
| 1781 buffer*. Prior buffers may be discarded only after the library establishes | |
| 1782 a restart point within a later buffer. Similar remarks apply for output into | |
| 1783 a chain of buffers. | |
| 1784 | |
| 1785 The library will never attempt to backtrack over a skip_input_data() call, | |
| 1786 so any skipped data can be permanently discarded. You still have to deal | |
| 1787 with the case of skipping not-yet-received data, however. | |
| 1788 | |
| 1789 It's much simpler to use only a single buffer; when fill_input_buffer() is | |
| 1790 called, move any unconsumed data (beyond the current pointer/count) down to | |
| 1791 the beginning of this buffer and then load new data into the remaining buffer | |
| 1792 space. This approach requires a little more data copying but is far easier | |
| 1793 to get right. | |
| 1794 | |
| 1795 | |
| 1796 Progressive JPEG support | |
| 1797 ------------------------ | |
| 1798 | |
| 1799 Progressive JPEG rearranges the stored data into a series of scans of | |
| 1800 increasing quality. In situations where a JPEG file is transmitted across a | |
| 1801 slow communications link, a decoder can generate a low-quality image very | |
| 1802 quickly from the first scan, then gradually improve the displayed quality as | |
| 1803 more scans are received. The final image after all scans are complete is | |
| 1804 identical to that of a regular (sequential) JPEG file of the same quality | |
| 1805 setting. Progressive JPEG files are often slightly smaller than equivalent | |
| 1806 sequential JPEG files, but the possibility of incremental display is the main | |
| 1807 reason for using progressive JPEG. | |
| 1808 | |
| 1809 The IJG encoder library generates progressive JPEG files when given a | |
| 1810 suitable "scan script" defining how to divide the data into scans. | |
| 1811 Creation of progressive JPEG files is otherwise transparent to the encoder. | |
| 1812 Progressive JPEG files can also be read transparently by the decoder library. | |
| 1813 If the decoding application simply uses the library as defined above, it | |
| 1814 will receive a final decoded image without any indication that the file was | |
| 1815 progressive. Of course, this approach does not allow incremental display. | |
| 1816 To perform incremental display, an application needs to use the decoder | |
| 1817 library's "buffered-image" mode, in which it receives a decoded image | |
| 1818 multiple times. | |
| 1819 | |
| 1820 Each displayed scan requires about as much work to decode as a full JPEG | |
| 1821 image of the same size, so the decoder must be fairly fast in relation to the | |
| 1822 data transmission rate in order to make incremental display useful. However, | |
| 1823 it is possible to skip displaying the image and simply add the incoming bits | |
| 1824 to the decoder's coefficient buffer. This is fast because only Huffman | |
| 1825 decoding need be done, not IDCT, upsampling, colorspace conversion, etc. | |
| 1826 The IJG decoder library allows the application to switch dynamically between | |
| 1827 displaying the image and simply absorbing the incoming bits. A properly | |
| 1828 coded application can automatically adapt the number of display passes to | |
| 1829 suit the time available as the image is received. Also, a final | |
| 1830 higher-quality display cycle can be performed from the buffered data after | |
| 1831 the end of the file is reached. | |
| 1832 | |
| 1833 Progressive compression: | |
| 1834 | |
| 1835 To create a progressive JPEG file (or a multiple-scan sequential JPEG file), | |
| 1836 set the scan_info cinfo field to point to an array of scan descriptors, and | |
| 1837 perform compression as usual. Instead of constructing your own scan list, | |
| 1838 you can call the jpeg_simple_progression() helper routine to create a | |
| 1839 recommended progression sequence; this method should be used by all | |
| 1840 applications that don't want to get involved in the nitty-gritty of | |
| 1841 progressive scan sequence design. (If you want to provide user control of | |
| 1842 scan sequences, you may wish to borrow the scan script reading code found | |
| 1843 in rdswitch.c, so that you can read scan script files just like cjpeg's.) | |
| 1844 When scan_info is not NULL, the compression library will store DCT'd data | |
| 1845 into a buffer array as jpeg_write_scanlines() is called, and will emit all | |
| 1846 the requested scans during jpeg_finish_compress(). This implies that | |
| 1847 multiple-scan output cannot be created with a suspending data destination | |
| 1848 manager, since jpeg_finish_compress() does not support suspension. We | |
| 1849 should also note that the compressor currently forces Huffman optimization | |
| 1850 mode when creating a progressive JPEG file, because the default Huffman | |
| 1851 tables are unsuitable for progressive files. | |
| 1852 | |
| 1853 Progressive decompression: | |
| 1854 | |
| 1855 When buffered-image mode is not used, the decoder library will read all of | |
| 1856 a multi-scan file during jpeg_start_decompress(), so that it can provide a | |
| 1857 final decoded image. (Here "multi-scan" means either progressive or | |
| 1858 multi-scan sequential.) This makes multi-scan files transparent to the | |
| 1859 decoding application. However, existing applications that used suspending | |
| 1860 input with version 5 of the IJG library will need to be modified to check | |
| 1861 for a suspension return from jpeg_start_decompress(). | |
| 1862 | |
| 1863 To perform incremental display, an application must use the library's | |
| 1864 buffered-image mode. This is described in the next section. | |
| 1865 | |
| 1866 | |
| 1867 Buffered-image mode | |
| 1868 ------------------- | |
| 1869 | |
| 1870 In buffered-image mode, the library stores the partially decoded image in a | |
| 1871 coefficient buffer, from which it can be read out as many times as desired. | |
| 1872 This mode is typically used for incremental display of progressive JPEG files, | |
| 1873 but it can be used with any JPEG file. Each scan of a progressive JPEG file | |
| 1874 adds more data (more detail) to the buffered image. The application can | |
| 1875 display in lockstep with the source file (one display pass per input scan), | |
| 1876 or it can allow input processing to outrun display processing. By making | |
| 1877 input and display processing run independently, it is possible for the | |
| 1878 application to adapt progressive display to a wide range of data transmission | |
| 1879 rates. | |
| 1880 | |
| 1881 The basic control flow for buffered-image decoding is | |
| 1882 | |
| 1883 jpeg_create_decompress() | |
| 1884 set data source | |
| 1885 jpeg_read_header() | |
| 1886 set overall decompression parameters | |
| 1887 cinfo.buffered_image = TRUE; /* select buffered-image mode */ | |
| 1888 jpeg_start_decompress() | |
| 1889 for (each output pass) { | |
| 1890 adjust output decompression parameters if required | |
| 1891 jpeg_start_output() /* start a new output pass */ | |
| 1892 for (all scanlines in image) { | |
| 1893 jpeg_read_scanlines() | |
| 1894 display scanlines | |
| 1895 } | |
| 1896 jpeg_finish_output() /* terminate output pass */ | |
| 1897 } | |
| 1898 jpeg_finish_decompress() | |
| 1899 jpeg_destroy_decompress() | |
| 1900 | |
| 1901 This differs from ordinary unbuffered decoding in that there is an additional | |
| 1902 level of looping. The application can choose how many output passes to make | |
| 1903 and how to display each pass. | |
| 1904 | |
| 1905 The simplest approach to displaying progressive images is to do one display | |
| 1906 pass for each scan appearing in the input file. In this case the outer loop | |
| 1907 condition is typically | |
| 1908 while (! jpeg_input_complete(&cinfo)) | |
| 1909 and the start-output call should read | |
| 1910 jpeg_start_output(&cinfo, cinfo.input_scan_number); | |
| 1911 The second parameter to jpeg_start_output() indicates which scan of the input | |
| 1912 file is to be displayed; the scans are numbered starting at 1 for this | |
| 1913 purpose. (You can use a loop counter starting at 1 if you like, but using | |
| 1914 the library's input scan counter is easier.) The library automatically reads | |
| 1915 data as necessary to complete each requested scan, and jpeg_finish_output() | |
| 1916 advances to the next scan or end-of-image marker (hence input_scan_number | |
| 1917 will be incremented by the time control arrives back at jpeg_start_output()). | |
| 1918 With this technique, data is read from the input file only as needed, and | |
| 1919 input and output processing run in lockstep. | |
| 1920 | |
| 1921 After reading the final scan and reaching the end of the input file, the | |
| 1922 buffered image remains available; it can be read additional times by | |
| 1923 repeating the jpeg_start_output()/jpeg_read_scanlines()/jpeg_finish_output() | |
| 1924 sequence. For example, a useful technique is to use fast one-pass color | |
| 1925 quantization for display passes made while the image is arriving, followed by | |
| 1926 a final display pass using two-pass quantization for highest quality. This | |
| 1927 is done by changing the library parameters before the final output pass. | |
| 1928 Changing parameters between passes is discussed in detail below. | |
| 1929 | |
| 1930 In general the last scan of a progressive file cannot be recognized as such | |
| 1931 until after it is read, so a post-input display pass is the best approach if | |
| 1932 you want special processing in the final pass. | |
| 1933 | |
| 1934 When done with the image, be sure to call jpeg_finish_decompress() to release | |
| 1935 the buffered image (or just use jpeg_destroy_decompress()). | |
| 1936 | |
| 1937 If input data arrives faster than it can be displayed, the application can | |
| 1938 cause the library to decode input data in advance of what's needed to produce | |
| 1939 output. This is done by calling the routine jpeg_consume_input(). | |
| 1940 The return value is one of the following: | |
| 1941 JPEG_REACHED_SOS: reached an SOS marker (the start of a new scan) | |
| 1942 JPEG_REACHED_EOI: reached the EOI marker (end of image) | |
| 1943 JPEG_ROW_COMPLETED: completed reading one MCU row of compressed data | |
| 1944 JPEG_SCAN_COMPLETED: completed reading last MCU row of current scan | |
| 1945 JPEG_SUSPENDED: suspended before completing any of the above | |
| 1946 (JPEG_SUSPENDED can occur only if a suspending data source is used.) This | |
| 1947 routine can be called at any time after initializing the JPEG object. It | |
| 1948 reads some additional data and returns when one of the indicated significant | |
| 1949 events occurs. (If called after the EOI marker is reached, it will | |
| 1950 immediately return JPEG_REACHED_EOI without attempting to read more data.) | |
| 1951 | |
| 1952 The library's output processing will automatically call jpeg_consume_input() | |
| 1953 whenever the output processing overtakes the input; thus, simple lockstep | |
| 1954 display requires no direct calls to jpeg_consume_input(). But by adding | |
| 1955 calls to jpeg_consume_input(), you can absorb data in advance of what is | |
| 1956 being displayed. This has two benefits: | |
| 1957 * You can limit buildup of unprocessed data in your input buffer. | |
| 1958 * You can eliminate extra display passes by paying attention to the | |
| 1959 state of the library's input processing. | |
| 1960 | |
| 1961 The first of these benefits only requires interspersing calls to | |
| 1962 jpeg_consume_input() with your display operations and any other processing | |
| 1963 you may be doing. To avoid wasting cycles due to backtracking, it's best to | |
| 1964 call jpeg_consume_input() only after a hundred or so new bytes have arrived. | |
| 1965 This is discussed further under "I/O suspension", above. (Note: the JPEG | |
| 1966 library currently is not thread-safe. You must not call jpeg_consume_input() | |
| 1967 from one thread of control if a different library routine is working on the | |
| 1968 same JPEG object in another thread.) | |
| 1969 | |
| 1970 When input arrives fast enough that more than one new scan is available | |
| 1971 before you start a new output pass, you may as well skip the output pass | |
| 1972 corresponding to the completed scan. This occurs for free if you pass | |
| 1973 cinfo.input_scan_number as the target scan number to jpeg_start_output(). | |
| 1974 The input_scan_number field is simply the index of the scan currently being | |
| 1975 consumed by the input processor. You can ensure that this is up-to-date by | |
| 1976 emptying the input buffer just before calling jpeg_start_output(): call | |
| 1977 jpeg_consume_input() repeatedly until it returns JPEG_SUSPENDED or | |
| 1978 JPEG_REACHED_EOI. | |
| 1979 | |
| 1980 The target scan number passed to jpeg_start_output() is saved in the | |
| 1981 cinfo.output_scan_number field. The library's output processing calls | |
| 1982 jpeg_consume_input() whenever the current input scan number and row within | |
| 1983 that scan is less than or equal to the current output scan number and row. | |
| 1984 Thus, input processing can "get ahead" of the output processing but is not | |
| 1985 allowed to "fall behind". You can achieve several different effects by | |
| 1986 manipulating this interlock rule. For example, if you pass a target scan | |
| 1987 number greater than the current input scan number, the output processor will | |
| 1988 wait until that scan starts to arrive before producing any output. (To avoid | |
| 1989 an infinite loop, the target scan number is automatically reset to the last | |
| 1990 scan number when the end of image is reached. Thus, if you specify a large | |
| 1991 target scan number, the library will just absorb the entire input file and | |
| 1992 then perform an output pass. This is effectively the same as what | |
| 1993 jpeg_start_decompress() does when you don't select buffered-image mode.) | |
| 1994 When you pass a target scan number equal to the current input scan number, | |
| 1995 the image is displayed no faster than the current input scan arrives. The | |
| 1996 final possibility is to pass a target scan number less than the current input | |
| 1997 scan number; this disables the input/output interlock and causes the output | |
| 1998 processor to simply display whatever it finds in the image buffer, without | |
| 1999 waiting for input. (However, the library will not accept a target scan | |
| 2000 number less than one, so you can't avoid waiting for the first scan.) | |
| 2001 | |
| 2002 When data is arriving faster than the output display processing can advance | |
| 2003 through the image, jpeg_consume_input() will store data into the buffered | |
| 2004 image beyond the point at which the output processing is reading data out | |
| 2005 again. If the input arrives fast enough, it may "wrap around" the buffer to | |
| 2006 the point where the input is more than one whole scan ahead of the output. | |
| 2007 If the output processing simply proceeds through its display pass without | |
| 2008 paying attention to the input, the effect seen on-screen is that the lower | |
| 2009 part of the image is one or more scans better in quality than the upper part. | |
| 2010 Then, when the next output scan is started, you have a choice of what target | |
| 2011 scan number to use. The recommended choice is to use the current input scan | |
| 2012 number at that time, which implies that you've skipped the output scans | |
| 2013 corresponding to the input scans that were completed while you processed the | |
| 2014 previous output scan. In this way, the decoder automatically adapts its | |
| 2015 speed to the arriving data, by skipping output scans as necessary to keep up | |
| 2016 with the arriving data. | |
| 2017 | |
| 2018 When using this strategy, you'll want to be sure that you perform a final | |
| 2019 output pass after receiving all the data; otherwise your last display may not | |
| 2020 be full quality across the whole screen. So the right outer loop logic is | |
| 2021 something like this: | |
| 2022 do { | |
| 2023 absorb any waiting input by calling jpeg_consume_input() | |
| 2024 final_pass = jpeg_input_complete(&cinfo); | |
| 2025 adjust output decompression parameters if required | |
| 2026 jpeg_start_output(&cinfo, cinfo.input_scan_number); | |
| 2027 ... | |
| 2028 jpeg_finish_output() | |
| 2029 } while (! final_pass); | |
| 2030 rather than quitting as soon as jpeg_input_complete() returns TRUE. This | |
| 2031 arrangement makes it simple to use higher-quality decoding parameters | |
| 2032 for the final pass. But if you don't want to use special parameters for | |
| 2033 the final pass, the right loop logic is like this: | |
| 2034 for (;;) { | |
| 2035 absorb any waiting input by calling jpeg_consume_input() | |
| 2036 jpeg_start_output(&cinfo, cinfo.input_scan_number); | |
| 2037 ... | |
| 2038 jpeg_finish_output() | |
| 2039 if (jpeg_input_complete(&cinfo) && | |
| 2040 cinfo.input_scan_number == cinfo.output_scan_number) | |
| 2041 break; | |
| 2042 } | |
| 2043 In this case you don't need to know in advance whether an output pass is to | |
| 2044 be the last one, so it's not necessary to have reached EOF before starting | |
| 2045 the final output pass; rather, what you want to test is whether the output | |
| 2046 pass was performed in sync with the final input scan. This form of the loop | |
| 2047 will avoid an extra output pass whenever the decoder is able (or nearly able) | |
| 2048 to keep up with the incoming data. | |
| 2049 | |
| 2050 When the data transmission speed is high, you might begin a display pass, | |
| 2051 then find that much or all of the file has arrived before you can complete | |
| 2052 the pass. (You can detect this by noting the JPEG_REACHED_EOI return code | |
| 2053 from jpeg_consume_input(), or equivalently by testing jpeg_input_complete().) | |
| 2054 In this situation you may wish to abort the current display pass and start a | |
| 2055 new one using the newly arrived information. To do so, just call | |
| 2056 jpeg_finish_output() and then start a new pass with jpeg_start_output(). | |
| 2057 | |
| 2058 A variant strategy is to abort and restart display if more than one complete | |
| 2059 scan arrives during an output pass; this can be detected by noting | |
| 2060 JPEG_REACHED_SOS returns and/or examining cinfo.input_scan_number. This | |
| 2061 idea should be employed with caution, however, since the display process | |
| 2062 might never get to the bottom of the image before being aborted, resulting | |
| 2063 in the lower part of the screen being several passes worse than the upper. | |
| 2064 In most cases it's probably best to abort an output pass only if the whole | |
| 2065 file has arrived and you want to begin the final output pass immediately. | |
| 2066 | |
| 2067 When receiving data across a communication link, we recommend always using | |
| 2068 the current input scan number for the output target scan number; if a | |
| 2069 higher-quality final pass is to be done, it should be started (aborting any | |
| 2070 incomplete output pass) as soon as the end of file is received. However, | |
| 2071 many other strategies are possible. For example, the application can examine | |
| 2072 the parameters of the current input scan and decide whether to display it or | |
| 2073 not. If the scan contains only chroma data, one might choose not to use it | |
| 2074 as the target scan, expecting that the scan will be small and will arrive | |
| 2075 quickly. To skip to the next scan, call jpeg_consume_input() until it | |
| 2076 returns JPEG_REACHED_SOS or JPEG_REACHED_EOI. Or just use the next higher | |
| 2077 number as the target scan for jpeg_start_output(); but that method doesn't | |
| 2078 let you inspect the next scan's parameters before deciding to display it. | |
| 2079 | |
| 2080 | |
| 2081 In buffered-image mode, jpeg_start_decompress() never performs input and | |
| 2082 thus never suspends. An application that uses input suspension with | |
| 2083 buffered-image mode must be prepared for suspension returns from these | |
| 2084 routines: | |
| 2085 * jpeg_start_output() performs input only if you request 2-pass quantization | |
| 2086 and the target scan isn't fully read yet. (This is discussed below.) | |
| 2087 * jpeg_read_scanlines(), as always, returns the number of scanlines that it | |
| 2088 was able to produce before suspending. | |
| 2089 * jpeg_finish_output() will read any markers following the target scan, | |
| 2090 up to the end of the file or the SOS marker that begins another scan. | |
| 2091 (But it reads no input if jpeg_consume_input() has already reached the | |
| 2092 end of the file or a SOS marker beyond the target output scan.) | |
| 2093 * jpeg_finish_decompress() will read until the end of file, and thus can | |
| 2094 suspend if the end hasn't already been reached (as can be tested by | |
| 2095 calling jpeg_input_complete()). | |
| 2096 jpeg_start_output(), jpeg_finish_output(), and jpeg_finish_decompress() | |
| 2097 all return TRUE if they completed their tasks, FALSE if they had to suspend. | |
| 2098 In the event of a FALSE return, the application must load more input data | |
| 2099 and repeat the call. Applications that use non-suspending data sources need | |
| 2100 not check the return values of these three routines. | |
| 2101 | |
| 2102 | |
| 2103 It is possible to change decoding parameters between output passes in the | |
| 2104 buffered-image mode. The decoder library currently supports only very | |
| 2105 limited changes of parameters. ONLY THE FOLLOWING parameter changes are | |
| 2106 allowed after jpeg_start_decompress() is called: | |
| 2107 * dct_method can be changed before each call to jpeg_start_output(). | |
| 2108 For example, one could use a fast DCT method for early scans, changing | |
| 2109 to a higher quality method for the final scan. | |
| 2110 * dither_mode can be changed before each call to jpeg_start_output(); | |
| 2111 of course this has no impact if not using color quantization. Typically | |
| 2112 one would use ordered dither for initial passes, then switch to | |
| 2113 Floyd-Steinberg dither for the final pass. Caution: changing dither mode | |
| 2114 can cause more memory to be allocated by the library. Although the amount | |
| 2115 of memory involved is not large (a scanline or so), it may cause the | |
| 2116 initial max_memory_to_use specification to be exceeded, which in the worst | |
| 2117 case would result in an out-of-memory failure. | |
| 2118 * do_block_smoothing can be changed before each call to jpeg_start_output(). | |
| 2119 This setting is relevant only when decoding a progressive JPEG image. | |
| 2120 During the first DC-only scan, block smoothing provides a very "fuzzy" look | |
| 2121 instead of the very "blocky" look seen without it; which is better seems a | |
| 2122 matter of personal taste. But block smoothing is nearly always a win | |
| 2123 during later stages, especially when decoding a successive-approximation | |
| 2124 image: smoothing helps to hide the slight blockiness that otherwise shows | |
| 2125 up on smooth gradients until the lowest coefficient bits are sent. | |
| 2126 * Color quantization mode can be changed under the rules described below. | |
| 2127 You *cannot* change between full-color and quantized output (because that | |
| 2128 would alter the required I/O buffer sizes), but you can change which | |
| 2129 quantization method is used. | |
| 2130 | |
| 2131 When generating color-quantized output, changing quantization method is a | |
| 2132 very useful way of switching between high-speed and high-quality display. | |
| 2133 The library allows you to change among its three quantization methods: | |
| 2134 1. Single-pass quantization to a fixed color cube. | |
| 2135 Selected by cinfo.two_pass_quantize = FALSE and cinfo.colormap = NULL. | |
| 2136 2. Single-pass quantization to an application-supplied colormap. | |
| 2137 Selected by setting cinfo.colormap to point to the colormap (the value of | |
| 2138 two_pass_quantize is ignored); also set cinfo.actual_number_of_colors. | |
| 2139 3. Two-pass quantization to a colormap chosen specifically for the image. | |
| 2140 Selected by cinfo.two_pass_quantize = TRUE and cinfo.colormap = NULL. | |
| 2141 (This is the default setting selected by jpeg_read_header, but it is | |
| 2142 probably NOT what you want for the first pass of progressive display!) | |
| 2143 These methods offer successively better quality and lesser speed. However, | |
| 2144 only the first method is available for quantizing in non-RGB color spaces. | |
| 2145 | |
| 2146 IMPORTANT: because the different quantizer methods have very different | |
| 2147 working-storage requirements, the library requires you to indicate which | |
| 2148 one(s) you intend to use before you call jpeg_start_decompress(). (If we did | |
| 2149 not require this, the max_memory_to_use setting would be a complete fiction.) | |
| 2150 You do this by setting one or more of these three cinfo fields to TRUE: | |
| 2151 enable_1pass_quant Fixed color cube colormap | |
| 2152 enable_external_quant Externally-supplied colormap | |
| 2153 enable_2pass_quant Two-pass custom colormap | |
| 2154 All three are initialized FALSE by jpeg_read_header(). But | |
| 2155 jpeg_start_decompress() automatically sets TRUE the one selected by the | |
| 2156 current two_pass_quantize and colormap settings, so you only need to set the | |
| 2157 enable flags for any other quantization methods you plan to change to later. | |
| 2158 | |
| 2159 After setting the enable flags correctly at jpeg_start_decompress() time, you | |
| 2160 can change to any enabled quantization method by setting two_pass_quantize | |
| 2161 and colormap properly just before calling jpeg_start_output(). The following | |
| 2162 special rules apply: | |
| 2163 1. You must explicitly set cinfo.colormap to NULL when switching to 1-pass | |
| 2164 or 2-pass mode from a different mode, or when you want the 2-pass | |
| 2165 quantizer to be re-run to generate a new colormap. | |
| 2166 2. To switch to an external colormap, or to change to a different external | |
| 2167 colormap than was used on the prior pass, you must call | |
| 2168 jpeg_new_colormap() after setting cinfo.colormap. | |
| 2169 NOTE: if you want to use the same colormap as was used in the prior pass, | |
| 2170 you should not do either of these things. This will save some nontrivial | |
| 2171 switchover costs. | |
| 2172 (These requirements exist because cinfo.colormap will always be non-NULL | |
| 2173 after completing a prior output pass, since both the 1-pass and 2-pass | |
| 2174 quantizers set it to point to their output colormaps. Thus you have to | |
| 2175 do one of these two things to notify the library that something has changed. | |
| 2176 Yup, it's a bit klugy, but it's necessary to do it this way for backwards | |
| 2177 compatibility.) | |
| 2178 | |
| 2179 Note that in buffered-image mode, the library generates any requested colormap | |
| 2180 during jpeg_start_output(), not during jpeg_start_decompress(). | |
| 2181 | |
| 2182 When using two-pass quantization, jpeg_start_output() makes a pass over the | |
| 2183 buffered image to determine the optimum color map; it therefore may take a | |
| 2184 significant amount of time, whereas ordinarily it does little work. The | |
| 2185 progress monitor hook is called during this pass, if defined. It is also | |
| 2186 important to realize that if the specified target scan number is greater than | |
| 2187 or equal to the current input scan number, jpeg_start_output() will attempt | |
| 2188 to consume input as it makes this pass. If you use a suspending data source, | |
| 2189 you need to check for a FALSE return from jpeg_start_output() under these | |
| 2190 conditions. The combination of 2-pass quantization and a not-yet-fully-read | |
| 2191 target scan is the only case in which jpeg_start_output() will consume input. | |
| 2192 | |
| 2193 | |
| 2194 Application authors who support buffered-image mode may be tempted to use it | |
| 2195 for all JPEG images, even single-scan ones. This will work, but it is | |
| 2196 inefficient: there is no need to create an image-sized coefficient buffer for | |
| 2197 single-scan images. Requesting buffered-image mode for such an image wastes | |
| 2198 memory. Worse, it can cost time on large images, since the buffered data has | |
| 2199 to be swapped out or written to a temporary file. If you are concerned about | |
| 2200 maximum performance on baseline JPEG files, you should use buffered-image | |
| 2201 mode only when the incoming file actually has multiple scans. This can be | |
| 2202 tested by calling jpeg_has_multiple_scans(), which will return a correct | |
| 2203 result at any time after jpeg_read_header() completes. | |
| 2204 | |
| 2205 It is also worth noting that when you use jpeg_consume_input() to let input | |
| 2206 processing get ahead of output processing, the resulting pattern of access to | |
| 2207 the coefficient buffer is quite nonsequential. It's best to use the memory | |
| 2208 manager jmemnobs.c if you can (ie, if you have enough real or virtual main | |
| 2209 memory). If not, at least make sure that max_memory_to_use is set as high as | |
| 2210 possible. If the JPEG memory manager has to use a temporary file, you will | |
| 2211 probably see a lot of disk traffic and poor performance. (This could be | |
| 2212 improved with additional work on the memory manager, but we haven't gotten | |
| 2213 around to it yet.) | |
| 2214 | |
| 2215 In some applications it may be convenient to use jpeg_consume_input() for all | |
| 2216 input processing, including reading the initial markers; that is, you may | |
| 2217 wish to call jpeg_consume_input() instead of jpeg_read_header() during | |
| 2218 startup. This works, but note that you must check for JPEG_REACHED_SOS and | |
| 2219 JPEG_REACHED_EOI return codes as the equivalent of jpeg_read_header's codes. | |
| 2220 Once the first SOS marker has been reached, you must call | |
| 2221 jpeg_start_decompress() before jpeg_consume_input() will consume more input; | |
| 2222 it'll just keep returning JPEG_REACHED_SOS until you do. If you read a | |
| 2223 tables-only file this way, jpeg_consume_input() will return JPEG_REACHED_EOI | |
| 2224 without ever returning JPEG_REACHED_SOS; be sure to check for this case. | |
| 2225 If this happens, the decompressor will not read any more input until you call | |
| 2226 jpeg_abort() to reset it. It is OK to call jpeg_consume_input() even when not | |
| 2227 using buffered-image mode, but in that case it's basically a no-op after the | |
| 2228 initial markers have been read: it will just return JPEG_SUSPENDED. | |
| 2229 | |
| 2230 | |
| 2231 Abbreviated datastreams and multiple images | |
| 2232 ------------------------------------------- | |
| 2233 | |
| 2234 A JPEG compression or decompression object can be reused to process multiple | |
| 2235 images. This saves a small amount of time per image by eliminating the | |
| 2236 "create" and "destroy" operations, but that isn't the real purpose of the | |
| 2237 feature. Rather, reuse of an object provides support for abbreviated JPEG | |
| 2238 datastreams. Object reuse can also simplify processing a series of images in | |
| 2239 a single input or output file. This section explains these features. | |
| 2240 | |
| 2241 A JPEG file normally contains several hundred bytes worth of quantization | |
| 2242 and Huffman tables. In a situation where many images will be stored or | |
| 2243 transmitted with identical tables, this may represent an annoying overhead. | |
| 2244 The JPEG standard therefore permits tables to be omitted. The standard | |
| 2245 defines three classes of JPEG datastreams: | |
| 2246 * "Interchange" datastreams contain an image and all tables needed to decode | |
| 2247 the image. These are the usual kind of JPEG file. | |
| 2248 * "Abbreviated image" datastreams contain an image, but are missing some or | |
| 2249 all of the tables needed to decode that image. | |
| 2250 * "Abbreviated table specification" (henceforth "tables-only") datastreams | |
| 2251 contain only table specifications. | |
| 2252 To decode an abbreviated image, it is necessary to load the missing table(s) | |
| 2253 into the decoder beforehand. This can be accomplished by reading a separate | |
| 2254 tables-only file. A variant scheme uses a series of images in which the first | |
| 2255 image is an interchange (complete) datastream, while subsequent ones are | |
| 2256 abbreviated and rely on the tables loaded by the first image. It is assumed | |
| 2257 that once the decoder has read a table, it will remember that table until a | |
| 2258 new definition for the same table number is encountered. | |
| 2259 | |
| 2260 It is the application designer's responsibility to figure out how to associate | |
| 2261 the correct tables with an abbreviated image. While abbreviated datastreams | |
| 2262 can be useful in a closed environment, their use is strongly discouraged in | |
| 2263 any situation where data exchange with other applications might be needed. | |
| 2264 Caveat designer. | |
| 2265 | |
| 2266 The JPEG library provides support for reading and writing any combination of | |
| 2267 tables-only datastreams and abbreviated images. In both compression and | |
| 2268 decompression objects, a quantization or Huffman table will be retained for | |
| 2269 the lifetime of the object, unless it is overwritten by a new table definition. | |
| 2270 | |
| 2271 | |
| 2272 To create abbreviated image datastreams, it is only necessary to tell the | |
| 2273 compressor not to emit some or all of the tables it is using. Each | |
| 2274 quantization and Huffman table struct contains a boolean field "sent_table", | |
| 2275 which normally is initialized to FALSE. For each table used by the image, the | |
| 2276 header-writing process emits the table and sets sent_table = TRUE unless it is | |
| 2277 already TRUE. (In normal usage, this prevents outputting the same table | |
| 2278 definition multiple times, as would otherwise occur because the chroma | |
| 2279 components typically share tables.) Thus, setting this field to TRUE before | |
| 2280 calling jpeg_start_compress() will prevent the table from being written at | |
| 2281 all. | |
| 2282 | |
| 2283 If you want to create a "pure" abbreviated image file containing no tables, | |
| 2284 just call "jpeg_suppress_tables(&cinfo, TRUE)" after constructing all the | |
| 2285 tables. If you want to emit some but not all tables, you'll need to set the | |
| 2286 individual sent_table fields directly. | |
| 2287 | |
| 2288 To create an abbreviated image, you must also call jpeg_start_compress() | |
| 2289 with a second parameter of FALSE, not TRUE. Otherwise jpeg_start_compress() | |
| 2290 will force all the sent_table fields to FALSE. (This is a safety feature to | |
| 2291 prevent abbreviated images from being created accidentally.) | |
| 2292 | |
| 2293 To create a tables-only file, perform the same parameter setup that you | |
| 2294 normally would, but instead of calling jpeg_start_compress() and so on, call | |
| 2295 jpeg_write_tables(&cinfo). This will write an abbreviated datastream | |
| 2296 containing only SOI, DQT and/or DHT markers, and EOI. All the quantization | |
| 2297 and Huffman tables that are currently defined in the compression object will | |
| 2298 be emitted unless their sent_tables flag is already TRUE, and then all the | |
| 2299 sent_tables flags will be set TRUE. | |
| 2300 | |
| 2301 A sure-fire way to create matching tables-only and abbreviated image files | |
| 2302 is to proceed as follows: | |
| 2303 | |
| 2304 create JPEG compression object | |
| 2305 set JPEG parameters | |
| 2306 set destination to tables-only file | |
| 2307 jpeg_write_tables(&cinfo); | |
| 2308 set destination to image file | |
| 2309 jpeg_start_compress(&cinfo, FALSE); | |
| 2310 write data... | |
| 2311 jpeg_finish_compress(&cinfo); | |
| 2312 | |
| 2313 Since the JPEG parameters are not altered between writing the table file and | |
| 2314 the abbreviated image file, the same tables are sure to be used. Of course, | |
| 2315 you can repeat the jpeg_start_compress() ... jpeg_finish_compress() sequence | |
| 2316 many times to produce many abbreviated image files matching the table file. | |
| 2317 | |
| 2318 You cannot suppress output of the computed Huffman tables when Huffman | |
| 2319 optimization is selected. (If you could, there'd be no way to decode the | |
| 2320 image...) Generally, you don't want to set optimize_coding = TRUE when | |
| 2321 you are trying to produce abbreviated files. | |
| 2322 | |
| 2323 In some cases you might want to compress an image using tables which are | |
| 2324 not stored in the application, but are defined in an interchange or | |
| 2325 tables-only file readable by the application. This can be done by setting up | |
| 2326 a JPEG decompression object to read the specification file, then copying the | |
| 2327 tables into your compression object. See jpeg_copy_critical_parameters() | |
| 2328 for an example of copying quantization tables. | |
| 2329 | |
| 2330 | |
| 2331 To read abbreviated image files, you simply need to load the proper tables | |
| 2332 into the decompression object before trying to read the abbreviated image. | |
| 2333 If the proper tables are stored in the application program, you can just | |
| 2334 allocate the table structs and fill in their contents directly. For example, | |
| 2335 to load a fixed quantization table into table slot "n": | |
| 2336 | |
| 2337 if (cinfo.quant_tbl_ptrs[n] == NULL) | |
| 2338 cinfo.quant_tbl_ptrs[n] = jpeg_alloc_quant_table((j_common_ptr) &cinfo); | |
| 2339 quant_ptr = cinfo.quant_tbl_ptrs[n]; /* quant_ptr is JQUANT_TBL* */ | |
| 2340 for (i = 0; i < 64; i++) { | |
| 2341 /* Qtable[] is desired quantization table, in natural array order */ | |
| 2342 quant_ptr->quantval[i] = Qtable[i]; | |
| 2343 } | |
| 2344 | |
| 2345 Code to load a fixed Huffman table is typically (for AC table "n"): | |
| 2346 | |
| 2347 if (cinfo.ac_huff_tbl_ptrs[n] == NULL) | |
| 2348 cinfo.ac_huff_tbl_ptrs[n] = jpeg_alloc_huff_table((j_common_ptr) &cinfo); | |
| 2349 huff_ptr = cinfo.ac_huff_tbl_ptrs[n]; /* huff_ptr is JHUFF_TBL* */ | |
| 2350 for (i = 1; i <= 16; i++) { | |
| 2351 /* counts[i] is number of Huffman codes of length i bits, i=1..16 */ | |
| 2352 huff_ptr->bits[i] = counts[i]; | |
| 2353 } | |
| 2354 for (i = 0; i < 256; i++) { | |
| 2355 /* symbols[] is the list of Huffman symbols, in code-length order */ | |
| 2356 huff_ptr->huffval[i] = symbols[i]; | |
| 2357 } | |
| 2358 | |
| 2359 (Note that trying to set cinfo.quant_tbl_ptrs[n] to point directly at a | |
| 2360 constant JQUANT_TBL object is not safe. If the incoming file happened to | |
| 2361 contain a quantization table definition, your master table would get | |
| 2362 overwritten! Instead allocate a working table copy and copy the master table | |
| 2363 into it, as illustrated above. Ditto for Huffman tables, of course.) | |
| 2364 | |
| 2365 You might want to read the tables from a tables-only file, rather than | |
| 2366 hard-wiring them into your application. The jpeg_read_header() call is | |
| 2367 sufficient to read a tables-only file. You must pass a second parameter of | |
| 2368 FALSE to indicate that you do not require an image to be present. Thus, the | |
| 2369 typical scenario is | |
| 2370 | |
| 2371 create JPEG decompression object | |
| 2372 set source to tables-only file | |
| 2373 jpeg_read_header(&cinfo, FALSE); | |
| 2374 set source to abbreviated image file | |
| 2375 jpeg_read_header(&cinfo, TRUE); | |
| 2376 set decompression parameters | |
| 2377 jpeg_start_decompress(&cinfo); | |
| 2378 read data... | |
| 2379 jpeg_finish_decompress(&cinfo); | |
| 2380 | |
| 2381 In some cases, you may want to read a file without knowing whether it contains | |
| 2382 an image or just tables. In that case, pass FALSE and check the return value | |
| 2383 from jpeg_read_header(): it will be JPEG_HEADER_OK if an image was found, | |
| 2384 JPEG_HEADER_TABLES_ONLY if only tables were found. (A third return value, | |
| 2385 JPEG_SUSPENDED, is possible when using a suspending data source manager.) | |
| 2386 Note that jpeg_read_header() will not complain if you read an abbreviated | |
| 2387 image for which you haven't loaded the missing tables; the missing-table check | |
| 2388 occurs later, in jpeg_start_decompress(). | |
| 2389 | |
| 2390 | |
| 2391 It is possible to read a series of images from a single source file by | |
| 2392 repeating the jpeg_read_header() ... jpeg_finish_decompress() sequence, | |
| 2393 without releasing/recreating the JPEG object or the data source module. | |
| 2394 (If you did reinitialize, any partial bufferload left in the data source | |
| 2395 buffer at the end of one image would be discarded, causing you to lose the | |
| 2396 start of the next image.) When you use this method, stored tables are | |
| 2397 automatically carried forward, so some of the images can be abbreviated images | |
| 2398 that depend on tables from earlier images. | |
| 2399 | |
| 2400 If you intend to write a series of images into a single destination file, | |
| 2401 you might want to make a specialized data destination module that doesn't | |
| 2402 flush the output buffer at term_destination() time. This would speed things | |
| 2403 up by some trifling amount. Of course, you'd need to remember to flush the | |
| 2404 buffer after the last image. You can make the later images be abbreviated | |
| 2405 ones by passing FALSE to jpeg_start_compress(). | |
| 2406 | |
| 2407 | |
| 2408 Special markers | |
| 2409 --------------- | |
| 2410 | |
| 2411 Some applications may need to insert or extract special data in the JPEG | |
| 2412 datastream. The JPEG standard provides marker types "COM" (comment) and | |
| 2413 "APP0" through "APP15" (application) to hold application-specific data. | |
| 2414 Unfortunately, the use of these markers is not specified by the standard. | |
| 2415 COM markers are fairly widely used to hold user-supplied text. The JFIF file | |
| 2416 format spec uses APP0 markers with specified initial strings to hold certain | |
| 2417 data. Adobe applications use APP14 markers beginning with the string "Adobe" | |
| 2418 for miscellaneous data. Other APPn markers are rarely seen, but might | |
| 2419 contain almost anything. | |
| 2420 | |
| 2421 If you wish to store user-supplied text, we recommend you use COM markers | |
| 2422 and place readable 7-bit ASCII text in them. Newline conventions are not | |
| 2423 standardized --- expect to find LF (Unix style), CR/LF (DOS style), or CR | |
| 2424 (Mac style). A robust COM reader should be able to cope with random binary | |
| 2425 garbage, including nulls, since some applications generate COM markers | |
| 2426 containing non-ASCII junk. (But yours should not be one of them.) | |
| 2427 | |
| 2428 For program-supplied data, use an APPn marker, and be sure to begin it with an | |
| 2429 identifying string so that you can tell whether the marker is actually yours. | |
| 2430 It's probably best to avoid using APP0 or APP14 for any private markers. | |
| 2431 (NOTE: the upcoming SPIFF standard will use APP8 markers; we recommend you | |
| 2432 not use APP8 markers for any private purposes, either.) | |
| 2433 | |
| 2434 Keep in mind that at most 65533 bytes can be put into one marker, but you | |
| 2435 can have as many markers as you like. | |
| 2436 | |
| 2437 By default, the IJG compression library will write a JFIF APP0 marker if the | |
| 2438 selected JPEG colorspace is grayscale or YCbCr, or an Adobe APP14 marker if | |
| 2439 the selected colorspace is RGB, CMYK, or YCCK. You can disable this, but | |
| 2440 we don't recommend it. The decompression library will recognize JFIF and | |
| 2441 Adobe markers and will set the JPEG colorspace properly when one is found. | |
| 2442 | |
| 2443 | |
| 2444 You can write special markers immediately following the datastream header by | |
| 2445 calling jpeg_write_marker() after jpeg_start_compress() and before the first | |
| 2446 call to jpeg_write_scanlines(). When you do this, the markers appear after | |
| 2447 the SOI and the JFIF APP0 and Adobe APP14 markers (if written), but before | |
| 2448 all else. Specify the marker type parameter as "JPEG_COM" for COM or | |
| 2449 "JPEG_APP0 + n" for APPn. (Actually, jpeg_write_marker will let you write | |
| 2450 any marker type, but we don't recommend writing any other kinds of marker.) | |
| 2451 For example, to write a user comment string pointed to by comment_text: | |
| 2452 jpeg_write_marker(cinfo, JPEG_COM, comment_text, strlen(comment_text)); | |
| 2453 | |
| 2454 If it's not convenient to store all the marker data in memory at once, | |
| 2455 you can instead call jpeg_write_m_header() followed by multiple calls to | |
| 2456 jpeg_write_m_byte(). If you do it this way, it's your responsibility to | |
| 2457 call jpeg_write_m_byte() exactly the number of times given in the length | |
| 2458 parameter to jpeg_write_m_header(). (This method lets you empty the | |
| 2459 output buffer partway through a marker, which might be important when | |
| 2460 using a suspending data destination module. In any case, if you are using | |
| 2461 a suspending destination, you should flush its buffer after inserting | |
| 2462 any special markers. See "I/O suspension".) | |
| 2463 | |
| 2464 Or, if you prefer to synthesize the marker byte sequence yourself, | |
| 2465 you can just cram it straight into the data destination module. | |
| 2466 | |
| 2467 If you are writing JFIF 1.02 extension markers (thumbnail images), don't | |
| 2468 forget to set cinfo.JFIF_minor_version = 2 so that the encoder will write the | |
| 2469 correct JFIF version number in the JFIF header marker. The library's default | |
| 2470 is to write version 1.01, but that's wrong if you insert any 1.02 extension | |
| 2471 markers. (We could probably get away with just defaulting to 1.02, but there | |
| 2472 used to be broken decoders that would complain about unknown minor version | |
| 2473 numbers. To reduce compatibility risks it's safest not to write 1.02 unless | |
| 2474 you are actually using 1.02 extensions.) | |
| 2475 | |
| 2476 | |
| 2477 When reading, two methods of handling special markers are available: | |
| 2478 1. You can ask the library to save the contents of COM and/or APPn markers | |
| 2479 into memory, and then examine them at your leisure afterwards. | |
| 2480 2. You can supply your own routine to process COM and/or APPn markers | |
| 2481 on-the-fly as they are read. | |
| 2482 The first method is simpler to use, especially if you are using a suspending | |
| 2483 data source; writing a marker processor that copes with input suspension is | |
| 2484 not easy (consider what happens if the marker is longer than your available | |
| 2485 input buffer). However, the second method conserves memory since the marker | |
| 2486 data need not be kept around after it's been processed. | |
| 2487 | |
| 2488 For either method, you'd normally set up marker handling after creating a | |
| 2489 decompression object and before calling jpeg_read_header(), because the | |
| 2490 markers of interest will typically be near the head of the file and so will | |
| 2491 be scanned by jpeg_read_header. Once you've established a marker handling | |
| 2492 method, it will be used for the life of that decompression object | |
| 2493 (potentially many datastreams), unless you change it. Marker handling is | |
| 2494 determined separately for COM markers and for each APPn marker code. | |
| 2495 | |
| 2496 | |
| 2497 To save the contents of special markers in memory, call | |
| 2498 jpeg_save_markers(cinfo, marker_code, length_limit) | |
| 2499 where marker_code is the marker type to save, JPEG_COM or JPEG_APP0+n. | |
| 2500 (To arrange to save all the special marker types, you need to call this | |
| 2501 routine 17 times, for COM and APP0-APP15.) If the incoming marker is longer | |
| 2502 than length_limit data bytes, only length_limit bytes will be saved; this | |
| 2503 parameter allows you to avoid chewing up memory when you only need to see the | |
| 2504 first few bytes of a potentially large marker. If you want to save all the | |
| 2505 data, set length_limit to 0xFFFF; that is enough since marker lengths are only | |
| 2506 16 bits. As a special case, setting length_limit to 0 prevents that marker | |
| 2507 type from being saved at all. (That is the default behavior, in fact.) | |
| 2508 | |
| 2509 After jpeg_read_header() completes, you can examine the special markers by | |
| 2510 following the cinfo->marker_list pointer chain. All the special markers in | |
| 2511 the file appear in this list, in order of their occurrence in the file (but | |
| 2512 omitting any markers of types you didn't ask for). Both the original data | |
| 2513 length and the saved data length are recorded for each list entry; the latter | |
| 2514 will not exceed length_limit for the particular marker type. Note that these | |
| 2515 lengths exclude the marker length word, whereas the stored representation | |
| 2516 within the JPEG file includes it. (Hence the maximum data length is really | |
| 2517 only 65533.) | |
| 2518 | |
| 2519 It is possible that additional special markers appear in the file beyond the | |
| 2520 SOS marker at which jpeg_read_header stops; if so, the marker list will be | |
| 2521 extended during reading of the rest of the file. This is not expected to be | |
| 2522 common, however. If you are short on memory you may want to reset the length | |
| 2523 limit to zero for all marker types after finishing jpeg_read_header, to | |
| 2524 ensure that the max_memory_to_use setting cannot be exceeded due to addition | |
| 2525 of later markers. | |
| 2526 | |
| 2527 The marker list remains stored until you call jpeg_finish_decompress or | |
| 2528 jpeg_abort, at which point the memory is freed and the list is set to empty. | |
| 2529 (jpeg_destroy also releases the storage, of course.) | |
| 2530 | |
| 2531 Note that the library is internally interested in APP0 and APP14 markers; | |
| 2532 if you try to set a small nonzero length limit on these types, the library | |
| 2533 will silently force the length up to the minimum it wants. (But you can set | |
| 2534 a zero length limit to prevent them from being saved at all.) Also, in a | |
| 2535 16-bit environment, the maximum length limit may be constrained to less than | |
| 2536 65533 by malloc() limitations. It is therefore best not to assume that the | |
| 2537 effective length limit is exactly what you set it to be. | |
| 2538 | |
| 2539 | |
| 2540 If you want to supply your own marker-reading routine, you do it by calling | |
| 2541 jpeg_set_marker_processor(). A marker processor routine must have the | |
| 2542 signature | |
| 2543 boolean jpeg_marker_parser_method (j_decompress_ptr cinfo) | |
| 2544 Although the marker code is not explicitly passed, the routine can find it | |
| 2545 in cinfo->unread_marker. At the time of call, the marker proper has been | |
| 2546 read from the data source module. The processor routine is responsible for | |
| 2547 reading the marker length word and the remaining parameter bytes, if any. | |
| 2548 Return TRUE to indicate success. (FALSE should be returned only if you are | |
| 2549 using a suspending data source and it tells you to suspend. See the standard | |
| 2550 marker processors in jdmarker.c for appropriate coding methods if you need to | |
| 2551 use a suspending data source.) | |
| 2552 | |
| 2553 If you override the default APP0 or APP14 processors, it is up to you to | |
| 2554 recognize JFIF and Adobe markers if you want colorspace recognition to occur | |
| 2555 properly. We recommend copying and extending the default processors if you | |
| 2556 want to do that. (A better idea is to save these marker types for later | |
| 2557 examination by calling jpeg_save_markers(); that method doesn't interfere | |
| 2558 with the library's own processing of these markers.) | |
| 2559 | |
| 2560 jpeg_set_marker_processor() and jpeg_save_markers() are mutually exclusive | |
| 2561 --- if you call one it overrides any previous call to the other, for the | |
| 2562 particular marker type specified. | |
| 2563 | |
| 2564 A simple example of an external COM processor can be found in djpeg.c. | |
| 2565 Also, see jpegtran.c for an example of using jpeg_save_markers. | |
| 2566 | |
| 2567 | |
| 2568 Raw (downsampled) image data | |
| 2569 ---------------------------- | |
| 2570 | |
| 2571 Some applications need to supply already-downsampled image data to the JPEG | |
| 2572 compressor, or to receive raw downsampled data from the decompressor. The | |
| 2573 library supports this requirement by allowing the application to write or | |
| 2574 read raw data, bypassing the normal preprocessing or postprocessing steps. | |
| 2575 The interface is different from the standard one and is somewhat harder to | |
| 2576 use. If your interest is merely in bypassing color conversion, we recommend | |
| 2577 that you use the standard interface and simply set jpeg_color_space = | |
| 2578 in_color_space (or jpeg_color_space = out_color_space for decompression). | |
| 2579 The mechanism described in this section is necessary only to supply or | |
| 2580 receive downsampled image data, in which not all components have the same | |
| 2581 dimensions. | |
| 2582 | |
| 2583 | |
| 2584 To compress raw data, you must supply the data in the colorspace to be used | |
| 2585 in the JPEG file (please read the earlier section on Special color spaces) | |
| 2586 and downsampled to the sampling factors specified in the JPEG parameters. | |
| 2587 You must supply the data in the format used internally by the JPEG library, | |
| 2588 namely a JSAMPIMAGE array. This is an array of pointers to two-dimensional | |
| 2589 arrays, each of type JSAMPARRAY. Each 2-D array holds the values for one | |
| 2590 color component. This structure is necessary since the components are of | |
| 2591 different sizes. If the image dimensions are not a multiple of the MCU size, | |
| 2592 you must also pad the data correctly (usually, this is done by replicating | |
| 2593 the last column and/or row). The data must be padded to a multiple of a DCT | |
| 2594 block in each component: that is, each downsampled row must contain a | |
| 2595 multiple of DCT_h_scaled_size valid samples, and there must be a multiple of | |
| 2596 DCT_v_scaled_size sample rows for each component. (For applications such as | |
| 2597 conversion of digital TV images, the standard image size is usually a | |
| 2598 multiple of the DCT block size, so that no padding need actually be done.) | |
| 2599 | |
| 2600 The procedure for compression of raw data is basically the same as normal | |
| 2601 compression, except that you call jpeg_write_raw_data() in place of | |
| 2602 jpeg_write_scanlines(). Before calling jpeg_start_compress(), you must do | |
| 2603 the following: | |
| 2604 * Set cinfo->raw_data_in to TRUE. (It is set FALSE by jpeg_set_defaults().) | |
| 2605 This notifies the library that you will be supplying raw data. | |
| 2606 * Ensure jpeg_color_space is correct --- an explicit jpeg_set_colorspace() | |
| 2607 call is a good idea. Note that since color conversion is bypassed, | |
| 2608 in_color_space is ignored, except that jpeg_set_defaults() uses it to | |
| 2609 choose the default jpeg_color_space setting. | |
| 2610 * Ensure the sampling factors, cinfo->comp_info[i].h_samp_factor and | |
| 2611 cinfo->comp_info[i].v_samp_factor, are correct. Since these indicate the | |
| 2612 dimensions of the data you are supplying, it's wise to set them | |
| 2613 explicitly, rather than assuming the library's defaults are what you want. | |
| 2614 | |
| 2615 To pass raw data to the library, call jpeg_write_raw_data() in place of | |
| 2616 jpeg_write_scanlines(). The two routines work similarly except that | |
| 2617 jpeg_write_raw_data takes a JSAMPIMAGE data array rather than JSAMPARRAY. | |
| 2618 The scanlines count passed to and returned from jpeg_write_raw_data is | |
| 2619 measured in terms of the component with the largest v_samp_factor. | |
| 2620 | |
| 2621 jpeg_write_raw_data() processes one MCU row per call, which is to say | |
| 2622 v_samp_factor*min_DCT_v_scaled_size sample rows of each component. The passed | |
| 2623 num_lines value must be at least max_v_samp_factor*min_DCT_v_scaled_size, and | |
| 2624 the return value will be exactly that amount (or possibly some multiple of | |
| 2625 that amount, in future library versions). This is true even on the last call | |
| 2626 at the bottom of the image; don't forget to pad your data as necessary. | |
| 2627 | |
| 2628 The required dimensions of the supplied data can be computed for each | |
| 2629 component as | |
| 2630 cinfo->comp_info[i].width_in_blocks * | |
| 2631 cinfo->comp_info[i].DCT_h_scaled_size samples per row | |
| 2632 cinfo->comp_info[i].height_in_blocks * | |
| 2633 cinfo->comp_info[i].DCT_v_scaled_size rows in image | |
| 2634 after jpeg_start_compress() has initialized those fields. If the valid data | |
| 2635 is smaller than this, it must be padded appropriately. For some sampling | |
| 2636 factors and image sizes, additional dummy DCT blocks are inserted to make | |
| 2637 the image a multiple of the MCU dimensions. The library creates such dummy | |
| 2638 blocks itself; it does not read them from your supplied data. Therefore you | |
| 2639 need never pad by more than DCT_scaled_size samples. | |
| 2640 An example may help here. Assume 2h2v downsampling of YCbCr data, that is | |
| 2641 cinfo->comp_info[0].h_samp_factor = 2 for Y | |
| 2642 cinfo->comp_info[0].v_samp_factor = 2 | |
| 2643 cinfo->comp_info[1].h_samp_factor = 1 for Cb | |
| 2644 cinfo->comp_info[1].v_samp_factor = 1 | |
| 2645 cinfo->comp_info[2].h_samp_factor = 1 for Cr | |
| 2646 cinfo->comp_info[2].v_samp_factor = 1 | |
| 2647 and suppose that the nominal image dimensions (cinfo->image_width and | |
| 2648 cinfo->image_height) are 101x101 pixels. Then jpeg_start_compress() will | |
| 2649 compute downsampled_width = 101 and width_in_blocks = 13 for Y, | |
| 2650 downsampled_width = 51 and width_in_blocks = 7 for Cb and Cr (and the same | |
| 2651 for the height fields). You must pad the Y data to at least 13*8 = 104 | |
| 2652 columns and rows, the Cb/Cr data to at least 7*8 = 56 columns and rows. The | |
| 2653 MCU height is max_v_samp_factor = 2 DCT rows so you must pass at least 16 | |
| 2654 scanlines on each call to jpeg_write_raw_data(), which is to say 16 actual | |
| 2655 sample rows of Y and 8 each of Cb and Cr. A total of 7 MCU rows are needed, | |
| 2656 so you must pass a total of 7*16 = 112 "scanlines". The last DCT block row | |
| 2657 of Y data is dummy, so it doesn't matter what you pass for it in the data | |
| 2658 arrays, but the scanlines count must total up to 112 so that all of the Cb | |
| 2659 and Cr data gets passed. | |
| 2660 | |
| 2661 Output suspension is supported with raw-data compression: if the data | |
| 2662 destination module suspends, jpeg_write_raw_data() will return 0. | |
| 2663 In this case the same data rows must be passed again on the next call. | |
| 2664 | |
| 2665 | |
| 2666 Decompression with raw data output implies bypassing all postprocessing: | |
| 2667 you cannot ask for color quantization, for instance. More seriously, you | |
| 2668 must deal with the color space and sampling factors present in the incoming | |
| 2669 file. If your application only handles, say, 2h1v YCbCr data, you must | |
| 2670 check for and fail on other color spaces or other sampling factors. | |
| 2671 The library will not convert to a different color space for you. | |
| 2672 | |
| 2673 To obtain raw data output, set cinfo->raw_data_out = TRUE before | |
| 2674 jpeg_start_decompress() (it is set FALSE by jpeg_read_header()). Be sure to | |
| 2675 verify that the color space and sampling factors are ones you can handle. | |
| 2676 Then call jpeg_read_raw_data() in place of jpeg_read_scanlines(). The | |
| 2677 decompression process is otherwise the same as usual. | |
| 2678 | |
| 2679 jpeg_read_raw_data() returns one MCU row per call, and thus you must pass a | |
| 2680 buffer of at least max_v_samp_factor*min_DCT_v_scaled_size scanlines (scanline | |
| 2681 counting is the same as for raw-data compression). The buffer you pass must | |
| 2682 be large enough to hold the actual data plus padding to DCT-block boundaries. | |
| 2683 As with compression, any entirely dummy DCT blocks are not processed so you | |
| 2684 need not allocate space for them, but the total scanline count includes them. | |
| 2685 The above example of computing buffer dimensions for raw-data compression is | |
| 2686 equally valid for decompression. | |
| 2687 | |
| 2688 Input suspension is supported with raw-data decompression: if the data source | |
| 2689 module suspends, jpeg_read_raw_data() will return 0. You can also use | |
| 2690 buffered-image mode to read raw data in multiple passes. | |
| 2691 | |
| 2692 | |
| 2693 Really raw data: DCT coefficients | |
| 2694 --------------------------------- | |
| 2695 | |
| 2696 It is possible to read or write the contents of a JPEG file as raw DCT | |
| 2697 coefficients. This facility is mainly intended for use in lossless | |
| 2698 transcoding between different JPEG file formats. Other possible applications | |
| 2699 include lossless cropping of a JPEG image, lossless reassembly of a | |
| 2700 multi-strip or multi-tile TIFF/JPEG file into a single JPEG datastream, etc. | |
| 2701 | |
| 2702 To read the contents of a JPEG file as DCT coefficients, open the file and do | |
| 2703 jpeg_read_header() as usual. But instead of calling jpeg_start_decompress() | |
| 2704 and jpeg_read_scanlines(), call jpeg_read_coefficients(). This will read the | |
| 2705 entire image into a set of virtual coefficient-block arrays, one array per | |
| 2706 component. The return value is a pointer to an array of virtual-array | |
| 2707 descriptors. Each virtual array can be accessed directly using the JPEG | |
| 2708 memory manager's access_virt_barray method (see Memory management, below, | |
| 2709 and also read structure.txt's discussion of virtual array handling). Or, | |
| 2710 for simple transcoding to a different JPEG file format, the array list can | |
| 2711 just be handed directly to jpeg_write_coefficients(). | |
| 2712 | |
| 2713 Each block in the block arrays contains quantized coefficient values in | |
| 2714 normal array order (not JPEG zigzag order). The block arrays contain only | |
| 2715 DCT blocks containing real data; any entirely-dummy blocks added to fill out | |
| 2716 interleaved MCUs at the right or bottom edges of the image are discarded | |
| 2717 during reading and are not stored in the block arrays. (The size of each | |
| 2718 block array can be determined from the width_in_blocks and height_in_blocks | |
| 2719 fields of the component's comp_info entry.) This is also the data format | |
| 2720 expected by jpeg_write_coefficients(). | |
| 2721 | |
| 2722 When you are done using the virtual arrays, call jpeg_finish_decompress() | |
| 2723 to release the array storage and return the decompression object to an idle | |
| 2724 state; or just call jpeg_destroy() if you don't need to reuse the object. | |
| 2725 | |
| 2726 If you use a suspending data source, jpeg_read_coefficients() will return | |
| 2727 NULL if it is forced to suspend; a non-NULL return value indicates successful | |
| 2728 completion. You need not test for a NULL return value when using a | |
| 2729 non-suspending data source. | |
| 2730 | |
| 2731 It is also possible to call jpeg_read_coefficients() to obtain access to the | |
| 2732 decoder's coefficient arrays during a normal decode cycle in buffered-image | |
| 2733 mode. This frammish might be useful for progressively displaying an incoming | |
| 2734 image and then re-encoding it without loss. To do this, decode in buffered- | |
| 2735 image mode as discussed previously, then call jpeg_read_coefficients() after | |
| 2736 the last jpeg_finish_output() call. The arrays will be available for your use | |
| 2737 until you call jpeg_finish_decompress(). | |
| 2738 | |
| 2739 | |
| 2740 To write the contents of a JPEG file as DCT coefficients, you must provide | |
| 2741 the DCT coefficients stored in virtual block arrays. You can either pass | |
| 2742 block arrays read from an input JPEG file by jpeg_read_coefficients(), or | |
| 2743 allocate virtual arrays from the JPEG compression object and fill them | |
| 2744 yourself. In either case, jpeg_write_coefficients() is substituted for | |
| 2745 jpeg_start_compress() and jpeg_write_scanlines(). Thus the sequence is | |
| 2746 * Create compression object | |
| 2747 * Set all compression parameters as necessary | |
| 2748 * Request virtual arrays if needed | |
| 2749 * jpeg_write_coefficients() | |
| 2750 * jpeg_finish_compress() | |
| 2751 * Destroy or re-use compression object | |
| 2752 jpeg_write_coefficients() is passed a pointer to an array of virtual block | |
| 2753 array descriptors; the number of arrays is equal to cinfo.num_components. | |
| 2754 | |
| 2755 The virtual arrays need only have been requested, not realized, before | |
| 2756 jpeg_write_coefficients() is called. A side-effect of | |
| 2757 jpeg_write_coefficients() is to realize any virtual arrays that have been | |
| 2758 requested from the compression object's memory manager. Thus, when obtaining | |
| 2759 the virtual arrays from the compression object, you should fill the arrays | |
| 2760 after calling jpeg_write_coefficients(). The data is actually written out | |
| 2761 when you call jpeg_finish_compress(); jpeg_write_coefficients() only writes | |
| 2762 the file header. | |
| 2763 | |
| 2764 When writing raw DCT coefficients, it is crucial that the JPEG quantization | |
| 2765 tables and sampling factors match the way the data was encoded, or the | |
| 2766 resulting file will be invalid. For transcoding from an existing JPEG file, | |
| 2767 we recommend using jpeg_copy_critical_parameters(). This routine initializes | |
| 2768 all the compression parameters to default values (like jpeg_set_defaults()), | |
| 2769 then copies the critical information from a source decompression object. | |
| 2770 The decompression object should have just been used to read the entire | |
| 2771 JPEG input file --- that is, it should be awaiting jpeg_finish_decompress(). | |
| 2772 | |
| 2773 jpeg_write_coefficients() marks all tables stored in the compression object | |
| 2774 as needing to be written to the output file (thus, it acts like | |
| 2775 jpeg_start_compress(cinfo, TRUE)). This is for safety's sake, to avoid | |
| 2776 emitting abbreviated JPEG files by accident. If you really want to emit an | |
| 2777 abbreviated JPEG file, call jpeg_suppress_tables(), or set the tables' | |
| 2778 individual sent_table flags, between calling jpeg_write_coefficients() and | |
| 2779 jpeg_finish_compress(). | |
| 2780 | |
| 2781 | |
| 2782 Progress monitoring | |
| 2783 ------------------- | |
| 2784 | |
| 2785 Some applications may need to regain control from the JPEG library every so | |
| 2786 often. The typical use of this feature is to produce a percent-done bar or | |
| 2787 other progress display. (For a simple example, see cjpeg.c or djpeg.c.) | |
| 2788 Although you do get control back frequently during the data-transferring pass | |
| 2789 (the jpeg_read_scanlines or jpeg_write_scanlines loop), any additional passes | |
| 2790 will occur inside jpeg_finish_compress or jpeg_start_decompress; those | |
| 2791 routines may take a long time to execute, and you don't get control back | |
| 2792 until they are done. | |
| 2793 | |
| 2794 You can define a progress-monitor routine which will be called periodically | |
| 2795 by the library. No guarantees are made about how often this call will occur, | |
| 2796 so we don't recommend you use it for mouse tracking or anything like that. | |
| 2797 At present, a call will occur once per MCU row, scanline, or sample row | |
| 2798 group, whichever unit is convenient for the current processing mode; so the | |
| 2799 wider the image, the longer the time between calls. During the data | |
| 2800 transferring pass, only one call occurs per call of jpeg_read_scanlines or | |
| 2801 jpeg_write_scanlines, so don't pass a large number of scanlines at once if | |
| 2802 you want fine resolution in the progress count. (If you really need to use | |
| 2803 the callback mechanism for time-critical tasks like mouse tracking, you could | |
| 2804 insert additional calls inside some of the library's inner loops.) | |
| 2805 | |
| 2806 To establish a progress-monitor callback, create a struct jpeg_progress_mgr, | |
| 2807 fill in its progress_monitor field with a pointer to your callback routine, | |
| 2808 and set cinfo->progress to point to the struct. The callback will be called | |
| 2809 whenever cinfo->progress is non-NULL. (This pointer is set to NULL by | |
| 2810 jpeg_create_compress or jpeg_create_decompress; the library will not change | |
| 2811 it thereafter. So if you allocate dynamic storage for the progress struct, | |
| 2812 make sure it will live as long as the JPEG object does. Allocating from the | |
| 2813 JPEG memory manager with lifetime JPOOL_PERMANENT will work nicely.) You | |
| 2814 can use the same callback routine for both compression and decompression. | |
| 2815 | |
| 2816 The jpeg_progress_mgr struct contains four fields which are set by the library: | |
| 2817 long pass_counter; /* work units completed in this pass */ | |
| 2818 long pass_limit; /* total number of work units in this pass */ | |
| 2819 int completed_passes; /* passes completed so far */ | |
| 2820 int total_passes; /* total number of passes expected */ | |
| 2821 During any one pass, pass_counter increases from 0 up to (not including) | |
| 2822 pass_limit; the step size is usually but not necessarily 1. The pass_limit | |
| 2823 value may change from one pass to another. The expected total number of | |
| 2824 passes is in total_passes, and the number of passes already completed is in | |
| 2825 completed_passes. Thus the fraction of work completed may be estimated as | |
| 2826 completed_passes + (pass_counter/pass_limit) | |
| 2827 -------------------------------------------- | |
| 2828 total_passes | |
| 2829 ignoring the fact that the passes may not be equal amounts of work. | |
| 2830 | |
| 2831 When decompressing, pass_limit can even change within a pass, because it | |
| 2832 depends on the number of scans in the JPEG file, which isn't always known in | |
| 2833 advance. The computed fraction-of-work-done may jump suddenly (if the library | |
| 2834 discovers it has overestimated the number of scans) or even decrease (in the | |
| 2835 opposite case). It is not wise to put great faith in the work estimate. | |
| 2836 | |
| 2837 When using the decompressor's buffered-image mode, the progress monitor work | |
| 2838 estimate is likely to be completely unhelpful, because the library has no way | |
| 2839 to know how many output passes will be demanded of it. Currently, the library | |
| 2840 sets total_passes based on the assumption that there will be one more output | |
| 2841 pass if the input file end hasn't yet been read (jpeg_input_complete() isn't | |
| 2842 TRUE), but no more output passes if the file end has been reached when the | |
| 2843 output pass is started. This means that total_passes will rise as additional | |
| 2844 output passes are requested. If you have a way of determining the input file | |
| 2845 size, estimating progress based on the fraction of the file that's been read | |
| 2846 will probably be more useful than using the library's value. | |
| 2847 | |
| 2848 | |
| 2849 Memory management | |
| 2850 ----------------- | |
| 2851 | |
| 2852 This section covers some key facts about the JPEG library's built-in memory | |
| 2853 manager. For more info, please read structure.txt's section about the memory | |
| 2854 manager, and consult the source code if necessary. | |
| 2855 | |
| 2856 All memory and temporary file allocation within the library is done via the | |
| 2857 memory manager. If necessary, you can replace the "back end" of the memory | |
| 2858 manager to control allocation yourself (for example, if you don't want the | |
| 2859 library to use malloc() and free() for some reason). | |
| 2860 | |
| 2861 Some data is allocated "permanently" and will not be freed until the JPEG | |
| 2862 object is destroyed. Most data is allocated "per image" and is freed by | |
| 2863 jpeg_finish_compress, jpeg_finish_decompress, or jpeg_abort. You can call the | |
| 2864 memory manager yourself to allocate structures that will automatically be | |
| 2865 freed at these times. Typical code for this is | |
| 2866 ptr = (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_IMAGE, size); | |
| 2867 Use JPOOL_PERMANENT to get storage that lasts as long as the JPEG object. | |
| 2868 Use alloc_large instead of alloc_small for anything bigger than a few Kbytes. | |
| 2869 There are also alloc_sarray and alloc_barray routines that automatically | |
| 2870 build 2-D sample or block arrays. | |
| 2871 | |
| 2872 The library's minimum space requirements to process an image depend on the | |
| 2873 image's width, but not on its height, because the library ordinarily works | |
| 2874 with "strip" buffers that are as wide as the image but just a few rows high. | |
| 2875 Some operating modes (eg, two-pass color quantization) require full-image | |
| 2876 buffers. Such buffers are treated as "virtual arrays": only the current strip | |
| 2877 need be in memory, and the rest can be swapped out to a temporary file. | |
| 2878 | |
| 2879 If you use the simplest memory manager back end (jmemnobs.c), then no | |
| 2880 temporary files are used; virtual arrays are simply malloc()'d. Images bigger | |
| 2881 than memory can be processed only if your system supports virtual memory. | |
| 2882 The other memory manager back ends support temporary files of various flavors | |
| 2883 and thus work in machines without virtual memory. They may also be useful on | |
| 2884 Unix machines if you need to process images that exceed available swap space. | |
| 2885 | |
| 2886 When using temporary files, the library will make the in-memory buffers for | |
| 2887 its virtual arrays just big enough to stay within a "maximum memory" setting. | |
| 2888 Your application can set this limit by setting cinfo->mem->max_memory_to_use | |
| 2889 after creating the JPEG object. (Of course, there is still a minimum size for | |
| 2890 the buffers, so the max-memory setting is effective only if it is bigger than | |
| 2891 the minimum space needed.) If you allocate any large structures yourself, you | |
| 2892 must allocate them before jpeg_start_compress() or jpeg_start_decompress() in | |
| 2893 order to have them counted against the max memory limit. Also keep in mind | |
| 2894 that space allocated with alloc_small() is ignored, on the assumption that | |
| 2895 it's too small to be worth worrying about; so a reasonable safety margin | |
| 2896 should be left when setting max_memory_to_use. | |
| 2897 | |
| 2898 If you use the jmemname.c or jmemdos.c memory manager back end, it is | |
| 2899 important to clean up the JPEG object properly to ensure that the temporary | |
| 2900 files get deleted. (This is especially crucial with jmemdos.c, where the | |
| 2901 "temporary files" may be extended-memory segments; if they are not freed, | |
| 2902 DOS will require a reboot to recover the memory.) Thus, with these memory | |
| 2903 managers, it's a good idea to provide a signal handler that will trap any | |
| 2904 early exit from your program. The handler should call either jpeg_abort() | |
| 2905 or jpeg_destroy() for any active JPEG objects. A handler is not needed with | |
| 2906 jmemnobs.c, and shouldn't be necessary with jmemansi.c or jmemmac.c either, | |
| 2907 since the C library is supposed to take care of deleting files made with | |
| 2908 tmpfile(). | |
| 2909 | |
| 2910 | |
| 2911 Memory usage | |
| 2912 ------------ | |
| 2913 | |
| 2914 Working memory requirements while performing compression or decompression | |
| 2915 depend on image dimensions, image characteristics (such as colorspace and | |
| 2916 JPEG process), and operating mode (application-selected options). | |
| 2917 | |
| 2918 As of v6b, the decompressor requires: | |
| 2919 1. About 24K in more-or-less-fixed-size data. This varies a bit depending | |
| 2920 on operating mode and image characteristics (particularly color vs. | |
| 2921 grayscale), but it doesn't depend on image dimensions. | |
| 2922 2. Strip buffers (of size proportional to the image width) for IDCT and | |
| 2923 upsampling results. The worst case for commonly used sampling factors | |
| 2924 is about 34 bytes * width in pixels for a color image. A grayscale image | |
| 2925 only needs about 8 bytes per pixel column. | |
| 2926 3. A full-image DCT coefficient buffer is needed to decode a multi-scan JPEG | |
| 2927 file (including progressive JPEGs), or whenever you select buffered-image | |
| 2928 mode. This takes 2 bytes/coefficient. At typical 2x2 sampling, that's | |
| 2929 3 bytes per pixel for a color image. Worst case (1x1 sampling) requires | |
| 2930 6 bytes/pixel. For grayscale, figure 2 bytes/pixel. | |
| 2931 4. To perform 2-pass color quantization, the decompressor also needs a | |
| 2932 128K color lookup table and a full-image pixel buffer (3 bytes/pixel). | |
| 2933 This does not count any memory allocated by the application, such as a | |
| 2934 buffer to hold the final output image. | |
| 2935 | |
| 2936 The above figures are valid for 8-bit JPEG data precision and a machine with | |
| 2937 32-bit ints. For 9-bit to 12-bit JPEG data, double the size of the strip | |
| 2938 buffers and quantization pixel buffer. The "fixed-size" data will be | |
| 2939 somewhat smaller with 16-bit ints, larger with 64-bit ints. Also, CMYK | |
| 2940 or other unusual color spaces will require different amounts of space. | |
| 2941 | |
| 2942 The full-image coefficient and pixel buffers, if needed at all, do not | |
| 2943 have to be fully RAM resident; you can have the library use temporary | |
| 2944 files instead when the total memory usage would exceed a limit you set. | |
| 2945 (But if your OS supports virtual memory, it's probably better to just use | |
| 2946 jmemnobs and let the OS do the swapping.) | |
| 2947 | |
| 2948 The compressor's memory requirements are similar, except that it has no need | |
| 2949 for color quantization. Also, it needs a full-image DCT coefficient buffer | |
| 2950 if Huffman-table optimization is asked for, even if progressive mode is not | |
| 2951 requested. | |
| 2952 | |
| 2953 If you need more detailed information about memory usage in a particular | |
| 2954 situation, you can enable the MEM_STATS code in jmemmgr.c. | |
| 2955 | |
| 2956 | |
| 2957 Library compile-time options | |
| 2958 ---------------------------- | |
| 2959 | |
| 2960 A number of compile-time options are available by modifying jmorecfg.h. | |
| 2961 | |
| 2962 The IJG code currently supports 8-bit to 12-bit sample data precision by | |
| 2963 defining BITS_IN_JSAMPLE as 8, 9, 10, 11, or 12. | |
| 2964 Note that a value larger than 8 causes JSAMPLE to be larger than a char, | |
| 2965 so it affects the surrounding application's image data. | |
| 2966 The sample applications cjpeg and djpeg can support deeper than 8-bit data | |
| 2967 only for PPM and GIF file formats; you must disable the other file formats | |
| 2968 to compile a 9-bit to 12-bit cjpeg or djpeg. (install.txt has more | |
| 2969 information about that.) | |
| 2970 Run-time selection and conversion of data precision are currently not | |
| 2971 supported and may be added later. | |
| 2972 Exception: The transcoding part (jpegtran) supports all settings in a | |
| 2973 single instance, since it operates on the level of DCT coefficients and | |
| 2974 not sample values. | |
| 2975 (If you need to include an 8-bit library and a 9-bit to 12-bit library for | |
| 2976 compression or decompression in a single application, you could probably do | |
| 2977 it by defining NEED_SHORT_EXTERNAL_NAMES for just one of the copies. You'd | |
| 2978 have to access the 8-bit and the 9-bit to 12-bit copies from separate | |
| 2979 application source files. This is untested ... if you try it, we'd like to | |
| 2980 hear whether it works!) | |
| 2981 | |
| 2982 Note that the standard Huffman tables are only valid for 8-bit data precision. | |
| 2983 If you selected more than 8-bit data precision, cjpeg uses arithmetic coding | |
| 2984 by default. The Huffman encoder normally uses entropy optimization to | |
| 2985 compute usable tables for higher precision. Otherwise, you'll have to | |
| 2986 supply different default Huffman tables. You may also want to supply your | |
| 2987 own DCT quantization tables; the existing quality-scaling code has been | |
| 2988 developed for 8-bit use, and probably doesn't generate especially good tables | |
| 2989 for 9-bit to 12-bit. | |
| 2990 | |
| 2991 The maximum number of components (color channels) in the image is determined | |
| 2992 by MAX_COMPONENTS. The JPEG standard allows up to 255 components, but we | |
| 2993 expect that few applications will need more than four or so. | |
| 2994 | |
| 2995 On machines with unusual data type sizes, you may be able to improve | |
| 2996 performance or reduce memory space by tweaking the various typedefs in | |
| 2997 jmorecfg.h. In particular, on some RISC CPUs, access to arrays of "short"s | |
| 2998 is quite slow; consider trading memory for speed by making JCOEF, INT16, and | |
| 2999 UINT16 be "int" or "unsigned int". UINT8 is also a candidate to become int. | |
| 3000 You probably don't want to make JSAMPLE be int unless you have lots of memory | |
| 3001 to burn. | |
| 3002 | |
| 3003 You can reduce the size of the library by compiling out various optional | |
| 3004 functions. To do this, undefine xxx_SUPPORTED symbols as necessary. | |
| 3005 | |
| 3006 You can also save a few K by not having text error messages in the library; | |
| 3007 the standard error message table occupies about 5Kb. This is particularly | |
| 3008 reasonable for embedded applications where there's no good way to display | |
| 3009 a message anyway. To do this, remove the creation of the message table | |
| 3010 (jpeg_std_message_table[]) from jerror.c, and alter format_message to do | |
| 3011 something reasonable without it. You could output the numeric value of the | |
| 3012 message code number, for example. If you do this, you can also save a couple | |
| 3013 more K by modifying the TRACEMSn() macros in jerror.h to expand to nothing; | |
| 3014 you don't need trace capability anyway, right? | |
| 3015 | |
| 3016 | |
| 3017 Portability considerations | |
| 3018 -------------------------- | |
| 3019 | |
| 3020 The JPEG library has been written to be extremely portable; the sample | |
| 3021 applications cjpeg and djpeg are slightly less so. This section summarizes | |
| 3022 the design goals in this area. (If you encounter any bugs that cause the | |
| 3023 library to be less portable than is claimed here, we'd appreciate hearing | |
| 3024 about them.) | |
| 3025 | |
| 3026 The code works fine on ANSI C, C++, and pre-ANSI C compilers, using any of | |
| 3027 the popular system include file setups, and some not-so-popular ones too. | |
| 3028 See install.txt for configuration procedures. | |
| 3029 | |
| 3030 The code is not dependent on the exact sizes of the C data types. As | |
| 3031 distributed, we make the assumptions that | |
| 3032 char is at least 8 bits wide | |
| 3033 short is at least 16 bits wide | |
| 3034 int is at least 16 bits wide | |
| 3035 long is at least 32 bits wide | |
| 3036 (These are the minimum requirements of the ANSI C standard.) Wider types will | |
| 3037 work fine, although memory may be used inefficiently if char is much larger | |
| 3038 than 8 bits or short is much bigger than 16 bits. The code should work | |
| 3039 equally well with 16- or 32-bit ints. | |
| 3040 | |
| 3041 In a system where these assumptions are not met, you may be able to make the | |
| 3042 code work by modifying the typedefs in jmorecfg.h. However, you will probably | |
| 3043 have difficulty if int is less than 16 bits wide, since references to plain | |
| 3044 int abound in the code. | |
| 3045 | |
| 3046 char can be either signed or unsigned, although the code runs faster if an | |
| 3047 unsigned char type is available. If char is wider than 8 bits, you will need | |
| 3048 to redefine JOCTET and/or provide custom data source/destination managers so | |
| 3049 that JOCTET represents exactly 8 bits of data on external storage. | |
| 3050 | |
| 3051 The JPEG library proper does not assume ASCII representation of characters. | |
| 3052 But some of the image file I/O modules in cjpeg/djpeg do have ASCII | |
| 3053 dependencies in file-header manipulation; so does cjpeg's select_file_type() | |
| 3054 routine. | |
| 3055 | |
| 3056 The JPEG library does not rely heavily on the C library. In particular, C | |
| 3057 stdio is used only by the data source/destination modules and the error | |
| 3058 handler, all of which are application-replaceable. (cjpeg/djpeg are more | |
| 3059 heavily dependent on stdio.) malloc and free are called only from the memory | |
| 3060 manager "back end" module, so you can use a different memory allocator by | |
| 3061 replacing that one file. | |
| 3062 | |
| 3063 The code generally assumes that C names must be unique in the first 15 | |
| 3064 characters. However, global function names can be made unique in the | |
| 3065 first 6 characters by defining NEED_SHORT_EXTERNAL_NAMES. | |
| 3066 | |
| 3067 More info about porting the code may be gleaned by reading jconfig.txt, | |
| 3068 jmorecfg.h, and jinclude.h. | |
| 3069 | |
| 3070 | |
| 3071 Notes for MS-DOS implementors | |
| 3072 ----------------------------- | |
| 3073 | |
| 3074 The IJG code is designed to work efficiently in 80x86 "small" or "medium" | |
| 3075 memory models (i.e., data pointers are 16 bits unless explicitly declared | |
| 3076 "far"; code pointers can be either size). You may be able to use small | |
| 3077 model to compile cjpeg or djpeg by itself, but you will probably have to use | |
| 3078 medium model for any larger application. This won't make much difference in | |
| 3079 performance. You *will* take a noticeable performance hit if you use a | |
| 3080 large-data memory model (perhaps 10%-25%), and you should avoid "huge" model | |
| 3081 if at all possible. | |
| 3082 | |
| 3083 The JPEG library typically needs 2Kb-3Kb of stack space. It will also | |
| 3084 malloc about 20K-30K of near heap space while executing (and lots of far | |
| 3085 heap, but that doesn't count in this calculation). This figure will vary | |
| 3086 depending on selected operating mode, and to a lesser extent on image size. | |
| 3087 There is also about 5Kb-6Kb of constant data which will be allocated in the | |
| 3088 near data segment (about 4Kb of this is the error message table). | |
| 3089 Thus you have perhaps 20K available for other modules' static data and near | |
| 3090 heap space before you need to go to a larger memory model. The C library's | |
| 3091 static data will account for several K of this, but that still leaves a good | |
| 3092 deal for your needs. (If you are tight on space, you could reduce the sizes | |
| 3093 of the I/O buffers allocated by jdatasrc.c and jdatadst.c, say from 4K to | |
| 3094 1K. Another possibility is to move the error message table to far memory; | |
| 3095 this should be doable with only localized hacking on jerror.c.) | |
| 3096 | |
| 3097 About 2K of the near heap space is "permanent" memory that will not be | |
| 3098 released until you destroy the JPEG object. This is only an issue if you | |
| 3099 save a JPEG object between compression or decompression operations. | |
| 3100 | |
| 3101 Far data space may also be a tight resource when you are dealing with large | |
| 3102 images. The most memory-intensive case is decompression with two-pass color | |
| 3103 quantization, or single-pass quantization to an externally supplied color | |
| 3104 map. This requires a 128Kb color lookup table plus strip buffers amounting | |
| 3105 to about 40 bytes per column for typical sampling ratios (eg, about 25600 | |
| 3106 bytes for a 640-pixel-wide image). You may not be able to process wide | |
| 3107 images if you have large data structures of your own. | |
| 3108 | |
| 3109 Of course, all of these concerns vanish if you use a 32-bit flat-memory-model | |
| 3110 compiler, such as DJGPP or Watcom C. We highly recommend flat model if you | |
| 3111 can use it; the JPEG library is significantly faster in flat model. |
