@fluex/fluexgl-dsp 0.1.3 → 0.2.2

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

@@ -1,45 +1,61 @@
-import { compiledWebAssemblyModule } from "../../utilities/web-assembly";
-import { Effector } from "../../core/classes/Effector";
-import { Debug } from "../../utilities/debugger";
-
-export class SoftClip extends Effector {
-
-    public label: string | null = "SoftClip";
-    static name: string = "SoftClip";
-
-    constructor(public drive: number = 1) {
-        super();
-    }
-
-    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: SoftClip`
-        ]);
-
-        this.audioWorkletNode = new AudioWorkletNode(parentialContext, "SoftClipProcessor", {
-            numberOfInputs: 1,
-            numberOfOutputs: 1,
-            outputChannelCount: [2],
-            parameterData: {
-                drive: this.drive
-            },
-            processorOptions: {
-                module: compiledWebAssemblyModule
-            }
-        });
-
-        this.parentialContext = parentialContext;
-    }
-
-    public SetDrive(drive: number): SoftClip {
-
-        if(this.audioWorkletNode) this.audioWorkletNode.port.postMessage({
-            type: "set-drive",
-            value: drive
-        });
-
-        this.drive = drive;
-        return this;
-    }
+import { compiledWebAssemblyModule } from "../../utilities/web-assembly";
+import { Effector } from "../../core/classes/Effector";
+import { Debug } from "../../utilities/debugger";
+
+export class SoftClip extends Effector {
+
+    public label: string | null = "SoftClip";
+    public name: string = "SoftClip";
+
+    constructor(public drive: number = 1, public gain: number = 1) {
+        super();
+    }
+
+    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: SoftClip`
+        ]);
+
+        this.audioWorkletNode = new AudioWorkletNode(parentialContext, "SoftClipProcessor", {
+            numberOfInputs: 1,
+            numberOfOutputs: 1,
+            outputChannelCount: [2],
+            parameterData: {
+                drive: this.drive,
+                gain: this.gain
+            },
+            processorOptions: {
+                module: compiledWebAssemblyModule
+            }
+        });
+
+        this.parentialContext = parentialContext;
+    }
+
+    public SetDrive(drive: number): SoftClip {
+
+        if(this.audioWorkletNode) this.audioWorkletNode.port.postMessage({
+            type: "set-drive",
+            value: drive
+        });
+
+        this.drive = drive;
+        return this;
+    }
+
+    public GetDrive(): number {
+        return this.drive;
+    }
+
+    public SetGain(gain: number): SoftClip {
+
+        if(this.audioWorkletNode) this.audioWorkletNode.port.postMessage({
+            type: "set-gain",
+            value: gain
+        })
+
+        this.gain = gain;
+        return this;
+    }
 }

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

@@ -1,3 +1,3 @@
-export class StereoPanner {
-    static name: string = "StereoPanner";
+export class StereoPanner {
+    public name: string = "StereoPanner";
 }

package/lib/src/effects/classes/filters/LowPassFilter.ts

@@ -0,0 +1,54 @@
+import { Effector } from "../../../core/classes/Effector";
+
+import { SendMessageToWorklet, CreateAudioWorkletNode } from "../../../utilities/helpers";
+
+import { LowPassFilterOptions, LowPassFilterMessageCommandId, AudioWorkletProcessorNames } from "../../../typings";
+
+export class LowPassFilter extends Effector {
+
+    public name: string = "LowPassFilter";
+    public label: string | null = "LowPassFilter";
+
+    public cutoff: number = 4000;
+    public minFrequency: number = 10;
+
+    constructor({ cutoff, minFrequency }: LowPassFilterOptions) {
+        super();
+
+        this.cutoff = cutoff ?? this.cutoff;
+        this.minFrequency = minFrequency ?? this.minFrequency;
+    }
+
+    public async InitializeOnAttachment(parentialContext: AudioContext): Promise<void> {
+
+        this.parentialContext = parentialContext;
+        this.audioWorkletNode = CreateAudioWorkletNode(parentialContext, AudioWorkletProcessorNames.LowPassFilter, this.ReturnOptionsAsObject());
+    }
+
+    public ReturnOptionsAsObject(): LowPassFilterOptions {
+        return {
+            cutoff: this.cutoff,
+            minFrequency: this.minFrequency
+        }
+    }
+
+    public SetCutoff(cutoff: number = 4000): boolean {
+
+        if (!this.parentialContext) return false;
+
+        if (cutoff >= this.parentialContext.sampleRate)
+            cutoff = this.parentialContext.sampleRate;
+
+        this.cutoff = cutoff;
+        return SendMessageToWorklet<LowPassFilterMessageCommandId, number>(this.audioWorkletNode, LowPassFilterMessageCommandId.SetCutoff, cutoff);
+    }
+
+    public SetMinFrequency(minFrequency: number = 10): boolean {
+
+        if (minFrequency < 10)
+            minFrequency = 10;
+
+        this.minFrequency = minFrequency;
+        return SendMessageToWorklet<LowPassFilterMessageCommandId, number>(this.audioWorkletNode, LowPassFilterMessageCommandId.SetMinFrequency, minFrequency);
+    }
+}

package/lib/src/effects/exports.ts

@@ -1,22 +1,23 @@
-export { Chorus } from "./classes/Chorus";
-export { Distortion } from "./classes/Distortion";
-export { Equalizer } from "./classes/Equalizer";
-export { Filter } from "./classes/Filter";
-export { Limiter } from "./classes/Limiter";
-export { Saturation } from "./classes/Saturation";
-export { StereoPanner } from "./classes/StereoPanner";
-export { SoftClip } from "./classes/SoftClip";
-
-export { Compressor } from "./classes/compressors/Compressor";
-export { MultibandCompressor } from "./classes/compressors/MultibandCompressor";
-
-export { AdvancedDelay } from "./classes/delays/AdvancedDelay";
-export { MonoDelay } from "./classes/delays/MonoDelay";
-export { PingPongDelay } from "./classes/delays/PingPongDelay";
-export { StereoDelay } from "./classes/delays/StereoDelay";
-
-export { ChamberReverb } from "./classes/reverbs/ChamberReverb";
-export { ConvolverReverb } from "./classes/reverbs/ConvolverReverb";
-export { GenericReverb } from "./classes/reverbs/GenericReverb";
-export { HallReverb } from "./classes/reverbs/HallReverb";
-export { RoomReverb } from "./classes/reverbs/RoomReverb";
+export { Chorus } from "./classes/Chorus";
+export { Distortion } from "./classes/Distortion";
+export { Equalizer } from "./classes/Equalizer";
+export { Limiter } from "./classes/Limiter";
+export { Saturation } from "./classes/Saturation";
+export { StereoPanner } from "./classes/StereoPanner";
+export { SoftClip } from "./classes/SoftClip";
+
+export { Compressor } from "./classes/compressors/Compressor";
+export { MultibandCompressor } from "./classes/compressors/MultibandCompressor";
+
+export { AdvancedDelay } from "./classes/delays/AdvancedDelay";
+export { MonoDelay } from "./classes/delays/MonoDelay";
+export { PingPongDelay } from "./classes/delays/PingPongDelay";
+export { StereoDelay } from "./classes/delays/StereoDelay";
+
+export { ChamberReverb } from "./classes/reverbs/ChamberReverb";
+export { ConvolverReverb } from "./classes/reverbs/ConvolverReverb";
+export { GenericReverb } from "./classes/reverbs/GenericReverb";
+export { HallReverb } from "./classes/reverbs/HallReverb";
+export { RoomReverb } from "./classes/reverbs/RoomReverb";
+
+export { LowPassFilter } from "./classes/filters/LowPassFilter";

package/lib/src/index.ts

@@ -1,94 +1,99 @@
-/**
- * FluexGL Audio
- * A javascript digital audio processor library.
- */
-
-import { FluexGLAudioDescriptor } from "./typings";
-
-export const FluexGLAudio: FluexGLAudioDescriptor = {
-    name: "FluexGL Audio",
-    author: "Rohan Kanhaisingh",
-    version: "0.0.2",
-    license: "MIT",
-    repository: "https://github.com/rohankanhaisingh/FluexGL-Audio",
-    options: {
-        maxMasterChannels: 8,
-        maxTotalChannels: 128,
-        sampleRate: 44000,
-        spatialization: "stereo",
-        debugger: {
-            showErrors: true,
-            showInfo: true,
-            showWarnings: true,
-            breakOnError: true
-        }
-    }
-}
-
-export {
-    Chorus,
-    Distortion,
-    Equalizer,
-    Filter,
-    Limiter,
-    Saturation,
-    StereoPanner,
-    Compressor,
-    MultibandCompressor,
-    AdvancedDelay,
-    MonoDelay,
-    PingPongDelay,
-    StereoDelay,
-    ChamberReverb,
-    ConvolverReverb,
-    GenericReverb,
-    HallReverb,
-    RoomReverb,
-    SoftClip
-} from "./effects/exports";
-
-export {
-    AudioDevice,
-    Channel,
-    Effector,
-    Master,
-    AudioClip,
-    DspPipeline
-} from "./core/exports";
-
-export {
-    InitializeDspPipeline,
-    ResolveAudioOutputDevices,
-    ResolveAudioInputDevices,
-    ResolveDefaultAudioInputDevice,
-    ResolveDefaultAudioOutputDevice,
-    LoadAudioSource,
-    LoadAudioSourceFromBlob,
-    LoadWorkletOnMasterChannel,
-} from "./utilities/helpers";
-
-export {
-    SUPPORTED_FILE_TYPES
-} from "./utilities/constants";
-
-export {
-    hasInitializedWasm,
-} from "./utilities/web-assembly";
-
-export type {
-    FluexGLAudioDescriptor,
-    FluexGLAudioDebuggerOptions,
-    FluexGLAudioOptions,
-    LoadAudioSourceOptions,
-    AudioSourceData,
-    ChannelOptions,
-    ChannelSpatialization,
-    AudioClipEventMap,
-    AudioClipEvents,
-    AudioClipOnProgressEvent,
-    AudioClipAnalyserProperty,
-    AudioClipAnalyserType,
-    DspPipelineInitializationOptions,
-    DspPipelineInitializationState,
-    ChorusEffectOptions
+/**
+ * FluexGL Audio
+ * A javascript digital audio processor library.
+ */
+
+import { FluexGLAudioDescriptor } from "./typings";
+
+export const FluexGLAudio: FluexGLAudioDescriptor = {
+    name: "FluexGL Audio",
+    author: "Rohan Kanhaisingh",
+    version: "0.0.2",
+    license: "MIT",
+    repository: "https://github.com/rohankanhaisingh/FluexGL-Audio",
+    options: {
+        maxMasterChannels: 8,
+        maxTotalChannels: 128,
+        sampleRate: 44000,
+        spatialization: "stereo",
+        debugger: {
+            showErrors: true,
+            showInfo: true,
+            showWarnings: true,
+            breakOnError: true
+        }
+    }
+}
+
+export {
+    Chorus,
+    Distortion,
+    Equalizer,
+    Limiter,
+    Saturation,
+    StereoPanner,
+    Compressor,
+    MultibandCompressor,
+    AdvancedDelay,
+    MonoDelay,
+    PingPongDelay,
+    StereoDelay,
+    ChamberReverb,
+    ConvolverReverb,
+    GenericReverb,
+    HallReverb,
+    RoomReverb,
+    SoftClip,
+    LowPassFilter
+} from "./effects/exports";
+
+export {
+    AudioDevice,
+    Channel,
+    Effector,
+    Master,
+    AudioClip,
+    DspPipeline
+} from "./core/exports";
+
+export {
+    InitializeDspPipeline,
+    ResolveAudioOutputDevices,
+    ResolveAudioInputDevices,
+    ResolveDefaultAudioInputDevice,
+    ResolveDefaultAudioOutputDevice,
+    LoadAudioSource,
+    LoadAudioSourceFromBlob,
+    LoadWorkletOnMasterChannel,
+    SendMessageToWorklet
+} from "./utilities/helpers";
+
+export {
+    SUPPORTED_FILE_TYPES
+} from "./utilities/constants";
+
+export {
+    hasInitializedWasm,
+} from "./utilities/web-assembly";
+
+export type {
+    FluexGLAudioDescriptor,
+    FluexGLAudioDebuggerOptions,
+    FluexGLAudioOptions,
+    LoadAudioSourceOptions,
+    AudioSourceData,
+    ChannelOptions,
+    ChannelSpatialization,
+    AudioClipEventMap,
+    AudioClipEvents,
+    AudioClipOnProgressEvent,
+    AudioClipAnalyserProperty,
+    AudioClipAnalyserType,
+    DspPipelineInitializationOptions,
+    DspPipelineInitializationState,
+    ChorusEffectOptions,
+    LowPassFilterOptions,
+    LowPassFilterMessageCommandId,
+    ChorusMessageCommandId,
+    AudioWorkletProcessorNames
 } from "./typings";

package/lib/src/typings.ts

@@ -1,79 +1,114 @@
-export type ChannelSpatialization = "mono" | "stereo" | "surround";
-
-export type AudioClipAnalyserType = "pre" | "post";
-export type AudioClipAnalyserProperty = "fftSize" | "minDecibels" | "maxDecibels" | "smoothingTimeConstant";
-
-export type AudioClipEvents  = {
-    [K in keyof AudioClipEventMap]: AudioClipEventMap[K][];
-}
-
-export interface FluexGLAudioDebuggerOptions {
-    breakOnError: boolean;
-    showInfo: boolean;
-    showErrors: boolean;
-    showWarnings: boolean;
-}
-
-export interface FluexGLAudioOptions {
-    maxMasterChannels: number;
-    maxTotalChannels: number;
-    sampleRate: number;
-    spatialization: ChannelSpatialization;
-    debugger: FluexGLAudioDebuggerOptions;
-}
-
-export interface FluexGLAudioDescriptor {
-    name: string;
-    author: string;
-    version: string;
-    license: string;
-    repository: string;
-    options: FluexGLAudioOptions;
-}
-
-export interface LoadAudioSourceOptions {
-    allowForeignFileTypes: boolean;
-}
-
-export interface AudioSourceData {
-    arrayBuffer: ArrayBuffer;
-    audioBuffer: AudioBuffer;
-    id: string;
-    timestamp: number;
-}
-
-export interface ChannelOptions {
-    label: string | null;
-    maxAudioNodes: number;
-    maxEffects: number;
-}
-
-export interface AudioClipOnProgressEvent {
-    startTime: number;
-    offset: number;
-    current: number;
-    contextTimestamp: number;
-    formatted: string;
-}
-
-export interface AudioClipEventMap {
-    "progress": (event: AudioClipOnProgressEvent) => void;
-}
-
-export interface DspPipelineInitializationOptions {
-    pathToWasm: string;
-    pathToWorklet: string;
-}
-
-export interface DspPipelineInitializationState {
-    success: boolean;
-    workletBlobUrl: string;
-}
-
-export interface ChorusEffectOptions {
-    baseDelayMs?: number;
-    depthMs?: number;
-    rateHz?: number;
-    mix?: number;
-    feedback?: number;  
+export type ChannelSpatialization = "mono" | "stereo" | "surround";
+
+export type AudioClipAnalyserType = "pre" | "post";
+export type AudioClipAnalyserProperty = "fftSize" | "minDecibels" | "maxDecibels" | "smoothingTimeConstant";
+
+export type AudioClipEvents  = {
+    [K in keyof AudioClipEventMap]: AudioClipEventMap[K][];
+}
+
+export enum LowPassFilterMessageCommandId {
+    SetCutoff,
+    SetMinFrequency
+}
+
+export enum ChorusMessageCommandId {
+    SetBaseDelayMs,
+    SetDepthMs,
+    SetRateHz,
+    SetMix,
+    SetFeedback
+}
+
+export enum AudioWorkletProcessorNames {
+    Compressor = "CompressorProcessor",
+    MultibandCompressor = "MultibandCompressorProcessor",
+    AdvancedDelay = "AdvancedDelayProcessor",
+    MonoDelay = "MonoDelayProcessor",
+    PingPongDelay = "PingPongDelayProcessor",
+    StereoDelay = "StereoDelayProcessor",
+    LowPassFilter = "LowPassFilterProcessor",
+    HighPassFilter = "HighPassFilterProcessor",
+    BandPassFilter = "BandPassFilterProcessor",
+    NotchFilter = "NotchFilterProcessor",
+    Chorus = "ChorusProcessor",
+    Flanger = "FlangerProcessor",
+    Phaser = "PhaserProcessor",
+    Reverb = "ReverbProcessor"
+}
+
+export interface FluexGLAudioDebuggerOptions {
+    breakOnError: boolean;
+    showInfo: boolean;
+    showErrors: boolean;
+    showWarnings: boolean;
+}
+
+export interface FluexGLAudioOptions {
+    maxMasterChannels: number;
+    maxTotalChannels: number;
+    sampleRate: number;
+    spatialization: ChannelSpatialization;
+    debugger: FluexGLAudioDebuggerOptions;
+}
+
+export interface FluexGLAudioDescriptor {
+    name: string;
+    author: string;
+    version: string;
+    license: string;
+    repository: string;
+    options: FluexGLAudioOptions;
+}
+
+export interface LoadAudioSourceOptions {
+    allowForeignFileTypes: boolean;
+}
+
+export interface AudioSourceData {
+    arrayBuffer: ArrayBuffer;
+    audioBuffer: AudioBuffer;
+    id: string;
+    timestamp: number;
+}
+
+export interface ChannelOptions {
+    label: string | null;
+    maxAudioNodes: number;
+    maxEffects: number;
+}
+
+export interface AudioClipOnProgressEvent {
+    startTime: number;
+    offset: number;
+    current: number;
+    contextTimestamp: number;
+    formatted: string;
+}
+
+export interface AudioClipEventMap {
+    "progress": (event: AudioClipOnProgressEvent) => void;
+}
+
+export interface DspPipelineInitializationOptions {
+    pathToWasm: string;
+    pathToWorklet: string;
+}
+
+export interface DspPipelineInitializationState {
+    success: boolean;
+    workletBlobUrl: string;
+}
+
+export interface ChorusEffectOptions {
+    baseDelayMs: number;
+    depthMs: number;
+    rateHz: number;
+    mix: number;
+    feedback: number;  
+}
+
+export interface LowPassFilterOptions {
+    cutoff?: number;
+    minFrequency?: number;
 }

package/lib/src/utilities/constants.ts

@@ -1,9 +1,9 @@
-export const SUPPORTED_FILE_TYPES: string[] = [
-    "audio/aac",
-    "audio/mp3",
-    "audio/mpeg",
-    "audio/ogg",
-    "audio/wav",
-    "audio/wave",
-    "audio/webm"
+export const SUPPORTED_FILE_TYPES: string[] = [
+    "audio/aac",
+    "audio/mp3",
+    "audio/mpeg",
+    "audio/ogg",
+    "audio/wav",
+    "audio/wave",
+    "audio/webm"
 ];