Various helper methods that don't belong within a specific type (just yet).
Array.<Number>Dumps an M8 Instrument to its bytes representation.
Array.<Number>Dumps an M8 Scale to its bytes representation.
Array.<Number>Dumps an M8 Song to its bytes representation.
Array.<Number>Dumps an M8 Table to its bytes representation.
Array.<Number>Dumps an M8 Theme to its bytes representation.
module:m8-js/lib/types/instruments.FMSYNTH | module:m8-js/lib/types/instruments.MACROSYNTH | module:m8-js/lib/types/instruments.MIDIOUT | module:m8-js/lib/types/instruments.NONE | module:m8-js/lib/types/instruments.SAMPLER | module:m8-js/lib/types/instruments.WAVSYNTHLoads an M8 Instrument from its bytes.
ScaleLoads an M8 Scale from its bytes.
SongLoads an M8 Song from its bytes.
module:m8-js/lib/types.TableLoads an M8 Table from its bytes.
ThemeLoads an M8 Theme from its bytes.
Uint8ArrayDumps an M8 file and returns its bytes.
Scale | Song | Theme | module:m8-js/lib/types/instruments.FMSYNTH | module:m8-js/lib/types/instruments.MACROSYNTH | module:m8-js/lib/types/instruments.MIDIOUT | module:m8-js/lib/types/instruments.NONE | module:m8-js/lib/types/instruments.SAMPLER | module:m8-js/lib/types/instruments.WAVSYNTHLoads an M8 file and returns the appropriate corresdponding object.
Array.<Number>
* [~bytesFromBool(bool)](#module_m8-js/lib/helpers..bytesFromBool) ⇒ Number
* [~bytesFromFloatLE(num)](#module_m8-js/lib/helpers..bytesFromFloatLE) ⇒ Array.<Number>
* [~bytesFromString(theString, padTo, [padValue])](#module_m8-js/lib/helpers..bytesFromString) ⇒ Array.<Number>
* [~getNote(val)](#module_m8-js/lib/helpers..getNote) ⇒ Number
* [~readFloatLE(bytes)](#module_m8-js/lib/helpers..readFloatLE) ⇒ Number
* [~readUInt16LE(bytes)](#module_m8-js/lib/helpers..readUInt16LE) ⇒ Number
* [~toM8Bool(val)](#module_m8-js/lib/helpers..toM8Bool) ⇒ String
* [~toM8Num(val, [len])](#module_m8-js/lib/helpers..toM8Num) ⇒ String
* [~toM8HexStr(val, [len])](#module_m8-js/lib/helpers..toM8HexStr) ⇒ String
### m8-js/lib/helpers~bytesForSkippedData([fileReader], offset, length, defaultValue) ⇒ Array.<Number>
Returns the bytes of unknown/unused data from the original M8 File Reader when present, or a default value.
**Kind**: inner method of [m8-js/lib/helpers](#module_m8-js/lib/helpers)
| Param | Type | Description |
| --- | --- | --- |
| [fileReader] | module:m8-js/lib/types/internal.M8FileReader | The M8 file reader |
| offset | Number | The offset |
| length | Number | The number of bytes to write |
| defaultValue | Number | The default value when the offest value wasn't skipped or there is no M8 file reader |
### m8-js/lib/helpers~bytesFromBool(bool) ⇒ Number
Returns the byte representation of the boolean.
**Kind**: inner method of [m8-js/lib/helpers](#module_m8-js/lib/helpers)
| Param | Type | Description |
| --- | --- | --- |
| bool | Boolean | The boolean |
### m8-js/lib/helpers~bytesFromFloatLE(num) ⇒ Array.<Number>
Returns a 4-byte array for the 32-bit, little-endian float.
**Kind**: inner method of [m8-js/lib/helpers](#module_m8-js/lib/helpers)
| Param | Type | Description |
| --- | --- | --- |
| num | Number | The 32-bit, little-endian float |
### m8-js/lib/helpers~bytesFromString(theString, padTo, [padValue]) ⇒ Array.<Number>
Write the string to the file's content and pad the end with empty values when necessar.
**Kind**: inner method of [m8-js/lib/helpers](#module_m8-js/lib/helpers)
| Param | Type | Description |
| --- | --- | --- |
| theString | String | The string value to write |
| padTo | Number | The number of bytes in storage to use regardless of string length |
| [padValue] | Number | The pad value to use |
### m8-js/lib/helpers~getNote(val) ⇒ Number
Returns a String representation of a Number note value.
**Kind**: inner method of [m8-js/lib/helpers](#module_m8-js/lib/helpers)
| Param | Type | Description |
| --- | --- | --- |
| val | Number | The raw note value |
### m8-js/lib/helpers~readFloatLE(bytes) ⇒ Number
Reads a 32-bit, little-endian float from the 4 bytes.
**Kind**: inner method of [m8-js/lib/helpers](#module_m8-js/lib/helpers)
| Param | Type | Description |
| --- | --- | --- |
| bytes | Array.<Number> | The bytes |
### m8-js/lib/helpers~readUInt16LE(bytes) ⇒ Number
Reads an unsigned, little-endian 16-bit integer from the two bytes.
**Kind**: inner method of [m8-js/lib/helpers](#module_m8-js/lib/helpers)
| Param | Type | Description |
| --- | --- | --- |
| bytes | Array.<Number> | The bytes |
### m8-js/lib/helpers~toM8Bool(val) ⇒ String
Turns the boolean to `ON` or `OFF`.
**Kind**: inner method of [m8-js/lib/helpers](#module_m8-js/lib/helpers)
| Param | Type | Description |
| --- | --- | --- |
| val | Boolean | the boolean to pretty print |
### m8-js/lib/helpers~toM8Num(val, [len]) ⇒ String
Raw number with zero padding of configurable length
**Kind**: inner method of [m8-js/lib/helpers](#module_m8-js/lib/helpers)
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| val | Number | | the number to pretty print |
| [len] | Number | 2 | the optional length of the number |
### m8-js/lib/helpers~toM8HexStr(val, [len]) ⇒ String
Turns the number into a string representation with 2 digit padding, upper case.
**Kind**: inner method of [m8-js/lib/helpers](#module_m8-js/lib/helpers)
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| val | Number | | the number to convert to pretty printed hex |
| [len] | Number | 2 | the optional length of the number |
## dumpInstrument(instrument, [skipHeader]) ⇒ Array.<Number>
Dumps an M8 Instrument to its bytes representation.
**Kind**: global function
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| instrument | module:m8-js/lib/types/instruments.FMSYNTH \| module:m8-js/lib/types/instruments.MACROSYNTH \| module:m8-js/lib/types/instruments.MIDIOUT \| module:m8-js/lib/types/instruments.NONE \| module:m8-js/lib/types/instruments.SAMPLER \| module:m8-js/lib/types/instruments.WAVSYNTH | | The M8 Instrument to dump |
| [skipHeader] | Boolean | false | Whether or not to include the M8 file header in the returned bytes |
## dumpScale(scale, [skipHeader]) ⇒ Array.<Number>
Dumps an M8 Scale to its bytes representation.
**Kind**: global function
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| scale | [Scale](#module_m8-js/lib/types.Scale) | | The M8 Scale to dump |
| [skipHeader] | Boolean | false | Whether or not to include the M8 file header in the returned bytes |
## dumpSong(song) ⇒ Array.<Number>
Dumps an M8 Song to its bytes representation.
**Kind**: global function
| Param | Type | Description |
| --- | --- | --- |
| song | [Song](#module_m8-js/lib/types.Song) | The Song to dump |
## dumpTable(table) ⇒ Array.<Number>
Dumps an M8 Table to its bytes representation.
**Kind**: global function
| Param | Type | Description |
| --- | --- | --- |
| table | module:m8-js/lib/types.Table | The Table to dump |
## dumpTheme(theme) ⇒ Array.<Number>
Dumps an M8 Theme to its bytes representation.
**Kind**: global function
| Param | Type | Description |
| --- | --- | --- |
| theme | [Theme](#module_m8-js/lib/types.Theme) | The M8 Theme to dump |
## loadInstrument(fileReader) ⇒ module:m8-js/lib/types/instruments.FMSYNTH \| module:m8-js/lib/types/instruments.MACROSYNTH \| module:m8-js/lib/types/instruments.MIDIOUT \| module:m8-js/lib/types/instruments.NONE \| module:m8-js/lib/types/instruments.SAMPLER \| module:m8-js/lib/types/instruments.WAVSYNTH
Loads an M8 Instrument from its bytes.
**Kind**: global function
| Param | Type | Description |
| --- | --- | --- |
| fileReader | module:m8-js/lib/types.M8FileReader | The M8 file reader |
## loadScale(fileReader) ⇒ [Scale](#module_m8-js/lib/types.Scale)
Loads an M8 Scale from its bytes.
**Kind**: global function
| Param | Type | Description |
| --- | --- | --- |
| fileReader | module:m8-js/lib/types.M8FileReader | The M8 file reader |
## loadSong(fileReader) ⇒ [Song](#module_m8-js/lib/types.Song)
Loads an M8 Song from its bytes.
**Kind**: global function
| Param | Type | Description |
| --- | --- | --- |
| fileReader | module:m8-js/lib/types.M8FileReader | The M8 file reader |
## loadTable(fileReader) ⇒ module:m8-js/lib/types.Table
Loads an M8 Table from its bytes.
**Kind**: global function
| Param | Type | Description |
| --- | --- | --- |
| fileReader | module:m8-js/lib/types.M8FileReader | The M8 file reader |
## loadTheme(fileReader) ⇒ [Theme](#module_m8-js/lib/types.Theme)
Loads an M8 Theme from its bytes.
**Kind**: global function
| Param | Type | Description |
| --- | --- | --- |
| fileReader | module:m8-js/lib/types.M8FileReader | The M8 file reader |
## dumpM8File(m8File) ⇒ Uint8Array
Dumps an M8 file and returns its bytes.
**Kind**: global function
| Param | Type | Description |
| --- | --- | --- |
| m8File | module:m8-js/lib/types.M8File | The M8File instance to dump |
## loadM8File(bytes) ⇒ [Scale](#module_m8-js/lib/types.Scale) \| [Song](#module_m8-js/lib/types.Song) \| [Theme](#module_m8-js/lib/types.Theme) \| module:m8-js/lib/types/instruments.FMSYNTH \| module:m8-js/lib/types/instruments.MACROSYNTH \| module:m8-js/lib/types/instruments.MIDIOUT \| module:m8-js/lib/types/instruments.NONE \| module:m8-js/lib/types/instruments.SAMPLER \| module:m8-js/lib/types/instruments.WAVSYNTH
Loads an M8 file and returns the appropriate corresdponding object.
**Kind**: global function
| Param | Type | Description |
| --- | --- | --- |
| bytes | Array.<Number> | The raw M8 file bytes |