blob: 2abfbeab296cfe81a41adf91507a4d9dd9cc7f3c [file] [log] [blame]
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +00001USAGE instructions for the Independent JPEG Group's JPEG software
2=================================================================
3
4This file describes usage of the JPEG conversion programs cjpeg and djpeg,
Thomas G. Lanebc79e061995-08-02 00:00:00 +00005as well as the utility programs jpegtran, rdjpgcom and wrjpgcom. (See
6the other documentation files if you wish to use the JPEG library within
7your own programs.)
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +00008
9If you are on a Unix machine you may prefer to read the Unix-style manual
Thomas G. Lanebc79e061995-08-02 00:00:00 +000010pages in files cjpeg.1, djpeg.1, jpegtran.1, rdjpgcom.1, wrjpgcom.1.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000011
12
13INTRODUCTION
14
Guido Vollbeding5996a252009-06-27 00:00:00 +000015These programs implement JPEG image encoding, decoding, and transcoding.
16JPEG (pronounced "jay-peg") is a standardized compression method for
17full-color and gray-scale images.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000018
19
20GENERAL USAGE
21
22We provide two programs, cjpeg to compress an image file into JPEG format,
23and djpeg to decompress a JPEG file back into a conventional image format.
24
25On Unix-like systems, you say:
26 cjpeg [switches] [imagefile] >jpegfile
27or
28 djpeg [switches] [jpegfile] >imagefile
29The programs read the specified input file, or standard input if none is
30named. They always write to standard output (with trace/error messages to
31standard error). These conventions are handy for piping images between
32programs.
33
34On most non-Unix systems, you say:
35 cjpeg [switches] imagefile jpegfile
36or
37 djpeg [switches] jpegfile imagefile
38i.e., both the input and output files are named on the command line. This
39style is a little more foolproof, and it loses no functionality if you don't
40have pipes. (You can get this style on Unix too, if you prefer, by defining
Guido Vollbeding5996a252009-06-27 00:00:00 +000041TWO_FILE_COMMANDLINE when you compile the programs; see install.txt.)
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000042
43You can also say:
44 cjpeg [switches] -outfile jpegfile imagefile
45or
46 djpeg [switches] -outfile imagefile jpegfile
47This syntax works on all systems, so it is useful for scripts.
48
49The currently supported image file formats are: PPM (PBMPLUS color format),
Thomas G. Lane5ead57a1998-03-27 00:00:00 +000050PGM (PBMPLUS gray-scale format), BMP, Targa, and RLE (Utah Raster Toolkit
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000051format). (RLE is supported only if the URT library is available.)
52cjpeg recognizes the input image format automatically, with the exception
53of some Targa-format files. You have to tell djpeg which format to generate.
54
55JPEG files are in the defacto standard JFIF file format. There are other,
56less widely used JPEG-based file formats, but we don't support them.
57
58All switch names may be abbreviated; for example, -grayscale may be written
59-gray or -gr. Most of the "basic" switches can be abbreviated to as little as
Thomas G. Lane5ead57a1998-03-27 00:00:00 +000060one letter. Upper and lower case are equivalent (-BMP is the same as -bmp).
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000061British spellings are also accepted (e.g., -greyscale), though for brevity
62these are not mentioned below.
63
64
65CJPEG DETAILS
66
67The basic command line switches for cjpeg are:
68
Guido Vollbeding5996a252009-06-27 00:00:00 +000069 -quality N[,...] Scale quantization tables to adjust image quality.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000070 Quality is 0 (worst) to 100 (best); default is 75.
71 (See below for more info.)
72
73 -grayscale Create monochrome JPEG file from color input.
74 Be sure to use this switch when compressing a grayscale
Thomas G. Lane5ead57a1998-03-27 00:00:00 +000075 BMP file, because cjpeg isn't bright enough to notice
76 whether a BMP file uses only shades of gray. By
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000077 saying -grayscale, you'll get a smaller JPEG file that
78 takes less time to process.
79
80 -optimize Perform optimization of entropy encoding parameters.
81 Without this, default encoding parameters are used.
82 -optimize usually makes the JPEG file a little smaller,
83 but cjpeg runs somewhat slower and needs much more
84 memory. Image quality and speed of decompression are
85 unaffected by -optimize.
86
Thomas G. Lanebc79e061995-08-02 00:00:00 +000087 -progressive Create progressive JPEG file (see below).
88
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +000089 -targa Input file is Targa format. Targa files that contain
90 an "identification" field will not be automatically
91 recognized by cjpeg; for such files you must specify
92 -targa to make cjpeg treat the input as Targa format.
93 For most Targa files, you won't need this switch.
94
95The -quality switch lets you trade off compressed file size against quality of
96the reconstructed image: the higher the quality setting, the larger the JPEG
97file, and the closer the output image will be to the original input. Normally
98you want to use the lowest quality setting (smallest file) that decompresses
99into something visually indistinguishable from the original image. For this
100purpose the quality setting should be between 50 and 95; the default of 75 is
101often about right. If you see defects at -quality 75, then go up 5 or 10
102counts at a time until you are happy with the output image. (The optimal
103setting will vary from one image to another.)
104
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000105-quality 100 will generate a quantization table of all 1's, minimizing loss
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000106in the quantization step (but there is still information loss in subsampling,
107as well as roundoff error). This setting is mainly of interest for
108experimental purposes. Quality values above about 95 are NOT recommended for
109normal use; the compressed file size goes up dramatically for hardly any gain
110in output image quality.
111
112In the other direction, quality values below 50 will produce very small files
113of low image quality. Settings around 5 to 10 might be useful in preparing an
114index of a large image library, for example. Try -quality 2 (or so) for some
115amusing Cubist effects. (Note: quality values below about 25 generate 2-byte
116quantization tables, which are considered optional in the JPEG standard.
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000117cjpeg emits a warning message when you give such a quality value, because some
118other JPEG programs may be unable to decode the resulting file. Use -baseline
119if you need to ensure compatibility at low quality values.)
120
DRC39ea5622010-10-12 01:55:31 +0000121The -quality option has been extended in this version of cjpeg to support
122separate quality settings for luminance and chrominance (or, in general,
123separate settings for every quantization table slot.) The principle is the
124same as chrominance subsampling: since the human eye is more sensitive to
125spatial changes in brightness than spatial changes in color, the chrominance
126components can be quantized more than the luminance components without
127incurring any visible image quality loss. However, unlike subsampling, this
128feature reduces data in the frequency domain instead of the spatial domain,
129which allows for more fine-grained control. This option is useful in
130quality-sensitive applications, for which the artifacts generated by
131subsampling may be unacceptable.
132
133The -quality option accepts a comma-separated list of parameters, which
DRCccd1bfd2012-01-31 09:53:46 +0000134respectively refer to the quality levels that should be assigned to the
DRC39ea5622010-10-12 01:55:31 +0000135quantization table slots. If there are more q-table slots than parameters,
136then the last parameter is replicated. Thus, if only one quality parameter is
137given, this is used for both luminance and chrominance (slots 0 and 1,
138respectively), preserving the legacy behavior of cjpeg v6b and prior. More (or
139customized) quantization tables can be set with the -qtables option and
140assigned to components with the -qslots option (see the "wizard" switches
141below.)
142
143JPEG files generated with separate luminance and chrominance quality are
144fully compliant with standard JPEG decoders.
145
146CAUTION: For this setting to be useful, be sure to pass an argument of
147-sample 1x1 to cjpeg to disable chrominance subsampling. Otherwise, the
148default subsampling level (2x2, AKA "4:2:0") will be used.
Guido Vollbeding5996a252009-06-27 00:00:00 +0000149
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000150The -progressive switch creates a "progressive JPEG" file. In this type of
151JPEG file, the data is stored in multiple scans of increasing quality. If the
152file is being transmitted over a slow communications link, the decoder can use
153the first scan to display a low-quality image very quickly, and can then
154improve the display with each subsequent scan. The final image is exactly
155equivalent to a standard JPEG file of the same quality setting, and the total
Guido Vollbeding5996a252009-06-27 00:00:00 +0000156file size is about the same --- often a little smaller.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000157
158Switches for advanced users:
159
Guido Vollbeding5829cb22012-01-15 00:00:00 +0000160 -arithmetic Use arithmetic coding. CAUTION: arithmetic coded JPEG
161 is not yet widely implemented, so many decoders will
162 be unable to view an arithmetic coded JPEG file at
163 all.
164
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000165 -dct int Use integer DCT method (default).
166 -dct fast Use fast integer DCT (less accurate).
167 -dct float Use floating-point DCT method.
Thomas G. Lanea8b67c41995-03-15 00:00:00 +0000168 The float method is very slightly more accurate than
169 the int method, but is much slower unless your machine
170 has very fast floating-point hardware. Also note that
171 results of the floating-point method may vary slightly
172 across machines, while the integer methods should give
173 the same results everywhere. The fast integer method
174 is much less accurate than the other two.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000175
176 -restart N Emit a JPEG restart marker every N MCU rows, or every
177 N MCU blocks if "B" is attached to the number.
178 -restart 0 (the default) means no restart markers.
179
180 -smooth N Smooth the input image to eliminate dithering noise.
181 N, ranging from 1 to 100, indicates the strength of
182 smoothing. 0 (the default) means no smoothing.
183
184 -maxmemory N Set limit for amount of memory to use in processing
185 large images. Value is in thousands of bytes, or
186 millions of bytes if "M" is attached to the number.
187 For example, -max 4m selects 4000000 bytes. If more
188 space is needed, temporary files will be used.
189
190 -verbose Enable debug printout. More -v's give more printout.
191 or -debug Also, version information is printed at startup.
192
193The -restart option inserts extra markers that allow a JPEG decoder to
194resynchronize after a transmission error. Without restart markers, any damage
195to a compressed file will usually ruin the image from the point of the error
196to the end of the image; with restart markers, the damage is usually confined
197to the portion of the image up to the next restart marker. Of course, the
198restart markers occupy extra space. We recommend -restart 1 for images that
199will be transmitted across unreliable networks such as Usenet.
200
201The -smooth option filters the input to eliminate fine-scale noise. This is
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000202often useful when converting dithered images to JPEG: a moderate smoothing
203factor of 10 to 50 gets rid of dithering patterns in the input file, resulting
204in a smaller JPEG file and a better-looking image. Too large a smoothing
205factor will visibly blur the image, however.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000206
207Switches for wizards:
208
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000209 -baseline Force baseline-compatible quantization tables to be
210 generated. This clamps quantization values to 8 bits
211 even at low quality settings. (This switch is poorly
212 named, since it does not ensure that the output is
213 actually baseline JPEG. For example, you can use
214 -baseline and -progressive together.)
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000215
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000216 -qtables file Use the quantization tables given in the specified
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000217 text file.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000218
219 -qslots N[,...] Select which quantization table to use for each color
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000220 component.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000221
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000222 -sample HxV[,...] Set JPEG sampling factors for each color component.
223
224 -scans file Use the scan script given in the specified text file.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000225
226The "wizard" switches are intended for experimentation with JPEG. If you
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000227don't know what you are doing, DON'T USE THEM. These switches are documented
Guido Vollbeding5996a252009-06-27 00:00:00 +0000228further in the file wizard.txt.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000229
230
231DJPEG DETAILS
232
233The basic command line switches for djpeg are:
234
235 -colors N Reduce image to at most N colors. This reduces the
236 or -quantize N number of colors used in the output image, so that it
237 can be displayed on a colormapped display or stored in
238 a colormapped file format. For example, if you have
239 an 8-bit display, you'd need to reduce to 256 or fewer
240 colors. (-colors is the recommended name, -quantize
241 is provided only for backwards compatibility.)
242
243 -fast Select recommended processing options for fast, low
244 quality output. (The default options are chosen for
245 highest quality output.) Currently, this is equivalent
246 to "-dct fast -nosmooth -onepass -dither ordered".
247
248 -grayscale Force gray-scale output even if JPEG file is color.
249 Useful for viewing on monochrome displays; also,
250 djpeg runs noticeably faster in this mode.
251
252 -scale M/N Scale the output image by a factor M/N. Currently
253 the scale factor must be 1/1, 1/2, 1/4, or 1/8.
254 Scaling is handy if the image is larger than your
255 screen; also, djpeg runs much faster when scaling
256 down the output.
257
258 -bmp Select BMP output format (Windows flavor). 8-bit
259 colormapped format is emitted if -colors or -grayscale
260 is specified, or if the JPEG file is gray-scale;
261 otherwise, 24-bit full-color format is emitted.
262
263 -gif Select GIF output format. Since GIF does not support
264 more than 256 colors, -colors 256 is assumed (unless
265 you specify a smaller number of colors). If you
266 specify -fast, the default number of colors is 216.
267
268 -os2 Select BMP output format (OS/2 1.x flavor). 8-bit
269 colormapped format is emitted if -colors or -grayscale
270 is specified, or if the JPEG file is gray-scale;
271 otherwise, 24-bit full-color format is emitted.
272
273 -pnm Select PBMPLUS (PPM/PGM) output format (this is the
274 default format). PGM is emitted if the JPEG file is
275 gray-scale or if -grayscale is specified; otherwise
276 PPM is emitted.
277
278 -rle Select RLE output format. (Requires URT library.)
279
280 -targa Select Targa output format. Gray-scale format is
281 emitted if the JPEG file is gray-scale or if
282 -grayscale is specified; otherwise, colormapped format
283 is emitted if -colors is specified; otherwise, 24-bit
284 full-color format is emitted.
285
286Switches for advanced users:
287
288 -dct int Use integer DCT method (default).
289 -dct fast Use fast integer DCT (less accurate).
290 -dct float Use floating-point DCT method.
Thomas G. Lanea8b67c41995-03-15 00:00:00 +0000291 The float method is very slightly more accurate than
292 the int method, but is much slower unless your machine
293 has very fast floating-point hardware. Also note that
294 results of the floating-point method may vary slightly
295 across machines, while the integer methods should give
296 the same results everywhere. The fast integer method
297 is much less accurate than the other two.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000298
299 -dither fs Use Floyd-Steinberg dithering in color quantization.
300 -dither ordered Use ordered dithering in color quantization.
301 -dither none Do not use dithering in color quantization.
302 By default, Floyd-Steinberg dithering is applied when
303 quantizing colors; this is slow but usually produces
304 the best results. Ordered dither is a compromise
305 between speed and quality; no dithering is fast but
306 usually looks awful. Note that these switches have
307 no effect unless color quantization is being done.
308 Ordered dither is only available in -onepass mode.
309
310 -map FILE Quantize to the colors used in the specified image
311 file. This is useful for producing multiple files
312 with identical color maps, or for forcing a predefined
313 set of colors to be used. The FILE must be a GIF
314 or PPM file. This option overrides -colors and
315 -onepass.
316
317 -nosmooth Use a faster, lower-quality upsampling routine.
318
319 -onepass Use one-pass instead of two-pass color quantization.
320 The one-pass method is faster and needs less memory,
321 but it produces a lower-quality image. -onepass is
322 ignored unless you also say -colors N. Also,
323 the one-pass method is always used for gray-scale
324 output (the two-pass method is no improvement then).
325
326 -maxmemory N Set limit for amount of memory to use in processing
327 large images. Value is in thousands of bytes, or
328 millions of bytes if "M" is attached to the number.
329 For example, -max 4m selects 4000000 bytes. If more
330 space is needed, temporary files will be used.
331
332 -verbose Enable debug printout. More -v's give more printout.
333 or -debug Also, version information is printed at startup.
334
335
336HINTS FOR CJPEG
337
338Color GIF files are not the ideal input for JPEG; JPEG is really intended for
339compressing full-color (24-bit) images. In particular, don't try to convert
340cartoons, line drawings, and other images that have only a few distinct
341colors. GIF works great on these, JPEG does not. If you want to convert a
342GIF to JPEG, you should experiment with cjpeg's -quality and -smooth options
343to get a satisfactory conversion. -smooth 10 or so is often helpful.
344
345Avoid running an image through a series of JPEG compression/decompression
346cycles. Image quality loss will accumulate; after ten or so cycles the image
347may be noticeably worse than it was after one cycle. It's best to use a
348lossless format while manipulating an image, then convert to JPEG format when
349you are ready to file the image away.
350
351The -optimize option to cjpeg is worth using when you are making a "final"
352version for posting or archiving. It's also a win when you are using low
353quality settings to make very small JPEG files; the percentage improvement
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000354is often a lot more than it is on larger files. (At present, -optimize
355mode is always selected when generating progressive JPEG files.)
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000356
DRC39ea5622010-10-12 01:55:31 +0000357Support for GIF input files was removed in cjpeg v6b due to concerns over
358the Unisys LZW patent. Although this patent expired in 2006, cjpeg still
359lacks GIF support, for these historical reasons. (Conversion of GIF files to
360JPEG is usually a bad idea anyway.)
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000361
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000362
363HINTS FOR DJPEG
364
365To get a quick preview of an image, use the -grayscale and/or -scale switches.
366"-grayscale -scale 1/8" is the fastest case.
367
368Several options are available that trade off image quality to gain speed.
369"-fast" turns on the recommended settings.
370
371"-dct fast" and/or "-nosmooth" gain speed at a small sacrifice in quality.
372When producing a color-quantized image, "-onepass -dither ordered" is fast but
373much lower quality than the default behavior. "-dither none" may give
374acceptable results in two-pass mode, but is seldom tolerable in one-pass mode.
375
376If you are fortunate enough to have very fast floating point hardware,
Thomas G. Lanea8b67c41995-03-15 00:00:00 +0000377"-dct float" may be even faster than "-dct fast". But on most machines
378"-dct float" is slower than "-dct int"; in this case it is not worth using,
379because its theoretical accuracy advantage is too small to be significant
380in practice.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000381
382Two-pass color quantization requires a good deal of memory; on MS-DOS machines
383it may run out of memory even with -maxmemory 0. In that case you can still
384decompress, with some loss of image quality, by specifying -onepass for
385one-pass quantization.
386
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000387To avoid the Unisys LZW patent, djpeg produces uncompressed GIF files. These
388are larger than they should be, but are readable by standard GIF decoders.
389
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000390
391HINTS FOR BOTH PROGRAMS
392
393If more space is needed than will fit in the available main memory (as
394determined by -maxmemory), temporary files will be used. (MS-DOS versions
395will try to get extended or expanded memory first.) The temporary files are
396often rather large: in typical cases they occupy three bytes per pixel, for
397example 3*800*600 = 1.44Mb for an 800x600 image. If you don't have enough
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000398free disk space, leave out -progressive and -optimize (for cjpeg) or specify
399-onepass (for djpeg).
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000400
401On MS-DOS, the temporary files are created in the directory named by the TMP
402or TEMP environment variable, or in the current directory if neither of those
403exist. Amiga implementations put the temp files in the directory named by
404JPEGTMP:, so be sure to assign JPEGTMP: to a disk partition with adequate free
405space.
406
407The default memory usage limit (-maxmemory) is set when the software is
408compiled. If you get an "insufficient memory" error, try specifying a smaller
409-maxmemory value, even -maxmemory 0 to use the absolute minimum space. You
410may want to recompile with a smaller default value if this happens often.
411
412On machines that have "environment" variables, you can define the environment
413variable JPEGMEM to set the default memory limit. The value is specified as
414described for the -maxmemory switch. JPEGMEM overrides the default value
415specified when the program was compiled, and itself is overridden by an
416explicit -maxmemory switch.
417
418On MS-DOS machines, -maxmemory is the amount of main (conventional) memory to
419use. (Extended or expanded memory is also used if available.) Most
420DOS-specific versions of this software do their own memory space estimation
421and do not need you to specify -maxmemory.
422
423
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000424JPEGTRAN
425
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000426jpegtran performs various useful transformations of JPEG files.
427It can translate the coded representation from one variant of JPEG to another,
428for example from baseline JPEG to progressive JPEG or vice versa. It can also
429perform some rearrangements of the image data, for example turning an image
430from landscape to portrait format by rotation.
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000431
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000432jpegtran works by rearranging the compressed data (DCT coefficients), without
433ever fully decoding the image. Therefore, its transformations are lossless:
434there is no image degradation at all, which would not be true if you used
435djpeg followed by cjpeg to accomplish the same conversion. But by the same
436token, jpegtran cannot perform lossy operations such as changing the image
437quality.
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000438
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000439jpegtran uses a command line syntax similar to cjpeg or djpeg.
440On Unix-like systems, you say:
441 jpegtran [switches] [inputfile] >outputfile
442On most non-Unix systems, you say:
443 jpegtran [switches] inputfile outputfile
444where both the input and output files are JPEG files.
445
446To specify the coded JPEG representation used in the output file,
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000447jpegtran accepts a subset of the switches recognized by cjpeg:
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000448 -optimize Perform optimization of entropy encoding parameters.
449 -progressive Create progressive JPEG file.
Guido Vollbeding5829cb22012-01-15 00:00:00 +0000450 -arithmetic Use arithmetic coding.
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000451 -restart N Emit a JPEG restart marker every N MCU rows, or every
452 N MCU blocks if "B" is attached to the number.
453 -scans file Use the scan script given in the specified text file.
454See the previous discussion of cjpeg for more details about these switches.
455If you specify none of these switches, you get a plain baseline-JPEG output
456file. The quality setting and so forth are determined by the input file.
457
458The image can be losslessly transformed by giving one of these switches:
459 -flip horizontal Mirror image horizontally (left-right).
460 -flip vertical Mirror image vertically (top-bottom).
461 -rotate 90 Rotate image 90 degrees clockwise.
462 -rotate 180 Rotate image 180 degrees.
463 -rotate 270 Rotate image 270 degrees clockwise (or 90 ccw).
464 -transpose Transpose image (across UL-to-LR axis).
465 -transverse Transverse transpose (across UR-to-LL axis).
466
467The transpose transformation has no restrictions regarding image dimensions.
468The other transformations operate rather oddly if the image dimensions are not
469a multiple of the iMCU size (usually 8 or 16 pixels), because they can only
470transform complete blocks of DCT coefficient data in the desired way.
471
472jpegtran's default behavior when transforming an odd-size image is designed
473to preserve exact reversibility and mathematical consistency of the
474transformation set. As stated, transpose is able to flip the entire image
475area. Horizontal mirroring leaves any partial iMCU column at the right edge
476untouched, but is able to flip all rows of the image. Similarly, vertical
477mirroring leaves any partial iMCU row at the bottom edge untouched, but is
478able to flip all columns. The other transforms can be built up as sequences
479of transpose and flip operations; for consistency, their actions on edge
480pixels are defined to be the same as the end result of the corresponding
481transpose-and-flip sequence.
482
483For practical use, you may prefer to discard any untransformable edge pixels
484rather than having a strange-looking strip along the right and/or bottom edges
485of a transformed image. To do this, add the -trim switch:
486 -trim Drop non-transformable edge blocks.
487Obviously, a transformation with -trim is not reversible, so strictly speaking
488jpegtran with this switch is not lossless. Also, the expected mathematical
489equivalences between the transformations no longer hold. For example,
490"-rot 270 -trim" trims only the bottom edge, but "-rot 90 -trim" followed by
491"-rot 180 -trim" trims both edges.
492
DRC39ea5622010-10-12 01:55:31 +0000493If you are only interested in perfect transformations, add the -perfect switch:
494 -perfect Fail with an error if the transformation is not
Guido Vollbeding5996a252009-06-27 00:00:00 +0000495 perfect.
DRC39ea5622010-10-12 01:55:31 +0000496For example, you may want to do
Guido Vollbeding5996a252009-06-27 00:00:00 +0000497 jpegtran -rot 90 -perfect foo.jpg || djpeg foo.jpg | pnmflip -r90 | cjpeg
DRC39ea5622010-10-12 01:55:31 +0000498to do a perfect rotation, if available, or an approximated one if not.
Guido Vollbeding5996a252009-06-27 00:00:00 +0000499
DRC39ea5622010-10-12 01:55:31 +0000500This version of jpegtran also offers a lossless crop option, which discards
501data outside of a given image region but losslessly preserves what is inside.
502Like the rotate and flip transforms, lossless crop is restricted by the current
503JPEG format; the upper left corner of the selected region must fall on an iMCU
504boundary. If it doesn't, then it is silently moved up and/or left to the
505nearest iMCU boundary (the lower right corner is unchanged.)
Guido Vollbeding5996a252009-06-27 00:00:00 +0000506
507The image can be losslessly cropped by giving the switch:
DRC39ea5622010-10-12 01:55:31 +0000508 -crop WxH+X+Y Crop to a rectangular region of width W and height H,
Guido Vollbeding5996a252009-06-27 00:00:00 +0000509 starting at point X,Y.
510
Guido Vollbeding989630f2010-01-10 00:00:00 +0000511Other not-strictly-lossless transformation switches are:
512
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000513 -grayscale Force grayscale output.
514This option discards the chrominance channels if the input image is YCbCr
515(ie, a standard color JPEG), resulting in a grayscale JPEG file. The
516luminance channel is preserved exactly, so this is a better method of reducing
517to grayscale than decompression, conversion, and recompression. This switch
518is particularly handy for fixing a monochrome picture that was mistakenly
519encoded as a color JPEG. (In such a case, the space savings from getting rid
520of the near-empty chroma channels won't be large; but the decoding time for
521a grayscale JPEG is substantially less than that for a color JPEG.)
522
523jpegtran also recognizes these switches that control what to do with "extra"
524markers, such as comment blocks:
525 -copy none Copy no extra markers from source file. This setting
526 suppresses all comments and other excess baggage
527 present in the source file.
528 -copy comments Copy only comment markers. This setting copies
DRC39ea5622010-10-12 01:55:31 +0000529 comments from the source file but discards
DRCccd1bfd2012-01-31 09:53:46 +0000530 any other data that is inessential for image display.
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000531 -copy all Copy all extra markers. This setting preserves
532 miscellaneous markers found in the source file, such
Guido Vollbeding5996a252009-06-27 00:00:00 +0000533 as JFIF thumbnails, Exif data, and Photoshop settings.
DRC39ea5622010-10-12 01:55:31 +0000534 In some files, these extra markers can be sizable.
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000535The default behavior is -copy comments. (Note: in IJG releases v6 and v6a,
536jpegtran always did the equivalent of -copy none.)
537
538Additional switches recognized by jpegtran are:
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000539 -outfile filename
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000540 -maxmemory N
541 -verbose
542 -debug
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000543These work the same as in cjpeg or djpeg.
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000544
545
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000546THE COMMENT UTILITIES
547
548The JPEG standard allows "comment" (COM) blocks to occur within a JPEG file.
549Although the standard doesn't actually define what COM blocks are for, they
550are widely used to hold user-supplied text strings. This lets you add
551annotations, titles, index terms, etc to your JPEG files, and later retrieve
552them as text. COM blocks do not interfere with the image stored in the JPEG
553file. The maximum size of a COM block is 64K, but you can have as many of
554them as you like in one JPEG file.
555
556We provide two utility programs to display COM block contents and add COM
557blocks to a JPEG file.
558
559rdjpgcom searches a JPEG file and prints the contents of any COM blocks on
560standard output. The command line syntax is
Guido Vollbeding5996a252009-06-27 00:00:00 +0000561 rdjpgcom [-raw] [-verbose] [inputfilename]
DRC39ea5622010-10-12 01:55:31 +0000562The switch "-raw" (or just "-r") causes rdjpgcom to output non-printable
563characters in JPEG comments. These characters are normally escaped for
564security reasons.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000565The switch "-verbose" (or just "-v") causes rdjpgcom to also display the JPEG
566image dimensions. If you omit the input file name from the command line,
567the JPEG file is read from standard input. (This may not work on some
568operating systems, if binary data can't be read from stdin.)
569
570wrjpgcom adds a COM block, containing text you provide, to a JPEG file.
571Ordinarily, the COM block is added after any existing COM blocks, but you
572can delete the old COM blocks if you wish. wrjpgcom produces a new JPEG
573file; it does not modify the input file. DO NOT try to overwrite the input
574file by directing wrjpgcom's output back into it; on most systems this will
575just destroy your file.
576
577The command line syntax for wrjpgcom is similar to cjpeg's. On Unix-like
578systems, it is
579 wrjpgcom [switches] [inputfilename]
580The output file is written to standard output. The input file comes from
581the named file, or from standard input if no input file is named.
582
583On most non-Unix systems, the syntax is
584 wrjpgcom [switches] inputfilename outputfilename
585where both input and output file names must be given explicitly.
586
587wrjpgcom understands three switches:
588 -replace Delete any existing COM blocks from the file.
589 -comment "Comment text" Supply new COM text on command line.
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000590 -cfile name Read text for new COM block from named file.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000591(Switch names can be abbreviated.) If you have only one line of comment text
592to add, you can provide it on the command line with -comment. The comment
593text must be surrounded with quotes so that it is treated as a single
594argument. Longer comments can be read from a text file.
595
596If you give neither -comment nor -cfile, then wrjpgcom will read the comment
597text from standard input. (In this case an input image file name MUST be
598supplied, so that the source JPEG file comes from somewhere else.) You can
599enter multiple lines, up to 64KB worth. Type an end-of-file indicator
600(usually control-D or control-Z) to terminate the comment text entry.
601
602wrjpgcom will not add a COM block if the provided comment string is empty.
603Therefore -replace -comment "" can be used to delete all COM blocks from a
604file.
605
606These utility programs do not depend on the IJG JPEG library. In
607particular, the source code for rdjpgcom is intended as an illustration of
608the minimum amount of code required to parse a JPEG file header correctly.