spessasynth_lib 4.0.20 → 4.1.0

package/README.md

@@ -3,38 +3,30 @@
 <img src='https://raw.githubusercontent.com/spessasus/SpessaSynth/refs/heads/master/src/website/spessasynth_logo_rounded.png' width='300' alt='SpessaSynth logo'>
 </p>
 
-*A powerful SF2/DLS/MIDI JavaScript library for the browsers, based on spessasynth_core.
-This is a WebAudioAPI wrapper for the [spessasynth_core](https://github.com/spessasus/spessasynth_core) library.*
-
-**v4.0.0 TypeScript Update is here! The NPM package now contains type declarations for easier developing!**
-[**Read about breaking changes here**](https://spessasus.github.io/spessasynth_lib/extra/4-0-migration-guide)
-
+_A powerful SF2/DLS/MIDI TypeScript/JavaScript library for the browsers, based on spessasynth_core.
+This is a WebAudioAPI wrapper for the [spessasynth_core](https://github.com/spessasus/spessasynth_core) library._
 
 It allows you to:
+
 - Play MIDI files using SF2/SF3/DLS files!
 - Read and write MIDI files!
 - Write SF2/SF3 files!
 - Convert DLS to SF2! (and back!)
 - [and more!](#current-features)
 
-
 > **TIP:**
-> 
+>
 > Looking for a bare JS version that works without WebAudioAPI? Try [spessasynth_core](https://github.com/spessasus/spessasynth_core)!
 
-
-
 ### [Project site (consider giving it a star!)](https://github.com/spessasus/spessasynth_lib)
 
 ### Made with spessasynth_lib
+
 - [SpessaSynth - Online SF2/DLS MIDI Player](https://spessasus.github.io/SpessaSynth)
 - [SpessaFont - Online SoundFont/DLS Editor](https://spessasus.github.io/SpessaFont)
 
-
 ### [Documentation](https://spessasus.github.io/spessasynth_lib)
 
-
-
 **SpessaSynth Project index**
 
 - [spessasynth_core](https://github.com/spessasus/spessasynth_core) - SF2/DLS/MIDI library
@@ -47,25 +39,27 @@ It allows you to:
 ### [All the features of spessasynth_core!](https://github.com/spessasus/spessasynth_core?#current-features)
 
 ### On top of that...
-- **Fully typed:** *Faster development and IDE auto-completion!*
-- **Modular design:** *Easy integration into other projects (load what you need)*
-- **[Detailed documentation:](https://spessasus.github.io/spessasynth_lib/)** *With [examples!](https://spessasus.github.io/spessasynth_lib/getting-started/#examples)*
-- **Easy to Use:** *Basic setup is just [two lines of code!](https://spessasus.github.io/spessasynth_lib/getting-started/#minimal-setup)*
-- **No external dependencies:** *Just spessasynth_core!*
+
+- **Fully typed:** _Faster development and IDE auto-completion!_
+- **Modular design:** _Easy integration into other projects (load what you need)_
+- **[Detailed documentation:](https://spessasus.github.io/spessasynth_lib/)** _With [examples!](https://spessasus.github.io/spessasynth_lib/getting-started/#examples)_
+- **Easy to Use:** _Basic setup is just [two lines of code!](https://spessasus.github.io/spessasynth_lib/getting-started/#minimal-setup)_
+- **No external dependencies:** _Just spessasynth_core!_
 - **Reverb and chorus support:** [customizable](https://spessasus.github.io/spessasynth_lib/synthesizer/#effects-configuration-object) and can be used standalone!
 - **Export audio files** using [OfflineAudioContext](https://developer.mozilla.org/en-US/docs/Web/API/OfflineAudioContext)!
-- **AudioWorklet synthesizer:** 
-  - Runs in a **separate thread** for maximum performance!
-  - Does not stop playing even when the main thread is frozen!
-  - Supported by all modern browsers!
-- **Web Worker synthesizer:** 
-  - Synthesize directly in the Web Worker!
-  - Direct audio engine access!
-  - Export audio automatically in the worker!
-  - Avoids [Chromium Audio Bugs](https://issues.chromium.org/issues/367304685)!
-- **High-performance mode:** Play Rush E! *note: may kill your browser ;)*
+- **AudioWorklet synthesizer:**
+    - Runs in a **separate thread** for maximum performance!
+    - Does not stop playing even when the main thread is frozen!
+    - Supported by all modern browsers!
+- **Web Worker synthesizer:**
+    - Synthesize directly in the Web Worker!
+    - Direct audio engine access!
+    - Export audio automatically in the worker!
+    - Avoids [Chromium Audio Bugs](https://issues.chromium.org/issues/367304685)!
+- **High-performance mode:** Play Rush E! _note: may kill your browser ;)_
 
 ### Special Thanks
+
 - [FluidSynth](https://github.com/FluidSynth/fluidsynth) - for the source code that helped implement functionality and fixes
 - [Polyphone](https://www.polyphone-soundfonts.com/) - for the sound bank testing and editing tool
 - [Meltysynth](https://github.com/sinshu/meltysynth) - for the initial low-pass filter implementation
@@ -78,11 +72,10 @@ It allows you to:
 - [Christian Collins](https://schristiancollins.com) - for various bug reports regarding the synthesizer
 - **And You!** - for checking out this project. I hope you like it :)
 
-
 ### Basic example: play a single note
 
 ```js
-import { WorkletSynthesizer } from "spessasynth_lib"
+import { WorkletSynthesizer } from "spessasynth_lib";
 
 // SF2, SF3, SFOGG and DLS files are all supported!
 const sfont = await (await fetch("soundfont.sf3")).arrayBuffer();
@@ -92,16 +85,16 @@ await ctx.audioWorklet.addModule("./spessasynth_processor.min.js");
 const synth = new WorkletSynthesizer(ctx);
 await synth.soundBankManager.addSoundBank(sfont, "main");
 await synth.isReady;
-document.getElementById("button").onclick = async () =>
-{
+document.getElementById("button").onclick = async () => {
     await ctx.resume();
     synth.programChange(0, 48); // strings ensemble
     synth.noteOn(0, 52, 127);
-}
+};
 ```
 
 # License
+
 Copyright © 2026 Spessasus
 Licensed under the Apache-2.0 License.
 
-SoundFont® is a registered trademark of Creative Technology Ltd.
+SoundFont® is a registered trademark of Creative Technology Ltd.

package/dist/index.d.ts

@@ -100,6 +100,7 @@ declare class SynthEventHandler {
     /**
      * Calls the given event.
      * INTERNAL USE ONLY!
+     * @internal
      */
     callEventInternal<T extends keyof SynthProcessorEventData>(name: T, eventData: SynthProcessorEventData[T]): void;
 }
@@ -150,6 +151,7 @@ type SequencerMessage = {
     [K in keyof SequencerMessageData]: {
         type: K;
         data: SequencerMessageData[K];
+        id: number;
     };
 }[keyof SequencerMessageData];
 interface SequencerMessageData {
@@ -167,12 +169,16 @@ interface SequencerMessageData {
     getMIDI: null;
     setSkipToFirstNote: boolean;
 }
-type SequencerReturnMessage = SequencerEvent | {
+type SequencerReturnMessage = (SequencerEvent & {
+    id: number;
+}) | {
     type: "getMIDI";
     data: BasicMIDI;
+    id: number;
 } | {
     type: "midiError";
     data: Error;
+    id: number;
 };
 /**
  * Sequencer.js
@@ -227,7 +233,7 @@ type PostMessageSynthCore = (data: BasicSynthesizerReturnMessage, transfer?: Tra
  */
 declare abstract class BasicSynthesizerCore {
     readonly synthesizer: SpessaSynthProcessor;
-    readonly sequencer: SpessaSynthSequencer;
+    readonly sequencers: SpessaSynthSequencer[];
     protected readonly post: PostMessageSynthCore;
     /**
      * Indicates if the processor is alive.
@@ -235,6 +241,7 @@ declare abstract class BasicSynthesizerCore {
      */
     protected alive: boolean;
     protected constructor(sampleRate: number, options: SynthProcessorOptions, postMessage: PostMessageSynthCore);
+    protected createNewSequencer(): void;
     protected postReady<K extends keyof SynthesizerReturn>(type: K, data: SynthesizerReturn[K], transferable?: Transferable[]): void;
     protected postProgress<K extends keyof SynthesizerProgress>(type: K, data: SynthesizerProgress[K]): void;
     protected destroy(): void;
@@ -299,6 +306,10 @@ interface WorkerRenderAudioOptions {
      * If the effects should be enabled.
      */
     enableEffects: boolean;
+    /**
+     * Which sequencer to render. Defaults to the first one (0).
+     */
+    sequencerID: number;
 }
 
 interface PassedProcessorParameters {
@@ -369,6 +380,10 @@ interface WorkerBankWriteOptions {
      * Trim the sound bank to only include samples used in the current MIDI file.
      */
     trim: boolean;
+    /**
+     * Which sequencer to grab the MIDI from if trimming. Defaults to the first one (0).
+     */
+    sequencerID: number;
     /**
      * The sound bank ID in the sound bank manager to write.
      */
@@ -417,7 +432,6 @@ interface BasicSynthesizerMessageData {
         delay: number;
     };
     stopAll: number;
-    killNotes: number;
     muteChannel: boolean;
     addNewChannel: null;
     customCcChange: {
@@ -435,6 +449,7 @@ interface BasicSynthesizerMessageData {
     };
     sequencerSpecific: SequencerMessage;
     requestSynthesizerSnapshot: null;
+    requestNewSequencer: null;
     setLogLevel: {
         enableInfo: boolean;
         enableWarning: boolean;
@@ -710,8 +725,10 @@ declare abstract class BasicSynthesizer {
     presetList: PresetList;
     /**
      * INTERNAL USE ONLY!
+     * @internal
+     * All sequencer callbacks
      */
-    sequencerCallbackFunction?: (m: SequencerReturnMessage) => unknown;
+    sequencers: ((m: SequencerReturnMessage) => unknown)[];
     /**
      * Resolves when the synthesizer is ready.
      */
@@ -728,6 +745,7 @@ declare abstract class BasicSynthesizer {
     readonly chorusProcessor?: ChorusProcessor;
     /**
      * INTERNAL USE ONLY!
+     * @internal
      */
     readonly post: (data: BasicSynthesizerMessage, transfer?: Transferable[]) => unknown;
     protected readonly worklet: AudioWorkletNode;
@@ -957,8 +975,15 @@ declare abstract class BasicSynthesizer {
      * INTERNAL USE ONLY!
      * @param type INTERNAL USE ONLY!
      * @param resolve INTERNAL USE ONLY!
+     * @internal
      */
     awaitWorkerResponse<K extends keyof SynthesizerReturn>(type: K, resolve: (data: SynthesizerReturn[K]) => unknown): void;
+    /**
+     * INTERNAL USE ONLY!
+     * @param callback the sequencer callback
+     * @internal
+     */
+    assignNewSequencer(callback: (m: SequencerReturnMessage) => unknown): number;
     protected assignProgressTracker<K extends keyof SynthesizerProgress>(type: K, progressFunction: (args: SynthesizerProgress[K]) => unknown): void;
     protected revokeProgressTracker<K extends keyof SynthesizerProgress>(type: K): void;
     protected _sendInternal(message: Iterable<number>, channelOffset: number, force: boolean | undefined, eventOptions: Partial<SynthMethodOptions>): void;
@@ -1079,6 +1104,7 @@ declare class SeqEventHandler {
     /**
      * Calls the given event.
      * Internal use only.
+     * @internal
      */
     callEventInternal<T extends keyof WorkletSequencerEventType>(name: T, eventData: WorkletSequencerEventType[T]): void;
 }
@@ -1120,6 +1146,10 @@ declare class Sequencer {
      * Absolute playback startTime, bases on the synth's time.
      */
     private absoluteStartTime;
+    /**
+     * For sending the messages to the correct SpessaSynthSequencer in core
+     */
+    private readonly sequencerID;
     /**
      * Creates a new MIDI sequencer for playing back MIDI files.
      * @param synth synth to send events to.
@@ -1135,7 +1165,7 @@ declare class Sequencer {
      * The current song number in the playlist.
      */
     set songIndex(value: number);
-    protected _currentTempo: number;
+    private _currentTempo;
     /**
      * Current song's tempo in BPM.
      */
@@ -1144,9 +1174,9 @@ declare class Sequencer {
      * The current sequence's length, in seconds.
      */
     get duration(): number;
-    protected _songsAmount: number;
+    private _songsAmount;
     get songsAmount(): number;
-    protected _skipToFirstNoteOn: boolean;
+    private _skipToFirstNoteOn;
     /**
      * Indicates if the sequencer should skip to first note on.
      */
@@ -1158,7 +1188,7 @@ declare class Sequencer {
     /**
      * Internal loop count marker (-1 is infinite).
      */
-    protected _loopCount: number;
+    private _loopCount;
     /**
      * The current remaining number of loops. -1 means infinite looping.
      */
@@ -1170,7 +1200,7 @@ declare class Sequencer {
     /**
      * Controls the playback's rate.
      */
-    protected _playbackRate: number;
+    private _playbackRate;
     /**
      * Controls the playback's rate.
      */
@@ -1179,7 +1209,7 @@ declare class Sequencer {
      * Controls the playback's rate.
      */
     set playbackRate(value: number);
-    protected _shuffleSongs: boolean;
+    private _shuffleSongs;
     /**
      * Indicates if the song order is random.
      */
@@ -1229,9 +1259,9 @@ declare class Sequencer {
      * Starts or resumes the playback.
      */
     play(): void;
-    protected handleMessage(m: SequencerReturnMessage): void;
-    protected callEventInternal<EventType extends keyof WorkletSequencerEventType>(type: EventType, data: WorkletSequencerEventType[EventType]): void;
-    protected resetMIDIOutput(): void;
+    private handleMessage;
+    private callEventInternal;
+    private resetMIDIOutput;
     private recalculateStartTime;
     private sendMessage;
 }