bitdepth

bitdepth

Copyright (c) 2017-2018 Rafael da Silva Rocha.
https://github.com/rochars/bitdepth

About

Change the resolution of samples to and from any bit depth.

Install

npm install bitdepth

Browser

Use the compiled file in the /dist folder:

<script src="bitdepth.min.js"></script>

Or get it from the jsDelivr CDN:

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

Or get it from unpkg:

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

Use

Supported bit depths (to and from):

• "8": 8-bit int (unsigned)
• Anything between "9" and "53" (integers, signed)
• "32f": 32-bit float
• "64": 64-bit float

const bitdepth = require("bitdepth").bitdepth;

// 8 bit samples
let samples = [0, 255]

// Make'em 32-bit floating point
// The input array is modified in place.
bitdepth(samples, "8", "32f");

API

bitdepth()

/**
 * Change the bit depth of samples. The input array is modified in-place.
 * @param {!Array<number>} samples The samples.
 * @param {string} original The original bit depth of the data.
 *      One of "8" ... "53", "32f", "64"
 * @param {string} target The desired bit depth for the data.
 *      One of "8" ... "53", "32f", "64"
 * @param {Array<number>=} outputArray An optional array to write
        converted samples to. Useful for writing to typed arrays.
 */
function bitdepth(samples, original, target, outputArray) {}

Distribution

This library is implemented as a ES6 module and also distributed as a CommonJS module, UMD module and a compiled script for browsers. If your system does not pick one automatically for you, you can pick one in the dist/ folder.

• The CommonJS is the one used by Node. It is served in the "main" field of this library's package.json
• The UMD module is compatible with Node, AMD and browsers. It is served in the "browser" field.
• The compiled dist is browser-only and should be the one served by CDNs.
• The "module" field points to "./index.js" and should be the default entry point.

If you are using a module bundler to compile a module that depends on this library you might need to specify what is the correct entry point as some bundlers will assume "browser". In general, you should point to "module".

webpack example:

module.exports = {
  entry: './index.js',
  resolve: {
    // tells webpack to use 'module' or 'main'
    // not 'browser'
    mainFields: ['module', 'main']
  },
  ...
};

LICENSE

Copyright (c) 2017-2018 Rafael da Silva Rocha.

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.