• Home
Name Date Size #Lines LOC

..--

ci/03-May-2024-

cmakescripts/03-May-2024-662583

doc/html/03-May-2024-7,4536,651

java/03-May-2024-16,09912,439

md5/03-May-2024-531297

release/03-May-2024-1,2351,086

sharedlib/03-May-2024-10087

simd/03-May-2024-66,76255,341

testimages/03-May-2024-7254

win/03-May-2024-583571

.gitattributesD03-May-2024103 54

.travis.ymlD03-May-20247.1 KiB145137

Android.bpD03-May-20247.5 KiB278265

BUILDING.mdD03-May-202428.4 KiB824574

BrewfileD03-May-202474 54

CMakeLists.txtD03-May-202455.4 KiB1,4111,245

ChangeLog.mdD03-May-202469 KiB1,4141,099

LICENSE.mdD03-May-20245.1 KiB13396

METADATAD03-May-2024265 1514

MODULE_LICENSE_BSDD03-May-20240

NOTICED03-May-20245.1 KiB13396

OWNERSD03-May-202419 21

README.androidD03-May-2024966 2516

README.ijgD03-May-202413.4 KiB278220

README.mdD03-May-202416.2 KiB347271

appveyor.ymlD03-May-20241.8 KiB5834

cderror.hD03-May-20245.4 KiB13898

cdjpeg.cD03-May-20243.9 KiB14694

cdjpeg.hD03-May-20245.6 KiB15879

change.logD03-May-202412.1 KiB316219

cjpeg.1D03-May-202413.3 KiB355354

cjpeg.cD03-May-202422.9 KiB696461

cmyk.hD03-May-20241.6 KiB6236

coderules.txtD03-May-20243.4 KiB7960

djpeg.1D03-May-20249.7 KiB297296

djpeg.cD03-May-202427.1 KiB821564

doxygen-extra.cssD03-May-202426 43

doxygen.configD03-May-2024401 1716

example.txtD03-May-202417.7 KiB448372

jaricom.cD03-May-20245 KiB158121

jcapimin.cD03-May-20249.5 KiB296142

jcapistd.cD03-May-20245.8 KiB16368

jcarith.cD03-May-202429 KiB933606

jccoefct.cD03-May-202416.9 KiB450279

jccolext.cD03-May-20244.5 KiB14584

jccolor.cD03-May-202423.2 KiB711535

jcdctmgr.cD03-May-202422 KiB722461

jchuff.cD03-May-202433.6 KiB1,093650

jchuff.hD03-May-20241.5 KiB4313

jcicc.cD03-May-20244 KiB10650

jcinit.cD03-May-20242.4 KiB7836

jcmainct.cD03-May-20245.1 KiB16383

jcmarker.cD03-May-202417.1 KiB665393

jcmaster.cD03-May-202421.4 KiB641418

jcomapi.cD03-May-20243.2 KiB11045

jconfig.hD03-May-20242.1 KiB7416

jconfig.h.inD03-May-20242.2 KiB7453

jconfig.txtD03-May-20244.8 KiB144115

jconfigint.hD03-May-20241.5 KiB5933

jconfigint.h.inD03-May-2024796 3223

jcparam.cD03-May-202417.8 KiB542323

jcphuff.cD03-May-202432.5 KiB1,106725

jcprepct.cD03-May-202412.7 KiB352208

jcsample.cD03-May-202419.7 KiB540313

jcstest.cD03-May-20243.8 KiB12777

jctrans.cD03-May-202414.6 KiB401226

jdapimin.cD03-May-202412.9 KiB408228

jdapistd.cD03-May-202423.1 KiB640354

jdarith.cD03-May-202424.6 KiB774489

jdatadst-tj.cD03-May-20246.6 KiB20291

jdatadst.cD03-May-20249.5 KiB294145

jdatasrc-tj.cD03-May-20246.7 KiB19258

jdatasrc.cD03-May-202410 KiB296122

jdcoefct.cD03-May-202424.8 KiB693485

jdcoefct.hD03-May-20242.6 KiB8336

jdcol565.cD03-May-202412 KiB385333

jdcolext.cD03-May-20244.4 KiB14488

jdcolor.cD03-May-202428.1 KiB884652

jdct.hD03-May-20249.5 KiB209101

jddctmgr.cD03-May-202411.1 KiB353247

jdhuff.cD03-May-202425.5 KiB828477

jdhuff.hD03-May-20249.3 KiB239107

jdicc.cD03-May-20245.6 KiB172106

jdinput.cD03-May-202414.2 KiB409228

jdmainct.cD03-May-202419.3 KiB461226

jdmainct.hD03-May-20242.4 KiB7240

jdmarker.cD03-May-202441.7 KiB1,378865

jdmaster.cD03-May-202427.3 KiB738477

jdmaster.hD03-May-2024788 298

jdmerge.cD03-May-202420.6 KiB620430

jdmrg565.cD03-May-202411.1 KiB355279

jdmrgext.cD03-May-20245.8 KiB185145

jdphuff.cD03-May-202421.8 KiB688401

jdpostct.cD03-May-202410.7 KiB295182

jdsample.cD03-May-202417.6 KiB515317

jdsample.hD03-May-20241.7 KiB5117

jdtrans.cD03-May-20245.3 KiB15678

jerror.cD03-May-20247.7 KiB252108

jerror.hD03-May-202414.8 KiB317265

jfdctflt.cD03-May-20245.5 KiB17086

jfdctfst.cD03-May-20247.6 KiB228104

jfdctint.cD03-May-202411.2 KiB289148

jidctflt.cD03-May-20248.5 KiB241124

jidctfst.cD03-May-202413.2 KiB372197

jidctint.cD03-May-2024103.7 KiB2,6281,848

jidctred.cD03-May-202414.2 KiB410245

jinclude.hD03-May-20242.9 KiB8929

jmemmgr.cD03-May-202443.7 KiB1,180687

jmemnobs.cD03-May-20242.8 KiB11656

jmemsys.hD03-May-20247.6 KiB17953

jmorecfg.hD03-May-202414.8 KiB422162

jpeg_nbits_table.hD03-May-2024264.1 KiB4,0994,098

jpegcomp.hD03-May-20241.1 KiB3219

jpegint.hD03-May-202415.2 KiB369232

jpeglib.hD03-May-202449.1 KiB1,133533

jpegtran.1D03-May-20249.6 KiB296294

jpegtran.cD03-May-202419.9 KiB602414

jquant1.cD03-May-202431.7 KiB860488

jquant2.cD03-May-202447.8 KiB1,286747

jsimd.hD03-May-20245.4 KiB11885

jsimd_none.cD03-May-20247.6 KiB419340

jsimddct.hD03-May-20243 KiB7150

jstdhuff.cD03-May-20245.2 KiB144103

jutils.cD03-May-20243.7 KiB13465

jversion.hD03-May-20241.6 KiB5321

libjpeg.map.inD03-May-2024164 1210

libjpeg.txtD03-May-2024165.9 KiB3,1452,620

rdbmp.cD03-May-202422.4 KiB690506

rdcolmap.cD03-May-20246.9 KiB255143

rdgif.cD03-May-20241.3 KiB4010

rdjpgcom.1D03-May-20241.7 KiB6463

rdjpgcom.cD03-May-202414.7 KiB512318

rdppm.cD03-May-202424 KiB767572

rdrle.cD03-May-202411.4 KiB390235

rdswitch.cD03-May-202412.7 KiB425304

rdtarga.cD03-May-202415.1 KiB510324

structure.txtD03-May-202448.6 KiB905739

tjbench.cD03-May-202438.5 KiB1,031895

tjbenchtest.inD03-May-202411.7 KiB257211

tjbenchtest.java.inD03-May-202410.1 KiB216170

tjexample.cD03-May-202414.8 KiB396290

tjexampletest.inD03-May-20248 KiB150126

tjexampletest.java.inD03-May-20248.2 KiB152128

tjunittest.cD03-May-202429.4 KiB930777

tjutil.cD03-May-20242.2 KiB6929

tjutil.hD03-May-20241.9 KiB4816

transupp.cD03-May-202461.2 KiB1,6291,179

transupp.hD03-May-20249.8 KiB21173

turbojpeg-jni.cD03-May-202445.7 KiB1,188942

turbojpeg-mapfileD03-May-2024989 6661

turbojpeg-mapfile.jniD03-May-20243.1 KiB10296

turbojpeg.cD03-May-202471.8 KiB2,1491,716

turbojpeg.hD03-May-202472.2 KiB1,745241

usage.txtD03-May-202434.2 KiB636520

wizard.txtD03-May-202410.2 KiB213175

wrbmp.cD03-May-202417.8 KiB559371

wrgif.cD03-May-202413.1 KiB414211

wrjpgcom.1D03-May-20242.6 KiB104103

wrjpgcom.cD03-May-202417.5 KiB592396

wrppm.cD03-May-202410.8 KiB366228

wrrle.cD03-May-20249.2 KiB310175

wrtarga.cD03-May-20247.5 KiB262158

README.android

1Any Android specific modifications to upstream libjpeg-turbo (the version
2specified in METADATA) should be 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/arm64/jsimd_neon.S
14
15To support execute-only memory layouts, constants in handwritten assembly have
16been moved into a dedicated rodata section.
17
18There's a pull request upstream for this as well. If that's accepted, this
19can be removed as an Android-specific modification.
20https://github.com/libjpeg-turbo/libjpeg-turbo/pull/318
21
22(3) Cherry-pick of 2a9e3b and 15902850 from upstream
23
24These fix a bug in TurboJPEG's handling of gigapixel images.
25

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.txt       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 IJG distribution formerly included code to read and write GIF files.
163To avoid entanglement with the Unisys LZW patent (now expired), GIF reading
164support has been removed altogether, and the GIF writer has been simplified
165to produce "uncompressed GIFs".  This technique does not use the LZW
166algorithm; the resulting GIF files are larger than usual, but are readable
167by all standard GIF decoders.
168
169We are required to state that
170    "The Graphics Interchange Format(c) is the Copyright property of
171    CompuServe Incorporated.  GIF(sm) is a Service Mark property of
172    CompuServe Incorporated."
173
174
175REFERENCES
176==========
177
178We recommend reading one or more of these references before trying to
179understand the innards of the JPEG software.
180
181The best short technical introduction to the JPEG compression algorithm is
182        Wallace, Gregory K.  "The JPEG Still Picture Compression Standard",
183        Communications of the ACM, April 1991 (vol. 34 no. 4), pp. 30-44.
184(Adjacent articles in that issue discuss MPEG motion picture compression,
185applications of JPEG, and related topics.)  If you don't have the CACM issue
186handy, a PDF file containing a revised version of Wallace's article is
187available at http://www.ijg.org/files/Wallace.JPEG.pdf.  The file (actually
188a preprint for an article that appeared in IEEE Trans. Consumer Electronics)
189omits the sample images that appeared in CACM, but it includes corrections
190and some added material.  Note: the Wallace article is copyright ACM and IEEE,
191and it may not be used for commercial purposes.
192
193A somewhat less technical, more leisurely introduction to JPEG can be found in
194"The Data Compression Book" by Mark Nelson and Jean-loup Gailly, published by
195M&T Books (New York), 2nd ed. 1996, ISBN 1-55851-434-1.  This book provides
196good explanations and example C code for a multitude of compression methods
197including JPEG.  It is an excellent source if you are comfortable reading C
198code but don't know much about data compression in general.  The book's JPEG
199sample code is far from industrial-strength, but when you are ready to look
200at a full implementation, you've got one here...
201
202The best currently available description of JPEG is the textbook "JPEG Still
203Image Data Compression Standard" by William B. Pennebaker and Joan L.
204Mitchell, published by Van Nostrand Reinhold, 1993, ISBN 0-442-01272-1.
205Price US$59.95, 638 pp.  The book includes the complete text of the ISO JPEG
206standards (DIS 10918-1 and draft DIS 10918-2).
207
208The original JPEG standard is divided into two parts, Part 1 being the actual
209specification, while Part 2 covers compliance testing methods.  Part 1 is
210titled "Digital Compression and Coding of Continuous-tone Still Images,
211Part 1: Requirements and guidelines" and has document numbers ISO/IEC IS
21210918-1, ITU-T T.81.  Part 2 is titled "Digital Compression and Coding of
213Continuous-tone Still Images, Part 2: Compliance testing" and has document
214numbers ISO/IEC IS 10918-2, ITU-T T.83.
215
216The JPEG standard does not specify all details of an interchangeable file
217format.  For the omitted details, we follow the "JFIF" conventions, revision
2181.02.  JFIF version 1 has been adopted as ISO/IEC 10918-5 (05/2013) and
219Recommendation ITU-T T.871 (05/2011): Information technology - Digital
220compression and coding of continuous-tone still images: JPEG File Interchange
221Format (JFIF).  It is available as a free download in PDF file format from
222https://www.iso.org/standard/54989.html and http://www.itu.int/rec/T-REC-T.871.
223A PDF file of the older JFIF 1.02 specification is available at
224http://www.w3.org/Graphics/JPEG/jfif3.pdf.
225
226The TIFF 6.0 file format specification can be obtained by FTP from
227ftp://ftp.sgi.com/graphics/tiff/TIFF6.ps.gz.  The JPEG incorporation scheme
228found in the TIFF 6.0 spec of 3-June-92 has a number of serious problems.
229IJG does not recommend use of the TIFF 6.0 design (TIFF Compression tag 6).
230Instead, we recommend the JPEG design proposed by TIFF Technical Note #2
231(Compression tag 7).  Copies of this Note can be obtained from
232http://www.ijg.org/files/.  It is expected that the next revision
233of the TIFF spec will replace the 6.0 JPEG design with the Note's design.
234Although IJG's own code does not support TIFF/JPEG, the free libtiff library
235uses our library to implement TIFF/JPEG per the Note.
236
237
238ARCHIVE LOCATIONS
239=================
240
241The "official" archive site for this software is www.ijg.org.
242The most recent released version can always be found there in
243directory "files".
244
245The JPEG FAQ (Frequently Asked Questions) article is a source of some
246general information about JPEG.
247It is available on the World Wide Web at http://www.faqs.org/faqs/jpeg-faq/
248and other news.answers archive sites, including the official news.answers
249archive at rtfm.mit.edu: ftp://rtfm.mit.edu/pub/usenet/news.answers/jpeg-faq/.
250If you don't have Web or FTP access, send e-mail to mail-server@rtfm.mit.edu
251with body
252        send usenet/news.answers/jpeg-faq/part1
253        send usenet/news.answers/jpeg-faq/part2
254
255
256FILE FORMAT COMPATIBILITY
257=========================
258
259This software implements ITU T.81 | ISO/IEC 10918 with some extensions from
260ITU T.871 | ISO/IEC 10918-5 (JPEG File Interchange Format-- see REFERENCES).
261Informally, the term "JPEG image" or "JPEG file" most often refers to JFIF or
262a subset thereof, but there are other formats containing the name "JPEG" that
263are incompatible with the DCT-based JPEG standard or with JFIF (for instance,
264JPEG 2000 and JPEG XR).  This software therefore does not support these
265formats.  Indeed, one of the original reasons for developing this free software
266was to help force convergence on a common, interoperable format standard for
267JPEG files.
268
269JFIF is a minimal or "low end" representation.  TIFF/JPEG (TIFF revision 6.0 as
270modified by TIFF Technical Note #2) can be used for "high end" applications
271that need to record a lot of additional data about an image.
272
273
274TO DO
275=====
276
277Please send bug reports, offers of help, etc. to jpeg-info@jpegclub.org.
278

README.md

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