@fluex/fluexgl-dsp 0.1.2 → 0.2.1

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

@@ -1,39 +1,39 @@
-import { v4 } from "uuid";
-
-import { Master } from "./Master";
-
-import { ErrorCodes } from "../../console-codes";
-import { Debug } from "../../utilities/debugger";
-
-export class AudioDevice {
-
-    public id: string = v4();
-    public timestamp: number = Date.now();
-
-    public masterChannel: Master = new Master();
-    public masterChannels: Master[] = [];
-
-    constructor(public deviceInfo: MediaDeviceInfo) {}
-
-    public GetMasterChannel(): Master {
-        return this.masterChannel;
-    }
-
-    public SetMasterChannel(channel: Master): void {
-        
-        if(channel.id === this.masterChannel.id) return Debug.Error("The provided master channel is the same as the current channel.", [
-            "Provide this method with a different master channel.",
-            `Received master channel ID ${channel.id}.`     
-        ], ErrorCodes.SAME_MASTER_CHANNEL);
-
-        this.masterChannel = channel;
-    }
-
-    public CreateMasterChannel(): Master {
-
-        const master = new Master();
-
-        this.masterChannels.push(master);
-        return master;
-    }
+import { v4 } from "uuid";
+
+import { Master } from "./Master";
+
+import { ErrorCodes } from "../../console-codes";
+import { Debug } from "../../utilities/debugger";
+
+export class AudioDevice {
+
+    public id: string = v4();
+    public timestamp: number = Date.now();
+
+    public masterChannel: Master = new Master();
+    public masterChannels: Master[] = [];
+
+    constructor(public deviceInfo: MediaDeviceInfo) {}
+
+    public GetMasterChannel(): Master {
+        return this.masterChannel;
+    }
+
+    public SetMasterChannel(channel: Master): void {
+        
+        if(channel.id === this.masterChannel.id) return Debug.Error("The provided master channel is the same as the current channel.", [
+            "Provide this method with a different master channel.",
+            `Received master channel ID ${channel.id}.`     
+        ], ErrorCodes.SAME_MASTER_CHANNEL);
+
+        this.masterChannel = channel;
+    }
+
+    public CreateMasterChannel(): Master {
+
+        const master = new Master();
+
+        this.masterChannels.push(master);
+        return master;
+    }
 }

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

@@ -1,199 +1,289 @@
-import { v4 } from "uuid";
-
-import { Effector } from "./Effector";
-import { AudioClip } from "./AudioClip";
-import { Master } from "./Master";
-
-import { ChannelOptions } from "../../typings";
-import { Debug } from "../../utilities/debugger";
-
-export class Channel {
-
-    public id: string = v4();
-    public effects: Effector[] = [];
-    public label: string | null;
-
-    public parentialContext: AudioContext | null = null;
-    public parentialMasterChannel: Master | null = null;
-
-    public audioClips: AudioClip[] = [];
-
-    public gainNode: GainNode | null = null;
-    public stereoPannerNode: StereoPannerNode | null = null;
-
-    public audioClipsInputGainNode: GainNode | null = null;
-
-    constructor(public options: Partial<ChannelOptions> = { maxAudioNodes: 8, maxEffects: 8 }) {
-
-        this.label = options.label ?? null;
-    }
-
-    private rebuildEffectChain() {
-        Debug.Log("Attempting to rebuild effect chain.");
-
-        if (!this.audioClipsInputGainNode || !this.gainNode) return Debug.Error("Could not rebuild effect chain, because one or more gain nodes on this channel are undefined.", [
-            `Channel id: ${this.id}.`,
-            `Current amount of effects: ${this.effects.length}.`
-        ]);
-
-        this.audioClipsInputGainNode.disconnect();
-
-        for (const effect of this.effects) {
-            effect.audioWorkletNode?.disconnect();
-        }
-
-        const activeEffects = this.effects.filter(e => !!e.audioWorkletNode /* && e.enabled !== false */);
-
-        if (activeEffects.length === 0) {
-
-            this.audioClipsInputGainNode.connect(this.gainNode);
-        } else {
-
-            const firstEffectGain = activeEffects[0].audioWorkletNode!;
-            this.audioClipsInputGainNode.connect(firstEffectGain);
-
-            for (let i = 0; i < activeEffects.length - 1; i++) {
-                
-                const current = activeEffects[i].audioWorkletNode!;
-                const next = activeEffects[i + 1].audioWorkletNode!;
-
-                current.connect(next);
-            }
-
-            const lastEffectGain = activeEffects[activeEffects.length - 1].audioWorkletNode!;
-
-            lastEffectGain.connect(this.gainNode);
-        }
-
-        Debug.Success("Successfully rebuilt effect chain.", [
-            `Channel id: ${this.id}.`,
-            `Current amount of effects: ${this.effects.length}`
-        ]);
-    }
-
-    public InitializeChannelOnMasterAttachment(master: Master) {
-
-        this.parentialMasterChannel = master;
-        this.parentialContext = master.context;
-
-        this.gainNode = new GainNode(this.parentialContext);
-        this.stereoPannerNode = new StereoPannerNode(this.parentialContext);
-
-        this.audioClipsInputGainNode = new GainNode(this.parentialContext);
-
-        this.audioClipsInputGainNode.connect(this.stereoPannerNode);
-        this.stereoPannerNode.connect(this.gainNode);
-        this.gainNode.connect(this.parentialMasterChannel.gainNode);
-    }
-
-    public SetLabel(label: string): void {
-
-        this.options.label = label;
-        this.label = label;
-    }
-
-    public ClearLabel(): void {
-
-        this.options.label = "";
-        this.label = null;
-    }
-
-    public AttachAudioClip(clip: AudioClip) {
-
-        if (this.audioClips.includes(clip)) return Debug.Error("Could not attach audio clip because it is already part of this channel", [
-            "Call .DetachAudioClip([clip AudioClip]) before attaching audio clip."
-        ]);
-
-        clip.InitializeAudioClipOnAttaching(this);
-        this.audioClips.push(clip);
-    }
-
-    public DetachAudioClip(clip: AudioClip) {
-
-        if (!this.audioClips.includes(clip)) return Debug.Error("Could not detach audio clip, because it is not part of this channel.", [
-            "Call .AttachAudioClip([clip AudioClip]) before deattaching audio clip."
-        ]);
-
-        const self: Channel = this;
-
-        clip.parentialAudioContext = null;
-        clip.parentialChannel = null;
-        clip.hasAttachedToChannel = false;
-
-        clip.stereoPannerNode?.disconnect();
-        clip.gainNode?.disconnect();
-
-        clip.DisconnectAllAudioBufferSourceNodes();
-
-        this.audioClips.forEach(function (_clip: AudioClip, index: number) {
-            if (clip.id === _clip.id)
-                return self.audioClips.splice(index, 1);
-        });
-    }
-
-    public SetVolume(volume: number): void {
-
-        if (!this.gainNode) return Debug.Error("Could not set channel volume because the channel is not attached to a master channel.", [
-            "Attach the channel to a master channel before setting the volume."
-        ]);
-
-        this.gainNode.gain.setValueAtTime(volume, this.parentialContext!.currentTime);
-    }
-
-    public SetPanLevel(pan: number): void {
-
-        if (!this.stereoPannerNode) return Debug.Error("Could not set channel pan level because the channel is not attached to a master channel.", [
-            "Attach the channel to a master channel before setting the pan level."
-        ]);
-
-        this.stereoPannerNode.pan.setValueAtTime(pan, this.parentialContext!.currentTime);
-    }
-
-    public AddEffect(effect: Effector): void {
-
-        if (!this.parentialContext) return Debug.Error("Could not add effect on channel, because the parential context is undefined.", [
-            `Channel ID: ${this.id}`,
-            `Effect ID: ${effect.id}`,
-            `Effect name: ${effect.constructor.name}`
-        ])
-
-        if (this.effects.includes(effect)) return Debug.Error("Could not add effect because it is already part of this channel", [
-            "Call .RemoveEffect([effect Effector]) before adding effect."
-        ]);
-
-        effect.InitializeOnAttachment(this.parentialContext);
-
-        this.effects.push(effect);
-        this.rebuildEffectChain();
-    }
-
-    public RemoveEffect(effect: Effector): void {
-
-        if (!this.effects.includes(effect)) return Debug.Error("Could not remove effect, because it is not part of this channel.", [
-            "Call .AddEffect([effect Effector]) before removing effect."
-        ]);
-
-        const self: Channel = this;
-
-        this.effects.forEach(function (_effect: Effector, index: number) {
-            if (effect.id === _effect.id)
-                return self.effects.splice(index, 1);
-        });
-
-        this.rebuildEffectChain();
-    }
-
-    // Public getters and setters
-
-    public get volume(): number | null {
-
-        if (!this.gainNode) return null;
-        return this.gainNode.gain.value;
-    }
-
-    public get panLevel(): number | null {
-
-        if (!this.stereoPannerNode) return null;
-        return this.stereoPannerNode.pan.value;
-    }
+import { v4 } from "uuid";
+
+import { Effector } from "./Effector";
+import { AudioClip } from "./AudioClip";
+import { Master } from "./Master";
+
+import { ChannelOptions } from "../../typings";
+import { Debug } from "../../utilities/debugger";
+
+export class Channel {
+
+    public id: string = v4();
+    public effects: Effector[] = [];
+    public label: string | null;
+
+    public parentialContext: AudioContext | null = null;
+    public parentialMasterChannel: Master | null = null;
+
+    public audioClips: AudioClip[] = [];
+
+    public gainNode: GainNode | null = null;
+    public stereoPannerNode: StereoPannerNode | null = null;
+    public analyserNode: AnalyserNode | null = null;
+    public channelSplitterNode: ChannelSplitterNode | null = null;
+
+    public analyserFloatArrayBuffer = new Float32Array();
+    public analyserByteArrayBuffer = new Uint8Array();
+
+    public audioClipsInputGainNode: GainNode | null = null;
+
+    public analyserOptions: AnalyserOptions = { fftSize: 32 };
+
+    constructor(public options: Partial<ChannelOptions> = { maxAudioNodes: 8, maxEffects: 8 }) {
+        this.label = options.label ?? null;
+    }
+
+    private rebuildEffectChain() {
+        Debug.Log("Attempting to rebuild effect chain.");
+
+        if (!this.audioClipsInputGainNode || !this.gainNode) return Debug.Error("Could not rebuild effect chain, because one or more gain nodes on this channel are undefined.", [
+            `Channel id: ${this.id}.`,
+            `Current amount of effects: ${this.effects.length}.`
+        ]);
+
+        this.audioClipsInputGainNode.disconnect();
+
+        for (const effect of this.effects) {
+            effect.audioWorkletNode?.disconnect();
+        }
+
+        const activeEffects = this.effects.filter(e => !!e.audioWorkletNode);
+
+        if (activeEffects.length === 0) {
+
+            this.audioClipsInputGainNode.connect(this.gainNode);
+        } else {
+
+            const firstEffectGain = activeEffects[0].audioWorkletNode!;
+            this.audioClipsInputGainNode.connect(firstEffectGain);
+
+            for (let i = 0; i < activeEffects.length - 1; i++) {
+
+                const current = activeEffects[i].audioWorkletNode!;
+                const next = activeEffects[i + 1].audioWorkletNode!;
+
+                current.connect(next);
+            }
+
+            const lastEffectGain = activeEffects[activeEffects.length - 1].audioWorkletNode!;
+
+            lastEffectGain.connect(this.gainNode);
+        }
+
+        Debug.Success("Successfully rebuilt effect chain.", [
+            `Channel id: ${this.id}.`,
+            `Current amount of effects: ${this.effects.length}`
+        ]);
+    }
+
+    public InitializeChannelOnMasterAttachment(master: Master) {
+
+        this.parentialMasterChannel = master;
+        this.parentialContext = master.context;
+
+        this.gainNode = new GainNode(this.parentialContext);
+        this.stereoPannerNode = new StereoPannerNode(this.parentialContext);
+        this.analyserNode = new AnalyserNode(this.parentialContext, this.analyserOptions);
+
+        this.analyserFloatArrayBuffer = new Float32Array(this.analyserNode.fftSize);
+        this.analyserByteArrayBuffer = new Uint8Array(this.analyserNode.fftSize);
+
+        this.audioClipsInputGainNode = new GainNode(this.parentialContext);
+
+        this.audioClipsInputGainNode.connect(this.stereoPannerNode);
+        this.stereoPannerNode.connect(this.gainNode);
+        this.gainNode.connect(this.analyserNode);
+        this.analyserNode.connect(this.parentialMasterChannel.gainNode);
+    }
+
+    public SetLabel(label: string): void {
+
+        this.options.label = label;
+        this.label = label;
+    }
+
+    public ClearLabel(): void {
+
+        this.options.label = "";
+        this.label = null;
+    }
+
+    public AttachAudioClip(clip: AudioClip) {
+
+        if (this.audioClips.includes(clip)) return Debug.Error("Could not attach audio clip because it is already part of this channel", [
+            "Call .DetachAudioClip([clip AudioClip]) before attaching audio clip."
+        ]);
+
+        clip.InitializeAudioClipOnAttaching(this);
+        this.audioClips.push(clip);
+    }
+
+    public DetachAudioClip(clip: AudioClip) {
+
+        if (!this.audioClips.includes(clip)) return Debug.Error("Could not detach audio clip, because it is not part of this channel.", [
+            "Call .AttachAudioClip([clip AudioClip]) before deattaching audio clip."
+        ]);
+
+        const self: Channel = this;
+
+        clip.parentialAudioContext = null;
+        clip.parentialChannel = null;
+        clip.hasAttachedToChannel = false;
+
+        clip.stereoPannerNode?.disconnect();
+        clip.gainNode?.disconnect();
+
+        clip.DisconnectAllAudioBufferSourceNodes();
+
+        this.audioClips.forEach(function (_clip: AudioClip, index: number) {
+            if (clip.id === _clip.id)
+                return self.audioClips.splice(index, 1);
+        });
+    }
+
+    public HasAudioClip(clip: AudioClip): boolean {
+
+        for (let _clip of this.audioClips) {
+            if (_clip.id === clip.id) return true;
+        }
+
+        return false;
+    }
+
+    public SetVolume(volume: number): void {
+
+        if (!this.gainNode) return Debug.Error("Could not set channel volume because the channel is not attached to a master channel.", [
+            "Attach the channel to a master channel before setting the volume."
+        ]);
+
+        this.gainNode.gain.setValueAtTime(volume, this.parentialContext!.currentTime);
+    }
+
+    public SetPanLevel(pan: number): void {
+
+        if (!this.stereoPannerNode) return Debug.Error("Could not set channel pan level because the channel is not attached to a master channel.", [
+            "Attach the channel to a master channel before setting the pan level."
+        ]);
+
+        this.stereoPannerNode.pan.setValueAtTime(pan, this.parentialContext!.currentTime);
+    }
+
+    public AddEffect(effect: Effector): void {
+
+        if (!this.parentialContext) return Debug.Error("Could not add effect on channel, because the parential context is undefined.", [
+            `Channel ID: ${this.id}`,
+            `Effect ID: ${effect.id}`,
+            `Effect name: ${effect.constructor.name}`
+        ])
+
+        if (this.effects.includes(effect)) return Debug.Error("Could not add effect because it is already part of this channel", [
+            "Call .RemoveEffect([effect Effector]) before adding effect."
+        ]);
+
+        effect.InitializeOnAttachment(this.parentialContext);
+
+        this.effects.push(effect);
+        this.rebuildEffectChain();
+    }
+
+    public AttachEffect(effect: Effector): void {
+        return this.AddEffect(effect);
+    }
+
+    public RemoveEffect(effect: Effector): void {
+
+        if (!this.effects.includes(effect)) return Debug.Error("Could not remove effect, because it is not part of this channel.", [
+            "Call .AddEffect([effect Effector]) before removing effect."
+        ]);
+
+        const self: Channel = this;
+
+        this.effects.forEach(function (_effect: Effector, index: number) {
+            if (effect.id === _effect.id)
+                return self.effects.splice(index, 1);
+        });
+
+        this.rebuildEffectChain();
+    }
+
+    public DetachEffect(effect: Effector): void {
+        return this.RemoveEffect(effect);
+    }
+
+    public SetAnalyserFftSize(value: number): number | null {
+
+        if (!this.analyserNode) {
+            Debug.Error("Could not set FFT size on analyser because the analyser has not been defined.");
+            return null;
+        }
+
+        this.analyserNode.fftSize = value;
+
+        this.analyserFloatArrayBuffer = new Float32Array(this.analyserNode.fftSize);
+        this.analyserByteArrayBuffer = new Uint8Array(this.analyserNode.fftSize);
+
+        return this.analyserNode.fftSize;
+    }
+
+    public GetWaveformFloatData(): Float32Array | null {
+
+        if (!this.analyserNode) {
+            Debug.Error("Could not get waveform float data, because the analyser has not been defined.");
+            return null;
+        }
+
+        if (this.analyserFloatArrayBuffer.length !== this.analyserNode.fftSize) {
+            this.analyserFloatArrayBuffer = new Float32Array(this.analyserNode.fftSize);
+        }
+
+        this.analyserNode.getFloatTimeDomainData(this.analyserFloatArrayBuffer);
+        return this.analyserFloatArrayBuffer;
+    }
+
+    public GetWaveformByteData(): Uint8Array | null {
+
+        if (!this.analyserNode) {
+            Debug.Error("Could not get waveform byte data, because the analyser has not been defined.");
+            return null;
+        }
+
+        if (this.analyserByteArrayBuffer.length !== this.analyserNode.fftSize) {
+            this.analyserByteArrayBuffer = new Uint8Array(this.analyserNode.fftSize);
+        }
+
+        this.analyserNode.getByteTimeDomainData(this.analyserByteArrayBuffer);
+        return this.analyserByteArrayBuffer;
+    }
+
+    public SetAnalyserOptions(options: AnalyserOptions): Channel | null {
+
+        this.analyserOptions = {...options};
+
+        if (!this.analyserNode) return null;
+
+        this.analyserNode.minDecibels = options.minDecibels ?? this.analyserNode.minDecibels;
+        this.analyserNode.maxDecibels = options.maxDecibels ?? this.analyserNode.maxDecibels;
+        this.analyserNode.fftSize = options.fftSize ?? 32;
+        this.analyserNode.smoothingTimeConstant = options.smoothingTimeConstant ?? this.analyserNode.smoothingTimeConstant;
+
+        this.analyserByteArrayBuffer = new Uint8Array(this.analyserNode.fftSize);
+        this.analyserFloatArrayBuffer = new Float32Array(this.analyserNode.fftSize);
+
+        return this;
+    }
+
+    // Public getters and setters
+
+    public get volume(): number | null {
+
+        if (!this.gainNode) return null;
+        return this.gainNode.gain.value;
+    }
+
+    public get panLevel(): number | null {
+
+        if (!this.stereoPannerNode) return null;
+        return this.stereoPannerNode.pan.value;
+    }
 }