Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kleisauke/wasm-vips
libvips for the browser and Node.js, compiled to WebAssembly with Emscripten.
https://github.com/kleisauke/wasm-vips
Last synced: 13 days ago
JSON representation
libvips for the browser and Node.js, compiled to WebAssembly with Emscripten.
- Host: GitHub
- URL: https://github.com/kleisauke/wasm-vips
- Owner: kleisauke
- License: mit
- Created: 2020-09-01T07:00:31.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-12-19T17:13:45.000Z (11 months ago)
- Last Synced: 2023-12-20T12:12:09.925Z (11 months ago)
- Language: C++
- Homepage: https://kleisauke.github.io/wasm-vips/
- Size: 6.93 MB
- Stars: 402
- Watchers: 15
- Forks: 22
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# wasm-vips
[libvips](https://www.libvips.org/) for the browser and Node.js, compiled
to WebAssembly with Emscripten.
Programs that use wasm-vips don't manipulate images directly, instead
they create pipelines of image processing operations building on a source
image. When the end of the pipe is connected to a destination, the whole
pipeline executes at once, streaming the image in parallel from source to
destination a section at a time. Because wasm-vips is parallel, it's quick,
and because it doesn't need to keep entire images in memory, it's light.
> [!NOTE]
> This library is still under early development. See: [#1](
https://github.com/kleisauke/wasm-vips/issues/1).
## Engine support
An engine that [supports WebAssembly SIMD](https://webassembly.org/features/).
This is present on most major browser engines.
For V8-based engines, at least version 9.1.54 is required to match the final
SIMD opcodes, this corresponds to Chrome 91, Node.js 16.4.0 and Deno 1.9.0.
For Spidermonkey-based engines, the JavaScript engine used in Mozilla Firefox
and whose version numbers are aligned, at least version 89 is required.
For JavaScriptCore-based engines, the built-in JavaScript engine for WebKit,
at least version 615.1.17 is required. This corresponds to Safari 16.4.
| 
Chrome | 
Firefox | 
Safari | 
Edge | 
Node.js | 
Deno |
|:---:|:---:|:---:|:---:|:---:|:---:|
| :heavy_check_mark:
[version 91+](https://chromestatus.com/feature/6533147810332672) | :heavy_check_mark:
[version 89+](https://bugzilla.mozilla.org/show_bug.cgi?id=1695585) | :heavy_check_mark:
[version 16.4+](https://webkit.org/blog/13966/webkit-features-in-safari-16-4/#javascript-and-webassembly) | :heavy_check_mark:
[version 91+](https://chromestatus.com/feature/6533147810332672) | :heavy_check_mark:
[version 16.4+](https://github.com/nodejs/node/pull/38273) | :heavy_check_mark:
[version 1.9+](https://github.com/denoland/deno/pull/10152) |
## Installation
wasm-vips can be installed with your favorite package manager.
```shell
npm install wasm-vips
```
```shell
yarn add wasm-vips
```
## Usage
### Browser
Requires `vips.js` (or `vips-es6.js`) and `vips.wasm` to be served from
the same directory.
Since wasm-vips requires [the `SharedArrayBuffer` API](
https://caniuse.com/sharedarraybuffer), the website needs to opt-in to
a cross-origin isolated state, by serving the following HTTP headers on
both the main document and `vips*.js` script:
```http
Cross-Origin-Embedder-Policy: require-corp
Cross-Origin-Opener-Policy: same-origin
```
See for more information.
After that, wasm-vips can be imported and initialized like this:
```html
const vips = await Vips();
```
Or, if you prefer to use ES6 modules:
```html
import Vips from './vips-es6.js';
const vips = await Vips();
```
This requires support for [`import()` in workers](https://caniuse.com/mdn-javascript_operators_import_worker_support).
### Node.js
On Node.js, wasm-vips is published as [a dual-package](
https://nodejs.org/api/packages.html#packages_conditional_exports), so it
can be imported as both CommonJS and ES6 module:
```js
// ES6 module
import Vips from 'wasm-vips';
// CommonJS module
const Vips = require('wasm-vips');
```
Then, wasm-vips can be initialized like this:
```js
// Usage with top-level await
const vips = await Vips();
// Usage with .then
Vips().then(vips => {
// Code here
});
```
### Deno
On Deno, the web ES6 module can be reused and imported from a CDN such as
[jsDelivr](https://www.jsdelivr.com/):
```js
import Vips from 'https://cdn.jsdelivr.net/npm/wasm-vips/lib/vips-es6.js';
const vips = await Vips();
```
## Example
```js
// Load an image from a file
let im = vips.Image.newFromFile('owl.jpg');
// Put im at position (100, 100) in a 3000 x 3000 pixel image,
// make the other pixels in the image by mirroring im up / down /
// left / right, see
// https://www.libvips.org/API/current/libvips-conversion.html#vips-embed
im = im.embed(100, 100, 3000, 3000, {
extend: 'mirror'
});
// Multiply the green (middle) band by 2, leave the other two alone
im = im.multiply([1, 2, 1]);
// Make an image from an array constant, convolve with it
const mask = vips.Image.newFromArray([
[-1, -1, -1],
[-1, 16, -1],
[-1, -1, -1]
], 8.0);
im = im.conv(mask, {
precision: 'integer'
});
// Finally, write the result to a buffer
const outBuffer = im.writeToBuffer('.jpg');
```