Add HT-JP2K plugin

Author: payno

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "lib/h5z-htj2k"]
+	path = lib/h5z-htj2k
+	url = https://github.com/silx-kit/h5z-htj2k

CHANGELOG.rst

@@ -1,3 +1,8 @@
+Unreleased
+----------
+
+This release add the new plugin `h5z-htj2k`.
+
 7.0.0: 25/06/2026
 -----------------
 

doc/information.rst

@@ -84,6 +84,7 @@ HDF5 compression filters and compression libraries sources were obtained from:
 * `HDF5-ZFP plugin <https://github.com/LLNL/H5Z-ZFP>`_ (v1.1.1) using ZFP.
 * `ZStd plugin <https://github.com/HDFGroup/hdf5_plugins/tree/master/ZSTD>`_
   (commit `5573db8 <https://github.com/HDFGroup/hdf5_plugins/tree/5573db8f9706e1df262752a9247e90a3d4bd57bd/ZSTD>`_) using ZStd.
+* `ZhtJ2k plugin <https://github.com/silx-kit/h5z-htj2k>` (v x.x.x) using `High-Trhoughput JPEG 2000 <https://jpeg.org/jpeg2000/htj2k.html>`
 
 Sources of compression libraries shared accross multiple filters were obtained from:
 
@@ -112,12 +113,14 @@ Please read the different licenses:
   * blosc: `lib/hdf5-blosc/LICENSES/ <https://github.com/silx-kit/hdf5plugin/blob/main/lib/hdf5-blosc/LICENSES/>`_, `lib/c-blosc/LICENSES/ <https://github.com/silx-kit/hdf5plugin/blob/main/lib/c-blosc/LICENSES/>`_
   * blosc2: `lib/PyTables/LICENSE.txt <https://github.com/silx-kit/hdf5plugin/blob/main/lib/PyTables/LICENSE.txt>`_  and `lib/c-blosc2/LICENSES/ <https://github.com/silx-kit/hdf5plugin/blob/main/lib/c-blosc2/LICENSES/>`_
   * bzip2: `lib/PyTables/LICENSE.txt <https://github.com/silx-kit/hdf5plugin/blob/main/lib/PyTables/LICENSE.txt>`_ and `lib/bzip2/LICENSE <https://github.com/silx-kit/hdf5plugin/blob/main/lib/bzip2/LICENSE>`_
+  * ht-jp2k: `lib/ <https://jpeg.org/jpeg2000/htj2k.html>`
   * lz4: `lib/LZ4/COPYING <https://github.com/silx-kit/hdf5plugin/blob/main/lib/LZ4/COPYING>`_, `lib/LZ4/LICENSE <https://github.com/silx-kit/hdf5plugin/blob/main/lib/LZ4/LICENSE>`_
   * FCIDECOMP: `lib/fcidecomp/LICENSE <https://github.com/silx-kit/hdf5plugin/blob/main/lib/fcidecomp/LICENSE>`_ and `lib/charls/LICENSE.md  <https://github.com/silx-kit/hdf5plugin/blob/main/lib/charls/LICENSE.md>`_
   * SPERR: `lib/H5Z-SPERR/LICENSE <https://github.com/silx-kit/hdf5plugin/blob/main/lib/H5Z-SPERR/LICENSE>`_ and `lib/SPERR/LICENSE <https://github.com/silx-kit/hdf5plugin/blob/main/lib/SPERR/LICENSE>`_
   * SZ: `lib/SZ/copyright-and-BSD-license.txt <https://github.com/silx-kit/hdf5plugin/blob/main/lib/SZ/copyright-and-BSD-license.txt>`_
   * SZ3: `lib/SZ3/copyright-and-BSD-license.txt <https://github.com/silx-kit/hdf5plugin/blob/main/lib/SZ3/copyright-and-BSD-license.txt>`_
   * zfp: `lib/H5Z-ZFP/LICENSE <https://github.com/silx-kit/hdf5plugin/blob/main/lib/H5Z-ZFP/LICENSE>`_
+  * htj2k: `lib/h5z-htj2k/LICENSE <https://github.com/silx-kit/hdf5plugin/blob/main/lib/H5Z-HT-JP2K/LICENSE>`_
   * zstd: `lib/HDF5Plugin-Zstandard/LICENSE <https://github.com/silx-kit/hdf5plugin/blob/main/lib/HDF5Plugin-Zstandard/LICENSE>`_
 
 * Shared compression libraries:

lib/h5z-htj2k

@@ -1395,6 +1395,26 @@ def _get_h5zfp_plugin():
     )
 
 
+PLUGIN_LIB_DEPENDENCIES["htj2k"] = ()
+
+
+def _get_h5z_htj2k_plugin():
+    """H5Z-htj2k plugin build config"""
+    h5z_htj2k_dir = "lib/h5z-htj2k"
+    openjph_include_dir = f"{h5z_htj2k_dir}/vendored/OpenJPH/src/core/openjph"
+
+    extra_compile_args = ["-O3", "-std=c++17"]
+    extra_compile_args += ["/Ox", "/std:c++17"]
+
+    return HDF5PluginExtension(
+        "hdf5plugin.plugins.libh5htj2k",
+        sources=glob(f"{h5z_htj2k_dir}/*.c") + glob(f"{h5z_htj2k_dir}/*.cpp"),
+        include_dirs=[h5z_htj2k_dir, openjph_include_dir],
+        extra_compile_args=extra_compile_args,
+        language="c++",
+    )
+
+
 PLUGIN_LIB_DEPENDENCIES["zfp"] = ("zfp",)
 
 
@@ -1497,6 +1517,7 @@ def _get_sperr_plugin():
     "bshuf": _get_bitshuffle_plugin,
     "bzip2": _get_bzip2_plugin,
     "fcidecomp": _get_fcidecomp_plugin,
+    "htj2k": _get_h5z_htj2k_plugin,
     "lz4": _get_lz4_plugin,
     "sperr": _get_sperr_plugin,
     "sz": _get_sz_plugin,

setup.py

@@ -42,6 +42,7 @@
     SZ3_ID,
     SZ_ID,
     ZFP_ID,
+    ZHT_JP2K_ID,
     ZSTD_ID,
     Bitshuffle,
     Blosc,
@@ -50,6 +51,7 @@
     FciDecomp,
     Sperr,
     Zfp,
+    Zhtj2k,
     Zstd,
 )
 from ._utils import (  # noqa
@@ -73,6 +75,7 @@
     "SZ",
     "SZ3",
     "Zfp",
+    "Zhtj2k",
     "Zstd",
     # Utilities
     "FILTERS",

src/hdf5plugin/__init__.py

@@ -55,6 +55,9 @@
 ZFP_ID = 32013
 """ZFP filter ID"""
 
+ZHT_JP2K_ID = 32033
+"""High troughput JPEG 2000"""
+
 ZSTD_ID = 32015
 """Zstandard filter ID"""
 
@@ -808,6 +811,15 @@ def _from_filter_options(cls, filter_options: tuple[int, ...]) -> Zfp:
         return cls(minbits=minbits, maxbits=maxbits, maxprec=maxprec, minexp=minexp)
 
 
+class Zhtj2k(FilterBase):
+    """
+    At the moment this filter only allows **reading** of compressed dataset.
+    """
+
+    filter_name = "htj2k"
+    filter_id = ZHT_JP2K_ID
+
+
 class Sperr(FilterBase):
     """``h5py.Group.create_dataset``'s compression arguments for using SPERR filter.
 
@@ -1337,6 +1349,7 @@ def _from_filter_options(cls, filter_options: tuple[int, ...]) -> Zstd:
     SZ,
     SZ3,
     Zfp,
+    Zhtj2k,
     Zstd,
 )
 

src/hdf5plugin/_filters.py

@@ -69,6 +69,7 @@ def should_test(filter_name: str) -> bool:
     "sz": hdf5plugin.SZ,
     "sz3": hdf5plugin.SZ3,
     "zfp": hdf5plugin.Zfp,
+    "zht-jp2k": hdf5plugin.Zhtj2k,
     "zstd": hdf5plugin.Zstd,
 }
 

src/hdf5plugin/test.py

@@ -144,6 +144,25 @@ def testZfp(self):
                 numpy.allclose(original, compressed), "Values should be close"
             )
 
+    @unittest.skipUnless(
+        h5py.h5z.filter_avail(hdf5plugin.ZHT_JP2K_ID), "HT-JP2K filter not available"
+    )
+    def testHtJp2k(self):
+        """Test writing and reading back HT-JP2K compressed data (lossless)"""
+        original = numpy.arange(100, dtype=numpy.uint16)
+        with self.subTest(dtype=original.dtype, shape=original.shape):
+            fname = os.path.join(self.tempdir, "ht_jp2k.h5")
+            with h5py.File(fname, "w") as h5:
+                h5.create_dataset(
+                    "data",
+                    data=original,
+                    chunks=original.shape,
+                    compression=hdf5plugin.Zhtj2k(),
+                )
+            with h5py.File(fname, "r") as h5:
+                result = h5["data"][()]
+            numpy.testing.assert_array_equal(result, original)
+
     @unittest.skipUnless(
         h5py.h5z.filter_avail(hdf5plugin.SPERR_ID), "Sperr filter not available"
     )