Merge pull request #2381 from Exiv2/jxl_brotli

Support brotli compressed boxes in JPEG XL
Exiv2 · Oct 24, 2022 · 1ae3a83 · 1ae3a83
2 parents 9767e37 + a58e52e
commit 1ae3a83
Show file tree

Hide file tree

Showing 15 changed files with 249 additions and 84 deletions.
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -37,10 +37,15 @@ jobs:
     steps:
     - name: Checkout repository
       uses: actions/checkout@v3
+
+    - name: Install dependencies
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y libexpat1-dev zlib1g-dev libbrotli-dev
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v2
       with:
         languages: ${{ matrix.language }}
         config-file: .github/codeql/codeql-config.yml
@@ -52,7 +57,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      uses: github/codeql-action/autobuild@v2
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -66,4 +71,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v2
diff --git a/.github/workflows/on_PR_windows_matrix.yml b/.github/workflows/on_PR_windows_matrix.yml
@@ -125,6 +125,7 @@ jobs:
             gtest:p
             libiconv:p
             zlib:p
+            brotli:p
             curl:p
 
       - name: Build
@@ -175,6 +176,9 @@ jobs:
             libxslt-devel
             python38-lxml
             zlib-devel
+            libbrotlicommon1
+            libbrotlidec1
+            libbrotli-devel
       - name: Build
         run: |
           cmake -GNinja \

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -22,13 +22,14 @@ include(cmake/mainSetup.cmake  REQUIRED)
 option( BUILD_SHARED_LIBS             "Build exiv2lib as a shared library"                    ON  )
 option( EXIV2_ENABLE_XMP              "Build with XMP metadata support"                       ON  )
 option( EXIV2_ENABLE_EXTERNAL_XMP     "Use external version of XMP"                           OFF )
-option( EXIV2_ENABLE_PNG              "Build with png support (requires libz)"                ON  )
+option( EXIV2_ENABLE_PNG              "Build with PNG support (requires zlib)"                ON  )
 option( EXIV2_ENABLE_NLS              "Build native language support (requires gettext)"      OFF )
-option( EXIV2_ENABLE_LENSDATA         "Build including lens data"                             ON  )
+option( EXIV2_ENABLE_LENSDATA         "Build including Nikon lens data"                       ON  )
 option( EXIV2_ENABLE_DYNAMIC_RUNTIME  "Use dynamic runtime (used for static libs)"            ON  )
 option( EXIV2_ENABLE_WEBREADY         "Build webready support into library"                   OFF )
-option( EXIV2_ENABLE_CURL             "USE Libcurl for HttpIo (WEBREADY)"                     OFF )
+option( EXIV2_ENABLE_CURL             "Use libcurl for HttpIo (WEBREADY)"                     OFF )
 option( EXIV2_ENABLE_BMFF             "Build with BMFF support"                               ON  )
+option( EXIV2_ENABLE_BROTLI           "Use Brotli for JPEG XL compressed boxes (BMFF)"        ON  )
 
 option( EXIV2_BUILD_SAMPLES           "Build sample applications"                             OFF )
 option( EXIV2_BUILD_EXIV2_COMMAND     "Build exiv2 command-line executable"                   ON  )

diff --git a/README.md b/README.md
@@ -196,7 +196,8 @@ Preset CMake variables:
 
 # CMake finds the project dependencies which were automatically handled by conan
 -- Conan: Using autogenerated FindZLIB.cmake
--- Library zlib found C:/Users/luis/.conan/data/zlib/1.2.11/_/_/package/-- Conan: Using autogenerated FindCURL.cmake
+-- Library zlib found C:/Users/luis/.conan/data/zlib/1.2.11/_/_/package/
+-- Conan: Using autogenerated FindCURL.cmake
 -- Library libcurl_imp found C:/Users/luis/.conan/data/libcurl/7.79.0/_/_/package/
 ...
 
@@ -245,12 +246,13 @@ Options defined at `exiv2/CMakeLists.txt` include:
 
 ```bash
 576 rmills@rmillsmm:~/gnu/github/exiv2/exiv2 $ grep ^option CMakeLists.txt
-option( BUILD_SHARED_LIBS          "Build exiv2lib as a shared library"      ON )
-option( EXIV2_ENABLE_XMP           "Build with XMP metadata support"         ON )
-option( EXIV2_ENABLE_EXTERNAL_XMP  "Use external version of XMP"            OFF )
-option( EXIV2_ENABLE_PNG           "Build with png support (requires libz)"  ON )
+option( BUILD_SHARED_LIBS          "Build exiv2lib as a shared library"              ON  )
+option( EXIV2_ENABLE_XMP           "Build with XMP metadata support"                 ON  )
+option( EXIV2_ENABLE_EXTERNAL_XMP  "Use external version of XMP"                     OFF )
+option( EXIV2_ENABLE_PNG           "Build with png support (requires libz)"          ON  )
 ...
-option( EXIV2_ENABLE_BMFF          "Build with BMFF support"                 ON )
+option( EXIV2_ENABLE_BMFF          "Build with BMFF support (brotli recommended)"    ON  )
+option( EXIV2_ENABLE_BROTLI        "Use Brotli for JPEG XL compressed boxes (BMFF)"  ON  )
 577 rmills@rmillsmm:~/gnu/github/exiv2/exiv2 $
 ```
 
@@ -267,12 +269,13 @@ $ cmake -DBUILD_SHARED_LIBS=ON -DEXIV2_ENABLE_NLS=OFF
 
 The following Exiv2 features require external libraries:
 
-| Feature                     | Package   |  Default | To change default             | Availability |
-|:--------------------------  |:--------  |:--------:| :---------------------------- |:-----------  |
-| PNG image support           | zlib      | ON       | -DEXIV2\_ENABLE\_PNG=OFF      | [http://zlib.net/](http://zlib.net/) |
-| XMP support                 | expat     | ON       | -DEXIV2\_ENABLE\_XMP=OFF      | [http://expat.sourceforge.net](http://expat.sourceforge.net)/<br/>Use _**Expat 2.2.6**_ and later |
-| Natural language system     | gettext   | OFF      | -DEXIV2\_ENABLE\_NLS=ON       | [http://www.gnu.org/software/gettext/](http://www.gnu.org/software/gettext/) |
-| Character set conversion    | libiconv  |          | Disabled for Visual Studio.<br>Linked when installed on UNIX like platforms.                              | [https://www.gnu.org/software/libiconv/](https://www.gnu.org/software/libiconv/) |
+| Feature                  | Package  | Default | To change default           | Availability |
+|:------------------------ |:-------- |:-------:|:--------------------------- |:------------ |
+| PNG image support        | zlib     | ON      | -DEXIV2\_ENABLE\_PNG=OFF    | [http://zlib.net/](http://zlib.net/) |
+| XMP support              | expat    | ON      | -DEXIV2\_ENABLE\_XMP=OFF    | [http://expat.sourceforge.net](http://expat.sourceforge.net)/<br/>Use _**Expat 2.2.6**_ and later |
+| Natural language system  | gettext  | OFF     | -DEXIV2\_ENABLE\_NLS=ON     | [http://www.gnu.org/software/gettext/](http://www.gnu.org/software/gettext/) |
+| JPEG XL brob support     | brotli   | ON      | -DEXIV2\_ENABLE\_BROTLI=OFF | [https://github.com/google/brotli](https://github.com/google/brotli) |
+| Character set conversion | libiconv |         | Disabled for Visual Studio.<br>Linked when installed on UNIX like platforms. | [https://www.gnu.org/software/libiconv/](https://www.gnu.org/software/libiconv/) |
 
 On UNIX systems, you may install the dependencies using the distribution's package management system. Install the
 development package of a dependency to install the header files and libraries required to build Exiv2. The script
@@ -1214,7 +1217,7 @@ Update your system and install the build tools and dependencies (zlib, expat, gt
 
 ```bash
 $ sudo apt --yes update
-$ sudo apt install --yes build-essential git clang ccache python3 libxml2-utils cmake python3 libexpat1-dev libz-dev zlib1g-dev libssh-dev libcurl4-openssl-dev libgtest-dev google-mock
+$ sudo apt install --yes build-essential git clang ccache python3 libxml2-utils cmake python3 libexpat1-dev libz-dev zlib1g-dev libbrotli-dev libssh-dev libcurl4-openssl-dev libgtest-dev google-mock
 ```
 
 For users of other platforms, the script <exiv2dir>/ci/install_dependencies.sh has code used to configure many platforms.  The code in that file is a useful guide to configuring your platform.
@@ -1247,31 +1250,31 @@ I recommend that you build and install CMake from source.
 
 ## MinGW/msys2
 
-Please note that the platform MinGW/msys2 32 is obsolete and superceded by MinGW/msys2 64. It is important to highlight that we rely on using the Universal C Runtime (UCRT) and its relatively new support for UTF-8. Check this [PR](https://github.com/Exiv2/exiv2/pull/2090) for more information. Therefore you will need to use the [URCT MSYS environment](https://www.msys2.org/docs/environments/).
+Please note that the 32bit MinGW platform is obsolete and superceded by the 64bit MSYS2 distribution. It is important to highlight that we rely on using the Universal C Runtime (UCRT) and its relatively new support for UTF-8. Check this [PR](https://github.com/Exiv2/exiv2/pull/2090) for more information. Therefore you will need to use the [MSYS2 URCT64 environment](https://www.msys2.org/docs/environments/).
 
 Install the latest version of [MSYS2](https://repo.msys2.org/distrib/msys2-x86_64-latest.exe), and follow the installation instructions available [here](https://www.msys2.org/).
 
-The CI workflow file `.github/workflows/on_PR_windows_matrix.yml` has a build job named `msys2` with instructions showing how to configure Exiv2 on MinGW/msys2.
+The CI workflow file `.github/workflows/on_PR_windows_matrix.yml` has a build job named `msys2` with instructions showing how to configure Exiv2 on MSYS2.
 
 ### Install exiv2 Dependencies
 
-Please note that you will need to install the `ucrt` package version of the exiv2 dependencies:
+Please note that you will need to install the `ucrt-x86_64` package version of the exiv2 dependencies:
 
 ```bash
-pacman -S mingw-w64-ucrt-x86_64-binutils mingw-w64-ucrt-x86_64-cmake mingw-w64-ucrt-x86_64-curl mingw-w64-ucrt-x86_64-expat mingw-w64-ucrt-x86_64-gcc mingw-w64-ucrt-x86_64-gettext mingw-w64-ucrt-x86_64-gtest mingw-w64-ucrt-x86_64-libiconv mingw-w64-ucrt-x86_64-make mingw-w64-ucrt-x86_64-zlib
+pacman -S --needed mingw-w64-ucrt-x86_64-{brotli,cc,cmake,curl,expat,gettext,gtest,libiconv,libwinpthread,ninja,zlib}
 ```
 
 ### Download exiv2 from github and build
 
-Use the Windows start menu to open the terminal customized for the UCRT environment: `MSYS2 MinGW UCRT x64`. Then run the following commands to download exiv2, configure the project and build it:
+Use the Windows start menu to open the terminal customized for the UCRT64 environment: `MSYS2 MinGW UCRT x64`. Then run the following commands to download exiv2, configure the project and build it:
 
 ```bash
 mkdir -p ~/gnu/github/exiv2
 cd       ~/gnu/github/exiv2
 git clone https://github.com/exiv2/exiv2
 cd exiv2
 mkdir build && cd build
-cmake -G "MSYS Makefiles" 
+cmake -G Ninja
       -DCMAKE_CXX_FLAGS=-Wno-deprecated
       -DCMAKE_BUILD_TYPE=Release
       -DBUILD_SHARED_LIBS=ON
@@ -1282,10 +1285,10 @@ cmake -G "MSYS Makefiles"
       -DEXIV2_BUILD_UNIT_TESTS=ON
       ..
 
-cmake --build . --parallel
+cmake --build .
 ```
 
-The binaries generated at this point can be executed from the MSYS2 UCRT terminal, but they will not run from a Windows Command Prompt or PowerShell. The reason is that the MSYS2 UCRT terminal is properly configured to find some needed DLLs. In case you want to be able to run the generated **exiv2** binary from any Windows terminal, you'll need to deploy the needed DLLs with the application.
+The binaries generated at this point can be executed from the MSYS2 UCRT64 terminal, but they will not run from a Windows Command Prompt or PowerShell. The reason is that the MSYS2 UCRT64 terminal is properly configured to find some needed DLLs. In case you want to be able to run the generated **exiv2** binary from any Windows terminal, you'll need to deploy the needed DLLs with the application.
 
 [TOC](#TOC)
 <div id="PlatformCygwin">

diff --git a/ci/install_dependencies.sh b/ci/install_dependencies.sh
@@ -23,46 +23,46 @@ debian_build_gtest() {
 # workaround for really bare-bones Archlinux containers:
 if [ -x "$(command -v pacman)" ]; then
     pacman --noconfirm -Sy
-    pacman --noconfirm -S grep gawk sed
+    pacman --noconfirm --needed -S grep gawk sed
 fi
 
 distro_id=$(grep '^ID=' /etc/os-release|awk -F = '{print $2}'|sed 's/\"//g')
 
 case "$distro_id" in
     'fedora')
-        dnf -y --refresh install gcc-c++ clang cmake make expat-devel zlib-devel libssh-devel libcurl-devel gtest-devel which dos2unix glibc-langpack-en diffutils
+        dnf -y --refresh install gcc-c++ clang cmake make expat-devel zlib-devel brotli-devel libssh-devel libcurl-devel gtest-devel which dos2unix glibc-langpack-en diffutils
         ;;
 
     'debian')
         apt-get update
-        apt-get install -y cmake g++ clang make libexpat1-dev zlib1g-dev libssh-dev libcurl4-openssl-dev libgtest-dev libxml2-utils
+        apt-get install -y cmake g++ clang make libexpat1-dev zlib1g-dev libbrotli-dev libssh-dev libcurl4-openssl-dev libgtest-dev libxml2-utils
         debian_build_gtest
         ;;
 
     'arch')
         pacman --noconfirm -Syu
-        pacman --noconfirm -S gcc clang cmake make expat zlib libssh curl gtest dos2unix which diffutils
+        pacman --noconfirm --needed -S gcc clang cmake make expat zlib brotli libssh curl gtest dos2unix which diffutils
         ;;
 
     'ubuntu')
         apt-get update
-        apt-get install -y cmake g++ clang make libexpat1-dev zlib1g-dev libssh-dev libcurl4-openssl-dev libgtest-dev google-mock libxml2-utils
+        apt-get install -y cmake g++ clang make libexpat1-dev zlib1g-dev libbrotli-dev libssh-dev libcurl4-openssl-dev libgtest-dev google-mock libxml2-utils
         debian_build_gtest
         ;;
 
     'alpine')
         apk update
-        apk add gcc g++ clang cmake make expat-dev zlib-dev libssh-dev curl-dev gtest gtest-dev gmock libintl gettext-dev which dos2unix bash libxml2-utils diffutils 
+        apk add gcc g++ clang cmake make expat-dev zlib-dev brotli-dev libssh-dev curl-dev gtest gtest-dev gmock libintl gettext-dev which dos2unix bash libxml2-utils diffutils 
         ;;
 
     'centos'|'rhel')
         dnf clean all
-        dnf -y install gcc-c++ clang cmake make expat-devel zlib-devel libssh-devel libcurl-devel which dos2unix
+        dnf -y install gcc-c++ clang cmake make expat-devel zlib-devel brotli-devel libssh-devel libcurl-devel which dos2unix
         ;;
 
     'opensuse-tumbleweed')
         zypper --non-interactive refresh
-        zypper --non-interactive install gcc-c++ clang cmake make libexpat-devel zlib-devel libssh-devel curl libcurl-devel git which dos2unix libxml2-tools
+        zypper --non-interactive install gcc-c++ clang cmake make libexpat-devel zlib-devel libbrotli-devel libssh-devel curl libcurl-devel git which dos2unix libxml2-tools
         pushd /tmp
           curl -LO https://github.com/google/googletest/archive/release-1.8.0.tar.gz
           tar xzf   release-1.8.0.tar.gz

diff --git a/cmake/FindBrotli.cmake b/cmake/FindBrotli.cmake
@@ -0,0 +1,45 @@
+#***************************************************************************
+#                                  _   _ ____  _
+#  Project                     ___| | | |  _ \| |
+#                             / __| | | | |_) | |
+#                            | (__| |_| |  _ <| |___
+#                             \___|\___/|_| \_\_____|
+#
+# Copyright (C) 1998 - 2020, Daniel Stenberg, <[email protected]>, et al.
+#
+# This software is licensed as described in the file COPYING, which
+# you should have received as part of this distribution. The terms
+# are also available at https://curl.se/docs/copyright.html.
+#
+# You may opt to use, copy, modify, merge, publish, distribute and/or sell
+# copies of the Software, and permit persons to whom the Software is
+# furnished to do so, under the terms of the COPYING file.
+#
+# This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
+# KIND, either express or implied.
+#
+###########################################################################
+include(FindPackageHandleStandardArgs)
+
+find_path(BROTLI_INCLUDE_DIR "brotli/decode.h")
+
+find_library(BROTLICOMMON_LIBRARY NAMES brotlicommon)
+find_library(BROTLIDEC_LIBRARY NAMES brotlidec)
+
+find_package_handle_standard_args(Brotli
+    FOUND_VAR
+      BROTLI_FOUND
+    REQUIRED_VARS
+      BROTLIDEC_LIBRARY
+      BROTLICOMMON_LIBRARY
+      BROTLI_INCLUDE_DIR
+    FAIL_MESSAGE
+      "Could NOT find Brotli"
+)
+
+set(Brotli_INCLUDE_DIRS ${BROTLI_INCLUDE_DIR})
+set(Brotli_LIBRARIES ${BROTLICOMMON_LIBRARY} ${BROTLIDEC_LIBRARY})
+
+mark_as_advanced(BROTLI_INCLUDE_DIR)
+mark_as_advanced(BROTLICOMMON_LIBRARY)
+mark_as_advanced(BROTLIDEC_LIBRARY)
diff --git a/cmake/config.h.cmake b/cmake/config.h.cmake
@@ -47,9 +47,12 @@
 // Define if you have the <sys/mman.h> header file.
 #cmakedefine EXV_HAVE_SYS_MMAN_H
 
-// Define if you have are using the zlib library.
+// Define if you have the zlib library.
 #cmakedefine EXV_HAVE_LIBZ
 
+// Define if you have the brotli library.
+#cmakedefine EXV_HAVE_BROTLI
+
 /* Define if you have (Exiv2/xmpsdk) Adobe XMP Toolkit. */
 #cmakedefine EXV_HAVE_XMP_TOOLKIT
 

diff --git a/cmake/findDependencies.cmake b/cmake/findDependencies.cmake
@@ -1,22 +1,20 @@
-set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/")
-
 if (CONAN_AUTO_INSTALL)
-  # Download automatically the cmake-conan integration file
-  if(NOT EXISTS "${CMAKE_BINARY_DIR}/conan.cmake")
-     message(STATUS "Downloading conan.cmake from https://github.com/conan-io/cmake-conan")
-     file(DOWNLOAD "https://raw.githubusercontent.com/conan-io/cmake-conan/master/conan.cmake"
-                    "${CMAKE_BINARY_DIR}/conan.cmake"
-                    TLS_VERIFY ON)
-  endif()
+    # Download automatically the cmake-conan integration file
+    if(NOT EXISTS "${CMAKE_BINARY_DIR}/conan.cmake")
+        message(STATUS "Downloading conan.cmake from https://github.com/conan-io/cmake-conan")
+        file(DOWNLOAD "https://raw.githubusercontent.com/conan-io/cmake-conan/master/conan.cmake"
+                      "${CMAKE_BINARY_DIR}/conan.cmake"
+                      TLS_VERIFY ON)
+    endif()
 
-  include(${CMAKE_BINARY_DIR}/conan.cmake)
+    include(${CMAKE_BINARY_DIR}/conan.cmake)
 
-  conan_cmake_autodetect(settings)
-  conan_cmake_install(PATH_OR_REFERENCE ..
-                      BUILD missing
-                      REMOTE conancenter
-                      OPTIONS webready=True
-                      SETTINGS ${settings})
+    conan_cmake_autodetect(settings)
+    conan_cmake_install(PATH_OR_REFERENCE ..
+                        BUILD missing
+                        REMOTE conancenter
+                        OPTIONS webready=True
+                        SETTINGS ${settings})
 endif()
 
 if (APPLE)
@@ -30,6 +28,8 @@ else()
     list(APPEND CMAKE_PREFIX_PATH ${CMAKE_BINARY_DIR})
 endif()
 
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake/")
+
 find_package (Python3 COMPONENTS Interpreter)
 if (NOT Python3_Interpreter_FOUND)
     message(WARNING "Python3 was not found. Python tests under the 'tests' folder will not be executed")
@@ -39,13 +39,17 @@ find_package(Filesystem REQUIRED)
 
 # don't use Frameworks on the Mac (#966)
 if (APPLE)
-     set(CMAKE_FIND_FRAMEWORK NEVER)
+    set(CMAKE_FIND_FRAMEWORK NEVER)
 endif()
 
 if( EXIV2_ENABLE_PNG )
     find_package( ZLIB REQUIRED )
 endif( )
 
+if( EXIV2_ENABLE_BMFF AND EXIV2_ENABLE_BROTLI )
+    find_package( Brotli REQUIRED )
+endif( )
+
 if( EXIV2_ENABLE_WEBREADY )
     if( EXIV2_ENABLE_CURL )
         find_package(CURL REQUIRED)
@@ -68,8 +72,8 @@ endif( )
 
 find_package(Iconv)
 if( ICONV_FOUND )
-    message ( "-- ICONV_INCLUDE_DIR : " ${Iconv_INCLUDE_DIR} )
-    message ( "-- ICONV_LIBRARIES : " ${Iconv_LIBRARY} )
+    message ( "-- Iconv_INCLUDE_DIRS : " ${Iconv_INCLUDE_DIRS} )
+    message ( "-- Iconv_LIBRARIES : " ${Iconv_LIBRARIES} )
 endif()
 
 if( BUILD_WITH_CCACHE )
@@ -80,4 +84,3 @@ if( BUILD_WITH_CCACHE )
         set_property(GLOBAL PROPERTY RULE_LAUNCH_LINK ccache)
     endif()
 endif()
-
diff --git a/cmake/generateConfigFile.cmake b/cmake/generateConfigFile.cmake
@@ -20,6 +20,7 @@ else()
 endif()
 set(EXV_HAVE_ICONV       ${ICONV_FOUND})
 set(EXV_HAVE_LIBZ        ${ZLIB_FOUND})
+set(EXV_HAVE_BROTLI      ${BROTLI_FOUND})
 
 check_cxx_symbol_exists(mmap        sys/mman.h     EXV_HAVE_MMAP )
 check_cxx_symbol_exists(munmap      sys/mman.h     EXV_HAVE_MUNMAP )