@fluex/fluexgl-dsp 0.4.6 → 0.4.8

package/lib/dist/utilities/helpers.js

@@ -12,29 +12,29 @@ import { ErrorCodes, WarningCodes } from "../console-codes";
  * FluexGL DSP cannot be used without calling this function first.
  * @returns
  */
-export async function InitializeDspPipeline(options) {
-    Debug.Log("Attempting to initialize DSP pipeline...");
+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.`);
+        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.", [
+        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 blobUrl = constructProcessorWorklet(textContent);
     const end = Date.now(), difference = end - start;
-    Debug.Success(`Succesfully initialized DSP pipeline within ${difference}ms.`);
+    Debug.success(`Succesfully initialized DSP pipeline within ${difference}ms.`);
     return {
         success: true,
         workletBlobUrl: blobUrl
@@ -44,7 +44,7 @@ export async function InitializeDspPipeline(options) {
  * Resolves a list of available audio output devices.
  * @returns
  */
-export async function ResolveAudioOutputDevices() {
+export async function resolveAudioOutputDevices() {
     const devices = await navigator.mediaDevices.enumerateDevices();
     const audioDevices = [];
     for (let device of devices)
@@ -55,7 +55,7 @@ export async function ResolveAudioOutputDevices() {
  * Resolves a list of available audio input devices.
  * @returns
  */
-export async function ResolveAudioInputDevices() {
+export async function resolveAudioInputDevices() {
     const devices = await navigator.mediaDevices.enumerateDevices();
     const audioDevices = [];
     for (let device of devices)
@@ -66,36 +66,36 @@ export async function ResolveAudioInputDevices() {
  * Resolves the default audio output device.
  * @returns
  */
-export async function ResolveDefaultAudioOutputDevice(init) {
-    Debug.Log("Attempting to resolve default audio output device...");
+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);
+    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;
 }
 /**
  * Resolves the default audio input device.
  * @returns
  */
-export async function ResolveDefaultAudioInputDevice(init) {
-    Debug.Log("Attempting to resolve default audio output device...");
+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);
+    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;
 }
 /**
@@ -104,19 +104,19 @@ export async function ResolveDefaultAudioInputDevice(init) {
  * @param options
  * @returns
  */
-export async function LoadAudioSource(path, options = { allowForeignFileTypes: false }) {
+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.", [
+        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.");
+        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;
@@ -133,7 +133,7 @@ export async function LoadAudioSource(path, options = { allowForeignFileTypes: f
 /**
  * Loads an audio file from a blob.
  */
-export async function LoadAudioSourceFromBlob(blob) {
+export async function loadAudioSourceFromBlob(blob) {
     const tempContext = new AudioContext(), arrayBuffer = await blob.arrayBuffer();
     const audioBuffer = await tempContext.decodeAudioData(arrayBuffer);
     return {
@@ -142,27 +142,27 @@ export async function LoadAudioSourceFromBlob(blob) {
         audioBuffer, arrayBuffer
     };
 }
-export function ConstructProcessorWorklet(code) {
+export function constructProcessorWorklet(code) {
     const blob = new Blob([code], {
         type: "application/javascript"
     });
     return URL.createObjectURL(blob);
 }
-export async function LoadWorkletOnAudioDevice(audioDevice, workletBlobUrl) {
-    Debug.Log("Loading worklet modules on master channel...", [`Channel ID: ${audioDevice.id}`]);
+export async function loadWorkletOnAudioDevice(audioDevice, workletBlobUrl) {
+    Debug.log("Loading worklet modules on master channel...", [`Channel ID: ${audioDevice.id}`]);
     const context = audioDevice.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.", [
+    Debug.success("Succesfully loaded audio processor worklets into master channel.", [
         `Executed in ${difference}ms.`,
     ]);
     return true;
 }
-export function SendMessageToWorklet(node, commandId, data) {
+export function sendMessageToWorklet(node, commandId, data) {
     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)}`
         ]);
@@ -171,39 +171,25 @@ export function SendMessageToWorklet(node, commandId, data) {
     node.port.postMessage({ commandId, data });
     return true;
 }
-export function IsFiniteNumber(value) {
+export function isFiniteNumber(value) {
     return typeof value === "number" && Number.isFinite(value);
 }
-export function CoerceFiniteNumber(value, fallback) {
-    return IsFiniteNumber(value) ? value : fallback;
+export function coerceFiniteNumber(value, fallback) {
+    return isFiniteNumber(value) ? value : fallback;
 }
-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}.`
-        ], 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(context, name, data) {
+    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/dist/utilities/web-assembly.js

@@ -8,7 +8,7 @@ export async function LoadWebAssemblyModule(path) {
             compiledWebAssemblyModule = module;
             resolve(module);
         }).catch(function (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/lib/src/console-codes.ts

@@ -19,7 +19,8 @@ export enum ErrorCodes {
     AUDIO_CLIP_ALREADY_ATTACHED = "ERROR:FLUEXGL-DSP@0018",
     AUDIO_CLIP_NOT_FOUND = "ERROR:FLUEXGL-DSP@0019",
     AUDIO_CLIP_PLAYER_NO_CONTEXT = "ERROR:FLUEXGL-DSP@0020",
-    PANNING_OUT_OF_RANGE = "ERROR:FLUEXGL-DSP@0021"
+    PANNING_OUT_OF_RANGE = "ERROR:FLUEXGL-DSP@0021",
+    PITCH_OUT_OF_RANGE = "ERROR:FLUEXGL-DSP@0022"
 }
 
 export enum WarningCodes {