spessasynth_lib 4.1.5 → 4.2.1

package/README.md

@@ -45,7 +45,6 @@ It allows you to:
 - **[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!

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-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';
+import { MIDIPatch, KeyModifier, SoundBankManagerListEntry, SynthProcessorEventData, BasicMIDI, MIDITrack, SequencerEvent, MIDIMessage, SpessaSynthProcessor, SpessaSynthSequencer, SynthProcessorOptions, BasicSoundBank, SoundFont2WriteOptions, DLSWriteOptions, RMIDIWriteOptions, SynthesizerSnapshot, SynthMethodOptions, CustomController, MIDIController, MasterParameterType, SynthProcessorEvent, ChannelProperty, PresetList, WaveWriteOptions } from 'spessasynth_core';
 
 declare class WorkletKeyModifierManagerWrapper {
     private keyModifiers;
@@ -169,7 +169,16 @@ interface SequencerMessageData {
     getMIDI: null;
     setSkipToFirstNote: boolean;
 }
-type SequencerReturnMessage = (SequencerEvent & {
+type SequencerReturnMessage = (Exclude<SequencerEvent, {
+    type: "songListChange";
+}> & {
+    id: number;
+}) | (Extract<SequencerEvent, {
+    type: "songListChange";
+}> & {
+    data: {
+        shuffledSongIndexes: number[];
+    };
     id: number;
 }) | {
     type: "getMIDI";
@@ -245,7 +254,7 @@ declare abstract class BasicSynthesizerCore {
      * @protected
      */
     protected alive: boolean;
-    protected constructor(sampleRate: number, options: SynthProcessorOptions, postMessage: PostMessageSynthCore);
+    protected constructor(sampleRate: number, options: Omit<SynthProcessorOptions, "reverbProcessor" | "chorusProcessor" | "delayProcessor">, 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;
@@ -431,11 +440,6 @@ interface BasicSynthesizerMessageData {
         options: SynthMethodOptions;
     };
     ccReset: null;
-    setChannelVibrato: {
-        rate: number;
-        depth: number;
-        delay: number;
-    };
     stopAll: number;
     muteChannel: boolean;
     addNewChannel: null;
@@ -518,8 +522,7 @@ interface SynthesizerReturn {
     startOfflineRender: null;
     synthesizerSnapshot: SynthesizerSnapshot;
     renderAudio: {
-        reverb: [Float32Array, Float32Array];
-        chorus: [Float32Array, Float32Array];
+        effects: [Float32Array, Float32Array];
         dry: [Float32Array, Float32Array][];
     };
     workerSynthWriteFile: {
@@ -540,17 +543,13 @@ interface SynthConfig {
      */
     oneOutput: boolean;
     /**
-     * If the chorus processor should be initialized during creation.
-     * Note that setting this to false will not allow it to be used later.
-     * If you want to enable it at some point, set this to true and set the chorus gain to 0.
+     * @deprecated Deprecated parameter, does nothing.
      */
-    initializeChorusProcessor: boolean;
+    initializeChorusProcessor?: boolean;
     /**
-     * If the reverb processor should be initialized during creation.
-     * Note that setting this to false will not allow it to be used later.
-     * If you want to enable it at some point, set this to true and set the reverb gain to 0.
+     * @deprecated Deprecated parameter, does nothing.
      */
-    initializeReverbProcessor: boolean;
+    initializeReverbProcessor?: boolean;
     /**
      * Custom audio node creation functions for Web Audio wrappers, such as standardized-audio-context.
      * Pass undefined to use the Web Audio API.
@@ -561,9 +560,6 @@ interface SynthConfig {
      */
     enableEventSystem: boolean;
 }
-interface BasicEffectConfig {
-    null?: null;
-}
 interface AudioNodeCreators {
     /**
      * A custom creator for an AudioWorkletNode.
@@ -575,133 +571,6 @@ interface AudioNodeCreators {
         processorOptions: PassedProcessorParameters;
     }) => AudioWorkletNode;
 }
-interface ReverbConfig extends BasicEffectConfig {
-    /**
-     * The impulse response for the reverb. Pass undefined to use default one.
-     */
-    impulseResponse?: AudioBuffer;
-}
-interface ChorusConfig extends BasicEffectConfig {
-    /**
-     * The amount of delay nodes (for each channel) and the corresponding oscillators.
-     */
-    nodesAmount: number;
-    /**
-     * The initial delay, in seconds.
-     */
-    defaultDelay: number;
-    /**
-     * The difference between delays in the delay nodes.
-     */
-    delayVariation: number;
-    /**
-     * The difference of delays between two channels (added to the right channel).
-     */
-    stereoDifference: number;
-    /**
-     * The initial delay time oscillator frequency, in Hz.
-     */
-    oscillatorFrequency: number;
-    /**
-     * The difference between frequencies of oscillators, in Hz.
-     */
-    oscillatorFrequencyVariation: number;
-    /**
-     * How much will oscillator alter the delay in delay nodes, in seconds.
-     */
-    oscillatorGain: number;
-}
-
-declare abstract class BasicEffectsProcessor {
-    readonly input: AudioNode;
-    protected readonly output: AudioNode;
-    protected constructor(input: AudioNode, output: AudioNode);
-    abstract get config(): BasicEffectConfig;
-    abstract update(config: BasicEffectConfig): void;
-    /**
-     * Connects the processor to a given node.
-     * @param destinationNode The node to connect to.
-     */
-    connect(destinationNode: AudioNode): AudioNode;
-    /**
-     * Disconnects the processor from a given node.
-     * @param destinationNode The node to disconnect from.
-     */
-    disconnect(destinationNode?: AudioNode): void;
-    /**
-     * Disconnects the effect processor.
-     */
-    delete(): void;
-}
-
-/**
- * Fancy_chorus.js
- * purpose: creates a simple chorus effect node
- */
-
-declare class ChorusProcessor extends BasicEffectsProcessor {
-    private readonly chorusLeft;
-    private readonly chorusRight;
-    /**
-     * Creates a fancy chorus effect.
-     * @param context The audio context.
-     * @param config The configuration for the chorus.
-     */
-    constructor(context: BaseAudioContext, config?: Partial<ChorusConfig>);
-    private _config;
-    get config(): ChorusConfig;
-    /**
-     * Updates the chorus with a given config.
-     * @param chorusConfig The config to use.
-     */
-    update(chorusConfig: Partial<ChorusConfig>): void;
-    /**
-     * Disconnects and deletes the chorus effect.
-     */
-    delete(): void;
-    private deleteNodes;
-    private createChorusNode;
-}
-
-declare class ReverbProcessor extends BasicEffectsProcessor {
-    /**
-     * Indicates that the reverb is ready.
-     */
-    readonly isReady: Promise<AudioBuffer>;
-    private conv;
-    /**
-     * Creates a new reverb processor.
-     * @param context The context to use.
-     * @param config The reverb configuration.
-     */
-    constructor(context: BaseAudioContext, config?: Partial<ReverbConfig>);
-    private _config;
-    get config(): ReverbConfig;
-    /**
-     * Updates the reverb with a given config.
-     * @param config The config to use.
-     */
-    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 SynthesizerSnapshot from the lib snapshot.
-     */
-    getCoreSnapshot(): SynthesizerSnapshot;
-}
 
 declare abstract class BasicSynthesizer {
     /**
@@ -739,15 +608,15 @@ declare abstract class BasicSynthesizer {
      */
     readonly isReady: Promise<unknown>;
     /**
-     * Synthesizer's reverb processor.
-     * Undefined if reverb is disabled.
+     * Legacy parameter.
+     * @deprecated
      */
-    readonly reverbProcessor?: ReverbProcessor;
+    readonly reverbProcessor: undefined;
     /**
-     * Synthesizer's chorus processor.
-     * Undefined if chorus is disabled.
+     * Legacy parameter.
+     * @deprecated
      */
-    readonly chorusProcessor?: ChorusProcessor;
+    readonly chorusProcessor: undefined;
     /**
      * INTERNAL USE ONLY!
      * @internal
@@ -822,15 +691,14 @@ declare abstract class BasicSynthesizer {
     /**
      * Gets a complete snapshot of the synthesizer, effects.
      */
-    getSnapshot(): Promise<LibSynthesizerSnapshot>;
+    getSnapshot(): Promise<SynthesizerSnapshot>;
     /**
      * Adds a new channel to the synthesizer.
      */
     addNewChannel(): void;
     /**
-     * Sets custom vibrato for the channel.
-     * @param channel The channel number.
-     * @param value The vibrato parameters.
+     * DEPRECATED, please don't use it!
+     * @deprecated
      */
     setVibrato(channel: number, value: {
         delay: number;
@@ -849,6 +717,7 @@ declare abstract class BasicSynthesizer {
     disconnectIndividualOutputs(audioNodes: AudioNode[]): void;
     /**
      * Disables the GS NRPN parameters like vibrato or drum key tuning.
+     * @deprecated Deprecated! Please use master parameters
      */
     disableGSNPRNParams(): void;
     /**
@@ -1115,10 +984,6 @@ declare class SeqEventHandler {
 }
 
 declare class Sequencer {
-    /**
-     * The current MIDI data, with the exclusion of the embedded sound bank and event data.
-     */
-    midiData?: MIDIData;
     /**
      * The current MIDI data for all songs, like the midiData property.
      */
@@ -1135,6 +1000,10 @@ declare class Sequencer {
      * The synthesizer attached to this sequencer.
      */
     readonly synth: BasicSynthesizer;
+    /**
+     * The current MIDI data, with the exclusion of the embedded sound bank and event data.
+     */
+    midiData?: MIDIData;
     /**
      * The MIDI port to play to.
      */
@@ -1161,13 +1030,21 @@ declare class Sequencer {
      * @param options the sequencer's options.
      */
     constructor(synth: BasicSynthesizer, options?: Partial<SequencerOptions>);
+    private _shuffledSongIndexes;
+    /**
+     * The shuffled song indexes.
+     * This is used when shuffleMode is enabled.
+     */
+    get shuffledSongIndexes(): number[];
     private _songIndex;
     /**
      * The current song number in the playlist.
+     * If shuffle Mode is enabled, this is the index of the shuffled song list.
      */
     get songIndex(): number;
     /**
      * The current song number in the playlist.
+     * If shuffle Mode is enabled, this is the index of the shuffled song list.
      */
     set songIndex(value: number);
     private _currentTempo;
@@ -1216,11 +1093,17 @@ declare class Sequencer {
     set playbackRate(value: number);
     private _shuffleSongs;
     /**
-     * Indicates if the song order is random.
+     * Controls if the sequencer should shuffle the songs in the song list.
+     * If true, the sequencer will play the songs in a random order.
+     *
+     * Songs are shuffled on a `loadNewSongList` call.
      */
     get shuffleSongs(): boolean;
     /**
-     * Indicates if the song order is random.
+     * Controls if the sequencer should shuffle the songs in the song list.
+     * If true, the sequencer will play the songs in a random order.
+     *
+     * Songs are shuffled on a `loadNewSongList` call.
      */
     set shuffleSongs(value: boolean);
     /**
@@ -1377,4 +1260,4 @@ declare class WebMIDILinkHandler {
 
 declare const DEFAULT_SYNTH_CONFIG: SynthConfig;
 
-export { BasicSynthesizer, ChorusProcessor, DEFAULT_SYNTH_CONFIG, MIDIDeviceHandler, ReverbProcessor, Sequencer, WebMIDILinkHandler, WorkerSynthesizer, WorkerSynthesizerCore, WorkletSynthesizer, audioBufferToWav };
+export { BasicSynthesizer, DEFAULT_SYNTH_CONFIG, MIDIDeviceHandler, Sequencer, WebMIDILinkHandler, WorkerSynthesizer, WorkerSynthesizerCore, WorkletSynthesizer, audioBufferToWav };