<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<!-- lifted from troff+man by doclifter -->
<refentry id='cjpeg1'>
<refmeta>
<refentrytitle>CJPEG</refentrytitle>
<manvolnum>1E</manvolnum>
<refmiscinfo class='date'>20 March 1998</refmiscinfo>
<refmiscinfo class='source'>IJG</refmiscinfo>
<refmiscinfo class='manual'>NFIS Reference Manual</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>cjpeg</refname>
<refpurpose>compress an image file to a JPEG file</refpurpose>
</refnamediv>
<!-- body begins here -->
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
  <command>cjpeg</command>    
    <arg choice='opt'><replaceable>options</replaceable></arg>
    <arg choice='opt'><replaceable>filename</replaceable></arg>
    <sbr/>
</cmdsynopsis>
</refsynopsisdiv>


<refsect1 id='description'><title>DESCRIPTION</title>
<para><command>cjpeg</command>
compresses the named image file, or the standard input if no file is
named, and produces a JPEG/JFIF file on the standard output.
The currently supported input file formats are: PPM (PBMPLUS color
format), PGM (PBMPLUS gray-scale format), BMP, Targa, and RLE (Utah Raster
Toolkit format).  (RLE is supported only if the URT library is available.)</para>
</refsect1>

<refsect1 id='options'><title>OPTIONS</title>
<para>All switch names may be abbreviated; for example,
<option>-grayscale</option>
may be written
<option>-gray</option>
or
<option>-gr</option>.
Most of the "basic" switches can be abbreviated to as little as one letter.
Upper and lower case are equivalent (thus
<option>-BMP</option>
is the same as
<option>-bmp</option>).
British spellings are also accepted (e.g.,
<option>-greyscale</option>),
though for brevity these are not mentioned below.</para>

<para>The basic switches are:</para>
<variablelist remap='TP'>
  <varlistentry>
  <term><option>-quality</option><replaceable> N</replaceable></term>
  <listitem>
<para>Scale quantization tables to adjust image quality.  Quality is 0 (worst) to
100 (best); default is 75.  (See below for more info.)</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-grayscale</option></term>
  <listitem>
<para>Create monochrome JPEG file from color input.  Be sure to use this switch when
compressing a grayscale BMP file, because
<command>cjpeg</command>
isn't bright enough to notice whether a BMP file uses only shades of gray.
By saying
<option>-grayscale</option>,
you'll get a smaller JPEG file that takes less time to process.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-optimize</option></term>
  <listitem>
<para>Perform optimization of entropy encoding parameters.  Without this, default
encoding parameters are used.
<option>-optimize</option>
usually makes the JPEG file a little smaller, but
<command>cjpeg</command>
runs somewhat slower and needs much more memory.  Image quality and speed of
decompression are unaffected by
<option>-optimize</option>.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-progressive</option></term>
  <listitem>
<para>Create progressive JPEG file (see below).</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-targa</option></term>
  <listitem>
<para>Input file is Targa format.  Targa files that contain an "identification"
field will not be automatically recognized by
<command>cjpeg</command>;
for such files you must specify
<option>-targa</option>
to make
<command>cjpeg</command>
treat the input as Targa format.
For most Targa files, you won't need this switch.</para>
  </listitem>
  </varlistentry>
</variablelist>

<para>The
<option>-quality</option>
switch lets you trade off compressed file size against quality of the
reconstructed image: the higher the quality setting, the larger the JPEG file,
and the closer the output image will be to the original input.  Normally you
want to use the lowest quality setting (smallest file) that decompresses into
something visually indistinguishable from the original image.  For this
purpose the quality setting should be between 50 and 95; the default of 75 is
often about right.  If you see defects at
<option>-quality</option>
75, then go up 5 or 10 counts at a time until you are happy with the output
image.  (The optimal setting will vary from one image to another.)</para>

<para><option>-quality</option>
100 will generate a quantization table of all 1's, minimizing loss in the
quantization step (but there is still information loss in subsampling, as well
as roundoff error).  This setting is mainly of interest for experimental
purposes.  Quality values above about 95 are
<emphasis remap='B'>not</emphasis>
recommended for normal use; the compressed file size goes up dramatically for
hardly any gain in output image quality.</para>

<para>In the other direction, quality values below 50 will produce very small files
of low image quality.  Settings around 5 to 10 might be useful in preparing an
index of a large image library, for example.  Try
<option>-quality</option>
2 (or so) for some amusing Cubist effects.  (Note: quality
values below about 25 generate 2-byte quantization tables, which are
considered optional in the JPEG standard.
<command>cjpeg</command>
emits a warning message when you give such a quality value, because some
other JPEG programs may be unable to decode the resulting file.  Use
<option>-baseline</option>
if you need to ensure compatibility at low quality values.)</para>

<para>The
<option>-progressive</option>
switch creates a "progressive JPEG" file.  In this type of JPEG file, the data
is stored in multiple scans of increasing quality.  If the file is being
transmitted over a slow communications link, the decoder can use the first
scan to display a low-quality image very quickly, and can then improve the
display with each subsequent scan.  The final image is exactly equivalent to a
standard JPEG file of the same quality setting, and the total file size is
about the same --- often a little smaller.
<emphasis remap='B'>Caution:</emphasis>
progressive JPEG is not yet widely implemented, so many decoders will be
unable to view a progressive JPEG file at all.</para>

<para>Switches for advanced users:</para>
<variablelist remap='TP'>
  <varlistentry>
  <term><option>-dct int</option></term>
  <listitem>
<para>Use integer DCT method (default).</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-dct fast</option></term>
  <listitem>
<para>Use fast integer DCT (less accurate).</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-dct float</option></term>
  <listitem>
<para>Use floating-point DCT method.
The float method is very slightly more accurate than the int method, but is
much slower unless your machine has very fast floating-point hardware.  Also
note that results of the floating-point method may vary slightly across
machines, while the integer methods should give the same results everywhere.
The fast integer method is much less accurate than the other two.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-restart</option><replaceable> N</replaceable></term>
  <listitem>
<para>Emit a JPEG restart marker every N MCU rows, or every N MCU blocks if "B" is
attached to the number.
<option>-restart 0</option>
(the default) means no restart markers.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-smooth</option><replaceable> N</replaceable></term>
  <listitem>
<para>Smooth the input image to eliminate dithering noise.  N, ranging from 1 to
100, indicates the strength of smoothing.  0 (the default) means no smoothing.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-maxmemory</option><replaceable> N</replaceable></term>
  <listitem>
<para>Set limit for amount of memory to use in processing large images.  Value is
in thousands of bytes, or millions of bytes if "M" is attached to the
number.  For example,
<option>-max 4m</option>
selects 4000000 bytes.  If more space is needed, temporary files will be used.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-outfile</option><replaceable> name</replaceable></term>
  <listitem>
<para>Send output image to the named file, not to standard output.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-verbose</option></term>
  <listitem>
<para>Enable debug printout.  More
<option>-v</option>'s
give more output.  Also, version information is printed at startup.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-debug</option></term>
  <listitem>
<para>Same as
<option>-verbose</option>.</para>
  </listitem>
  </varlistentry>
</variablelist>

<para>The
<option>-restart</option>
option inserts extra markers that allow a JPEG decoder to resynchronize after
a transmission error.  Without restart markers, any damage to a compressed
file will usually ruin the image from the point of the error to the end of the
image; with restart markers, the damage is usually confined to the portion of
the image up to the next restart marker.  Of course, the restart markers
occupy extra space.  We recommend
<option>-restart 1</option>
for images that will be transmitted across unreliable networks such as Usenet.</para>

<para>The
<option>-smooth</option>
option filters the input to eliminate fine-scale noise.  This is often useful
when converting dithered images to JPEG: a moderate smoothing factor of 10 to
50 gets rid of dithering patterns in the input file, resulting in a smaller
JPEG file and a better-looking image.  Too large a smoothing factor will
visibly blur the image, however.</para>

<para>Switches for wizards:</para>
<variablelist remap='TP'>
  <varlistentry>
  <term><option>-baseline</option></term>
  <listitem>
<para>Force baseline-compatible quantization tables to be generated.  This clamps
quantization values to 8 bits even at low quality settings.  (This switch is
poorly named, since it does not ensure that the output is actually baseline
JPEG.  For example, you can use
<option>-baseline</option>
and
<option>-progressive</option>
together.)</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-qtables</option><replaceable> file</replaceable></term>
  <listitem>
<para>Use the quantization tables given in the specified text file.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-qslots</option><replaceable> N[,...]</replaceable></term>
  <listitem>
<para>Select which quantization table to use for each color component.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-sample</option><replaceable> HxV[,...]</replaceable></term>
  <listitem>
<para>Set JPEG sampling factors for each color component.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-scans</option><replaceable> file</replaceable></term>
  <listitem>
<para>Use the scan script given in the specified text file.</para>
  </listitem>
  </varlistentry>
</variablelist>

<para>The "wizard" switches are intended for experimentation with JPEG.  If you
don't know what you are doing, <emphasis remap='B'>don't use them</emphasis>.  These switches are
documented further in the file wizard.doc.</para>
</refsect1>

<refsect1 id='examples'><title>EXAMPLES</title>
<para>This example compresses the PPM file foo.ppm with a quality factor of
60 and saves the output as foo.jpg:</para>

<para><userinput>cjpeg -quality</userinput>
<emphasis remap='I'>60 foo.ppm</emphasis>
<emphasis remap='B'>&gt;</emphasis>
<emphasis remap='I'>foo.jpg</emphasis></para>
</refsect1>

<refsect1 id='hints'><title>HINTS</title>
<para>Color GIF files are not the ideal input for JPEG; JPEG is really intended for
compressing full-color (24-bit) images.  In particular, don't try to convert
cartoons, line drawings, and other images that have only a few distinct
colors.  GIF works great on these, JPEG does not.  If you want to convert a
GIF to JPEG, you should experiment with
<command>cjpeg</command>'s
<option>-quality</option>
and
<option>-smooth</option>
options to get a satisfactory conversion.
<option>-smooth 10</option>
or so is often helpful.</para>

<para>Avoid running an image through a series of JPEG compression/decompression
cycles.  Image quality loss will accumulate; after ten or so cycles the image
may be noticeably worse than it was after one cycle.  It's best to use a
lossless format while manipulating an image, then convert to JPEG format when
you are ready to file the image away.</para>

<para>The
<option>-optimize</option>
option to
<command>cjpeg</command>
is worth using when you are making a "final" version for posting or archiving.
It's also a win when you are using low quality settings to make very small
JPEG files; the percentage improvement is often a lot more than it is on
larger files.  (At present,
<option>-optimize</option>
mode is always selected when generating progressive JPEG files.)</para>
</refsect1>

<refsect1 id='environment'><title>ENVIRONMENT</title>
<variablelist remap='TP'>
  <varlistentry>
  <term><emphasis remap='B'>JPEGMEM</emphasis></term>
  <listitem>
<para>If this environment variable is set, its value is the default memory limit.
The value is specified as described for the
<option>-maxmemory</option>
switch.
<emphasis remap='B'>JPEGMEM</emphasis>
overrides the default value specified when the program was compiled, and
itself is overridden by an explicit
<option>-maxmemory</option>.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='see_also'><title>SEE ALSO</title>
<para><citerefentry><refentrytitle>djpeg</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>jpegtran</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>rdjpgcom</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>wrjpgcom</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<!-- .br -->
<citerefentry><refentrytitle>ppm</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>pgm</refentrytitle><manvolnum>5</manvolnum></citerefentry>
<!-- .br -->
Wallace, Gregory K.  "The JPEG Still Picture Compression Standard",
Communications of the ACM, April 1991 (vol. 34, no. 4), pp. 30-44.</para>
</refsect1>

<refsect1 id='author'><title>AUTHOR</title>
<para>Independent JPEG Group</para>
</refsect1>

<refsect1 id='bugs'><title>BUGS</title>
<para>Arithmetic coding is not supported for legal reasons.</para>

<para>GIF input files are no longer supported, to avoid the Unisys LZW patent.
Use a Unisys-licensed program if you need to read a GIF file.  (Conversion
of GIF files to JPEG is usually a bad idea anyway.)</para>

<para>Not all variants of BMP and Targa file formats are supported.</para>

<para>The
<option>-targa</option>
switch is not a bug, it's a feature.  (It would be a bug if the Targa format
designers had not been clueless.)</para>

<para>Still not as fast as we'd like.</para>
</refsect1>
</refentry>

