jpeg/README

   1 libjpeg-turbo note:  This file is mostly taken from the libjpeg v8b README
   2 file, and it is included only for reference.  Some parts of it may not apply to
   3 libjpeg-turbo.  Please see README-turbo.txt for information specific to the
   4 turbo version.
   5
   6
   7 The Independent JPEG Group's JPEG software
   8 ==========================================
   9
  10 This distribution contains a release of the Independent JPEG Group's free JPEG
  11 software.  You are welcome to redistribute this software and to use it for any
  12 purpose, subject to the conditions under LEGAL ISSUES, below.
  13
  14 This software is the work of Tom Lane, Guido Vollbeding, Philip Gladstone,
  15 Bill Allombert, Jim Boucher, Lee Crocker, Bob Friesenhahn, Ben Jackson,
  16 Julian Minguillon, Luis Ortiz, George Phillips, Davide Rossi, Ge' Weijers,
  17 and other members of the Independent JPEG Group.
  18
  19 IJG is not affiliated with the official ISO JPEG standards committee.
  20
  21
  22 DOCUMENTATION ROADMAP
  23 =====================
  24
  25 This file contains the following sections:
  26
  27 OVERVIEW            General description of JPEG and the IJG software.
  28 LEGAL ISSUES        Copyright, lack of warranty, terms of distribution.
  29 REFERENCES          Where to learn more about JPEG.
  30 ARCHIVE LOCATIONS   Where to find newer versions of this software.
  31 FILE FORMAT WARS    Software *not* to get.
  32 TO DO               Plans for future IJG releases.
  33
  34 Other documentation files in the distribution are:
  35
  36 User documentation:
  37   install.txt       How to configure and install the IJG software.
  38   usage.txt         Usage instructions for cjpeg, djpeg, jpegtran,
  39                     rdjpgcom, and wrjpgcom.
  40   *.1               Unix-style man pages for programs (same info as usage.txt).
  41   wizard.txt        Advanced usage instructions for JPEG wizards only.
  42   change.log        Version-to-version change highlights.
  43 Programmer and internal documentation:
  44   libjpeg.txt       How to use the JPEG library in your own programs.
  45   example.c         Sample code for calling the JPEG library.
  46   structure.txt     Overview of the JPEG library's internal structure.
  47   filelist.txt      Road map of IJG files.
  48   coderules.txt     Coding style rules --- please read if you contribute code.
  49
  50 Please read at least the files install.txt and usage.txt.  Some information
  51 can also be found in the JPEG FAQ (Frequently Asked Questions) article.  See
  52 ARCHIVE LOCATIONS below to find out where to obtain the FAQ article.
  53
  54 If you want to understand how the JPEG code works, we suggest reading one or
  55 more of the REFERENCES, then looking at the documentation files (in roughly
  56 the order listed) before diving into the code.
  57
  58
  59 OVERVIEW
  60 ========
  61
  62 This package contains C software to implement JPEG image encoding, decoding,
  63 and transcoding.  JPEG (pronounced "jay-peg") is a standardized compression
  64 method for full-color and gray-scale images.  JPEG's strong suit is compressing
  65 photographic images or other types of images which have smooth color and
  66 brightness transitions between neighboring pixels.  Images with sharp lines or
  67 other abrupt features may not compress well with JPEG, and a higher JPEG
  68 quality may have to be used to avoid visible compression artifacts with such
  69 images.
  70
  71 JPEG is lossy, meaning that the output pixels are not necessarily identical to
  72 the input pixels.  However, on photographic content and other "smooth" images,
  73 very good compression ratios can be obtained with no visible compression
  74 artifacts, and extremely high compression ratios are possible if you are
  75 willing to sacrifice image quality (by reducing the "quality" setting in the
  76 compressor.)
  77
  78 This software implements JPEG baseline, extended-sequential, and progressive
  79 compression processes.  Provision is made for supporting all variants of these
  80 processes, although some uncommon parameter settings aren't implemented yet.
  81 We have made no provision for supporting the hierarchical or lossless
  82 processes defined in the standard.
  83
  84 We provide a set of library routines for reading and writing JPEG image files,
  85 plus two sample applications "cjpeg" and "djpeg", which use the library to
  86 perform conversion between JPEG and some other popular image file formats.
  87 The library is intended to be reused in other applications.
  88
  89 In order to support file conversion and viewing software, we have included
  90 considerable functionality beyond the bare JPEG coding/decoding capability;
  91 for example, the color quantization modules are not strictly part of JPEG
  92 decoding, but they are essential for output to colormapped file formats or
  93 colormapped displays.  These extra functions can be compiled out of the
  94 library if not required for a particular application.
  95
  96 We have also included "jpegtran", a utility for lossless transcoding between
  97 different JPEG processes, and "rdjpgcom" and "wrjpgcom", two simple
  98 applications for inserting and extracting textual comments in JFIF files.
  99
 100 The emphasis in designing this software has been on achieving portability and
 101 flexibility, while also making it fast enough to be useful.  In particular,
 102 the software is not intended to be read as a tutorial on JPEG.  (See the
 103 REFERENCES section for introductory material.)  Rather, it is intended to
 104 be reliable, portable, industrial-strength code.  We do not claim to have
 105 achieved that goal in every aspect of the software, but we strive for it.
 106
 107 We welcome the use of this software as a component of commercial products.
 108 No royalty is required, but we do ask for an acknowledgement in product
 109 documentation, as described under LEGAL ISSUES.
 110
 111
 112 LEGAL ISSUES
 113 ============
 114
 115 In plain English:
 116
 117 1. We don't promise that this software works.  (But if you find any bugs,
 118    please let us know!)
 119 2. You can use this software for whatever you want.  You don't have to pay us.
 120 3. You may not pretend that you wrote this software.  If you use it in a
 121    program, you must acknowledge somewhere in your documentation that
 122    you've used the IJG code.
 123
 124 In legalese:
 125
 126 The authors make NO WARRANTY or representation, either express or implied,
 127 with respect to this software, its quality, accuracy, merchantability, or
 128 fitness for a particular purpose.  This software is provided "AS IS", and you,
 129 its user, assume the entire risk as to its quality and accuracy.
 130
 131 This software is copyright (C) 1991-2010, Thomas G. Lane, Guido Vollbeding.
 132 All Rights Reserved except as specified below.
 133
 134 Permission is hereby granted to use, copy, modify, and distribute this
 135 software (or portions thereof) for any purpose, without fee, subject to these
 136 conditions:
 137 (1) If any part of the source code for this software is distributed, then this
 138 README file must be included, with this copyright and no-warranty notice
 139 unaltered; and any additions, deletions, or changes to the original files
 140 must be clearly indicated in accompanying documentation.
 141 (2) If only executable code is distributed, then the accompanying
 142 documentation must state that "this software is based in part on the work of
 143 the Independent JPEG Group".
 144 (3) Permission for use of this software is granted only if the user accepts
 145 full responsibility for any undesirable consequences; the authors accept
 146 NO LIABILITY for damages of any kind.
 147
 148 These conditions apply to any software derived from or based on the IJG code,
 149 not just to the unmodified library.  If you use our work, you ought to
 150 acknowledge us.
 151
 152 Permission is NOT granted for the use of any IJG author's name or company name
 153 in advertising or publicity relating to this software or products derived from
 154 it.  This software may be referred to only as "the Independent JPEG Group's
 155 software".
 156
 157 We specifically permit and encourage the use of this software as the basis of
 158 commercial products, provided that all warranty or liability claims are
 159 assumed by the product vendor.
 160
 161
 162 ansi2knr.c is included in this distribution by permission of L. Peter Deutsch,
 163 sole proprietor of its copyright holder, Aladdin Enterprises of Menlo Park, CA.
 164 ansi2knr.c is NOT covered by the above copyright and conditions, but instead
 165 by the usual distribution terms of the Free Software Foundation; principally,
 166 that you must include source code if you redistribute it.  (See the file
 167 ansi2knr.c for full details.)  However, since ansi2knr.c is not needed as part
 168 of any program generated from the IJG code, this does not limit you more than
 169 the foregoing paragraphs do.
 170
 171 The Unix configuration script "configure" was produced with GNU Autoconf.
 172 It is copyright by the Free Software Foundation but is freely distributable.
 173 The same holds for its supporting scripts (config.guess, config.sub,
 174 ltmain.sh).  Another support script, install-sh, is copyright by X Consortium
 175 but is also freely distributable.
 176
 177 The IJG distribution formerly included code to read and write GIF files.
 178 To avoid entanglement with the Unisys LZW patent, GIF reading support has
 179 been removed altogether, and the GIF writer has been simplified to produce
 180 "uncompressed GIFs".  This technique does not use the LZW algorithm; the
 181 resulting GIF files are larger than usual, but are readable by all standard
 182 GIF decoders.
 183
 184 We are required to state that
 185     "The Graphics Interchange Format(c) is the Copyright property of
 186     CompuServe Incorporated.  GIF(sm) is a Service Mark property of
 187     CompuServe Incorporated."
 188
 189
 190 REFERENCES
 191 ==========
 192
 193 We recommend reading one or more of these references before trying to
 194 understand the innards of the JPEG software.
 195
 196 The best short technical introduction to the JPEG compression algorithm is
 197         Wallace, Gregory K.  "The JPEG Still Picture Compression Standard",
 198         Communications of the ACM, April 1991 (vol. 34 no. 4), pp. 30-44.
 199 (Adjacent articles in that issue discuss MPEG motion picture compression,
 200 applications of JPEG, and related topics.)  If you don't have the CACM issue
 201 handy, a PostScript file containing a revised version of Wallace's article is
 202 available at http://www.ijg.org/files/wallace.ps.gz.  The file (actually
 203 a preprint for an article that appeared in IEEE Trans. Consumer Electronics)
 204 omits the sample images that appeared in CACM, but it includes corrections
 205 and some added material.  Note: the Wallace article is copyright ACM and IEEE,
 206 and it may not be used for commercial purposes.
 207
 208 A somewhat less technical, more leisurely introduction to JPEG can be found in
 209 "The Data Compression Book" by Mark Nelson and Jean-loup Gailly, published by
 210 M&T Books (New York), 2nd ed. 1996, ISBN 1-55851-434-1.  This book provides
 211 good explanations and example C code for a multitude of compression methods
 212 including JPEG.  It is an excellent source if you are comfortable reading C
 213 code but don't know much about data compression in general.  The book's JPEG
 214 sample code is far from industrial-strength, but when you are ready to look
 215 at a full implementation, you've got one here...
 216
 217 The best currently available description of JPEG is the textbook "JPEG Still
 218 Image Data Compression Standard" by William B. Pennebaker and Joan L.
 219 Mitchell, published by Van Nostrand Reinhold, 1993, ISBN 0-442-01272-1.
 220 Price US$59.95, 638 pp.  The book includes the complete text of the ISO JPEG
 221 standards (DIS 10918-1 and draft DIS 10918-2).
 222
 223 The original JPEG standard is divided into two parts, Part 1 being the actual
 224 specification, while Part 2 covers compliance testing methods.  Part 1 is
 225 titled "Digital Compression and Coding of Continuous-tone Still Images,
 226 Part 1: Requirements and guidelines" and has document numbers ISO/IEC IS
 227 10918-1, ITU-T T.81.  Part 2 is titled "Digital Compression and Coding of
 228 Continuous-tone Still Images, Part 2: Compliance testing" and has document
 229 numbers ISO/IEC IS 10918-2, ITU-T T.83.
 230
 231 The JPEG standard does not specify all details of an interchangeable file
 232 format.  For the omitted details we follow the "JFIF" conventions, revision
 233 1.02.  JFIF 1.02 has been adopted as an Ecma International Technical Report
 234 and thus received a formal publication status.  It is available as a free
 235 download in PDF format from
 236 http://www.ecma-international.org/publications/techreports/E-TR-098.htm.
 237 A PostScript version of the JFIF document is available at
 238 http://www.ijg.org/files/jfif.ps.gz.  There is also a plain text version at
 239 http://www.ijg.org/files/jfif.txt.gz, but it is missing the figures.
 240
 241 The TIFF 6.0 file format specification can be obtained by FTP from
 242 ftp://ftp.sgi.com/graphics/tiff/TIFF6.ps.gz.  The JPEG incorporation scheme
 243 found in the TIFF 6.0 spec of 3-June-92 has a number of serious problems.
 244 IJG does not recommend use of the TIFF 6.0 design (TIFF Compression tag 6).
 245 Instead, we recommend the JPEG design proposed by TIFF Technical Note #2
 246 (Compression tag 7).  Copies of this Note can be obtained from
 247 http://www.ijg.org/files/.  It is expected that the next revision
 248 of the TIFF spec will replace the 6.0 JPEG design with the Note's design.
 249 Although IJG's own code does not support TIFF/JPEG, the free libtiff library
 250 uses our library to implement TIFF/JPEG per the Note.
 251
 252
 253 ARCHIVE LOCATIONS
 254 =================
 255
 256 The "official" archive site for this software is www.ijg.org.
 257 The most recent released version can always be found there in
 258 directory "files".  This particular version will be archived as
 259 http://www.ijg.org/files/jpegsrc.v8b.tar.gz, and in Windows-compatible
 260 "zip" archive format as http://www.ijg.org/files/jpegsr8b.zip.
 261
 262 The JPEG FAQ (Frequently Asked Questions) article is a source of some
 263 general information about JPEG.
 264 It is available on the World Wide Web at http://www.faqs.org/faqs/jpeg-faq/
 265 and other news.answers archive sites, including the official news.answers
 266 archive at rtfm.mit.edu: ftp://rtfm.mit.edu/pub/usenet/news.answers/jpeg-faq/.
 267 If you don't have Web or FTP access, send e-mail to mail-server@rtfm.mit.edu
 268 with body
 269         send usenet/news.answers/jpeg-faq/part1
 270         send usenet/news.answers/jpeg-faq/part2
 271
 272
 273 FILE FORMAT WARS
 274 ================
 275
 276 The ISO JPEG standards committee actually promotes different formats like
 277 "JPEG 2000" or "JPEG XR" which are incompatible with original DCT-based
 278 JPEG.  IJG therefore does not support these formats (see REFERENCES).  Indeed,
 279 one of the original reasons for developing this free software was to help
 280 force convergence on common, interoperable format standards for JPEG files.
 281 Don't use an incompatible file format!
 282 (In any case, our decoder will remain capable of reading existing JPEG
 283 image files indefinitely.)
 284
 285
 286 TO DO
 287 =====
 288
 289 Please send bug reports, offers of help, etc. to jpeg-info@uc.ag.