@napi-rs/image 1.4.4 → 1.5.1

package/README.md

@@ -419,6 +419,28 @@ export const enum ResizeFilterType {
 }
 ```
 
+#### `overlay`
+
+```ts
+/**
+ * Overlay an image at a given coordinate (x, y)
+ */
+overlay(onTop: Buffer, x: number, y: number): this
+```
+```ts
+import { writeFileSync } from 'fs'
+
+import { Transformer } from '@napi-rs/image'
+
+
+const imageOutputPng = await new Transformer(PNG).overlay(PNG, 200, 200).png()
+
+writeFileSync(
+  'output-overlay-png.png',
+  imageOutputPng
+)
+```
+
 **ResizeFilterType**:
 
 To test the different sampling filters on a real example, you can find two

package/index.d.ts

@@ -57,6 +57,65 @@ export const enum ChromaSubsampling {
    */
   Yuv400 = 3
 }
+export const enum FastResizeFilter {
+  /**
+   * Each pixel of source image contributes to one pixel of the
+   * destination image with identical weights. For upscaling is equivalent
+   * of `Nearest` resize algorithm.
+   */
+  Box = 0,
+  /**
+   * Bilinear filter calculate the output pixel value using linear
+   * interpolation on all pixels that may contribute to the output value.
+   */
+  Bilinear = 1,
+  /**
+   * Hamming filter has the same performance as `Bilinear` filter while
+   * providing the image downscaling quality comparable to bicubic
+   * (`CatmulRom` or `Mitchell`). Produces a sharper image than `Bilinear`,
+   * doesn't have dislocations on local level like with `Box`.
+   * The filter don’t show good quality for the image upscaling.
+   */
+  Hamming = 2,
+  /**
+   * Catmull-Rom bicubic filter calculate the output pixel value using
+   * cubic interpolation on all pixels that may contribute to the output
+   * value.
+   */
+  CatmullRom = 3,
+  /**
+   * Mitchell–Netravali bicubic filter calculate the output pixel value
+   * using cubic interpolation on all pixels that may contribute to the
+   * output value.
+   */
+  Mitchell = 4,
+  /**
+   * Lanczos3 filter calculate the output pixel value using a high-quality
+   * Lanczos filter (a truncated sinc) on all pixels that may contribute
+   * to the output value.
+   */
+  Lanczos3 = 5
+}
+export const enum ResizeFit {
+  /**
+   * (default) Preserving aspect ratio
+   * ensure the image covers both provided dimensions by cropping/clipping to fit.
+   */
+  Cover = 0,
+  /** Ignore the aspect ratio of the input and stretch to both provided dimensions. */
+  Fill = 1,
+  /**
+   * Preserving aspect ratio
+   * resize the image to be as large as possible while ensuring its dimensions are less than or equal to both those specified.
+   */
+  Inside = 2
+}
+export interface FastResizeOptions {
+  width: number
+  height?: number
+  filter?: FastResizeFilter
+  fit?: ResizeFit
+}
 export interface JpegCompressOptions {
   /** Output quality, default is 100 (lossless) */
   quality?: number
@@ -298,6 +357,12 @@ export interface Metadata {
   format: string
   colorType: JsColorType
 }
+export interface ResizeOptions {
+  width: number
+  height?: number
+  filter?: ResizeFilterType
+  fit?: ResizeFit
+}
 export class Transformer {
   constructor(input: Buffer)
   static fromRgbaPixels(input: Buffer | Uint8ClampedArray, width: number, height: number): Transformer
@@ -321,7 +386,16 @@ export class Transformer {
    * The image is scaled to the maximum possible size that fits
    * within the bounds specified by `width` and `height`.
    */
-  resize(width: number, height?: number | undefined | null, filterType?: ResizeFilterType | undefined | null): this
+  resize(widthOrOptions: number | ResizeOptions, height?: number | undefined | null, filter?: ResizeFilterType | undefined | null, fit?: ResizeFit | undefined | null): this
+  /**
+   * Resize this image using the specified filter algorithm.
+   * The image is scaled to the maximum possible size that fits
+   * within the bounds specified by `width` and `height`.
+   *
+   * This is using faster SIMD based resize implementation
+   * the resize filter is different from `resize` method
+   */
+  fastResize(options: FastResizeOptions): this
   /**
    * Performs a Gaussian blur on this image.
    * `sigma` is a measure of how much to blur by.
@@ -358,6 +432,8 @@ export class Transformer {
   huerotate(hue: number): this
   /** Crop a cut-out of this image delimited by the bounding rectangle. */
   crop(x: number, y: number, width: number, height: number): this
+  /** Overlay an image at a given coordinate (x, y) */
+  overlay(onTop: Buffer, x: number, y: number): this
   /** Return this image's pixels as a native endian byte slice. */
   rawPixels(signal?: AbortSignal | undefined | null): Promise<Buffer>
   /** Return this image's pixels as a native endian byte slice. */

package/index.js

@@ -246,9 +246,11 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { ChromaSubsampling, compressJpegSync, compressJpeg, CompressionType, FilterType, PngRowFilter, losslessCompressPngSync, losslessCompressPng, pngQuantizeSync, pngQuantize, Orientation, ResizeFilterType, JsColorType, Transformer } = nativeBinding
+const { ChromaSubsampling, FastResizeFilter, ResizeFit, compressJpegSync, compressJpeg, CompressionType, FilterType, PngRowFilter, losslessCompressPngSync, losslessCompressPng, pngQuantizeSync, pngQuantize, Orientation, ResizeFilterType, JsColorType, Transformer } = nativeBinding
 
 module.exports.ChromaSubsampling = ChromaSubsampling
+module.exports.FastResizeFilter = FastResizeFilter
+module.exports.ResizeFit = ResizeFit
 module.exports.compressJpegSync = compressJpegSync
 module.exports.compressJpeg = compressJpeg
 module.exports.CompressionType = CompressionType

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@napi-rs/image",
-  "version": "1.4.4",
+  "version": "1.5.1",
   "main": "index.js",
   "types": "index.d.ts",
   "description": "Image processing library",
@@ -61,21 +61,21 @@
   },
   "repository": "git@github.com:Brooooooklyn/Image.git",
   "devDependencies": {
-    "@napi-rs/cli": "^2.14.1"
+    "@napi-rs/cli": "^2.14.3"
   },
-  "gitHead": "fdd80a15bf0f215383c622a4361a3b74dd22bddd",
+  "gitHead": "21d75bbe1650438b5901a51de34f1dccfc149359",
   "optionalDependencies": {
-    "@napi-rs/image-win32-x64-msvc": "1.4.4",
-    "@napi-rs/image-darwin-x64": "1.4.4",
-    "@napi-rs/image-linux-x64-gnu": "1.4.4",
-    "@napi-rs/image-darwin-arm64": "1.4.4",
-    "@napi-rs/image-android-arm64": "1.4.4",
-    "@napi-rs/image-linux-arm64-gnu": "1.4.4",
-    "@napi-rs/image-linux-arm64-musl": "1.4.4",
-    "@napi-rs/image-linux-arm-gnueabihf": "1.4.4",
-    "@napi-rs/image-linux-x64-musl": "1.4.4",
-    "@napi-rs/image-freebsd-x64": "1.4.4",
-    "@napi-rs/image-win32-ia32-msvc": "1.4.4",
-    "@napi-rs/image-android-arm-eabi": "1.4.4"
+    "@napi-rs/image-win32-x64-msvc": "1.5.1",
+    "@napi-rs/image-darwin-x64": "1.5.1",
+    "@napi-rs/image-linux-x64-gnu": "1.5.1",
+    "@napi-rs/image-darwin-arm64": "1.5.1",
+    "@napi-rs/image-android-arm64": "1.5.1",
+    "@napi-rs/image-linux-arm64-gnu": "1.5.1",
+    "@napi-rs/image-linux-arm64-musl": "1.5.1",
+    "@napi-rs/image-linux-arm-gnueabihf": "1.5.1",
+    "@napi-rs/image-linux-x64-musl": "1.5.1",
+    "@napi-rs/image-freebsd-x64": "1.5.1",
+    "@napi-rs/image-win32-ia32-msvc": "1.5.1",
+    "@napi-rs/image-android-arm-eabi": "1.5.1"
   }
 }