feat: support avif

- Add avif encode feature
- Add documentation for `@napi-rs/image` package
- Add tests for `webp` and `avif` encode function

Author: Brooooooklyn

.github/workflows/CI.yml

@@ -52,6 +52,7 @@ jobs:
               set -e &&
               unset RUSTFLAGS &&
               unset CC &&
+              apk add --update --repository http://dl-cdn.alpinelinux.org/alpine/edge/testing --no-cache nasm &&
               yarn build -- --features with_simd &&
               strip packages/*/*.node
           - host: macos-latest
@@ -197,7 +198,7 @@ jobs:
           usesh: true
           mem: 3000
           prepare: |
-            pkg install -y curl node14 python2
+            pkg install -y curl nasm node14 python2
             curl -qL https://www.npmjs.com/install.sh | sh
             npm install -g yarn
             curl https://sh.rustup.rs -sSf --output rustup.sh

.gitignore

@@ -13,8 +13,6 @@ Cargo.lock
 !.yarn/versions
 .turbo
 *.tsbuildinfo
-optimized-lossless.*
-optimized.svg
-quantized.png
+optimized*
 lib
 dist

.prettierignore

@@ -1,3 +1,4 @@
 target
 node_modules
-lib
+lib
+.yarn

Cargo.toml

@@ -1,7 +1,5 @@
 [workspace]
-members = [
-  "./packages/binding",
-]
+members = ["./packages/binding"]
 
 [profile.release]
 codegen-units = 1

README.md

@@ -3,8 +3,6 @@
 Image processing library.
 
 ![CI](https://github.com/Brooooooklyn/image/workflows/CI/badge.svg)
-[![install size](https://packagephobia.com/badge?p=@napi-rs/image)](https://packagephobia.com/result?p=@napi-rs/image)
-[![Downloads](https://img.shields.io/npm/dm/@napi-rs/image.svg?sanitize=true)](https://npmcharts.com/compare/@napi-rs/image?minimal=true)
 
 ## Support matrix
 
@@ -23,69 +21,6 @@ Image processing library.
 | Android armv7         | ✓      | ✓      | ✓      | ✓      | ✓      |
 | FreeBSD x64           | ✓      | ✓      | ✓      | ✓      | ✓      |
 
-## Lossless compression
+## `@napi-rs/image`
 
-### `PNG`
-
-```ts
-export interface PNGLosslessOptions {
-  /**
-   * Attempt to fix errors when decoding the input file rather than returning an Err.
-   * Default: `false`
-   */
-  fixErrors?: boolean | undefined | null
-  /**
-   * Write to output even if there was no improvement in compression.
-   * Default: `false`
-   */
-  force?: boolean | undefined | null
-  /** Which filters to try on the file (0-5) */
-  filter?: Array<number> | undefined | null
-  /**
-   * Whether to attempt bit depth reduction
-   * Default: `true`
-   */
-  bitDepthReduction?: boolean | undefined | null
-  /**
-   * Whether to attempt color type reduction
-   * Default: `true`
-   */
-  colorTypeReduction?: boolean | undefined | null
-  /**
-   * Whether to attempt palette reduction
-   * Default: `true`
-   */
-  paletteReduction?: boolean | undefined | null
-  /**
-   * Whether to attempt grayscale reduction
-   * Default: `true`
-   */
-  grayscaleReduction?: boolean | undefined | null
-  /**
-   * Whether to perform IDAT recoding
-   * If any type of reduction is performed, IDAT recoding will be performed regardless of this setting
-   * Default: `true`
-   */
-  idatRecoding?: boolean | undefined | null
-  /** Whether to remove ***All non-critical headers*** on PNG */
-  strip?: boolean | undefined | null
-  /** Whether to use heuristics to pick the best filter and compression */
-  useHeuristics?: boolean | undefined | null
-}
-export function losslessCompressPng(input: Buffer, options?: PNGLosslessOptions | undefined | null): Buffer
-```
-
-### `JPEG`
-
-```ts
-export interface JpegCompressOptions {
-  /** Output quality, default is 100 (lossless) */
-  quality?: number | undefined | null
-  /**
-   * If true, it will use MozJPEG’s scan optimization. Makes progressive image files smaller.
-   * Default is `true`
-   */
-  optimizeScans?: boolean | undefined | null
-}
-export function compressJpeg(input: Buffer, options?: JpegCompressOptions | undefined | null): Buffer
-```
+See [Documentation for `@napi-rs/image`](./packages/binding)

example.mjs

@@ -0,0 +1,27 @@
+import { readFileSync, writeFileSync } from 'fs'
+
+import {
+  losslessCompressPng,
+  compressJpeg,
+  pngQuantize,
+  losslessEncodeWebp,
+  encodeAvif,
+  encodeWebp,
+} from '@napi-rs/image'
+
+const PNG = readFileSync('./un-optimized.png')
+const JPEG = readFileSync('./un-optimized.jpg')
+
+writeFileSync('optimized-lossless.png', losslessCompressPng(PNG))
+
+writeFileSync('optimized-lossy.png', pngQuantize(PNG))
+
+writeFileSync('optimized-lossless.jpg', compressJpeg(readFileSync('./un-optimized.jpg')))
+
+writeFileSync('optimized-lossless.webp', losslessEncodeWebp(PNG))
+
+writeFileSync('optimized-lossy-jpeg.webp', encodeWebp(JPEG, 90))
+
+writeFileSync('optimized-lossy.webp', encodeWebp(PNG, 90))
+
+writeFileSync('optimized.avif', encodeAvif(PNG))

optimize-test.js

@@ -12,6 +12,7 @@
   ],
   "devDependencies": {
     "@napi-rs/cli": "^2.5.0",
+    "@taplo/cli": "^0.3.2",
     "@types/node": "^17.0.23",
     "ava": "^4.1.0",
     "lerna": "^4.0.0",
@@ -23,6 +24,10 @@
     "artifacts": "lerna run artifacts",
     "build": "lerna run build --stream --concurrency 1 --no-prefix",
     "build:ts": "tsc -b tsconfig.project.json",
+    "format": "run-p format:prettier format:rs format:toml",
+    "format:prettier": "prettier . -w",
+    "format:rs": "cargo fmt",
+    "format:toml": "taplo format",
     "test": "ava"
   },
   "prettier": {
@@ -36,11 +41,27 @@
     "extensions": [
       "mjs"
     ],
-    "timeout": "3m",
+    "timeout": "10m",
     "environmentVariables": {
       "NODE_ENV": "ava"
     }
   },
+  "lint-staged": {
+    "*.@(js||ts|json|md|yml|yaml)": [
+      "prettier --write"
+    ],
+    "*.toml": [
+      "taplo format"
+    ],
+    "*.rs": [
+      "cargo fmt --"
+    ]
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged && cargo fmt --all"
+    }
+  },
   "packageManager": "yarn@3.2.0",
   "repository": "git@github.com:Brooooooklyn/Image.git"
 }

package.json

@@ -13,11 +13,18 @@ with_simd = ["mozjpeg-sys/nasm_simd_parallel_build"]
 
 [dependencies]
 imagequant = "4.0.0"
+infer = "0.7"
+jpeg-decoder = "0.2"
 libc = "0.2"
-libwebp-sys = {version = "0.5", features = ["avx2", "sse41", "neon"]}
+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"]}
+napi = { version = "2", default-features = false, features = ["napi3"] }
+napi-derive = { version = "2", default-features = false, features = [
+  "type-def",
+] }
+png = "0.17"
+ravif = "0.8"
+rgb = "0.8"
 
 [dependencies.oxipng]
 default-features = false