use libjpeg_turbo for improved jpg compatibility and speed

Author: DanielKinsman

COPYRIGHT.txt

@@ -324,16 +324,18 @@ Comment: Jolt Physics
 Copyright: 2021, Jorrit Rouwe
 License: Expat
 
-Files: thirdparty/jpeg-compressor/*
-Comment: jpeg-compressor
-Copyright: 2012, Rich Geldreich
-License: public-domain or Apache-2.0
-
 Files: thirdparty/libbacktrace/*
 Comment: libbacktrace
 Copyright: 2012-2021, Free Software Foundation, Inc.
 License: BSD-3-clause
 
+Files: thirdparty/libjpeg-turbo/*
+Comment: libjpeg-turbo
+Copyright: Copyright (C)2009-2024 D. R. Commander
+ Copyright (C)2015 Viktor Szathmáry.
+ 1991-2020, Thomas G. Lane, Guido Vollbeding
+License: TurboJPEG modified BSD-3-clause, IJG License
+
 Files: thirdparty/libktx/*
 Comment: KTX
 Copyright: 2013-2020, Mark Callow
@@ -1683,6 +1685,42 @@ License: HarfBuzz
  ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 
+License: IJG License
+ The authors make NO WARRANTY or representation, either express or implied,
+ with respect to this software, its quality, accuracy, merchantability, or
+ fitness for a particular purpose.  This software is provided "AS IS", and you,
+ its user, assume the entire risk as to its quality and accuracy.
+
+ This software is copyright (C) 1991-2020, Thomas G. Lane, Guido Vollbeding.
+ All Rights Reserved except as specified below.
+
+ Permission is hereby granted to use, copy, modify, and distribute this
+ software (or portions thereof) for any purpose, without fee, subject to these
+ conditions:
+ (1) If any part of the source code for this software is distributed, then this
+ README file must be included, with this copyright and no-warranty notice
+ unaltered; and any additions, deletions, or changes to the original files
+ must be clearly indicated in accompanying documentation.
+ (2) If only executable code is distributed, then the accompanying
+ documentation must state that "this software is based in part on the work of
+ the Independent JPEG Group".
+ (3) Permission for use of this software is granted only if the user accepts
+ full responsibility for any undesirable consequences; the authors accept
+ NO LIABILITY for damages of any kind.
+
+ These conditions apply to any software derived from or based on the IJG code,
+ not just to the unmodified library.  If you use our work, you ought to
+ acknowledge us.
+
+ Permission is NOT granted for the use of any IJG author's name or company name
+ in advertising or publicity relating to this software or products derived from
+ it.  This software may be referred to only as "the Independent JPEG Group's
+ software".
+
+ We specifically permit and encourage the use of this software as the basis of
+ commercial products, provided that all warranty or liability claims are
+ assumed by the product vendor.
+
 License: MPL-2.0
  Mozilla Public License Version 2.0
  ==================================
@@ -2141,6 +2179,34 @@ License: OFL-1.1
  DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE.
 
+License: TurboJPEG modified BSD-3-clause
+ Copyright (C)2009-2024 D. R. Commander.  All Rights Reserved.<br>
+ Copyright (C)2015 Viktor Szathmáry.  All Rights Reserved.
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions are met:
+
+ - Redistributions of source code must retain the above copyright notice,
+   this list of conditions and the following disclaimer.
+ - Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+ - Neither the name of the libjpeg-turbo Project nor the names of its
+   contributors may be used to endorse or promote products derived from this
+   software without specific prior written permission.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS",
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+ LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ POSSIBILITY OF SUCH DAMAGE.
+
 License: Unicode
  COPYRIGHT AND PERMISSION NOTICE (ICU 58 and later)
  .

SConstruct

@@ -276,6 +276,7 @@ opts.Add(BoolVariable("builtin_glslang", "Use the built-in glslang library", Tru
 opts.Add(BoolVariable("builtin_graphite", "Use the built-in Graphite library", True))
 opts.Add(BoolVariable("builtin_harfbuzz", "Use the built-in HarfBuzz library", True))
 opts.Add(BoolVariable("builtin_icu4c", "Use the built-in ICU library", True))
+opts.Add(BoolVariable("builtin_libjpeg_turbo", "Use the built-in libjpeg-turbo library", True))
 opts.Add(BoolVariable("builtin_libogg", "Use the built-in libogg library", True))
 opts.Add(BoolVariable("builtin_libpng", "Use the built-in libpng library", True))
 opts.Add(BoolVariable("builtin_libtheora", "Use the built-in libtheora library", True))

misc/error_suppressions/tsan.txt

@@ -6,3 +6,4 @@ deadlock:modules/text_server_adv/text_server_adv.cpp
 deadlock:modules/text_server_fb/text_server_fb.cpp
 race:modules/navigation_2d/nav_map_2d.cpp
 race:modules/navigation_3d/nav_map_3d.cpp
+race:thirdparty/thorvg/src/loaders/external_jpg/tvgJpgLoader.cpp

misc/error_suppressions/ubsan.txt

@@ -6,6 +6,7 @@ float-divide-by-zero:thirdparty/thorvg/src/renderer/sw_engine/tvgSwFill.cpp
 function:thirdparty/embree/common/sys/thread.cpp
 function:thirdparty/embree/kernels/common/accel.h
 function:thirdparty/xatlas/xatlas.cpp
+implicit-integer-sign-change:thirdparty/basis_universal/encoder/jpgd.cpp
 implicit-integer-sign-change:thirdparty/basis_universal/transcoder/basisu_astc_helpers.h
 implicit-integer-sign-change:thirdparty/embree/common/lexers/../sys/ref.h
 implicit-integer-sign-change:thirdparty/embree/common/lexers/tokenstream.cpp
@@ -38,7 +39,6 @@ implicit-integer-sign-change:thirdparty/icu4c/common/unicode/unistr.h
 implicit-integer-sign-change:thirdparty/icu4c/common/unistr.cpp
 implicit-integer-sign-change:thirdparty/icu4c/common/uresbund.cpp
 implicit-integer-sign-change:thirdparty/icu4c/common/ustrtrns.cpp
-implicit-integer-sign-change:thirdparty/jpeg-compressor/jpgd.cpp
 implicit-integer-sign-change:thirdparty/libogg/bitwise.c
 implicit-integer-sign-change:thirdparty/libvorbis/info.c
 implicit-integer-sign-change:thirdparty/libvorbis/sharedbook.c

modules/basis_universal/SCsub

@@ -38,6 +38,7 @@ if basisu_encoder:
         "basisu_ssim.cpp",
         "basisu_uastc_enc.cpp",
         "basisu_uastc_hdr_4x4_enc.cpp",
+        "jpgd.cpp",
         "pvpngreader.cpp",
     ]
     encoder_sources = [thirdparty_dir + "encoder/" + file for file in encoder_sources]
@@ -47,7 +48,6 @@ transcoder_sources = [thirdparty_dir + "transcoder/basisu_transcoder.cpp"]
 env_basisu.Prepend(CPPEXTPATH=[thirdparty_dir])
 
 if basisu_encoder:
-    env_basisu.Prepend(CPPEXTPATH=["#thirdparty/jpeg-compressor"])
     env_basisu.Prepend(CPPEXTPATH=["#thirdparty/tinyexr"])
 
 if env["builtin_zstd"]:

modules/basis_universal/config.py

@@ -1,6 +1,6 @@
 def can_build(env, platform):
     if env.editor_build:  # Encoder dependencies
-        env.module_add_dependencies("basis_universal", ["jpg", "tinyexr"])
+        env.module_add_dependencies("basis_universal", ["tinyexr"])
     return True
 
 

modules/jpg/SCsub

@@ -4,32 +4,125 @@ from misc.utility.scons_hints import *
 Import("env")
 Import("env_modules")
 
-env_jpg = env_modules.Clone()
-
-# Thirdparty source files
+env_jpeg_turbo = env_modules.Clone()
 
 thirdparty_obj = []
 
-# Not unbundled for now as they are not commonly available as shared library
-thirdparty_dir = "#thirdparty/jpeg-compressor/"
-thirdparty_sources = [
-    "jpgd.cpp",
-    "jpge.cpp",
+thirdparty_dir = "#thirdparty/libjpeg-turbo"
+
+thirdparty_sources_common = [
+    "jaricom.c",
+    "jcapimin.c",
+    "jcarith.c",
+    "jchuff.c",
+    "jcicc.c",
+    "jcinit.c",
+    "jcmarker.c",
+    "jcmaster.c",
+    "jcomapi.c",
+    "jcparam.c",
+    "jcphuff.c",
+    "jctrans.c",
+    "jdapimin.c",
+    "jdarith.c",
+    "jdatadst.c",
+    "jdatadst-tj.c",
+    "jdatasrc.c",
+    "jdatasrc-tj.c",
+    "jdhuff.c",
+    "jdicc.c",
+    "jdinput.c",
+    "jdmarker.c",
+    "jdmaster.c",
+    "jdphuff.c",
+    "jdtrans.c",
+    "jerror.c",
+    "jfdctflt.c",
+    "jmemmgr.c",
+    "jmemnobs.c",
+    "jpeg_nbits.c",
+    "transupp.c",
+    "turbojpeg.c",
+]
+
+thirdparty_sources_bit_dependent = [
+    "jcapistd.c",
+    "jccoefct.c",
+    "jccolor.c",
+    "jcdctmgr.c",
+    "jcmainct.c",
+    "jcprepct.c",
+    "jcsample.c",
+    "jdcoefct.c",
+    "jdcolor.c",
+    "jdapistd.c",
+    "jddctmgr.c",
+    "jdmainct.c",
+    "jdmerge.c",
+    "jdpostct.c",
+    "jdsample.c",
+    "jfdctfst.c",
+    "jfdctint.c",
+    "jidctflt.c",
+    "jidctfst.c",
+    "jidctint.c",
+    "jidctred.c",
+    "jutils.c",
+    "jquant1.c",
+    "jquant2.c",
 ]
-thirdparty_sources = [thirdparty_dir + file for file in thirdparty_sources]
 
-env_jpg.Prepend(CPPEXTPATH=[thirdparty_dir])
+absent_in_16 = frozenset(
+    [
+        "jcdctmgr.c",
+        "jccoefct.c",
+        "jdcoefct.c",
+        "jddctmgr.c",
+        "jfdctfst.c",
+        "jfdctint.c",
+        "jidctflt.c",
+        "jidctfst.c",
+        "jidctint.c",
+        "jidctred.c",
+    ]
+)
+
+thirdparty_sources_by_bits = {
+    8: list(thirdparty_sources_bit_dependent),
+    12: list(thirdparty_sources_bit_dependent),
+    16: [x for x in thirdparty_sources_bit_dependent if x not in absent_in_16],
+}
+
+
+def source_paths(files):
+    return [thirdparty_dir + "/src/" + f for f in files]
+
+
+env_jpeg_turbo.Prepend(CPPEXTPATH=[thirdparty_dir + "/src"])
+
+
+def add_bit_depth(bit_depth: int):
+    env_bit_depth = env_jpeg_turbo.Clone()
+    env_bit_depth.disable_warnings()
+    env_bit_depth["OBJSUFFIX"] = f"_{bit_depth}{env_bit_depth['OBJSUFFIX']}"
+    env_bit_depth.AppendUnique(CPPDEFINES=[f"BITS_IN_JSAMPLE={bit_depth}"])  # to unique or not?
+    env_bit_depth.add_source_files(thirdparty_obj, source_paths(thirdparty_sources_by_bits[bit_depth]))
+
+
+add_bit_depth(8)
+add_bit_depth(12)
+# add_bit_depth(16)
 
-env_thirdparty = env_jpg.Clone()
+env_thirdparty = env_jpeg_turbo.Clone()
 env_thirdparty.disable_warnings()
-env_thirdparty.add_source_files(thirdparty_obj, thirdparty_sources)
+env_thirdparty.add_source_files(thirdparty_obj, source_paths(thirdparty_sources_common))
 env.modules_sources += thirdparty_obj
 
 # Godot source files
 
 module_obj = []
 
-env_jpg.add_source_files(module_obj, "*.cpp")
+env_jpeg_turbo.add_source_files(module_obj, "*.cpp")
 env.modules_sources += module_obj
 
 # Needed to force rebuilding the module files when the thirdparty library is updated.