Bitdepth NPM | npm.io

bitdepth

Change the bit depth of PCM samples.

Install

npm install bitdepth

Use

Node

const changeBitDepth = require("bitdepth").changeBitDepth;
// The params, in order:
// - the original sample array
// - the original bit depth
// - the output array for the new samples
// - the target bit depth
changeBitDepth(originalArray, "32f", outputArray, "16");

The outputArray must be a typed array.

Browser

Use the bitdepth.js file in the /dist folder:

<script src="bitdepth.js"></script>
<script>
	bitdepth.changeBitDepth(originalArray, "32f", outputArray, "16");
</script>

Or get it from the jsDelivr CDN:

<script src="https://cdn.jsdelivr.net/npm/bitdepth"></script>

Or get it from unpkg:

<script src="https://unpkg.com/bitdepth"></script>

Bit depth codes

The params informing the original and target bit depths are strings representing the bit depth code. Their values can be:

A string representing any integer from "8" to "53" (integer samples)
"32f" for 32 bit floating-point
"64" for 64 bit floating-point

Range of the samples

This lib is inteded to be used with PCM data. Note that:

8-bit samples range from 0 to 255 (unsigned)
Other integers are all signed
32 fp and 64 range from -1 to 1

Dithering

This lib does not apply any dither to the samples.

API

/**
 * Change the bit depth of PCM samples.
 * @param {!Array|!TypedArray} samples The original samples.
 * @param {string} bithDepth The original bit depth.
 * @param {!TypedArray} newSamples The output array.
 * @param {string} targetBitDepth The target bit depth.
 * @throws {Error} If original or target bit depths are not valid.
 */
function changeBitDepth(samples, bithDepth, newSamples, targetBitDepth) {};

LICENSE

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.