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