mirror of
https://github.com/Brooooooklyn/Image.git
synced 2025-12-08 18:36:03 +00:00
180 lines
8.4 KiB
Plaintext
180 lines
8.4 KiB
Plaintext
---
|
|
title: '@napi-rs/image'
|
|
description: Image processing library.
|
|
---
|
|
|
|
# `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 | ✅ | ✅ |
|
|
| AVIF | ✅ | ✅ |
|
|
| 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](https://github.com/Brooooooklyn/Image/blob/main/packages/binding/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`](./docs)
|
|
|
|
### Example
|
|
|
|
You can clone this repo and run the following command to taste the example below:
|
|
|
|
- `yarn install`
|
|
- `node example.mjs`
|
|
|
|
> Shot by NASA <br/><br/>
|
|
>
|
|
> <img src="img/un-optimized.png" width="300" /> <br />
|
|
|
|
| Optimization | <div style={{ width: '80px' }}>Raw</div> | <div style={{ width: '80px' }}>Optimized</div> | Raw Size | Optimized Size |
|
|
| ------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | ------------------------------------------------------------------------- | -------- | -------------- |
|
|
| `losslessCompressPng()` <br/>**Lossless** |  |  | `1.2M` | `876K` |
|
|
| `pngQuantize({ maxQuality: 75 })` <br/>**Lossy** |  |  | `1.2M` | `228K` |
|
|
| `compressJpeg()` <br/>**Lossless** |  |  | `192K` | `184K` |
|
|
| `compressJpeg(75)` <br/>**Lossy** |  |  | `192K` | `104K` |
|
|
| `new Transformer(PNG).webpLossless()`<br/>**Lossless** |  |  | `1.2M` | `676K` |
|
|
| `new Transformer(PNG).webp(75)`<br/>**Lossy** |  |  | `1.2M` | `84K` |
|
|
| `Transformer(PNG).avif({ quality: 100 })`<br/>**Lossless** |  |  | `1.2M` | `584K` |
|
|
| `new Transformer(PNG).avif({ quality: 75, chromaSubsampling: ChromaSubsampling.Yuv420 })`<br/>**Lossy** |  |  | `1.2M` | `112K` |
|
|
|
|
```js filename="example.mjs"
|
|
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')
|
|
|
|
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'))
|
|
```
|