feat(image): support decode avif and webp (#18)

Brooooooklyn · web-flow · commit 2813560b9240 · 2022-05-02T15:12:26.000+08:00
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -3,6 +3,7 @@ env:
   DEBUG: napi:*
   APP_NAME: image
   MACOSX_DEPLOYMENT_TARGET: '10.13'
+  SYSTEM_DEPS_DAV1D_BUILD_INTERNAL: 'always'
 'on':
   push:
     branches:
@@ -27,10 +28,12 @@ jobs:
           - host: macos-latest
             target: x86_64-apple-darwin
             build: |
+              brew install meson
               yarn workspace @napi-rs/image build --features with_simd
               strip -x packages/*/*.node
           - host: windows-latest
             build: |
+              choco install meson -y
               yarn workspace @napi-rs/image build --features with_simd
             target: x86_64-pc-windows-msvc
           - host: windows-2022-xl
@@ -47,7 +50,7 @@ jobs:
             docker: ghcr.io/napi-rs/napi-rs/nodejs-rust:lts-debian
             build: |
               set -e && \
-              apt install libaom-dev -y && \
+              apt install meson -y && \
               yarn workspace @napi-rs/image build --features with_simd --target x86_64-unknown-linux-gnu && \
               strip packages/*/*.node
           - host: ubuntu-latest
@@ -58,7 +61,7 @@ jobs:
               unset RUSTFLAGS &&
               unset CC &&
               unset CXX &&
-              apk add --update --repository http://dl-cdn.alpinelinux.org/alpine/edge/testing --no-cache perl nasm aom-dev &&
+              apk add --update --repository http://dl-cdn.alpinelinux.org/alpine/edge/testing --no-cache perl nasm aom-dev meson &&
               export LIB_AOM_STATIC_LIB_PATH=/usr/lib &&
               export LIB_AOM_INCLUDE_PATH=/usr/include/aom/aom &&
               export LIB_AOM_PKG_CONFIG_PATH=/usr/lib/pkgconfig &&
@@ -67,14 +70,15 @@ jobs:
           - host: macos-latest
             target: aarch64-apple-darwin
             build: |
+              brew install meson
               yarn workspace @napi-rs/image build --features with_simd
               strip -x packages/*/*.node
           - host: ubuntu-18.04
             architecture: x64
             target: aarch64-unknown-linux-gnu
             setup: |
               sudo apt-get update
-              sudo apt-get install g++-aarch64-linux-gnu gcc-aarch64-linux-gnu -y
+              sudo apt-get install meson g++-aarch64-linux-gnu gcc-aarch64-linux-gnu -y
             build: |
               yarn workspace @napi-rs/image build --features with_simd
               aarch64-linux-gnu-strip packages/*/*.node
@@ -83,14 +87,16 @@ jobs:
             target: armv7-unknown-linux-gnueabihf
             setup: |
               sudo apt-get update
-              sudo apt-get install gcc-arm-linux-gnueabihf g++-arm-linux-gnueabihf -y
+              sudo apt-get install meson gcc-arm-linux-gnueabihf g++-arm-linux-gnueabihf -y
             build: |
               yarn workspace @napi-rs/image build --features oxipng_libdeflater
               arm-linux-gnueabihf-strip packages/*/*.node
           - host: ubuntu-latest
             architecture: x64
             target: aarch64-linux-android
             build: |
+              sudo apt update
+              sudo apt install meson -y
               export CARGO_TARGET_AARCH64_LINUX_ANDROID_LINKER="${ANDROID_NDK_HOME}/toolchains/llvm/prebuilt/linux-x86_64/bin/aarch64-linux-android24-clang"
               export CC="${ANDROID_NDK_HOME}/toolchains/llvm/prebuilt/linux-x86_64/bin/aarch64-linux-android24-clang"
               export CXX="${ANDROID_NDK_HOME}/toolchains/llvm/prebuilt/linux-x86_64/bin/aarch64-linux-android24-clang++"
@@ -101,6 +107,8 @@ jobs:
             architecture: x64
             target: armv7-linux-androideabi
             build: |
+              sudo apt update
+              sudo apt install meson -y
               export CARGO_TARGET_ARMV7_LINUX_ANDROIDEABI_LINKER="${ANDROID_NDK_HOME}/toolchains/llvm/prebuilt/linux-x86_64/bin/armv7a-linux-androideabi24-clang"
               export CC="${ANDROID_NDK_HOME}/toolchains/llvm/prebuilt/linux-x86_64/bin/armv7a-linux-androideabi24-clang"
               export CXX="${ANDROID_NDK_HOME}/toolchains/llvm/prebuilt/linux-x86_64/bin/armv7a-linux-androideabi24-clang++"
@@ -118,7 +126,7 @@ jobs:
               unset RUSTFLAGS &&
               unset CC &&
               unset CXX &&
-              apk add --update --repository http://dl-cdn.alpinelinux.org/alpine/edge/testing --no-cache aom-dev perl &&
+              apk add --update --repository http://dl-cdn.alpinelinux.org/alpine/edge/testing --no-cache aom-dev perl meson &&
               yarn workspace @napi-rs/image build --target aarch64-unknown-linux-musl --features with_simd &&
               /aarch64-linux-musl-cross/bin/aarch64-linux-musl-strip packages/*/*.node
     name: stable - ${{ matrix.settings.target }} - node@16
diff --git a/packages/binding/CHANGELOG.md b/packages/binding/CHANGELOG.md
@@ -5,15 +5,10 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 
 ## [1.1.2](https://github.com/Brooooooklyn/Image/compare/@napi-rs/image@1.1.1...@napi-rs/image@1.1.2) (2022-04-22)
 
-
 ### Bug Fixes
 
-* **image:** manipulate image has no effect ([e224c25](https://github.com/Brooooooklyn/Image/commit/e224c259d709bba704549ca34fa7851da41a6a3d))
-* **image:** webp encode LumaA8 and Luma8 ([2473680](https://github.com/Brooooooklyn/Image/commit/24736809eaa38237bd618b5860b12ae0ebe91bd6))
-
-
-
-
+- **image:** manipulate image has no effect ([e224c25](https://github.com/Brooooooklyn/Image/commit/e224c259d709bba704549ca34fa7851da41a6a3d))
+- **image:** webp encode LumaA8 and Luma8 ([2473680](https://github.com/Brooooooklyn/Image/commit/24736809eaa38237bd618b5860b12ae0ebe91bd6))
 
 ## [1.1.1](https://github.com/Brooooooklyn/Image/compare/@napi-rs/image@1.1.0...@napi-rs/image@1.1.1) (2022-04-21)
 
diff --git a/packages/binding/Cargo.toml b/packages/binding/Cargo.toml
@@ -25,6 +25,7 @@ image = { version = "0.24", default-features = false, features = [
   "tga",
   "tiff",
   "bmp",
+  "webp",
   "hdr",
   "dxt",
   "dds",
diff --git a/packages/binding/README.md b/packages/binding/README.md
@@ -19,8 +19,8 @@ This library support encode/decode these formats:
 | BMP       | ✅                                        | Rgb8, Rgba8, Gray8, GrayA8              |
 | ICO       | ✅                                        | ✅                                      |
 | TIFF      | Baseline(no fax support) + LZW + PackBits | Rgb8, Rgba8, Gray8                      |
-| WebP      | No                                        | ✅                                      |
-| AVIF      | No                                        | ✅                                      |
+| WebP      | ✅                                        | ✅                                      |
+| AVIF      | ✅                                        | ✅                                      |
 | PNM       | PBM, PGM, PPM, standard PAM               | ✅                                      |
 | DDS       | DXT1, DXT3, DXT5                          | No                                      |
 | TGA       | ✅                                        | Rgb8, Rgba8, Bgr8, Bgra8, Gray8, GrayA8 |
diff --git a/packages/binding/__test__/transformer.spec.mjs b/packages/binding/__test__/transformer.spec.mjs
@@ -41,6 +41,20 @@ test('should be able to encode into webp', async (t) => {
   await t.notThrowsAsync(() => decoder.webp(75))
 })
 
+test('should be able to decode from avif', async (t) => {
+  const decoder = new Transformer(PNG)
+  const AVIF = await decoder.avif()
+  const avifDecoder = new Transformer(AVIF)
+  await t.notThrowsAsync(() => avifDecoder.png())
+})
+
+test('should be able to decode from webp', async (t) => {
+  const decoder = new Transformer(PNG)
+  const WEBP = await decoder.webpLossless()
+  const webpDecoder = new Transformer(WEBP)
+  await t.notThrowsAsync(() => webpDecoder.png())
+})
+
 test('should be able to create transformer from raw rgba pixels', async (t) => {
   const pixels = decode('LEHV6nWB2yk8pyo0adR*.7kCMdnj', 32, 32)
   await t.notThrowsAsync(() => Transformer.fromRgbaPixels(pixels, 32, 32).webpLossless())
diff --git a/packages/binding/npm/android-arm-eabi/package.json b/packages/binding/npm/android-arm-eabi/package.json
@@ -34,4 +34,4 @@
     "access": "public"
   },
   "repository": "git@github.com:Brooooooklyn/imgquant.git"
-}
+}
diff --git a/packages/binding/npm/android-arm64/package.json b/packages/binding/npm/android-arm64/package.json
@@ -34,4 +34,4 @@
     "access": "public"
   },
   "repository": "git@github.com:Brooooooklyn/imgquant.git"
-}
+}
diff --git a/packages/binding/npm/darwin-arm64/package.json b/packages/binding/npm/darwin-arm64/package.json
@@ -34,4 +34,4 @@
     "access": "public"
   },
   "repository": "git@github.com:Brooooooklyn/imgquant.git"
-}
+}
diff --git a/packages/binding/npm/darwin-x64/package.json b/packages/binding/npm/darwin-x64/package.json
@@ -34,4 +34,4 @@
     "access": "public"
   },
   "repository": "git@github.com:Brooooooklyn/imgquant.git"
-}
+}
diff --git a/packages/binding/npm/freebsd-x64/package.json b/packages/binding/npm/freebsd-x64/package.json
@@ -34,4 +34,4 @@
     "access": "public"
   },
   "repository": "git@github.com:Brooooooklyn/imgquant.git"
-}
+}
diff --git a/packages/binding/npm/linux-arm-gnueabihf/package.json b/packages/binding/npm/linux-arm-gnueabihf/package.json
@@ -34,4 +34,4 @@
     "access": "public"
   },
   "repository": "git@github.com:Brooooooklyn/imgquant.git"
-}
+}
diff --git a/packages/binding/npm/linux-arm64-gnu/package.json b/packages/binding/npm/linux-arm64-gnu/package.json
@@ -41,4 +41,4 @@
     "access": "public"
   },
   "repository": "git@github.com:Brooooooklyn/imgquant.git"
-}
+}
diff --git a/packages/binding/npm/linux-arm64-musl/package.json b/packages/binding/npm/linux-arm64-musl/package.json
@@ -41,4 +41,4 @@
     "access": "public"
   },
   "repository": "git@github.com:Brooooooklyn/imgquant.git"
-}
+}
diff --git a/packages/binding/npm/linux-x64-gnu/package.json b/packages/binding/npm/linux-x64-gnu/package.json
@@ -41,4 +41,4 @@
     "access": "public"
   },
   "repository": "git@github.com:Brooooooklyn/imgquant.git"
-}
+}
diff --git a/packages/binding/npm/linux-x64-musl/package.json b/packages/binding/npm/linux-x64-musl/package.json
@@ -41,4 +41,4 @@
     "access": "public"
   },
   "repository": "git@github.com:Brooooooklyn/imgquant.git"
-}
+}
diff --git a/packages/binding/npm/win32-ia32-msvc/package.json b/packages/binding/npm/win32-ia32-msvc/package.json
@@ -34,4 +34,4 @@
     "access": "public"
   },
   "repository": "git@github.com:Brooooooklyn/imgquant.git"
-}
+}
diff --git a/packages/binding/npm/win32-x64-msvc/package.json b/packages/binding/npm/win32-x64-msvc/package.json
@@ -34,4 +34,4 @@
     "access": "public"
   },
   "repository": "git@github.com:Brooooooklyn/imgquant.git"
-}
+}
diff --git a/packages/binding/src/transformer.rs b/packages/binding/src/transformer.rs
@@ -2,7 +2,9 @@ use std::collections::HashMap;
 use std::io::Cursor;
 use std::sync::Arc;
 
-use image::{imageops::FilterType, ColorType, DynamicImage, ImageEncoder, ImageFormat};
+use image::{
+  imageops::FilterType, ColorType, DynamicImage, ImageBuffer, ImageEncoder, ImageFormat,
+};
 use libavif::AvifData;
 use napi::{bindgen_prelude::*, JsBuffer};
 use napi_derive::napi;
@@ -220,8 +222,34 @@ impl ThreadSafeDynamicImage {
           orientation = _orientation;
         }
       }
-      let dynamic_image = image::load_from_memory_with_format(input_buf, image_format.clone())
-        .map_err(|err| Error::new(Status::InvalidArg, format!("Decode image failed {}", err)))?;
+      let dynamic_image = if image_format == ImageFormat::Avif {
+        let avif = libavif::decode_rgb(input_buf).map_err(|err| {
+          Error::new(
+            Status::InvalidArg,
+            format!("Decode avif image failed {}", err),
+          )
+        })?;
+        let decoded_rgb = avif.to_vec();
+        let decoded_length = decoded_rgb.len();
+        let width = avif.width();
+        let height = avif.height();
+        if (width * height * 3) as usize == decoded_length {
+          ImageBuffer::from_raw(width, height, decoded_rgb)
+            .map(|buf| DynamicImage::ImageRgb8(buf))
+            .ok_or_else(|| Error::new(Status::InvalidArg, "Decode avif image failed".to_owned()))?
+        } else if (width * height * 4) as usize == decoded_length {
+          ImageBuffer::from_raw(width, height, decoded_rgb)
+            .map(|buf| DynamicImage::ImageRgba8(buf))
+            .ok_or_else(|| Error::new(Status::InvalidArg, "Decode avif image failed".to_owned()))?
+        } else {
+          ImageBuffer::from_raw(width, height, decoded_rgb)
+            .map(|buf| DynamicImage::ImageLuma8(buf))
+            .ok_or_else(|| Error::new(Status::InvalidArg, "Decode avif image failed".to_owned()))?
+        }
+      } else {
+        image::load_from_memory_with_format(input_buf, image_format.clone())
+          .map_err(|err| Error::new(Status::InvalidArg, format!("Decode image failed {}", err)))?
+      };
       let color_type = dynamic_image.color();
       image.replace(ImageMetaData {
         image: dynamic_image,
diff --git a/website/pages/docs/index.mdx b/website/pages/docs/index.mdx
@@ -554,12 +554,13 @@ huerotate(hue: number): this
 | ![](img/un-optimized.png) | ![](img/huerotate.manipulated.webp) |
 
 #### `crop`
+
 > Crop a cut-out of this image delimited by the bounding rectangle.
 
 `crop(270, 40, 500, 500)`
 
-| Image                     | Output                              |
-| ------------------------- | ----------------------------------- |
+| Image                     | Output                         |
+| ------------------------- | ------------------------------ |
 | ![](img/un-optimized.png) | ![](img/crop.manipulated.webp) |
 
 ## Optimize PNG
diff --git a/website/pages/index.mdx b/website/pages/index.mdx
@@ -17,8 +17,8 @@ This library support encode/decode these formats:
 | BMP       | ✅                                        | Rgb8, Rgba8, Gray8, GrayA8              |
 | ICO       | ✅                                        | ✅                                      |
 | TIFF      | Baseline(no fax support) + LZW + PackBits | Rgb8, Rgba8, Gray8                      |
-| WebP      | No                                        | ✅                                      |
-| AVIF      | No                                        | ✅                                      |
+| WebP      | ✅                                        | ✅                                      |
+| AVIF      | ✅                                        | ✅                                      |
 | PNM       | PBM, PGM, PPM, standard PAM               | ✅                                      |
 | DDS       | DXT1, DXT3, DXT5                          | No                                      |
 | TGA       | ✅                                        | Rgb8, Rgba8, Bgr8, Bgra8, Gray8, GrayA8 |

-Original file line number
+Diff line change
   "tga",
   "tiff",
   "bmp",
 +  "webp",
   "hdr",
   "dxt",
   "dds",