blob: 0519b94afbf4f3235d6e8c496af43aa1f6a85a48 [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
134respectively refer to the quality levels which should be assigned to the
135quantization 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
160 -dct int Use integer DCT method (default).
161 -dct fast Use fast integer DCT (less accurate).
162 -dct float Use floating-point DCT method.
Thomas G. Lanea8b67c41995-03-15 00:00:00 +0000163 The float method is very slightly more accurate than
164 the int method, but is much slower unless your machine
165 has very fast floating-point hardware. Also note that
166 results of the floating-point method may vary slightly
167 across machines, while the integer methods should give
168 the same results everywhere. The fast integer method
169 is much less accurate than the other two.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000170
171 -restart N Emit a JPEG restart marker every N MCU rows, or every
172 N MCU blocks if "B" is attached to the number.
173 -restart 0 (the default) means no restart markers.
174
175 -smooth N Smooth the input image to eliminate dithering noise.
176 N, ranging from 1 to 100, indicates the strength of
177 smoothing. 0 (the default) means no smoothing.
178
179 -maxmemory N Set limit for amount of memory to use in processing
180 large images. Value is in thousands of bytes, or
181 millions of bytes if "M" is attached to the number.
182 For example, -max 4m selects 4000000 bytes. If more
183 space is needed, temporary files will be used.
184
185 -verbose Enable debug printout. More -v's give more printout.
186 or -debug Also, version information is printed at startup.
187
188The -restart option inserts extra markers that allow a JPEG decoder to
189resynchronize after a transmission error. Without restart markers, any damage
190to a compressed file will usually ruin the image from the point of the error
191to the end of the image; with restart markers, the damage is usually confined
192to the portion of the image up to the next restart marker. Of course, the
193restart markers occupy extra space. We recommend -restart 1 for images that
194will be transmitted across unreliable networks such as Usenet.
195
196The -smooth option filters the input to eliminate fine-scale noise. This is
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000197often useful when converting dithered images to JPEG: a moderate smoothing
198factor of 10 to 50 gets rid of dithering patterns in the input file, resulting
199in a smaller JPEG file and a better-looking image. Too large a smoothing
200factor will visibly blur the image, however.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000201
202Switches for wizards:
203
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000204 -baseline Force baseline-compatible quantization tables to be
205 generated. This clamps quantization values to 8 bits
206 even at low quality settings. (This switch is poorly
207 named, since it does not ensure that the output is
208 actually baseline JPEG. For example, you can use
209 -baseline and -progressive together.)
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000210
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000211 -qtables file Use the quantization tables given in the specified
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000212 text file.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000213
214 -qslots N[,...] Select which quantization table to use for each color
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000215 component.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000216
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000217 -sample HxV[,...] Set JPEG sampling factors for each color component.
218
219 -scans file Use the scan script given in the specified text file.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000220
221The "wizard" switches are intended for experimentation with JPEG. If you
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000222don't know what you are doing, DON'T USE THEM. These switches are documented
Guido Vollbeding5996a252009-06-27 00:00:00 +0000223further in the file wizard.txt.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000224
225
226DJPEG DETAILS
227
228The basic command line switches for djpeg are:
229
230 -colors N Reduce image to at most N colors. This reduces the
231 or -quantize N number of colors used in the output image, so that it
232 can be displayed on a colormapped display or stored in
233 a colormapped file format. For example, if you have
234 an 8-bit display, you'd need to reduce to 256 or fewer
235 colors. (-colors is the recommended name, -quantize
236 is provided only for backwards compatibility.)
237
238 -fast Select recommended processing options for fast, low
239 quality output. (The default options are chosen for
240 highest quality output.) Currently, this is equivalent
241 to "-dct fast -nosmooth -onepass -dither ordered".
242
243 -grayscale Force gray-scale output even if JPEG file is color.
244 Useful for viewing on monochrome displays; also,
245 djpeg runs noticeably faster in this mode.
246
247 -scale M/N Scale the output image by a factor M/N. Currently
248 the scale factor must be 1/1, 1/2, 1/4, or 1/8.
249 Scaling is handy if the image is larger than your
250 screen; also, djpeg runs much faster when scaling
251 down the output.
252
253 -bmp Select BMP output format (Windows flavor). 8-bit
254 colormapped format is emitted if -colors or -grayscale
255 is specified, or if the JPEG file is gray-scale;
256 otherwise, 24-bit full-color format is emitted.
257
258 -gif Select GIF output format. Since GIF does not support
259 more than 256 colors, -colors 256 is assumed (unless
260 you specify a smaller number of colors). If you
261 specify -fast, the default number of colors is 216.
262
263 -os2 Select BMP output format (OS/2 1.x flavor). 8-bit
264 colormapped format is emitted if -colors or -grayscale
265 is specified, or if the JPEG file is gray-scale;
266 otherwise, 24-bit full-color format is emitted.
267
268 -pnm Select PBMPLUS (PPM/PGM) output format (this is the
269 default format). PGM is emitted if the JPEG file is
270 gray-scale or if -grayscale is specified; otherwise
271 PPM is emitted.
272
273 -rle Select RLE output format. (Requires URT library.)
274
275 -targa Select Targa output format. Gray-scale format is
276 emitted if the JPEG file is gray-scale or if
277 -grayscale is specified; otherwise, colormapped format
278 is emitted if -colors is specified; otherwise, 24-bit
279 full-color format is emitted.
280
281Switches for advanced users:
282
283 -dct int Use integer DCT method (default).
284 -dct fast Use fast integer DCT (less accurate).
285 -dct float Use floating-point DCT method.
Thomas G. Lanea8b67c41995-03-15 00:00:00 +0000286 The float method is very slightly more accurate than
287 the int method, but is much slower unless your machine
288 has very fast floating-point hardware. Also note that
289 results of the floating-point method may vary slightly
290 across machines, while the integer methods should give
291 the same results everywhere. The fast integer method
292 is much less accurate than the other two.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000293
294 -dither fs Use Floyd-Steinberg dithering in color quantization.
295 -dither ordered Use ordered dithering in color quantization.
296 -dither none Do not use dithering in color quantization.
297 By default, Floyd-Steinberg dithering is applied when
298 quantizing colors; this is slow but usually produces
299 the best results. Ordered dither is a compromise
300 between speed and quality; no dithering is fast but
301 usually looks awful. Note that these switches have
302 no effect unless color quantization is being done.
303 Ordered dither is only available in -onepass mode.
304
305 -map FILE Quantize to the colors used in the specified image
306 file. This is useful for producing multiple files
307 with identical color maps, or for forcing a predefined
308 set of colors to be used. The FILE must be a GIF
309 or PPM file. This option overrides -colors and
310 -onepass.
311
312 -nosmooth Use a faster, lower-quality upsampling routine.
313
314 -onepass Use one-pass instead of two-pass color quantization.
315 The one-pass method is faster and needs less memory,
316 but it produces a lower-quality image. -onepass is
317 ignored unless you also say -colors N. Also,
318 the one-pass method is always used for gray-scale
319 output (the two-pass method is no improvement then).
320
321 -maxmemory N Set limit for amount of memory to use in processing
322 large images. Value is in thousands of bytes, or
323 millions of bytes if "M" is attached to the number.
324 For example, -max 4m selects 4000000 bytes. If more
325 space is needed, temporary files will be used.
326
327 -verbose Enable debug printout. More -v's give more printout.
328 or -debug Also, version information is printed at startup.
329
330
331HINTS FOR CJPEG
332
333Color GIF files are not the ideal input for JPEG; JPEG is really intended for
334compressing full-color (24-bit) images. In particular, don't try to convert
335cartoons, line drawings, and other images that have only a few distinct
336colors. GIF works great on these, JPEG does not. If you want to convert a
337GIF to JPEG, you should experiment with cjpeg's -quality and -smooth options
338to get a satisfactory conversion. -smooth 10 or so is often helpful.
339
340Avoid running an image through a series of JPEG compression/decompression
341cycles. Image quality loss will accumulate; after ten or so cycles the image
342may be noticeably worse than it was after one cycle. It's best to use a
343lossless format while manipulating an image, then convert to JPEG format when
344you are ready to file the image away.
345
346The -optimize option to cjpeg is worth using when you are making a "final"
347version for posting or archiving. It's also a win when you are using low
348quality settings to make very small JPEG files; the percentage improvement
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000349is often a lot more than it is on larger files. (At present, -optimize
350mode is always selected when generating progressive JPEG files.)
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000351
DRC39ea5622010-10-12 01:55:31 +0000352Support for GIF input files was removed in cjpeg v6b due to concerns over
353the Unisys LZW patent. Although this patent expired in 2006, cjpeg still
354lacks GIF support, for these historical reasons. (Conversion of GIF files to
355JPEG is usually a bad idea anyway.)
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000356
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000357
358HINTS FOR DJPEG
359
360To get a quick preview of an image, use the -grayscale and/or -scale switches.
361"-grayscale -scale 1/8" is the fastest case.
362
363Several options are available that trade off image quality to gain speed.
364"-fast" turns on the recommended settings.
365
366"-dct fast" and/or "-nosmooth" gain speed at a small sacrifice in quality.
367When producing a color-quantized image, "-onepass -dither ordered" is fast but
368much lower quality than the default behavior. "-dither none" may give
369acceptable results in two-pass mode, but is seldom tolerable in one-pass mode.
370
371If you are fortunate enough to have very fast floating point hardware,
Thomas G. Lanea8b67c41995-03-15 00:00:00 +0000372"-dct float" may be even faster than "-dct fast". But on most machines
373"-dct float" is slower than "-dct int"; in this case it is not worth using,
374because its theoretical accuracy advantage is too small to be significant
375in practice.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000376
377Two-pass color quantization requires a good deal of memory; on MS-DOS machines
378it may run out of memory even with -maxmemory 0. In that case you can still
379decompress, with some loss of image quality, by specifying -onepass for
380one-pass quantization.
381
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000382To avoid the Unisys LZW patent, djpeg produces uncompressed GIF files. These
383are larger than they should be, but are readable by standard GIF decoders.
384
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000385
386HINTS FOR BOTH PROGRAMS
387
388If more space is needed than will fit in the available main memory (as
389determined by -maxmemory), temporary files will be used. (MS-DOS versions
390will try to get extended or expanded memory first.) The temporary files are
391often rather large: in typical cases they occupy three bytes per pixel, for
392example 3*800*600 = 1.44Mb for an 800x600 image. If you don't have enough
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000393free disk space, leave out -progressive and -optimize (for cjpeg) or specify
394-onepass (for djpeg).
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000395
396On MS-DOS, the temporary files are created in the directory named by the TMP
397or TEMP environment variable, or in the current directory if neither of those
398exist. Amiga implementations put the temp files in the directory named by
399JPEGTMP:, so be sure to assign JPEGTMP: to a disk partition with adequate free
400space.
401
402The default memory usage limit (-maxmemory) is set when the software is
403compiled. If you get an "insufficient memory" error, try specifying a smaller
404-maxmemory value, even -maxmemory 0 to use the absolute minimum space. You
405may want to recompile with a smaller default value if this happens often.
406
407On machines that have "environment" variables, you can define the environment
408variable JPEGMEM to set the default memory limit. The value is specified as
409described for the -maxmemory switch. JPEGMEM overrides the default value
410specified when the program was compiled, and itself is overridden by an
411explicit -maxmemory switch.
412
413On MS-DOS machines, -maxmemory is the amount of main (conventional) memory to
414use. (Extended or expanded memory is also used if available.) Most
415DOS-specific versions of this software do their own memory space estimation
416and do not need you to specify -maxmemory.
417
418
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000419JPEGTRAN
420
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000421jpegtran performs various useful transformations of JPEG files.
422It can translate the coded representation from one variant of JPEG to another,
423for example from baseline JPEG to progressive JPEG or vice versa. It can also
424perform some rearrangements of the image data, for example turning an image
425from landscape to portrait format by rotation.
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000426
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000427jpegtran works by rearranging the compressed data (DCT coefficients), without
428ever fully decoding the image. Therefore, its transformations are lossless:
429there is no image degradation at all, which would not be true if you used
430djpeg followed by cjpeg to accomplish the same conversion. But by the same
431token, jpegtran cannot perform lossy operations such as changing the image
432quality.
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000433
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000434jpegtran uses a command line syntax similar to cjpeg or djpeg.
435On Unix-like systems, you say:
436 jpegtran [switches] [inputfile] >outputfile
437On most non-Unix systems, you say:
438 jpegtran [switches] inputfile outputfile
439where both the input and output files are JPEG files.
440
441To specify the coded JPEG representation used in the output file,
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000442jpegtran accepts a subset of the switches recognized by cjpeg:
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000443 -optimize Perform optimization of entropy encoding parameters.
444 -progressive Create progressive JPEG file.
445 -restart N Emit a JPEG restart marker every N MCU rows, or every
446 N MCU blocks if "B" is attached to the number.
447 -scans file Use the scan script given in the specified text file.
448See the previous discussion of cjpeg for more details about these switches.
449If you specify none of these switches, you get a plain baseline-JPEG output
450file. The quality setting and so forth are determined by the input file.
451
452The image can be losslessly transformed by giving one of these switches:
453 -flip horizontal Mirror image horizontally (left-right).
454 -flip vertical Mirror image vertically (top-bottom).
455 -rotate 90 Rotate image 90 degrees clockwise.
456 -rotate 180 Rotate image 180 degrees.
457 -rotate 270 Rotate image 270 degrees clockwise (or 90 ccw).
458 -transpose Transpose image (across UL-to-LR axis).
459 -transverse Transverse transpose (across UR-to-LL axis).
460
461The transpose transformation has no restrictions regarding image dimensions.
462The other transformations operate rather oddly if the image dimensions are not
463a multiple of the iMCU size (usually 8 or 16 pixels), because they can only
464transform complete blocks of DCT coefficient data in the desired way.
465
466jpegtran's default behavior when transforming an odd-size image is designed
467to preserve exact reversibility and mathematical consistency of the
468transformation set. As stated, transpose is able to flip the entire image
469area. Horizontal mirroring leaves any partial iMCU column at the right edge
470untouched, but is able to flip all rows of the image. Similarly, vertical
471mirroring leaves any partial iMCU row at the bottom edge untouched, but is
472able to flip all columns. The other transforms can be built up as sequences
473of transpose and flip operations; for consistency, their actions on edge
474pixels are defined to be the same as the end result of the corresponding
475transpose-and-flip sequence.
476
477For practical use, you may prefer to discard any untransformable edge pixels
478rather than having a strange-looking strip along the right and/or bottom edges
479of a transformed image. To do this, add the -trim switch:
480 -trim Drop non-transformable edge blocks.
481Obviously, a transformation with -trim is not reversible, so strictly speaking
482jpegtran with this switch is not lossless. Also, the expected mathematical
483equivalences between the transformations no longer hold. For example,
484"-rot 270 -trim" trims only the bottom edge, but "-rot 90 -trim" followed by
485"-rot 180 -trim" trims both edges.
486
DRC39ea5622010-10-12 01:55:31 +0000487If you are only interested in perfect transformations, add the -perfect switch:
488 -perfect Fail with an error if the transformation is not
Guido Vollbeding5996a252009-06-27 00:00:00 +0000489 perfect.
DRC39ea5622010-10-12 01:55:31 +0000490For example, you may want to do
Guido Vollbeding5996a252009-06-27 00:00:00 +0000491 jpegtran -rot 90 -perfect foo.jpg || djpeg foo.jpg | pnmflip -r90 | cjpeg
DRC39ea5622010-10-12 01:55:31 +0000492to do a perfect rotation, if available, or an approximated one if not.
Guido Vollbeding5996a252009-06-27 00:00:00 +0000493
DRC39ea5622010-10-12 01:55:31 +0000494This version of jpegtran also offers a lossless crop option, which discards
495data outside of a given image region but losslessly preserves what is inside.
496Like the rotate and flip transforms, lossless crop is restricted by the current
497JPEG format; the upper left corner of the selected region must fall on an iMCU
498boundary. If it doesn't, then it is silently moved up and/or left to the
499nearest iMCU boundary (the lower right corner is unchanged.)
Guido Vollbeding5996a252009-06-27 00:00:00 +0000500
501The image can be losslessly cropped by giving the switch:
DRC39ea5622010-10-12 01:55:31 +0000502 -crop WxH+X+Y Crop to a rectangular region of width W and height H,
Guido Vollbeding5996a252009-06-27 00:00:00 +0000503 starting at point X,Y.
504
Guido Vollbeding989630f2010-01-10 00:00:00 +0000505Other not-strictly-lossless transformation switches are:
506
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000507 -grayscale Force grayscale output.
508This option discards the chrominance channels if the input image is YCbCr
509(ie, a standard color JPEG), resulting in a grayscale JPEG file. The
510luminance channel is preserved exactly, so this is a better method of reducing
511to grayscale than decompression, conversion, and recompression. This switch
512is particularly handy for fixing a monochrome picture that was mistakenly
513encoded as a color JPEG. (In such a case, the space savings from getting rid
514of the near-empty chroma channels won't be large; but the decoding time for
515a grayscale JPEG is substantially less than that for a color JPEG.)
516
517jpegtran also recognizes these switches that control what to do with "extra"
518markers, such as comment blocks:
519 -copy none Copy no extra markers from source file. This setting
520 suppresses all comments and other excess baggage
521 present in the source file.
522 -copy comments Copy only comment markers. This setting copies
DRC39ea5622010-10-12 01:55:31 +0000523 comments from the source file but discards
524 any other data which is inessential for image display.
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000525 -copy all Copy all extra markers. This setting preserves
526 miscellaneous markers found in the source file, such
Guido Vollbeding5996a252009-06-27 00:00:00 +0000527 as JFIF thumbnails, Exif data, and Photoshop settings.
DRC39ea5622010-10-12 01:55:31 +0000528 In some files, these extra markers can be sizable.
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000529The default behavior is -copy comments. (Note: in IJG releases v6 and v6a,
530jpegtran always did the equivalent of -copy none.)
531
532Additional switches recognized by jpegtran are:
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000533 -outfile filename
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000534 -maxmemory N
535 -verbose
536 -debug
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000537These work the same as in cjpeg or djpeg.
Thomas G. Lanebc79e061995-08-02 00:00:00 +0000538
539
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000540THE COMMENT UTILITIES
541
542The JPEG standard allows "comment" (COM) blocks to occur within a JPEG file.
543Although the standard doesn't actually define what COM blocks are for, they
544are widely used to hold user-supplied text strings. This lets you add
545annotations, titles, index terms, etc to your JPEG files, and later retrieve
546them as text. COM blocks do not interfere with the image stored in the JPEG
547file. The maximum size of a COM block is 64K, but you can have as many of
548them as you like in one JPEG file.
549
550We provide two utility programs to display COM block contents and add COM
551blocks to a JPEG file.
552
553rdjpgcom searches a JPEG file and prints the contents of any COM blocks on
554standard output. The command line syntax is
Guido Vollbeding5996a252009-06-27 00:00:00 +0000555 rdjpgcom [-raw] [-verbose] [inputfilename]
DRC39ea5622010-10-12 01:55:31 +0000556The switch "-raw" (or just "-r") causes rdjpgcom to output non-printable
557characters in JPEG comments. These characters are normally escaped for
558security reasons.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000559The switch "-verbose" (or just "-v") causes rdjpgcom to also display the JPEG
560image dimensions. If you omit the input file name from the command line,
561the JPEG file is read from standard input. (This may not work on some
562operating systems, if binary data can't be read from stdin.)
563
564wrjpgcom adds a COM block, containing text you provide, to a JPEG file.
565Ordinarily, the COM block is added after any existing COM blocks, but you
566can delete the old COM blocks if you wish. wrjpgcom produces a new JPEG
567file; it does not modify the input file. DO NOT try to overwrite the input
568file by directing wrjpgcom's output back into it; on most systems this will
569just destroy your file.
570
571The command line syntax for wrjpgcom is similar to cjpeg's. On Unix-like
572systems, it is
573 wrjpgcom [switches] [inputfilename]
574The output file is written to standard output. The input file comes from
575the named file, or from standard input if no input file is named.
576
577On most non-Unix systems, the syntax is
578 wrjpgcom [switches] inputfilename outputfilename
579where both input and output file names must be given explicitly.
580
581wrjpgcom understands three switches:
582 -replace Delete any existing COM blocks from the file.
583 -comment "Comment text" Supply new COM text on command line.
Thomas G. Lane5ead57a1998-03-27 00:00:00 +0000584 -cfile name Read text for new COM block from named file.
Thomas G. Lane36a4ccc1994-09-24 00:00:00 +0000585(Switch names can be abbreviated.) If you have only one line of comment text
586to add, you can provide it on the command line with -comment. The comment
587text must be surrounded with quotes so that it is treated as a single
588argument. Longer comments can be read from a text file.
589
590If you give neither -comment nor -cfile, then wrjpgcom will read the comment
591text from standard input. (In this case an input image file name MUST be
592supplied, so that the source JPEG file comes from somewhere else.) You can
593enter multiple lines, up to 64KB worth. Type an end-of-file indicator
594(usually control-D or control-Z) to terminate the comment text entry.
595
596wrjpgcom will not add a COM block if the provided comment string is empty.
597Therefore -replace -comment "" can be used to delete all COM blocks from a
598file.
599
600These utility programs do not depend on the IJG JPEG library. In
601particular, the source code for rdjpgcom is intended as an illustration of
602the minimum amount of code required to parse a JPEG file header correctly.