NameDateSize

..10-Aug-201812 KiB

.gitignore10-Aug-2018146

acinclude.m410-Aug-20186.7 KiB

Android.bp10-Aug-20185.9 KiB

appveyor.yml10-Aug-20181.8 KiB

bmp.c10-Aug-20189.7 KiB

bmp.h10-Aug-20181.8 KiB

BUILDING.md10-Aug-201834.3 KiB

cderror.h10-Aug-20185.3 KiB

cdjpeg.c10-Aug-20183.9 KiB

cdjpeg.h10-Aug-20185.5 KiB

change.log10-Aug-201812.1 KiB

ChangeLog.md10-Aug-201855.1 KiB

ci/10-Aug-20184 KiB

cjpeg.110-Aug-201813.2 KiB

cjpeg.c10-Aug-201821.3 KiB

CMakeLists.txt10-Aug-201837.2 KiB

cmakescripts/10-Aug-20184 KiB

coderules.txt10-Aug-20183.4 KiB

configure.ac10-Aug-201819.4 KiB

djpeg.110-Aug-20189.6 KiB

djpeg.c10-Aug-201825.8 KiB

doc/10-Aug-20184 KiB

doxygen-extra.css10-Aug-201826

doxygen.config10-Aug-2018401

example.c10-Aug-201816.8 KiB

jaricom.c10-Aug-20185 KiB

java/10-Aug-20184 KiB

jcapimin.c10-Aug-20189.5 KiB

jcapistd.c10-Aug-20185.8 KiB

jcarith.c10-Aug-201828.9 KiB

jccoefct.c10-Aug-201816.8 KiB

jccolext.c10-Aug-20184.5 KiB

jccolor.c10-Aug-201823.4 KiB

jcdctmgr.c10-Aug-201822 KiB

jchuff.c10-Aug-201833.6 KiB

jchuff.h10-Aug-20181.4 KiB

jcinit.c10-Aug-20182.4 KiB

jcmainct.c10-Aug-20185 KiB

jcmarker.c10-Aug-201817.2 KiB

jcmaster.c10-Aug-201821.4 KiB

jcomapi.c10-Aug-20183.2 KiB

jconfig.h10-Aug-20182.2 KiB

jconfig.h.in10-Aug-20182.1 KiB

jconfig.txt10-Aug-20184.8 KiB

jconfigint.h10-Aug-20181 KiB

jconfigint.h.in10-Aug-2018336

jcparam.c10-Aug-201817.7 KiB

jcphuff.c10-Aug-201825.3 KiB

jcprepct.c10-Aug-201812.9 KiB

jcsample.c10-Aug-201819.8 KiB

jcstest.c10-Aug-20183.8 KiB

jctrans.c10-Aug-201814.6 KiB

jdapimin.c10-Aug-201812.9 KiB

jdapistd.c10-Aug-201823.2 KiB

jdarith.c10-Aug-201824.4 KiB

jdatadst-tj.c10-Aug-20186.6 KiB

jdatadst.c10-Aug-20189.5 KiB

jdatasrc-tj.c10-Aug-20186.7 KiB

jdatasrc.c10-Aug-201810.1 KiB

jdcoefct.c10-Aug-201824.7 KiB

jdcoefct.h10-Aug-20182.6 KiB

jdcol565.c10-Aug-201812 KiB

jdcolext.c10-Aug-20184.4 KiB

jdcolor.c10-Aug-201828.5 KiB

jdct.h10-Aug-20188.8 KiB

jddctmgr.c10-Aug-201811.2 KiB

jdhuff.c10-Aug-201825.4 KiB

jdhuff.h10-Aug-20189.2 KiB

jdinput.c10-Aug-201814.2 KiB

jdmainct.c10-Aug-201818.9 KiB

jdmainct.h10-Aug-20182.4 KiB

jdmarker.c10-Aug-201841.9 KiB

jdmaster.c10-Aug-201827.3 KiB

jdmaster.h10-Aug-2018788

jdmerge.c10-Aug-201820.9 KiB

jdmrg565.c10-Aug-201811.2 KiB

jdmrgext.c10-Aug-20185.9 KiB

jdphuff.c10-Aug-201821.4 KiB

jdpostct.c10-Aug-201810.1 KiB

jdsample.c10-Aug-201817.7 KiB

jdsample.h10-Aug-20181.7 KiB

jdtrans.c10-Aug-20185.3 KiB

jerror.c10-Aug-20187.7 KiB

jerror.h10-Aug-201814.7 KiB

jfdctflt.c10-Aug-20185.4 KiB

jfdctfst.c10-Aug-20187.6 KiB

jfdctint.c10-Aug-201811.2 KiB

jidctflt.c10-Aug-20188.5 KiB

jidctfst.c10-Aug-201813.4 KiB

jidctint.c10-Aug-2018102.7 KiB

jidctred.c10-Aug-201813.9 KiB

jinclude.h10-Aug-20182.9 KiB

jmemmgr.c10-Aug-201843.8 KiB

jmemnobs.c10-Aug-20182.8 KiB

jmemsys.h10-Aug-20187.6 KiB

jmorecfg.h10-Aug-201814.7 KiB

jpeg_nbits_table.h10-Aug-2018264.1 KiB

jpegcomp.h10-Aug-20181 KiB

jpegint.h10-Aug-201815.2 KiB

jpeglib.h10-Aug-201848.7 KiB

jpegtran.110-Aug-20189.4 KiB

jpegtran.c10-Aug-201818.3 KiB

jquant1.c10-Aug-201831.7 KiB

jquant2.c10-Aug-201847.7 KiB

jsimd.h10-Aug-20183.6 KiB

jsimd_none.c10-Aug-20187.4 KiB

jsimddct.h10-Aug-20183.2 KiB

jstdhuff.c10-Aug-20185.2 KiB

jutils.c10-Aug-20183.7 KiB

jversion.h10-Aug-20181.8 KiB

libjpeg.map.in10-Aug-2018164

libjpeg.txt10-Aug-2018163.9 KiB

LICENSE.md10-Aug-20185.2 KiB

Makefile.am10-Aug-201833.5 KiB

md5/10-Aug-20184 KiB

MODULE_LICENSE_BSD10-Aug-20180

NOTICE10-Aug-20182.9 KiB

OWNERS10-Aug-201819

rdbmp.c10-Aug-201815.1 KiB

rdcolmap.c10-Aug-20186.9 KiB

rdgif.c10-Aug-20181.3 KiB

rdjpgcom.110-Aug-20181.7 KiB

rdjpgcom.c10-Aug-201814.7 KiB

rdppm.c10-Aug-201814.3 KiB

rdrle.c10-Aug-201811.5 KiB

rdswitch.c10-Aug-201812.7 KiB

rdtarga.c10-Aug-201815 KiB

README10-Aug-201813.5 KiB

README-turbo.txt10-Aug-201816.4 KiB

README.android10-Aug-20181.2 KiB

README.ijg10-Aug-201813.3 KiB

README.md10-Aug-201815.8 KiB

README.version10-Aug-2018151

release/10-Aug-20184 KiB

sharedlib/10-Aug-20184 KiB

simd/10-Aug-20184 KiB

structure.txt10-Aug-201848.6 KiB

testimages/10-Aug-20184 KiB

tjbench.c10-Aug-201831.1 KiB

tjbenchtest.in10-Aug-201811.4 KiB

tjbenchtest.java.in10-Aug-20189.6 KiB

tjexampletest.in10-Aug-20188 KiB

tjunittest.c10-Aug-201818.6 KiB

tjutil.c10-Aug-20182.1 KiB

tjutil.h10-Aug-20181.9 KiB

transupp.c10-Aug-201861 KiB

transupp.h10-Aug-20189.4 KiB

turbojpeg-jni.c10-Aug-201841.6 KiB

turbojpeg-mapfile10-Aug-2018794

turbojpeg-mapfile.jni10-Aug-20182.9 KiB

turbojpeg.c10-Aug-201861.9 KiB

turbojpeg.h10-Aug-201863.6 KiB

usage.txt10-Aug-201834.2 KiB

win/10-Aug-20184 KiB

wizard.txt10-Aug-201810.1 KiB

wrbmp.c10-Aug-201815.3 KiB

wrgif.c10-Aug-201813.2 KiB

wrjpgcom.110-Aug-20182.6 KiB

wrjpgcom.c10-Aug-201817.5 KiB

wrppm.c10-Aug-20188.3 KiB

wrppm.h10-Aug-2018721

wrrle.c10-Aug-20189.2 KiB

wrtarga.c10-Aug-20187.5 KiB

README

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

README-turbo.txt

1*******************************************************************************
2**     Background
3*******************************************************************************
4
5libjpeg-turbo is a JPEG image codec that uses SIMD instructions (MMX, SSE2,
6NEON) to accelerate baseline JPEG compression and decompression on x86, x86-64,
7and ARM systems.  On such systems, libjpeg-turbo is generally 2-4x as fast as
8libjpeg, all else being equal.  On other types of systems, libjpeg-turbo can
9still outperform libjpeg by a significant amount, by virtue of its
10highly-optimized Huffman coding routines.  In many cases, the performance of
11libjpeg-turbo rivals that of proprietary high-speed JPEG codecs.
12
13libjpeg-turbo implements both the traditional libjpeg API as well as the less
14powerful but more straightforward TurboJPEG API.  libjpeg-turbo also features
15colorspace extensions that allow it to compress from/decompress to 32-bit and
16big-endian pixel buffers (RGBX, XBGR, etc.), as well as a full-featured Java
17interface.
18
19libjpeg-turbo was originally based on libjpeg/SIMD, an MMX-accelerated
20derivative of libjpeg v6b developed by Miyasaka Masaru.  The TigerVNC and
21VirtualGL projects made numerous enhancements to the codec in 2009, and in
22early 2010, libjpeg-turbo spun off into an independent project, with the goal
23of making high-speed JPEG compression/decompression technology available to a
24broader range of users and developers.
25
26
27*******************************************************************************
28**     License
29*******************************************************************************
30
31libjpeg-turbo is covered by three compatible BSD-style open source licenses.
32Refer to LICENSE.txt for a roll-up of license terms.
33
34
35*******************************************************************************
36**     Using libjpeg-turbo
37*******************************************************************************
38
39libjpeg-turbo includes two APIs that can be used to compress and decompress
40JPEG images:
41
42  TurboJPEG API:  This API provides an easy-to-use interface for compressing
43  and decompressing JPEG images in memory.  It also provides some functionality
44  that would not be straightforward to achieve using the underlying libjpeg
45  API, such as generating planar YUV images and performing multiple
46  simultaneous lossless transforms on an image.  The Java interface for
47  libjpeg-turbo is written on top of the TurboJPEG API.
48
49  libjpeg API:  This is the de facto industry-standard API for compressing and
50  decompressing JPEG images.  It is more difficult to use than the TurboJPEG
51  API but also more powerful.  The libjpeg API implementation in libjpeg-turbo
52  is both API/ABI-compatible and mathematically compatible with libjpeg v6b.
53  It can also optionally be configured to be API/ABI-compatible with libjpeg v7
54  and v8 (see below.)
55
56There is no significant performance advantage to either API when both are used
57to perform similar operations.
58
59=====================
60Colorspace Extensions
61=====================
62
63libjpeg-turbo includes extensions that allow JPEG images to be compressed
64directly from (and decompressed directly to) buffers that use BGR, BGRX,
65RGBX, XBGR, and XRGB pixel ordering.  This is implemented with ten new
66colorspace constants:
67
68  JCS_EXT_RGB   /* red/green/blue */
69  JCS_EXT_RGBX  /* red/green/blue/x */
70  JCS_EXT_BGR   /* blue/green/red */
71  JCS_EXT_BGRX  /* blue/green/red/x */
72  JCS_EXT_XBGR  /* x/blue/green/red */
73  JCS_EXT_XRGB  /* x/red/green/blue */
74  JCS_EXT_RGBA  /* red/green/blue/alpha */
75  JCS_EXT_BGRA  /* blue/green/red/alpha */
76  JCS_EXT_ABGR  /* alpha/blue/green/red */
77  JCS_EXT_ARGB  /* alpha/red/green/blue */
78
79Setting cinfo.in_color_space (compression) or cinfo.out_color_space
80(decompression) to one of these values will cause libjpeg-turbo to read the
81red, green, and blue values from (or write them to) the appropriate position in
82the pixel when compressing from/decompressing to an RGB buffer.
83
84Your application can check for the existence of these extensions at compile
85time with:
86
87  #ifdef JCS_EXTENSIONS
88
89At run time, attempting to use these extensions with a libjpeg implementation
90that does not support them will result in a "Bogus input colorspace" error.
91Applications can trap this error in order to test whether run-time support is
92available for the colorspace extensions.
93
94When using the RGBX, BGRX, XBGR, and XRGB colorspaces during decompression, the
95X byte is undefined, and in order to ensure the best performance, libjpeg-turbo
96can set that byte to whatever value it wishes.  If an application expects the X
97byte to be used as an alpha channel, then it should specify JCS_EXT_RGBA,
98JCS_EXT_BGRA, JCS_EXT_ABGR, or JCS_EXT_ARGB.  When these colorspace constants
99are used, the X byte is guaranteed to be 0xFF, which is interpreted as opaque.
100
101Your application can check for the existence of the alpha channel colorspace
102extensions at compile time with:
103
104  #ifdef JCS_ALPHA_EXTENSIONS
105
106jcstest.c, located in the libjpeg-turbo source tree, demonstrates how to check
107for the existence of the colorspace extensions at compile time and run time.
108
109===================================
110libjpeg v7 and v8 API/ABI Emulation
111===================================
112
113With libjpeg v7 and v8, new features were added that necessitated extending the
114compression and decompression structures.  Unfortunately, due to the exposed
115nature of those structures, extending them also necessitated breaking backward
116ABI compatibility with previous libjpeg releases.  Thus, programs that were
117built to use libjpeg v7 or v8 did not work with libjpeg-turbo, since it is
118based on the libjpeg v6b code base.  Although libjpeg v7 and v8 are not
119as widely used as v6b, enough programs (including a few Linux distros) made
120the switch that there was a demand to emulate the libjpeg v7 and v8 ABIs
121in libjpeg-turbo.  It should be noted, however, that this feature was added
122primarily so that applications that had already been compiled to use libjpeg
123v7+ could take advantage of accelerated baseline JPEG encoding/decoding
124without recompiling.  libjpeg-turbo does not claim to support all of the
125libjpeg v7+ features, nor to produce identical output to libjpeg v7+ in all
126cases (see below.)
127
128By passing an argument of --with-jpeg7 or --with-jpeg8 to configure, or an
129argument of -DWITH_JPEG7=1 or -DWITH_JPEG8=1 to cmake, you can build a version
130of libjpeg-turbo that emulates the libjpeg v7 or v8 ABI, so that programs
131that are built against libjpeg v7 or v8 can be run with libjpeg-turbo.  The
132following section describes which libjpeg v7+ features are supported and which
133aren't.
134
135Support for libjpeg v7 and v8 Features:
136---------------------------------------
137
138Fully supported:
139
140-- libjpeg: IDCT scaling extensions in decompressor
141   libjpeg-turbo supports IDCT scaling with scaling factors of 1/8, 1/4, 3/8,
142   1/2, 5/8, 3/4, 7/8, 9/8, 5/4, 11/8, 3/2, 13/8, 7/4, 15/8, and 2/1 (only 1/4
143   and 1/2 are SIMD-accelerated.)
144
145-- libjpeg: arithmetic coding
146
147-- libjpeg: In-memory source and destination managers
148   See notes below.
149
150-- cjpeg: Separate quality settings for luminance and chrominance
151   Note that the libpjeg v7+ API was extended to accommodate this feature only
152   for convenience purposes.  It has always been possible to implement this
153   feature with libjpeg v6b (see rdswitch.c for an example.)
154
155-- cjpeg: 32-bit BMP support
156
157-- cjpeg: -rgb option
158
159-- jpegtran: lossless cropping
160
161-- jpegtran: -perfect option
162
163-- jpegtran: forcing width/height when performing lossless crop
164
165-- rdjpgcom: -raw option
166
167-- rdjpgcom: locale awareness
168
169
170Not supported:
171
172NOTE:  As of this writing, extensive research has been conducted into the
173usefulness of DCT scaling as a means of data reduction and SmartScale as a
174means of quality improvement.  The reader is invited to peruse the research at
175http://www.libjpeg-turbo.org/About/SmartScale and draw his/her own conclusions,
176but it is the general belief of our project that these features have not
177demonstrated sufficient usefulness to justify inclusion in libjpeg-turbo.
178
179-- libjpeg: DCT scaling in compressor
180   cinfo.scale_num and cinfo.scale_denom are silently ignored.
181   There is no technical reason why DCT scaling could not be supported when
182   emulating the libjpeg v7+ API/ABI, but without the SmartScale extension (see
183   below), only scaling factors of 1/2, 8/15, 4/7, 8/13, 2/3, 8/11, 4/5, and
184   8/9 would be available, which is of limited usefulness.
185
186-- libjpeg: SmartScale
187   cinfo.block_size is silently ignored.
188   SmartScale is an extension to the JPEG format that allows for DCT block
189   sizes other than 8x8.  Providing support for this new format would be
190   feasible (particularly without full acceleration.)  However, until/unless
191   the format becomes either an official industry standard or, at minimum, an
192   accepted solution in the community, we are hesitant to implement it, as
193   there is no sense of whether or how it might change in the future.  It is
194   our belief that SmartScale has not demonstrated sufficient usefulness as a
195   lossless format nor as a means of quality enhancement, and thus, our primary
196   interest in providing this feature would be as a means of supporting
197   additional DCT scaling factors.
198
199-- libjpeg: Fancy downsampling in compressor
200   cinfo.do_fancy_downsampling is silently ignored.
201   This requires the DCT scaling feature, which is not supported.
202
203-- jpegtran: Scaling
204   This requires both the DCT scaling and SmartScale features, which are not
205   supported.
206
207-- Lossless RGB JPEG files
208   This requires the SmartScale feature, which is not supported.
209
210What About libjpeg v9?
211----------------------
212
213libjpeg v9 introduced yet another field to the JPEG compression structure
214(color_transform), thus making the ABI backward incompatible with that of
215libjpeg v8.  This new field was introduced solely for the purpose of supporting
216lossless SmartScale encoding.  Further, there was actually no reason to extend
217the API in this manner, as the color transform could have just as easily been
218activated by way of a new JPEG colorspace constant, thus preserving backward
219ABI compatibility.
220
221Our research (see link above) has shown that lossless SmartScale does not
222generally accomplish anything that can't already be accomplished better with
223existing, standard lossless formats.  Thus, at this time, it is our belief that
224there is not sufficient technical justification for software to upgrade from
225libjpeg v8 to libjpeg v9, and therefore, not sufficient technical justification
226for us to emulate the libjpeg v9 ABI.
227
228=====================================
229In-Memory Source/Destination Managers
230=====================================
231
232By default, libjpeg-turbo 1.3 and later includes the jpeg_mem_src() and
233jpeg_mem_dest() functions, even when not emulating the libjpeg v8 API/ABI.
234Previously, it was necessary to build libjpeg-turbo from source with libjpeg v8
235API/ABI emulation in order to use the in-memory source/destination managers,
236but several projects requested that those functions be included when emulating
237the libjpeg v6b API/ABI as well.  This allows the use of those functions by
238programs that need them without breaking ABI compatibility for programs that
239don't, and it allows those functions to be provided in the "official"
240libjpeg-turbo binaries.
241
242Those who are concerned about maintaining strict conformance with the libjpeg
243v6b or v7 API can pass an argument of --without-mem-srcdst to configure or
244an argument of -DWITH_MEM_SRCDST=0 to CMake prior to building libjpeg-turbo.
245This will restore the pre-1.3 behavior, in which jpeg_mem_src() and
246jpeg_mem_dest() are only included when emulating the libjpeg v8 API/ABI.
247
248On Un*x systems, including the in-memory source/destination managers changes
249the dynamic library version from 62.0.0 to 62.1.0 if using libjpeg v6b API/ABI
250emulation and from 7.0.0 to 7.1.0 if using libjpeg v7 API/ABI emulation.
251
252Note that, on most Un*x systems, the dynamic linker will not look for a
253function in a library until that function is actually used.  Thus, if a program
254is built against libjpeg-turbo 1.3+ and uses jpeg_mem_src() or jpeg_mem_dest(),
255that program will not fail if run against an older version of libjpeg-turbo or
256against libjpeg v7- until the program actually tries to call jpeg_mem_src() or
257jpeg_mem_dest().  Such is not the case on Windows.  If a program is built
258against the libjpeg-turbo 1.3+ DLL and uses jpeg_mem_src() or jpeg_mem_dest(),
259then it must use the libjpeg-turbo 1.3+ DLL at run time.
260
261Both cjpeg and djpeg have been extended to allow testing the in-memory
262source/destination manager functions.  See their respective man pages for more
263details.
264
265
266*******************************************************************************
267**     Mathematical Compatibility
268*******************************************************************************
269
270For the most part, libjpeg-turbo should produce identical output to libjpeg
271v6b.  The one exception to this is when using the floating point DCT/IDCT, in
272which case the outputs of libjpeg v6b and libjpeg-turbo can differ for the
273following reasons:
274
275-- The SSE/SSE2 floating point DCT implementation in libjpeg-turbo is ever so
276   slightly more accurate than the implementation in libjpeg v6b, but not by
277   any amount perceptible to human vision (generally in the range of 0.01 to
278   0.08 dB gain in PNSR.)
279-- When not using the SIMD extensions, libjpeg-turbo uses the more accurate
280   (and slightly faster) floating point IDCT algorithm introduced in libjpeg
281   v8a as opposed to the algorithm used in libjpeg v6b.  It should be noted,
282   however, that this algorithm basically brings the accuracy of the floating
283   point IDCT in line with the accuracy of the slow integer IDCT.  The floating
284   point DCT/IDCT algorithms are mainly a legacy feature, and they do not
285   produce significantly more accuracy than the slow integer algorithms (to put
286   numbers on this, the typical difference in PNSR between the two algorithms
287   is less than 0.10 dB, whereas changing the quality level by 1 in the upper
288   range of the quality scale is typically more like a 1.0 dB difference.)
289-- If the floating point algorithms in libjpeg-turbo are not implemented using
290   SIMD instructions on a particular platform, then the accuracy of the
291   floating point DCT/IDCT can depend on the compiler settings.
292
293While libjpeg-turbo does emulate the libjpeg v8 API/ABI, under the hood, it is
294still using the same algorithms as libjpeg v6b, so there are several specific
295cases in which libjpeg-turbo cannot be expected to produce the same output as
296libjpeg v8:
297
298-- When decompressing using scaling factors of 1/2 and 1/4, because libjpeg v8
299   implements those scaling algorithms differently than libjpeg v6b does, and
300   libjpeg-turbo's SIMD extensions are based on the libjpeg v6b behavior.
301
302-- When using chrominance subsampling, because libjpeg v8 implements this
303   with its DCT/IDCT scaling algorithms rather than with a separate
304   downsampling/upsampling algorithm.  In our testing, the subsampled/upsampled
305   output of libjpeg v8 is less accurate than that of libjpeg v6b for this
306   reason.
307
308-- When decompressing using a scaling factor > 1 and merged (AKA "non-fancy" or
309   "non-smooth") chrominance upsampling, because libjpeg v8 does not support
310   merged upsampling with scaling factors > 1.
311
312
313*******************************************************************************
314**     Performance Pitfalls
315*******************************************************************************
316
317===============
318Restart Markers
319===============
320
321The optimized Huffman decoder in libjpeg-turbo does not handle restart markers
322in a way that makes the rest of the libjpeg infrastructure happy, so it is
323necessary to use the slow Huffman decoder when decompressing a JPEG image that
324has restart markers.  This can cause the decompression performance to drop by
325as much as 20%, but the performance will still be much greater than that of
326libjpeg.  Many consumer packages, such as PhotoShop, use restart markers when
327generating JPEG images, so images generated by those programs will experience
328this issue.
329
330===============================================
331Fast Integer Forward DCT at High Quality Levels
332===============================================
333
334The algorithm used by the SIMD-accelerated quantization function cannot produce
335correct results whenever the fast integer forward DCT is used along with a JPEG
336quality of 98-100.  Thus, libjpeg-turbo must use the non-SIMD quantization
337function in those cases.  This causes performance to drop by as much as 40%.
338It is therefore strongly advised that you use the slow integer forward DCT
339whenever encoding images with a JPEG quality of 98 or higher.
340

README.android

1Any Android specific modifications to upstream libjpeg-turbo (1.5.1) should
2be listed here:
3
4(1) jconfig.h and jconfigint.h
5
6These are included upstream as jconfig.h.in and jconfigint.h.in.
7We have the option autogenerate these platform/version specific files (using
8the libjpeg-turbo build system) or to manually create them.
9
10Autogenerating these files on linux gets us most of the way, but we've needed
11to add some multi-platform flexibility to the INLINE and SIZEOF_SIZE_T macros.
12
13(2) simd/jsimdext.inc
14
15The modification enables us to compile x86 SIMD.
16
17The original code was:
18%define EXTN(name)   _ %+ name
19The new code is:
20%define EXTN(name)   name
21
22It is unclear why the unmodified code from upstream appends an underscore
23to name.  Before removing the underscore, the code failed to link because
24the function names in the SIMD code did not match the callers (because of
25the extra underscore).
26
27(3) jmemmgr.c
28
29Fix broken build with NDK platforms < android-21
30Cherry picked from upstream:
31https://github.com/libjpeg-turbo/libjpeg-turbo/commit/dfefba77520ded5c5fd4864e76352a5f3eb23e74
32
33(4) rdppm.c
34Fix sign mismatch comparison warnings
35Cherry picked from upstream:
36https://github.com/libjpeg-turbo/libjpeg-turbo/commit/d22fd541bf9dd87889c25909e19a640a580bcad7
37

README.ijg

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

README.md

1Background
2==========
3
4libjpeg-turbo is a JPEG image codec that uses SIMD instructions (MMX, SSE2,
5NEON, AltiVec) to accelerate baseline JPEG compression and decompression on
6x86, x86-64, ARM, and PowerPC systems.  On such systems, libjpeg-turbo is
7generally 2-6x as fast as libjpeg, all else being equal.  On other types of
8systems, libjpeg-turbo can still outperform libjpeg by a significant amount, by
9virtue of its highly-optimized Huffman coding routines.  In many cases, the
10performance of libjpeg-turbo rivals that of proprietary high-speed JPEG codecs.
11
12libjpeg-turbo implements both the traditional libjpeg API as well as the less
13powerful but more straightforward TurboJPEG API.  libjpeg-turbo also features
14colorspace extensions that allow it to compress from/decompress to 32-bit and
15big-endian pixel buffers (RGBX, XBGR, etc.), as well as a full-featured Java
16interface.
17
18libjpeg-turbo was originally based on libjpeg/SIMD, an MMX-accelerated
19derivative of libjpeg v6b developed by Miyasaka Masaru.  The TigerVNC and
20VirtualGL projects made numerous enhancements to the codec in 2009, and in
21early 2010, libjpeg-turbo spun off into an independent project, with the goal
22of making high-speed JPEG compression/decompression technology available to a
23broader range of users and developers.
24
25
26License
27=======
28
29libjpeg-turbo is covered by three compatible BSD-style open source licenses.
30Refer to [LICENSE.md](LICENSE.md) for a roll-up of license terms.
31
32
33Building libjpeg-turbo
34======================
35
36Refer to [BUILDING.md](BUILDING.md) for complete instructions.
37
38
39Using libjpeg-turbo
40===================
41
42libjpeg-turbo includes two APIs that can be used to compress and decompress
43JPEG images:
44
45- **TurboJPEG API**<br>
46  This API provides an easy-to-use interface for compressing and decompressing
47  JPEG images in memory.  It also provides some functionality that would not be
48  straightforward to achieve using the underlying libjpeg API, such as
49  generating planar YUV images and performing multiple simultaneous lossless
50  transforms on an image.  The Java interface for libjpeg-turbo is written on
51  top of the TurboJPEG API.
52
53- **libjpeg API**<br>
54  This is the de facto industry-standard API for compressing and decompressing
55  JPEG images.  It is more difficult to use than the TurboJPEG API but also
56  more powerful.  The libjpeg API implementation in libjpeg-turbo is both
57  API/ABI-compatible and mathematically compatible with libjpeg v6b.  It can
58  also optionally be configured to be API/ABI-compatible with libjpeg v7 and v8
59  (see below.)
60
61There is no significant performance advantage to either API when both are used
62to perform similar operations.
63
64Colorspace Extensions
65---------------------
66
67libjpeg-turbo includes extensions that allow JPEG images to be compressed
68directly from (and decompressed directly to) buffers that use BGR, BGRX,
69RGBX, XBGR, and XRGB pixel ordering.  This is implemented with ten new
70colorspace constants:
71
72    JCS_EXT_RGB   /* red/green/blue */
73    JCS_EXT_RGBX  /* red/green/blue/x */
74    JCS_EXT_BGR   /* blue/green/red */
75    JCS_EXT_BGRX  /* blue/green/red/x */
76    JCS_EXT_XBGR  /* x/blue/green/red */
77    JCS_EXT_XRGB  /* x/red/green/blue */
78    JCS_EXT_RGBA  /* red/green/blue/alpha */
79    JCS_EXT_BGRA  /* blue/green/red/alpha */
80    JCS_EXT_ABGR  /* alpha/blue/green/red */
81    JCS_EXT_ARGB  /* alpha/red/green/blue */
82
83Setting `cinfo.in_color_space` (compression) or `cinfo.out_color_space`
84(decompression) to one of these values will cause libjpeg-turbo to read the
85red, green, and blue values from (or write them to) the appropriate position in
86the pixel when compressing from/decompressing to an RGB buffer.
87
88Your application can check for the existence of these extensions at compile
89time with:
90
91    #ifdef JCS_EXTENSIONS
92
93At run time, attempting to use these extensions with a libjpeg implementation
94that does not support them will result in a "Bogus input colorspace" error.
95Applications can trap this error in order to test whether run-time support is
96available for the colorspace extensions.
97
98When using the RGBX, BGRX, XBGR, and XRGB colorspaces during decompression, the
99X byte is undefined, and in order to ensure the best performance, libjpeg-turbo
100can set that byte to whatever value it wishes.  If an application expects the X
101byte to be used as an alpha channel, then it should specify `JCS_EXT_RGBA`,
102`JCS_EXT_BGRA`, `JCS_EXT_ABGR`, or `JCS_EXT_ARGB`.  When these colorspace
103constants are used, the X byte is guaranteed to be 0xFF, which is interpreted
104as opaque.
105
106Your application can check for the existence of the alpha channel colorspace
107extensions at compile time with:
108
109    #ifdef JCS_ALPHA_EXTENSIONS
110
111[jcstest.c](jcstest.c), located in the libjpeg-turbo source tree, demonstrates
112how to check for the existence of the colorspace extensions at compile time and
113run time.
114
115libjpeg v7 and v8 API/ABI Emulation
116-----------------------------------
117
118With libjpeg v7 and v8, new features were added that necessitated extending the
119compression and decompression structures.  Unfortunately, due to the exposed
120nature of those structures, extending them also necessitated breaking backward
121ABI compatibility with previous libjpeg releases.  Thus, programs that were
122built to use libjpeg v7 or v8 did not work with libjpeg-turbo, since it is
123based on the libjpeg v6b code base.  Although libjpeg v7 and v8 are not
124as widely used as v6b, enough programs (including a few Linux distros) made
125the switch that there was a demand to emulate the libjpeg v7 and v8 ABIs
126in libjpeg-turbo.  It should be noted, however, that this feature was added
127primarily so that applications that had already been compiled to use libjpeg
128v7+ could take advantage of accelerated baseline JPEG encoding/decoding
129without recompiling.  libjpeg-turbo does not claim to support all of the
130libjpeg v7+ features, nor to produce identical output to libjpeg v7+ in all
131cases (see below.)
132
133By passing an argument of `--with-jpeg7` or `--with-jpeg8` to `configure`, or
134an argument of `-DWITH_JPEG7=1` or `-DWITH_JPEG8=1` to `cmake`, you can build a
135version of libjpeg-turbo that emulates the libjpeg v7 or v8 ABI, so that
136programs that are built against libjpeg v7 or v8 can be run with libjpeg-turbo.
137The following section describes which libjpeg v7+ features are supported and
138which aren't.
139
140### Support for libjpeg v7 and v8 Features
141
142#### Fully supported
143
144- **libjpeg: IDCT scaling extensions in decompressor**<br>
145  libjpeg-turbo supports IDCT scaling with scaling factors of 1/8, 1/4, 3/8,
146  1/2, 5/8, 3/4, 7/8, 9/8, 5/4, 11/8, 3/2, 13/8, 7/4, 15/8, and 2/1 (only 1/4
147  and 1/2 are SIMD-accelerated.)
148
149- **libjpeg: Arithmetic coding**
150
151- **libjpeg: In-memory source and destination managers**<br>
152  See notes below.
153
154- **cjpeg: Separate quality settings for luminance and chrominance**<br>
155  Note that the libpjeg v7+ API was extended to accommodate this feature only
156  for convenience purposes.  It has always been possible to implement this
157  feature with libjpeg v6b (see rdswitch.c for an example.)
158
159- **cjpeg: 32-bit BMP support**
160
161- **cjpeg: `-rgb` option**
162
163- **jpegtran: Lossless cropping**
164
165- **jpegtran: `-perfect` option**
166
167- **jpegtran: Forcing width/height when performing lossless crop**
168
169- **rdjpgcom: `-raw` option**
170
171- **rdjpgcom: Locale awareness**
172
173
174#### Not supported
175
176NOTE:  As of this writing, extensive research has been conducted into the
177usefulness of DCT scaling as a means of data reduction and SmartScale as a
178means of quality improvement.  The reader is invited to peruse the research at
179<http://www.libjpeg-turbo.org/About/SmartScale> and draw his/her own conclusions,
180but it is the general belief of our project that these features have not
181demonstrated sufficient usefulness to justify inclusion in libjpeg-turbo.
182
183- **libjpeg: DCT scaling in compressor**<br>
184  `cinfo.scale_num` and `cinfo.scale_denom` are silently ignored.
185  There is no technical reason why DCT scaling could not be supported when
186  emulating the libjpeg v7+ API/ABI, but without the SmartScale extension (see
187  below), only scaling factors of 1/2, 8/15, 4/7, 8/13, 2/3, 8/11, 4/5, and
188  8/9 would be available, which is of limited usefulness.
189
190- **libjpeg: SmartScale**<br>
191  `cinfo.block_size` is silently ignored.
192  SmartScale is an extension to the JPEG format that allows for DCT block
193  sizes other than 8x8.  Providing support for this new format would be
194  feasible (particularly without full acceleration.)  However, until/unless
195  the format becomes either an official industry standard or, at minimum, an
196  accepted solution in the community, we are hesitant to implement it, as
197  there is no sense of whether or how it might change in the future.  It is
198  our belief that SmartScale has not demonstrated sufficient usefulness as a
199  lossless format nor as a means of quality enhancement, and thus our primary
200  interest in providing this feature would be as a means of supporting
201  additional DCT scaling factors.
202
203- **libjpeg: Fancy downsampling in compressor**<br>
204  `cinfo.do_fancy_downsampling` is silently ignored.
205  This requires the DCT scaling feature, which is not supported.
206
207- **jpegtran: Scaling**<br>
208  This requires both the DCT scaling and SmartScale features, which are not
209  supported.
210
211- **Lossless RGB JPEG files**<br>
212  This requires the SmartScale feature, which is not supported.
213
214### What About libjpeg v9?
215
216libjpeg v9 introduced yet another field to the JPEG compression structure
217(`color_transform`), thus making the ABI backward incompatible with that of
218libjpeg v8.  This new field was introduced solely for the purpose of supporting
219lossless SmartScale encoding.  Furthermore, there was actually no reason to
220extend the API in this manner, as the color transform could have just as easily
221been activated by way of a new JPEG colorspace constant, thus preserving
222backward ABI compatibility.
223
224Our research (see link above) has shown that lossless SmartScale does not
225generally accomplish anything that can't already be accomplished better with
226existing, standard lossless formats.  Therefore, at this time it is our belief
227that there is not sufficient technical justification for software projects to
228upgrade from libjpeg v8 to libjpeg v9, and thus there is not sufficient
229technical justification for us to emulate the libjpeg v9 ABI.
230
231In-Memory Source/Destination Managers
232-------------------------------------
233
234By default, libjpeg-turbo 1.3 and later includes the `jpeg_mem_src()` and
235`jpeg_mem_dest()` functions, even when not emulating the libjpeg v8 API/ABI.
236Previously, it was necessary to build libjpeg-turbo from source with libjpeg v8
237API/ABI emulation in order to use the in-memory source/destination managers,
238but several projects requested that those functions be included when emulating
239the libjpeg v6b API/ABI as well.  This allows the use of those functions by
240programs that need them, without breaking ABI compatibility for programs that
241don't, and it allows those functions to be provided in the "official"
242libjpeg-turbo binaries.
243
244Those who are concerned about maintaining strict conformance with the libjpeg
245v6b or v7 API can pass an argument of `--without-mem-srcdst` to `configure` or
246an argument of `-DWITH_MEM_SRCDST=0` to `cmake` prior to building
247libjpeg-turbo.  This will restore the pre-1.3 behavior, in which
248`jpeg_mem_src()` and `jpeg_mem_dest()` are only included when emulating the
249libjpeg v8 API/ABI.
250
251On Un*x systems, including the in-memory source/destination managers changes
252the dynamic library version from 62.1.0 to 62.2.0 if using libjpeg v6b API/ABI
253emulation and from 7.1.0 to 7.2.0 if using libjpeg v7 API/ABI emulation.
254
255Note that, on most Un*x systems, the dynamic linker will not look for a
256function in a library until that function is actually used.  Thus, if a program
257is built against libjpeg-turbo 1.3+ and uses `jpeg_mem_src()` or
258`jpeg_mem_dest()`, that program will not fail if run against an older version
259of libjpeg-turbo or against libjpeg v7- until the program actually tries to
260call `jpeg_mem_src()` or `jpeg_mem_dest()`.  Such is not the case on Windows.
261If a program is built against the libjpeg-turbo 1.3+ DLL and uses
262`jpeg_mem_src()` or `jpeg_mem_dest()`, then it must use the libjpeg-turbo 1.3+
263DLL at run time.
264
265Both cjpeg and djpeg have been extended to allow testing the in-memory
266source/destination manager functions.  See their respective man pages for more
267details.
268
269
270Mathematical Compatibility
271==========================
272
273For the most part, libjpeg-turbo should produce identical output to libjpeg
274v6b.  The one exception to this is when using the floating point DCT/IDCT, in
275which case the outputs of libjpeg v6b and libjpeg-turbo can differ for the
276following reasons:
277
278- The SSE/SSE2 floating point DCT implementation in libjpeg-turbo is ever so
279  slightly more accurate than the implementation in libjpeg v6b, but not by
280  any amount perceptible to human vision (generally in the range of 0.01 to
281  0.08 dB gain in PNSR.)
282
283- When not using the SIMD extensions, libjpeg-turbo uses the more accurate
284  (and slightly faster) floating point IDCT algorithm introduced in libjpeg
285  v8a as opposed to the algorithm used in libjpeg v6b.  It should be noted,
286  however, that this algorithm basically brings the accuracy of the floating
287  point IDCT in line with the accuracy of the slow integer IDCT.  The floating
288  point DCT/IDCT algorithms are mainly a legacy feature, and they do not
289  produce significantly more accuracy than the slow integer algorithms (to put
290  numbers on this, the typical difference in PNSR between the two algorithms
291  is less than 0.10 dB, whereas changing the quality level by 1 in the upper
292  range of the quality scale is typically more like a 1.0 dB difference.)
293
294- If the floating point algorithms in libjpeg-turbo are not implemented using
295  SIMD instructions on a particular platform, then the accuracy of the
296  floating point DCT/IDCT can depend on the compiler settings.
297
298While libjpeg-turbo does emulate the libjpeg v8 API/ABI, under the hood it is
299still using the same algorithms as libjpeg v6b, so there are several specific
300cases in which libjpeg-turbo cannot be expected to produce the same output as
301libjpeg v8:
302
303- When decompressing using scaling factors of 1/2 and 1/4, because libjpeg v8
304  implements those scaling algorithms differently than libjpeg v6b does, and
305  libjpeg-turbo's SIMD extensions are based on the libjpeg v6b behavior.
306
307- When using chrominance subsampling, because libjpeg v8 implements this
308  with its DCT/IDCT scaling algorithms rather than with a separate
309  downsampling/upsampling algorithm.  In our testing, the subsampled/upsampled
310  output of libjpeg v8 is less accurate than that of libjpeg v6b for this
311  reason.
312
313- When decompressing using a scaling factor > 1 and merged (AKA "non-fancy" or
314  "non-smooth") chrominance upsampling, because libjpeg v8 does not support
315  merged upsampling with scaling factors > 1.
316
317
318Performance Pitfalls
319====================
320
321Restart Markers
322---------------
323
324The optimized Huffman decoder in libjpeg-turbo does not handle restart markers
325in a way that makes the rest of the libjpeg infrastructure happy, so it is
326necessary to use the slow Huffman decoder when decompressing a JPEG image that
327has restart markers.  This can cause the decompression performance to drop by
328as much as 20%, but the performance will still be much greater than that of
329libjpeg.  Many consumer packages, such as PhotoShop, use restart markers when
330generating JPEG images, so images generated by those programs will experience
331this issue.
332
333Fast Integer Forward DCT at High Quality Levels
334-----------------------------------------------
335
336The algorithm used by the SIMD-accelerated quantization function cannot produce
337correct results whenever the fast integer forward DCT is used along with a JPEG
338quality of 98-100.  Thus, libjpeg-turbo must use the non-SIMD quantization
339function in those cases.  This causes performance to drop by as much as 40%.
340It is therefore strongly advised that you use the slow integer forward DCT
341whenever encoding images with a JPEG quality of 98 or higher.
342

README.version