spessasynth_lib 3.16.1 → 3.16.3

package/@types/soundfont/{read → read_sf2}/zones.d.ts

@@ -3,10 +3,10 @@
  * @param zonesChunk {RiffChunk}
  * @param instrumentGenerators {Generator[]}
  * @param instrumentModulators {Modulator[]}
- * @param instrumentSamples {LoadedSample[]}
+ * @param instrumentSamples {BasicSample[]}
  * @returns {InstrumentZone[]}
  */
-export function readInstrumentZones(zonesChunk: RiffChunk, instrumentGenerators: Generator[], instrumentModulators: Modulator[], instrumentSamples: LoadedSample[]): InstrumentZone[];
+export function readInstrumentZones(zonesChunk: RiffChunk, instrumentGenerators: Generator[], instrumentModulators: Modulator[], instrumentSamples: BasicSample[]): InstrumentZone[];
 /**
  * Reads the given preset zone read
  * @param zonesChunk {RiffChunk}
@@ -20,37 +20,16 @@ export function readPresetZones(zonesChunk: RiffChunk, presetGenerators: Generat
  * zones.js
  * purpose: reads instrumend and preset zones from soundfont and gets their respective samples and generators and modulators
  */
-export class InstrumentZone {
+export class InstrumentZone extends BasicInstrumentZone {
     /**
      * Creates a zone (instrument)
      * @param dataArray {IndexedByteArray}
-     * @param index {number}
      */
-    constructor(dataArray: IndexedByteArray, index: number);
+    constructor(dataArray: IndexedByteArray);
     generatorZoneStartIndex: number;
     modulatorZoneStartIndex: number;
     modulatorZoneSize: number;
     generatorZoneSize: number;
-    zoneID: number;
-    keyRange: {
-        min: number;
-        max: number;
-    };
-    velRange: {
-        min: number;
-        max: number;
-    };
-    isGlobal: boolean;
-    useCount: number;
-    /**
-     * @type {Generator[]}
-     */
-    generators: Generator[];
-    /**
-     * @type {Modulator[]}
-     */
-    modulators: Modulator[];
-    deleteZone(): void;
     setZoneSize(modulatorZoneSize: any, generatorZoneSize: any): void;
     /**
      * grab the generators
@@ -64,10 +43,9 @@ export class InstrumentZone {
     getModulators(modulators: Modulator[]): void;
     /**
      * Loads the zone's sample
-     * @param samples {LoadedSample[]}
+     * @param samples {BasicSample[]}
      */
-    getSample(samples: LoadedSample[]): void;
-    sample: LoadedSample;
+    getSample(samples: BasicSample[]): void;
     /**
      * Reads the keyRange of the zone
      */
@@ -77,37 +55,17 @@ export class InstrumentZone {
      */
     getVelRange(): void;
 }
-export class PresetZone {
+export class PresetZone extends BasicPresetZone {
     /**
      * Creates a zone (preset)
      * @param dataArray {IndexedByteArray}
-     * @param index {number}
      */
-    constructor(dataArray: IndexedByteArray, index: number);
+    constructor(dataArray: IndexedByteArray);
     generatorZoneStartIndex: number;
     modulatorZoneStartIndex: number;
     modulatorZoneSize: number;
     generatorZoneSize: number;
-    zoneID: number;
-    keyRange: {
-        min: number;
-        max: number;
-    };
-    velRange: {
-        min: number;
-        max: number;
-    };
-    isGlobal: boolean;
-    /**
-     * @type {Generator[]}
-     */
-    generators: Generator[];
-    /**
-     * @type {Modulator[]}
-     */
-    modulators: Modulator[];
     setZoneSize(modulatorZoneSize: any, generatorZoneSize: any): void;
-    deleteZone(): void;
     /**
      * grab the generators
      * @param generators {Generator[]}
@@ -123,7 +81,6 @@ export class PresetZone {
      * @param instruments {Instrument[]}
      */
     getInstrument(instruments: Instrument[]): void;
-    instrument: Instrument;
     /**
      * Reads the keyRange of the zone
      */
@@ -133,9 +90,10 @@ export class PresetZone {
      */
     getVelRange(): void;
 }
-import { RiffChunk } from "./riff_chunk.js";
+import { RiffChunk } from "../basic_soundfont/riff_chunk.js";
 import { Generator } from "./generators.js";
 import { Modulator } from "./modulators.js";
-import { LoadedSample } from "./samples.js";
 import { Instrument } from "./instruments.js";
+import { BasicInstrumentZone } from '../basic_soundfont/basic_zones.js';
 import { IndexedByteArray } from "../../utils/indexed_array.js";
+import { BasicPresetZone } from '../basic_soundfont/basic_zones.js';

package/@types/soundfont/soundfont.d.ts

@@ -2,48 +2,15 @@
  * soundfont.js
  * purpose: parses a soundfont2 file
  */
-export class SoundFont2 {
-    /**
-     * Merges soundfonts with the given order. Keep in mind that the info read is copied from the first one
-     * @param soundfonts {...SoundFont2} the soundfonts to merge, the first overwrites the last
-     * @returns {SoundFont2}
-     */
-    static mergeSoundfonts(...soundfonts: SoundFont2[]): SoundFont2;
+export class SoundFont2 extends BasicSoundFont {
     /**
      * Initializes a new SoundFont2 Parser and parses the given data array
-     * @param arrayBuffer {ArrayBuffer|{presets: Preset[], info: Object<string, string>}}
+     * @param arrayBuffer {ArrayBuffer}
      */
-    constructor(arrayBuffer: ArrayBuffer | {
-        presets: Preset[];
-        info: {
-            [x: string]: string;
-        };
-    });
-    presets: Preset[];
-    soundFontInfo: {
-        [x: string]: string;
-    };
+    constructor(arrayBuffer: ArrayBuffer);
     dataArray: IndexedByteArray;
     sampleDataStartIndex: number;
-    samples: import("./read/samples.js").LoadedSample[];
-    /**
-     * read all the instruments
-     * @type {Instrument[]}
-     */
-    instruments: Instrument[];
-    removeUnusedElements(): void;
-    /**
-     * @param instrument {Instrument}
-     */
-    deleteInstrument(instrument: Instrument): void;
-    /**
-     * @param sample {LoadedSample}
-     */
-    deleteSample(sample: LoadedSample): void;
-    /**
-     * @param preset {Preset}
-     */
-    deletePreset(preset: Preset): void;
+    instruments: import("./read_sf2/instruments.js").Instrument[];
     /**
      * @param chunk {RiffChunk}
      * @param expected {string}
@@ -54,35 +21,7 @@ export class SoundFont2 {
      * @param expected {string}
      */
     verifyText(text: string, expected: string): void;
-    /**
-     * Get the appropriate preset, undefined if not foun d
-     * @param bankNr {number}
-     * @param presetNr {number}
-     * @return {Preset}
-     */
-    getPresetNoFallback(bankNr: number, presetNr: number): Preset;
-    /**
-     * To avoid overlapping on multiple desfonts
-     * @param offset {number}
-     */
-    setSampleIDOffset(offset: number): void;
-    /**
-     * Get the appropriate preset
-     * @param bankNr {number}
-     * @param presetNr {number}
-     * @returns {Preset}
-     */
-    getPreset(bankNr: number, presetNr: number): Preset;
-    /**
-     * gets preset by name
-     * @param presetName {string}
-     * @returns {Preset}
-     */
-    getPresetByName(presetName: string): Preset;
-    write: typeof write;
 }
-import { Preset } from "./read/presets.js";
+import { BasicSoundFont } from './basic_soundfont/basic_soundfont.js';
 import { IndexedByteArray } from '../utils/indexed_array.js';
-import { Instrument } from "./read/instruments.js";
-import { RiffChunk } from './read/riff_chunk.js';
-import { write } from './write/write.js';
+import { RiffChunk } from './basic_soundfont/riff_chunk.js';

package/midi_parser/midi_loader.js

@@ -2,7 +2,7 @@ import { dataBytesAmount, getChannel, messageTypes, MidiMessage } from './midi_m
 import { IndexedByteArray } from '../utils/indexed_array.js'
 import { arrayToHexString, consoleColors, formatTitle } from '../utils/other.js'
 import { SpessaSynthGroupCollapsed, SpessaSynthGroupEnd, SpessaSynthInfo } from '../utils/loggin.js'
-import { readRIFFChunk } from '../soundfont/read/riff_chunk.js'
+import { readRIFFChunk } from '../soundfont/basic_soundfont/riff_chunk.js'
 import { readVariableLengthQuantity } from '../utils/byte_functions/variable_length_quantity.js'
 import { readBytesAsUintBigEndian } from '../utils/byte_functions/big_endian.js'
 import { readBytesAsString } from '../utils/byte_functions/string.js'

package/midi_parser/rmidi_writer.js

@@ -1,6 +1,6 @@
 import { combineArrays, IndexedByteArray } from '../utils/indexed_array.js'
 import { writeMIDIFile } from './midi_writer.js'
-import { writeRIFFOddSize } from '../soundfont/read/riff_chunk.js'
+import { writeRIFFOddSize } from '../soundfont/basic_soundfont/riff_chunk.js'
 import { getStringBytes } from '../utils/byte_functions/string.js'
 import { messageTypes, midiControllers, MidiMessage } from './midi_message.js'
 import { DEFAULT_PERCUSSION } from '../synthetizer/synthetizer.js'
@@ -340,21 +340,21 @@ export function writeRMIDI(soundfontBinary, mid, soundfont, bankOffset = 0, enco
     const encoder = new TextEncoder();
     // software
     infoContent.push(
-        writeRIFFOddSize(RMIDINFOChunks.software, encoder.encode("SpessaSynth"))
+        writeRIFFOddSize(RMIDINFOChunks.software, encoder.encode("SpessaSynth"), true)
     );
     // name
     if(metadata.name !== undefined)
     {
 
         infoContent.push(
-            writeRIFFOddSize(RMIDINFOChunks.name, encoder.encode(metadata.name))
+            writeRIFFOddSize(RMIDINFOChunks.name, encoder.encode(metadata.name), true)
         );
         encoding = FORCED_ENCODING;
     }
     else
     {
         infoContent.push(
-            writeRIFFOddSize(RMIDINFOChunks.name, mid.rawMidiName)
+            writeRIFFOddSize(RMIDINFOChunks.name, mid.rawMidiName, true)
         );
     }
     // creation date
@@ -362,7 +362,7 @@ export function writeRMIDI(soundfontBinary, mid, soundfont, bankOffset = 0, enco
     {
         encoding = FORCED_ENCODING;
         infoContent.push(
-            writeRIFFOddSize(RMIDINFOChunks.creationDate, encoder.encode(metadata.creationDate))
+            writeRIFFOddSize(RMIDINFOChunks.creationDate, encoder.encode(metadata.creationDate), true)
         );
     }
     else
@@ -376,7 +376,7 @@ export function writeRMIDI(soundfontBinary, mid, soundfont, bankOffset = 0, enco
         minute: "numeric"
     });
         infoContent.push(
-            writeRIFFOddSize(RMIDINFOChunks.creationDate, getStringBytes(today))
+            writeRIFFOddSize(RMIDINFOChunks.creationDate, getStringBytes(today), true)
         );
     }
     // comment
@@ -391,7 +391,7 @@ export function writeRMIDI(soundfontBinary, mid, soundfont, bankOffset = 0, enco
     if(metadata.engineer !== undefined)
     {
         infoContent.push(
-            writeRIFFOddSize(RMIDINFOChunks.engineer, encoder.encode(metadata.engineer))
+            writeRIFFOddSize(RMIDINFOChunks.engineer, encoder.encode(metadata.engineer), true)
         )
     }
     // album
@@ -399,7 +399,7 @@ export function writeRMIDI(soundfontBinary, mid, soundfont, bankOffset = 0, enco
     {
         encoding = FORCED_ENCODING;
         infoContent.push(
-            writeRIFFOddSize(RMIDINFOChunks.album, encoder.encode(metadata.album))
+            writeRIFFOddSize(RMIDINFOChunks.album, encoder.encode(metadata.album), true)
         );
     }
     // artist
@@ -407,7 +407,7 @@ export function writeRMIDI(soundfontBinary, mid, soundfont, bankOffset = 0, enco
     {
         encoding = FORCED_ENCODING;
         infoContent.push(
-            writeRIFFOddSize(RMIDINFOChunks.artist, encoder.encode(metadata.artist))
+            writeRIFFOddSize(RMIDINFOChunks.artist, encoder.encode(metadata.artist), true)
         );
     }
     // genre
@@ -415,7 +415,7 @@ export function writeRMIDI(soundfontBinary, mid, soundfont, bankOffset = 0, enco
     {
         encoding = FORCED_ENCODING;
         infoContent.push(
-            writeRIFFOddSize(RMIDINFOChunks.genre, encoder.encode(metadata.genre))
+            writeRIFFOddSize(RMIDINFOChunks.genre, encoder.encode(metadata.genre), true)
         );
     }
     // picture
@@ -430,7 +430,7 @@ export function writeRMIDI(soundfontBinary, mid, soundfont, bankOffset = 0, enco
     {
         encoding = FORCED_ENCODING;
         infoContent.push(
-            writeRIFFOddSize(RMIDINFOChunks.copyright, encoder.encode(metadata.copyright))
+            writeRIFFOddSize(RMIDINFOChunks.copyright, encoder.encode(metadata.copyright), true)
         );
     }
     else

package/midi_parser/used_keys_loaded.js

@@ -5,7 +5,7 @@ import { messageTypes, midiControllers } from './midi_message.js'
 
 /**
  * @param mid {MIDI}
- * @param soundfont {{getPreset: function(number, number): Preset}}
+ * @param soundfont {{getPreset: function(number, number): BasicPreset}}
  * @returns {Object<string, Set<string>>}
  */
 export function getUsedProgramsAndKeys(mid, soundfont)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spessasynth_lib",
-  "version": "3.16.1",
+  "version": "3.16.3",
   "description": "No compromise MIDI and SoundFont2 Synthesizer library",
   "browser": "index.js",
   "types": "@types/index.d.ts",

package/sequencer/worklet_sequencer/song_control.js

@@ -68,7 +68,7 @@ export function loadNewSequence(parsedMidi)
         if(this.synth.overrideSoundfont)
         {
             // clean up the embedded soundfont
-            this.synth.clearSoundFont();
+            this.synth.clearSoundFont(true, true);
         }
         SpessaSynthGroupCollapsed("%cPreloading samples...", consoleColors.info);
         // smart preloading: load only samples used in the midi!

package/soundfont/basic_soundfont/basic_instrument.js

@@ -0,0 +1,73 @@
+export class BasicInstrument
+{
+    constructor()
+    {
+        /**
+         * The instrument's name
+         * @type {string}
+         */
+        this.instrumentName = "";
+        /**
+         * The instrument's zones
+         * @type {BasicInstrumentZone[]}
+         */
+        this.instrumentZones = [];
+        this._useCount = 0;
+    }
+
+    addUseCount()
+    {
+        this._useCount++;
+        this.instrumentZones.forEach(z => z.useCount++);
+    }
+
+    removeUseCount()
+    {
+        this._useCount--;
+        for(let i = 0; i < this.instrumentZones.length; i++)
+        {
+            if(this.safeDeleteZone(i))
+            {
+                i--;
+            }
+        }
+    }
+
+    /**
+     * @returns {number}
+     */
+    get useCount()
+    {
+        return this._useCount;
+    }
+
+    deleteInstrument()
+    {
+        this.instrumentZones.forEach(z => z.deleteZone());
+        this.instrumentZones.length = 0;
+    }
+
+    /**
+     * @param index {number}
+     * @returns {boolean} is the zone has been deleted
+     */
+    safeDeleteZone(index)
+    {
+        this.instrumentZones[index].useCount--;
+        if(this.instrumentZones[index].useCount < 1)
+        {
+            this.deleteZone(index);
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * @param index {number}
+     */
+    deleteZone(index)
+    {
+        this.instrumentZones[index].deleteZone();
+        this.instrumentZones.splice(index, 1);
+    }
+}

package/soundfont/{read/presets.js → basic_soundfont/basic_preset.js}

@@ -1,35 +1,45 @@
-import {RiffChunk} from "./riff_chunk.js";
-import {PresetZone} from "./zones.js";
-import {readBytesAsUintLittleEndian} from "../../utils/byte_functions/little_endian.js";
-import {LoadedSample} from "./samples.js";
-import { Generator, generatorTypes } from './generators.js'
-import { defaultModulators } from './modulators.js'
-import { readBytesAsString } from '../../utils/byte_functions/string.js'
-
 /**
- * parses soundfont presets, also includes function for getting the generators and samples from midi note and velocity
+ * @typedef {{
+ *  instrumentGenerators: Generator[],
+ *  presetGenerators: Generator[],
+ *  modulators: Modulator[],
+ *  sample: BasicSample,
+ *  sampleID: number,
+ * }} SampleAndGenerators
  */
+import { defaultModulators } from '../read_sf2/modulators.js'
+import { generatorTypes } from '../read_sf2/generators.js'
 
-export class Preset {
-    /**
-     * Creates a preset
-     * @param presetChunk {RiffChunk}
-     */
-    constructor(presetChunk)
+export class BasicPreset
+{
+    constructor()
     {
-        this.presetName = readBytesAsString(presetChunk.chunkData, 20)
-            .trim()
-            .replace(/\d{3}:\d{3}/, ""); // remove those pesky "000:001"
+        /**
+         * The preset's name
+         * @type {string}
+         */
+        this.presetName = "";
+        /**
+         * The preset's MIDI program number
+         * @type {number}
+         */
+        this.program = 0;
+        /**
+         * The preset's MIDI bank number
+         * @type {number}
+         */
+        this.bank = 0;
 
-        this.program = readBytesAsUintLittleEndian(presetChunk.chunkData, 2);
-        this.bank = readBytesAsUintLittleEndian(presetChunk.chunkData, 2);
-        this.presetZoneStartIndex = readBytesAsUintLittleEndian(presetChunk.chunkData, 2);
-        this.presetZonesAmount = 0;
         /**
-         * @type {PresetZone[]}
+         * The preset's zones
+         * @type {BasicPresetZone[]}
          */
         this.presetZones = [];
 
+        /**
+         * SampleID offset for this preset
+         * @type {number}
+         */
         this.sampleIDOffset = 0;
 
         /**
@@ -42,24 +52,21 @@ export class Preset {
             this.foundSamplesAndGenerators[i] = [];
         }
 
-        // read the dwords
-        this.library = readBytesAsUintLittleEndian(presetChunk.chunkData, 4);
-        this.genre = readBytesAsUintLittleEndian(presetChunk.chunkData, 4);
-        this.morphology = readBytesAsUintLittleEndian(presetChunk.chunkData, 4);
-    }
-
-    /**
-     * Loads all the preset zones, given the amount
-     * @param amount {number}
-     * @param zones {PresetZone[]}
-     */
-    getPresetZones(amount, zones)
-    {
-        this.presetZonesAmount = amount;
-        for (let i = this.presetZoneStartIndex; i < this.presetZonesAmount + this.presetZoneStartIndex; i++)
-        {
-            this.presetZones.push(zones[i]);
-        }
+        /**
+         * unused metadata
+         * @type {number}
+         */
+        this.library = 0;
+        /**
+         * unused metadata
+         * @type {number}
+         */
+        this.genre = 0;
+        /**
+         * unused metadata
+         * @type {number}
+         */
+        this.morphology = 0;
     }
 
     deletePreset()
@@ -111,16 +118,6 @@ export class Preset {
         })
     }
 
-    /**
-     * @typedef {{
-     *  instrumentGenerators: Generator[],
-     *  presetGenerators: Generator[],
-     *  modulators: Modulator[],
-     *  sample: LoadedSample,
-     *  sampleID: number,
-     * }} SampleAndGenerators
-     */
-
     /**
      * Returns generatorTranslator and generators for given note
      * @param midiNote {number}
@@ -215,12 +212,12 @@ export class Preset {
                 .filter(currentZone =>
                     (
                         isInRange(currentZone.keyRange.min,
-                        currentZone.keyRange.max,
-                        midiNote)
-                    &&
-                    isInRange(currentZone.velRange.min,
-                        currentZone.velRange.max,
-                        velocity)
+                            currentZone.keyRange.max,
+                            midiNote)
+                        &&
+                        isInRange(currentZone.velRange.min,
+                            currentZone.velRange.max,
+                            velocity)
                     ) && !currentZone.isGlobal
                 );
 
@@ -278,34 +275,4 @@ export class Preset {
         this.foundSamplesAndGenerators[midiNote][velocity] = parsedGeneratorsAndSamples;
         return parsedGeneratorsAndSamples;
     }
-}
-
-/**
- * Reads the presets
- * @param presetChunk {RiffChunk}
- * @param presetZones {PresetZone[]}
- * @returns {Preset[]}
- */
-export function readPresets(presetChunk, presetZones)
-{
-    /**
-     * @type {Preset[]}
-     */
-    let presets = [];
-    while(presetChunk.chunkData.length > presetChunk.chunkData.currentIndex)
-    {
-        let preset = new Preset(presetChunk);
-        if(presets.length > 0)
-        {
-            let presetZonesAmount = preset.presetZoneStartIndex - presets[presets.length - 1].presetZoneStartIndex;
-            presets[presets.length - 1].getPresetZones(presetZonesAmount, presetZones);
-        }
-        presets.push(preset);
-    }
-    // remove EOP
-    if (presets.length > 1)
-    {
-        presets.pop();
-    }
-    return presets;
 }