node-web-audio-api 0.19.0 → 0.21.0

package/CHANGELOG.md

@@ -1,3 +1,14 @@
+## v0.21.0 (17/05/2024)
+
+- Feat: implement AudioWorkletNode
+
+## v0.20.0 (29/04/2024)
+
+- Update upstream crate to [v0.44.0](https://github.com/orottier/web-audio-api-rs/blob/main/CHANGELOG.md#version-0440-2024-04-22)
+- Implement ScriptProcessorNode
+- Fix memory leak introduced in v0.19.0
+- Improve events compliance
+
 ## v0.19.0 (17/04/2024)
 
 - Update upstream crate to [1.0.0-rc.5](https://github.com/orottier/web-audio-api-rs/blob/main/CHANGELOG.md#version-0430--100-rc5-2024-04-15)

package/README.md

@@ -65,9 +65,7 @@ node examples/granular-scrub.mjs
 
 ## Caveats
 
-- Missing nodes: `ScriptProcessorNode`, `AudioWorkletNode`.
-- Streams: only a minimial audio input stream and the `MediaStreamSourceNode` are provided. All other `MediaStream` features are left on the side for now as they principaly concern a different API specification, which is not a trivial problem.
-- Some async methods (e.g. `decodeAudioData`, `setSinkId`) are not trully async yet. This will evolve with the implemetation of the async version in the upstream crate.
+- `Streams`: only a minimial audio input stream and the `MediaStreamSourceNode` are provided. All other `MediaStream` features are left on the side for now as they principaly concern a different API specification, which is not a trivial problem.
 
 ## Supported Platforms
 

package/index.cjs

@@ -1,90 +1,88 @@
-const { platform, arch } = process;
+// -------------------------------------------------------------------------- //
+// -------------------------------------------------------------------------- //
+//                                                                            //
+//                                                                            //
+//                                                                            //
+//    ██╗    ██╗ █████╗ ██████╗ ███╗   ██╗██╗███╗   ██╗ ██████╗               //
+//    ██║    ██║██╔══██╗██╔══██╗████╗  ██║██║████╗  ██║██╔════╝               //
+//    ██║ █╗ ██║███████║██████╔╝██╔██╗ ██║██║██╔██╗ ██║██║  ███╗              //
+//    ██║███╗██║██╔══██║██╔══██╗██║╚██╗██║██║██║╚██╗██║██║   ██║              //
+//    ╚███╔███╔╝██║  ██║██║  ██║██║ ╚████║██║██║ ╚████║╚██████╔╝              //
+//     ╚══╝╚══╝ ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═══╝╚═╝╚═╝  ╚═══╝ ╚═════╝               //
+//                                                                            //
+//                                                                            //
+//    - This file has been generated ---------------------------              //
+//                                                                            //
+//                                                                            //
+// -------------------------------------------------------------------------- //
+// -------------------------------------------------------------------------- //
 
-let nativeBinding = null;
-let loadError = null;
+const nativeBinding = require('./load-native.cjs');
+const jsExport = {};
 
-switch (platform) {
-  case 'win32':
-    switch (arch) {
-      case 'x64':
-        try {
-          nativeBinding = require('./node-web-audio-api.win32-x64-msvc.node');
-        } catch (e) {
-          loadError = e;
-        }
-        break;
-      case 'arm64':
-        try {
-          nativeBinding = require('./node-web-audio-api.win32-arm64-msvc.node');
-        } catch (e) {
-          loadError = e;
-        }
-        break;
-      default:
-        throw new Error(`Unsupported architecture on Windows: ${arch}`);
-    }
-    break;
-  case 'darwin':
-    switch (arch) {
-      case 'x64':
-        try {
-          nativeBinding = require('./node-web-audio-api.darwin-x64.node');
-        } catch (e) {
-          loadError = e;
-        }
-        break;
-      case 'arm64':
-        try {
-          nativeBinding = require('./node-web-audio-api.darwin-arm64.node');
-        } catch (e) {
-          loadError = e;
-        }
-        break;
-      default:
-        throw new Error(`Unsupported architecture on macOS: ${arch}`);
-    }
-    break;
-  case 'linux':
-    switch (arch) {
-      case 'x64':
-        try {
-          nativeBinding = require('./node-web-audio-api.linux-x64-gnu.node');
-        } catch (e) {
-          loadError = e;
-        }
-        break;
-      case 'arm64':
-        try {
-          nativeBinding = require('./node-web-audio-api.linux-arm64-gnu.node');
-        } catch (e) {
-          loadError = e;
-        }
-        break;
-      case 'arm':
-        try {
-          nativeBinding = require('./node-web-audio-api.linux-arm-gnueabihf.node');
-        } catch (e) {
-          loadError = e;
-        }
-        break;
-      default:
-        throw new Error(`Unsupported architecture on Linux: ${arch}`);
-    }
-    break;
-  default:
-    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`);
-}
+// --------------------------------------------------------------------------
+// Events
+// --------------------------------------------------------------------------
+jsExport.OfflineAudioCompletionEvent = require('./js/Events').OfflineAudioCompletionEvent;
+jsExport.AudioProcessingEvent = require('./js/Events').AudioProcessingEvent;
+jsExport.AudioRenderCapacityEvent = require('./js/Events').AudioRenderCapacityEvent;
+// --------------------------------------------------------------------------
+// Create Web Audio API facade
+// --------------------------------------------------------------------------
+jsExport.BaseAudioContext = require('./js/BaseAudioContext.js')(jsExport, nativeBinding);
+jsExport.AudioContext = require('./js/AudioContext.js')(jsExport, nativeBinding);
+jsExport.OfflineAudioContext = require('./js/OfflineAudioContext.js')(jsExport, nativeBinding);
 
-if (!nativeBinding) {
-  if (loadError) {
-    throw loadError;
-  }
+jsExport.ScriptProcessorNode = require('./js/ScriptProcessorNode.js')(jsExport, nativeBinding);
+jsExport.AudioWorkletNode = require('./js/AudioWorkletNode.js')(jsExport, nativeBinding);
+jsExport.AnalyserNode = require('./js/AnalyserNode.js')(jsExport, nativeBinding);
+jsExport.AudioBufferSourceNode = require('./js/AudioBufferSourceNode.js')(jsExport, nativeBinding);
+jsExport.BiquadFilterNode = require('./js/BiquadFilterNode.js')(jsExport, nativeBinding);
+jsExport.ChannelMergerNode = require('./js/ChannelMergerNode.js')(jsExport, nativeBinding);
+jsExport.ChannelSplitterNode = require('./js/ChannelSplitterNode.js')(jsExport, nativeBinding);
+jsExport.ConstantSourceNode = require('./js/ConstantSourceNode.js')(jsExport, nativeBinding);
+jsExport.ConvolverNode = require('./js/ConvolverNode.js')(jsExport, nativeBinding);
+jsExport.DelayNode = require('./js/DelayNode.js')(jsExport, nativeBinding);
+jsExport.DynamicsCompressorNode = require('./js/DynamicsCompressorNode.js')(jsExport, nativeBinding);
+jsExport.GainNode = require('./js/GainNode.js')(jsExport, nativeBinding);
+jsExport.IIRFilterNode = require('./js/IIRFilterNode.js')(jsExport, nativeBinding);
+jsExport.MediaStreamAudioSourceNode = require('./js/MediaStreamAudioSourceNode.js')(jsExport, nativeBinding);
+jsExport.OscillatorNode = require('./js/OscillatorNode.js')(jsExport, nativeBinding);
+jsExport.PannerNode = require('./js/PannerNode.js')(jsExport, nativeBinding);
+jsExport.StereoPannerNode = require('./js/StereoPannerNode.js')(jsExport, nativeBinding);
+jsExport.WaveShaperNode = require('./js/WaveShaperNode.js')(jsExport, nativeBinding);
+
+jsExport.AudioNode = require('./js/AudioNode.js');
+jsExport.AudioScheduledSourceNode = require('./js/AudioScheduledSourceNode.js');
+jsExport.AudioParam = require('./js/AudioParam.js');
+jsExport.AudioDestinationNode = require('./js/AudioDestinationNode.js');
+jsExport.AudioListener = require('./js/AudioListener.js');
+jsExport.AudioWorklet = require('./js/AudioWorklet.js');
+jsExport.AudioParamMap = require('./js/AudioParamMap.js');
+jsExport.AudioRenderCapacity = require('./js/AudioRenderCapacity.js');
+
+jsExport.PeriodicWave = require('./js/PeriodicWave.js')(jsExport, nativeBinding);
+jsExport.AudioBuffer = require('./js/AudioBuffer.js')(jsExport, nativeBinding);
 
-  throw new Error(`Failed to load native binding for OS: ${platform}, architecture: ${arch}`);
-}
+// --------------------------------------------------------------------------
+// Promisify MediaDevices API
+// --------------------------------------------------------------------------
+jsExport.mediaDevices = {};
 
-const monkeyPatch = require('./js/monkey-patch.js');
-nativeBinding = monkeyPatch(nativeBinding);
+const enumerateDevicesSync = nativeBinding.mediaDevices.enumerateDevices;
+jsExport.mediaDevices.enumerateDevices = async function enumerateDevices() {
+  const list = enumerateDevicesSync();
+  return Promise.resolve(list);
+};
+
+const getUserMediaSync = nativeBinding.mediaDevices.getUserMedia;
+jsExport.mediaDevices.getUserMedia = async function getUserMedia(options) {
+  if (options === undefined) {
+    throw new TypeError('Failed to execute "getUserMedia" on "MediaDevices": audio must be requested');
+  }
 
-module.exports = nativeBinding;
+  const stream = getUserMediaSync(options);
+  return Promise.resolve(stream);
+};
 
+module.exports = jsExport;

package/index.mjs

@@ -27,6 +27,12 @@ const require = createRequire(import.meta.url);
 
 const nativeModule = require('./index.cjs');
 export const {
+  // events
+  OfflineAudioCompletionEvent,
+  AudioProcessingEvent,
+  AudioRenderCapacityEvent,
+
+  // manually written nodes
   BaseAudioContext,
   AudioContext,
   OfflineAudioContext,
@@ -36,10 +42,15 @@ export const {
   AudioParam,
   AudioDestinationNode,
   AudioListener,
+  AudioWorklet,
+  AudioParamMap,
+  AudioRenderCapacity,
 
   PeriodicWave,
   AudioBuffer,
-  // generated supported nodes
+  // generated nodes
+  ScriptProcessorNode,
+  AudioWorkletNode,
   AnalyserNode,
   AudioBufferSourceNode,
   BiquadFilterNode,

package/js/AnalyserNode.js

@@ -33,9 +33,6 @@ const {
   kNapiObj,
   kAudioBuffer,
 } = require('./lib/symbols.js');
-const {
-  bridgeEventTarget,
-} = require('./lib/events.js');
 /* eslint-enable no-unused-vars */
 
 const AudioNode = require('./AudioNode.js');

package/js/AudioBuffer.js

@@ -1,4 +1,4 @@
-const conversions = require("webidl-conversions");
+const conversions = require('webidl-conversions');
 
 const {
   throwSanitizedError,
@@ -9,7 +9,6 @@ const {
 } = require('./lib/utils.js');
 const {
   kNapiObj,
-  kAudioBuffer,
 } = require('./lib/symbols.js');
 
 
@@ -21,7 +20,7 @@ module.exports = (_jsExport, nativeBinding) => {
       }
 
       if (typeof options !== 'object') {
-        throw new TypeError("Failed to construct 'AudioBuffer': argument 1 is not of type 'AudioBufferOptions'");
+        throw new TypeError(`Failed to construct 'AudioBuffer': argument 1 is not of type 'AudioBufferOptions'`);
       }
 
       if (kNapiObj in options) {
@@ -82,7 +81,7 @@ module.exports = (_jsExport, nativeBinding) => {
 
     get sampleRate() {
       if (!(this instanceof AudioBuffer)) {
-        throw new TypeError("Invalid Invocation: Value of 'this' must be of type 'AudioBuffer'");
+        throw new TypeError(`Invalid Invocation: Value of 'this' must be of type 'AudioBuffer'`);
       }
 
       return this[kNapiObj].sampleRate;
@@ -90,7 +89,7 @@ module.exports = (_jsExport, nativeBinding) => {
 
     get duration() {
       if (!(this instanceof AudioBuffer)) {
-        throw new TypeError("Invalid Invocation: Value of 'this' must be of type 'AudioBuffer'");
+        throw new TypeError(`Invalid Invocation: Value of 'this' must be of type 'AudioBuffer'`);
       }
 
       return this[kNapiObj].duration;
@@ -98,7 +97,7 @@ module.exports = (_jsExport, nativeBinding) => {
 
     get length() {
       if (!(this instanceof AudioBuffer)) {
-        throw new TypeError("Invalid Invocation: Value of 'this' must be of type 'AudioBuffer'");
+        throw new TypeError(`Invalid Invocation: Value of 'this' must be of type 'AudioBuffer'`);
       }
 
       return this[kNapiObj].length;
@@ -106,7 +105,7 @@ module.exports = (_jsExport, nativeBinding) => {
 
     get numberOfChannels() {
       if (!(this instanceof AudioBuffer)) {
-        throw new TypeError("Invalid Invocation: Value of 'this' must be of type 'AudioBuffer'");
+        throw new TypeError(`Invalid Invocation: Value of 'this' must be of type 'AudioBuffer'`);
       }
 
       return this[kNapiObj].numberOfChannels;
@@ -114,7 +113,7 @@ module.exports = (_jsExport, nativeBinding) => {
 
     copyFromChannel(destination, channelNumber, bufferOffset = 0) {
       if (!(this instanceof AudioBuffer)) {
-        throw new TypeError("Invalid Invocation: Value of 'this' must be of type 'AudioBuffer'");
+        throw new TypeError(`Invalid Invocation: Value of 'this' must be of type 'AudioBuffer'`);
       }
 
       if (arguments.length < 2) {
@@ -149,7 +148,7 @@ module.exports = (_jsExport, nativeBinding) => {
 
     copyToChannel(source, channelNumber, bufferOffset = 0) {
       if (!(this instanceof AudioBuffer)) {
-        throw new TypeError("Invalid Invocation: Value of 'this' must be of type 'AudioBuffer'");
+        throw new TypeError(`Invalid Invocation: Value of 'this' must be of type 'AudioBuffer'`);
       }
 
       if (arguments.length < 2) {
@@ -184,7 +183,7 @@ module.exports = (_jsExport, nativeBinding) => {
 
     getChannelData(channel) {
       if (!(this instanceof AudioBuffer)) {
-        throw new TypeError("Invalid Invocation: Value of 'this' must be of type 'AudioBuffer'");
+        throw new TypeError(`Invalid Invocation: Value of 'this' must be of type 'AudioBuffer'`);
       }
 
       if (arguments.length < 1) {
@@ -220,7 +219,7 @@ module.exports = (_jsExport, nativeBinding) => {
     },
   });
 
-  Object.defineProperties(AudioBuffer.prototype,  {
+  Object.defineProperties(AudioBuffer.prototype, {
     [Symbol.toStringTag]: {
       __proto__: null,
       writable: false,

package/js/AudioBufferSourceNode.js

@@ -33,9 +33,6 @@ const {
   kNapiObj,
   kAudioBuffer,
 } = require('./lib/symbols.js');
-const {
-  bridgeEventTarget,
-} = require('./lib/events.js');
 /* eslint-enable no-unused-vars */
 
 const AudioScheduledSourceNode = require('./AudioScheduledSourceNode.js');
@@ -142,9 +139,6 @@ module.exports = (jsExport, nativeBinding) => {
         this[kAudioBuffer] = options.buffer;
       }
 
-      // Bridge Rust native event to Node EventTarget
-      bridgeEventTarget(this);
-
       this.#playbackRate = new jsExport.AudioParam({
         [kNapiObj]: this[kNapiObj].playbackRate,
       });

package/js/AudioContext.js

@@ -1,17 +1,20 @@
-const conversions = require("webidl-conversions");
+const conversions = require('webidl-conversions');
 
 const {
   throwSanitizedError,
 } = require('./lib/errors.js');
 const {
   isFunction,
-  kEnumerableProperty
+  kEnumerableProperty,
 } = require('./lib/utils.js');
 const {
   kNapiObj,
+  kOnStateChange,
+  kOnSinkChange,
+  kWorkletRelease,
 } = require('./lib/symbols.js');
 const {
-  bridgeEventTarget,
+  propagateEvent,
 } = require('./lib/events.js');
 
 let contextId = 0;
@@ -20,6 +23,8 @@ module.exports = function(jsExport, nativeBinding) {
 
   class AudioContext extends jsExport.BaseAudioContext {
     #sinkId = '';
+    #renderCapacity = null;
+    #onsinkchange = null;
 
     constructor(options = {}) {
       if (typeof options !== 'object') {
@@ -49,18 +54,16 @@ module.exports = function(jsExport, nativeBinding) {
       }
 
       if (options.sinkId !== undefined) {
-        const sinkId = options.sinkId;
-
         if (typeof options.sinkId === 'object') {
           // https://webaudio.github.io/web-audio-api/#enumdef-audiosinktype
           if (!('type' in options.sinkId) || options.sinkId.type !== 'none') {
-            throw TypeError(`Failed to construct 'AudioContext': Failed to read the 'sinkId' property from AudioNodeOptions: Failed to read the 'type' property from 'AudioSinkOptions': The provided value (${sinkId.type}) is not a valid enum value of type AudioSinkType.`);
+            throw TypeError(`Failed to construct 'AudioContext': Failed to read the 'sinkId' property from AudioNodeOptions: Failed to read the 'type' property from 'AudioSinkOptions': The provided value (${options.sinkId.type}) is not a valid enum value of type AudioSinkType.`);
           }
 
           targetOptions.sinkId = 'none';
         } else {
-          targetOptions.sinkId = conversions['DOMString'](sinkId, {
-            context: `Failed to construct 'AudioContext': Failed to read the 'sinkId' property from AudioNodeOptions:  Failed to read the 'type' property from 'AudioSinkOptions': The provided value (${sinkId})`,
+          targetOptions.sinkId = conversions['DOMString'](options.sinkId, {
+            context: `Failed to construct 'AudioContext': Failed to read the 'sinkId' property from AudioNodeOptions:  Failed to read the 'type' property from 'AudioSinkOptions': The provided value (${options.sinkId})`,
           });
         }
       } else {
@@ -81,8 +84,33 @@ module.exports = function(jsExport, nativeBinding) {
         this.#sinkId = options.sinkId;
       }
 
-      // Bridge Rust native event to Node EventTarget
-      bridgeEventTarget(this);
+      this.#renderCapacity = new jsExport.AudioRenderCapacity({
+        [kNapiObj]: this[kNapiObj].renderCapacity,
+      });
+
+      // Add function to Napi object to bridge from Rust events to JS EventTarget
+      this[kNapiObj][kOnStateChange] = (err, rawEvent) => {
+        if (typeof rawEvent !== 'object' && !('type' in rawEvent)) {
+          throw new TypeError('Invalid [kOnStateChange] Invocation: rawEvent should have a type property');
+        }
+
+        const event = new Event(rawEvent.type);
+        propagateEvent(this, event);
+      };
+
+      this[kNapiObj][kOnSinkChange] = (err, rawEvent) => {
+        if (typeof rawEvent !== 'object' && !('type' in rawEvent)) {
+          throw new TypeError('Invalid [kOnSinkChange] Invocation: rawEvent should have a type property');
+        }
+
+        const event = new Event(rawEvent.type);
+        propagateEvent(this, event);
+      };
+
+      // Workaround to bind the `sinkchange` and `statechange` events to EventTarget.
+      // This must be called from JS facade ctor as the JS handler are added to the Napi
+      // object after its instantiation, and that we don't have any initial `resume` call.
+      this[kNapiObj].listen_to_events();
 
       // @todo - check if this is still required
       // prevent garbage collection and process exit
@@ -137,7 +165,7 @@ module.exports = function(jsExport, nativeBinding) {
         throw new TypeError('Invalid Invocation: Value of \'this\' must be of type \'AudioContext\'');
       }
 
-      throw new Error(`AudioContext::renderCapacity is not yet implemented`);
+      return this.#renderCapacity;
     }
 
     get onsinkchange() {
@@ -145,7 +173,7 @@ module.exports = function(jsExport, nativeBinding) {
         throw new TypeError('Invalid Invocation: Value of \'this\' must be of type \'AudioContext\'');
       }
 
-      return this._sinkchange || null;
+      return this.#onsinkchange;
     }
 
     set onsinkchange(value) {
@@ -154,7 +182,7 @@ module.exports = function(jsExport, nativeBinding) {
       }
 
       if (isFunction(value) || value === null) {
-        this._sinkchange = value;
+        this.#onsinkchange = value;
       }
     }
 
@@ -187,6 +215,9 @@ module.exports = function(jsExport, nativeBinding) {
         throw new TypeError('Invalid Invocation: Value of \'this\' must be of type \'AudioContext\'');
       }
 
+      // Close audioWorklet first so that `run_audio_worklet_global_scope` exit first
+      // The other way around works too because of `recv_timeout` but cleaner this way
+      await this.audioWorklet[kWorkletRelease]();
       await this[kNapiObj].close();
     }
 

package/js/AudioDestinationNode.js

@@ -20,7 +20,7 @@ class AudioDestinationNode extends AudioNode {
 
   get maxChannelCount() {
     if (!(this instanceof AudioDestinationNode)) {
-      throw new TypeError("Invalid Invocation: Value of 'this' must be of type 'AudioDestinationNode'");
+      throw new TypeError(`Invalid Invocation: Value of 'this' must be of type 'AudioDestinationNode'`);
     }
 
     return this[kNapiObj].maxChannelCount;

package/js/AudioListener.js

@@ -1,4 +1,4 @@
-const conversions = require("webidl-conversions");
+const conversions = require('webidl-conversions');
 
 const { throwSanitizedError } = require('./lib/errors.js');
 const { kEnumerableProperty, kHiddenProperty } = require('./lib/utils.js');
@@ -160,7 +160,7 @@ class AudioListener {
       context: `Failed to execute 'setOrientation' on 'AudioListener': The provided float value`,
     });
 
-    Z = conversions['float'](Z, {
+    z = conversions['float'](z, {
       context: `Failed to execute 'setOrientation' on 'AudioListener': The provided float value`,
     });
 

package/js/AudioParamMap.js

@@ -0,0 +1,88 @@
+const {
+  kPrivateConstructor,
+} = require('./lib/symbols.js');
+const {
+  kEnumerableProperty,
+} = require('./lib/utils.js');
+
+class AudioParamMap {
+  #parameters = null;
+
+  constructor(options) {
+    if (
+      (typeof options !== 'object') ||
+      options[kPrivateConstructor] !== true
+    ) {
+      throw new TypeError('Illegal constructor');
+    }
+
+    this.#parameters = options.parameters;
+  }
+
+  get size() {
+    return this.#parameters.size;
+  }
+
+  entries() {
+    return this.#parameters.entries();
+  }
+
+  keys() {
+    return this.#parameters.keys();
+  }
+
+  values() {
+    return this.#parameters.values();
+  }
+
+  forEach(func) {
+    return this.#parameters.forEach(func);
+  }
+
+  get(name) {
+    return this.#parameters.get(name);
+  }
+
+  has(name) {
+    return this.#parameters.has(name);
+  }
+}
+
+Object.defineProperties(AudioParamMap, {
+  length: {
+    __proto__: null,
+    writable: false,
+    enumerable: false,
+    configurable: true,
+    value: 0,
+  },
+});
+
+Object.defineProperties(AudioParamMap.prototype, {
+  [Symbol.toStringTag]: {
+    __proto__: null,
+    writable: false,
+    enumerable: false,
+    configurable: true,
+    value: 'AudioParamMap',
+  },
+  [Symbol.iterator]: {
+    value: AudioParamMap.prototype.entries,
+    enumerable: false,
+    configurable: true,
+    writable: true,
+  },
+  size: {
+    __proto__: null,
+    enumerable: true,
+    configurable: true,
+  },
+  entries: kEnumerableProperty,
+  keys: kEnumerableProperty,
+  values: kEnumerableProperty,
+  forEach: kEnumerableProperty,
+  get: kEnumerableProperty,
+  has: kEnumerableProperty,
+});
+
+module.exports = AudioParamMap;