spessasynth_lib 4.2.1 → 4.2.3

package/README.md

@@ -3,7 +3,7 @@
 <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 TypeScript/JavaScript library for the browsers, based on spessasynth_core.
+_A powerful multipurpose 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:
@@ -91,9 +91,15 @@ document.getElementById("button").onclick = async () => {
 };
 ```
 
-# License
+## License
 
 Copyright © 2026 Spessasus
 Licensed under the Apache-2.0 License.
 
+#### Legal
+
+This project is in no way endorsed or otherwise affiliated with the MIDI Manufacturers Association,
+Roland Corporation, Yamaha Corporation, Creative Technology Ltd. or E-mu Systems, Inc.,
+or any other organization mentioned.
 SoundFont® is a registered trademark of Creative Technology Ltd.
+All other trademarks are the property of their respective owners.

package/dist/index.d.ts

@@ -436,7 +436,6 @@ interface BasicSynthesizerMessageData {
     midiMessage: {
         messageData: Uint8Array;
         channelOffset: number;
-        force: boolean;
         options: SynthMethodOptions;
     };
     ccReset: null;
@@ -706,12 +705,27 @@ declare abstract class BasicSynthesizer {
         rate: number;
     }): void;
     /**
-     * Connects the individual audio outputs to the given audio nodes. In the app, it's used by the renderer.
+     * Connects a given channel output to the given audio node.
+     * Note that this output is only meant for visualization and may be silent when Insertion Effect for this channel is enabled.
+     * @param targetNode The node to connect to.
+     * @param channelNumber The channel number to connect to, will be rolled over if value is greater than 15.
+     * @returns The target node.
+     */
+    connectChannel(targetNode: AudioNode, channelNumber: number): AudioNode;
+    /**
+     * Disconnects a given channel output to the given audio node.
+     * @param targetNode The node to disconnect from.
+     * @param channelNumber The channel number to connect to, will be rolled over if value is greater than 15.
+     */
+    disconnectChannel(targetNode: AudioNode, channelNumber: number): void;
+    /**
+     * Connects the individual audio outputs to the given audio nodes.
+     * Note that these outputs is only meant for visualization and may be silent when Insertion Effect for this channel is enabled.
      * @param audioNodes Exactly 16 outputs.
      */
     connectIndividualOutputs(audioNodes: AudioNode[]): void;
     /**
-     * Disconnects the individual audio outputs to the given audio nodes. In the app, it's used by the renderer.
+     * Disconnects the individual audio outputs from the given audio nodes.
      * @param audioNodes Exactly 16 outputs.
      */
     disconnectIndividualOutputs(audioNodes: AudioNode[]): void;
@@ -739,10 +753,9 @@ declare abstract class BasicSynthesizer {
      * Stops playing a note.
      * @param channel Usually 0-15: the channel of the note.
      * @param midiNote {number} 0-127 the key number of the note.
-     * @param force Instantly kills the note if true.
      * @param eventOptions Additional options for this command.
      */
-    noteOff(channel: number, midiNote: number, force?: boolean, eventOptions?: SynthMethodOptions): void;
+    noteOff(channel: number, midiNote: number, eventOptions?: SynthMethodOptions): void;
     /**
      * Stops all notes.
      * @param force If the notes should immediately be stopped, defaults to false.
@@ -753,10 +766,9 @@ declare abstract class BasicSynthesizer {
      * @param channel Usually 0-15: the channel to change the controller.
      * @param controllerNumber 0-127 the MIDI CC number.
      * @param controllerValue 0-127 the controller value.
-     * @param force Forces the controller-change message, even if it's locked or gm system is set and the cc is bank select.
      * @param eventOptions Additional options for this command.
      */
-    controllerChange(channel: number, controllerNumber: MIDIController, controllerValue: number, force?: boolean, eventOptions?: SynthMethodOptions): void;
+    controllerChange(channel: number, controllerNumber: MIDIController, controllerValue: number, eventOptions?: SynthMethodOptions): void;
     /**
      * Resets all controllers (for every channel)
      */
@@ -796,15 +808,16 @@ declare abstract class BasicSynthesizer {
      * Sets the channel's pitch wheel range, in semitones.
      * @param channel Usually 0-15: the channel to change.
      * @param range The bend range in semitones.
+     * @param eventOptions Additional options for this command.
      */
-    pitchWheelRange(channel: number, range: number): void;
+    pitchWheelRange(channel: number, range: number, eventOptions?: SynthMethodOptions): void;
     /**
      * Changes the program for a given channel
      * @param channel Usually 0-15: the channel to change.
      * @param programNumber 0-127 the MIDI patch number.
-     * defaults to false
+     * @param eventOptions Additional options for this command.
      */
-    programChange(channel: number, programNumber: number): void;
+    programChange(channel: number, programNumber: number, eventOptions?: SynthMethodOptions): void;
     /**
      * Transposes the channel by given number of semitones.
      * @param channel The channel number.
@@ -860,7 +873,7 @@ declare abstract class BasicSynthesizer {
     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;
+    protected _sendInternal(message: Iterable<number>, channelOffset: number, eventOptions: Partial<SynthMethodOptions>): void;
     /**
      * Handles the messages received from the worklet.
      */

package/dist/index.js

@@ -557,7 +557,27 @@ var BasicSynthesizer = class {
     void value;
   }
   /**
-   * Connects the individual audio outputs to the given audio nodes. In the app, it's used by the renderer.
+   * Connects a given channel output to the given audio node.
+   * Note that this output is only meant for visualization and may be silent when Insertion Effect for this channel is enabled.
+   * @param targetNode The node to connect to.
+   * @param channelNumber The channel number to connect to, will be rolled over if value is greater than 15.
+   * @returns The target node.
+   */
+  connectChannel(targetNode, channelNumber) {
+    this.worklet.connect(targetNode, channelNumber % 16 + 1);
+    return targetNode;
+  }
+  /**
+   * Disconnects a given channel output to the given audio node.
+   * @param targetNode The node to disconnect from.
+   * @param channelNumber The channel number to connect to, will be rolled over if value is greater than 15.
+   */
+  disconnectChannel(targetNode, channelNumber) {
+    this.worklet.disconnect(targetNode, channelNumber % 16 + 1);
+  }
+  /**
+   * Connects the individual audio outputs to the given audio nodes.
+   * Note that these outputs is only meant for visualization and may be silent when Insertion Effect for this channel is enabled.
    * @param audioNodes Exactly 16 outputs.
    */
   connectIndividualOutputs(audioNodes) {
@@ -565,12 +585,12 @@ var BasicSynthesizer = class {
       throw new Error(`input nodes amount differs from the system's outputs amount!
             Expected ${this._outputsAmount} got ${audioNodes.length}`);
     }
-    for (let outputNumber = 0; outputNumber < this._outputsAmount; outputNumber++) {
-      this.worklet.connect(audioNodes[outputNumber], outputNumber + 1);
+    for (let channel = 0; channel < this._outputsAmount; channel++) {
+      this.connectChannel(audioNodes[channel], channel);
     }
   }
   /**
-   * Disconnects the individual audio outputs to the given audio nodes. In the app, it's used by the renderer.
+   * Disconnects the individual audio outputs from the given audio nodes.
    * @param audioNodes Exactly 16 outputs.
    */
   disconnectIndividualOutputs(audioNodes) {
@@ -578,8 +598,8 @@ var BasicSynthesizer = class {
       throw new Error(`input nodes amount differs from the system's outputs amount!
             Expected ${this._outputsAmount} got ${audioNodes.length}`);
     }
-    for (let outputNumber = 0; outputNumber < this._outputsAmount; outputNumber++) {
-      this.worklet.disconnect(audioNodes[outputNumber], outputNumber + 2);
+    for (let channel = 0; channel < this._outputsAmount; channel++) {
+      this.disconnectChannel(audioNodes[channel], channel);
     }
   }
   // noinspection JSUnusedGlobalSymbols
@@ -597,7 +617,7 @@ var BasicSynthesizer = class {
    * @param eventOptions additional options for this command.
    */
   sendMessage(message, channelOffset = 0, eventOptions = DEFAULT_SYNTH_METHOD_OPTIONS) {
-    this._sendInternal(message, channelOffset, false, eventOptions);
+    this._sendInternal(message, channelOffset, eventOptions);
   }
   /**
    * Starts playing a note
@@ -621,17 +641,15 @@ var BasicSynthesizer = class {
    * Stops playing a note.
    * @param channel Usually 0-15: the channel of the note.
    * @param midiNote {number} 0-127 the key number of the note.
-   * @param force Instantly kills the note if true.
    * @param eventOptions Additional options for this command.
    */
-  noteOff(channel, midiNote, force = false, eventOptions = DEFAULT_SYNTH_METHOD_OPTIONS) {
+  noteOff(channel, midiNote, eventOptions = DEFAULT_SYNTH_METHOD_OPTIONS) {
     midiNote %= 128;
     const ch = channel % 16;
     const offset = channel - ch;
     this._sendInternal(
       [midiMessageTypes.noteOff | ch, midiNote],
       offset,
-      force,
       eventOptions
     );
   }
@@ -651,10 +669,9 @@ var BasicSynthesizer = class {
    * @param channel Usually 0-15: the channel to change the controller.
    * @param controllerNumber 0-127 the MIDI CC number.
    * @param controllerValue 0-127 the controller value.
-   * @param force Forces the controller-change message, even if it's locked or gm system is set and the cc is bank select.
    * @param eventOptions Additional options for this command.
    */
-  controllerChange(channel, controllerNumber, controllerValue, force = false, eventOptions = DEFAULT_SYNTH_METHOD_OPTIONS) {
+  controllerChange(channel, controllerNumber, controllerValue, eventOptions = DEFAULT_SYNTH_METHOD_OPTIONS) {
     if (controllerNumber > 127 || controllerNumber < 0) {
       throw new Error(`Invalid controller number: ${controllerNumber}`);
     }
@@ -669,7 +686,6 @@ var BasicSynthesizer = class {
         controllerValue
       ],
       offset,
-      force,
       eventOptions
     );
   }
@@ -756,44 +772,55 @@ var BasicSynthesizer = class {
    * Sets the channel's pitch wheel range, in semitones.
    * @param channel Usually 0-15: the channel to change.
    * @param range The bend range in semitones.
+   * @param eventOptions Additional options for this command.
    */
-  pitchWheelRange(channel, range) {
+  pitchWheelRange(channel, range, eventOptions = DEFAULT_SYNTH_METHOD_OPTIONS) {
     this.controllerChange(
       channel,
       midiControllers.registeredParameterMSB,
-      0
+      0,
+      eventOptions
     );
     this.controllerChange(
       channel,
       midiControllers.registeredParameterLSB,
-      0
+      0,
+      eventOptions
     );
     this.controllerChange(channel, midiControllers.dataEntryMSB, range);
     this.controllerChange(
       channel,
       midiControllers.registeredParameterMSB,
-      127
+      127,
+      eventOptions
     );
     this.controllerChange(
       channel,
       midiControllers.registeredParameterLSB,
-      127
+      127,
+      eventOptions
+    );
+    this.controllerChange(
+      channel,
+      midiControllers.dataEntryMSB,
+      0,
+      eventOptions
     );
-    this.controllerChange(channel, midiControllers.dataEntryMSB, 0);
   }
   /**
    * Changes the program for a given channel
    * @param channel Usually 0-15: the channel to change.
    * @param programNumber 0-127 the MIDI patch number.
-   * defaults to false
+   * @param eventOptions Additional options for this command.
    */
-  programChange(channel, programNumber) {
+  programChange(channel, programNumber, eventOptions = DEFAULT_SYNTH_METHOD_OPTIONS) {
     const ch = channel % 16;
     const offset = channel - ch;
     programNumber %= 128;
     this.sendMessage(
       [midiMessageTypes.programChange | ch, programNumber],
-      offset
+      offset,
+      eventOptions
     );
   }
   // noinspection JSUnusedGlobalSymbols
@@ -836,7 +863,6 @@ var BasicSynthesizer = class {
     this._sendInternal(
       [midiMessageTypes.systemExclusive, ...Array.from(messageData)],
       channelOffset,
-      false,
       eventOptions
     );
   }
@@ -943,7 +969,7 @@ var BasicSynthesizer = class {
   revokeProgressTracker(type) {
     this.renderingProgressTracker.delete(type);
   }
-  _sendInternal(message, channelOffset, force = false, eventOptions) {
+  _sendInternal(message, channelOffset, eventOptions) {
     const options = fillWithDefaults(
       eventOptions,
       DEFAULT_SYNTH_METHOD_OPTIONS
@@ -954,10 +980,8 @@ var BasicSynthesizer = class {
       data: {
         messageData: new Uint8Array(message),
         channelOffset,
-        force,
         options
       }
-      //[new Uint8Array(message), offset, force, opts]
     });
   }
   /**
@@ -1223,8 +1247,6 @@ function renderAudioWorker(sampleRate, options) {
   const rendererSynth = new SpessaSynthProcessor(sampleRate, {
     enableEventSystem: false
   });
-  const rendererSeq = new SpessaSynthSequencer(rendererSynth);
-  rendererSynth.setMasterParameter("autoAllocateVoices", true);
   for (const entry of this.synthesizer.soundBankManager.soundBankList)
     rendererSynth.soundBankManager.addSoundBank(
       entry.soundBank,
@@ -1244,12 +1266,14 @@ function renderAudioWorker(sampleRate, options) {
   const loopDuration = loopEndAbsolute - loopStartAbsolute;
   const duration = parsedMid.duration / playbackRate + options.extraTime + loopDuration * options.loopCount;
   const sampleDuration = sampleRate * duration;
+  const rendererSeq = new SpessaSynthSequencer(rendererSynth);
   rendererSeq.loopCount = options.loopCount;
   if (options.preserveSynthParams) {
     rendererSeq.playbackRate = seq.playbackRate;
     const snapshot = this.synthesizer.getSnapshot();
     rendererSynth.applySynthesizerSnapshot(snapshot);
   }
+  rendererSynth.setMasterParameter("autoAllocateVoices", true);
   rendererSeq.loadNewSongList([parsedMid]);
   rendererSeq.play();
   const wetL = new Float32Array(sampleDuration);
@@ -1744,7 +1768,6 @@ var BasicSynthesizerCore = class {
         this.synthesizer.processMessage(
           m.data.messageData,
           m.data.channelOffset,
-          m.data.force,
           m.data.options
         );
         break;