@fluex/fluexgl-dsp 0.4.6 → 0.4.8

package/lib/src/utilities/helpers.ts

@@ -19,8 +19,8 @@ import { LoadAudioSourceOptions, AudioSourceData, DspPipelineInitializationOptio
  * FluexGL DSP cannot be used without calling this function first.
  * @returns 
  */
-export async function InitializeDspPipeline(options: DspPipelineInitializationOptions): Promise<DspPipelineInitializationState | null> {
-    Debug.Log("Attempting to initialize DSP pipeline...");
+export async function initializeDspPipeline(options: DspPipelineInitializationOptions): Promise<DspPipelineInitializationState | null> {
+    Debug.log("Attempting to initialize DSP pipeline...");
 
     const start: number = Date.now();
     let initialized: boolean = true;
@@ -29,7 +29,7 @@ export async function InitializeDspPipeline(options: DspPipelineInitializationOp
 
         const stream = await navigator.mediaDevices.getUserMedia({ audio: true });
 
-        Debug.Log(`Found ${stream.getTracks().length} media stream tracks.`);
+        Debug.log(`Found ${stream.getTracks().length} media stream tracks.`);
 
         stream.getTracks().forEach(function (track: MediaStreamTrack) {
             track.stop();
@@ -38,7 +38,7 @@ export async function InitializeDspPipeline(options: DspPipelineInitializationOp
 
         initialized = false;
 
-        Debug.Error("Permission to access media devices has not been granted.", [
+        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)
     }
@@ -48,12 +48,12 @@ export async function InitializeDspPipeline(options: DspPipelineInitializationOp
     const workletFileRequest = await fetch(options.pathToWorklet);
     const textContent: string = await workletFileRequest.text();
 
-    const blobUrl: string = ConstructProcessorWorklet(textContent);
+    const blobUrl: string = constructProcessorWorklet(textContent);
 
     const end: number = Date.now(),
         difference: number = end - start;
 
-    Debug.Success(`Succesfully initialized DSP pipeline within ${difference}ms.`);
+    Debug.success(`Succesfully initialized DSP pipeline within ${difference}ms.`);
 
     return {
         success: true,
@@ -65,7 +65,7 @@ export async function InitializeDspPipeline(options: DspPipelineInitializationOp
  * Resolves a list of available audio output devices.
  * @returns 
  */
-export async function ResolveAudioOutputDevices(): Promise<AudioDevice[]> {
+export async function resolveAudioOutputDevices(): Promise<AudioDevice[]> {
 
     const devices = await navigator.mediaDevices.enumerateDevices();
 
@@ -81,7 +81,7 @@ export async function ResolveAudioOutputDevices(): Promise<AudioDevice[]> {
  * Resolves a list of available audio input devices.
  * @returns 
  */
-export async function ResolveAudioInputDevices(): Promise<AudioDevice[]> {
+export async function resolveAudioInputDevices(): Promise<AudioDevice[]> {
 
     const devices = await navigator.mediaDevices.enumerateDevices();
 
@@ -97,8 +97,8 @@ export async function ResolveAudioInputDevices(): Promise<AudioDevice[]> {
  * Resolves the default audio output device.
  * @returns 
  */
-export async function ResolveDefaultAudioOutputDevice(init: DspPipelineInitializationState): Promise<AudioDevice | null> {
-    Debug.Log("Attempting to resolve default audio output device...");
+export async function resolveDefaultAudioOutputDevice(init: DspPipelineInitializationState): Promise<AudioDevice | null> {
+    Debug.log("Attempting to resolve default audio output device...");
 
     const audioDeviceInfos: MediaDeviceInfo[] = [];
     const devices = await navigator.mediaDevices.enumerateDevices();
@@ -107,13 +107,13 @@ export async function ResolveDefaultAudioOutputDevice(init: DspPipelineInitializ
         (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);
+    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 LoadWorkletOnAudioDevice(defaultAudioDevice, init.workletBlobUrl);
+    await loadWorkletOnAudioDevice(defaultAudioDevice, init.workletBlobUrl);
 
     return defaultAudioDevice;
 }
@@ -122,8 +122,8 @@ export async function ResolveDefaultAudioOutputDevice(init: DspPipelineInitializ
  * Resolves the default audio input device.
  * @returns 
  */
-export async function ResolveDefaultAudioInputDevice(init: DspPipelineInitializationState): Promise<AudioDevice | null> {
-    Debug.Log("Attempting to resolve default audio output device...");
+export async function resolveDefaultAudioInputDevice(init: DspPipelineInitializationState): Promise<AudioDevice | null> {
+    Debug.log("Attempting to resolve default audio output device...");
 
     const audioDeviceInfos: MediaDeviceInfo[] = [];
     const devices = await navigator.mediaDevices.enumerateDevices();
@@ -132,13 +132,13 @@ export async function ResolveDefaultAudioInputDevice(init: DspPipelineInitializa
         (device.kind === "audioinput" && device.deviceId == "default")
             && audioDeviceInfos.push(device);
 
-    devices.length === 0 && Debug.Warn("No default audio device found.", [], WarningCodes.NO_DEFAULT_AUDIO_DEVICE_FOUND);
+    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 LoadWorkletOnAudioDevice(defaultAudioDevice, init.workletBlobUrl);
+    await loadWorkletOnAudioDevice(defaultAudioDevice, init.workletBlobUrl);
 
     return defaultAudioDevice;
 }
@@ -149,25 +149,25 @@ export async function ResolveDefaultAudioInputDevice(init: DspPipelineInitializa
  * @param options 
  * @returns 
  */
-export async function LoadAudioSource(path: string, options: Partial<LoadAudioSourceOptions> = { allowForeignFileTypes: false }): Promise<AudioSourceData | null> {
+export async function loadAudioSource(path: string, options: Partial<LoadAudioSourceOptions> = { allowForeignFileTypes: false }): Promise<AudioSourceData | null> {
 
     const extension: string | null = mime.getType(path);
 
     if (!extension && !options.allowForeignFileTypes) {
 
-        Debug.Error("The file type of the specified file could not be identified.", [
+        Debug.error("The file type of the specified file could not be identified.", [
             `Set allowForeignFileTypes to true in the properties to allow foreign or unknown file types.`
         ], ErrorCodes.NO_FILE_TYPE_FOUND);
         return null;
     }
 
-    if (!SUPPORTED_FILE_TYPES.includes(extension as string)) Debug.Warn("The file type of the specified file is unknown and possibly unknown, but will be used anyways.");
+    if (!SUPPORTED_FILE_TYPES.includes(extension as string)) Debug.warn("The file type of the specified file is unknown and possibly unknown, but will be used anyways.");
 
     const file = await fetch(path, { method: "get" });
 
     if (file.status !== 200) {
 
-        Debug.Error("The specified file could not be loaded.", [
+        Debug.error("The specified file could not be loaded.", [
             `Received status code: ${file.status}.`
         ], ErrorCodes.PATH_TO_FILE_NOT_FOUND);
         return null;
@@ -190,7 +190,7 @@ export async function LoadAudioSource(path: string, options: Partial<LoadAudioSo
 /**
  * Loads an audio file from a blob.
  */
-export async function LoadAudioSourceFromBlob(blob: Blob): Promise<AudioSourceData | null> {
+export async function loadAudioSourceFromBlob(blob: Blob): Promise<AudioSourceData | null> {
 
     const tempContext: AudioContext = new AudioContext(),
         arrayBuffer: ArrayBuffer = await blob.arrayBuffer();
@@ -204,7 +204,7 @@ export async function LoadAudioSourceFromBlob(blob: Blob): Promise<AudioSourceDa
     };
 }
 
-export function ConstructProcessorWorklet(code: string): string {
+export function constructProcessorWorklet(code: string): string {
 
     const blob = new Blob([code], {
         type: "application/javascript"
@@ -213,8 +213,8 @@ export function ConstructProcessorWorklet(code: string): string {
     return URL.createObjectURL(blob);
 }
 
-export async function LoadWorkletOnAudioDevice(audioDevice: AudioDevice, workletBlobUrl: string) {
-    Debug.Log("Loading worklet modules on master channel...", [`Channel ID: ${audioDevice.id}`]);
+export async function loadWorkletOnAudioDevice(audioDevice: AudioDevice, workletBlobUrl: string) {
+    Debug.log("Loading worklet modules on master channel...", [`Channel ID: ${audioDevice.id}`]);
 
     const context: AudioContext = audioDevice.context,
         start: number = Date.now();
@@ -224,19 +224,19 @@ export async function LoadWorkletOnAudioDevice(audioDevice: AudioDevice, worklet
     const end: number = Date.now(),
         difference: number = end - start;
 
-    Debug.Success("Succesfully loaded audio processor worklets into master channel.", [
+    Debug.success("Succesfully loaded audio processor worklets into master channel.", [
         `Executed in ${difference}ms.`,
     ]);
 
     return true;
 }
 
-export function SendMessageToWorklet<T, K = any>(node: AudioWorkletNode | null, commandId: T, data: K) {
+export function sendMessageToWorklet<T, K = any>(node: AudioWorkletNode | null, commandId: T, data: K) {
 
     if (!node) return false;
 
     if (typeof data === "number" && !Number.isFinite(data)) {
-        Debug.Warn("Refusing to send non-finite numeric value to AudioWorkletNode.", [
+        Debug.warn("Refusing to send non-finite numeric value to AudioWorkletNode.", [
             `Command: ${String(commandId)}`,
             `Value: ${String(data)}`
         ]);
@@ -248,42 +248,29 @@ export function SendMessageToWorklet<T, K = any>(node: AudioWorkletNode | null,
     return true;
 }
 
-export function IsFiniteNumber(value: unknown): value is number {
+export function isFiniteNumber(value: unknown): value is number {
     return typeof value === "number" && Number.isFinite(value);
 }
 
-export function CoerceFiniteNumber(value: unknown, fallback: number): number {
-    return IsFiniteNumber(value) ? value : fallback;
+export function coerceFiniteNumber(value: unknown, fallback: number): number {
+    return isFiniteNumber(value) ? value : fallback;
 }
 
-export function CreateAudioWorkletNode<T = any>(context: AudioContext, name: AudioWorkletProcessorNames | string, data: T) {
-
-    if (!compiledWebAssemblyModule) {
-        Debug.Error("Failed to create audio worklet node, because the web assembly module has not been compiled properly.", [
-            `Request audio worklet node: ${name}.`
-        ], ErrorCodes.WORKLET_NO_WASM_MODULE_INSTANTIATED);
-        return null;
-    }
-
-    try {
-        return new AudioWorkletNode(context, name, {
-            numberOfInputs: 1,
-            numberOfOutputs: 1,
-            outputChannelCount: [2],
-            parameterData: {
-                ...data,
-                sampleRate: context.sampleRate
-            },
-            processorOptions: {
-                module: compiledWebAssemblyModule
-            }
-        });
-    } catch (err) {
-        Debug.Error("Failed to create audio worklet node.", [
-            `Request audio worklet node: ${name}.`,
-            "Make sure you called InitializeDspPipeline/InitializeDpsPipeline and loaded the worklet module on the same AudioContext.",
-            String(err)
-        ]);
-        return null;
-    }
+export function createAudioWorkletNode<T = any>(context: AudioContext, name: AudioWorkletProcessorNames | string, data: T): AudioWorkletNode {
+
+    if (!compiledWebAssemblyModule)
+        throw new Error("Coult not create audio worklet node. WebAssembly has not been compiled yet.")
+
+    return new AudioWorkletNode(context, name, {
+        numberOfInputs: 1,
+        numberOfOutputs: 1,
+        outputChannelCount: [2],
+        parameterData: {
+            ...data,
+            sampleRate: context.sampleRate
+        },
+        processorOptions: {
+            module: compiledWebAssemblyModule
+        }
+    });
 }

package/lib/src/utilities/web-assembly.ts

@@ -11,7 +11,7 @@ export async function LoadWebAssemblyModule(path: string): Promise<WebAssembly.M
             resolve(module);
         }).catch(function (error: Error) {
             
-            Debug.Error("Failed to load WebAssembly module from path: " + path, [
+            Debug.error("Failed to load WebAssembly module from path: " + path, [
                 "Make sure the path is correct and the server is serving the .wasm file with the correct MIME type (application/wasm).",
                 "Error details: " + error.message
             ], ErrorCodes.WASM_COMPILATION_ERROR);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fluex/fluexgl-dsp",
-    "version": "0.4.6",
+    "version": "0.4.8",
     "description": "An open-source, web-based DSP library developed alongside FluexGL, designed for creating and manipulating sounds in various contexts.",
     "main": "lib/dist/index.js",
     "types": "lib/dist/index.d.ts",
@@ -31,6 +31,7 @@
         "mime": "^4.1.0",
         "terser": "^5.44.0",
         "truncate": "^3.0.0",
+        "typescript": "^7.0.2",
         "uuid": "^13.0.0"
     },
     "devDependencies": {
@@ -49,4 +50,4 @@
         "url": "https://github.com/rohankanhaisingh/FluexGL-DSP/issues"
     },
     "homepage": "https://github.com/rohankanhaisingh/FluexGL-DSP#readme"
-}
+}

package/lib/src/effects/classes/reverbs/ChamberReverb.ts

@@ -1 +0,0 @@
-export class ChamberReverb {}

package/lib/src/effects/classes/reverbs/ConvolverReverb.ts

@@ -1 +0,0 @@
-export class ConvolverReverb {}

package/lib/src/effects/classes/reverbs/GenericReverb.ts

@@ -1 +0,0 @@
-export class GenericReverb {}

package/lib/src/effects/classes/reverbs/HallReverb.ts

@@ -1 +0,0 @@
-export class HallReverb {}

package/lib/src/effects/classes/reverbs/RoomReverb.ts

@@ -1 +0,0 @@
-export class RoomReverb {}