Add support for UltraHDR images

Author: kleisauke

CHANGELOG.md

@@ -12,6 +12,11 @@ Uses libvips v8.18.0-rc2, compiled with Emscripten v4.0.21.
 
 - Support all typed array variants in `Image.newFromMemory()` and
   `image.writeToMemory()`.
+- Support for UltraHDR images.
+- Add `image.gainmap` property to retrieve the gainmap from
+  Ultra HDR images.
+- Add `image.setImage()` method to attach an image as metadata.
+- Add `vips.Utils.typeFromName()` helper.
 
 ### Changed
 

THIRD-PARTY-NOTICES.md

@@ -21,6 +21,7 @@ used under the terms of the following licences:
 | libnsgif      | MIT Licence                                                                                               |
 | libpng        | [libpng License](https://github.com/pnggroup/libpng/blob/master/LICENSE)                                  |
 | libtiff       | [libtiff License](https://gitlab.com/libtiff/libtiff/blob/master/LICENSE.md) (BSD-like)                   |
+| libultrahdr   | Apache-2.0 License                                                                                        |
 | libvips       | LGPLv3                                                                                                    |
 | libwebp       | New BSD License                                                                                           |
 | mozjpeg       | [zlib License, IJG License, BSD-3-Clause](https://github.com/mozilla/mozjpeg/blob/master/LICENSE.md)      |

build.sh

@@ -51,6 +51,9 @@ LTO=false
 # Dynamic loadable modules, enabled by default
 MODULES=true
 
+# Support for UltraHDR images, enabled by default
+UHDR=true
+
 # Support for JPEG XL images, enabled by default
 JXL=true
 
@@ -78,6 +81,7 @@ while [ $# -gt 0 ]; do
       ;;
     --disable-simd) SIMD=false ;;
     --disable-wasm-bigint) WASM_BIGINT=false ;;
+    --disable-uhdr) UHDR=false ;;
     --disable-jxl) JXL=false ;;
     --disable-avif) AVIF=false ;;
     --disable-svg) SVG=false ;;
@@ -91,7 +95,7 @@ while [ $# -gt 0 ]; do
 done
 
 # Configure the ENABLE_* and DISABLE_* expansion helpers
-for arg in SIMD JXL AVIF SVG MODULES BINDINGS; do
+for arg in SIMD UHDR JXL AVIF SVG MODULES BINDINGS; do
   if [ "${!arg}" = "true" ]; then
     declare ENABLE_$arg=true
   else
@@ -178,6 +182,7 @@ VERSION_LCMS2=2.17          # https://github.com/mm2/Little-CMS
 VERSION_HWY=1.3.0           # https://github.com/google/highway
 VERSION_BROTLI=1.2.0        # https://github.com/google/brotli
 VERSION_MOZJPEG=0826579     # https://github.com/mozilla/mozjpeg
+VERSION_UHDR=1.4.0          # https://github.com/google/libultrahdr
 VERSION_JXL=0.11.1          # https://github.com/libjxl/libjxl
 VERSION_PNG=1.6.52          # https://github.com/pnggroup/libpng
 VERSION_IMAGEQUANT=2.4.1    # https://github.com/lovell/libimagequant
@@ -210,6 +215,7 @@ VERSION_EMSCRIPTEN="$(emcc -dumpversion)"
   printf "  \"png\": \"${VERSION_PNG}\",\n"; \
   [ -n "$DISABLE_SVG" ] || printf "  \"resvg\": \"${VERSION_RESVG}\",\n"; \
   printf "  \"tiff\": \"${VERSION_TIFF}\",\n"; \
+  [ -n "$DISABLE_UHDR" ] || printf "  \"uhdr\": \"${VERSION_UHDR}\",\n"; \
   printf "  \"vips\": \"${VERSION_VIPS}\",\n"; \
   printf "  \"webp\": \"${VERSION_WEBP}\",\n"; \
   printf "  \"zlib-ng\": \"${VERSION_ZLIB_NG}\"\n"; \
@@ -348,6 +354,20 @@ node --version
   make -C _build install
 )
 
+[ -f "$TARGET/lib/pkgconfig/libuhdr.pc" ] || [ -n "$DISABLE_UHDR" ] || (
+  stage "Compiling uhdr"
+  mkdir $DEPS/uhdr
+  curl -Ls https://github.com/google/libultrahdr/archive/refs/tags/v$VERSION_UHDR.tar.gz | tar xzC $DEPS/uhdr --strip-components=1
+  cd $DEPS/uhdr
+  # Ensure install targets are enabled when cross-compiling
+  sed -i 's/CMAKE_CROSSCOMPILING AND UHDR_ENABLE_INSTALL/FALSE/' CMakeLists.txt
+  # Disable threading support, we rely on libvips' thread pool
+  sed -i 's/(std::max)(1u, std::thread::hardware_concurrency())/1u/' lib/src/jpegr.cpp
+  emcmake cmake -B_build -S. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=$TARGET $CMAKE_ARGS -DBUILD_SHARED_LIBS=FALSE \
+    -DCMAKE_POSITION_INDEPENDENT_CODE=$MODULES -DUHDR_BUILD_EXAMPLES=FALSE -DUHDR_MAX_DIMENSION=65500
+  make -C _build install
+)
+
 [ -f "$TARGET/lib/pkgconfig/libjxl.pc" ] || [ -n "$DISABLE_JXL" ] || (
   stage "Compiling jxl"
   mkdir $DEPS/jxl
@@ -493,7 +513,7 @@ node --version
     ${DISABLE_SIMD:+-Dhighway=disabled} ${DISABLE_JXL:+-Djpeg-xl=disabled} -Dmagick=disabled \
     -Dmatio=disabled -Dnifti=disabled -Dopenexr=disabled -Dopenjpeg=disabled \
     -Dopenslide=disabled -Dpangocairo=disabled -Dpdfium=disabled -Dpoppler=disabled \
-    -Draw=disabled ${DISABLE_SVG:+-Dresvg=disabled} -Drsvg=disabled -Duhdr=disabled
+    -Draw=disabled ${DISABLE_SVG:+-Dresvg=disabled} -Drsvg=disabled ${DISABLE_UHDR:+-Duhdr=disabled}
   meson install -C _build --tag runtime,devel
   # Emscripten requires linking to side modules to find the necessary symbols to export
   module_dir=$(printf '%s\n' $TARGET/lib/vips-modules-* | sort -n | tail -1)

build/preamble_vips.d.ts

@@ -283,6 +283,13 @@ declare module Vips {
      * Handy utilities.
      */
     abstract class Utils {
+        /**
+         * Return the GType for a name.
+         * @param name Type name to lookup.
+         * @return Corresponding type ID, or `0` if not found.
+         */
+        static typeFromName(name: string): number;
+
         /**
          * Get the GType for a name.
          * Looks up the GType for a nickname. Types below basename in the type hierarchy are searched.
@@ -522,6 +529,11 @@ declare module Vips {
          */
         readonly filename?: string;
 
+        /**
+         * The associated gainmap image, if any.
+         */
+        readonly gainmap?: Image;
+
         /**
          * Page height in pixels.
          */
@@ -900,6 +912,14 @@ declare module Vips {
          */
         setString(name: string, value: string): void;
 
+        /**
+         * Set an image to another image as metadata.
+         * This is typically used to update the gainmap.
+         * @param name The name of the piece of metadata to set the value of.
+         * @param value The metadata value.
+         */
+        setImage(name: string, value: Image): void;
+
         /**
          * Set a blob on an image as metadata.
          * The value will internally be copied from JavaScript to WASM.

lib/vips.d.ts

@@ -119,6 +119,7 @@
       console.log('Open files:'.padEnd(pad), module.Stats.files());
 
       console.log('JPEG support:'.padEnd(pad), have('jpegload') ? 'yes' : 'no');
+      console.log('UltraHDR support:'.padEnd(pad), have('uhdrload') ? 'yes' : 'no');
       console.log('JPEG XL support:'.padEnd(pad), have('jxlload') ? 'yes' : 'no');
       console.log('AVIF support:'.padEnd(pad), have('heifload') ? 'yes' : 'no');
       console.log('PNG support:'.padEnd(pad), have('pngload') ? 'yes' : 'no');

playground/src/playground-runner.html

@@ -89,6 +89,14 @@ class Image : public Object {
         return vips_image_get_page_height(get_image());
     }
 
+    std::optional<Image> gainmap() const {
+        VipsImage *image = vips_image_get_gainmap(get_image());
+        if (image == nullptr) 
+            return {};
+
+        return Image(image);
+    }
+
     bool is_killed() const {
         return vips_image_iskilled(get_image());
     }
@@ -133,6 +141,10 @@ class Image : public Object {
         vips_image_set_string(get_image(), field.c_str(), value.c_str());
     }
 
+    void set(const std::string &field, const Image &value) const {
+        vips_image_set_image(get_image(), field.c_str(), value.get_image());
+    }
+
     void set_blob(const std::string &field, const std::string &data) const {
         // We must take a copy of the data.
         vips_image_set_blob_copy(get_image(), field.c_str(), data.c_str(),