spessasynth_lib 3.15.1 → 3.16.0

package/@types/midi_parser/used_keys_loaded.d.ts

@@ -1,8 +1,10 @@
 /**
  * @param mid {MIDI}
- * @param soundfont {SoundFont2}
+ * @param soundfont {{getPreset: function(number, number): Preset}}
  * @returns {Object<string, Set<string>>}
  */
-export function getUsedProgramsAndKeys(mid: MIDI, soundfont: SoundFont2): {
+export function getUsedProgramsAndKeys(mid: MIDI, soundfont: {
+    getPreset: (arg0: number, arg1: number) => Preset;
+}): {
     [x: string]: Set<string>;
 };

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

@@ -23,6 +23,7 @@ export class Preset {
      * @type {PresetZone[]}
      */
     presetZones: PresetZone[];
+    sampleIDOffset: number;
     /**
      * Stores already found getSamplesAndGenerators for reuse
      * @type {SampleAndGenerators[][][]}

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

@@ -54,6 +54,18 @@ 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}

package/@types/synthetizer/synth_soundfont_manager.d.ts

@@ -0,0 +1,52 @@
+export class SoundfontManager {
+    /**
+     * Creates a new instance of the soundfont manager
+     * @param synth {Synthetizer}
+     */
+    constructor(synth: Synthetizer);
+    /**
+     * The current list of soundfonts, in order from the most important to the least.
+     * @type {{
+     *     id: string,
+     *     bankOffset: number
+     * }[]}
+     */
+    soundfontList: {
+        id: string;
+        bankOffset: number;
+    }[];
+    /**
+     * @type {MessagePort}
+     * @private
+     */
+    private _port;
+    synth: Synthetizer;
+    /**
+     * @private
+     * @param type {WorkletSoundfontManagerMessageType}
+     * @param data {any}
+     */
+    private _sendToWorklet;
+    /**
+     * Adds a new soundfont buffer with a given ID
+     * @param soundfontBuffer {ArrayBuffer} - the soundfont's buffer
+     * @param id {string} - the soundfont's unique identifier
+     * @param bankOffset {number} - the soundfont's bank offset. Default is 0
+     */
+    addNewSoundFont(soundfontBuffer: ArrayBuffer, id: string, bankOffset?: number): Promise<void>;
+    /**
+     * Deletes a soundfont with the given ID
+     * @param id {string} - the soundfont to delete
+     */
+    deleteSoundFont(id: string): void;
+    /**
+     * Rearranges the soundfonts in a given order
+     * @param newList {string[]} the order of soundfonts, a list of identifiers, first overwrites second
+     */
+    rearrangeSoundFonts(newList: string[]): void;
+    /**
+     * DELETES ALL SOUNDFONTS!! and creates a new one with id "main"
+     * @param newBuffer {ArrayBuffer}
+     */
+    reloadManager(newBuffer: ArrayBuffer): Promise<void>;
+}

package/@types/synthetizer/synthetizer.d.ts

@@ -50,12 +50,15 @@ export class Synthetizer {
      * @type {number}
      */
     channelsAmount: number;
+    /**
+     * @type {function}
+     */
+    resolveWhenReady: Function;
     /**
      * Indicates if the synth is fully ready
      * @type {Promise<void>}
      */
     isReady: Promise<void>;
-    _resolveReady: (value: void | PromiseLike<void>) => void;
     /**
      * individual channel voices amount
      * @type {ChannelProperty[]}
@@ -68,6 +71,11 @@ export class Synthetizer {
      */
     _highPerformanceMode: boolean;
     worklet: AudioWorkletNode;
+    /**
+     * The synth's soundfont manager
+     * @type {SoundfontManager}
+     */
+    soundfontManager: SoundfontManager;
     /**
      * @type {function(SynthesizerSnapshot)}
      * @private
@@ -245,8 +253,11 @@ export class Synthetizer {
     muteChannel(channel: number, isMuted: boolean): void;
     /**
      * Reloads the sounfont.
+     * THIS IS DEPRECATED!
+     * USE soundfontManager INSTEAD
      * @param soundFontBuffer {ArrayBuffer} the new soundfont file array buffer
      * @return {Promise<void>}
+     * @deprecated Use the soundfontManager property
      */
     reloadSoundFont(soundFontBuffer: ArrayBuffer): Promise<void>;
     /**
@@ -290,5 +301,6 @@ export type StartRenderingDataConfig = {
     oneOutput: boolean | undefined;
 };
 import { EventHandler } from './synth_event_handler.js';
+import { SoundfontManager } from './synth_soundfont_manager.js';
 import { FancyChorus } from './audio_effects/fancy_chorus.js';
 import { IndexedByteArray } from '../utils/indexed_array.js';

package/@types/synthetizer/worklet_system/message_protocol/worklet_message.d.ts

@@ -12,7 +12,7 @@ export namespace workletMessageType {
     let killNote: number;
     let ccReset: number;
     let setChannelVibrato: number;
-    let reloadSoundFont: number;
+    let soundFontManager: number;
     let stopAll: number;
     let killNotes: number;
     let muteChannel: number;
@@ -85,5 +85,5 @@ export type WorkletReturnMessage = {
     } | ChannelProperty[] | PresetListElement[] | string | {
         messageType: WorkletSequencerReturnMessageType;
         messageData: any;
-    } | SynthesizerSnapshot;
+    } | SynthesizerSnapshot | [WorkletSoundfontManagerMessageType, any];
 };

package/@types/synthetizer/worklet_system/worklet_methods/worklet_soundfont_manager/sfman_message.d.ts

@@ -0,0 +1,7 @@
+export type WorkletSoundfontManagerMessageType = number;
+export namespace WorkletSoundfontManagerMessageType {
+    let reloadSoundFont: number;
+    let addNewSoundFont: number;
+    let deleteSoundFont: number;
+    let rearrangeSoundFonts: number;
+}

package/README.md

@@ -40,6 +40,7 @@ document.getElementById("button").onclick = async () => {
     - **Modulator Support:** _First (to my knowledge) JavaScript SoundFont synth with that feature!_
     - **SoundFont3 Support:** Play compressed SoundFonts!
     - **Can load very large SoundFonts:** up to 4GB! _Note: Only Firefox handles this well; Chromium has a hard-coded memory limit_
+    - **Soundfont manager:** Stack multiple soundfonts!
 - **Reverb and chorus support:** [customizable!](https://github.com/spessasus/SpessaSynth/wiki/Synthetizer-Class#effects-configuration-object)
 - **Export audio files** using [OfflineAudioContext](https://developer.mozilla.org/en-US/docs/Web/API/OfflineAudioContext)
 - **[Custom modulators for additional controllers](https://github.com/spessasus/SpessaSynth/wiki/Modulator-Class#default-modulators):** Why not?

package/midi_parser/used_keys_loaded.js

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

package/package.json

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

package/sequencer/worklet_sequencer/song_control.js

@@ -67,12 +67,12 @@ export function loadNewSequence(parsedMidi)
     {
         if(this.synth.overrideSoundfont)
         {
-            // clean up the emdeeded soundfont
+            // clean up the embedded soundfont
             this.synth.clearSoundFont();
         }
         SpessaSynthGroupCollapsed("%cPreloading samples...", consoleColors.info);
         // smart preloading: load only samples used in the midi!
-        const used = getUsedProgramsAndKeys(this.midiData, this.synth.soundfont);
+        const used = getUsedProgramsAndKeys(this.midiData, this.synth.soundfontManager);
         for (const [programBank, combos] of Object.entries(used))
         {
             const bank = parseInt(programBank.split(":")[0]);

package/soundfont/read/presets.js

@@ -30,6 +30,8 @@ export class Preset {
          */
         this.presetZones = [];
 
+        this.sampleIDOffset = 0;
+
         /**
          * Stores already found getSamplesAndGenerators for reuse
          * @type {SampleAndGenerators[][][]}

package/soundfont/soundfont.js

@@ -49,6 +49,11 @@ class SoundFont2
             SpessaSynthGroupEnd();
             throw new SyntaxError(`Invalid soundFont! Expected "sfbk" or "sfpk" got "${type}"`);
         }
+        /*
+        Some SF2Pack description:
+        this is essentially sf2, but the entire smpl chunk is compressed (we only support ogg vorbis here)
+        and the only other difference is that the main chunk isn't "sfbk" but rather "sfpk"
+         */
         const isSF2Pack = type === "sfpk";
 
         // INFO
@@ -316,6 +321,26 @@ class SoundFont2
         }
     }
 
+    /**
+     * Get the appropriate preset, undefined if not foun d
+     * @param bankNr {number}
+     * @param presetNr {number}
+     * @return {Preset}
+     */
+    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}

package/synthetizer/synth_soundfont_manager.js

@@ -0,0 +1,111 @@
+import { workletMessageType } from './worklet_system/message_protocol/worklet_message.js'
+import {
+    WorkletSoundfontManagerMessageType
+} from './worklet_system/worklet_methods/worklet_soundfont_manager/sfman_message.js'
+import { SpessaSynthWarn } from '../utils/loggin.js'
+
+export class SoundfontManager
+{
+    /**
+     * Creates a new instance of the soundfont manager
+     * @param synth {Synthetizer}
+     */
+    constructor(synth)
+    {
+        /**
+         * The current list of soundfonts, in order from the most important to the least.
+         * @type {{
+         *     id: string,
+         *     bankOffset: number
+         * }[]}
+         */
+        this.soundfontList = [{
+            id: "main",
+            bankOffset: 0
+        }];
+
+        /**
+         * @type {MessagePort}
+         * @private
+         */
+        this._port = synth.worklet.port;
+        this.synth = synth;
+    }
+
+    /**
+     * @private
+     * @param type {WorkletSoundfontManagerMessageType}
+     * @param data {any}
+     */
+    _sendToWorklet(type, data)
+    {
+        this._port.postMessage({
+            messageType: workletMessageType.soundFontManager,
+            messageData: [
+                type,
+                data
+            ]
+        });
+    }
+
+    /**
+     * Adds a new soundfont buffer with a given ID
+     * @param soundfontBuffer {ArrayBuffer} - the soundfont's buffer
+     * @param id {string} - the soundfont's unique identifier
+     * @param bankOffset {number} - the soundfont's bank offset. Default is 0
+     */
+    async addNewSoundFont(soundfontBuffer, id, bankOffset = 0)
+    {
+        if(this.soundfontList.find(s => s.id === id) !== undefined)
+        {
+            throw new Error("Cannot overwrite the existing soundfont. Use soundfontManager.delete(id) instead.");
+        }
+        this._sendToWorklet(WorkletSoundfontManagerMessageType.addNewSoundFont, [soundfontBuffer, id, bankOffset]);
+        await new Promise(r => this.synth.resolveWhenReady = r);
+        this.soundfontList.push({
+            id: id,
+            bankOffset: bankOffset
+        });
+    }
+
+    /**
+     * Deletes a soundfont with the given ID
+     * @param id {string} - the soundfont to delete
+     */
+    deleteSoundFont(id)
+    {
+        if(this.soundfontList.length === 0)
+        {
+            SpessaSynthWarn("1 soundfont left. Aborting!");
+            return;
+        }
+        if(this.soundfontList.findIndex(s => s.id === id) === -1)
+        {
+            SpessaSynthWarn(`No soundfont with id of "${id}" found. Aborting!`);
+            return;
+        }
+        this._sendToWorklet(WorkletSoundfontManagerMessageType.deleteSoundFont, id);
+    }
+
+    /**
+     * Rearranges the soundfonts in a given order
+     * @param newList {string[]} the order of soundfonts, a list of identifiers, first overwrites second
+     */
+    rearrangeSoundFonts(newList)
+    {
+        this._sendToWorklet(WorkletSoundfontManagerMessageType.rearrangeSoundFonts, newList);
+        this.soundfontList.sort((a, b) =>
+            newList.indexOf(a.id) - newList.indexOf(b.id)
+        );
+    }
+
+    /**
+     * DELETES ALL SOUNDFONTS!! and creates a new one with id "main"
+     * @param newBuffer {ArrayBuffer}
+     */
+    async reloadManager(newBuffer)
+    {
+        this._sendToWorklet(WorkletSoundfontManagerMessageType.reloadSoundFont, newBuffer);
+        await new Promise(r => this.synth.resolveWhenReady = r);
+    }
+}

package/synthetizer/synthetizer.js

@@ -11,6 +11,7 @@ import {
 } from './worklet_system/message_protocol/worklet_message.js'
 import { SpessaSynthInfo, SpessaSynthWarn } from '../utils/loggin.js'
 import { DEFAULT_EFFECTS_CONFIG } from './audio_effects/effects_config.js'
+import { SoundfontManager } from './synth_soundfont_manager.js'
 
 
 /**
@@ -81,11 +82,16 @@ export class Synthetizer {
          */
         this.channelsAmount = this._outputsAmount;
 
+        /**
+         * @type {function}
+         */
+        this.resolveWhenReady = undefined;
+
         /**
          * Indicates if the synth is fully ready
          * @type {Promise<void>}
          */
-        this.isReady = new Promise(resolve => this._resolveReady = resolve);
+        this.isReady = new Promise(resolve => this.resolveWhenReady = resolve);
 
 
         /**
@@ -145,6 +151,12 @@ export class Synthetizer {
         // worklet sends us some data back
         this.worklet.port.onmessage = e => this.handleMessage(e.data);
 
+        /**
+         * The synth's soundfont manager
+         * @type {SoundfontManager}
+         */
+        this.soundfontManager = new SoundfontManager(this);
+
         /**
          * @type {function(SynthesizerSnapshot)}
          * @private
@@ -282,7 +294,7 @@ export class Synthetizer {
                 break;
 
             case returnMessageType.ready:
-                this._resolveReady();
+                this.resolveWhenReady();
                 break;
 
             case returnMessageType.soundfontError:
@@ -634,21 +646,16 @@ export class Synthetizer {
 
     /**
      * Reloads the sounfont.
+     * THIS IS DEPRECATED!
+     * USE soundfontManager INSTEAD
      * @param soundFontBuffer {ArrayBuffer} the new soundfont file array buffer
      * @return {Promise<void>}
+     * @deprecated Use the soundfontManager property
      */
     async reloadSoundFont(soundFontBuffer)
     {
-        // copy and use transferable
-        const bufferCopy = soundFontBuffer.slice(0);
-        await new Promise(resolve => {
-            this._resolveReady = resolve;
-            this.worklet.port.postMessage({
-                channelNumber: 0,
-                messageType: workletMessageType.reloadSoundFont,
-                messageData: bufferCopy
-            }, [bufferCopy]);
-        });
+        SpessaSynthWarn("reloadSoundFont is deprecated. Please use the soundfontManager property instead.")
+        await this.soundfontManager.reloadManager(soundFontBuffer);
     }
 
     /**