node-web-audio-api 0.18.0 → 0.19.0

package/js/monkey-patch.js

@@ -18,48 +18,53 @@
 // -------------------------------------------------------------------------- //
 
 module.exports = function monkeyPatch(nativeBinding) {
+  let jsExport = {};
   // --------------------------------------------------------------------------
   // Monkey Patch Web Audio API
   // --------------------------------------------------------------------------
+  jsExport.BaseAudioContext = require('./BaseAudioContext.js')(jsExport, nativeBinding);
+  jsExport.AudioContext = require('./AudioContext.js')(jsExport, nativeBinding);
+  jsExport.OfflineAudioContext = require('./OfflineAudioContext.js')(jsExport, nativeBinding);
 
-  nativeBinding.AnalyserNode = require('./AnalyserNode.js')(nativeBinding.AnalyserNode);
-  nativeBinding.AudioBufferSourceNode = require('./AudioBufferSourceNode.js')(nativeBinding.AudioBufferSourceNode);
-  nativeBinding.BiquadFilterNode = require('./BiquadFilterNode.js')(nativeBinding.BiquadFilterNode);
-  nativeBinding.ChannelMergerNode = require('./ChannelMergerNode.js')(nativeBinding.ChannelMergerNode);
-  nativeBinding.ChannelSplitterNode = require('./ChannelSplitterNode.js')(nativeBinding.ChannelSplitterNode);
-  nativeBinding.ConstantSourceNode = require('./ConstantSourceNode.js')(nativeBinding.ConstantSourceNode);
-  nativeBinding.ConvolverNode = require('./ConvolverNode.js')(nativeBinding.ConvolverNode);
-  nativeBinding.DelayNode = require('./DelayNode.js')(nativeBinding.DelayNode);
-  nativeBinding.DynamicsCompressorNode = require('./DynamicsCompressorNode.js')(nativeBinding.DynamicsCompressorNode);
-  nativeBinding.GainNode = require('./GainNode.js')(nativeBinding.GainNode);
-  nativeBinding.IIRFilterNode = require('./IIRFilterNode.js')(nativeBinding.IIRFilterNode);
-  nativeBinding.MediaStreamAudioSourceNode = require('./MediaStreamAudioSourceNode.js')(nativeBinding.MediaStreamAudioSourceNode);
-  nativeBinding.OscillatorNode = require('./OscillatorNode.js')(nativeBinding.OscillatorNode);
-  nativeBinding.PannerNode = require('./PannerNode.js')(nativeBinding.PannerNode);
-  nativeBinding.StereoPannerNode = require('./StereoPannerNode.js')(nativeBinding.StereoPannerNode);
-  nativeBinding.WaveShaperNode = require('./WaveShaperNode.js')(nativeBinding.WaveShaperNode);
+  jsExport.AnalyserNode = require('./AnalyserNode.js')(jsExport, nativeBinding);
+  jsExport.AudioBufferSourceNode = require('./AudioBufferSourceNode.js')(jsExport, nativeBinding);
+  jsExport.BiquadFilterNode = require('./BiquadFilterNode.js')(jsExport, nativeBinding);
+  jsExport.ChannelMergerNode = require('./ChannelMergerNode.js')(jsExport, nativeBinding);
+  jsExport.ChannelSplitterNode = require('./ChannelSplitterNode.js')(jsExport, nativeBinding);
+  jsExport.ConstantSourceNode = require('./ConstantSourceNode.js')(jsExport, nativeBinding);
+  jsExport.ConvolverNode = require('./ConvolverNode.js')(jsExport, nativeBinding);
+  jsExport.DelayNode = require('./DelayNode.js')(jsExport, nativeBinding);
+  jsExport.DynamicsCompressorNode = require('./DynamicsCompressorNode.js')(jsExport, nativeBinding);
+  jsExport.GainNode = require('./GainNode.js')(jsExport, nativeBinding);
+  jsExport.IIRFilterNode = require('./IIRFilterNode.js')(jsExport, nativeBinding);
+  jsExport.MediaStreamAudioSourceNode = require('./MediaStreamAudioSourceNode.js')(jsExport, nativeBinding);
+  jsExport.OscillatorNode = require('./OscillatorNode.js')(jsExport, nativeBinding);
+  jsExport.PannerNode = require('./PannerNode.js')(jsExport, nativeBinding);
+  jsExport.StereoPannerNode = require('./StereoPannerNode.js')(jsExport, nativeBinding);
+  jsExport.WaveShaperNode = require('./WaveShaperNode.js')(jsExport, nativeBinding);
 
-  // @todo - wrap AudioBuffer interface as well
-  nativeBinding.PeriodicWave = require('./PeriodicWave.js')(nativeBinding.PeriodicWave);
+  jsExport.AudioNode = require('./AudioNode.js');
+  jsExport.AudioScheduledSourceNode = require('./AudioScheduledSourceNode.js');
+  jsExport.AudioParam = require('./AudioParam.js');
+  jsExport.AudioDestinationNode = require('./AudioDestinationNode.js');
+  jsExport.AudioListener = require('./AudioListener.js');
 
-  nativeBinding.AudioContext = require('./AudioContext.js')(nativeBinding);
-  nativeBinding.OfflineAudioContext = require('./OfflineAudioContext.js')(nativeBinding);
-
-  // find a way to make the constructor private
-  nativeBinding.AudioParam = require('./AudioParam.js').AudioParam;
-  nativeBinding.AudioDestinationNode = require('./AudioDestinationNode.js').AudioDestinationNode;
+  jsExport.PeriodicWave = require('./PeriodicWave.js')(jsExport, nativeBinding);
+  jsExport.AudioBuffer = require('./AudioBuffer.js')(jsExport, nativeBinding);
 
   // --------------------------------------------------------------------------
   // Promisify MediaDevices API
   // --------------------------------------------------------------------------
+  jsExport.mediaDevices = {};
+
   const enumerateDevicesSync = nativeBinding.mediaDevices.enumerateDevices;
-  nativeBinding.mediaDevices.enumerateDevices = async function enumerateDevices() {
+  jsExport.mediaDevices.enumerateDevices = async function enumerateDevices() {
     const list = enumerateDevicesSync();
     return Promise.resolve(list);
   };
 
   const getUserMediaSync = nativeBinding.mediaDevices.getUserMedia;
-  nativeBinding.mediaDevices.getUserMedia = async function getUserMedia(options) {
+  jsExport.mediaDevices.getUserMedia = async function getUserMedia(options) {
     if (options === undefined) {
       throw new TypeError('Failed to execute "getUserMedia" on "MediaDevices": audio must be requested');
     }
@@ -68,8 +73,5 @@ module.exports = function monkeyPatch(nativeBinding) {
     return Promise.resolve(stream);
   };
 
-  return nativeBinding;
+  return jsExport;
 };
-
-
-  

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-web-audio-api",
-  "version": "0.18.0",
+  "version": "0.19.0",
   "author": "Benjamin Matuszewski",
   "description": "Node.js bindings for web-audio-api-rs using napi-rs",
   "exports": {
@@ -44,13 +44,14 @@
     "lint": "npx eslint index.cjs index.mjs && npx eslint js/*.js && npx eslint examples/*.mjs",
     "preversion": "yarn install && npm run generate",
     "postversion": "cargo bump $npm_package_version && git commit -am \"v$npm_package_version\" && node .scripts/check-changelog.mjs",
-    "test": "mocha",
+    "test": "mocha tests",
     "wpt": "npm run build && node ./.scripts/wpt-harness.mjs",
     "wpt:only": "node ./.scripts/wpt-harness.mjs"
   },
   "devDependencies": {
     "@ircam/eslint-config": "^1.3.0",
     "@ircam/sc-gettime": "^1.0.0",
+    "@ircam/sc-utils": "^1.3.3",
     "@sindresorhus/slugify": "^2.1.1",
     "camelcase": "^7.0.1",
     "chai": "^4.3.7",
@@ -58,7 +59,8 @@
     "cli-table": "^0.3.11",
     "commander": "^11.1.0",
     "dotenv": "^16.0.3",
-    "eslint": "^8.32.0",
+    "eslint": "^8.57.0",
+    "js-beautify": "^1.15.1",
     "mocha": "^10.2.0",
     "node-ssh": "^13.0.0",
     "octokit": "^2.0.11",
@@ -70,6 +72,7 @@
   },
   "dependencies": {
     "@napi-rs/cli": "^2.14.3",
-    "@node-rs/helper": "^1.3.3"
+    "@node-rs/helper": "^1.3.3",
+    "webidl-conversions": "^7.0.0"
   }
 }

package/run-wpt.md

@@ -0,0 +1,27 @@
+create file run-wpt.sh and chmod +x run-wpt.sh:
+
+```
+#!/bin/bash
+echo $1
+echo ~~~~~~~~~~~~~~~~~
+node ./.scripts/wpt-harness.mjs --filter "$1" 2>&1 | grep -A 3 RESULTS
+echo
+```
+
+dissect the full suite per directory:
+
+```
+ls wpt/webaudio/the-audio-api | xargs -I {} ./run-wpt.sh {}
+```
+
+check the specific file results in a dir:
+
+```
+ls wpt/webaudio/the-audio-api/the-oscillatornode-interface | xargs -I {} ./run-wpt.sh {} 
+```
+
+ls wpt/webaudio/the-audio-api/the-audiocontext-interface | xargs -I {} ./run-wpt.sh {} 
+
+processing-model
+
+ls wpt/webaudio/the-audio-api/processing-model | xargs -I {} ./run-wpt.sh {}

package/run-wpt.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+echo $1
+echo ~~~~~~~~~~~~~~~~~
+node ./.scripts/wpt-harness.mjs --filter "$1" 2>&1 | grep -A 3 RESULTS
+echo

package/js/AudioNode.mixin.js

@@ -1,132 +0,0 @@
-// -------------------------------------------------------------------------- //
-// -------------------------------------------------------------------------- //
-//                                                                            //
-//                                                                            //
-//                                                                            //
-//    ██╗    ██╗ █████╗ ██████╗ ███╗   ██╗██╗███╗   ██╗ ██████╗               //
-//    ██║    ██║██╔══██╗██╔══██╗████╗  ██║██║████╗  ██║██╔════╝               //
-//    ██║ █╗ ██║███████║██████╔╝██╔██╗ ██║██║██╔██╗ ██║██║  ███╗              //
-//    ██║███╗██║██╔══██║██╔══██╗██║╚██╗██║██║██║╚██╗██║██║   ██║              //
-//    ╚███╔███╔╝██║  ██║██║  ██║██║ ╚████║██║██║ ╚████║╚██████╔╝              //
-//     ╚══╝╚══╝ ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═══╝╚═╝╚═╝  ╚═══╝ ╚═════╝               //
-//                                                                            //
-//                                                                            //
-//    - This file has been generated ---------------------------              //
-//                                                                            //
-//                                                                            //
-// -------------------------------------------------------------------------- //
-// -------------------------------------------------------------------------- //
-
-const { throwSanitizedError } = require('./lib/errors.js');
-
-const { AudioParam, kNativeAudioParam } = require('./AudioParam.js');
-const { AudioDestinationNode, kNativeAudioDestinationNode } = require('./AudioDestinationNode.js');
-
-module.exports = (superclass) => {
-  class AudioNode extends superclass {
-    /* eslint-disable constructor-super */
-    constructor(...args) {
-      try {
-        super(...args);
-      } catch (err) {
-        throwSanitizedError(err);
-      }
-    }
-    /* eslint-enable constructor-super */
-
-    // getters
-
-    get context() {
-      return super.context;
-    }
-
-    get numberOfInputs() {
-      return super.numberOfInputs;
-    }
-
-    get numberOfOutputs() {
-      return super.numberOfOutputs;
-    }
-
-    get channelCount() {
-      return super.channelCount;
-    }
-
-    get channelCountMode() {
-      return super.channelCountMode;
-    }
-
-    get channelInterpretation() {
-      return super.channelInterpretation;
-    }
-
-    // setters
-
-    set channelCount(value) {
-      try {
-        super.channelCount = value;
-      } catch (err) {
-        throwSanitizedError(err);
-      }
-    }
-
-    set channelCountMode(value) {
-      try {
-        super.channelCountMode = value;
-      } catch (err) {
-        throwSanitizedError(err);
-      }
-    }
-
-    set channelInterpretation(value) {
-      try {
-        super.channelInterpretation = value;
-      } catch (err) {
-        throwSanitizedError(err);
-      }
-    }
-
-    // methods - connect / disconnect
-    
-    connect(...args) {
-      // unwrap raw audio params from facade
-      if (args[0] instanceof AudioParam) {
-        args[0] = args[0][kNativeAudioParam];
-      }
-
-      // unwrap raw audio destination from facade
-      if (args[0] instanceof AudioDestinationNode) {
-        args[0] = args[0][kNativeAudioDestinationNode];
-      }
-
-      try {
-        return super.connect(...args);
-      } catch (err) {
-        throwSanitizedError(err);
-      }
-    }
-
-    disconnect(...args) {
-      // unwrap raw audio params from facade
-      if (args[0] instanceof AudioParam) {
-        args[0] = args[0][kNativeAudioParam];
-      }
-
-      // unwrap raw audio destination from facade
-      if (args[0] instanceof AudioDestinationNode) {
-        args[0] = args[0][kNativeAudioDestinationNode];
-      }
-
-      try {
-        return super.disconnect(...args);
-      } catch (err) {
-        throwSanitizedError(err);
-      }
-    }
-
-  }
-
-  return AudioNode;
-};
-
-  

package/js/AudioScheduledSourceNode.mixin.js

@@ -1,67 +0,0 @@
-// -------------------------------------------------------------------------- //
-// -------------------------------------------------------------------------- //
-//                                                                            //
-//                                                                            //
-//                                                                            //
-//    ██╗    ██╗ █████╗ ██████╗ ███╗   ██╗██╗███╗   ██╗ ██████╗               //
-//    ██║    ██║██╔══██╗██╔══██╗████╗  ██║██║████╗  ██║██╔════╝               //
-//    ██║ █╗ ██║███████║██████╔╝██╔██╗ ██║██║██╔██╗ ██║██║  ███╗              //
-//    ██║███╗██║██╔══██║██╔══██╗██║╚██╗██║██║██║╚██╗██║██║   ██║              //
-//    ╚███╔███╔╝██║  ██║██║  ██║██║ ╚████║██║██║ ╚████║╚██████╔╝              //
-//     ╚══╝╚══╝ ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═══╝╚═╝╚═╝  ╚═══╝ ╚═════╝               //
-//                                                                            //
-//                                                                            //
-//    - This file has been generated ---------------------------              //
-//                                                                            //
-//                                                                            //
-// -------------------------------------------------------------------------- //
-// -------------------------------------------------------------------------- //
-
-const { throwSanitizedError } = require('./lib/errors.js');
-
-module.exports = (superclass) => {
-  class AudioScheduledSourceNode extends superclass {
-    constructor(...args) {
-      super(...args);
-    }
-    // getters
-
-    get onended() {
-      return super.onended;
-    }
-
-    // setters
-
-    set onended(value) {
-      try {
-        super.onended = value;
-      } catch (err) {
-        throwSanitizedError(err);
-      }
-    }
-
-    // methods - start / stop
-    
-    start(...args) {
-      try {
-        return super.start(...args);
-      } catch (err) {
-        throwSanitizedError(err);
-      }
-    }
-
-    stop(...args) {
-      try {
-        return super.stop(...args);
-      } catch (err) {
-        throwSanitizedError(err);
-      }
-    }
-
-  }
-
-  return AudioScheduledSourceNode;
-};
-
-
-  

package/js/BaseAudioContext.mixin.js

@@ -1,154 +0,0 @@
-// -------------------------------------------------------------------------- //
-// -------------------------------------------------------------------------- //
-//                                                                            //
-//                                                                            //
-//                                                                            //
-//    ██╗    ██╗ █████╗ ██████╗ ███╗   ██╗██╗███╗   ██╗ ██████╗               //
-//    ██║    ██║██╔══██╗██╔══██╗████╗  ██║██║████╗  ██║██╔════╝               //
-//    ██║ █╗ ██║███████║██████╔╝██╔██╗ ██║██║██╔██╗ ██║██║  ███╗              //
-//    ██║███╗██║██╔══██║██╔══██╗██║╚██╗██║██║██║╚██╗██║██║   ██║              //
-//    ╚███╔███╔╝██║  ██║██║  ██║██║ ╚████║██║██║ ╚████║╚██████╔╝              //
-//     ╚══╝╚══╝ ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═══╝╚═╝╚═╝  ╚═══╝ ╚═════╝               //
-//                                                                            //
-//                                                                            //
-//    - This file has been generated ---------------------------              //
-//                                                                            //
-//                                                                            //
-// -------------------------------------------------------------------------- //
-// -------------------------------------------------------------------------- //
-
-const { AudioDestinationNode } = require('./AudioDestinationNode.js');
-const { isFunction } = require('./lib/utils.js');
-
-module.exports = (superclass, bindings) => {
-  const {
-    AnalyserNode,
-    AudioBufferSourceNode,
-    BiquadFilterNode,
-    ChannelMergerNode,
-    ChannelSplitterNode,
-    ConstantSourceNode,
-    ConvolverNode,
-    DelayNode,
-    DynamicsCompressorNode,
-    GainNode,
-    IIRFilterNode,
-    MediaStreamAudioSourceNode,
-    OscillatorNode,
-    PannerNode,
-    StereoPannerNode,
-    WaveShaperNode,
-    PeriodicWave,
-  } = bindings;
-
-  class BaseAudioContext extends superclass {
-    constructor(...args) {
-      super(...args);
-
-      this.destination = new AudioDestinationNode(this.destination);
-    }
-
-    // This is not exactly what the spec says, but if we reject the promise
-    // when decodeErrorCallback is present the program will crash in an
-    // unexpected manner
-    // cf. https://webaudio.github.io/web-audio-api/#dom-baseaudiocontext-decodeaudiodata
-    decodeAudioData(audioData, decodeSuccessCallback, decodeErrorCallback) {
-      if (!(audioData instanceof ArrayBuffer)) {
-        throw new TypeError('Failed to execute "decodeAudioData": parameter 1 is not of type "ArrayBuffer"');
-      }
-
-      try {
-        const audioBuffer = super.decodeAudioData(audioData);
-
-        if (isFunction(decodeSuccessCallback)) {
-          decodeSuccessCallback(audioBuffer);
-        } else {
-          return Promise.resolve(audioBuffer);
-        }
-      } catch (err) {
-        if (isFunction(decodeErrorCallback)) {
-          decodeErrorCallback(err);
-        } else {
-          return Promise.reject(err);
-        }
-      }
-    }
-
-    createPeriodicWave(real, imag) {
-      return new PeriodicWave(this, { real, imag });
-    }
-
-    // --------------------------------------------------------------------
-    // Factory Methods (use the patched AudioNodes)
-    // --------------------------------------------------------------------
-    createAnalyser() {
-      return new AnalyserNode(this);
-    }
-
-    createBufferSource() {
-      return new AudioBufferSourceNode(this);
-    }
-
-    createBiquadFilter() {
-      return new BiquadFilterNode(this);
-    }
-
-    createChannelMerger(numberOfInputs) {
-      const options = { numberOfInputs };
-      return new ChannelMergerNode(this, options);
-    }
-
-    createChannelSplitter(numberOfOutputs) {
-      const options = { numberOfOutputs };
-      return new ChannelSplitterNode(this, options);
-    }
-
-    createConstantSource() {
-      return new ConstantSourceNode(this);
-    }
-
-    createConvolver() {
-      return new ConvolverNode(this);
-    }
-
-    createDelay(maxDelayTime) {
-      const options = { maxDelayTime };
-      return new DelayNode(this, options);
-    }
-
-    createDynamicsCompressor() {
-      return new DynamicsCompressorNode(this);
-    }
-
-    createGain() {
-      return new GainNode(this);
-    }
-
-    createIIRFilter(feedforward, feedback) {
-      const options = { feedforward, feedback };
-      return new IIRFilterNode(this, options);
-    }
-
-
-    createOscillator() {
-      return new OscillatorNode(this);
-    }
-
-    createPanner() {
-      return new PannerNode(this);
-    }
-
-    createStereoPanner() {
-      return new StereoPannerNode(this);
-    }
-
-    createWaveShaper() {
-      return new WaveShaperNode(this);
-    }
-
-  }
-
-  return BaseAudioContext;
-};
-
-  

package/js/EventTarget.mixin.js

@@ -1,60 +0,0 @@
-const { isFunction } = require('./lib/utils.js');
-
-const kEventListeners = Symbol('node-web-audio-api:event-listeners');
-const kDispatchEvent = Symbol.for('node-web-audio-api:napi-dispatch-event');
-
-module.exports = (superclass, eventTypes = []) => class EventTarget extends superclass {
-  [kEventListeners] = new Map();
-
-  constructor(...args) {
-    super(...args);
-
-    eventTypes.forEach((eventType) => {
-      this[`on${eventType}`] = null;
-    });
-
-    // we need to bind because calling [kDispatchEvent] from rust loose `this`
-    this[kDispatchEvent] = this[kDispatchEvent].bind(this);
-  }
-
-  // instance might
-  addEventListener(eventType, callback) {
-    if (!this[kEventListeners].has(eventType)) {
-      this[kEventListeners].set(eventType, new Set());
-    }
-
-    const callbacks = this[kEventListeners].get(eventType);
-    callbacks.add(callback);
-  }
-
-  removeEventListener(eventType, callback) {
-    // this is valid event eventType, otherwaise just ignore
-    if (this[kEventListeners].has(eventType)) {
-      const callbacks = this[kEventListeners].get(eventType);
-      callbacks.delete(callback);
-    }
-  }
-
-  dispatchEvent(event) {
-    if (isFunction(this[`on${event.type}`])) {
-      this[`on${event.type}`](event);
-    }
-
-    if (this[kEventListeners].has(event.type)) {
-      const callbacks = this[kEventListeners].get(event.type);
-      callbacks.forEach(callback => callback(event));
-    }
-  }
-
-  // called from rust
-  [kDispatchEvent](err, eventType) {
-    const event = new Event(eventType);
-    // cannot override, this would need to derive EventTarget
-    // cf. https://www.nearform.com/blog/node-js-and-the-struggles-of-being-an-eventtarget/
-    // event.target = this;
-    // event.currentTarget = this;
-    // event.srcElement = this;
-
-    this.dispatchEvent(event);
-  }
-};