feat: async Transformer class (#9)

Author: Brooooooklyn

.cargo/config.toml

@@ -1,5 +1,5 @@
 [target.x86_64-unknown-linux-musl]
-rustflags = ["-C", "target-feature=+sse4.2", "-C", "target-feature=-crt-static"]
+rustflags = ["-C", "target-feature=-crt-static"]
 [target.aarch64-unknown-linux-gnu]
 linker = "aarch64-linux-gnu-gcc"
 [target.aarch64-unknown-linux-musl]

.github/workflows/CI.yml

@@ -32,9 +32,12 @@ jobs:
             build: |
               yarn build -- --features with_simd
             target: x86_64-pc-windows-msvc
-          - host: windows-latest
+          - host: windows-2022-xl
             build: |
-              yarn build -- --features with_simd
+              $Env:PATH="C:\Cargo\bin;$Env:PATH"
+              $Env:LIBAVIF_CROSS_WIN32=1
+              yarn build -- --features with_simd --target i686-pc-windows-msvc
+              node -e "console.log(process.arch)"
               yarn test
             target: i686-pc-windows-msvc
           - host: ubuntu-latest
@@ -43,6 +46,7 @@ jobs:
             docker: ghcr.io/napi-rs/napi-rs/nodejs-rust:lts-debian
             build: |
               set -e && \
+              apt install libaom-dev -y && \
               yarn build -- --features with_simd --target x86_64-unknown-linux-gnu && \
               strip packages/*/*.node
           - host: ubuntu-latest
@@ -52,7 +56,11 @@ jobs:
               set -e &&
               unset RUSTFLAGS &&
               unset CC &&
-              apk add --update --repository http://dl-cdn.alpinelinux.org/alpine/edge/testing --no-cache nasm &&
+              unset CXX &&
+              apk add --update --repository http://dl-cdn.alpinelinux.org/alpine/edge/testing --no-cache perl nasm aom-dev &&
+              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 &&
               yarn build -- --features with_simd &&
               strip packages/*/*.node
           - host: macos-latest
@@ -96,6 +104,7 @@ jobs:
               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++"
               export PATH="${ANDROID_NDK_HOME}/toolchains/llvm/prebuilt/linux-x86_64/bin:${PATH}"
+              export C_INCLUDE_PATH="${ANDROID_NDK_HOME}/sources/android/cpufeatures"; 
               yarn build -- --features oxipng_libdeflater
               ${ANDROID_NDK_HOME}/toolchains/llvm/prebuilt/linux-x86_64/bin/arm-linux-androideabi-strip packages/*/*.node
           - host: ubuntu-latest
@@ -105,6 +114,10 @@ jobs:
             docker: ghcr.io/napi-rs/napi-rs/nodejs-rust:lts-alpine
             build: >-
               set -e &&
+              unset RUSTFLAGS &&
+              unset CC &&
+              unset CXX &&
+              apk add --update --repository http://dl-cdn.alpinelinux.org/alpine/edge/testing --no-cache aom-dev perl &&
               yarn 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
@@ -121,9 +134,10 @@ jobs:
           cache: yarn
       - name: Setup nasm
         uses: ilammy/setup-nasm@v1
-        if: matrix.settings.target == 'x86_64-pc-windows-msvc' || matrix.settings.target == 'x86_64-apple-darwin'
+        if: matrix.settings.target == 'x86_64-pc-windows-msvc' || matrix.settings.target == 'x86_64-apple-darwin' || matrix.settings.target == 'i686-pc-windows-msvc'
       - name: Install
         uses: actions-rs/toolchain@v1
+        if: matrix.settings.target != 'i686-pc-windows-msvc'
         with:
           profile: minimal
           override: true
@@ -172,8 +186,12 @@ jobs:
           run: ${{ matrix.settings.build }}
       - name: Build
         run: ${{ matrix.settings.build }}
-        if: ${{ !matrix.settings.docker }}
+        if: ${{ !matrix.settings.docker && matrix.settings.target != 'i686-pc-windows-msvc' }}
         shell: bash
+      - name: Build
+        run: ${{ matrix.settings.build }}
+        if: matrix.settings.target == 'i686-pc-windows-msvc'
+        shell: powershell
       - name: Upload artifact
         uses: actions/upload-artifact@v2
         with:
@@ -198,7 +216,7 @@ jobs:
           usesh: true
           mem: 3000
           prepare: |
-            pkg install -y curl nasm node14 python2
+            pkg install -y curl cmake nasm node14 python2 perl5
             curl -qL https://www.npmjs.com/install.sh | sh
             npm install -g yarn
             curl https://sh.rustup.rs -sSf --output rustup.sh

.gitignore

@@ -2,6 +2,7 @@ target
 node_modules
 *.node
 Cargo.lock
+*.log
 .swc
 .DS_Store
 .pnp.*
@@ -16,3 +17,4 @@ Cargo.lock
 optimized*
 lib
 dist
+output-exif.*

.prettierignore

@@ -2,3 +2,5 @@ target
 node_modules
 lib
 .yarn
+index.js
+index.d.js

Cargo.toml

@@ -2,5 +2,4 @@
 members = ["./packages/binding"]
 
 [profile.release]
-codegen-units = 1
 lto = true

bench/bench.mjs

@@ -0,0 +1,110 @@
+import { promises as fs } from 'fs'
+import { cpus } from 'os'
+import { hrtime } from 'process'
+
+import { from, timer, lastValueFrom, Subject } from 'rxjs'
+import { mergeMap, takeUntil } from 'rxjs/operators'
+import sharp from 'sharp'
+
+import { ChromaSubsampling, Transformer } from '@napi-rs/image'
+
+// https://github.com/ianare/exif-samples/blob/master/jpg/orientation/portrait_5.jpg
+const WITH_EXIF = await fs.readFile('./with-exif.jpg')
+
+const CPU_LENGTH = cpus().length
+
+const DEFAULT_TOTAL_ITERATIONS = 10000
+const DEFAULT_MAX_DURATION = 20000
+
+function bench(name, options = {}) {
+  const suites = []
+  return {
+    add(suiteName, suiteFn) {
+      suites.push({
+        name: suiteName,
+        fn: suiteFn,
+      })
+      return this
+    },
+    run: async () => {
+      let fastest = {
+        perf: -1,
+        name: '',
+      }
+      for (const { suiteName, fn: suiteFn } of suites) {
+        try {
+          await suiteFn()
+        } catch (e) {
+          console.error(`Warming up ${suiteName} failed`)
+          throw e
+        }
+      }
+      for (const { name: suiteName, fn: suiteFn } of suites) {
+        const iterations = options.iterations ?? DEFAULT_TOTAL_ITERATIONS
+        const parallel = options.parallel ?? CPU_LENGTH
+        const maxDuration = options.maxDuration ?? DEFAULT_MAX_DURATION
+        const start = hrtime.bigint()
+        let totalIterations = 0
+        let finishedIterations = 0
+        const finish$ = new Subject()
+        await lastValueFrom(
+          from({ length: iterations }).pipe(
+            mergeMap(async () => {
+              totalIterations++
+              await suiteFn()
+              finishedIterations++
+              if (finishedIterations === totalIterations) {
+                finish$.next()
+                finish$.complete()
+              }
+            }, parallel),
+            takeUntil(timer(maxDuration)),
+          ),
+        )
+        await lastValueFrom(finish$)
+        const duration = Number(hrtime.bigint() - start)
+        const currentPerf = totalIterations / duration
+        if (currentPerf > fastest.perf) {
+          fastest = {
+            perf: currentPerf,
+            name: suiteName,
+          }
+        }
+        console.info(`${suiteName} ${Math.round(currentPerf * 1e9)} ops/s`)
+      }
+      console.info(`In ${name} suite, fastest is ${fastest.name}`)
+    },
+  }
+}
+
+await bench('webp')
+  .add('@napi-rs/image', () =>
+    new Transformer(WITH_EXIF)
+      .rotate()
+      .resize(450 / 2)
+      .webp(75),
+  )
+  .add('sharp', () =>
+    sharp(WITH_EXIF)
+      .rotate()
+      .resize(450 / 2)
+      .webp({ quality: 75 })
+      .toBuffer(),
+  )
+  .run()
+
+bench('avif')
+  .add('@napi-rs/image', () =>
+    new Transformer(WITH_EXIF)
+      .rotate()
+      .resize(450 / 2)
+      .avif({ quality: 70, chromaSubsampling: ChromaSubsampling.Yuv420 }),
+  )
+  .add('sharp', () =>
+    sharp(WITH_EXIF)
+      .rotate()
+      .resize(450 / 2)
+      .avif({ quality: 70, chromaSubsampling: '4:2:0' })
+      .toBuffer(),
+  )
+  .run()

example.mjs

@@ -1,27 +1,30 @@
 import { readFileSync, writeFileSync } from 'fs'
 
-import {
-  losslessCompressPng,
-  compressJpeg,
-  pngQuantize,
-  losslessEncodeWebp,
-  encodeAvif,
-  encodeWebp,
-} from '@napi-rs/image'
+import { losslessCompressPngSync, compressJpegSync, pngQuantizeSync, Transformer } from '@napi-rs/image'
 
 const PNG = readFileSync('./un-optimized.png')
 const JPEG = readFileSync('./un-optimized.jpg')
+// https://github.com/ianare/exif-samples/blob/master/jpg/orientation/portrait_5.jpg
+const WITH_EXIF = readFileSync('./with-exif.jpg')
 
-writeFileSync('optimized-lossless.png', losslessCompressPng(PNG))
+writeFileSync('optimized-lossless.png', losslessCompressPngSync(PNG))
 
-writeFileSync('optimized-lossy.png', pngQuantize(PNG))
+writeFileSync('optimized-lossy.png', pngQuantizeSync(PNG))
 
-writeFileSync('optimized-lossless.jpg', compressJpeg(readFileSync('./un-optimized.jpg')))
+writeFileSync('optimized-lossless.jpg', compressJpegSync(readFileSync('./un-optimized.jpg')))
 
-writeFileSync('optimized-lossless.webp', losslessEncodeWebp(PNG))
+writeFileSync('optimized-lossless.webp', new Transformer(PNG).webpLosslessSync())
 
-writeFileSync('optimized-lossy-jpeg.webp', encodeWebp(JPEG, 90))
+writeFileSync('optimized-lossy-jpeg.webp', new Transformer(JPEG).webpSync(90))
 
-writeFileSync('optimized-lossy.webp', encodeWebp(PNG, 90))
+writeFileSync('optimized-lossy.webp', new Transformer(PNG).webpSync(90))
 
-writeFileSync('optimized.avif', encodeAvif(PNG))
+writeFileSync('optimized.avif', new Transformer(PNG).avifSync())
+
+writeFileSync(
+  'output-exif.webp',
+  await new Transformer(WITH_EXIF)
+    .rotate()
+    .resize(450 / 2)
+    .webp(75),
+)

package.json

@@ -11,13 +11,16 @@
     "packages/*"
   ],
   "devDependencies": {
-    "@napi-rs/cli": "^2.5.0",
+    "@napi-rs/cli": "^2.6.2",
     "@taplo/cli": "^0.3.2",
     "@types/node": "^17.0.23",
+    "@types/sharp": "^0.30.1",
     "ava": "^4.1.0",
     "lerna": "^4.0.0",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.6.1",
+    "prettier": "^2.6.2",
+    "rxjs": "^7.5.5",
+    "sharp": "^0.30.3",
     "typescript": "^4.6.3"
   },
   "scripts": {
@@ -47,7 +50,7 @@
     }
   },
   "lint-staged": {
-    "*.@(js||ts|json|md|yml|yaml)": [
+    "*.@(js|ts|json|md|yml|yaml)": [
       "prettier --write"
     ],
     "*.toml": [

packages/binding/Cargo.toml

@@ -13,17 +13,22 @@ with_simd = ["mozjpeg-sys/nasm_simd_parallel_build"]
 
 [dependencies]
 imagequant = "4.0.0"
+image = { version = "0.24" }
 infer = "0.7"
 jpeg-decoder = "0.2"
+libavif = { version = "0.10", git = "https://github.com/Brooooooklyn/libavif-rs", branch = "fix-build", default-features = false, features = [
+  "codec-aom",
+] }
 libc = "0.2"
 libwebp-sys = { version = "0.5", features = ["avx2", "sse41", "neon"] }
 lodepng = "3"
 napi = { version = "2", default-features = false, features = ["napi3"] }
 napi-derive = { version = "2", default-features = false, features = [
   "type-def",
 ] }
+num_cpus = "1"
 png = "0.17"
-ravif = "0.8"
+rexif = "0.7"
 rgb = "0.8"
 
 [dependencies.oxipng]

packages/binding/__test__/decoder.spec.mjs

@@ -0,0 +1,40 @@
+import { promises as fs } from 'fs'
+import { join } from 'path'
+import { fileURLToPath } from 'url'
+
+import test from 'ava'
+
+import { Transformer } from '../index.js'
+
+const ROOT_DIR = join(fileURLToPath(import.meta.url), '..', '..', '..', '..')
+
+const PNG = await fs.readFile(join(ROOT_DIR, 'un-optimized.png'))
+const JPEG = await fs.readFile(join(ROOT_DIR, 'un-optimized.jpg'))
+const WITH_EXIF_JPG = await fs.readFile(join(ROOT_DIR, 'with-exif.jpg'))
+
+test('should be able to get metadata from png', async (t) => {
+  const decoder = new Transformer(PNG)
+  const metadata = await decoder.metadata()
+  t.is(metadata.width, 1052)
+  t.is(metadata.height, 744)
+})
+
+test('should be able to get metadata from jpg', async (t) => {
+  const decoder = new Transformer(JPEG)
+  const metadata = await decoder.metadata()
+  t.is(metadata.width, 1024)
+  t.is(metadata.height, 678)
+})
+
+test('should be able to get exif from jpg', async (t) => {
+  const decoder = new Transformer(WITH_EXIF_JPG)
+  const metadata = await decoder.metadata(true)
+  t.snapshot(metadata.exif)
+  t.is(metadata.orientation, 5)
+  t.is(metadata.format, 'jpeg')
+})
+
+test('should be able to encode into webp', async (t) => {
+  const decoder = new Transformer(PNG)
+  await t.notThrowsAsync(() => decoder.webp(75))
+})