libsamplerate

ABI stable native implementation of libsamplerate as a Transform stream. Uses N-API, node-addon-api, cmake-js and pkg-prebuilds.

Originally forked from node-libsamplerate package.

Introduction

Allows the upsampling/downsampling and/or upconverting/downconverting to/from arbitrary sample rates and to/from 16 or 32 bits per sample. Tested on Linux (x64 and arm), Windows and MacOS. This module uses the "Full Api" detailed here

Install

npm install libsamplerate --save

Prebuilt binaries are bundled in the package for supported platforms.

If no matching prebuild is available, installation falls back to a source build and requires:

• C/C++ toolchain and Python

Source builds also require cmake and git (the build uses CMake FetchContent to download libsamplerate).

Usage

const { SampleRate, Interpolation } = require('libsamplerate');

const options = {
    // Value can be from 0 to 4 or using enum. 0 is the best quality and the slowest.
    type: Interpolation.SINC_MEDIUM_QUALITY,
    // Stereo
    channels: 2,
    // Sample rate of source
    fromRate: 48000,
    // bit depth of source. Valid values: 16 or 32
    fromDepth: 16,
    // Desired sample rate
    toRate: 44100,
    // Desired bit depth. Valid values: 16 or 32
    toDepth: 16
}
const resample = new SampleRate(options);

Input audio data should be signed integers (e.g. S16_LE or S32_LE). Output will also be signed integers. Floating point input/output is not yet supported. Input should be from a readable stream, output should be to a writable stream: e.g.

const fs = require('fs');
const rs = fs.createReadStream('input.pcm');
const ws = fs.createWriteStream('output.pcm');

rs.pipe(resample).pipe(ws);

NOTE: if reading from a WAV file, start the read at 44 bytes to avoid the wav header ({start:44} for fs.createReadStream). If recording from arecord, sox or similar, use format raw.

Altering playback speed

This is possible by modifying the converter ratio, which can be done on the fly using the setRatio method. e.g. resample.setRatio(0.5). Depending upon timing, this will most likely take effect at the next buffer load. If fine grained modifications to playback speed are required, then a small value for highWaterMark on the input stream will be needed.