@fluex/fluexgl-dsp 0.1.3 → 0.2.2

package/lib/src/core/classes/DpsPipeline.ts

@@ -1,153 +1,153 @@
-import { v4 } from "uuid";
-
-import { AudioDevice } from "./AudioDevice";
-import { Debug } from "../../utilities/debugger";
-import { LoadWebAssemblyModule } from "../../utilities/web-assembly";
-import { ConstructProcessorWorklet, LoadWorkletOnMasterChannel } from "../../utilities/helpers";
-
-import { ErrorCodes, WarningCodes } from "../../console-codes";
-import { DspPipelineInitializationOptions } from "../../typings";
-
-/**
- * Represents the digital signal processing (DSP) pipeline responsible for initializing
- * WebAssembly modules, AudioWorklet processors, and resolving audio output devices.
- */
-export class DspPipeline {
-
-    /**
-     * The path to the WebAssembly module file.
-     */
-    public pathToWasm: string | null = null;
-
-    /**
-     * The path to the AudioWorklet processor script.
-     */
-    public pathToWorklet: string | null = null;
-
-    /**
-     * Unique identifier of this DSP pipeline instance.
-     */
-    public id: string = v4();
-
-    /**
-     * Indicates whether the DSP pipeline has been successfully initialized.
-     */
-    public hasInitialized: boolean = false;
-
-    /**
-     * The generated blob URL containing the AudioWorklet processor code.
-     */
-    private blobUrl: string | null = null;
-
-    /**
-     * Creates a new instance of the {@link DspPipeline} class.
-     *
-     * @param options - Initialization options for the DSP pipeline.
-     * Must include valid paths to the WebAssembly and AudioWorklet files.
-     */
-    constructor(options: DspPipelineInitializationOptions) {
-        this.pathToWasm = options.pathToWasm;
-        this.pathToWorklet = options.pathToWorklet;
-    }
-
-    /**
-     * Initializes the DSP pipeline.
-     * This is a convenience wrapper around {@link InitializeDpsPipeline}.
-     *
-     * @returns A promise resolving to `true` if the initialization succeeded, otherwise `false`.
-     */
-    public async Init(): Promise<boolean> {
-        return await this.InitializeDpsPipeline();
-    }
-
-    /**
-     * Performs the full initialization of the DSP pipeline.
-     * Loads the WebAssembly module, constructs the AudioWorklet blob URL,
-     * and ensures audio access permissions are granted.
-     *
-     * @returns A promise resolving to `true` when initialization completes successfully, otherwise `false`.
-     */
-    public async InitializeDpsPipeline(): Promise<boolean> {
-        Debug.Log("Attempting to initialize DSP pipeline...");
-
-        const start: number = Date.now();
-
-        if (!this.pathToWasm || !this.pathToWorklet) {
-            Debug.Error("Could not initialize DSP pipeline, because the path to the WASM, or the worklet file has not been defined.");
-            return false;
-        }
-
-        try {
-            const stream = await navigator.mediaDevices.getUserMedia({ audio: true });
-            Debug.Log(`Found ${stream.getTracks().length} media stream tracks.`);
-
-            // Stop all tracks immediately after verification
-            stream.getTracks().forEach((track: MediaStreamTrack) => {
-                track.stop();
-            });
-        } catch (err) {
-            Debug.Error(
-                "Permission to access media devices has not been granted.",
-                ["Make sure the user has granted FluentGL permission to access media devices."],
-                ErrorCodes.NO_CONTEXT_PERMISSION
-            );
-            return false;
-        }
-
-        await LoadWebAssemblyModule(this.pathToWasm);
-
-        const workletFileRequest = await fetch(this.pathToWorklet);
-        const textContent: string = await workletFileRequest.text();
-
-        this.blobUrl = ConstructProcessorWorklet(textContent);
-
-        const end: number = Date.now();
-        const difference: number = end - start;
-
-        Debug.Success(`Successfully initialized DSP pipeline within ${difference}ms.`);
-
-        return (this.hasInitialized = true);
-    }
-
-    /**
-     * Resolves and initializes the system’s default audio output device.
-     * This method can only be called after the DSP pipeline has been initialized.
-     *
-     * @returns A promise that resolves with the default {@link AudioDevice} instance,
-     * or `null` if no default device was found or initialization failed.
-     */
-    public async ResolveDefaultAudioOutputDevice() {
-        Debug.Log("Attempting to resolve default audio output device...");
-
-        if (!this.hasInitialized || !this.blobUrl) {
-            Debug.Error(
-                "Could not resolve default audio output device, because the required blob URL has not been created.",
-                ["Call await .InitializeDpsPipeline() before resolving default audio output device."]
-            );
-            return null;
-        }
-
-        const audioDeviceInfos: MediaDeviceInfo[] = [];
-        const devices = await navigator.mediaDevices.enumerateDevices();
-
-        for (let device of devices)
-            (device.kind === "audiooutput" && device.deviceId === "default") &&
-                audioDeviceInfos.push(device);
-
-        devices.length === 0 &&
-            Debug.Warn("No default audio device found.", [], WarningCodes.NO_DEFAULT_AUDIO_DEVICE_FOUND);
-
-        const defaultAudioDevice =
-            devices.length === 0 ? null : new AudioDevice(audioDeviceInfos[0]);
-
-        if (!defaultAudioDevice) return null;
-
-        await LoadWorkletOnMasterChannel(defaultAudioDevice.masterChannel, this.blobUrl);
-
-        return defaultAudioDevice;
-    }
-
-    public TellMeWhatTheFuckThisWholeLibraryActuallyDoes() {
-        return `I wanted to create a web based game and implement advanced audio, but javascript is slow so that's why this library uses Web Assembly. You dont have to use it, unless you know what the fuck you're doing. If you do, god bless you.`
-    }
+import { v4 } from "uuid";
+
+import { AudioDevice } from "./AudioDevice";
+import { Debug } from "../../utilities/debugger";
+import { LoadWebAssemblyModule } from "../../utilities/web-assembly";
+import { ConstructProcessorWorklet, LoadWorkletOnMasterChannel } from "../../utilities/helpers";
+
+import { ErrorCodes, WarningCodes } from "../../console-codes";
+import { DspPipelineInitializationOptions } from "../../typings";
+
+/**
+ * Represents the digital signal processing (DSP) pipeline responsible for initializing
+ * WebAssembly modules, AudioWorklet processors, and resolving audio output devices.
+ */
+export class DspPipeline {
+
+    /**
+     * The path to the WebAssembly module file.
+     */
+    public pathToWasm: string | null = null;
+
+    /**
+     * The path to the AudioWorklet processor script.
+     */
+    public pathToWorklet: string | null = null;
+
+    /**
+     * Unique identifier of this DSP pipeline instance.
+     */
+    public id: string = v4();
+
+    /**
+     * Indicates whether the DSP pipeline has been successfully initialized.
+     */
+    public hasInitialized: boolean = false;
+
+    /**
+     * The generated blob URL containing the AudioWorklet processor code.
+     */
+    private blobUrl: string | null = null;
+
+    /**
+     * Creates a new instance of the {@link DspPipeline} class.
+     *
+     * @param options - Initialization options for the DSP pipeline.
+     * Must include valid paths to the WebAssembly and AudioWorklet files.
+     */
+    constructor(options: DspPipelineInitializationOptions) {
+        this.pathToWasm = options.pathToWasm;
+        this.pathToWorklet = options.pathToWorklet;
+    }
+
+    /**
+     * Initializes the DSP pipeline.
+     * This is a convenience wrapper around {@link InitializeDpsPipeline}.
+     *
+     * @returns A promise resolving to `true` if the initialization succeeded, otherwise `false`.
+     */
+    public async Init(): Promise<boolean> {
+        return await this.InitializeDpsPipeline();
+    }
+
+    /**
+     * Performs the full initialization of the DSP pipeline.
+     * Loads the WebAssembly module, constructs the AudioWorklet blob URL,
+     * and ensures audio access permissions are granted.
+     *
+     * @returns A promise resolving to `true` when initialization completes successfully, otherwise `false`.
+     */
+    public async InitializeDpsPipeline(): Promise<boolean> {
+        Debug.Log("Attempting to initialize DSP pipeline...");
+
+        const start: number = Date.now();
+
+        if (!this.pathToWasm || !this.pathToWorklet) {
+            Debug.Error("Could not initialize DSP pipeline, because the path to the WASM, or the worklet file has not been defined.");
+            return false;
+        }
+
+        try {
+            const stream = await navigator.mediaDevices.getUserMedia({ audio: true });
+            Debug.Log(`Found ${stream.getTracks().length} media stream tracks.`);
+
+            // Stop all tracks immediately after verification
+            stream.getTracks().forEach((track: MediaStreamTrack) => {
+                track.stop();
+            });
+        } catch (err) {
+            Debug.Error(
+                "Permission to access media devices has not been granted.",
+                ["Make sure the user has granted FluentGL permission to access media devices."],
+                ErrorCodes.NO_CONTEXT_PERMISSION
+            );
+            return false;
+        }
+
+        await LoadWebAssemblyModule(this.pathToWasm);
+
+        const workletFileRequest = await fetch(this.pathToWorklet);
+        const textContent: string = await workletFileRequest.text();
+
+        this.blobUrl = ConstructProcessorWorklet(textContent);
+
+        const end: number = Date.now();
+        const difference: number = end - start;
+
+        Debug.Success(`Successfully initialized DSP pipeline within ${difference}ms.`);
+
+        return (this.hasInitialized = true);
+    }
+
+    /**
+     * Resolves and initializes the system’s default audio output device.
+     * This method can only be called after the DSP pipeline has been initialized.
+     *
+     * @returns A promise that resolves with the default {@link AudioDevice} instance,
+     * or `null` if no default device was found or initialization failed.
+     */
+    public async ResolveDefaultAudioOutputDevice() {
+        Debug.Log("Attempting to resolve default audio output device...");
+
+        if (!this.hasInitialized || !this.blobUrl) {
+            Debug.Error(
+                "Could not resolve default audio output device, because the required blob URL has not been created.",
+                ["Call await .InitializeDpsPipeline() before resolving default audio output device."]
+            );
+            return null;
+        }
+
+        const audioDeviceInfos: MediaDeviceInfo[] = [];
+        const devices = await navigator.mediaDevices.enumerateDevices();
+
+        for (let device of devices)
+            (device.kind === "audiooutput" && device.deviceId === "default") &&
+                audioDeviceInfos.push(device);
+
+        devices.length === 0 &&
+            Debug.Warn("No default audio device found.", [], WarningCodes.NO_DEFAULT_AUDIO_DEVICE_FOUND);
+
+        const defaultAudioDevice =
+            devices.length === 0 ? null : new AudioDevice(audioDeviceInfos[0]);
+
+        if (!defaultAudioDevice) return null;
+
+        await LoadWorkletOnMasterChannel(defaultAudioDevice.masterChannel, this.blobUrl);
+
+        return defaultAudioDevice;
+    }
+
+    public TellMeWhatTheFuckThisWholeLibraryActuallyDoes() {
+        return `I wanted to create a web based game and implement advanced audio, but javascript is slow so that's why this library uses Web Assembly. You dont have to use it, unless you know what the fuck you're doing. If you do, god bless you.`
+    }
 }

package/lib/src/core/classes/Effector.ts

@@ -1,13 +1,12 @@
-import { v4 } from "uuid";
-
-export abstract class Effector {
-    
-    public id: string = v4();
-    public label: string | null = null;
-    public audioWorkletNode: AudioWorkletNode | null = null;
-    public parentialContext: AudioContext | null = null;
-
-    static name: string = "Effector";
-
-    public abstract InitializeOnAttachment(parentialContext: AudioContext): Promise<void>;
+import { v4 } from "uuid";
+
+export abstract class Effector {
+    
+    public id: string = v4();
+    public label: string | null = null;
+    public name: string = "Effector";
+    public audioWorkletNode: AudioWorkletNode | null = null;
+    public parentialContext: AudioContext | null = null;
+
+    public abstract InitializeOnAttachment(parentialContext: AudioContext): Promise<void>;
 }

package/lib/src/core/classes/Master.ts

@@ -1,50 +1,50 @@
-import { v4 } from "uuid";
-
-import { Channel } from "./Channel";
-
-import { Debug } from "../../utilities/debugger";
-
-export class Master {
-
-    public id: string = v4();
-    public channels: Channel[] = [];
-    public context: AudioContext = new AudioContext();
-
-    public gainNode: GainNode = this.context.createGain();
-    public analyserNode: AnalyserNode = this.context.createAnalyser();
-
-    constructor() {
-     
-        this.gainNode.connect(this.analyserNode);
-        this.analyserNode.connect(this.context.destination);
-    }
-
-    public AttachChannel(channel: Channel): void {
-
-        if(this.channels.includes(channel)) return Debug.Error("Could not attach the channel because it is already part of this master channel.",[
-            "Call .DetachChannel([channel Channel]) before attaching the channel."
-        ]);
-
-        channel.InitializeChannelOnMasterAttachment(this);
-
-        this.channels.push(channel);
-        return;
-    }
-
-    public DetachChannel(channel: Channel): void {
-
-        if(!this.channels.includes(channel)) return Debug.Error("Could not detach the channel because it is not part of this master channel.", [
-            "Call .AttachChannel([channel Channel]) before detaching the channel."
-        ]);
-
-        const self = this;
-
-        this.channels.forEach(function(_channel: Channel, index: number) {
-            if(channel.id === _channel.id) {
-
-                self.channels.splice(index, 1);
-                return;
-            }
-        });
-    }
+import { v4 } from "uuid";
+
+import { Channel } from "./Channel";
+
+import { Debug } from "../../utilities/debugger";
+
+export class Master {
+
+    public id: string = v4();
+    public channels: Channel[] = [];
+    public context: AudioContext = new AudioContext();
+
+    public gainNode: GainNode = this.context.createGain();
+    public analyserNode: AnalyserNode = this.context.createAnalyser();
+
+    constructor() {
+     
+        this.gainNode.connect(this.analyserNode);
+        this.analyserNode.connect(this.context.destination);
+    }
+
+    public AttachChannel(channel: Channel): void {
+
+        if(this.channels.includes(channel)) return Debug.Error("Could not attach the channel because it is already part of this master channel.",[
+            "Call .DetachChannel([channel Channel]) before attaching the channel."
+        ]);
+
+        channel.InitializeChannelOnMasterAttachment(this);
+
+        this.channels.push(channel);
+        return;
+    }
+
+    public DetachChannel(channel: Channel): void {
+
+        if(!this.channels.includes(channel)) return Debug.Error("Could not detach the channel because it is not part of this master channel.", [
+            "Call .AttachChannel([channel Channel]) before detaching the channel."
+        ]);
+
+        const self = this;
+
+        this.channels.forEach(function(_channel: Channel, index: number) {
+            if(channel.id === _channel.id) {
+
+                self.channels.splice(index, 1);
+                return;
+            }
+        });
+    }
 }

package/lib/src/core/exports.ts

@@ -1,6 +1,6 @@
-export { AudioDevice } from "./classes/AudioDevice";
-export { Channel } from "./classes/Channel";
-export { Effector } from "./classes/Effector";
-export { Master } from "./classes/Master";
-export { AudioClip } from "./classes/AudioClip";
+export { AudioDevice } from "./classes/AudioDevice";
+export { Channel } from "./classes/Channel";
+export { Effector } from "./classes/Effector";
+export { Master } from "./classes/Master";
+export { AudioClip } from "./classes/AudioClip";
 export { DspPipeline } from "./classes/DpsPipeline";

package/lib/src/effects/classes/Chorus.ts

@@ -1,112 +1,66 @@
-import { compiledWebAssemblyModule } from "../../utilities/web-assembly";
-import { Effector } from "../../core/classes/Effector";
-import { Debug } from "../../utilities/debugger";
-import { ChorusEffectOptions } from "../../typings";
-
-export class Chorus extends Effector {
-
-    public label: string | null = "Chorus";
-    static name: string = "Chorus";
-
-    public baseDelayMs: number = 15;
-    public depthMs: number = 8;
-    public rateHz: number = 1.5;
-    public mix: number = 0.5;
-    public feedback: number = 0.2;
-
-    public options: ChorusEffectOptions = {};
-
-    private sampleRate: number = 0;
-
-    constructor(options?: ChorusEffectOptions) {
-        super();
-
-        this.options = {
-            baseDelayMs: this.baseDelayMs,
-            depthMs: this.depthMs,
-            rateHz: this.rateHz,
-            mix: this.mix,
-            feedback: this.mix,
-            ...options
-        }
-    }
-
-    public async InitializeOnAttachment(parentialContext: AudioContext): Promise<void> {
-
-        if (!compiledWebAssemblyModule) return Debug.Error("Could not initialize effector because the nessecary WASM file has not been specified.", [
-            `Effector type: Chorus`
-        ]);
-
-        this.sampleRate = parentialContext.sampleRate;
-
-        this.audioWorkletNode = new AudioWorkletNode(parentialContext, "ChorusProcessor", {
-            numberOfInputs: 1,
-            numberOfOutputs: 1,
-            outputChannelCount: [2],
-            parameterData: {
-                ...this.options,
-                sampleRate: this.sampleRate
-            },
-            processorOptions: {
-                module: compiledWebAssemblyModule
-            }
-        });
-
-        this.parentialContext = parentialContext;
-    }
-
-    public SetBaseDelayMs(value: number) {
-
-        this.baseDelayMs = value;
-        this.options.baseDelayMs = value;
-
-        this.audioWorkletNode?.port.postMessage({
-            type: "set-base-delay-ms",
-            value
-        });
-    }
-
-    public SetDepthMs(value: number) {
-
-        this.depthMs = value;
-        this.options.depthMs = value;
-
-        this.audioWorkletNode?.port.postMessage({
-            type: "set-depth-ms",
-            value
-        });
-    }
-
-    public SetRateHz(value: number) {
-
-        this.rateHz = value;
-        this.options.rateHz = value;
-
-        this.audioWorkletNode?.port.postMessage({
-            type: "set-rate-hz",
-            value
-        });
-    }
-
-    public SetMix(value: number) {
-
-        this.mix = value;
-        this.options.mix = value;
-
-        this.audioWorkletNode?.port.postMessage({
-            type: "set-mix",
-            value
-        });
-    }
-
-    public SetFeedback(value: number) {
-
-        this.feedback = value;
-        this.options.feedback = value;
-
-        this.audioWorkletNode?.port.postMessage({
-            type: "set-mix",
-            value
-        });
-    }
+import { SendMessageToWorklet, CreateAudioWorkletNode } from "../../utilities/helpers";
+import { Effector } from "../../core/classes/Effector";
+import { ChorusEffectOptions, ChorusMessageCommandId, AudioWorkletProcessorNames } from "../../typings";
+
+export class Chorus extends Effector {
+
+    public label: string | null = "Chorus";
+    public name: string = "Chorus";
+
+    public baseDelayMs: number = 15;
+    public depthMs: number = 8;
+    public rateHz: number = 1.5;
+    public mix: number = 0.5;
+    public feedback: number = 0.2;
+
+    constructor({ baseDelayMs, depthMs, rateHz, mix, feedback }: Partial<ChorusEffectOptions>) {
+        super();
+
+        this.baseDelayMs = baseDelayMs ?? this.baseDelayMs;
+        this.depthMs = depthMs ?? this.depthMs;
+        this.rateHz = rateHz ?? this.rateHz;
+        this.mix = mix ?? this.mix;
+        this.feedback = feedback ?? this.feedback;
+    }
+
+    public async InitializeOnAttachment(parentialContext: AudioContext): Promise<void> {
+
+        this.parentialContext = parentialContext;
+        this.audioWorkletNode = CreateAudioWorkletNode<ChorusEffectOptions>(parentialContext, AudioWorkletProcessorNames.Chorus, this.ReturnOptionsAsObject());
+    }
+
+    public ReturnOptionsAsObject(): ChorusEffectOptions {
+        return {
+            baseDelayMs: this.baseDelayMs,
+            depthMs: this.depthMs,
+            rateHz: this.rateHz,
+            mix: this.mix,
+            feedback: this.feedback,
+        }
+    }
+
+    public SetBaseDelayMs(value: number): boolean {
+        this.baseDelayMs = value;
+        return SendMessageToWorklet<ChorusMessageCommandId, number>(this.audioWorkletNode, ChorusMessageCommandId.SetBaseDelayMs, value);
+    }
+
+    public SetDepthMs(value: number) {
+        this.depthMs = value;
+        return SendMessageToWorklet<ChorusMessageCommandId, number>(this.audioWorkletNode, ChorusMessageCommandId.SetDepthMs, value);
+    }
+
+    public SetRateHz(value: number) {
+        this.rateHz = value;
+        return SendMessageToWorklet<ChorusMessageCommandId, number>(this.audioWorkletNode, ChorusMessageCommandId.SetRateHz, value);
+    }
+
+    public SetMix(value: number) {
+        this.mix = value;
+        return SendMessageToWorklet<ChorusMessageCommandId, number>(this.audioWorkletNode, ChorusMessageCommandId.SetMix, value);
+    }
+
+    public SetFeedback(value: number) {
+        this.feedback = value;
+        return SendMessageToWorklet<ChorusMessageCommandId, number>(this.audioWorkletNode, ChorusMessageCommandId.SetFeedback, value);
+    }
 }

package/lib/src/effects/classes/Distortion.ts

@@ -1,14 +1,14 @@
-import { Effector } from "../../core/classes/Effector";
-
-export class Distortion extends Effector {
-
-    static name: string = "Distortion";
-
-    constructor() {
-        super();
-    }
-
-    public async InitializeOnAttachment(parentialContext: AudioContext): Promise<void> {
-        
-    }
+import { Effector } from "../../core/classes/Effector";
+
+export class Distortion extends Effector {
+
+    public name: string = "Distortion";
+
+    constructor() {
+        super();
+    }
+
+    public async InitializeOnAttachment(parentialContext: AudioContext): Promise<void> {
+        
+    }
 }

package/lib/src/effects/classes/Saturation.ts

@@ -1,3 +1,3 @@
-export class Saturation {
-    
+export class Saturation {
+    
 }