spessasynth_lib 3.24.2 → 3.24.3

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.2",
+  "version": "3.24.3",
   "description": "MIDI and SoundFont2/DLS library with no compromises",
   "browser": "index.js",
   "types": "@types/index.d.ts",

package/synthetizer/audio_effects/effects_config.js

@@ -1,21 +1,25 @@
 import { DEFAULT_CHORUS_CONFIG } from "./fancy_chorus.js";
 
 /**
- * @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 = {
+export const DEFAULT_SYNTH_CONFIG = {
     chorusEnabled: true,
     chorusConfig: DEFAULT_CHORUS_CONFIG,
     
     reverbEnabled: true,
-    reverbImpulseResponse: undefined // will load the integrated one
+    reverbImpulseResponse: undefined, // will load the integrated one
+    audioNodeCreators: undefined
 };

package/synthetizer/audio_effects/fancy_chorus.js

@@ -52,13 +52,9 @@ export class FancyChorus
     {
         const context = output.context;
         
-        this.input = new ChannelSplitterNode(context, {
-            numberOfOutputs: 2
-        });
+        this.input = context.createChannelSplitter(2);
         
-        const merger = new ChannelMergerNode(context, {
-            numberOfInputs: 2
-        });
+        const merger = context.createChannelMerger(2);
         
         /**
          * @type {ChorusNode[]}
@@ -142,16 +138,13 @@ export class FancyChorus
      */
     createChorusNode(freq, delay, list, input, output, outputNum, context, config)
     {
-        const oscillator = new OscillatorNode(context, {
-            type: "sine",
-            frequency: freq
-        });
-        const gainNode = new GainNode(context, {
-            gain: config.oscillatorGain
-        });
-        const delayNode = new DelayNode(context, {
-            delayTime: delay
-        });
+        const oscillator = context.createOscillator();
+        oscillator.type = "sine";
+        oscillator.frequency.value = freq;
+        const gainNode = context.createGain();
+        gainNode.gain.value = config.oscillatorGain;
+        const delayNode = context.createDelay();
+        delayNode.delayTime.value = delay;
         
         oscillator.connect(gainNode);
         gainNode.connect(delayNode.delayTime);

package/synthetizer/audio_effects/reverb.js

@@ -6,7 +6,7 @@
  */
 export function getReverbProcessor(context, reverbBuffer = undefined)
 {
-    const convolver = new ConvolverNode(context);
+    const convolver = context.createConvolver();
     if (reverbBuffer)
     {
         convolver.buffer = reverbBuffer;

package/synthetizer/synthetizer.js

@@ -11,7 +11,7 @@ import {
     workletMessageType
 } from "./worklet_system/message_protocol/worklet_message.js";
 import { SpessaSynthInfo, SpessaSynthWarn } from "../utils/loggin.js";
-import { DEFAULT_EFFECTS_CONFIG } from "./audio_effects/effects_config.js";
+import { DEFAULT_SYNTH_CONFIG } from "./audio_effects/effects_config.js";
 import { SoundfontManager } from "./synth_soundfont_manager.js";
 import { channelConfiguration } from "./worklet_system/worklet_utilities/worklet_processor_channel.js";
 import { KeyModifierManager } from "./key_modifier_manager.js";
@@ -26,7 +26,8 @@ import { KeyModifierManager } from "./key_modifier_manager.js";
  * @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
  */
 
@@ -38,14 +39,7 @@ 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
 {
     /**
@@ -54,13 +48,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,
                 soundFontBuffer,
                 enableEventSystem = true,
                 startRenderingData = undefined,
-                effectsConfig = DEFAULT_EFFECTS_CONFIG)
+                synthConfig = DEFAULT_SYNTH_CONFIG)
     {
         SpessaSynthInfo("%cInitializing SpessaSynth synthesizer...", consoleColors.info);
         this.context = targetNode.context;
@@ -68,7 +62,7 @@ export class Synthetizer
         const oneOutputMode = startRenderingData?.oneOutput === true;
         
         /**
-         * Allows to set up custom event listeners for the synthesizer
+         * Allows setting up custom event listeners for the synthesizer
          * @type {EventHandler}
          */
         this.eventHandler = new EventHandler();
@@ -78,14 +72,14 @@ export class Synthetizer
         
         /**
          * 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
          */
         this._outputsAmount = MIDI_CHANNEL_COUNT;
         
         /**
-         * the amount of midi channels
+         * the number of midi channels
          * @type {number}
          */
         this.channelsAmount = this._outputsAmount;
@@ -133,7 +127,7 @@ export class Synthetizer
         if (startRenderingData?.snapshot?.effectsConfig !== undefined)
         {
             /**
-             * @type {EffectsConfig}
+             * @type {SynthConfig}
              */
             this.effectsConfig = startRenderingData.snapshot.effectsConfig;
             // remove from config as it can't be cloned
@@ -142,15 +136,24 @@ export class Synthetizer
         else
         {
             /**
-             * @type {EffectsConfig}
+             * @type {SynthConfig}
              */
-            this.effectsConfig = effectsConfig;
+            this.effectsConfig = synthConfig;
         }
         
         // first two outputs: reverb, chorsu, the others are the channel outputs
         try
         {
-            this.worklet = new AudioWorkletNode(this.context, WORKLET_PROCESSOR_NAME, {
+            let workletConstructor = synthConfig?.audioNodeCreators?.worklet;
+            if (!workletConstructor)
+            {
+                workletConstructor = (ctx, name, opts) =>
+                {
+                    // noinspection JSCheckFunctionSignatures
+                    return new AudioWorkletNode(ctx, name, opts);
+                };
+            }
+            this.worklet = workletConstructor(this.context, WORKLET_PROCESSOR_NAME, {
                 outputChannelCount: processorChannelCount,
                 numberOfOutputs: processorOutputsCount,
                 processorOptions: {
@@ -202,19 +205,6 @@ export class Synthetizer
          * @type {function(WorkletSequencerReturnMessageType, any)}
          */
         this.sequencerCallbackFunction = undefined;
-        // add reverb
-        if (this.effectsConfig.reverbEnabled && !oneOutputMode)
-        {
-            this.reverbProcessor = getReverbProcessor(this.context, this.effectsConfig.reverbImpulseResponse);
-            this.reverbProcessor.connect(targetNode);
-            this.worklet.connect(this.reverbProcessor, 0);
-        }
-        
-        if (this.effectsConfig.chorusEnabled && !oneOutputMode)
-        {
-            this.chorusProcessor = new FancyChorus(targetNode, this.effectsConfig.chorusConfig);
-            this.worklet.connect(this.chorusProcessor.input, 1);
-        }
         
         if (oneOutputMode)
         {
@@ -223,6 +213,22 @@ export class Synthetizer
         }
         else
         {
+            // add reverb and chorus processors
+            const reverbOn = this.effectsConfig?.reverbEnabled ?? true;
+            const chorusOn = this.effectsConfig?.chorusEnabled ?? true;
+            if (reverbOn)
+            {
+                this.reverbProcessor = getReverbProcessor(this.context, this.effectsConfig.reverbImpulseResponse);
+                this.reverbProcessor.connect(targetNode);
+                this.worklet.connect(this.reverbProcessor, 0);
+            }
+            
+            if (chorusOn)
+            {
+                this.chorusProcessor = new FancyChorus(targetNode, this.effectsConfig.chorusConfig);
+                this.worklet.connect(this.chorusProcessor.input, 1);
+            }
+            
             // connect all outputs to the output node
             for (let i = 2; i < this.channelsAmount + 2; i++)
             {
@@ -238,7 +244,7 @@ export class Synthetizer
     }
     
     /**
-     * The maximum amount of voices allowed at once
+     * The maximum number of voices allowed at once
      * @returns {number}
      */
     get voiceCap()
@@ -247,7 +253,7 @@ export class Synthetizer
     }
     
     /**
-     * The maximum amount of voices allowed at once
+     * The maximum number of voices allowed at once
      * @param value {number}
      */
     set voiceCap(value)
@@ -280,7 +286,7 @@ export class Synthetizer
     }
     
     /**
-     * @returns {number} the current amount of voices playing
+     * @returns {number} the current number of voices playing
      */
     get voicesAmount()
     {
@@ -436,7 +442,7 @@ export class Synthetizer
     }
     
     /**
-     * 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)
@@ -623,7 +629,7 @@ export class Synthetizer
     }
     
     /**
-     * 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)