|
Name |
|
Date |
Size |
#Lines |
LOC |
| .. | | - | - |
| .github/ | | 23-Nov-2023 | - | 146 | 110 |
| gtest/ | | 23-Nov-2023 | - | 1,956 | 1,398 |
| md5/ | | 23-Nov-2023 | - | 460 | 263 |
| simd/ | | 23-Nov-2023 | - | 49,205 | 39,756 |
| testimages/ | | 23-Nov-2023 | - | 81 | 62 |
| .gitattributes | D | 23-Nov-2023 | 126 | 6 | 5 |
| .travis.yml | D | 23-Nov-2023 | 7.4 KiB | 157 | 147 |
| Android.bp | D | 23-Nov-2023 | 10 KiB | 338 | 322 |
| BUILD.gn | D | 23-Nov-2023 | 8.6 KiB | 364 | 330 |
| BUILDING.md | D | 23-Nov-2023 | 24.6 KiB | 717 | 500 |
| ChangeLog.md | D | 23-Nov-2023 | 84.9 KiB | 1,755 | 1,363 |
| DIR_METADATA | D | 23-Nov-2023 | 52 | 4 | 3 |
| LICENSE.md | D | 23-Nov-2023 | 5.1 KiB | 133 | 96 |
| METADATA | D | 23-Nov-2023 | 333 | 16 | 15 |
| MODULE_LICENSE_BSD | D | 23-Nov-2023 | 0 | | |
| NOTICE | D | 23-Nov-2023 | 5.1 KiB | 133 | 96 |
| OWNERS | D | 23-Nov-2023 | 63 | | |
| OWNERS.android | D | 23-Nov-2023 | 149 | 5 | 4 |
| README.android | D | 23-Nov-2023 | 956 | 16 | 14 |
| README.chromium | D | 23-Nov-2023 | 3.4 KiB | 71 | 64 |
| README.ijg | D | 23-Nov-2023 | 12.4 KiB | 259 | 204 |
| README.md | D | 23-Nov-2023 | 16.6 KiB | 358 | 279 |
| TEST_MAPPING | D | 23-Nov-2023 | 74 | 8 | 7 |
| cderror.h | D | 23-Nov-2023 | 4.6 KiB | 124 | 83 |
| cdjpeg.c | D | 23-Nov-2023 | 4.3 KiB | 157 | 104 |
| cdjpeg.h | D | 23-Nov-2023 | 5.8 KiB | 162 | 81 |
| change.log | D | 23-Nov-2023 | 12.6 KiB | 337 | 231 |
| cjpeg.1 | D | 23-Nov-2023 | 13.5 KiB | 361 | 359 |
| cjpeg.c | D | 23-Nov-2023 | 24.2 KiB | 761 | 514 |
| cmyk.h | D | 23-Nov-2023 | 1.6 KiB | 62 | 36 |
| codereview.settings | D | 23-Nov-2023 | 318 | 8 | 7 |
| coderules.txt | D | 23-Nov-2023 | 3.4 KiB | 79 | 60 |
| croptest.in | D | 23-Nov-2023 | 2.5 KiB | 96 | 73 |
| djpeg.1 | D | 23-Nov-2023 | 10.6 KiB | 321 | 319 |
| djpeg.c | D | 23-Nov-2023 | 29 KiB | 872 | 609 |
| jaricom.c | D | 23-Nov-2023 | 5 KiB | 158 | 121 |
| jcapimin.c | D | 23-Nov-2023 | 9.5 KiB | 296 | 142 |
| jcapistd.c | D | 23-Nov-2023 | 5.8 KiB | 163 | 68 |
| jcarith.c | D | 23-Nov-2023 | 29 KiB | 933 | 606 |
| jccoefct.c | D | 23-Nov-2023 | 16.9 KiB | 450 | 279 |
| jccolext.c | D | 23-Nov-2023 | 4.4 KiB | 145 | 84 |
| jccolor.c | D | 23-Nov-2023 | 23 KiB | 711 | 535 |
| jcdctmgr.c | D | 23-Nov-2023 | 21.8 KiB | 721 | 460 |
| jchuff.c | D | 23-Nov-2023 | 35.7 KiB | 1,137 | 692 |
| jchuff.h | D | 23-Nov-2023 | 1.5 KiB | 43 | 13 |
| jcicc.c | D | 23-Nov-2023 | 4 KiB | 106 | 50 |
| jcinit.c | D | 23-Nov-2023 | 2.5 KiB | 81 | 37 |
| jcmainct.c | D | 23-Nov-2023 | 5.1 KiB | 163 | 83 |
| jcmarker.c | D | 23-Nov-2023 | 17.1 KiB | 665 | 393 |
| jcmaster.c | D | 23-Nov-2023 | 21.4 KiB | 641 | 418 |
| jcomapi.c | D | 23-Nov-2023 | 3.2 KiB | 110 | 45 |
| jconfig.h | D | 23-Nov-2023 | 2 KiB | 69 | 13 |
| jconfig.h.in | D | 23-Nov-2023 | 2.1 KiB | 69 | 49 |
| jconfig.txt | D | 23-Nov-2023 | 4.5 KiB | 137 | 109 |
| jconfigint.h | D | 23-Nov-2023 | 1.2 KiB | 55 | 36 |
| jconfigint.h.in | D | 23-Nov-2023 | 875 | 35 | 25 |
| jcparam.c | D | 23-Nov-2023 | 17.8 KiB | 542 | 323 |
| jcphuff.c | D | 23-Nov-2023 | 32.7 KiB | 1,113 | 732 |
| jcprepct.c | D | 23-Nov-2023 | 12.7 KiB | 352 | 208 |
| jcsample.c | D | 23-Nov-2023 | 18.7 KiB | 523 | 296 |
| jcstest.c | D | 23-Nov-2023 | 3.8 KiB | 127 | 77 |
| jctrans.c | D | 23-Nov-2023 | 14.6 KiB | 402 | 227 |
| jdapimin.c | D | 23-Nov-2023 | 12.9 KiB | 408 | 228 |
| jdapistd.c | D | 23-Nov-2023 | 24.4 KiB | 675 | 382 |
| jdarith.c | D | 23-Nov-2023 | 24.9 KiB | 783 | 498 |
| jdatadst-tj.c | D | 23-Nov-2023 | 6.7 KiB | 203 | 92 |
| jdatadst.c | D | 23-Nov-2023 | 9.5 KiB | 293 | 144 |
| jdatasrc-tj.c | D | 23-Nov-2023 | 6.8 KiB | 195 | 60 |
| jdatasrc.c | D | 23-Nov-2023 | 10 KiB | 296 | 122 |
| jdcoefct.c | D | 23-Nov-2023 | 33.2 KiB | 879 | 647 |
| jdcoefct.h | D | 23-Nov-2023 | 2.6 KiB | 84 | 36 |
| jdcol565.c | D | 23-Nov-2023 | 11.4 KiB | 385 | 333 |
| jdcolext.c | D | 23-Nov-2023 | 4.3 KiB | 142 | 88 |
| jdcolor.c | D | 23-Nov-2023 | 27.9 KiB | 883 | 651 |
| jdct.h | D | 23-Nov-2023 | 9.5 KiB | 209 | 101 |
| jddctmgr.c | D | 23-Nov-2023 | 11.1 KiB | 353 | 247 |
| jdhuff.c | D | 23-Nov-2023 | 25.7 KiB | 826 | 473 |
| jdhuff.h | D | 23-Nov-2023 | 9.6 KiB | 248 | 113 |
| jdicc.c | D | 23-Nov-2023 | 5.4 KiB | 172 | 106 |
| jdinput.c | D | 23-Nov-2023 | 14.2 KiB | 409 | 228 |
| jdmainct.c | D | 23-Nov-2023 | 19.3 KiB | 461 | 226 |
| jdmainct.h | D | 23-Nov-2023 | 2.4 KiB | 72 | 40 |
| jdmarker.c | D | 23-Nov-2023 | 41.2 KiB | 1,375 | 862 |
| jdmaster.c | D | 23-Nov-2023 | 26.8 KiB | 727 | 469 |
| jdmaster.h | D | 23-Nov-2023 | 788 | 29 | 8 |
| jdmerge.c | D | 23-Nov-2023 | 19.3 KiB | 589 | 415 |
| jdmerge.h | D | 23-Nov-2023 | 1.6 KiB | 48 | 18 |
| jdmrg565.c | D | 23-Nov-2023 | 10.8 KiB | 355 | 279 |
| jdmrgext.c | D | 23-Nov-2023 | 5.7 KiB | 185 | 145 |
| jdphuff.c | D | 23-Nov-2023 | 21.6 KiB | 680 | 400 |
| jdpostct.c | D | 23-Nov-2023 | 10.7 KiB | 295 | 182 |
| jdsample.c | D | 23-Nov-2023 | 17.6 KiB | 525 | 326 |
| jdsample.h | D | 23-Nov-2023 | 1.7 KiB | 51 | 17 |
| jdtrans.c | D | 23-Nov-2023 | 5.3 KiB | 157 | 79 |
| jerror.c | D | 23-Nov-2023 | 7.7 KiB | 252 | 108 |
| jerror.h | D | 23-Nov-2023 | 15.3 KiB | 330 | 278 |
| jfdctflt.c | D | 23-Nov-2023 | 5.5 KiB | 170 | 86 |
| jfdctfst.c | D | 23-Nov-2023 | 7.6 KiB | 228 | 104 |
| jfdctint.c | D | 23-Nov-2023 | 11.2 KiB | 289 | 148 |
| jidctflt.c | D | 23-Nov-2023 | 8.5 KiB | 241 | 124 |
| jidctfst.c | D | 23-Nov-2023 | 13.2 KiB | 372 | 197 |
| jidctint.c | D | 23-Nov-2023 | 103.8 KiB | 2,628 | 1,848 |
| jidctred.c | D | 23-Nov-2023 | 14.2 KiB | 410 | 245 |
| jinclude.h | D | 23-Nov-2023 | 2.9 KiB | 89 | 29 |
| jmemmgr.c | D | 23-Nov-2023 | 43.7 KiB | 1,180 | 687 |
| jmemnobs.c | D | 23-Nov-2023 | 2.8 KiB | 116 | 56 |
| jmemsys.h | D | 23-Nov-2023 | 7.6 KiB | 179 | 53 |
| jmorecfg.h | D | 23-Nov-2023 | 14 KiB | 387 | 136 |
| jpeg_nbits_table.c | D | 23-Nov-2023 | 264.2 KiB | 4,105 | 4,102 |
| jpeg_nbits_table.h | D | 23-Nov-2023 | 51 | 1 | 1 |
| jpegcomp.h | D | 23-Nov-2023 | 1.1 KiB | 33 | 20 |
| jpegint.h | D | 23-Nov-2023 | 15.3 KiB | 372 | 233 |
| jpeglib.h | D | 23-Nov-2023 | 49.2 KiB | 1,139 | 536 |
| jpeglibmangler.h | D | 23-Nov-2023 | 7 KiB | 134 | 124 |
| jpegtran.1 | D | 23-Nov-2023 | 12.8 KiB | 359 | 357 |
| jpegtran.c | D | 23-Nov-2023 | 24.3 KiB | 738 | 538 |
| jquant1.c | D | 23-Nov-2023 | 31.4 KiB | 857 | 485 |
| jquant2.c | D | 23-Nov-2023 | 47.6 KiB | 1,286 | 747 |
| jsimd.h | D | 23-Nov-2023 | 5.7 KiB | 124 | 90 |
| jsimd_none.c | D | 23-Nov-2023 | 7.8 KiB | 432 | 350 |
| jsimddct.h | D | 23-Nov-2023 | 3 KiB | 71 | 50 |
| jstdhuff.c | D | 23-Nov-2023 | 5.2 KiB | 144 | 103 |
| jutils.c | D | 23-Nov-2023 | 3.7 KiB | 134 | 65 |
| jversion.h | D | 23-Nov-2023 | 1.7 KiB | 55 | 22 |
| libjpeg.map.in | D | 23-Nov-2023 | 164 | 12 | 10 |
| libjpeg.txt | D | 23-Nov-2023 | 166.9 KiB | 3,163 | 2,634 |
| rdbmp.c | D | 23-Nov-2023 | 22.5 KiB | 690 | 508 |
| rdcolmap.c | D | 23-Nov-2023 | 6.8 KiB | 254 | 142 |
| rdgif.c | D | 23-Nov-2023 | 23.2 KiB | 696 | 427 |
| rdjpgcom.1 | D | 23-Nov-2023 | 1.7 KiB | 64 | 63 |
| rdjpgcom.c | D | 23-Nov-2023 | 14.6 KiB | 511 | 317 |
| rdppm.c | D | 23-Nov-2023 | 24.8 KiB | 780 | 586 |
| rdswitch.c | D | 23-Nov-2023 | 12.8 KiB | 425 | 301 |
| rdtarga.c | D | 23-Nov-2023 | 15.1 KiB | 509 | 323 |
| structure.txt | D | 23-Nov-2023 | 48.3 KiB | 901 | 735 |
| tjbench.c | D | 23-Nov-2023 | 39.6 KiB | 1,051 | 916 |
| tjbenchtest.in | D | 23-Nov-2023 | 11.7 KiB | 257 | 211 |
| tjbenchtest.java.in | D | 23-Nov-2023 | 10.1 KiB | 216 | 170 |
| tjunittest.c | D | 23-Nov-2023 | 34.9 KiB | 1,173 | 951 |
| tjutil.c | D | 23-Nov-2023 | 2.2 KiB | 71 | 31 |
| tjutil.h | D | 23-Nov-2023 | 1.9 KiB | 48 | 16 |
| transupp.c | D | 23-Nov-2023 | 90.8 KiB | 2,368 | 1,822 |
| transupp.h | D | 23-Nov-2023 | 10.9 KiB | 231 | 80 |
| turbojpeg-jni.c | D | 23-Nov-2023 | 45.9 KiB | 1,229 | 975 |
| turbojpeg-mapfile | D | 23-Nov-2023 | 989 | 66 | 61 |
| turbojpeg-mapfile.jni | D | 23-Nov-2023 | 3.1 KiB | 102 | 96 |
| turbojpeg.c | D | 23-Nov-2023 | 73.6 KiB | 2,222 | 1,780 |
| turbojpeg.h | D | 23-Nov-2023 | 72.9 KiB | 1,757 | 242 |
| usage.txt | D | 23-Nov-2023 | 37.4 KiB | 684 | 563 |
| wizard.txt | D | 23-Nov-2023 | 10.2 KiB | 213 | 175 |
| wrbmp.c | D | 23-Nov-2023 | 17.6 KiB | 553 | 367 |
| wrgif.c | D | 23-Nov-2023 | 18.2 KiB | 581 | 321 |
| wrjpgcom.1 | D | 23-Nov-2023 | 2.6 KiB | 104 | 103 |
| wrjpgcom.c | D | 23-Nov-2023 | 17.5 KiB | 592 | 396 |
| wrppm.c | D | 23-Nov-2023 | 10.6 KiB | 367 | 229 |
| wrtarga.c | D | 23-Nov-2023 | 7.3 KiB | 259 | 155 |
README.android
1# Android differences from upstream chromium
2
3Android builds with `C_ARITH_CODING_SUPPORTED` and `D_ARITH_CODING_SUPPORTED`,
4added in
5https://android-review.googlesource.com/c/platform/external/libjpeg-turbo/+/291407/
6to support a variant of jpeg files using arithmetic (instead of Huffman)
7encoding. This variant isn't often used because of a lack of support in many
8viewers (e.g. Chromium), but Android really values backwards compatibility, and
9this might break some users. Android probably only needs to keep
10`D_ARITH_CODING_SUPPORTED`, but vendor code might also be encoding by setting
11jpeg_compress_struct.arith_code to true, so we enable both to ensure full
12backwards compatibility since it's not really costing us anything.
13We `#define` these in jconfig.h rather than in Android.bp so that they're
14correctly exported to any *users* (in particular, jerror.h only conditionally
15defines the corresponding error codes if these `#define`s are present).
16
README.chromium
1Name: libjpeg-turbo
2URL: https://github.com/libjpeg-turbo/libjpeg-turbo/
3Version: 2.1.0
4License: Custom license
5License File: LICENSE.md
6Security Critical: yes
7License Android Compatible: yes
8
9Description:
10This consists of the components:
11* libjpeg-turbo 2.1.0
12* This file (README.chromium)
13* A build file (BUILD.gn)
14* An OWNERS file
15* A codereview.settings file
16* Patched header files used by Chromium
17* Deleted unused directories: cmakescripts, doc, fuzz, java, release,
18 sharedlib, simd/loongson, simd/mips, simd/powerpc, and win
19* Deleted unused files: appveyor.yml, CMakeLists.txt, doxygen.config,
20 doxygen-extra.css, .gitattributes, md5/CMakeLists.txt, md5/md5cmp.c,
21 simd/CMakeLists.txt, tjexample.c, tjexampletest.in, tjexampletest.java.in and
22 .travis.yml
23* Deleted legacy Arm Neon assembly files (supporting old compiler versions that
24 do not generate performant code from intrinsics):
25 simd/arm/aarch32/jsimd_neon.S, simd/arm/aarch64/jsimd_neon.S.
26
27This libjpeg-turbo can replace our libjpeg-6b without any modifications in the
28Chromium code.
29
30Same as our copy of libjpeg-6b, this libjpeg-turbo also added a new file
31jpeglibmangler.h and included it from jpeglib.h that changes the names of all
32externally visible functions to chromium_* so that we can avoid conflicts that
33arise when system libraries attempt to use our libjpeg. Also, we applied the
34following changes which are not merged to upstream:
35
36* Configuration files jconfig.h, jconfigint.h and neon-compat.h were generated
37 and then altered manually to be compatible on all of Chromium's platforms.
38 http://crbug.com/608347
39* Fix static const data duplication of jpeg_nbits_table. A unique copy
40 was in the jchuff.obj and jcphuff.obj resulting in an added 65k in
41 .rdata in chrome.dll and chrome_child.dll. Declaring extern const
42 in the header instead of static const and moving the definition to
43 a new .c file fixes this so only one copy is referenced. Also added
44 extern wrappers around usage in asm files. The jpeg_nbits_table.inc
45 file was also deleted. It was also necessary to give this table hidden
46 visibility to avoid invalid relocations (ignored by ld but rejected by
47 lld) arising from attempts to reference the table from assembler on
48 32-bit x86. This only affects shared libraries, but that's important
49 for downstream Android builds.
50* Patches to enable running the upstream unit tests through GTest.
51 The upstream unit tests are defined here under the section 'TESTS':
52 https://github.com/libjpeg-turbo/libjpeg-turbo/blob/master/CMakeLists.txt
53 These changes are tracked by Chromium issue: https://crbug.com/993876
54 - Refactor tjunittest.c to provide test interface
55 - Move tjunittest logs from stdout to stderr
56 - Refactor tjbench.c to provide test interface
57 - Move tbench logs from stdout to stderr
58 - Write tjunittest output files to sdcard on Android
59 - Refactor cjpeg.c to provide test interface
60 - Refactor jpegtran.c to provide test interface
61 - Add input JPEG images for djpeg and jpegtran tests
62 - Refactor djpeg.c to provide test interface
63 A new gtest directory contains GTest wrappers (and associated utilities) for
64 each of tjunittest, tjbench, cjpeg, djpeg and jpegtran.
65
66Refer to working-with-nested-repos [1] for details of how to setup your git
67svn client to update the code (for making local changes, cherry picking from
68upstream, etc).
69
70[1] https://www.chromium.org/developers/how-tos/get-the-code/working-with-nested-repos
71
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-2020, 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
162REFERENCES
163==========
164
165We recommend reading one or more of these references before trying to
166understand the innards of the JPEG software.
167
168The best short technical introduction to the JPEG compression algorithm is
169 Wallace, Gregory K. "The JPEG Still Picture Compression Standard",
170 Communications of the ACM, April 1991 (vol. 34 no. 4), pp. 30-44.
171(Adjacent articles in that issue discuss MPEG motion picture compression,
172applications of JPEG, and related topics.) If you don't have the CACM issue
173handy, a PDF file containing a revised version of Wallace's article is
174available at http://www.ijg.org/files/Wallace.JPEG.pdf. The file (actually
175a preprint for an article that appeared in IEEE Trans. Consumer Electronics)
176omits the sample images that appeared in CACM, but it includes corrections
177and some added material. Note: the Wallace article is copyright ACM and IEEE,
178and it may not be used for commercial purposes.
179
180A somewhat less technical, more leisurely introduction to JPEG can be found in
181"The Data Compression Book" by Mark Nelson and Jean-loup Gailly, published by
182M&T Books (New York), 2nd ed. 1996, ISBN 1-55851-434-1. This book provides
183good explanations and example C code for a multitude of compression methods
184including JPEG. It is an excellent source if you are comfortable reading C
185code but don't know much about data compression in general. The book's JPEG
186sample code is far from industrial-strength, but when you are ready to look
187at a full implementation, you've got one here...
188
189The best currently available description of JPEG is the textbook "JPEG Still
190Image Data Compression Standard" by William B. Pennebaker and Joan L.
191Mitchell, published by Van Nostrand Reinhold, 1993, ISBN 0-442-01272-1.
192Price US$59.95, 638 pp. The book includes the complete text of the ISO JPEG
193standards (DIS 10918-1 and draft DIS 10918-2).
194
195The original JPEG standard is divided into two parts, Part 1 being the actual
196specification, while Part 2 covers compliance testing methods. Part 1 is
197titled "Digital Compression and Coding of Continuous-tone Still Images,
198Part 1: Requirements and guidelines" and has document numbers ISO/IEC IS
19910918-1, ITU-T T.81. Part 2 is titled "Digital Compression and Coding of
200Continuous-tone Still Images, Part 2: Compliance testing" and has document
201numbers ISO/IEC IS 10918-2, ITU-T T.83.
202
203The JPEG standard does not specify all details of an interchangeable file
204format. For the omitted details, we follow the "JFIF" conventions, revision
2051.02. JFIF version 1 has been adopted as ISO/IEC 10918-5 (05/2013) and
206Recommendation ITU-T T.871 (05/2011): Information technology - Digital
207compression and coding of continuous-tone still images: JPEG File Interchange
208Format (JFIF). It is available as a free download in PDF file format from
209https://www.iso.org/standard/54989.html and http://www.itu.int/rec/T-REC-T.871.
210A PDF file of the older JFIF 1.02 specification is available at
211http://www.w3.org/Graphics/JPEG/jfif3.pdf.
212
213The TIFF 6.0 file format specification can be obtained from
214http://mirrors.ctan.org/graphics/tiff/TIFF6.ps.gz. The JPEG incorporation
215scheme found in the TIFF 6.0 spec of 3-June-92 has a number of serious
216problems. IJG does not recommend use of the TIFF 6.0 design (TIFF Compression
217tag 6). Instead, we recommend the JPEG design proposed by TIFF Technical Note
218#2 (Compression tag 7). Copies of this Note can be obtained from
219http://www.ijg.org/files/. It is expected that the next revision
220of the TIFF spec will replace the 6.0 JPEG design with the Note's design.
221Although IJG's own code does not support TIFF/JPEG, the free libtiff library
222uses our library to implement TIFF/JPEG per the Note.
223
224
225ARCHIVE LOCATIONS
226=================
227
228The "official" archive site for this software is www.ijg.org.
229The most recent released version can always be found there in
230directory "files".
231
232The JPEG FAQ (Frequently Asked Questions) article is a source of some
233general information about JPEG. It is available at
234http://www.faqs.org/faqs/jpeg-faq.
235
236
237FILE FORMAT COMPATIBILITY
238=========================
239
240This software implements ITU T.81 | ISO/IEC 10918 with some extensions from
241ITU T.871 | ISO/IEC 10918-5 (JPEG File Interchange Format-- see REFERENCES).
242Informally, the term "JPEG image" or "JPEG file" most often refers to JFIF or
243a subset thereof, but there are other formats containing the name "JPEG" that
244are incompatible with the DCT-based JPEG standard or with JFIF (for instance,
245JPEG 2000 and JPEG XR). This software therefore does not support these
246formats. Indeed, one of the original reasons for developing this free software
247was to help force convergence on a common, interoperable format standard for
248JPEG files.
249
250JFIF is a minimal or "low end" representation. TIFF/JPEG (TIFF revision 6.0 as
251modified by TIFF Technical Note #2) can be used for "high end" applications
252that need to record a lot of additional data about an image.
253
254
255TO DO
256=====
257
258Please send bug reports, offers of help, etc. to jpeg-info@jpegclub.org.
259
README.md
1Background
2==========
3
4libjpeg-turbo is a JPEG image codec that uses SIMD instructions to accelerate
5baseline JPEG compression and decompression on x86, x86-64, Arm, PowerPC, and
6MIPS systems, as well as progressive JPEG compression on x86, x86-64, and Arm
7systems. On such systems, libjpeg-turbo is generally 2-6x as fast as libjpeg,
8all else being equal. On other types of systems, libjpeg-turbo can still
9outperform libjpeg by a significant amount, by virtue of its highly-optimized
10Huffman coding routines. In many cases, the performance of libjpeg-turbo
11rivals 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 `-DWITH_JPEG7=1` or `-DWITH_JPEG8=1` to `cmake`, you
139can build a version of libjpeg-turbo that emulates the libjpeg v7 or v8 ABI, so
140that programs that are built against libjpeg v7 or v8 can be run with
141libjpeg-turbo. The following section describes which libjpeg v7+ features are
142supported and which aren't.
143
144### Support for libjpeg v7 and v8 Features
145
146#### Fully supported
147
148- **libjpeg API: IDCT scaling extensions in decompressor**<br>
149 libjpeg-turbo supports IDCT scaling with scaling factors of 1/8, 1/4, 3/8,
150 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
151 and 1/2 are SIMD-accelerated.)
152
153- **libjpeg API: Arithmetic coding**
154
155- **libjpeg API: In-memory source and destination managers**<br>
156 See notes below.
157
158- **cjpeg: Separate quality settings for luminance and chrominance**<br>
159 Note that the libpjeg v7+ API was extended to accommodate this feature only
160 for convenience purposes. It has always been possible to implement this
161 feature with libjpeg v6b (see rdswitch.c for an example.)
162
163- **cjpeg: 32-bit BMP support**
164
165- **cjpeg: `-rgb` option**
166
167- **jpegtran: Lossless cropping**
168
169- **jpegtran: `-perfect` option**
170
171- **jpegtran: Forcing width/height when performing lossless crop**
172
173- **rdjpgcom: `-raw` option**
174
175- **rdjpgcom: Locale awareness**
176
177
178#### Not supported
179
180NOTE: As of this writing, extensive research has been conducted into the
181usefulness of DCT scaling as a means of data reduction and SmartScale as a
182means of quality improvement. Readers are invited to peruse the research at
183<http://www.libjpeg-turbo.org/About/SmartScale> and draw their own conclusions,
184but it is the general belief of our project that these features have not
185demonstrated sufficient usefulness to justify inclusion in libjpeg-turbo.
186
187- **libjpeg API: DCT scaling in compressor**<br>
188 `cinfo.scale_num` and `cinfo.scale_denom` are silently ignored.
189 There is no technical reason why DCT scaling could not be supported when
190 emulating the libjpeg v7+ API/ABI, but without the SmartScale extension (see
191 below), only scaling factors of 1/2, 8/15, 4/7, 8/13, 2/3, 8/11, 4/5, and
192 8/9 would be available, which is of limited usefulness.
193
194- **libjpeg API: SmartScale**<br>
195 `cinfo.block_size` is silently ignored.
196 SmartScale is an extension to the JPEG format that allows for DCT block
197 sizes other than 8x8. Providing support for this new format would be
198 feasible (particularly without full acceleration.) However, until/unless
199 the format becomes either an official industry standard or, at minimum, an
200 accepted solution in the community, we are hesitant to implement it, as
201 there is no sense of whether or how it might change in the future. It is
202 our belief that SmartScale has not demonstrated sufficient usefulness as a
203 lossless format nor as a means of quality enhancement, and thus our primary
204 interest in providing this feature would be as a means of supporting
205 additional DCT scaling factors.
206
207- **libjpeg API: Fancy downsampling in compressor**<br>
208 `cinfo.do_fancy_downsampling` is silently ignored.
209 This requires the DCT scaling feature, which is not supported.
210
211- **jpegtran: Scaling**<br>
212 This requires both the DCT scaling and SmartScale features, which are not
213 supported.
214
215- **Lossless RGB JPEG files**<br>
216 This requires the SmartScale feature, which is not supported.
217
218### What About libjpeg v9?
219
220libjpeg v9 introduced yet another field to the JPEG compression structure
221(`color_transform`), thus making the ABI backward incompatible with that of
222libjpeg v8. This new field was introduced solely for the purpose of supporting
223lossless SmartScale encoding. Furthermore, there was actually no reason to
224extend the API in this manner, as the color transform could have just as easily
225been activated by way of a new JPEG colorspace constant, thus preserving
226backward ABI compatibility.
227
228Our research (see link above) has shown that lossless SmartScale does not
229generally accomplish anything that can't already be accomplished better with
230existing, standard lossless formats. Therefore, at this time it is our belief
231that there is not sufficient technical justification for software projects to
232upgrade from libjpeg v8 to libjpeg v9, and thus there is not sufficient
233technical justification for us to emulate the libjpeg v9 ABI.
234
235In-Memory Source/Destination Managers
236-------------------------------------
237
238By default, libjpeg-turbo 1.3 and later includes the `jpeg_mem_src()` and
239`jpeg_mem_dest()` functions, even when not emulating the libjpeg v8 API/ABI.
240Previously, it was necessary to build libjpeg-turbo from source with libjpeg v8
241API/ABI emulation in order to use the in-memory source/destination managers,
242but several projects requested that those functions be included when emulating
243the libjpeg v6b API/ABI as well. This allows the use of those functions by
244programs that need them, without breaking ABI compatibility for programs that
245don't, and it allows those functions to be provided in the "official"
246libjpeg-turbo binaries.
247
248Those who are concerned about maintaining strict conformance with the libjpeg
249v6b or v7 API can pass an argument of `-DWITH_MEM_SRCDST=0` to `cmake` prior to
250building libjpeg-turbo. This will restore the pre-1.3 behavior, in which
251`jpeg_mem_src()` and `jpeg_mem_dest()` are only included when emulating the
252libjpeg v8 API/ABI.
253
254On Un*x systems, including the in-memory source/destination managers changes
255the dynamic library version from 62.2.0 to 62.3.0 if using libjpeg v6b API/ABI
256emulation and from 7.2.0 to 7.3.0 if using libjpeg v7 API/ABI emulation.
257
258Note that, on most Un*x systems, the dynamic linker will not look for a
259function in a library until that function is actually used. Thus, if a program
260is built against libjpeg-turbo 1.3+ and uses `jpeg_mem_src()` or
261`jpeg_mem_dest()`, that program will not fail if run against an older version
262of libjpeg-turbo or against libjpeg v7- until the program actually tries to
263call `jpeg_mem_src()` or `jpeg_mem_dest()`. Such is not the case on Windows.
264If a program is built against the libjpeg-turbo 1.3+ DLL and uses
265`jpeg_mem_src()` or `jpeg_mem_dest()`, then it must use the libjpeg-turbo 1.3+
266DLL at run time.
267
268Both cjpeg and djpeg have been extended to allow testing the in-memory
269source/destination manager functions. See their respective man pages for more
270details.
271
272
273Mathematical Compatibility
274==========================
275
276For the most part, libjpeg-turbo should produce identical output to libjpeg
277v6b. The one exception to this is when using the floating point DCT/IDCT, in
278which case the outputs of libjpeg v6b and libjpeg-turbo can differ for the
279following reasons:
280
281- The SSE/SSE2 floating point DCT implementation in libjpeg-turbo is ever so
282 slightly more accurate than the implementation in libjpeg v6b, but not by
283 any amount perceptible to human vision (generally in the range of 0.01 to
284 0.08 dB gain in PNSR.)
285
286- When not using the SIMD extensions, libjpeg-turbo uses the more accurate
287 (and slightly faster) floating point IDCT algorithm introduced in libjpeg
288 v8a as opposed to the algorithm used in libjpeg v6b. It should be noted,
289 however, that this algorithm basically brings the accuracy of the floating
290 point IDCT in line with the accuracy of the accurate integer IDCT. The
291 floating point DCT/IDCT algorithms are mainly a legacy feature, and they do
292 not produce significantly more accuracy than the accurate integer algorithms
293 (to put numbers on this, the typical difference in PNSR between the two
294 algorithms is less than 0.10 dB, whereas changing the quality level by 1 in
295 the upper range of the quality scale is typically more like a 1.0 dB
296 difference.)
297
298- If the floating point algorithms in libjpeg-turbo are not implemented using
299 SIMD instructions on a particular platform, then the accuracy of the
300 floating point DCT/IDCT can depend on the compiler settings.
301
302While libjpeg-turbo does emulate the libjpeg v8 API/ABI, under the hood it is
303still using the same algorithms as libjpeg v6b, so there are several specific
304cases in which libjpeg-turbo cannot be expected to produce the same output as
305libjpeg v8:
306
307- When decompressing using scaling factors of 1/2 and 1/4, because libjpeg v8
308 implements those scaling algorithms differently than libjpeg v6b does, and
309 libjpeg-turbo's SIMD extensions are based on the libjpeg v6b behavior.
310
311- When using chrominance subsampling, because libjpeg v8 implements this
312 with its DCT/IDCT scaling algorithms rather than with a separate
313 downsampling/upsampling algorithm. In our testing, the subsampled/upsampled
314 output of libjpeg v8 is less accurate than that of libjpeg v6b for this
315 reason.
316
317- When decompressing using a scaling factor > 1 and merged (AKA "non-fancy" or
318 "non-smooth") chrominance upsampling, because libjpeg v8 does not support
319 merged upsampling with scaling factors > 1.
320
321
322Performance Pitfalls
323====================
324
325Restart Markers
326---------------
327
328The optimized Huffman decoder in libjpeg-turbo does not handle restart markers
329in a way that makes the rest of the libjpeg infrastructure happy, so it is
330necessary to use the slow Huffman decoder when decompressing a JPEG image that
331has restart markers. This can cause the decompression performance to drop by
332as much as 20%, but the performance will still be much greater than that of
333libjpeg. Many consumer packages, such as Photoshop, use restart markers when
334generating JPEG images, so images generated by those programs will experience
335this issue.
336
337Fast Integer Forward DCT at High Quality Levels
338-----------------------------------------------
339
340The algorithm used by the SIMD-accelerated quantization function cannot produce
341correct results whenever the fast integer forward DCT is used along with a JPEG
342quality of 98-100. Thus, libjpeg-turbo must use the non-SIMD quantization
343function in those cases. This causes performance to drop by as much as 40%.
344It is therefore strongly advised that you use the accurate integer forward DCT
345whenever encoding images with a JPEG quality of 98 or higher.
346
347
348Memory Debugger Pitfalls
349========================
350
351Valgrind and Memory Sanitizer (MSan) can generate false positives
352(specifically, incorrect reports of uninitialized memory accesses) when used
353with libjpeg-turbo's SIMD extensions. It is generally recommended that the
354SIMD extensions be disabled, either by passing an argument of `-DWITH_SIMD=0`
355to `cmake` when configuring the build or by setting the environment variable
356`JSIMD_FORCENONE` to `1` at run time, when testing libjpeg-turbo with Valgrind,
357MSan, or other memory debuggers.
358