spessasynth_lib 3.16.2 → 3.16.4

package/soundfont/basic_soundfont/basic_sample.js

@@ -0,0 +1,132 @@
+/**
+ * samples.js
+ * purpose: parses soundfont samples, resamples if needed.
+ * loads sample data, handles async loading of sf3 compressed samples
+ */
+import { SpessaSynthWarn } from '../../utils/loggin.js'
+
+export class BasicSample {
+    /**
+     * The basic representation of a soundfont sample
+     * @param sampleName {string}
+     * @param sampleRate {number}
+     * @param samplePitch {number}
+     * @param samplePitchCorrection {number}
+     * @param sampleLink {number}
+     * @param sampleType {number}
+     * @param loopStart {number} relative to sample start
+     * @param loopEnd {number} relative to sample start
+     */
+    constructor(
+        sampleName,
+        sampleRate,
+        samplePitch,
+        samplePitchCorrection,
+        sampleLink,
+        sampleType,
+        loopStart,
+        loopEnd,
+    ) {
+        /**
+         * Sample's name
+         * @type {string}
+         */
+        this.sampleName = sampleName
+        /**
+         * Sample rate in Hz
+         * @type {number}
+         */
+        this.sampleRate = sampleRate
+        /**
+         * Original pitch of the sample as a MIDI note number
+         * @type {number}
+         */
+        this.samplePitch = samplePitch
+        /**
+         * Pitch correction, in cents. Can be negative
+         * @type {number}
+         */
+        this.samplePitchCorrection = samplePitchCorrection
+        /**
+         * Sample link, currently unused.
+         * @type {number}
+         */
+        this.sampleLink = sampleLink
+        /**
+         * Type of the sample, an enum
+         * @type {number}
+         */
+        this.sampleType = sampleType
+        /**
+         * Relative to start of the sample, bytes
+         * @type {number}
+         */
+        this.sampleLoopStartIndex = loopStart
+        /**
+         * Relative to start of the sample, in bytes
+         * @type {number}
+         */
+        this.sampleLoopEndIndex = loopEnd
+
+        /**
+         * Indicates if the sample is compressed
+         * @type {boolean}
+         */
+        this.isCompressed = (sampleType & 0x10) > 0
+
+        /**
+         * The compressed sample data if it was compressed by spessasynth
+         * @type {Uint8Array}
+         */
+        this.compressedData = undefined;
+
+        /**
+         * The sample's use count
+         * @type {number}
+         */
+        this.useCount = 0;
+    }
+
+    /**
+     * @returns {Uint8Array|IndexedByteArray}
+     */
+    getRawData()
+    {
+        const e = new Error('Not implemented')
+        e.name = 'NotImplementedError'
+        throw e
+    }
+
+    /**
+     * @param quality {number}
+     * @param encodeVorbis {EncodeVorbisFunction}
+     */
+    compressSample(quality, encodeVorbis) {
+        // no need to compress
+        if (this.isCompressed) {
+            return
+        }
+        // compress, always mono!
+        try {
+            this.compressedData = encodeVorbis([this.getAudioData()], 1, this.sampleRate, quality)
+            // flag as compressed
+            this.sampleType |= 0x10
+            this.isCompressed = true
+        } catch (e) {
+            SpessaSynthWarn(`Failed to compress ${this.sampleName}. Leaving as uncompressed!`)
+            this.isCompressed = false
+            this.compressedData = undefined
+            this.sampleType &= -17
+        }
+
+    }
+
+    /**
+     * @returns {Float32Array}
+     */
+    getAudioData() {
+        const e = new Error('Not implemented')
+        e.name = 'NotImplementedError'
+        throw e
+    }
+}

package/soundfont/basic_soundfont/basic_soundfont.js

@@ -0,0 +1,193 @@
+import { SpessaSynthWarn } from '../../utils/loggin.js'
+import { consoleColors } from '../../utils/other.js'
+import { write } from './write_sf2/write.js'
+
+class BasicSoundFont
+{
+    /**
+     * Creates a new basic soundfont template
+     * @param data {undefined|{presets: BasicPreset[], info: Object<string, string>}}
+     */
+    constructor(data = undefined)
+    {
+        /**
+         * Soundfont's info stored as name: value. ifil and iver are stored as string representation of float (e.g. 2.1)
+         * @type {Object<string, string>}
+         */
+        this.soundFontInfo = {};
+
+        /**
+         * The soundfont's presets
+         * @type {BasicPreset[]}
+         */
+        this.presets = []
+
+        /**
+         * The soundfont's samples
+         * @type {BasicSample[]}
+         */
+        this.samples = [];
+
+        /**
+         * The soundfont's instruments
+         * @type {BasicInstrument[]}
+         */
+        this.instruments = [];
+
+        if(data?.presets)
+        {
+            this.presets.push(...data.presets);
+            this.soundFontInfo = data.info;
+        }
+    }
+
+    removeUnusedElements()
+    {
+        this.instruments.forEach(i => {
+            if(i.useCount < 1)
+            {
+                i.instrumentZones.forEach(z => {if(!z.isGlobal) z.sample.useCount--});
+            }
+        })
+        this.instruments = this.instruments.filter(i => i.useCount > 0);
+        this.samples = this.samples.filter(s => s.useCount > 0);
+    }
+
+    /**
+     * @param instrument {BasicInstrument}
+     */
+    deleteInstrument(instrument)
+    {
+        if(instrument.useCount > 0)
+        {
+            throw new Error(`Cannot delete an instrument that has ${instrument.useCount} usages.`);
+        }
+        this.instruments.splice(this.instruments.indexOf(instrument), 1);
+        instrument.deleteInstrument();
+        this.removeUnusedElements();
+    }
+
+    /**
+     * @param sample {BasicSample}
+     */
+    deleteSample(sample)
+    {
+        if(sample.useCount > 0)
+        {
+            throw new Error(`Cannot delete sample that has ${sample.useCount} usages.`);
+        }
+        this.samples.splice(this.samples.indexOf(sample), 1);
+        this.removeUnusedElements();
+    }
+
+    /**
+     * @param preset {BasicPreset}
+     */
+    deletePreset(preset)
+    {
+        preset.deletePreset();
+        this.presets.splice(this.presets.indexOf(preset), 1);
+        this.removeUnusedElements();
+    }
+
+    /**
+     * Get the appropriate preset, undefined if not foun d
+     * @param bankNr {number}
+     * @param presetNr {number}
+     * @return {BasicPreset}
+     */
+    getPresetNoFallback(bankNr, presetNr)
+    {
+        return this.presets.find(p => p.bank === bankNr && p.program === presetNr);
+    }
+
+    /**
+     * To avoid overlapping on multiple desfonts
+     * @param offset {number}
+     */
+    setSampleIDOffset(offset)
+    {
+        this.presets.forEach(p => p.sampleIDOffset = offset);
+    }
+
+    /**
+     * Get the appropriate preset
+     * @param bankNr {number}
+     * @param presetNr {number}
+     * @returns {BasicPreset}
+     */
+    getPreset(bankNr, presetNr)
+    {
+        let preset = this.presets.find(p => p.bank === bankNr && p.program === presetNr);
+        if (!preset)
+        {
+            preset = this.presets.find(p => p.program === presetNr && p.bank !== 128);
+            if(bankNr === 128)
+            {
+                preset = this.presets.find(p => p.bank === 128 && p.program === presetNr);
+                if(!preset)
+                {
+                    preset = this.presets.find(p => p.bank === 128);
+                }
+            }
+            if(preset)
+            {
+                SpessaSynthWarn(`%cPreset ${bankNr}.${presetNr} not found. Replaced with %c${preset.presetName} (${preset.bank}.${preset.program})`,
+                    consoleColors.warn,
+                    consoleColors.recognized);
+            }
+        }
+        if(!preset)
+        {
+            SpessaSynthWarn(`Preset ${presetNr} not found. Defaulting to`, this.presets[0].presetName);
+            preset = this.presets[0];
+        }
+        return preset;
+    }
+
+    /**
+     * gets preset by name
+     * @param presetName {string}
+     * @returns {BasicPreset}
+     */
+    getPresetByName(presetName)
+    {
+        let preset = this.presets.find(p => p.presetName === presetName);
+        if(!preset)
+        {
+            SpessaSynthWarn("Preset not found. Defaulting to:", this.presets[0].presetName);
+            preset = this.presets[0];
+        }
+        return preset;
+    }
+
+
+    /**
+     * Merges soundfonts with the given order. Keep in mind that the info read is copied from the first one
+     * @param soundfonts {...BasicSoundFont} the soundfonts to merge, the first overwrites the last
+     * @returns {BasicSoundFont}
+     */
+    static mergeSoundfonts(...soundfonts)
+    {
+        const mainSf = soundfonts.shift();
+        const presets = mainSf.presets;
+        while(soundfonts.length)
+        {
+            const newPresets = soundfonts.shift().presets;
+            newPresets.forEach(newPreset => {
+                if(
+                    presets.find(existingPreset => existingPreset.bank === newPreset.bank && existingPreset.program === newPreset.program) === undefined
+                )
+                {
+                    presets.push(newPreset);
+                }
+            })
+        }
+
+        return new BasicSoundFont({presets: presets, info: mainSf.soundFontInfo});
+    }
+}
+
+BasicSoundFont.prototype.write = write;
+
+export { BasicSoundFont }

package/soundfont/basic_soundfont/basic_zone.js

@@ -0,0 +1,39 @@
+/**
+ * @typedef {Object} SoundFontRange
+ * @property {number} min - the minimum midi note
+ * @property {number} max - the maximum midi note
+ */
+
+export class BasicZone
+{
+    constructor()
+    {
+        /**
+         * The zone's generators
+         * @type {Generator[]}
+         */
+        this.generators = [];
+        /**
+         * The zone's modulators
+         * @type {Modulator[]}
+         */
+        this.modulators = [];
+        /**
+         * Indicates if the zone is global
+         * @type {boolean}
+         */
+        this.isGlobal = false;
+        /**
+         * The zone's key range
+         * @type {SoundFontRange}
+         */
+        this.keyRange = { min: 0, max: 127 };
+
+        /**
+         * The zone's velocity range
+         * @type {SoundFontRange}
+         */
+        this.velRange = { min: 0, max: 127 };
+    }
+}
+

package/soundfont/basic_soundfont/basic_zones.js

@@ -0,0 +1,47 @@
+import { BasicZone } from './basic_zone.js'
+
+export class BasicInstrumentZone extends BasicZone
+{
+    constructor()
+    {
+        super()
+        /**
+         * Zone's sample. Undefined if global
+         * @type {BasicSample|undefined}
+         */
+        this.sample = undefined
+        this.useCount = 0
+    }
+
+    deleteZone()
+    {
+        this.useCount--
+        if (this.isGlobal)
+        {
+            return
+        }
+        this.sample.useCount--
+    }
+}
+
+export class BasicPresetZone extends BasicZone
+{
+    constructor()
+    {
+        super()
+        /**
+         * Zone's instrument. Undefined if global
+         * @type {BasicInstrument|undefined}
+         */
+        this.instrument = undefined
+    }
+
+    deleteZone()
+    {
+        if(this.isGlobal)
+        {
+            return;
+        }
+        this.instrument.removeUseCount();
+    }
+}

package/soundfont/{read → basic_soundfont}/riff_chunk.js

@@ -91,10 +91,17 @@ export function writeRIFFChunk(chunk, prepend = undefined)
 /**
  * @param header {string}
  * @param data {Uint8Array}
+ * @param addZeroByte {Boolean}
  * @returns {IndexedByteArray}
  */
-export function writeRIFFOddSize(header, data)
+export function writeRIFFOddSize(header, data, addZeroByte = false)
 {
+    if(addZeroByte)
+    {
+        const tempData = new Uint8Array(data.length + 1);
+        tempData.set(data, 0);
+        data = tempData;
+    }
     let finalSize = 8 + data.length;
     if(finalSize % 2 !== 0)
     {

package/soundfont/{write → basic_soundfont/write_sf2}/ibag.js

@@ -1,9 +1,9 @@
-import { IndexedByteArray } from '../../utils/indexed_array.js'
-import { writeWord } from '../../utils/byte_functions/little_endian.js'
-import { RiffChunk, writeRIFFChunk } from '../read/riff_chunk.js'
+import { IndexedByteArray } from '../../../utils/indexed_array.js'
+import { writeWord } from '../../../utils/byte_functions/little_endian.js'
+import { RiffChunk, writeRIFFChunk } from '../riff_chunk.js'
 
 /**
- * @this {SoundFont2}
+ * @this {BasicSoundFont}
  * @returns {IndexedByteArray}
  */
 export function getIBAG()

package/soundfont/{write → basic_soundfont/write_sf2}/igen.js

@@ -1,10 +1,10 @@
-import { writeDword, writeWord } from '../../utils/byte_functions/little_endian.js'
-import { IndexedByteArray } from '../../utils/indexed_array.js'
-import { RiffChunk, writeRIFFChunk } from '../read/riff_chunk.js'
-import { generatorTypes } from '../read/generators.js'
+import { writeDword, writeWord } from '../../../utils/byte_functions/little_endian.js'
+import { IndexedByteArray } from '../../../utils/indexed_array.js'
+import { RiffChunk, writeRIFFChunk } from '../riff_chunk.js'
+import { generatorTypes } from '../../read_sf2/generators.js'
 
 /**
- * @this {SoundFont2}
+ * @this {BasicSoundFont}
  * @returns {IndexedByteArray}
  */
 export function getIGEN()

package/soundfont/{write → basic_soundfont/write_sf2}/imod.js

@@ -1,9 +1,9 @@
-import { IndexedByteArray } from '../../utils/indexed_array.js'
-import { writeLittleEndian, writeWord } from '../../utils/byte_functions/little_endian.js'
-import { RiffChunk, writeRIFFChunk } from '../read/riff_chunk.js'
+import { IndexedByteArray } from '../../../utils/indexed_array.js'
+import { writeLittleEndian, writeWord } from '../../../utils/byte_functions/little_endian.js'
+import { RiffChunk, writeRIFFChunk } from '../riff_chunk.js'
 
 /**
- * @this {SoundFont2}
+ * @this {BasicSoundFont}
  * @returns {IndexedByteArray}
  */
 export function getIMOD()

package/soundfont/{write → basic_soundfont/write_sf2}/inst.js

@@ -1,10 +1,10 @@
-import { IndexedByteArray } from '../../utils/indexed_array.js'
-import { writeStringAsBytes } from '../../utils/byte_functions/string.js'
-import { writeWord } from '../../utils/byte_functions/little_endian.js'
-import { RiffChunk, writeRIFFChunk } from '../read/riff_chunk.js'
+import { IndexedByteArray } from '../../../utils/indexed_array.js'
+import { writeStringAsBytes } from '../../../utils/byte_functions/string.js'
+import { writeWord } from '../../../utils/byte_functions/little_endian.js'
+import { RiffChunk, writeRIFFChunk } from '../riff_chunk.js'
 
 /**
- * @this {SoundFont2}
+ * @this {BasicSoundFont}
  * @returns {IndexedByteArray}
  */
 export function getINST()

package/soundfont/{write → basic_soundfont/write_sf2}/pbag.js

@@ -1,9 +1,9 @@
-import { IndexedByteArray } from '../../utils/indexed_array.js'
-import { writeWord } from '../../utils/byte_functions/little_endian.js'
-import { RiffChunk, writeRIFFChunk } from '../read/riff_chunk.js'
+import { IndexedByteArray } from '../../../utils/indexed_array.js'
+import { writeWord } from '../../../utils/byte_functions/little_endian.js'
+import { RiffChunk, writeRIFFChunk } from '../riff_chunk.js'
 
 /**
- * @this {SoundFont2}
+ * @this {BasicSoundFont}
  * @returns {IndexedByteArray}
  */
 export function getPBAG()

package/soundfont/{write → basic_soundfont/write_sf2}/pgen.js

@@ -1,10 +1,10 @@
-import { writeWord } from '../../utils/byte_functions/little_endian.js'
-import { IndexedByteArray } from '../../utils/indexed_array.js'
-import { RiffChunk, writeRIFFChunk } from '../read/riff_chunk.js'
-import { generatorTypes } from '../read/generators.js'
+import { writeWord } from '../../../utils/byte_functions/little_endian.js'
+import { IndexedByteArray } from '../../../utils/indexed_array.js'
+import { RiffChunk, writeRIFFChunk } from '../riff_chunk.js'
+import { generatorTypes } from '../../read_sf2/generators.js'
 
 /**
- * @this {SoundFont2}
+ * @this {BasicSoundFont}
  * @returns {IndexedByteArray}
  */
 export function getPGEN()

package/soundfont/{write → basic_soundfont/write_sf2}/phdr.js

@@ -1,10 +1,10 @@
-import { IndexedByteArray } from '../../utils/indexed_array.js'
-import { writeStringAsBytes } from '../../utils/byte_functions/string.js'
-import { writeDword, writeWord } from '../../utils/byte_functions/little_endian.js'
-import { RiffChunk, writeRIFFChunk } from '../read/riff_chunk.js'
+import { IndexedByteArray } from '../../../utils/indexed_array.js'
+import { writeStringAsBytes } from '../../../utils/byte_functions/string.js'
+import { writeDword, writeWord } from '../../../utils/byte_functions/little_endian.js'
+import { RiffChunk, writeRIFFChunk } from '../riff_chunk.js'
 
 /**
- * @this {SoundFont2}
+ * @this {BasicSoundFont}
  * @returns {IndexedByteArray}
  */
 export function getPHDR()

package/soundfont/{write → basic_soundfont/write_sf2}/pmod.js

@@ -1,9 +1,9 @@
-import { IndexedByteArray } from '../../utils/indexed_array.js'
-import { writeLittleEndian, writeWord } from '../../utils/byte_functions/little_endian.js'
-import { RiffChunk, writeRIFFChunk } from '../read/riff_chunk.js'
+import { IndexedByteArray } from '../../../utils/indexed_array.js'
+import { writeLittleEndian, writeWord } from '../../../utils/byte_functions/little_endian.js'
+import { RiffChunk, writeRIFFChunk } from '../riff_chunk.js'
 
 /**
- * @this {SoundFont2}
+ * @this {BasicSoundFont}
  * @returns {IndexedByteArray}
  */
 export function getPMOD()

package/soundfont/{write → basic_soundfont/write_sf2}/sdta.js

@@ -1,10 +1,10 @@
-import { RiffChunk, writeRIFFChunk } from '../read/riff_chunk.js'
-import { IndexedByteArray } from '../../utils/indexed_array.js'
-import { SpessaSynthInfo } from '../../utils/loggin.js'
-import { consoleColors } from '../../utils/other.js'
+import { RiffChunk, writeRIFFChunk } from '../riff_chunk.js'
+import { IndexedByteArray } from '../../../utils/indexed_array.js'
+import { SpessaSynthInfo } from '../../../utils/loggin.js'
+import { consoleColors } from '../../../utils/other.js'
 
 /**
- * @this {SoundFont2}
+ * @this {BasicSoundFont}
  * @param smplStartOffsets {number[]}
  * @param smplEndOffsets {number[]}
  * @param compress {boolean}

package/soundfont/{write → basic_soundfont/write_sf2}/shdr.js

@@ -1,10 +1,10 @@
-import { IndexedByteArray } from '../../utils/indexed_array.js'
-import { writeStringAsBytes } from '../../utils/byte_functions/string.js'
-import { writeDword, writeWord } from '../../utils/byte_functions/little_endian.js'
-import { RiffChunk, writeRIFFChunk } from '../read/riff_chunk.js'
+import { IndexedByteArray } from '../../../utils/indexed_array.js'
+import { writeStringAsBytes } from '../../../utils/byte_functions/string.js'
+import { writeDword, writeWord } from '../../../utils/byte_functions/little_endian.js'
+import { RiffChunk, writeRIFFChunk } from '../riff_chunk.js'
 
 /**
- * @this {SoundFont2}
+ * @this {BasicSoundFont}
  * @param smplStartOffsets {number[]}
  * @param smplEndOffsets {number[]}
  * @returns {IndexedByteArray}

package/soundfont/{write → basic_soundfont/write_sf2}/soundfont_trimmer.js

@@ -1,14 +1,14 @@
-import { consoleColors } from '../../utils/other.js'
+import { consoleColors } from '../../../utils/other.js'
 import {
     SpessaSynthGroup,
     SpessaSynthGroupCollapsed,
     SpessaSynthGroupEnd,
-    SpessaSynthInfo,
-} from '../../utils/loggin.js'
-import { getUsedProgramsAndKeys } from '../../midi_parser/used_keys_loaded.js'
+    SpessaSynthInfo
+} from '../../../utils/loggin.js'
+import { getUsedProgramsAndKeys } from '../../../midi_parser/used_keys_loaded.js'
 
 /**
- * @param soundfont {SoundFont2}
+ * @param soundfont {BasicSoundFont}
  * @param mid {MIDI}
  * @returns {Uint8Array}
  */

package/soundfont/{write → basic_soundfont/write_sf2}/write.js

@@ -1,7 +1,7 @@
-import { combineArrays, IndexedByteArray } from '../../utils/indexed_array.js'
-import { RiffChunk, writeRIFFChunk } from '../read/riff_chunk.js'
-import { writeStringAsBytes } from '../../utils/byte_functions/string.js'
-import { consoleColors } from '../../utils/other.js'
+import { combineArrays, IndexedByteArray } from '../../../utils/indexed_array.js'
+import { RiffChunk, writeRIFFChunk } from '../riff_chunk.js'
+import { writeStringAsBytes } from '../../../utils/byte_functions/string.js'
+import { consoleColors } from '../../../utils/other.js'
 import { getIGEN } from './igen.js'
 import { getSDTA } from './sdta.js'
 import { getSHDR } from './shdr.js'
@@ -12,13 +12,12 @@ import { getPGEN } from './pgen.js'
 import { getPMOD } from './pmod.js'
 import { getPBAG } from './pbag.js'
 import { getPHDR } from './phdr.js'
-import { writeWord } from '../../utils/byte_functions/little_endian.js'
+import { writeWord } from '../../../utils/byte_functions/little_endian.js'
 import {
     SpessaSynthGroupCollapsed,
     SpessaSynthGroupEnd,
-    SpessaSynthInfo,
-} from '../../utils/loggin.js'
-
+    SpessaSynthInfo
+} from '../../../utils/loggin.js'
 /**
  * @typedef {Object} SoundFont2WriteOptions
  * @property {boolean} compress - if the soundfont should be compressed with the ogg vorbis codec
@@ -37,7 +36,7 @@ const DEFAULT_WRITE_OPTIONS = {
 
 /**
  * Write the soundfont as an .sf2 file. This method is DESTRUCTIVE
- * @this {SoundFont2}
+ * @this {BasicSoundFont}
  * @param {SoundFont2WriteOptions} options
  * @returns {Uint8Array}
  */

package/soundfont/{read → read_sf2}/generators.js

@@ -1,5 +1,5 @@
 import { IndexedByteArray } from '../../utils/indexed_array.js'
-import { RiffChunk } from './riff_chunk.js'
+import { RiffChunk } from '../basic_soundfont/riff_chunk.js'
 import { signedInt16 } from '../../utils/byte_functions/little_endian.js'
 
 /**
@@ -11,6 +11,7 @@ import { signedInt16 } from '../../utils/byte_functions/little_endian.js'
  * @enum {number}
  */
 export const generatorTypes = {
+    INVALID: -1,                        // invalid generator
     startAddrsOffset: 0,                // sample control - moves sample start point
     endAddrOffset: 1,                   // sample control - moves sample end point
     startloopAddrsOffset: 2,            // loop control - moves loop start point