keyframe-resample-wasm

Resamples and optimizes keyframe data using WebAssembly. Minzipped size is about 6-7 kb.

Installation

npm install --save keyframe-resample

Compatibility

The keyframe-resample module will load a WebAssembly binary as a static resource, as described in Web.Dev: Bundling non-JavaScript resources . This method in compatible with Node.js, most browsers, and applications compiled with a modern bundler. For older bundlers, a keyframe-resample/compat module is also available, loading the WebAssembly binary from an inline Data URI. The compatibility build is a couple kilobytes larger, and requires more time to process the WebAssembly binary.

API

1import { ready, resample } from 'keyframe-resample'; // Node.js, browsers, and modern bundlers
2import { ready, resample } from 'keyframe-resample/compat'; // Legacy bundlers
3
4// wait for WASM to compile
5await ready;
6
7// keyframe times, in seconds
8const srcTimes = new Float32Array([0, 0.1, 0.2, 0.3, 0.4]);
9
10// keyframe values, N-dimensional vectors
11const srcValues = new Float32Array([
12    0, 0, 1,
13    0, 0, 2,
14    0, 0, 3,
15    0, 0, 4,
16    0, 0, 5,
17]);
18
19// resample keyframes, remove those unnecessary with interpolation.
20const count = resample(srcTimes, srcValues, 'lerp');
21
22// results are written to start of source array.
23const dstTimes = srcTimes.slice(0, count); // → [0, 0.4]
24const dstValues = srcValues.slice(0, count * 3); // → [0, 0, 1, 0, 0, 5]

In addition to the resample(...) function implemented in WebAssembly, a resampleDebug(...) function implemented in plain JavaScript is also exported. The WebAssembly implementation runs considerably faster.

Exports

ready: Promise<void>

resample(
 times: Float32Array,
 values: Float32Array,
 interp: 'step' | 'lerp' | 'slerp',
 tolerance = 1e4
)

resampleDebug(
 times: Float32Array,
 values: Float32Array,
 interp: 'step' | 'lerp' | 'slerp',
 tolerance = 1e4
)

Interpolation modes

Contributing

To build the project locally, run:

npm install
npm run dist

To test changes:

npm run test
npm run benchmark

Optimizations and bug fixes are welcome. Please consider filing an issue to discuss possible feature additions.

License

Licensed under Blue Oak Model License 1.0.0.