[IPLUG/AAX] remove IPlugAAX::SetParameterFromGUI()
[wdl/wdl-ol.git] / WDL / jpeglib / README
blob911d0e843beda5f7253a93ffbf50f9441dfd97f5
1 The Independent JPEG Group's JPEG software\r
2 ==========================================\r
3 \r
4 README for release 6b of 27-Mar-1998\r
5 ====================================\r
6 \r
7 This distribution contains the sixth public release of the Independent JPEG\r
8 Group's free JPEG software.  You are welcome to redistribute this software and\r
9 to use it for any purpose, subject to the conditions under LEGAL ISSUES, below.\r
11 Serious users of this software (particularly those incorporating it into\r
12 larger programs) should contact IJG at jpeg-info@uunet.uu.net to be added to\r
13 our electronic mailing list.  Mailing list members are notified of updates\r
14 and have a chance to participate in technical discussions, etc.\r
16 This software is the work of Tom Lane, Philip Gladstone, Jim Boucher,\r
17 Lee Crocker, Julian Minguillon, Luis Ortiz, George Phillips, Davide Rossi,\r
18 Guido Vollbeding, Ge' Weijers, and other members of the Independent JPEG\r
19 Group.\r
21 IJG is not affiliated with the official ISO JPEG standards committee.\r
24 DOCUMENTATION ROADMAP\r
25 =====================\r
27 This file contains the following sections:\r
29 OVERVIEW            General description of JPEG and the IJG software.\r
30 LEGAL ISSUES        Copyright, lack of warranty, terms of distribution.\r
31 REFERENCES          Where to learn more about JPEG.\r
32 ARCHIVE LOCATIONS   Where to find newer versions of this software.\r
33 RELATED SOFTWARE    Other stuff you should get.\r
34 FILE FORMAT WARS    Software *not* to get.\r
35 TO DO               Plans for future IJG releases.\r
37 Other documentation files in the distribution are:\r
39 User documentation:\r
40   install.doc       How to configure and install the IJG software.\r
41   usage.doc         Usage instructions for cjpeg, djpeg, jpegtran,\r
42                     rdjpgcom, and wrjpgcom.\r
43   *.1               Unix-style man pages for programs (same info as usage.doc).\r
44   wizard.doc        Advanced usage instructions for JPEG wizards only.\r
45   change.log        Version-to-version change highlights.\r
46 Programmer and internal documentation:\r
47   libjpeg.doc       How to use the JPEG library in your own programs.\r
48   example.c         Sample code for calling the JPEG library.\r
49   structure.doc     Overview of the JPEG library's internal structure.\r
50   filelist.doc      Road map of IJG files.\r
51   coderules.doc     Coding style rules --- please read if you contribute code.\r
53 Please read at least the files install.doc and usage.doc.  Useful information\r
54 can also be found in the JPEG FAQ (Frequently Asked Questions) article.  See\r
55 ARCHIVE LOCATIONS below to find out where to obtain the FAQ article.\r
57 If you want to understand how the JPEG code works, we suggest reading one or\r
58 more of the REFERENCES, then looking at the documentation files (in roughly\r
59 the order listed) before diving into the code.\r
62 OVERVIEW\r
63 ========\r
65 This package contains C software to implement JPEG image compression and\r
66 decompression.  JPEG (pronounced "jay-peg") is a standardized compression\r
67 method for full-color and gray-scale images.  JPEG is intended for compressing\r
68 "real-world" scenes; line drawings, cartoons and other non-realistic images\r
69 are not its strong suit.  JPEG is lossy, meaning that the output image is not\r
70 exactly identical to the input image.  Hence you must not use JPEG if you\r
71 have to have identical output bits.  However, on typical photographic images,\r
72 very good compression levels can be obtained with no visible change, and\r
73 remarkably high compression levels are possible if you can tolerate a\r
74 low-quality image.  For more details, see the references, or just experiment\r
75 with various compression settings.\r
77 This software implements JPEG baseline, extended-sequential, and progressive\r
78 compression processes.  Provision is made for supporting all variants of these\r
79 processes, although some uncommon parameter settings aren't implemented yet.\r
80 For legal reasons, we are not distributing code for the arithmetic-coding\r
81 variants of JPEG; see LEGAL ISSUES.  We have made no provision for supporting\r
82 the hierarchical or lossless processes defined in the standard.\r
84 We provide a set of library routines for reading and writing JPEG image files,\r
85 plus two sample applications "cjpeg" and "djpeg", which use the library to\r
86 perform conversion between JPEG and some other popular image file formats.\r
87 The library is intended to be reused in other applications.\r
89 In order to support file conversion and viewing software, we have included\r
90 considerable functionality beyond the bare JPEG coding/decoding capability;\r
91 for example, the color quantization modules are not strictly part of JPEG\r
92 decoding, but they are essential for output to colormapped file formats or\r
93 colormapped displays.  These extra functions can be compiled out of the\r
94 library if not required for a particular application.  We have also included\r
95 "jpegtran", a utility for lossless transcoding between different JPEG\r
96 processes, and "rdjpgcom" and "wrjpgcom", two simple applications for\r
97 inserting and extracting textual comments in JFIF files.\r
99 The emphasis in designing this software has been on achieving portability and\r
100 flexibility, while also making it fast enough to be useful.  In particular,\r
101 the software is not intended to be read as a tutorial on JPEG.  (See the\r
102 REFERENCES section for introductory material.)  Rather, it is intended to\r
103 be reliable, portable, industrial-strength code.  We do not claim to have\r
104 achieved that goal in every aspect of the software, but we strive for it.\r
106 We welcome the use of this software as a component of commercial products.\r
107 No royalty is required, but we do ask for an acknowledgement in product\r
108 documentation, as described under LEGAL ISSUES.\r
111 LEGAL ISSUES\r
112 ============\r
114 In plain English:\r
116 1. We don't promise that this software works.  (But if you find any bugs,\r
117    please let us know!)\r
118 2. You can use this software for whatever you want.  You don't have to pay us.\r
119 3. You may not pretend that you wrote this software.  If you use it in a\r
120    program, you must acknowledge somewhere in your documentation that\r
121    you've used the IJG code.\r
123 In legalese:\r
125 The authors make NO WARRANTY or representation, either express or implied,\r
126 with respect to this software, its quality, accuracy, merchantability, or\r
127 fitness for a particular purpose.  This software is provided "AS IS", and you,\r
128 its user, assume the entire risk as to its quality and accuracy.\r
130 This software is copyright (C) 1991-1998, Thomas G. Lane.\r
131 All Rights Reserved except as specified below.\r
133 Permission is hereby granted to use, copy, modify, and distribute this\r
134 software (or portions thereof) for any purpose, without fee, subject to these\r
135 conditions:\r
136 (1) If any part of the source code for this software is distributed, then this\r
137 README file must be included, with this copyright and no-warranty notice\r
138 unaltered; and any additions, deletions, or changes to the original files\r
139 must be clearly indicated in accompanying documentation.\r
140 (2) If only executable code is distributed, then the accompanying\r
141 documentation must state that "this software is based in part on the work of\r
142 the Independent JPEG Group".\r
143 (3) Permission for use of this software is granted only if the user accepts\r
144 full responsibility for any undesirable consequences; the authors accept\r
145 NO LIABILITY for damages of any kind.\r
147 These conditions apply to any software derived from or based on the IJG code,\r
148 not just to the unmodified library.  If you use our work, you ought to\r
149 acknowledge us.\r
151 Permission is NOT granted for the use of any IJG author's name or company name\r
152 in advertising or publicity relating to this software or products derived from\r
153 it.  This software may be referred to only as "the Independent JPEG Group's\r
154 software".\r
156 We specifically permit and encourage the use of this software as the basis of\r
157 commercial products, provided that all warranty or liability claims are\r
158 assumed by the product vendor.\r
161 ansi2knr.c is included in this distribution by permission of L. Peter Deutsch,\r
162 sole proprietor of its copyright holder, Aladdin Enterprises of Menlo Park, CA.\r
163 ansi2knr.c is NOT covered by the above copyright and conditions, but instead\r
164 by the usual distribution terms of the Free Software Foundation; principally,\r
165 that you must include source code if you redistribute it.  (See the file\r
166 ansi2knr.c for full details.)  However, since ansi2knr.c is not needed as part\r
167 of any program generated from the IJG code, this does not limit you more than\r
168 the foregoing paragraphs do.\r
170 The Unix configuration script "configure" was produced with GNU Autoconf.\r
171 It is copyright by the Free Software Foundation but is freely distributable.\r
172 The same holds for its supporting scripts (config.guess, config.sub,\r
173 ltconfig, ltmain.sh).  Another support script, install-sh, is copyright\r
174 by M.I.T. but is also freely distributable.\r
176 It appears that the arithmetic coding option of the JPEG spec is covered by\r
177 patents owned by IBM, AT&T, and Mitsubishi.  Hence arithmetic coding cannot\r
178 legally be used without obtaining one or more licenses.  For this reason,\r
179 support for arithmetic coding has been removed from the free JPEG software.\r
180 (Since arithmetic coding provides only a marginal gain over the unpatented\r
181 Huffman mode, it is unlikely that very many implementations will support it.)\r
182 So far as we are aware, there are no patent restrictions on the remaining\r
183 code.\r
185 The IJG distribution formerly included code to read and write GIF files.\r
186 To avoid entanglement with the Unisys LZW patent, GIF reading support has\r
187 been removed altogether, and the GIF writer has been simplified to produce\r
188 "uncompressed GIFs".  This technique does not use the LZW algorithm; the\r
189 resulting GIF files are larger than usual, but are readable by all standard\r
190 GIF decoders.\r
192 We are required to state that\r
193     "The Graphics Interchange Format(c) is the Copyright property of\r
194     CompuServe Incorporated.  GIF(sm) is a Service Mark property of\r
195     CompuServe Incorporated."\r
198 REFERENCES\r
199 ==========\r
201 We highly recommend reading one or more of these references before trying to\r
202 understand the innards of the JPEG software.\r
204 The best short technical introduction to the JPEG compression algorithm is\r
205         Wallace, Gregory K.  "The JPEG Still Picture Compression Standard",\r
206         Communications of the ACM, April 1991 (vol. 34 no. 4), pp. 30-44.\r
207 (Adjacent articles in that issue discuss MPEG motion picture compression,\r
208 applications of JPEG, and related topics.)  If you don't have the CACM issue\r
209 handy, a PostScript file containing a revised version of Wallace's article is\r
210 available at ftp://ftp.uu.net/graphics/jpeg/wallace.ps.gz.  The file (actually\r
211 a preprint for an article that appeared in IEEE Trans. Consumer Electronics)\r
212 omits the sample images that appeared in CACM, but it includes corrections\r
213 and some added material.  Note: the Wallace article is copyright ACM and IEEE,\r
214 and it may not be used for commercial purposes.\r
216 A somewhat less technical, more leisurely introduction to JPEG can be found in\r
217 "The Data Compression Book" by Mark Nelson and Jean-loup Gailly, published by\r
218 M&T Books (New York), 2nd ed. 1996, ISBN 1-55851-434-1.  This book provides\r
219 good explanations and example C code for a multitude of compression methods\r
220 including JPEG.  It is an excellent source if you are comfortable reading C\r
221 code but don't know much about data compression in general.  The book's JPEG\r
222 sample code is far from industrial-strength, but when you are ready to look\r
223 at a full implementation, you've got one here...\r
225 The best full description of JPEG is the textbook "JPEG Still Image Data\r
226 Compression Standard" by William B. Pennebaker and Joan L. Mitchell, published\r
227 by Van Nostrand Reinhold, 1993, ISBN 0-442-01272-1.  Price US$59.95, 638 pp.\r
228 The book includes the complete text of the ISO JPEG standards (DIS 10918-1\r
229 and draft DIS 10918-2).  This is by far the most complete exposition of JPEG\r
230 in existence, and we highly recommend it.\r
232 The JPEG standard itself is not available electronically; you must order a\r
233 paper copy through ISO or ITU.  (Unless you feel a need to own a certified\r
234 official copy, we recommend buying the Pennebaker and Mitchell book instead;\r
235 it's much cheaper and includes a great deal of useful explanatory material.)\r
236 In the USA, copies of the standard may be ordered from ANSI Sales at (212)\r
237 642-4900, or from Global Engineering Documents at (800) 854-7179.  (ANSI\r
238 doesn't take credit card orders, but Global does.)  It's not cheap: as of\r
239 1992, ANSI was charging $95 for Part 1 and $47 for Part 2, plus 7%\r
240 shipping/handling.  The standard is divided into two parts, Part 1 being the\r
241 actual specification, while Part 2 covers compliance testing methods.  Part 1\r
242 is titled "Digital Compression and Coding of Continuous-tone Still Images,\r
243 Part 1: Requirements and guidelines" and has document numbers ISO/IEC IS\r
244 10918-1, ITU-T T.81.  Part 2 is titled "Digital Compression and Coding of\r
245 Continuous-tone Still Images, Part 2: Compliance testing" and has document\r
246 numbers ISO/IEC IS 10918-2, ITU-T T.83.\r
248 Some extensions to the original JPEG standard are defined in JPEG Part 3,\r
249 a newer ISO standard numbered ISO/IEC IS 10918-3 and ITU-T T.84.  IJG\r
250 currently does not support any Part 3 extensions.\r
252 The JPEG standard does not specify all details of an interchangeable file\r
253 format.  For the omitted details we follow the "JFIF" conventions, revision\r
254 1.02.  A copy of the JFIF spec is available from:\r
255         Literature Department\r
256         C-Cube Microsystems, Inc.\r
257         1778 McCarthy Blvd.\r
258         Milpitas, CA 95035\r
259         phone (408) 944-6300,  fax (408) 944-6314\r
260 A PostScript version of this document is available by FTP at\r
261 ftp://ftp.uu.net/graphics/jpeg/jfif.ps.gz.  There is also a plain text\r
262 version at ftp://ftp.uu.net/graphics/jpeg/jfif.txt.gz, but it is missing\r
263 the figures.\r
265 The TIFF 6.0 file format specification can be obtained by FTP from\r
266 ftp://ftp.sgi.com/graphics/tiff/TIFF6.ps.gz.  The JPEG incorporation scheme\r
267 found in the TIFF 6.0 spec of 3-June-92 has a number of serious problems.\r
268 IJG does not recommend use of the TIFF 6.0 design (TIFF Compression tag 6).\r
269 Instead, we recommend the JPEG design proposed by TIFF Technical Note #2\r
270 (Compression tag 7).  Copies of this Note can be obtained from ftp.sgi.com or\r
271 from ftp://ftp.uu.net/graphics/jpeg/.  It is expected that the next revision\r
272 of the TIFF spec will replace the 6.0 JPEG design with the Note's design.\r
273 Although IJG's own code does not support TIFF/JPEG, the free libtiff library\r
274 uses our library to implement TIFF/JPEG per the Note.  libtiff is available\r
275 from ftp://ftp.sgi.com/graphics/tiff/.\r
278 ARCHIVE LOCATIONS\r
279 =================\r
281 The "official" archive site for this software is ftp.uu.net (Internet\r
282 address 192.48.96.9).  The most recent released version can always be found\r
283 there in directory graphics/jpeg.  This particular version will be archived\r
284 as ftp://ftp.uu.net/graphics/jpeg/jpegsrc.v6b.tar.gz.  If you don't have\r
285 direct Internet access, UUNET's archives are also available via UUCP; contact\r
286 help@uunet.uu.net for information on retrieving files that way.\r
288 Numerous Internet sites maintain copies of the UUNET files.  However, only\r
289 ftp.uu.net is guaranteed to have the latest official version.\r
291 You can also obtain this software in DOS-compatible "zip" archive format from\r
292 the SimTel archives (ftp://ftp.simtel.net/pub/simtelnet/msdos/graphics/), or\r
293 on CompuServe in the Graphics Support forum (GO CIS:GRAPHSUP), library 12\r
294 "JPEG Tools".  Again, these versions may sometimes lag behind the ftp.uu.net\r
295 release.\r
297 The JPEG FAQ (Frequently Asked Questions) article is a useful source of\r
298 general information about JPEG.  It is updated constantly and therefore is\r
299 not included in this distribution.  The FAQ is posted every two weeks to\r
300 Usenet newsgroups comp.graphics.misc, news.answers, and other groups.\r
301 It is available on the World Wide Web at http://www.faqs.org/faqs/jpeg-faq/\r
302 and other news.answers archive sites, including the official news.answers\r
303 archive at rtfm.mit.edu: ftp://rtfm.mit.edu/pub/usenet/news.answers/jpeg-faq/.\r
304 If you don't have Web or FTP access, send e-mail to mail-server@rtfm.mit.edu\r
305 with body\r
306         send usenet/news.answers/jpeg-faq/part1\r
307         send usenet/news.answers/jpeg-faq/part2\r
310 RELATED SOFTWARE\r
311 ================\r
313 Numerous viewing and image manipulation programs now support JPEG.  (Quite a\r
314 few of them use this library to do so.)  The JPEG FAQ described above lists\r
315 some of the more popular free and shareware viewers, and tells where to\r
316 obtain them on Internet.\r
318 If you are on a Unix machine, we highly recommend Jef Poskanzer's free\r
319 PBMPLUS software, which provides many useful operations on PPM-format image\r
320 files.  In particular, it can convert PPM images to and from a wide range of\r
321 other formats, thus making cjpeg/djpeg considerably more useful.  The latest\r
322 version is distributed by the NetPBM group, and is available from numerous\r
323 sites, notably ftp://wuarchive.wustl.edu/graphics/graphics/packages/NetPBM/.\r
324 Unfortunately PBMPLUS/NETPBM is not nearly as portable as the IJG software is;\r
325 you are likely to have difficulty making it work on any non-Unix machine.\r
327 A different free JPEG implementation, written by the PVRG group at Stanford,\r
328 is available from ftp://havefun.stanford.edu/pub/jpeg/.  This program\r
329 is designed for research and experimentation rather than production use;\r
330 it is slower, harder to use, and less portable than the IJG code, but it\r
331 is easier to read and modify.  Also, the PVRG code supports lossless JPEG,\r
332 which we do not.  (On the other hand, it doesn't do progressive JPEG.)\r
335 FILE FORMAT WARS\r
336 ================\r
338 Some JPEG programs produce files that are not compatible with our library.\r
339 The root of the problem is that the ISO JPEG committee failed to specify a\r
340 concrete file format.  Some vendors "filled in the blanks" on their own,\r
341 creating proprietary formats that no one else could read.  (For example, none\r
342 of the early commercial JPEG implementations for the Macintosh were able to\r
343 exchange compressed files.)\r
345 The file format we have adopted is called JFIF (see REFERENCES).  This format\r
346 has been agreed to by a number of major commercial JPEG vendors, and it has\r
347 become the de facto standard.  JFIF is a minimal or "low end" representation.\r
348 We recommend the use of TIFF/JPEG (TIFF revision 6.0 as modified by TIFF\r
349 Technical Note #2) for "high end" applications that need to record a lot of\r
350 additional data about an image.  TIFF/JPEG is fairly new and not yet widely\r
351 supported, unfortunately.\r
353 The upcoming JPEG Part 3 standard defines a file format called SPIFF.\r
354 SPIFF is interoperable with JFIF, in the sense that most JFIF decoders should\r
355 be able to read the most common variant of SPIFF.  SPIFF has some technical\r
356 advantages over JFIF, but its major claim to fame is simply that it is an\r
357 official standard rather than an informal one.  At this point it is unclear\r
358 whether SPIFF will supersede JFIF or whether JFIF will remain the de-facto\r
359 standard.  IJG intends to support SPIFF once the standard is frozen, but we\r
360 have not decided whether it should become our default output format or not.\r
361 (In any case, our decoder will remain capable of reading JFIF indefinitely.)\r
363 Various proprietary file formats incorporating JPEG compression also exist.\r
364 We have little or no sympathy for the existence of these formats.  Indeed,\r
365 one of the original reasons for developing this free software was to help\r
366 force convergence on common, open format standards for JPEG files.  Don't\r
367 use a proprietary file format!\r
370 TO DO\r
371 =====\r
373 The major thrust for v7 will probably be improvement of visual quality.\r
374 The current method for scaling the quantization tables is known not to be\r
375 very good at low Q values.  We also intend to investigate block boundary\r
376 smoothing, "poor man's variable quantization", and other means of improving\r
377 quality-vs-file-size performance without sacrificing compatibility.\r
379 In future versions, we are considering supporting some of the upcoming JPEG\r
380 Part 3 extensions --- principally, variable quantization and the SPIFF file\r
381 format.\r
383 As always, speeding things up is of great interest.\r
385 Please send bug reports, offers of help, etc. to jpeg-info@uunet.uu.net.\r