Image
Image processing library.
This library support encode/decode these formats:
| Format | Input | Output |
|---|---|---|
| RawPixels | RGBA 8 bits pixels | |
| JPEG | Baseline and progressive | Baseline JPEG |
| PNG | All supported color types | Same as decoding |
| BMP | โ | Rgb8, Rgba8, Gray8, GrayA8 |
| ICO | โ | โ |
| TIFF | Baseline(no fax support) + LZW + PackBits | Rgb8, Rgba8, Gray8 |
| WebP | No | โ |
| AVIF | No | โ |
| PNM | PBM, PGM, PPM, standard PAM | โ |
| DDS | DXT1, DXT3, DXT5 | No |
| TGA | โ | Rgb8, Rgba8, Bgr8, Bgra8, Gray8, GrayA8 |
| OpenEXR | Rgb32F, Rgba32F (no dwa compression) | Rgb32F, Rgba32F (no dwa compression) |
| farbfeld | โ | โ |
| SVG | โ |
See index.d.ts for API reference.
Support matrix
| node10 | node12 | node14 | node16 | node18 | |
|---|---|---|---|---|---|
| Windows x64 | โ | โ | โ | โ | โ |
| Windows x32 | โ | โ | โ | โ | โ |
| macOS x64 | โ | โ | โ | โ | โ |
| macOS arm64 (m chips) | โ | โ | โ | โ | โ |
| Linux x64 gnu | โ | โ | โ | โ | โ |
| Linux x64 musl | โ | โ | โ | โ | โ |
| Linux arm gnu | โ | โ | โ | โ | โ |
| Linux arm64 gnu | โ | โ | โ | โ | โ |
| Linux arm64 musl | โ | โ | โ | โ | โ |
| Android arm64 | โ | โ | โ | โ | โ |
| Android armv7 | โ | โ | โ | โ | โ |
| FreeBSD x64 | โ | โ | โ | โ | โ |
Performance
System info
OS: macOS 12.3.1 21E258 arm64
Host: MacBookPro18,2
Kernel: 21.4.0
Shell: zsh 5.8
CPU: Apple M1 Max
GPU: Apple M1 Max
Memory: 9539MiB / 65536MiB
node bench/bench.mjs
@napi-rs/image 202 ops/s
sharp 169 ops/s
In webp suite, fastest is @napi-rs/image
@napi-rs/image 26 ops/s
sharp 24 ops/s
In avif suite, fastest is @napi-rs/image
UV_THREADPOOL_SIZE=10 node bench/bench.mjs
@napi-rs/image 431 ops/s
sharp 238 ops/s
In webp suite, fastest is @napi-rs/image
@napi-rs/image 36 ops/s
sharp 32 ops/s
In avif suite, fastest is @napi-rs/image
@napi-rs/image
See Full documentation for @napi-rs/image
Example
You can clone this repo and run the following command to taste the example below:
yarn installnode example.mjs
| Optimization | Raw | Raw Size | Optimized Size |
|---|---|---|---|
losslessCompressPng() Lossless |
 CC-BY-SA 3.0 by Niabot |
888K |
736K |
pngQuantize({ maxQuality: 75 }) Lossy |
CC-BY-SA 3.0 by Niabot |
888K |
248K |
compressJpeg() Lossless |
 |
192K |
184K |
compressJpeg(75) Lossy |
|
192K |
104K |
new Transformer(PNG).webpLossless()Lossless |
CC-BY-SA 3.0 by Niabot |
888K |
588K |
new Transformer(PNG).webp(75)Lossy |
CC-BY-SA 3.0 by Niabot |
888K |
64K |
Transformer(PNG).avif({ quality: 100 })Lossless |
CC-BY-SA 3.0 by Niabot |
888K |
536K |
new Transformer(PNG).avif({ quality: 75, chromaSubsampling: ChromaSubsampling.Yuv420 })Lossy |
CC-BY-SA 3.0 by Niabot |
888K |
64K |
import { readFileSync, writeFileSync } from 'fs'
import {
losslessCompressPng,
compressJpeg,
pngQuantize,
Transformer,
ResizeFilterType,
ChromaSubsampling,
} from '@napi-rs/image'
import chalk from 'chalk'
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')
const SVG = readFileSync('./input-debian.svg')
writeFileSync('optimized-lossless.png', await losslessCompressPng(PNG))
console.info(chalk.green('Lossless compression png done'))
writeFileSync(
'optimized-lossy.png',
await pngQuantize(PNG, {
maxQuality: 75,
}),
)
console.info(chalk.green('Lossy compression png done'))
writeFileSync('optimized-lossless.jpg', await compressJpeg(readFileSync('./un-optimized.jpg')))
console.info(chalk.green('Lossless compression jpeg done'))
writeFileSync('optimized-lossy.jpg', await compressJpeg(readFileSync('./un-optimized.jpg'), { quality: 75 }))
console.info(chalk.green('Lossy compression jpeg done'))
writeFileSync('optimized-lossless.webp', await new Transformer(PNG).webpLossless())
console.info(chalk.green('Lossless encoding webp from PNG done'))
writeFileSync('optimized-lossy-png.webp', await new Transformer(PNG).webp(75))
console.info(chalk.green('Encoding webp from PNG done'))
writeFileSync('optimized-lossless-png.avif', await new Transformer(PNG).avif({ quality: 100 }))
console.info(chalk.green('Lossless encoding avif from PNG done'))
writeFileSync(
'optimized-lossy-png.avif',
await new Transformer(PNG).avif({ quality: 75, chromaSubsampling: ChromaSubsampling.Yuv420 }),
)
console.info(chalk.green('Lossy encoding avif from PNG done'))
writeFileSync(
'output-exif.webp',
await new Transformer(WITH_EXIF)
.rotate()
.resize(450 / 2, null, ResizeFilterType.Lanczos3)
.webp(75),
)
console.info(chalk.green('Encoding webp from JPEG with EXIF done'))
writeFileSync('output-overlay-png.png', await new Transformer(PNG).overlay(PNG, 200, 200).png())
console.info(chalk.green('Overlay an image done'))
writeFileSync('output-debian.jpeg', await Transformer.fromSvg(SVG, 'rgba(238, 235, 230, .9)').jpeg())
console.info(chalk.green('Encoding jpeg from SVG done'))