@fluex/fluexgl-dsp 0.1.3 → 0.2.2

package/lib/dist/utilities/helpers.js

@@ -1,143 +1,186 @@
-import mime from "mime";
-import { v4 } from "uuid";
-import { AudioDevice } from "../core/classes/AudioDevice";
-import { Debug } from "./debugger";
-import { SUPPORTED_FILE_TYPES } from "./constants";
-import { LoadWebAssemblyModule } from "./web-assembly";
-import { ErrorCodes, WarningCodes } from "../console-codes";
-/**
- * Initializes the DSP pipeline by requesting audio permissions and initializing the WASM module.
- * Very important to call this function and wait for it to complete before using any audio features.
- *
- * FluexGL DSP cannot be used without calling this function first.
- * @returns
- */
-export async function InitializeDspPipeline(options) {
-    Debug.Log("Attempting to initialize DSP pipeline...");
-    const start = Date.now();
-    let initialized = true;
-    try {
-        const stream = await navigator.mediaDevices.getUserMedia({ audio: true });
-        Debug.Log(`Found ${stream.getTracks().length} media stream tracks.`);
-        stream.getTracks().forEach(function (track) {
-            track.stop();
-        });
-    }
-    catch (err) {
-        initialized = false;
-        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);
-    }
-    await LoadWebAssemblyModule(options.pathToWasm);
-    const workletFileRequest = await fetch(options.pathToWorklet);
-    const textContent = await workletFileRequest.text();
-    const blobUrl = ConstructProcessorWorklet(textContent);
-    const end = Date.now(), difference = end - start;
-    Debug.Success(`Succesfully initialized DSP pipeline within ${difference}ms.`);
-    return {
-        success: true,
-        workletBlobUrl: blobUrl
-    };
-}
-/**
- * Resolves a list of available audio output devices.
- * @returns
- */
-export async function ResolveAudioOutputDevices() {
-    const devices = await navigator.mediaDevices.enumerateDevices();
-    const audioDevices = [];
-    for (let device of devices)
-        device.kind === "audiooutput" && audioDevices.push(new AudioDevice(device));
-    return audioDevices;
-}
-/**
- * Resolves a list of available audio input devices.
- * @returns
- */
-export async function ResolveAudioInputDevices() {
-    const devices = await navigator.mediaDevices.enumerateDevices();
-    const audioDevices = [];
-    for (let device of devices)
-        device.kind === "audioinput" && audioDevices.push(new AudioDevice(device));
-    return audioDevices;
-}
-/**
- * Resolves the default audio output device.
- * @returns
- */
-export async function ResolveDefaultAudioOutputDevice(init) {
-    Debug.Log("Attempting to resolve default audio output device...");
-    const audioDeviceInfos = [];
-    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, init.workletBlobUrl);
-    return defaultAudioDevice;
-}
-/**
- * Resolves the default audio input device.
- * @returns
- */
-export async function ResolveDefaultAudioInputDevice() {
-    const audioDeviceInfos = [];
-    const devices = await navigator.mediaDevices.enumerateDevices();
-    for (let device of devices)
-        (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);
-    return devices.length === 0 ? null : new AudioDevice(audioDeviceInfos[0]);
-}
-/**
- * Loads an audio source from a specified path.
- * @param path
- * @param options
- * @returns
- */
-export async function LoadAudioSource(path, options = { allowForeignFileTypes: false }) {
-    const extension = mime.getType(path);
-    if (!extension && !options.allowForeignFileTypes) {
-        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))
-        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.", [
-            `Received status code: ${file.status}.`
-        ], ErrorCodes.PATH_TO_FILE_NOT_FOUND);
-        return null;
-    }
-    const tempContext = new AudioContext(), arrayBuffer = await file.arrayBuffer(), audioBuffer = await tempContext.decodeAudioData(arrayBuffer);
-    // IMPORTANT!
-    tempContext.close();
-    return {
-        arrayBuffer, audioBuffer,
-        id: v4(),
-        timestamp: Date.now()
-    };
-}
-export function ConstructProcessorWorklet(code) {
-    const blob = new Blob([code], {
-        type: "application/javascript"
-    });
-    return URL.createObjectURL(blob);
-}
-export async function LoadWorkletOnMasterChannel(master, workletBlobUrl) {
-    Debug.Log("Loading worklet modules on master channel...", [`Channel ID: ${master.id}`]);
-    const context = master.context, start = Date.now();
-    await context.audioWorklet.addModule(workletBlobUrl);
-    const end = Date.now(), difference = end - start;
-    Debug.Success("Succesfully loaded audio processor worklets into master channel.", [
-        `Executed in ${difference}ms.`,
-    ]);
-    return true;
-}
+import mime from "mime";
+import { v4 } from "uuid";
+import { AudioDevice } from "../core/classes/AudioDevice";
+import { Debug } from "./debugger";
+import { SUPPORTED_FILE_TYPES } from "./constants";
+import { compiledWebAssemblyModule, LoadWebAssemblyModule } from "./web-assembly";
+import { ErrorCodes, WarningCodes } from "../console-codes";
+/**
+ * Initializes the DSP pipeline by requesting audio permissions and initializing the WASM module.
+ * Very important to call this function and wait for it to complete before using any audio features.
+ *
+ * FluexGL DSP cannot be used without calling this function first.
+ * @returns
+ */
+export async function InitializeDspPipeline(options) {
+    Debug.Log("Attempting to initialize DSP pipeline...");
+    const start = Date.now();
+    let initialized = true;
+    try {
+        const stream = await navigator.mediaDevices.getUserMedia({ audio: true });
+        Debug.Log(`Found ${stream.getTracks().length} media stream tracks.`);
+        stream.getTracks().forEach(function (track) {
+            track.stop();
+        });
+    }
+    catch (err) {
+        initialized = false;
+        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);
+    }
+    await LoadWebAssemblyModule(options.pathToWasm);
+    const workletFileRequest = await fetch(options.pathToWorklet);
+    const textContent = await workletFileRequest.text();
+    const blobUrl = ConstructProcessorWorklet(textContent);
+    const end = Date.now(), difference = end - start;
+    Debug.Success(`Succesfully initialized DSP pipeline within ${difference}ms.`);
+    return {
+        success: true,
+        workletBlobUrl: blobUrl
+    };
+}
+/**
+ * Resolves a list of available audio output devices.
+ * @returns
+ */
+export async function ResolveAudioOutputDevices() {
+    const devices = await navigator.mediaDevices.enumerateDevices();
+    const audioDevices = [];
+    for (let device of devices)
+        device.kind === "audiooutput" && audioDevices.push(new AudioDevice(device));
+    return audioDevices;
+}
+/**
+ * Resolves a list of available audio input devices.
+ * @returns
+ */
+export async function ResolveAudioInputDevices() {
+    const devices = await navigator.mediaDevices.enumerateDevices();
+    const audioDevices = [];
+    for (let device of devices)
+        device.kind === "audioinput" && audioDevices.push(new AudioDevice(device));
+    return audioDevices;
+}
+/**
+ * Resolves the default audio output device.
+ * @returns
+ */
+export async function ResolveDefaultAudioOutputDevice(init) {
+    Debug.Log("Attempting to resolve default audio output device...");
+    const audioDeviceInfos = [];
+    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, init.workletBlobUrl);
+    return defaultAudioDevice;
+}
+/**
+ * Resolves the default audio input device.
+ * @returns
+ */
+export async function ResolveDefaultAudioInputDevice(init) {
+    Debug.Log("Attempting to resolve default audio output device...");
+    const audioDeviceInfos = [];
+    const devices = await navigator.mediaDevices.enumerateDevices();
+    for (let device of devices)
+        (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);
+    const defaultAudioDevice = devices.length === 0 ? null : new AudioDevice(audioDeviceInfos[0]);
+    if (!defaultAudioDevice)
+        return null;
+    await LoadWorkletOnMasterChannel(defaultAudioDevice.masterChannel, init.workletBlobUrl);
+    return defaultAudioDevice;
+}
+/**
+ * Loads an audio source from a specified path.
+ * @param path
+ * @param options
+ * @returns
+ */
+export async function LoadAudioSource(path, options = { allowForeignFileTypes: false }) {
+    const extension = mime.getType(path);
+    if (!extension && !options.allowForeignFileTypes) {
+        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))
+        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.", [
+            `Received status code: ${file.status}.`
+        ], ErrorCodes.PATH_TO_FILE_NOT_FOUND);
+        return null;
+    }
+    const tempContext = new AudioContext(), arrayBuffer = await file.arrayBuffer(), audioBuffer = await tempContext.decodeAudioData(arrayBuffer);
+    // IMPORTANT!
+    tempContext.close();
+    return {
+        arrayBuffer, audioBuffer,
+        id: v4(),
+        timestamp: Date.now()
+    };
+}
+/**
+ * Loads an audio file from a blob.
+ */
+export async function LoadAudioSourceFromBlob(blob) {
+    const tempContext = new AudioContext(), arrayBuffer = await blob.arrayBuffer();
+    const audioBuffer = await tempContext.decodeAudioData(arrayBuffer);
+    return {
+        id: v4(),
+        timestamp: Date.now(),
+        audioBuffer, arrayBuffer
+    };
+}
+export function ConstructProcessorWorklet(code) {
+    const blob = new Blob([code], {
+        type: "application/javascript"
+    });
+    return URL.createObjectURL(blob);
+}
+export async function LoadWorkletOnMasterChannel(master, workletBlobUrl) {
+    Debug.Log("Loading worklet modules on master channel...", [`Channel ID: ${master.id}`]);
+    const context = master.context, start = Date.now();
+    await context.audioWorklet.addModule(workletBlobUrl);
+    const end = Date.now(), difference = end - start;
+    Debug.Success("Succesfully loaded audio processor worklets into master channel.", [
+        `Executed in ${difference}ms.`,
+    ]);
+    return true;
+}
+export function SendMessageToWorklet(node, commandId, data) {
+    if (!node)
+        return false;
+    node.port.postMessage({ commandId, data });
+    return true;
+}
+export function CreateAudioWorkletNode(context, name, data) {
+    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}.`
+        ]);
+        return null;
+    }
+    return new AudioWorkletNode(context, name, {
+        numberOfInputs: 1,
+        numberOfOutputs: 1,
+        outputChannelCount: [2],
+        parameterData: {
+            ...data,
+            sampleRate: context.sampleRate
+        },
+        processorOptions: {
+            module: compiledWebAssemblyModule
+        }
+    });
+}

package/lib/dist/utilities/web-assembly.d.ts

@@ -1,4 +1,4 @@
-export declare let hasInitializedWasm: boolean;
-export declare let compiledWebAssemblyModule: WebAssembly.Module | null;
-export declare function LoadWebAssemblyModule(path: string): Promise<WebAssembly.Module>;
+export declare let hasInitializedWasm: boolean;
+export declare let compiledWebAssemblyModule: WebAssembly.Module | null;
+export declare function LoadWebAssemblyModule(path: string): Promise<WebAssembly.Module>;
 //# sourceMappingURL=web-assembly.d.ts.map

package/lib/dist/utilities/web-assembly.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"web-assembly.d.ts","sourceRoot":"","sources":["../../src/utilities/web-assembly.ts"],"names":[],"mappings":"AAAA,eAAO,IAAI,kBAAkB,EAAE,OAAe,CAAC;AAC/C,eAAO,IAAI,yBAAyB,EAAE,WAAW,CAAC,MAAM,GAAG,IAAW,CAAC;AAEvE,wBAAsB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAUrF"}
+{"version":3,"file":"web-assembly.d.ts","sourceRoot":"","sources":["../../src/utilities/web-assembly.ts"],"names":[],"mappings":"AAAA,eAAO,IAAI,kBAAkB,EAAE,OAAe,CAAC;AAC/C,eAAO,IAAI,yBAAyB,EAAE,WAAW,CAAC,MAAM,GAAG,IAAW,CAAC;AAEvE,wBAAsB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CASrF"}

package/lib/dist/utilities/web-assembly.js

@@ -1,12 +1,12 @@
-export let hasInitializedWasm = false;
-export let compiledWebAssemblyModule = null;
-export async function LoadWebAssemblyModule(path) {
-    return new Promise(function (resolve, reject) {
-        WebAssembly.compileStreaming(fetch(path)).then(function (module) {
-            compiledWebAssemblyModule = module;
-            resolve(module);
-        }).catch(function (error) {
-            reject(error);
-        });
-    });
-}
+export let hasInitializedWasm = false;
+export let compiledWebAssemblyModule = null;
+export async function LoadWebAssemblyModule(path) {
+    return new Promise(function (resolve, reject) {
+        WebAssembly.compileStreaming(fetch(path)).then(function (module) {
+            compiledWebAssemblyModule = module;
+            resolve(module);
+        }).catch(function (error) {
+            reject(error);
+        });
+    });
+}

package/lib/src/console-codes.ts

@@ -1,16 +1,16 @@
-export enum ErrorCodes {
-    NO_CONTEXT_PERMISSION = "FLUEXGL@AUDIO_ERROR_0001",
-    NO_FILE_TYPE_FOUND = "FLUEXGL@AUDIO_ERROR_0002",
-    PATH_TO_FILE_NOT_FOUND = "FLUEXGL@AUDIO_ERROR_0003",
-    SAME_MASTER_CHANNEL = "FLUEXGL@AUDIO_ERROR_0004",
-    WASM_MODULE_INITIALIZATION_FAILED = "FLUEXGL@AUDIO_ERROR_0005",
-    PATH_TO_WASM_FILE_NOT_FOUND = "FLUEXGL@AUDIO_ERROR_0006"
-}
-
-export enum WarningCodes {
-    NO_DEFAULT_AUDIO_DEVICE_FOUND = "FLUEXGL@AUDIO_WARNING_0001"
-}
-
-export enum SuccessCodes {
-
+export enum ErrorCodes {
+    NO_CONTEXT_PERMISSION = "FLUEXGL@AUDIO_ERROR_0001",
+    NO_FILE_TYPE_FOUND = "FLUEXGL@AUDIO_ERROR_0002",
+    PATH_TO_FILE_NOT_FOUND = "FLUEXGL@AUDIO_ERROR_0003",
+    SAME_MASTER_CHANNEL = "FLUEXGL@AUDIO_ERROR_0004",
+    WASM_MODULE_INITIALIZATION_FAILED = "FLUEXGL@AUDIO_ERROR_0005",
+    PATH_TO_WASM_FILE_NOT_FOUND = "FLUEXGL@AUDIO_ERROR_0006"
+}
+
+export enum WarningCodes {
+    NO_DEFAULT_AUDIO_DEVICE_FOUND = "FLUEXGL@AUDIO_WARNING_0001"
+}
+
+export enum SuccessCodes {
+
 }