@jsquash/jpeg


An easy experience for encoding and decoding JPEG images in the browser. Powered by WebAssembly ⚡️.

Uses the MozJPEG library.

A jSquash package. Codecs and supporting code derived from the Squoosh app.

Installation

``shell
npm install --save @jsquash/jpeg


Or your favourite package manager alternative


`

Usage

Note: You will need to either manually include the wasm files from the codec directory or use a bundler like WebPack or Rollup to include them in your app/server.

$3

Decodes JPEG binary ArrayBuffer to raw RGB image data.

#### data
Type: ArrayBuffer

#### options
Type: Partial

The custom options for the decoder. Setting preserveOrientation to true will rotate the image to the correct orientation based on the metadata tag. By default, this is set to false.

#### Example
`js
import { decode } from '@jsquash/jpeg';

const formEl = document.querySelector('form');
const formData = new FormData(formEl);
// Assuming user selected an input jpeg file
const imageData = await decode(await formData.get('image').arrayBuffer());
`

$3

Encodes raw RGB image data to JPEG format and resolves to an ArrayBuffer of binary data.

#### data
Type: ImageData

#### options
Type: Partial

The MozJPEG encoder options for the output image. See default values.

#### Example
`js
import { encode } from '@jsquash/jpeg';

async function loadImage(src) {
const img = document.createElement('img');
img.src = src;
await new Promise(resolve => img.onload = resolve);
const canvas = document.createElement('canvas');
[canvas.width, canvas.height] = [img.width, img.height];
const ctx = canvas.getContext('2d');
ctx.drawImage(img, 0, 0);
return ctx.getImageData(0, 0, img.width, img.height);
}

const rawImageData = await loadImage('/example.png');
const jpegBuffer = await encode(rawImageData);
`

Manual WASM initialisation (not recommended)

In most situations there is no need to manually initialise the provided WebAssembly modules.
The generated glue code takes care of this and supports most web bundlers.

One situation where this arises is when using the modules in Cloudflare Workers (See the README for more info).

The encode and decode modules both export an init function that can be used to manually load the wasm module.

`js
import decode, { init as initJpegDecode } from '@jsquash/jpeg/decode';

initJpegDecode(WASM_MODULE); // The WASM_MODULE variable will need to be sourced by yourself and passed as an ArrayBuffer.
const image = await fetch('./image.jpeg').then(res => res.arrayBuffer()).then(decode);
`

You can also pass custom options to the init function to customise the behaviour of the module. See the Emscripten documentation for more information.

`js
import decode, { init as initJpegDecode } from '@jsquash/jpeg/decode';

initJpegDecode(null, {
// Customise the path to load the wasm file
locateFile: (path, prefix) => https://example.com/${prefix}/${path},
});
const image = await fetch('./image.jpeg').then(res => res.arrayBuffer()).then(decode);
``

Known Issues

See jSquash Project README