node-web-audio-api 0.21.4 → 1.0.0-beta.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## v0.21.5 (23/12/2024)
+
+- Fix: Use module import for `AudioWorklet#addModule`
+- Feat: Resolve `AudioWorkletNode` when installed in `node_modules`
+- Ensure support of `AudioWorkletNode` that use Web Assembly
+
 ## v0.21.4 (16/12/2024)
 
 - Update upstream crate to [v1.1.0](https://github.com/orottier/web-audio-api-rs/blob/main/CHANGELOG.md#version-110-2024-12-11)

package/Cross.toml

@@ -0,0 +1,17 @@
+[target.aarch64-unknown-linux-gnu]
+pre-build = [
+  "dpkg --add-architecture $CROSS_DEB_ARCH",
+  "apt-get update && apt-get --assume-yes install libasound2-dev:$CROSS_DEB_ARCH libjack-jackd2-dev:$CROSS_DEB_ARCH"
+]
+
+[target.armv7-unknown-linux-gnueabihf]
+pre-build = [
+  "dpkg --add-architecture $CROSS_DEB_ARCH",
+  "apt-get update && apt-get --assume-yes install libasound2-dev:$CROSS_DEB_ARCH libjack-jackd2-dev:$CROSS_DEB_ARCH"
+]
+
+[target.x86_64-unknown-linux-gnu]
+pre-build = [
+  "dpkg --add-architecture $CROSS_DEB_ARCH",
+  "apt-get update && apt-get --assume-yes install libasound2-dev:$CROSS_DEB_ARCH libjack-jackd2-dev:$CROSS_DEB_ARCH"
+]

package/all-checks.sh

@@ -7,9 +7,9 @@ echo "-----------------------------------------------"
 cargo fmt -- --check --color always
 
 echo "-----------------------------------------------"
-echo "> cargo clippy --all-targets --features cpal -- -D warnings"
+echo "> cargo clippy --all-targets -- -D warnings"
 echo "-----------------------------------------------"
-cargo clippy --all-targets --features cpal -- -D warnings
+cargo clippy --all-targets -- -D warnings
 
 echo "-----------------------------------------------"
 echo "> Run js tests"

package/js/AudioRenderCapacity.js

@@ -5,6 +5,7 @@ const {
   kOnUpdate,
 } = require('./lib/symbols.js');
 const {
+  isFunction,
   kEnumerableProperty,
 } = require('./lib/utils.js');
 const {
@@ -70,7 +71,7 @@ class AudioRenderCapacity extends EventTarget {
       }
 
       targetOptions.updateInterval = conversions['double'](options.updateInterval, {
-        context: `Failed to execute 'start' on 'AudioRenderCapacity': Failed to read the 'updateInterval' property on 'AudioRenderCapacityOptions': The provided value ()`
+        context: `Failed to execute 'start' on 'AudioRenderCapacity': Failed to read the 'updateInterval' property on 'AudioRenderCapacityOptions': The provided value ()`,
       });
     } else {
       targetOptions.updateInterval = 1;
@@ -108,7 +109,7 @@ Object.defineProperties(AudioRenderCapacity.prototype, {
   },
 
   onupdate: kEnumerableProperty,
-  stop: kEnumerableProperty,
+  start: kEnumerableProperty,
   stop: kEnumerableProperty,
 });
 

package/js/AudioWorklet.js

@@ -1,8 +1,9 @@
 const {
-  resolveObjectURL
+  resolveObjectURL,
 } = require('node:buffer');
-const fs = require('node:fs').promises;
-const { existsSync } = require('node:fs');
+const {
+  existsSync,
+} = require('node:fs');
 const path = require('node:path');
 const {
   Worker,
@@ -23,85 +24,76 @@ const {
 
 const caller = require('caller');
 // cf. https://www.npmjs.com/package/node-fetch#commonjs
-const fetch = (...args) => import('node-fetch').then(({default: fetch}) => fetch(...args));
+const fetch = (...args) => import('node-fetch').then(({ default: fetch }) => fetch(...args));
 
 /**
  * Retrieve code with different module resolution strategies
  * - file - absolute or relative to cwd path
- * - URL
- * - Blob
+ *
+ * - URL - do not support import within module
+ * - Blob - do not support import within module
  * - fallback: relative to caller site
- *   + in fs
+ *   + in fs - support import within module
  *   + caller site is url - required for wpt, probably no other use case
  */
 const resolveModule = async (moduleUrl) => {
-  let code;
+  let code = null;
+  let absPathname = null;
 
   if (existsSync(moduleUrl)) {
-    const pathname = moduleUrl;
-
-    try {
-      const buffer = await fs.readFile(pathname);
-      code = buffer.toString();
-    } catch (err) {
-      throw new Error(`Failed to execute 'addModule' on 'AudioWorklet': ${err.message}`);
+    if (path.isAbsolute(moduleUrl)) {
+      absPathname = moduleUrl;
+    } else { // moduleUrl is relative to process.cwd();
+      absPathname = path.join(process.cwd(), moduleUrl);
     }
   } else if (moduleUrl.startsWith('http')) {
     try {
-        const res = await fetch(moduleUrl);
-        code = await res.text();
-      } catch (err) {
-        throw new Error(`Failed to execute 'addModule' on 'AudioWorklet': ${err.message}`);
-      }
+      const res = await fetch(moduleUrl);
+      code = await res.text();
+    } catch (err) {
+      throw new DOMException(`Failed to execute 'addModule' on 'AudioWorklet': ${err.message}`, 'AbortError');
+    }
   } else if (moduleUrl.startsWith('blob:')) {
     try {
       const blob = resolveObjectURL(moduleUrl);
       code = await blob.text();
     } catch (err) {
-      throw new Error(`Failed to execute 'addModule' on 'AudioWorklet': ${err.message}`);
+      throw new DOMException(`Failed to execute 'addModule' on 'AudioWorklet': ${err.message}`, 'AbortError');
     }
   } else {
-    // get caller site from error stack trace
     const callerSite = caller(2);
 
     if (callerSite.startsWith('http')) { // this branch exists for wpt where caller site is an url
-      let url;
-      // handle origin relative and caller path relative URLs
-      if (moduleUrl.startsWith('/')) {
-        const origin = new URL(baseUrl).origin;
-        url = origin + moduleUrl;
-      } else {
-        // we know separators are '/'
-        const baseUrl = callerSite.substr(0, callerSite.lastIndexOf('/'));
-        url = baseUrl + '/' + moduleUrl;
-      }
+      const baseUrl = callerSite.substring(0, callerSite.lastIndexOf('/'));
+      const url = baseUrl + '/' + moduleUrl;
 
       try {
         const res = await fetch(url);
         code = await res.text();
       } catch (err) {
-        throw new Error(`Failed to execute 'addModule' on 'AudioWorklet': ${err.message}`);
+        throw new DOMException(`Failed to execute 'addModule' on 'AudioWorklet': ${err.message}`, 'AbortError');
       }
     } else {
-      const dirname = callerSite.substr(0, callerSite.lastIndexOf(path.sep));
+      // filesystem, relative to caller site or in node_modules
+      const dirname = callerSite.substring(0, callerSite.lastIndexOf(path.sep));
       const absDirname = dirname.replace('file://', '');
       const pathname = path.join(absDirname, moduleUrl);
 
-      if (existsSync(pathname)) {
+      if (existsSync(pathname)) { // relative to caller site
+        absPathname = pathname;
+      } else {
         try {
-          const buffer = await fs.readFile(pathname);
-          code = buffer.toString();
+          // try resolve according to process.cwd()
+          absPathname = require.resolve(moduleUrl, { paths: [process.cwd()] });
         } catch (err) {
-          throw new Error(`Failed to execute 'addModule' on 'AudioWorklet': ${err.message}`);
+          throw new DOMException(`Failed to execute 'addModule' on 'AudioWorklet': Cannot resolve module ${moduleUrl}`, 'AbortError');
         }
-      } else {
-        throw new Error(`Failed to execute 'addModule' on 'AudioWorklet': Cannot resolve module ${moduleUrl}`);
       }
     }
   }
 
-  return code;
-}
+  return { absPathname, code };
+};
 
 class AudioWorklet {
   #workletId = null;
@@ -125,6 +117,9 @@ class AudioWorklet {
   }
 
   #bindEvents() {
+    // @todo
+    // - better error handling, stack trace, etc.
+    // - handle 'node-web-audio-api:worklet:ctor-error' message
     this.#port.on('message', event => {
       switch (event.cmd) {
         case 'node-web-audio-api:worklet:module-added': {
@@ -135,10 +130,9 @@ class AudioWorklet {
           break;
         }
         case 'node-web-audio-api:worklet:add-module-failed': {
-          const { promiseId, ctor, name, message } = event;
+          const { promiseId, err } = event;
           const { reject } = this.#idPromiseMap.get(promiseId);
           this.#idPromiseMap.delete(promiseId);
-          const err = new globalThis[ctor](message, name);
           reject(err);
           break;
         }
@@ -161,7 +155,9 @@ class AudioWorklet {
   }
 
   async addModule(moduleUrl) {
-    const code = await resolveModule(moduleUrl);
+    // @important - `resolveModule` must be called first because it uses `caller`
+    // which will return `null` if this is not in the first line...
+    const resolved = await resolveModule(moduleUrl);
 
     // launch Worker if not exists
     if (!this.#port) {
@@ -187,7 +183,8 @@ class AudioWorklet {
 
       this.#port.postMessage({
         cmd: 'node-web-audio-api:worklet:add-module',
-        code,
+        moduleUrl: resolved.absPathname,
+        code: resolved.code,
         promiseId,
       });
     });
@@ -196,6 +193,7 @@ class AudioWorklet {
   // For OfflineAudioContext only, check that all processors have been properly
   // created before actual `startRendering`
   async [kCheckProcessorsCreated]() {
+    //  eslint-disable-next-line no-async-promise-executor
     return new Promise(async resolve => {
       while (this.#pendingCreateProcessors.size !== 0) {
         // we need a microtask to ensure message can be received

package/js/AudioWorkletGlobalScope.js

@@ -87,7 +87,7 @@ globalThis[kWorkletRecycleBuffer1] = buffer => pool1.recycle(buffer);
 globalThis[kWorkletMarkAsUntransferable] = obj => {
   markAsUntransferable(obj);
   return obj;
-}
+};
 
 function isIterable(obj) {
   // checks for null and undefined
@@ -114,7 +114,7 @@ function runLoop() {
   runLoopImmediateId = setImmediate(runLoop);
 }
 
-globalThis.currentTime = 0
+globalThis.currentTime = 0;
 globalThis.currentFrame = 0;
 globalThis.sampleRate = sampleRate;
 // @todo - implement in upstream crate
@@ -153,7 +153,7 @@ globalThis.AudioWorkletProcessor = class AudioWorkletProcessor {
       this[kWorkletParamsCache][desc.name] = [
         pool128.get(), // should be globalThis.renderQuantumSize
         pool1.get(),
-      ]
+      ];
     });
 
     this.#port = port;
@@ -170,7 +170,7 @@ globalThis.AudioWorkletProcessor = class AudioWorkletProcessor {
   [kWorkletQueueTask](cmd, err) {
     this.#port.postMessage({ cmd, err });
   }
-}
+};
 
 // follow algorithm from:
 // https://webaudio.github.io/web-audio-api/#dom-audioworkletglobalscope-registerprocessor
@@ -298,12 +298,8 @@ globalThis.registerProcessor = function registerProcessor(name, processorCtor) {
 //   process.stdout.write('closing worklet');
 // });
 
-parentPort.on('message', event => {
+parentPort.on('message', async event => {
   switch (event.cmd) {
-    case 'node-web-audio-api:worklet:init': {
-      const { workletId, processors, promiseId } = event;
-      break;
-    }
     case 'node-web-audio-api:worklet:exit': {
       clearImmediate(runLoopImmediateId);
       // properly exit audio worklet on rust side
@@ -313,11 +309,18 @@ parentPort.on('message', event => {
       break;
     }
     case 'node-web-audio-api:worklet:add-module': {
-      const { code, promiseId } = event;
-      const func = new Function('AudioWorkletProcessor', 'registerProcessor', code);
+      const { moduleUrl, code, promiseId } = event;
 
       try {
-        func(AudioWorkletProcessor, registerProcessor);
+        // 1. If given module is a "real" file, we can import it as is,
+        // 2. If module is a blob or loaded from an URL, we use the raw text as
+        //    input. In this case, if the module uses `import` it will crash
+        if (moduleUrl !== null) {
+          await import(moduleUrl);
+        } else {
+          await import(`data:text/javascript;base64,${btoa(unescape(encodeURIComponent(code)))}`);
+        }
+
         // send registered param descriptors on main thread and resolve Promise
         parentPort.postMessage({
           cmd: 'node-web-audio-api:worklet:module-added',
@@ -327,9 +330,7 @@ parentPort.on('message', event => {
         parentPort.postMessage({
           cmd: 'node-web-audio-api:worklet:add-module-failed',
           promiseId,
-          ctor: err.constructor.name,
-          name: err.name,
-          message: err.message,
+          err,
         });
       }
       break;
@@ -338,7 +339,7 @@ parentPort.on('message', event => {
       const { name, id, options, port } = event;
       const ctor = nameProcessorCtorMap.get(name);
 
-      // rewrap options of interest for the AudioWorkletNodeBaseClass
+      // re-wrap options of interest for the AudioWorkletNodeBaseClass
       pendingProcessorConstructionData = {
         port,
         numberOfInputs: options.numberOfInputs,
@@ -352,6 +353,7 @@ parentPort.on('message', event => {
         instance = new ctor(options);
       } catch (err) {
         port.postMessage({ cmd: 'node-web-audio-api:worklet:ctor-error', err });
+        return;
       }
 
       pendingProcessorConstructionData = null;

package/js/AudioWorkletNode.js

@@ -156,7 +156,7 @@ module.exports = (jsExport, nativeBinding) => {
         // if we delegate this check to Rust, this can poison a Mutex
         // (probably the `audio_param_descriptor_channel` one)
         if (parsedOptions.channelCount <= 0 || parsedOptions.channelCount > IMPLEMENTATION_MAX_NUMBER_OF_CHANNELS) {
-          throw new DOMException(`Failed to construct 'AudioWorkletNode': Invalid 'channelCount' property: Number of channels: ${parsedOptions.channelCount} is outside range [1, 32]`, 'NotSupportedError')
+          throw new DOMException(`Failed to construct 'AudioWorkletNode': Invalid 'channelCount' property: Number of channels: ${parsedOptions.channelCount} is outside range [1, 32]`, 'NotSupportedError');
         }
       }
 
@@ -222,7 +222,8 @@ module.exports = (jsExport, nativeBinding) => {
       );
 
       this.#port.on('message', msg => {
-        // ErrorEvent named processorerror
+        // Handle 'processorerror' ErrorEvent
+        // cf. https://webaudio.github.io/web-audio-api/#dom-audioworkletnode-onprocessorerror
         switch (msg.cmd) {
           case 'node-web-audio-api:worklet:ctor-error': {
             const message = `Failed to construct '${parsedName}' AudioWorkletProcessor: ${msg.err.message}`;

package/js/OfflineAudioContext.js

@@ -138,10 +138,12 @@ module.exports = function patchOfflineAudioContext(jsExport, nativeBinding) {
       // ensure all AudioWorkletProcessor have finished their instanciation
       await this.audioWorklet[kCheckProcessorsCreated]();
 
-      let nativeAudioBuffer;
+      // keep this to highlight the workaround w/ the oncomplete event
+      let _nativeAudioBuffer;
 
       try {
-        nativeAudioBuffer = await this[kNapiObj].startRendering();
+        // eslint-disable-next-line no-unused-vars
+        _nativeAudioBuffer = await this[kNapiObj].startRendering();
       } catch (err) {
         throwSanitizedError(err);
       }

package/load-native.cjs

@@ -1,3 +1,4 @@
+const fs = require('node:fs');
 const { platform, arch } = process;
 
 let nativeBinding = null;
@@ -21,7 +22,7 @@ switch (platform) {
         }
         break;
       default:
-        throw new Error(`Unsupported architecture on Windows: ${arch}`);
+        loadError = new Error(`Unsupported architecture on Windows: ${arch}`);
     }
     break;
   case 'darwin':
@@ -41,11 +42,15 @@ switch (platform) {
         }
         break;
       default:
-        throw new Error(`Unsupported architecture on macOS: ${arch}`);
+        loadError = new Error(`Unsupported architecture on macOS: ${arch}`);
     }
     break;
+  //   case 'freebsd': x64 only
   case 'linux':
     switch (arch) {
+      // @todo
+      // - support riscv64 arch
+      // - support musl C lib
       case 'x64':
         try {
           nativeBinding = require('./node-web-audio-api.linux-x64-gnu.node');
@@ -68,11 +73,20 @@ switch (platform) {
         }
         break;
       default:
-        throw new Error(`Unsupported architecture on Linux: ${arch}`);
+        loadError = new Error(`Unsupported architecture on Linux: ${arch}`);
     }
     break;
   default:
-    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`);
+    loadError = new Error(`Unsupported OS: ${platform}, architecture: ${arch}`);
+}
+
+// use local build if exists
+if (fs.existsSync('node-web-audio-api.build-release.node')) {
+  nativeBinding = require('./node-web-audio-api.build-release.node');
+}
+
+if (fs.existsSync('node-web-audio-api.build-debug.node')) {
+  nativeBinding = require('./node-web-audio-api.build-debug.node');
 }
 
 if (!nativeBinding) {

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "node-web-audio-api",
-  "version": "0.21.4",
+  "version": "1.0.0-beta.0",
   "author": "Benjamin Matuszewski",
-  "description": "Node.js bindings for web-audio-api-rs using napi-rs",
+  "description": "Web Audio API implementation for Node.js",
   "exports": {
     "import": "./index.mjs",
     "require": "./index.cjs",
@@ -21,7 +21,7 @@
     "music",
     "dsp",
     "rust",
-    "n-api"
+    "node-api"
   ],
   "engines": {
     "node": ">= 14"
@@ -35,17 +35,17 @@
     "access": "public"
   },
   "scripts": {
-    "artifacts": "napi artifacts",
-    "build": "npm run generate && napi build --platform --release",
-    "build:jack": "npm run generate && napi build --platform --features jack --release",
-    "build:debug": "npm run generate && napi build --platform",
-    "build:only": "napi build --platform --release",
+    "build": "npm run generate && cargo build --release && node ./.scripts/move-artifact.mjs --release",
+    "build:jack": "npm run generate && cargo build --features jack --release && node ./.scripts/move-artifact.mjs --release",
+    "build:debug": "npm run generate && cargo build && node ./.scripts/move-artifact.mjs",
+    "build:only": "cargo build --release && node ./.scripts/move-artifact.mjs --release",
     "check": "cargo fmt && cargo clippy",
     "generate": "node generator/index.mjs && cargo fmt",
     "lint": "npx eslint index.cjs index.mjs && npx eslint js/*.js && npx eslint examples/*.mjs",
-    "preversion": "yarn install && npm run generate",
+    "preversion": "npm install && npm run generate",
     "postversion": "cargo bump $npm_package_version && git commit -am \"v$npm_package_version\" && node .scripts/check-changelog.mjs",
     "test": "mocha tests/*.spec.mjs",
+    "test:ci": "mocha tests/*.spec.mjs -- --ci",
     "test:only": "mocha",
     "wpt": "npm run build && node ./.scripts/wpt-harness.mjs",
     "wpt:only": "node ./.scripts/wpt-harness.mjs"
@@ -73,8 +73,6 @@
     "wpt-runner": "^5.0.0"
   },
   "dependencies": {
-    "@napi-rs/cli": "^2.14.3",
-    "@node-rs/helper": "^1.3.3",
     "caller": "^1.1.0",
     "node-fetch": "^3.3.2",
     "webidl-conversions": "^7.0.0"