wasm-vips 0.0.16 → 0.0.17

package/lib/vips.d.ts

@@ -33,6 +33,15 @@ declare module Vips {
     type Enum = string | number;
     type Flag = string | number;
     type Blob = string | ArrayBuffer | Uint8Array | Uint8ClampedArray | Int8Array;
+    type Memory =
+        Int8Array
+        | Uint8Array
+        | Int16Array
+        | Uint16Array
+        | Int32Array
+        | Uint32Array
+        | Float32Array
+        | Float64Array;
     type ArrayConstant = SingleOrArray<number>;
     type ArrayImage = SingleOrArray<Image> | Vector<Image>;
     type DeletionFuncs<T extends EmbindClassHandle<T>> = EmbindClassHandle<T>[];
@@ -169,7 +178,7 @@ declare module Vips {
     /**
      * A sequence container representing an array that can change in size.
      */
-    interface Vector<T> extends EmbindClassHandle<Vector<T>> {
+    interface Vector<T> extends EmbindClassHandle<Vector<T>>, Iterable<T> {
         /**
          * Adds a new element at the end of the vector, after its current last element.
          * @param val The value to be appended at the end of the container.
@@ -274,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.
@@ -296,9 +312,9 @@ declare module Vips {
      */
     abstract class Connection extends EmbindClassHandle<Connection> {
         /**
-         * Get the filename associated with a connection.
+         * The filename associated with a connection, if any.
          */
-        readonly filename: string;
+        readonly filename?: string;
 
         /**
          * Make a human-readable name for a connection suitable for error messages.
@@ -509,9 +525,14 @@ declare module Vips {
         readonly yres: number;
 
         /**
-         * Image filename.
+         * Image filename, if any.
+         */
+        readonly filename?: string;
+
+        /**
+         * The associated gainmap image, if any.
          */
-        readonly filename: string;
+        readonly gainmap?: Image;
 
         /**
          * Page height in pixels.
@@ -639,7 +660,7 @@ declare module Vips {
          * @param format Band format.
          * @return A new image.
          */
-        static newFromMemory(data: Blob, width: number, height: number, bands: number, format: BandFormat): Image;
+        static newFromMemory(data: Memory, width: number, height: number, bands: number, format: BandFormat): Image;
 
         /**
          * Wrap an image around a pointer.
@@ -850,7 +871,7 @@ declare module Vips {
          * will return a four byte typed array containing the values 1, 2, 3, 4.
          * @return A typed array of 8-bit unsigned integer values.
          */
-        writeToMemory(): Uint8Array;
+        writeToMemory(): Memory;
 
         //#endregion
 
@@ -891,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.
@@ -1757,7 +1786,15 @@ declare module Vips {
         /**
          * Pixels are HSV
          */
-        hsv = 29 // 'hsv'
+        hsv = 29, // 'hsv'
+        /**
+         * Pixels are in Oklab colourspace
+         */
+        oklab = 30, // 'oklab'
+        /**
+         * Pixels are in Oklch colourspace
+         */
+        oklch = 31 // 'oklch'
     }
 
     /**
@@ -1999,8 +2036,7 @@ declare module Vips {
         /**
          * Top-to-bottom reading only, but with a small buffer
          */
-        sequential = 1, // 'sequential'
-        sequential_unbuffered = 2 // 'sequential-unbuffered'
+        sequential = 1 // 'sequential'
     }
 
     /**
@@ -2494,6 +2530,12 @@ declare module Vips {
 
     /**
      * How to calculate the output pixels when shrinking a 2x2 region.
+     *
+     * Images with alpha (see [method@Image.hasalpha]) always shrink with
+     * [enum@Vips.RegionShrink.MEAN] and pixels scaled by alpha to avoid fringing.
+     *
+     * Set the image interpretation to [enum@Vips.Interpretation.MULTIBAND] to
+     * treat all bands equally.
      */
     enum RegionShrink {
         /**
@@ -2651,35 +2693,35 @@ declare module Vips {
      */
     enum Kernel {
         /**
-         * The nearest pixel to the point.
+         * The nearest pixel to the point
          */
         nearest = 0, // 'nearest'
         /**
-         * Convolve with a triangle filter.
+         * Convolve with a triangle filter
          */
         linear = 1, // 'linear'
         /**
-         * Convolve with a cubic filter.
+         * Convolve with a cubic filter
          */
         cubic = 2, // 'cubic'
         /**
-         * Convolve with a Mitchell kernel.
+         * Convolve with a Mitchell kernel
          */
         mitchell = 3, // 'mitchell'
         /**
-         * Convolve with a two-lobe Lanczos kernel.
+         * Convolve with a two-lobe Lanczos kernel
          */
         lanczos2 = 4, // 'lanczos2'
         /**
-         * Convolve with a three-lobe Lanczos kernel.
+         * Convolve with a three-lobe Lanczos kernel
          */
         lanczos3 = 5, // 'lanczos3'
         /**
-         * Convolve with Magic Kernel Sharp 2013.
+         * Convolve with Magic Kernel Sharp 2013
          */
         mks2013 = 6, // 'mks2013'
         /**
-         * Convolve with Magic Kernel Sharp 2021.
+         * Convolve with Magic Kernel Sharp 2021
          */
         mks2021 = 7 // 'mks2021'
     }
@@ -2762,13 +2804,17 @@ declare module Vips {
          */
         icc = 8, // 'icc'
         /**
-         * Keep other metadata (e.g. PNG comments and some TIFF tags)
+         * Keep other metadata (e.g. PNG comments)
          */
         other = 16, // 'other'
+        /**
+         * Keep the gainmap metadata
+         */
+        gainmap = 32, // 'gainmap'
         /**
          * Keep all metadata
          */
-        all = 31 // 'all'
+        all = 63 // 'all'
     }
 
     /**
@@ -4393,14 +4439,18 @@ declare module Vips {
              * Array of input images.
              */
             _in?: ArrayImage | ArrayConstant
+            /**
+             * Format for input filename.
+             */
+            in_format?: string
             /**
              * Format for output filename.
              */
             out_format?: string
             /**
-             * Format for input filename.
+             * Cache this call.
              */
-            in_format?: string
+            cache?: boolean
             /**
              * Output image (output).
              */
@@ -4744,6 +4794,97 @@ declare module Vips {
             H?: number
         }): Image;
 
+        /**
+         * Load a uhdr image.
+         * @param filename Filename to load from.
+         * @param options Optional options.
+         * @return Output image.
+         */
+        static uhdrload(filename: string, options?: {
+            /**
+             * Shrink factor on load.
+             */
+            shrink?: number
+            /**
+             * Force open via memory.
+             */
+            memory?: boolean
+            /**
+             * Required access pattern for this file.
+             */
+            access?: Access | Enum
+            /**
+             * Error level to fail on.
+             */
+            fail_on?: FailOn | Enum
+            /**
+             * Don't use a cached result for this operation.
+             */
+            revalidate?: boolean
+            /**
+             * Flags for this file (output).
+             */
+            flags?: number | undefined
+        }): Image;
+
+        /**
+         * Load a uhdr image.
+         * @param buffer Buffer to load from.
+         * @param options Optional options.
+         * @return Output image.
+         */
+        static uhdrloadBuffer(buffer: Blob, options?: {
+            /**
+             * Shrink factor on load.
+             */
+            shrink?: number
+            /**
+             * Force open via memory.
+             */
+            memory?: boolean
+            /**
+             * Required access pattern for this file.
+             */
+            access?: Access | Enum
+            /**
+             * Error level to fail on.
+             */
+            fail_on?: FailOn | Enum
+            /**
+             * Flags for this file (output).
+             */
+            flags?: number | undefined
+        }): Image;
+
+        /**
+         * Load a uhdr image.
+         * @param source Source to load from.
+         * @param options Optional options.
+         * @return Output image.
+         */
+        static uhdrloadSource(source: Source, options?: {
+            /**
+             * Shrink factor on load.
+             */
+            shrink?: number
+            /**
+             * Force open via memory.
+             */
+            memory?: boolean
+            /**
+             * Required access pattern for this file.
+             */
+            access?: Access | Enum
+            /**
+             * Error level to fail on.
+             */
+            fail_on?: FailOn | Enum
+            /**
+             * Flags for this file (output).
+             */
+            flags?: number | undefined
+        }): Image;
+
         /**
          * Load vips from file.
          * @param filename Filename to load from.
@@ -5057,6 +5198,24 @@ declare module Vips {
          */
         LabS2LabQ(): Image;
 
+        /**
+         * Transform oklab to oklch.
+         * @return Output image.
+         */
+        Oklab2Oklch(): Image;
+
+        /**
+         * Transform oklab to xyz.
+         * @return Output image.
+         */
+        Oklab2XYZ(): Image;
+
+        /**
+         * Transform oklch to oklab.
+         * @return Output image.
+         */
+        Oklch2Oklab(): Image;
+
         /**
          * Transform xyz to cmyk.
          * @return Output image.
@@ -5075,6 +5234,12 @@ declare module Vips {
             temp?: ArrayConstant
         }): Image;
 
+        /**
+         * Transform xyz to oklab.
+         * @return Output image.
+         */
+        XYZ2Oklab(): Image;
+
         /**
          * Transform xyz to yxy.
          * @return Output image.
@@ -6130,6 +6295,10 @@ declare module Vips {
              * Select encoder to use.
              */
             encoder?: ForeignHeifEncoder | Enum
+            /**
+             * Tuning parameters.
+             */
+            tune?: string
             /**
              * Which metadata to retain.
              */
@@ -6182,6 +6351,10 @@ declare module Vips {
              * Select encoder to use.
              */
             encoder?: ForeignHeifEncoder | Enum
+            /**
+             * Tuning parameters.
+             */
+            tune?: string
             /**
              * Which metadata to retain.
              */
@@ -6234,6 +6407,10 @@ declare module Vips {
              * Select encoder to use.
              */
             encoder?: ForeignHeifEncoder | Enum
+            /**
+             * Tuning parameters.
+             */
+            tune?: string
             /**
              * Which metadata to retain.
              */
@@ -6555,7 +6732,7 @@ declare module Vips {
         }): Image;
 
         /**
-         * Save image to jpeg file.
+         * Save as jpeg.
          * @param filename Filename to save to.
          * @param options Optional options.
          */
@@ -6615,7 +6792,7 @@ declare module Vips {
         }): void;
 
         /**
-         * Save image to jpeg buffer.
+         * Save as jpeg.
          * @param options Optional options.
          * @return Buffer to save to.
          */
@@ -6734,7 +6911,7 @@ declare module Vips {
         }): void;
 
         /**
-         * Save image to jpeg target.
+         * Save as jpeg.
          * @param target Target to save to.
          * @param options Optional options.
          */
@@ -6819,6 +6996,10 @@ declare module Vips {
              * Quality factor.
              */
             Q?: number
+            /**
+             * Bit depth.
+             */
+            bitdepth?: number
             /**
              * Which metadata to retain.
              */
@@ -6863,6 +7044,10 @@ declare module Vips {
              * Quality factor.
              */
             Q?: number
+            /**
+             * Bit depth.
+             */
+            bitdepth?: number
             /**
              * Which metadata to retain.
              */
@@ -6907,6 +7092,10 @@ declare module Vips {
              * Quality factor.
              */
             Q?: number
+            /**
+             * Bit depth.
+             */
+            bitdepth?: number
             /**
              * Which metadata to retain.
              */
@@ -7413,7 +7602,7 @@ declare module Vips {
              */
             interlace?: boolean
             /**
-             * Libspng row filter flag(s).
+             * Libpng row filter flag(s).
              */
             filter?: ForeignPngFilter | Flag
             /**
@@ -7469,7 +7658,7 @@ declare module Vips {
              */
             interlace?: boolean
             /**
-             * Libspng row filter flag(s).
+             * Libpng row filter flag(s).
              */
             filter?: ForeignPngFilter | Flag
             /**
@@ -7525,7 +7714,7 @@ declare module Vips {
              */
             interlace?: boolean
             /**
-             * Libspng row filter flag(s).
+             * Libpng row filter flag(s).
              */
             filter?: ForeignPngFilter | Flag
             /**
@@ -8691,6 +8880,96 @@ declare module Vips {
             page_height?: number
         }): Image;
 
+        /**
+         * Transform uhdr to scrgb.
+         * @return Output image.
+         */
+        uhdr2scRGB(): Image;
+
+        /**
+         * Save image in ultrahdr format.
+         * @param filename Filename to save to.
+         * @param options Optional options.
+         */
+        uhdrsave(filename: string, options?: {
+            /**
+             * Q factor.
+             */
+            Q?: number
+            /**
+             * Which metadata to retain.
+             */
+            keep?: ForeignKeep | Flag
+            /**
+             * Background value.
+             */
+            background?: ArrayConstant
+            /**
+             * Set page height for multipage save.
+             */
+            page_height?: number
+            /**
+             * Filename of icc profile to embed.
+             */
+            profile?: string
+        }): void;
+
+        /**
+         * Save image in ultrahdr format.
+         * @param options Optional options.
+         * @return Buffer to save to.
+         */
+        uhdrsaveBuffer(options?: {
+            /**
+             * Q factor.
+             */
+            Q?: number
+            /**
+             * Which metadata to retain.
+             */
+            keep?: ForeignKeep | Flag
+            /**
+             * Background value.
+             */
+            background?: ArrayConstant
+            /**
+             * Set page height for multipage save.
+             */
+            page_height?: number
+            /**
+             * Filename of icc profile to embed.
+             */
+            profile?: string
+        }): Uint8Array;
+
+        /**
+         * Save image in ultrahdr format.
+         * @param target Target to save to.
+         * @param options Optional options.
+         */
+        uhdrsaveTarget(target: Target, options?: {
+            /**
+             * Q factor.
+             */
+            Q?: number
+            /**
+             * Which metadata to retain.
+             */
+            keep?: ForeignKeep | Flag
+            /**
+             * Background value.
+             */
+            background?: ArrayConstant
+            /**
+             * Set page height for multipage save.
+             */
+            page_height?: number
+            /**
+             * Filename of icc profile to embed.
+             */
+            profile?: string
+        }): void;
+
         /**
          * Unpremultiply image alpha.
          * @param options Optional options.
@@ -8769,6 +9048,10 @@ declare module Vips {
              * Enable lossless compression.
              */
             lossless?: boolean
+            /**
+             * Preserve color values from transparent pixels.
+             */
+            exact?: boolean
             /**
              * Preset for lossy compression.
              */
@@ -8849,6 +9132,10 @@ declare module Vips {
              * Enable lossless compression.
              */
             lossless?: boolean
+            /**
+             * Preserve color values from transparent pixels.
+             */
+            exact?: boolean
             /**
              * Preset for lossy compression.
              */
@@ -8928,6 +9215,10 @@ declare module Vips {
              * Enable lossless compression.
              */
             lossless?: boolean
+            /**
+             * Preserve color values from transparent pixels.
+             */
+            exact?: boolean
             /**
              * Preset for lossy compression.
              */
@@ -9008,6 +9299,10 @@ declare module Vips {
              * Enable lossless compression.
              */
             lossless?: boolean
+            /**
+             * Preserve color values from transparent pixels.
+             */
+            exact?: boolean
             /**
              * Preset for lossy compression.
              */