Add HTJ2K Compressor (#1883)

* Add HT256 compressor

Signed-off-by: Pierre-Anthony Lemieux <[email protected]>

* Update src/lib/OpenEXR/ImfCompression.h

Co-authored-by: Cary Phillips <[email protected]>
Signed-off-by: Pierre-Anthony Lemieux <[email protected]>
Signed-off-by: Pierre-Anthony Lemieux <[email protected]>

* Update src/lib/OpenEXR/ImfCompression.cpp

Co-authored-by: Cary Phillips <[email protected]>
Signed-off-by: Pierre-Anthony Lemieux <[email protected]>
Signed-off-by: Pierre-Anthony Lemieux <[email protected]>

* Update website/ReadingAndWritingImageFiles.rst

Co-authored-by: Cary Phillips <[email protected]>
Signed-off-by: Pierre-Anthony Lemieux <[email protected]>
Signed-off-by: Pierre-Anthony Lemieux <[email protected]>

* Add channel map

Signed-off-by: Pierre-Anthony Lemieux <[email protected]>

---------

Signed-off-by: Pierre-Anthony Lemieux <[email protected]>
Signed-off-by: Pierre-Anthony Lemieux <[email protected]>
Co-authored-by: Cary Phillips <[email protected]>

Author: palemieux

.github/workflows/ci_steps.yml

@@ -47,6 +47,8 @@ on:
         type: string
       OPENEXR_FORCE_INTERNAL_DEFLATE:
         type: string
+      OPENEXR_FORCE_INTERNAL_OPENJPH:
+        type: string
       BUILD_TESTING:
         type: string
       namespace:
@@ -84,6 +86,12 @@ jobs:
         run: share/ci/scripts/install_libdeflate.sh master
         shell: bash
 
+      - name: Install OpenJPH
+        # Pre-install OpenJPH so the builds validate finding the external installation
+        if: ${{ inputs.OPENEXR_FORCE_INTERNAL_OPENJPH == 'OFF' }}
+        run: share/ci/scripts/install_openjph.sh master
+        shell: bash
+
       - name: Install help2man
         # TODO: this could go in the ASWF Linux docker
         # container. Also, it doesn't currently work for Windows, so
@@ -113,6 +121,7 @@ jobs:
                 -DOPENEXR_BUILD_TOOLS=${{ inputs.OPENEXR_BUILD_TOOLS }} \
                 -DOPENEXR_FORCE_INTERNAL_IMATH=${{ inputs.OPENEXR_FORCE_INTERNAL_IMATH }} \
                 -DOPENEXR_FORCE_INTERNAL_DEFLATE=${{ inputs.OPENEXR_FORCE_INTERNAL_DEFLATE }} \
+                -DOPENEXR_FORCE_INTERNAL_OPENJPH=${{ inputs.OPENEXR_FORCE_INTERNAL_OPENJPH }} \
                 -DBUILD_TESTING=${{ inputs.BUILD_TESTING }} \
                 -DOPENEXR_RUN_FUZZ_TESTS=OFF \
                 -DCMAKE_VERBOSE_MAKEFILE=ON"
@@ -170,7 +179,7 @@ jobs:
         # When building against external Imath/libdeflate shared objects, the tests need PATH to include the dll's.
         if: contains(inputs.os, 'windows')
         run: |
-          echo "$PATH;C:/Program Files (x86)/Imath/bin;C:/Program Files (x86)/Imath/lib;C:/Program Files (x86)/libdeflate/bin;C:/Program Files (x86)/libdeflate/lib" >> $GITHUB_PATH
+          echo "$PATH;C:/Program Files (x86)/openjph/lib/;C:/Program Files (x86)/openjph/bin;C:/Program Files (x86)/Imath/bin;C:/Program Files (x86)/Imath/lib;C:/Program Files (x86)/libdeflate/bin;C:/Program Files (x86)/libdeflate/lib" >> $GITHUB_PATH
         shell: bash
 
       - name: Test

.github/workflows/ci_workflow.yml

@@ -77,6 +77,7 @@ jobs:
       OPENEXR_BUILD_TOOLS: ${{ matrix.OPENEXR_BUILD_TOOLS || 'ON' }}
       OPENEXR_FORCE_INTERNAL_IMATH: ${{ matrix.OPENEXR_FORCE_INTERNAL_IMATH || 'OFF' }}
       OPENEXR_FORCE_INTERNAL_DEFLATE: ${{ matrix.OPENEXR_FORCE_INTERNAL_DEFLATE || 'OFF' }}
+      OPENEXR_FORCE_INTERNAL_OPENJPH: ${{ matrix.OPENEXR_FORCE_INTERNAL_OPENJPH || 'OFF' }}
       BUILD_TESTING: ${{ matrix.BUILD_TESTING || 'ON' }}
       namespace: ${{ matrix.namespace }}
       validate_install: ${{ matrix.validate_install || 'ON' }}
@@ -107,6 +108,7 @@ jobs:
             OPENEXR_BUILD_TOOLS: 'OFF'
             OPENEXR_FORCE_INTERNAL_IMATH: 'ON'
             OPENEXR_FORCE_INTERNAL_DEFLATE: 'ON'
+            OPENEXR_FORCE_INTERNAL_OPENJPH: 'ON'
             BUILD_TESTING: 'OFF'
 
           - build: 6
@@ -141,6 +143,7 @@ jobs:
       OPENEXR_BUILD_TOOLS: ${{ matrix.OPENEXR_BUILD_TOOLS || 'ON' }}
       OPENEXR_FORCE_INTERNAL_IMATH: ${{ matrix.OPENEXR_FORCE_INTERNAL_IMATH || 'OFF' }}
       OPENEXR_FORCE_INTERNAL_DEFLATE: ${{ matrix.OPENEXR_FORCE_INTERNAL_DEFLATE || 'OFF' }}
+      OPENEXR_FORCE_INTERNAL_OPENJPH: ${{ matrix.OPENEXR_FORCE_INTERNAL_OPENJPH || 'OFF' }}
       BUILD_TESTING: ${{ matrix.BUILD_TESTING || 'ON' }}
       validate_install: ${{ matrix.validate_install || 'ON' }}
     strategy:
@@ -170,6 +173,7 @@ jobs:
             OPENEXR_BUILD_TOOLS: 'OFF'
             OPENEXR_FORCE_INTERNAL_IMATH: 'ON'
             OPENEXR_FORCE_INTERNAL_DEFLATE: 'ON'
+            OPENEXR_FORCE_INTERNAL_OPENJPH: 'ON'
             BUILD_TESTING: 'OFF'
 
           - build: 6
@@ -195,6 +199,7 @@ jobs:
       OPENEXR_BUILD_TOOLS: ${{ matrix.OPENEXR_BUILD_TOOLS || 'ON' }}
       OPENEXR_FORCE_INTERNAL_IMATH: ${{ matrix.OPENEXR_FORCE_INTERNAL_IMATH || 'OFF' }}
       OPENEXR_FORCE_INTERNAL_DEFLATE: ${{ matrix.OPENEXR_FORCE_INTERNAL_DEFLATE || 'OFF' }}
+      OPENEXR_FORCE_INTERNAL_OPENJPH: ${{ matrix.OPENEXR_FORCE_INTERNAL_OPENJPH || 'OFF' }}
       BUILD_TESTING: ${{ matrix.BUILD_TESTING || 'ON' }}
       validate_install: ${{ matrix.validate_install || 'ON' }}
     strategy:
@@ -224,6 +229,7 @@ jobs:
             OPENEXR_BUILD_TOOLS: 'OFF'
             OPENEXR_FORCE_INTERNAL_IMATH: 'ON'
             OPENEXR_FORCE_INTERNAL_DEFLATE: 'ON'
+            OPENEXR_FORCE_INTERNAL_OPENJPH: 'ON'
             BUILD_TESTING: 'OFF'
 
           - build: 6

.github/workflows/ossfuzz_workflow.yml

@@ -48,7 +48,7 @@ jobs:
         dry-run: false
         language: c++
     - name: Upload Crash
-      uses: actions/upload-artifact@ff15f0306b3f739f7b6fd43fb5d26cd321bd4de5 # v3.2.1
+      uses: actions/upload-artifact@v4
       if: failure() && steps.build.outcome == 'success'
       with:
         name: artifacts

.github/workflows/python-wheels-publish-test.yml

@@ -64,7 +64,7 @@ jobs:
           CIBW_ENVIRONMENT: OPENEXR_RELEASE_CANDIDATE_TAG="${{ github.ref_name }}"
 
       - name: Upload artifact
-        uses: actions/upload-artifact@ff15f0306b3f739f7b6fd43fb5d26cd321bd4de5 # v3.2.1
+        uses: actions/upload-artifact@v4
         with:
           name: wheels-${{ matrix.os }}
           path: |

.github/workflows/python-wheels-publish.yml

@@ -57,7 +57,7 @@ jobs:
           CIBW_TEST_SKIP: "*arm64"
 
       - name: Upload artifact
-        uses: actions/upload-artifact@ff15f0306b3f739f7b6fd43fb5d26cd321bd4de5 # v3.2.1
+        uses: actions/upload-artifact@v4
         with:
           name: wheels-${{ matrix.os }}
           path: |

.github/workflows/python-wheels.yml

@@ -70,9 +70,9 @@ jobs:
           OPENEXR_TEST_IMAGE_REPO: "https://raw.githubusercontent.com/AcademySoftwareFoundation/openexr-images/main"
 
       - name: Upload artifact
-        uses: actions/upload-artifact@ff15f0306b3f739f7b6fd43fb5d26cd321bd4de5 # v3.2.1
+        uses: actions/upload-artifact@v4
         with:
           name: wheels-${{ matrix.os }}
           path: |
             ./wheelhouse/*.whl
-            ./wheelhouse/*.tar.gz
+            ./wheelhouse/*.tar.gz

.github/workflows/scorecard.yml

@@ -43,7 +43,7 @@ jobs:
 
       # Upload the results as artifacts (optional)
       - name: "Upload artifact"
-        uses: actions/upload-artifact@ff15f0306b3f739f7b6fd43fb5d26cd321bd4de5 # v3.2.1
+        uses: actions/upload-artifact@v4
         with:
           name: SARIF file
           path: results.sarif

BUILD.bazel

@@ -189,6 +189,9 @@ cc_library(
         "src/lib/OpenEXRCore/internal_dwa_simd.h",
         "src/lib/OpenEXRCore/internal_file.h",
         "src/lib/OpenEXRCore/internal_float_vector.h",
+        "src/lib/OpenEXRCore/internal_ht.cpp",
+        "src/lib/OpenEXRCore/internal_ht_common.h",
+        "src/lib/OpenEXRCore/internal_ht_common.cpp",
         "src/lib/OpenEXRCore/internal_huf.c",
         "src/lib/OpenEXRCore/internal_huf.h",
         "src/lib/OpenEXRCore/internal_memory.h",
@@ -262,6 +265,7 @@ cc_library(
     visibility = ["//visibility:public"],
     deps = [
         "@imath",
+        "@openjph",
         "@libdeflate//:deflate",
     ],
 )
@@ -308,6 +312,7 @@ cc_library(
         "src/lib/OpenEXR/ImfGenericInputFile.cpp",
         "src/lib/OpenEXR/ImfGenericOutputFile.cpp",
         "src/lib/OpenEXR/ImfHeader.cpp",
+        "src/lib/OpenEXR/ImfHTCompressor.cpp",
         "src/lib/OpenEXR/ImfHuf.cpp",
         "src/lib/OpenEXR/ImfIDManifest.cpp",
         "src/lib/OpenEXR/ImfIDManifestAttribute.cpp",
@@ -413,6 +418,7 @@ cc_library(
         "src/lib/OpenEXR/ImfGenericInputFile.h",
         "src/lib/OpenEXR/ImfGenericOutputFile.h",
         "src/lib/OpenEXR/ImfHeader.h",
+        "src/lib/OpenEXR/ImfHTCompressor.h",
         "src/lib/OpenEXR/ImfHuf.h",
         "src/lib/OpenEXR/ImfIDManifest.h",
         "src/lib/OpenEXR/ImfIDManifestAttribute.h",
@@ -504,6 +510,7 @@ cc_library(
         ":IlmThread",
         ":OpenEXRCore",
         "@imath",
+        "@openjph"
     ],
 )
 

MODULE.bazel

@@ -8,6 +8,7 @@ module(
 
 bazel_dep(name = "bazel_skylib", version = "1.7.1")
 bazel_dep(name = "imath")
+bazel_dep(name = "openjph")
 bazel_dep(name = "libdeflate")
 bazel_dep(name = "platforms", version = "0.0.10")
 
@@ -30,3 +31,13 @@ archive_override(
     strip_prefix = "libdeflate-master",
     urls = ["https://github.com/ebiggers/libdeflate/archive/refs/heads/master.zip"],
 )
+
+archive_override(
+    module_name = "openjph",
+    patches = [
+        "//bazel:openjph_add_build_file.patch",
+        "//bazel:openjph_module_dot_bazel.patch",
+    ],
+    strip_prefix = "OpenJPH-add-export",
+    urls = ["https://github.com/palemieux/OpenJPH/archive/refs/heads/add-export.zip"],
+)

bazel/openjph_add_build_file.patch

@@ -0,0 +1,119 @@
+--- /dev/null
++++ BUILD.bazel
+@@ -0,0 +1,116 @@
++load("@rules_cc//cc:defs.bzl", "cc_binary", "cc_library")
++load("@rules_license//rules:license.bzl", "license")
++
++package(
++    default_applicable_licenses = [":license"],
++)
++
++exports_files([
++    "LICENSE",
++])
++
++license(
++    name = "license",
++    license_kinds = ["@rules_license//licenses/spdx:BSD-2-Clause"],
++    license_text = "LICENSE",
++)
++
++cc_binary(
++    name = "ojph_compress",
++    srcs = ["src/apps/ojph_compress/ojph_compress.cpp"],
++    visibility = ["//visibility:public"],
++    deps = [":ojph_expand"],
++)
++
++cc_library(
++    name = "ojph_expand",
++    srcs = [
++        "src/apps/ojph_expand/ojph_expand.cpp",
++        "src/apps/others/ojph_img_io.cpp",
++    ],
++    hdrs = [
++        "src/apps/common/ojph_img_io.h",
++    ],
++    includes = [
++        "src/apps/common",
++    ],
++    visibility = ["//visibility:public"],
++    deps = [":openjph"],
++)
++
++cc_library(
++    name = "openjph",
++    srcs = [
++        "src/core/codestream/ojph_bitbuffer_read.h",
++        "src/core/codestream/ojph_bitbuffer_write.h",
++        "src/core/codestream/ojph_codeblock.cpp",
++        "src/core/codestream/ojph_codeblock.h",
++        "src/core/codestream/ojph_codeblock_fun.cpp",
++        "src/core/codestream/ojph_codeblock_fun.h",
++        "src/core/codestream/ojph_codestream.cpp",
++        "src/core/codestream/ojph_codestream_gen.cpp",
++        "src/core/codestream/ojph_codestream_local.cpp",
++        "src/core/codestream/ojph_codestream_local.h",
++        "src/core/codestream/ojph_params.cpp",
++        "src/core/codestream/ojph_params_local.h",
++        "src/core/codestream/ojph_precinct.cpp",
++        "src/core/codestream/ojph_precinct.h",
++        "src/core/codestream/ojph_resolution.cpp",
++        "src/core/codestream/ojph_resolution.h",
++        "src/core/codestream/ojph_subband.cpp",
++        "src/core/codestream/ojph_subband.h",
++        "src/core/codestream/ojph_tile.cpp",
++        "src/core/codestream/ojph_tile.h",
++        "src/core/codestream/ojph_tile_comp.cpp",
++        "src/core/codestream/ojph_tile_comp.h",
++        "src/core/coding/ojph_block_common.cpp",
++        "src/core/coding/ojph_block_common.h",
++        "src/core/coding/ojph_block_decoder.h",
++        "src/core/coding/ojph_block_decoder32.cpp",
++        "src/core/coding/ojph_block_decoder64.cpp",
++        "src/core/coding/ojph_block_encoder.cpp",
++        "src/core/coding/ojph_block_encoder.h",
++        "src/core/coding/table0.h",
++        "src/core/coding/table1.h",
++        "src/core/common/ojph_arch.h",
++        "src/core/common/ojph_base.h",
++        "src/core/common/ojph_codestream.h",
++        "src/core/common/ojph_defs.h",
++        "src/core/common/ojph_file.h",
++        "src/core/common/ojph_message.h",
++        "src/core/common/ojph_params.h",
++        "src/core/common/ojph_version.h",
++        "src/core/others/ojph_arch.cpp",
++        "src/core/others/ojph_file.cpp",
++        "src/core/others/ojph_mem.cpp",
++        "src/core/others/ojph_message.cpp",
++        "src/core/transform/ojph_colour.cpp",
++        "src/core/transform/ojph_colour.h",
++        "src/core/transform/ojph_colour_local.h",
++        "src/core/transform/ojph_transform.cpp",
++        "src/core/transform/ojph_transform.h",
++        "src/core/transform/ojph_transform_local.h",
++    ],
++    hdrs = [
++        "src/core/common/ojph_arg.h",
++        "src/core/common/ojph_mem.h",
++    ],
++    defines = [
++        "OJPH_DISABLE_SIMD",
++        #"OJPH_DISABLE_SSE2",
++        #"OJPH_DISABLE_SSSE3",
++        #"OJPH_DISABLE_SSE4",
++        #"OJPH_DISABLE_AVX",
++        #"OJPH_DISABLE_AVX2",
++        #"OJPH_DISABLE_AVX512",
++        #"OJPH_DISABLE_NEON",
++    ],
++    includes = [
++        "src/core/codestream",
++        "src/core/coding",
++        "src/core/common",
++        "src/core/others",
++        "src/core/transform",
++    ],
++    visibility = ["//visibility:public"],
++)