Skip to content

Latest commit

 

History

History
68 lines (38 loc) · 1.76 KB

readme.md

File metadata and controls

68 lines (38 loc) · 1.76 KB

pcm-util unstable Build Status Greenkeeper badge

Utils to tamper with PCM formats/buffers. In particular, converting Buffer to AudioBuffer, ArrayBuffer to AudioBuffer, AudioBuffer to ArrayBuffer or AudioBuffer to Buffer.

npm install pcm-util

var pcm = require('pcm-util')

pcm.defaults

Default PCM format to use for any operations

pcm.defaults === {
	channels: 2,
	sampleRate: 44100,
	interleaved: true,
	float: false,
	signed: true,
	bitDepth: 16,
	byteOrder: 'LE',
	max: 32767,
	min: -32768,
	samplesPerFrame: 1024,
	id: 'S_16_LE_2_44100_I'
}

pcm.normalize(format)

Normalize passed format: ensure all the properties are present and do not contradict.

pcm.format(audioBuffer)

Retrieve format-related properties from audio buffer, return not normalized format.

pcm.equal(a, b)

Compare whether two formats are equal to each other.

pcm.toAudioBuffer(buffer, format)

Convert buffer/arrayBuffer with the format to audio buffer.

pcm.toArrayBuffer(audioBuffer, format)

Convert audio buffer to array buffer with the format.

pcm.convert(buffer, fromFormat, toFormat)

Convert array buffer from one format to another.

Related

audio-buffer — audio buffer polyfill.
audio-buffer-utils — utils for audio buffers.