@uttori/audio-padinfo v1.2.2

Uttori Pad Info

Utility to manipulate the PAD_INFO.BIN file for SP-404 / SP-404SX / SP-404A series of samplers.

Install

npm install --save @uttori/audio-padinfo

Example

const fs = require('fs');
const { AudioPadInfo } = require('@uttori/audio-padinfo');
const data = fs.readFileSync('./PAD_INFO.bin');
const { pads } = AudioPadInfo.fromFile(data);
console.log('Pads:', pads);
➜ [
    {
      "avaliable": false,
      "label": "A1",
      "filename": "A0000001.WAV",
      "originalSampleStart": 512,
      "originalSampleEnd": 385388,
      "userSampleStart": 512,
      "userSampleEnd": 385388,
      "volume": 87,
      "lofi": false,
      "loop": false,
      "gate": false,
      "reverse": true,
      "format": "WAVE",
      "channels": "Stereo",
      "tempoMode": "Off",
      "originalTempo": 109.9,
      "userTempo": 109.9
    },
    ...,
    {
      "avaliable": false,
      "label": "J12",
      "filename": "J0000012.WAV",
      "originalSampleStart": 512,
      "originalSampleEnd": 53424,
      "userSampleStart": 512,
      "userSampleEnd": 53424,
      "volume": 127,
      "lofi": false,
      "loop": false,
      "gate": true,
      "reverse": false,
      "format": "WAVE",
      "channels": "Stereo",
      "tempoMode": "Off",
      "originalTempo": 100,
      "userTempo": 100
    }
  ]

API Reference

Classes

Typedefs

AudioPadInfo

Uttori Pad Info - Utility to manipulate the PAD_INFO.BIN file for SP-404 series of samplers.

Kind: global class Properties

• AudioPadInfo
  • new AudioPadInfo(list, [overrides])
  • instance
    • .parse()
  • static
    • .fromFile(data) ⇒ AudioPadInfo
    • .fromBuffer(buffer) ⇒ AudioPadInfo
    • .encodePad(data) ⇒ Buffer
    • .checkDefault(pad, [strict]) ⇒ boolean
    • .getPadLabel(index) ⇒ string
    • .getPadIndex(label) ⇒ number

new AudioPadInfo(list, overrides)

Creates an instance of AudioPadInfo.

Example (AudioPadInfo)

const fs = require('fs');
const data = fs.readFileSync('./PAD_INFO.bin');
const { pads } = AudioPadInfo.fromFile(data);
fs.writeFileSync('./output.json', JSON.stringify(pads, null, 2));
console.log('Pads:', pads);
➜ [
    {
      "avaliable": false,
      "label": "A1",
      "filename": "A0000001.WAV",
      "originalSampleStart": 512,
      "originalSampleEnd": 385388,
      "userSampleStart": 512,
      "userSampleEnd": 385388,
      "volume": 87,
      "lofi": false,
      "loop": false,
      "gate": false,
      "reverse": true,
      "format": "WAVE",
      "channels": "Stereo",
      "tempoMode": "Off",
      "originalTempo": 109.9,
      "userTempo": 109.9
    },
    ...,
  {
      "avaliable": false,
      "label": "J12",
      "filename": "J0000012.WAV",
      "originalSampleStart": 512,
      "originalSampleEnd": 53424,
      "userSampleStart": 512,
      "userSampleEnd": 53424,
      "volume": 127,
      "lofi": false,
      "loop": false,
      "gate": true,
      "reverse": false,
      "format": "WAVE",
      "channels": "Stereo",
      "tempoMode": "Off",
      "originalTempo": 100,
      "userTempo": 100
    }
  ]

audioPadInfo.parse()

Parse the PAD_INFO.BIN file, decoding the supported pad info.

This is stored alongside the samples in PAD_INFO.BIN and contains 120 × 32-byte records, one for each pad from A1 to J12. In this file, values are stored in big-endian order

Kind: instance method of AudioPadInfo

AudioPadInfo.fromFile(data) ⇒ AudioPadInfo

Creates a new AudioPadInfo from file data.

Kind: static method of AudioPadInfo Returns: AudioPadInfo - the new AudioPadInfo instance for the provided file data

AudioPadInfo.fromBuffer(buffer) ⇒ AudioPadInfo

Creates a new AudioPadInfo from a DataBuffer.

Kind: static method of AudioPadInfo Returns: AudioPadInfo - the new AudioPadInfo instance for the provided DataBuffer

AudioPadInfo.encodePad(data) ⇒ Buffer

Encode JSON values to a valid pad structure.

Kind: static method of AudioPadInfo Returns: Buffer - - The new pad Buffer.

AudioPadInfo.checkDefault(pad, strict) ⇒ boolean

Checks to see if a Pad is set to the default values, if so it is likely.

Kind: static method of AudioPadInfo Returns: boolean - - Returns true if the Pad is set the the default values, false otherwise.

AudioPadInfo.getPadLabel(index) ⇒ string

Convert a numberic value used in the PAD_INFO.bin file for that pad to the pad label like A1 or J12.

Kind: static method of AudioPadInfo Returns: string - - The pad label like A1 or J12.

AudioPadInfo.getPadIndex(label) ⇒ number

Convert a pad label like A1 or J12 to the numberic value used in the PAD_INFO.bin file for that pad.

Kind: static method of AudioPadInfo Returns: number - - The numberic value used in the PAD_INFO.bin file.

Pad : object

A Pad object.

Kind: global typedef Properties

Tests

To run the test suite, first install the dependencies, then run npm test:

npm install
npm test
DEBUG=Uttori* npm test

Contributors

• Matthew Callis

Thanks

• Paul Battley - His Roland SP-404SX sample file format was a huge help.

License

• MIT