spessasynth_lib 3.24.0 → 3.24.3

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

@@ -25,7 +25,7 @@ export class Sequencer {
      * Fires on text event
      * @type {function}
      * @param data {Uint8Array} the data text
-     * @param type {number} the status byte of the message (the meta status byte)
+     * @param type {number} the status byte of the message (the meta-status byte)
      * @param lyricsIndex {number} if the text is a lyric, the index of the lyric in midiData.lyrics, otherwise -1
      */
     onTextEvent: Function;
@@ -40,47 +40,58 @@ export class Sequencer {
      * @private
      */
     private onSongEnded;
-    ignoreEvents: boolean;
-    synth: Synthetizer;
-    highResTimeOffset: number;
     /**
-     * Absolute playback startTime, bases on the synth's time
-     * @type {number}
+     * Fires on tempo change
+     * @type {Object<string, function(number)>}
      */
-    absoluteStartTime: number;
+    onTempoChange: {
+        [x: string]: (arg0: number) => any;
+    };
     /**
-     * @type {function(BasicMIDI)}
-     * @private
+     * Current song's tempo in BPM
+     * @type {number}
      */
-    private _getMIDIResolve;
+    currentTempo: number;
     /**
-     * Controls the playback's rate
+     * Current song index
      * @type {number}
      */
-    _playbackRate: number;
     songIndex: number;
     /**
-     * Indicates if the current midiData property has dummy data in it (not yet loaded)
+     * @type {function(BasicMIDI)}
+     * @private
+     */
+    private _getMIDIResolve;
+    /**
+     * Indicates if the current midiData property has fake data in it (not yet loaded)
      * @type {boolean}
      */
     hasDummyData: boolean;
-    _loop: boolean;
     /**
      * Indicates whether the sequencer has finished playing a sequence
      * @type {boolean}
      */
     isFinished: boolean;
+    /**
+     * The current sequence's length, in seconds
+     * @type {number}
+     */
+    duration: number;
     /**
      * Indicates if the sequencer is paused.
      * Paused if a number, undefined if playing
      * @type {undefined|number}
+     * @private
      */
-    pausedTime: undefined | number;
+    private pausedTime;
+    ignoreEvents: boolean;
+    synth: Synthetizer;
+    highResTimeOffset: number;
     /**
-     * The current sequence's length, in seconds
+     * Absolute playback startTime, bases on the synth's time
      * @type {number}
      */
-    duration: number;
+    absoluteStartTime: number;
     /**
      * @type {boolean}
      * @private
@@ -91,6 +102,28 @@ export class Sequencer {
      * @private
      */
     private _preservePlaybackState;
+    /**
+     * Internal loop marker
+     * @type {boolean}
+     * @private
+     */
+    private _loop;
+    set loop(value: boolean);
+    get loop(): boolean;
+    /**
+     * Controls the playback's rate
+     * @type {number}
+     * @private
+     */
+    private _playbackRate;
+    /**
+     * @param value {number}
+     */
+    set playbackRate(value: number);
+    /**
+     * @returns {number}
+     */
+    get playbackRate(): number;
     /**
      * Indicates if the sequencer should skip to first note on
      * @param val {boolean}
@@ -118,21 +151,11 @@ export class Sequencer {
      * @returns {number} Current playback time, in seconds
      */
     get currentTime(): number;
-    set loop(value: boolean);
-    get loop(): boolean;
     /**
      * Use for visualization as it's not affected by the audioContext stutter
      * @returns {number}
      */
     get currentHighResolutionTime(): number;
-    /**
-     * @param value {number}
-     */
-    set playbackRate(value: number);
-    /**
-     * @returns {number}
-     */
-    get playbackRate(): number;
     /**
      * true if paused, false if playing or stopped
      * @returns {boolean}
@@ -156,6 +179,12 @@ export class Sequencer {
      * @param id {string} must be unique
      */
     addOnTimeChangeEvent(callback: (arg0: number) => any, id: string): void;
+    /**
+     * Adds a new event that gets called when the tempo changes
+     * @param callback {function(number)} the new tempo, in BPM
+     * @param id {string} must be unique
+     */
+    addOnTempoChangeEvent(callback: (arg0: number) => any, id: string): void;
     resetMIDIOut(): void;
     /**
      * @param messageType {WorkletSequencerMessageType}
@@ -165,6 +194,12 @@ export class Sequencer {
     private _sendMessage;
     nextSong(): void;
     previousSong(): void;
+    /**
+     * @param type {Object<string, function>}
+     * @param params {any}
+     * @private
+     */
+    private _callEvents;
     /**
      * @param {WorkletSequencerReturnMessageType} messageType
      * @param {any} messageData
@@ -199,7 +234,7 @@ export class Sequencer {
     unpause(): void;
     /**
      * Starts the playback
-     * @param resetTime {boolean} If true, time is set to 0s
+     * @param resetTime {boolean} If true, time is set to 0 s
      */
     play(resetTime?: boolean): void;
     /**

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

@@ -27,4 +27,5 @@ export namespace WorkletSequencerReturnMessageType {
     let getMIDI_1: number;
     export { getMIDI_1 as getMIDI };
     export let midiError: number;
+    export let tempoChange: number;
 }

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

@@ -1,15 +1,18 @@
 /**
- * @typedef {Object} EffectsConfig
+ * @typedef {Object} SynthConfig
  * @property {boolean} chorusEnabled - indicates if the chorus effect is enabled.
- * @property {ChorusConfig} chorusConfig - the configuration for chorus. Pass undefined to use defaults
+ * @property {ChorusConfig?} chorusConfig - the configuration for chorus. Pass undefined to use defaults
  * @property {boolean} reverbEnabled - indicates if the reverb effect is enabled.
- * @property {AudioBuffer} reverbImpulseResponse - the impulse response for the reverb. Pass undefined to use defaults
+ * @property {AudioBuffer?} reverbImpulseResponse - the impulse response for the reverb. Pass undefined to use defaults
+ * @property {{
+ *      worklet: function(context: object, name: string, options?: Object)
+ * }} audioNodeCreators - custom audio node creation functions for Web Audio wrappers.
  */
 /**
- * @type {EffectsConfig}
+ * @type {SynthConfig}
  */
-export const DEFAULT_EFFECTS_CONFIG: EffectsConfig;
-export type EffectsConfig = {
+export const DEFAULT_SYNTH_CONFIG: SynthConfig;
+export type SynthConfig = {
     /**
      * - indicates if the chorus effect is enabled.
      */
@@ -17,7 +20,7 @@ export type EffectsConfig = {
     /**
      * - the configuration for chorus. Pass undefined to use defaults
      */
-    chorusConfig: ChorusConfig;
+    chorusConfig: ChorusConfig | null;
     /**
      * - indicates if the reverb effect is enabled.
      */
@@ -25,5 +28,14 @@ export type EffectsConfig = {
     /**
      * - the impulse response for the reverb. Pass undefined to use defaults
      */
-    reverbImpulseResponse: AudioBuffer;
+    reverbImpulseResponse: AudioBuffer | null;
+    /**
+     * )
+     * }} audioNodeCreators - custom audio node creation functions for Web Audio wrappers.
+     */
+    "": {
+        worklet: (arg0: context) => object;
+        name: string;
+        options?: any;
+    };
 };

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

@@ -6,7 +6,8 @@
  * @typedef {Object} StartRenderingDataConfig
  * @property {BasicMIDI} parsedMIDI - the MIDI to render
  * @property {SynthesizerSnapshot} snapshot - the snapshot to apply
- * @property {boolean|undefined} oneOutput - if synth should use one output with 32 channels (2 audio channels for each midi channel). this disables chorus and reverb.
+ * @property {boolean|undefined} oneOutput - if synth should use one output with 32 channels (2 audio channels for each midi channel).
+ * this disabled chorus and reverb.
  * @property {number|undefined} loopCount - the times to loop the song
  */
 export const WORKLET_PROCESSOR_NAME: "spessasynth-worklet-system";
@@ -14,14 +15,6 @@ export const VOICE_CAP: 350;
 export const DEFAULT_PERCUSSION: 9;
 export const MIDI_CHANNEL_COUNT: 16;
 export const DEFAULT_SYNTH_MODE: "gs";
-/**
- * Creates a new instance of the SpessaSynth synthesizer
- * @param targetNode {AudioNode}
- * @param soundFontBuffer {ArrayBuffer} the soundfont file array buffer
- * @param enableEventSystem {boolean} enables the event system. Defaults to true
- * @param startRenderingData {StartRenderingDataConfig} if set, starts playing this immediately and restores the values
- * @param effectsConfig {EffectsConfig} optional configuration for the audio effects.
- */
 export class Synthetizer {
     /**
      * Creates a new instance of the SpessaSynth synthesizer
@@ -29,13 +22,13 @@ export class Synthetizer {
      * @param soundFontBuffer {ArrayBuffer} the soundfont file array buffer
      * @param enableEventSystem {boolean} enables the event system. Defaults to true
      * @param startRenderingData {StartRenderingDataConfig} if set, starts playing this immediately and restores the values
-     * @param effectsConfig {EffectsConfig} optional configuration for the audio effects.
+     * @param synthConfig {SynthConfig} optional configuration for the synthesizer.
      */
-    constructor(targetNode: AudioNode, soundFontBuffer: ArrayBuffer, enableEventSystem?: boolean, startRenderingData?: StartRenderingDataConfig, effectsConfig?: EffectsConfig);
+    constructor(targetNode: AudioNode, soundFontBuffer: ArrayBuffer, enableEventSystem?: boolean, startRenderingData?: StartRenderingDataConfig, synthConfig?: SynthConfig);
     context: BaseAudioContext;
     targetNode: AudioNode;
     /**
-     * Allows to set up custom event listeners for the synthesizer
+     * Allows setting up custom event listeners for the synthesizer
      * @type {EventHandler}
      */
     eventHandler: EventHandler;
@@ -43,13 +36,13 @@ export class Synthetizer {
     _destroyed: boolean;
     /**
      * the new channels will have their audio sent to the moduled output by this constant.
-     * what does that mean? e.g. if outputsAmount is 16, then channel's 16 audio will be sent to channel 0
+     * what does that mean? e.g., if outputsAmount is 16, then channel's 16 audio data will be sent to channel 0
      * @type {number}
      * @private
      */
     private _outputsAmount;
     /**
-     * the amount of midi channels
+     * the number of midi channels
      * @type {number}
      */
     channelsAmount: number;
@@ -74,10 +67,10 @@ export class Synthetizer {
      */
     _highPerformanceMode: boolean;
     /**
-     * @type {EffectsConfig}
+     * @type {SynthConfig}
      */
-    effectsConfig: EffectsConfig;
-    worklet: AudioWorkletNode;
+    effectsConfig: SynthConfig;
+    worklet: any;
     /**
      * The synth's soundfont manager
      * @type {SoundfontManager}
@@ -101,12 +94,12 @@ export class Synthetizer {
     reverbProcessor: ConvolverNode;
     chorusProcessor: FancyChorus;
     /**
-     * The maximum amount of voices allowed at once
+     * The maximum number of voices allowed at once
      * @param value {number}
      */
     set voiceCap(value: number);
     /**
-     * The maximum amount of voices allowed at once
+     * The maximum number of voices allowed at once
      * @returns {number}
      */
     get voiceCap(): number;
@@ -121,7 +114,7 @@ export class Synthetizer {
      */
     get currentTime(): number;
     /**
-     * @returns {number} the current amount of voices playing
+     * @returns {number} the current number of voices playing
      */
     get voicesAmount(): number;
     /**
@@ -171,7 +164,7 @@ export class Synthetizer {
         rate: number;
     }): void;
     /**
-     * Connects the individual audio outputs to the given audio nodes. In the app it's used by the renderer.
+     * Connects the individual audio outputs to the given audio nodes. In the app, it's used by the renderer.
      * @param audioNodes {AudioNode[]}
      */
     connectIndividualOutputs(audioNodes: AudioNode[]): void;
@@ -237,7 +230,7 @@ export class Synthetizer {
      */
     pitchWheel(channel: number, MSB: number, LSB: number): void;
     /**
-     * Transposes the synthetizer's pitch by given semitones amount (percussion channels do not get affected)
+     * Transposes the synthetizer's pitch by given semitones amount (percussion channels don’t get affected)
      * @param semitones {number} the semitones to transpose by. Can be a floating point number for more precision
      */
     transpose(semitones: number): void;
@@ -350,7 +343,8 @@ export type StartRenderingDataConfig = {
      */
     snapshot: SynthesizerSnapshot;
     /**
-     * - if synth should use one output with 32 channels (2 audio channels for each midi channel). this disables chorus and reverb.
+     * - if synth should use one output with 32 channels (2 audio channels for each midi channel).
+     * this disabled chorus and reverb.
      */
     oneOutput: boolean | undefined;
     /**

package/package.json

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