spessasynth_lib 3.21.9 → 3.21.12

package/@types/sequencer/sequencer.d.ts

@@ -84,6 +84,11 @@ export class Sequencer {
      * @private
      */
     private _skipToFirstNoteOn;
+    /**
+     * @type {boolean}
+     * @private
+     */
+    private _preservePlaybackState;
     /**
      * Indicates if the sequencer should skip to first note on
      * @param val {boolean}
@@ -94,6 +99,18 @@ export class Sequencer {
      * @return {boolean}
      */
     get skipToFirstNoteOn(): boolean;
+    /**
+     * if true,
+     * the sequencer will stay paused when seeking or changing the playback rate
+     * @param val {boolean}
+     */
+    set preservePlaybackState(val: boolean);
+    /**
+     * if true,
+     * the sequencer will stay paused when seeking or changing the playback rate
+     * @returns {boolean}
+     */
+    get preservePlaybackState(): boolean;
     set currentTime(time: number);
     /**
      * @returns {number} Current playback time, in seconds
@@ -211,6 +228,11 @@ export type SequencerOptions = {
      * - if true, the sequencer will automatically start playing the MIDI
      */
     autoPlay: boolean | undefined;
+    /**
+     * - if true,
+     * the sequencer will stay paused when seeking or changing the playback rate
+     */
+    preservePlaybackState: boolean | typeof unescape;
 };
 import { MidiData } from "../midi_parser/midi_data.js";
 import { Synthetizer } from "../synthetizer/synthetizer.js";

package/@types/sequencer/worklet_sequencer/sequencer_message.d.ts

@@ -14,6 +14,7 @@ export namespace WorkletSequencerMessageType {
     let changeSong: number;
     let getMIDI: number;
     let setSkipToFirstNote: number;
+    let setPreservePlaybackState: number;
 }
 export type WorkletSequencerReturnMessageType = number;
 export namespace WorkletSequencerReturnMessageType {

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

@@ -292,9 +292,10 @@ export class Synthetizer {
     reloadSoundFont(soundFontBuffer: ArrayBuffer): Promise<void>;
     /**
      * Sends a MIDI Sysex message to the synthesizer
-     * @param messageData {IndexedByteArray} the message's data (excluding the F0 byte, but including the F7 at the end)
+     * @param messageData {number[]|ArrayLike|Uint8Array} the message's data
+     * (excluding the F0 byte, but including the F7 at the end)
      */
-    systemExclusive(messageData: IndexedByteArray): void;
+    systemExclusive(messageData: number[] | ArrayLike<any> | Uint8Array): void;
     /**
      * Toggles drums on a given channel
      * @param channel {number}
@@ -303,9 +304,9 @@ export class Synthetizer {
     setDrums(channel: number, isDrum: boolean): void;
     /**
      * sends a raw MIDI message to the synthesizer
-     * @param message {ArrayLike<number>} the midi message, each number is a byte
+     * @param message {number[]|Uint8Array} the midi message, each number is a byte
      */
-    sendMessage(message: ArrayLike<number>): void;
+    sendMessage(message: number[] | Uint8Array): void;
     /**
      * Updates the reverb processor with a new impulse response
      * @param buffer {AudioBuffer} the new reverb impulse response
@@ -339,4 +340,3 @@ export type StartRenderingDataConfig = {
 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/worklet_utilities/worklet_processor_channel.d.ts

@@ -16,6 +16,7 @@
  * @property {number} NRPFine - the current fine value of the Non-Registered Parameter
  * @property {number} RPValue - the current value of the Registered Parameter
  *
+ * @property {number} bank - the channel's bank number
  * @property {BasicPreset} preset - the channel's preset
  * @property {boolean} lockPreset - indicates whether the program on the channel is locked
  * @property {boolean} presetUsesOverride - indcates if the channel uses a preset from the override soundfont.
@@ -36,6 +37,16 @@
  * @this {SpessaSynthProcessor}
  */
 export function createWorkletChannel(this: SpessaSynthProcessor, sendEvent?: boolean): void;
+/**
+ * @param channel {WorkletProcessorChannel}
+ * @param bank {number}
+ */
+export function setBankSelect(channel: WorkletProcessorChannel, bank: number): void;
+/**
+ * @param channel {WorkletProcessorChannel}
+ * @returns {number}
+ */
+export function getBankSelect(channel: WorkletProcessorChannel): number;
 /**
  * This is a channel configuration enum, it is internally sent from Synthetizer via controller change
  */
@@ -96,6 +107,10 @@ export type WorkletProcessorChannel = {
      * - the current value of the Registered Parameter
      */
     RPValue: number;
+    /**
+     * - the channel's bank number
+     */
+    bank: number;
     /**
      * - the channel's preset
      */

package/README.md

@@ -43,14 +43,15 @@ document.getElementById("button").onclick = async () =>
 - **Excellent SoundFont support:**
   - **Full Generator Support**
   - **Full Modulator Support:** *First (to my knowledge) JavaScript SoundFont synth with that feature!*
+  - **GeneralUserGS Certified:** *[See more here!](https://github.com/mrbumpy409/GeneralUser-GS/blob/main/documentation/README.md)*
   - **SoundFont3 Support:** Play compressed SoundFonts!
   - **Experimental SF2Pack Support:** Play soundfonts compressed with BASSMIDI! (*Note: only works with vorbis compression*)
   - **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!
-- **DLS Level 1 and 2 Support:** *internally converted to sf2*
+- **DLS Level 1 and 2 Support:** *works with gm.dls!*
 - **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?
+- **[Custom modulators for additional controllers](https://github.com/spessasus/SpessaSynth/wiki/Modulator-Class#default-modulators):** *Why not?*
 - **Written using AudioWorklets:** 
   - Runs in a **separate thread** for maximum performance
   - Supported by all modern browsers
@@ -60,7 +61,6 @@ document.getElementById("button").onclick = async () =>
   - **MIDI Tuning Standard Support:** [more info here](https://github.com/spessasus/SpessaSynth/wiki/MIDI-Implementation#midi-tuning-standard)
   - [Full **RPN** and limited **NRPN** support](https://github.com/spessasus/SpessaSynth/wiki/MIDI-Implementation#supported-registered-parameters)
   - Supports some [**Roland GS** and **Yamaha XG** system exclusives](https://github.com/spessasus/SpessaSynth/wiki/MIDI-Implementation#supported-system-exclusives)
-
 - **High-performance mode:** Play Rush E! _note: may kill your browser ;)_
 
 ### Built-in Powerful and Fast Sequencer

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spessasynth_lib",
-  "version": "3.21.9",
+  "version": "3.21.12",
   "description": "MIDI and SoundFont2/DLS library with no compromises",
   "browser": "index.js",
   "types": "@types/index.d.ts",

package/sequencer/sequencer.js

@@ -28,6 +28,8 @@ import { DUMMY_MIDI_DATA, MidiData } from "../midi_parser/midi_data.js";
  * @typedef {Object} SequencerOptions
  * @property {boolean|undefined} skipToFirstNoteOn - if true, the sequencer will skip to the first note
  * @property {boolean|undefined} autoPlay - if true, the sequencer will automatically start playing the MIDI
+ * @property {boolean|unescape} preservePlaybackState - if true,
+ * the sequencer will stay paused when seeking or changing the playback rate
  */
 
 /**
@@ -35,7 +37,8 @@ import { DUMMY_MIDI_DATA, MidiData } from "../midi_parser/midi_data.js";
  */
 const DEFAULT_OPTIONS = {
     skipToFirstNoteOn: true,
-    autoPlay: true
+    autoPlay: true,
+    preservePlaybackState: false
 };
 
 export class Sequencer
@@ -138,7 +141,12 @@ export class Sequencer
          * @type {boolean}
          * @private
          */
-        this._skipToFirstNoteOn = options?.skipToFirstNoteOn ?? true;
+        this._skipToFirstNoteOn = options?.skipToFirstNoteOn || true;
+        /**
+         * @type {boolean}
+         * @private
+         */
+        this._preservePlaybackState = options?.preservePlaybackState || false;
         
         if (this._skipToFirstNoteOn === false)
         {
@@ -146,7 +154,12 @@ export class Sequencer
             this._sendMessage(WorkletSequencerMessageType.setSkipToFirstNote, false);
         }
         
-        this.loadNewSongList(midiBinaries, options?.autoPlay ?? false);
+        if (this._preservePlaybackState === true)
+        {
+            this._sendMessage(WorkletSequencerMessageType.setPreservePlaybackState, true);
+        }
+        
+        this.loadNewSongList(midiBinaries, options?.autoPlay || true);
         
         window.addEventListener("beforeunload", this.resetMIDIOut.bind(this));
     }
@@ -170,6 +183,27 @@ export class Sequencer
         this._sendMessage(WorkletSequencerMessageType.setSkipToFirstNote, this._skipToFirstNoteOn);
     }
     
+    /**
+     * if true,
+     * the sequencer will stay paused when seeking or changing the playback rate
+     * @returns {boolean}
+     */
+    get preservePlaybackState()
+    {
+        return this._preservePlaybackState;
+    }
+    
+    /**
+     * if true,
+     * the sequencer will stay paused when seeking or changing the playback rate
+     * @param val {boolean}
+     */
+    set preservePlaybackState(val)
+    {
+        this._preservePlaybackState = val;
+        this._sendMessage(WorkletSequencerMessageType.setPreservePlaybackState, val);
+    }
+    
     /**
      * @returns {number} Current playback time, in seconds
      */
@@ -186,7 +220,10 @@ export class Sequencer
     
     set currentTime(time)
     {
-        this.unpause();
+        if (!this._preservePlaybackState)
+        {
+            this.unpause();
+        }
         this._sendMessage(WorkletSequencerMessageType.setTime, time);
     }
     
@@ -395,8 +432,15 @@ export class Sequencer
                 // message data is absolute time
                 const time = this.synth.currentTime - messageData;
                 Object.entries(this.onTimeChange).forEach((callback) => callback[1](time));
-                this.unpause();
                 this._recalculateStartTime(time);
+                if (this.paused && this._preservePlaybackState)
+                {
+                    this.pausedTime = time;
+                }
+                else
+                {
+                    this.unpause();
+                }
                 break;
             
             case WorkletSequencerReturnMessageType.pause:

package/sequencer/worklet_sequencer/events.js

@@ -65,6 +65,9 @@ export function processMessage(messageType, messageData)
         case WorkletSequencerMessageType.setSkipToFirstNote:
             this._skipToFirstNoteOn = messageData;
             break;
+        
+        case WorkletSequencerMessageType.setPreservePlaybackState:
+            this.preservePlaybackState = messageData;
     }
 }
 

package/sequencer/worklet_sequencer/play.js

@@ -254,12 +254,14 @@ export function play(resetTime = false)
     // reset the time if necesarry
     if (resetTime)
     {
+        this.pausedTime = undefined;
         this.currentTime = 0;
         return;
     }
     
     if (this.currentTime >= this.duration)
     {
+        this.pausedTime = undefined;
         this.currentTime = 0;
         return;
     }

package/sequencer/worklet_sequencer/sequencer_message.js

@@ -11,6 +11,7 @@
  * @property {number} changeSong               - 8 -> goForwards<boolean> if true, next song, if false, previous
  * @property {number} getMIDI                  - 9 -> (no data)
  * @property {number} setSkipToFirstNote       -10 -> skipToFirstNoteOn<boolean>
+ * @property {number} setPreservePlaybackState -11 -> preservePlaybackState<boolean>
  */
 export const WorkletSequencerMessageType = {
     loadNewSongList: 0,
@@ -23,7 +24,8 @@ export const WorkletSequencerMessageType = {
     setLoop: 7,
     changeSong: 8,
     getMIDI: 9,
-    setSkipToFirstNote: 10
+    setSkipToFirstNote: 10,
+    setPreservePlaybackState: 11
 };
 
 /**

package/sequencer/worklet_sequencer/worklet_sequencer.js

@@ -104,6 +104,12 @@ class WorkletSequencer
          * @private
          */
         this._skipToFirstNoteOn = true;
+        
+        /**
+         * If true, seq will stay paused when seeking or changing the playback rate
+         * @type {boolean}
+         */
+        this.preservePlaybackState = false;
     }
     
     /**
@@ -152,15 +158,19 @@ class WorkletSequencer
         }
         this.stop();
         this.playingNotes = [];
+        const wasPaused = this.paused && this.preservePlaybackState;
         this.pausedTime = undefined;
         this.post(WorkletSequencerReturnMessageType.timeChange, currentTime - time);
-        const isNotFinished = this._playTo(time);
+        this._playTo(time);
         this._recalculateStartTime(time);
-        if (!isNotFinished)
+        if (wasPaused)
         {
-            return;
+            this.pause();
+        }
+        else
+        {
+            this.play();
         }
-        this.play();
     }
     
     /**

package/synthetizer/synthetizer.js

@@ -725,7 +725,8 @@ export class Synthetizer
     
     /**
      * Sends a MIDI Sysex message to the synthesizer
-     * @param messageData {IndexedByteArray} the message's data (excluding the F0 byte, but including the F7 at the end)
+     * @param messageData {number[]|ArrayLike|Uint8Array} the message's data
+     * (excluding the F0 byte, but including the F7 at the end)
      */
     systemExclusive(messageData)
     {
@@ -752,7 +753,7 @@ export class Synthetizer
     
     /**
      * sends a raw MIDI message to the synthesizer
-     * @param message {ArrayLike<number>} the midi message, each number is a byte
+     * @param message {number[]|Uint8Array} the midi message, each number is a byte
      */
     sendMessage(message)
     {