node-web-audio-api 0.20.0 → 0.21.0

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 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)

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

@@ -30,6 +30,7 @@ export const {
   // events
   OfflineAudioCompletionEvent,
   AudioProcessingEvent,
+  AudioRenderCapacityEvent,
 
   // manually written nodes
   BaseAudioContext,
@@ -41,11 +42,15 @@ export const {
   AudioParam,
   AudioDestinationNode,
   AudioListener,
+  AudioWorklet,
+  AudioParamMap,
+  AudioRenderCapacity,
 
   PeriodicWave,
   AudioBuffer,
   // generated nodes
   ScriptProcessorNode,
+  AudioWorkletNode,
   AnalyserNode,
   AudioBufferSourceNode,
   BiquadFilterNode,

package/js/AudioContext.js

@@ -11,6 +11,7 @@ const {
   kNapiObj,
   kOnStateChange,
   kOnSinkChange,
+  kWorkletRelease,
 } = require('./lib/symbols.js');
 const {
   propagateEvent,
@@ -22,6 +23,8 @@ module.exports = function(jsExport, nativeBinding) {
 
   class AudioContext extends jsExport.BaseAudioContext {
     #sinkId = '';
+    #renderCapacity = null;
+    #onsinkchange = null;
 
     constructor(options = {}) {
       if (typeof options !== 'object') {
@@ -51,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 {
@@ -83,6 +84,10 @@ module.exports = function(jsExport, nativeBinding) {
         this.#sinkId = options.sinkId;
       }
 
+      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)) {
@@ -160,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() {
@@ -168,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) {
@@ -177,7 +182,7 @@ module.exports = function(jsExport, nativeBinding) {
       }
 
       if (isFunction(value) || value === null) {
-        this._sinkchange = value;
+        this.#onsinkchange = value;
       }
     }
 
@@ -210,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/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;

package/js/AudioRenderCapacity.js

@@ -0,0 +1,117 @@
+const conversions = require('webidl-conversions');
+
+const {
+  kNapiObj,
+  kOnUpdate,
+} = require('./lib/symbols.js');
+const {
+  kEnumerableProperty,
+} = require('./lib/utils.js');
+const {
+  propagateEvent,
+} = require('./lib/events.js');
+const {
+  AudioRenderCapacityEvent,
+} = require('./Events.js');
+
+class AudioRenderCapacity extends EventTarget {
+  #onupdate = null;
+
+  constructor(options) {
+    // Make constructor "private"
+    if (
+      (typeof options !== 'object')
+      || !(kNapiObj in options)
+      || options[kNapiObj]['Symbol.toStringTag'] !== 'AudioRenderCapacity'
+    ) {
+      throw new TypeError('Illegal constructor');
+    }
+
+    super();
+
+    this[kNapiObj] = options[kNapiObj];
+
+    this[kNapiObj][kOnUpdate] = (err, rawEvent) => {
+      const event = new AudioRenderCapacityEvent('update', rawEvent);
+      propagateEvent(this, event);
+    };
+
+    this[kNapiObj].listen_to_events();
+  }
+
+  get onupdate() {
+    if (!(this instanceof AudioRenderCapacity)) {
+      throw new TypeError('Invalid Invocation: Value of \'this\' must be of type \'AudioRenderCapacity\'');
+    }
+
+    return this.#onupdate;
+  }
+
+  set onupdate(value) {
+    if (!(this instanceof AudioRenderCapacity)) {
+      throw new TypeError('Invalid Invocation: Value of \'this\' must be of type \'AudioRenderCapacity\'');
+    }
+
+    if (isFunction(value) || value === null) {
+      this.#onupdate = value;
+    }
+  }
+
+  start(options = null) {
+    if (!(this instanceof AudioRenderCapacity)) {
+      throw new TypeError(`Invalid Invocation: Value of 'this' must be of type 'AudioRenderCapacity'`);
+    }
+
+    let targetOptions = {};
+
+    if (typeof options === 'object' && options !== null) {
+      if (!('updateInterval' in options)) {
+        throw new TypeError(`Failed to execute 'start' on 'AudioRenderCapacity': Failed to read the 'updateInterval' property on 'AudioRenderCapacityOptions'`);
+      }
+
+      targetOptions.updateInterval = conversions['double'](options.updateInterval, {
+        context: `Failed to execute 'start' on 'AudioRenderCapacity': Failed to read the 'updateInterval' property on 'AudioRenderCapacityOptions': The provided value ()`
+      });
+    } else {
+      targetOptions.updateInterval = 1;
+    }
+
+    return this[kNapiObj].start(targetOptions);
+  }
+
+  stop() {
+    if (!(this instanceof AudioRenderCapacity)) {
+      throw new TypeError(`Invalid Invocation: Value of 'this' must be of type 'AudioRenderCapacity'`);
+    }
+
+    return this[kNapiObj].start();
+  }
+}
+
+Object.defineProperties(AudioRenderCapacity, {
+  length: {
+    __proto__: null,
+    writable: false,
+    enumerable: false,
+    configurable: true,
+    value: 0,
+  },
+});
+
+Object.defineProperties(AudioRenderCapacity.prototype, {
+  [Symbol.toStringTag]: {
+    __proto__: null,
+    writable: false,
+    enumerable: false,
+    configurable: true,
+    value: 'AudioRenderCapacity',
+  },
+
+  onupdate: kEnumerableProperty,
+  stop: kEnumerableProperty,
+  stop: kEnumerableProperty,
+});
+
+module.exports = AudioRenderCapacity;
+
+