spessasynth_lib 4.0.4 → 4.0.5

package/dist/index.d.ts

@@ -1,4 +1,108 @@
-import { BasicMIDI, MIDITrack, MIDIMessage, SequencerEvent, SpessaSynthProcessor, SpessaSynthSequencer, SynthProcessorOptions, BasicSoundBank, SoundFont2WriteOptions, DLSWriteOptions, RMIDIWriteOptions, SynthesizerSnapshot, SynthMethodOptions, CustomController, MIDIController, MasterParameterType, KeyModifier, SynthProcessorEvent, MIDIPatch, SoundBankManagerListEntry, SynthProcessorEventData, ChannelSnapshot, ChannelProperty, PresetList, WaveWriteOptions } from 'spessasynth_core';
+import { MIDIPatch, KeyModifier, SoundBankManagerListEntry, SynthProcessorEventData, BasicMIDI, MIDITrack, SequencerEvent, MIDIMessage, SpessaSynthProcessor, SpessaSynthSequencer, SynthProcessorOptions, BasicSoundBank, SoundFont2WriteOptions, DLSWriteOptions, RMIDIWriteOptions, SynthesizerSnapshot, SynthMethodOptions, CustomController, MIDIController, MasterParameterType, SynthProcessorEvent, ChannelSnapshot, ChannelProperty, PresetList, WaveWriteOptions } from 'spessasynth_core';
+
+declare class WorkletKeyModifierManagerWrapper {
+    private keyModifiers;
+    private synth;
+    constructor(synth: BasicSynthesizer);
+    /**
+     * Modifies a single key.
+     * @param channel The channel affected. Usually 0-15.
+     * @param midiNote The MIDI note to change. 0-127.
+     * @param options The key's modifiers.
+     */
+    addModifier(channel: number, midiNote: number, options: Partial<{
+        velocity: number;
+        patch: MIDIPatch;
+        gain: number;
+    }>): void;
+    /**
+     * Gets a key modifier.
+     * @param channel The channel affected. Usually 0-15.
+     * @param midiNote The MIDI note to change. 0-127.
+     * @returns The key modifier if it exists.
+     */
+    getModifier(channel: number, midiNote: number): KeyModifier | undefined;
+    /**
+     * Deletes a key modifier.
+     * @param channel The channel affected. Usually 0-15.
+     * @param midiNote The MIDI note to change. 0-127.
+     */
+    deleteModifier(channel: number, midiNote: number): void;
+    /**
+     * Clears ALL Modifiers
+     */
+    clearModifiers(): void;
+    private sendToWorklet;
+}
+
+type LibSBKManagerEntry = Omit<SoundBankManagerListEntry, "soundBank">;
+declare class SoundBankManager {
+    /**
+     * All the sound banks, ordered from the most important to the least.
+     */
+    soundBankList: LibSBKManagerEntry[];
+    private synth;
+    /**
+     * Creates a new instance of the sound bank manager.
+     */
+    constructor(synth: BasicSynthesizer);
+    /**
+     * The current sound bank priority order.
+     * @returns The IDs of the sound banks in the current order.
+     */
+    get priorityOrder(): string[];
+    /**
+     * Rearranges the sound banks in a given order.
+     * @param newList The order of sound banks, a list of identifiers, first overwrites second.
+     */
+    set priorityOrder(newList: string[]);
+    /**
+     * Adds a new sound bank buffer with a given ID.
+     * @param soundBankBuffer The sound bank's buffer
+     * @param id The sound bank's unique identifier.
+     * @param bankOffset The sound bank's bank offset. Default is 0.
+     */
+    addSoundBank(soundBankBuffer: ArrayBuffer, id: string, bankOffset?: number): Promise<void>;
+    /**
+     * Deletes a sound bank with the given ID.
+     * @param id The sound bank to delete.
+     */
+    deleteSoundBank(id: string): Promise<void>;
+    private awaitResponse;
+    private sendToWorklet;
+}
+
+type ProcessorEventCallback<T extends keyof SynthProcessorEventData> = (callbackData: SynthProcessorEventData[T]) => unknown;
+declare class SynthEventHandler {
+    /**
+     * The time delay before an event is called.
+     * Set to 0 to disable it.
+     */
+    timeDelay: number;
+    /**
+     * The main list of events.
+     * @private
+     */
+    private readonly events;
+    /**
+     * Adds a new event listener.
+     * @param event The event to listen to.
+     * @param id The unique identifier for the event. It can be used to overwrite existing callback with the same ID.
+     * @param callback The callback for the event.
+     */
+    addEvent<T extends keyof SynthProcessorEventData>(event: T, id: string, callback: ProcessorEventCallback<T>): void;
+    /**
+     * Removes an event listener
+     * @param name The event to remove a listener from.
+     * @param id The unique identifier for the event to remove.
+     */
+    removeEvent<T extends keyof SynthProcessorEventData>(name: T, id: string): void;
+    /**
+     * Calls the given event.
+     * INTERNAL USE ONLY!
+     */
+    callEventInternal<T extends keyof SynthProcessorEventData>(name: T, eventData: SynthProcessorEventData[T]): void;
+}
 
 declare const songChangeType: {
     readonly shuffleOn: 1;
@@ -488,110 +592,6 @@ interface ChorusConfig extends BasicEffectConfig {
     oscillatorGain: number;
 }
 
-declare class WorkletKeyModifierManagerWrapper {
-    private keyModifiers;
-    private synth;
-    constructor(synth: BasicSynthesizer);
-    /**
-     * Modifies a single key.
-     * @param channel The channel affected. Usually 0-15.
-     * @param midiNote The MIDI note to change. 0-127.
-     * @param options The key's modifiers.
-     */
-    addModifier(channel: number, midiNote: number, options: Partial<{
-        velocity: number;
-        patch: MIDIPatch;
-        gain: number;
-    }>): void;
-    /**
-     * Gets a key modifier.
-     * @param channel The channel affected. Usually 0-15.
-     * @param midiNote The MIDI note to change. 0-127.
-     * @returns The key modifier if it exists.
-     */
-    getModifier(channel: number, midiNote: number): KeyModifier | undefined;
-    /**
-     * Deletes a key modifier.
-     * @param channel The channel affected. Usually 0-15.
-     * @param midiNote The MIDI note to change. 0-127.
-     */
-    deleteModifier(channel: number, midiNote: number): void;
-    /**
-     * Clears ALL Modifiers
-     */
-    clearModifiers(): void;
-    private sendToWorklet;
-}
-
-type LibSBKManagerEntry = Omit<SoundBankManagerListEntry, "soundBank">;
-declare class SoundBankManager {
-    /**
-     * All the sound banks, ordered from the most important to the least.
-     */
-    soundBankList: LibSBKManagerEntry[];
-    private synth;
-    /**
-     * Creates a new instance of the sound bank manager.
-     */
-    constructor(synth: BasicSynthesizer);
-    /**
-     * The current sound bank priority order.
-     * @returns The IDs of the sound banks in the current order.
-     */
-    get priorityOrder(): string[];
-    /**
-     * Rearranges the sound banks in a given order.
-     * @param newList The order of sound banks, a list of identifiers, first overwrites second.
-     */
-    set priorityOrder(newList: string[]);
-    /**
-     * Adds a new sound bank buffer with a given ID.
-     * @param soundBankBuffer The sound bank's buffer
-     * @param id The sound bank's unique identifier.
-     * @param bankOffset The sound bank's bank offset. Default is 0.
-     */
-    addSoundBank(soundBankBuffer: ArrayBuffer, id: string, bankOffset?: number): Promise<void>;
-    /**
-     * Deletes a sound bank with the given ID.
-     * @param id The sound bank to delete.
-     */
-    deleteSoundBank(id: string): Promise<void>;
-    private awaitResponse;
-    private sendToWorklet;
-}
-
-type ProcessorEventCallback<T extends keyof SynthProcessorEventData> = (callbackData: SynthProcessorEventData[T]) => unknown;
-declare class SynthEventHandler {
-    /**
-     * The time delay before an event is called.
-     * Set to 0 to disable it.
-     */
-    timeDelay: number;
-    /**
-     * The main list of events.
-     * @private
-     */
-    private readonly events;
-    /**
-     * Adds a new event listener.
-     * @param event The event to listen to.
-     * @param id The unique identifier for the event. It can be used to overwrite existing callback with the same ID.
-     * @param callback The callback for the event.
-     */
-    addEvent<T extends keyof SynthProcessorEventData>(event: T, id: string, callback: ProcessorEventCallback<T>): void;
-    /**
-     * Removes an event listener
-     * @param name The event to remove a listener from.
-     * @param id The unique identifier for the event to remove.
-     */
-    removeEvent<T extends keyof SynthProcessorEventData>(name: T, id: string): void;
-    /**
-     * Calls the given event.
-     * INTERNAL USE ONLY!
-     */
-    callEventInternal<T extends keyof SynthProcessorEventData>(name: T, eventData: SynthProcessorEventData[T]): void;
-}
-
 declare abstract class BasicEffectsProcessor {
     readonly input: AudioNode;
     protected readonly output: AudioNode;
@@ -664,12 +664,21 @@ declare class ReverbProcessor extends BasicEffectsProcessor {
     update(config: Partial<ReverbConfig>): void;
 }
 
+/**
+ * Extended synthesizer snapshot to contain effects
+ */
 declare class LibSynthesizerSnapshot extends SynthesizerSnapshot {
+    /**
+     * Chorus configuration of this synthesizer.
+     */
     chorusConfig: ChorusConfig;
+    /**
+     * Reverb configuration of this synthesizer.
+     */
     reverbConfig: ReverbConfig;
     constructor(channelSnapshots: ChannelSnapshot[], masterParameters: MasterParameterType, keyMappings: (KeyModifier | undefined)[][], chorusConfig?: ChorusConfig, reverbConfig?: ReverbConfig);
     /**
-     * Retrieves the spessasynth_core snapshot from the lib snapshot.
+     * Retrieves the SynthesizerSnapshot from the lib snapshot.
      */
     getCoreSnapshot(): SynthesizerSnapshot;
 }
@@ -699,6 +708,9 @@ declare abstract class BasicSynthesizer {
      * The current preset list.
      */
     presetList: PresetList;
+    /**
+     * INTERNAL USE ONLY!
+     */
     sequencerCallbackFunction?: (m: SequencerReturnMessage) => unknown;
     /**
      * Resolves when the synthesizer is ready.
@@ -714,6 +726,9 @@ declare abstract class BasicSynthesizer {
      * Undefined if chorus is disabled.
      */
     readonly chorusProcessor?: ChorusProcessor;
+    /**
+     * INTERNAL USE ONLY!
+     */
     readonly post: (data: BasicSynthesizerMessage, transfer?: Transferable[]) => unknown;
     protected readonly worklet: AudioWorkletNode;
     /**
@@ -1325,4 +1340,4 @@ declare class WebMIDILinkHandler {
 
 declare const DEFAULT_SYNTH_CONFIG: SynthConfig;
 
-export { ChorusProcessor, DEFAULT_SYNTH_CONFIG, MIDIDeviceHandler, ReverbProcessor, Sequencer, WebMIDILinkHandler, WorkerSynthesizer, WorkerSynthesizerCore, WorkletSynthesizer, audioBufferToWav };
+export { BasicSynthesizer, ChorusProcessor, DEFAULT_SYNTH_CONFIG, MIDIDeviceHandler, ReverbProcessor, Sequencer, WebMIDILinkHandler, WorkerSynthesizer, WorkerSynthesizerCore, WorkletSynthesizer, audioBufferToWav };

package/dist/index.js

@@ -1,15 +1,3 @@
-// src/synthesizer/audio_effects/effects_config.ts
-var DEFAULT_SYNTH_CONFIG = {
-  enableEventSystem: true,
-  oneOutput: false,
-  audioNodeCreators: void 0,
-  initializeChorusProcessor: true,
-  initializeReverbProcessor: true
-};
-
-// src/synthesizer/worklet/worklet_processor_name.ts
-var WORKLET_PROCESSOR_NAME = "spessasynth-worklet-processor";
-
 // src/synthesizer/basic/key_modifier_manager.ts
 import { KeyModifier } from "spessasynth_core";
 
@@ -419,6 +407,7 @@ var ChorusProcessor = class extends BasicEffectsProcessor {
     this.deleteNodes();
   }
   deleteNodes() {
+    this.input.disconnect();
     for (const node of this.chorusLeft) {
       node.delay.disconnect();
       node.oscillator.disconnect();
@@ -459,6 +448,15 @@ var ChorusProcessor = class extends BasicEffectsProcessor {
   }
 };
 
+// src/synthesizer/audio_effects/effects_config.ts
+var DEFAULT_SYNTH_CONFIG = {
+  enableEventSystem: true,
+  oneOutput: false,
+  audioNodeCreators: void 0,
+  initializeChorusProcessor: true,
+  initializeReverbProcessor: true
+};
+
 // src/utils/other.ts
 import { SpessaSynthCoreUtils as SpessaSynthCoreUtils2 } from "spessasynth_core";
 var consoleColors = SpessaSynthCoreUtils2.consoleColors;
@@ -527,21 +525,28 @@ var ReverbProcessor = class extends BasicEffectsProcessor {
 };
 
 // src/synthesizer/basic/snapshot.ts
-import {
-  SynthesizerSnapshot
-} from "spessasynth_core";
+import { ChannelSnapshot, SynthesizerSnapshot } from "spessasynth_core";
 var LibSynthesizerSnapshot = class extends SynthesizerSnapshot {
-  // Effects configuration of this synthesizer.
+  /**
+   * Chorus configuration of this synthesizer.
+   */
   chorusConfig;
+  /**
+   * Reverb configuration of this synthesizer.
+   */
   reverbConfig;
   constructor(channelSnapshots, masterParameters, keyMappings, chorusConfig = DEFAULT_CHORUS_CONFIG, reverbConfig = DEFAULT_REVERB_CONFIG) {
-    super(channelSnapshots, masterParameters, keyMappings);
+    super(
+      channelSnapshots.map((c) => ChannelSnapshot.copyFrom(c)),
+      masterParameters,
+      keyMappings
+    );
     this.reverbConfig = { ...reverbConfig };
     this.chorusConfig = { ...chorusConfig };
   }
   // noinspection JSUnusedGlobalSymbols
   /**
-   * Retrieves the spessasynth_core snapshot from the lib snapshot.
+   * Retrieves the SynthesizerSnapshot from the lib snapshot.
    */
   getCoreSnapshot() {
     return new SynthesizerSnapshot(
@@ -583,7 +588,9 @@ var BasicSynthesizer = class {
    * The current preset list.
    */
   presetList = [];
-  // INTERNAL USE ONLY!
+  /**
+   * INTERNAL USE ONLY!
+   */
   sequencerCallbackFunction;
   /**
    * Resolves when the synthesizer is ready.
@@ -599,7 +606,9 @@ var BasicSynthesizer = class {
    * Undefined if chorus is disabled.
    */
   chorusProcessor;
-  // INTERNAL USE ONLY!
+  /**
+   * INTERNAL USE ONLY!
+   */
   post;
   worklet;
   /**
@@ -1261,6 +1270,9 @@ var BasicSynthesizer = class {
   }
 };
 
+// src/synthesizer/worklet/worklet_processor_name.ts
+var WORKLET_PROCESSOR_NAME = "spessasynth-worklet-processor";
+
 // src/synthesizer/worklet/worklet_synthesizer.ts
 var WorkletSynthesizer = class extends BasicSynthesizer {
   /**