node-web-audio-api 0.18.0 → 0.20.0

package/js/lib/errors.js

@@ -4,58 +4,6 @@ const path = require('path');
 const internalPath = path.join('node-web-audio-api', 'js');
 const internalRe = new RegExp(internalPath);
 
-// from wpt/resources/tesharness.js (line 2226)
-const nameCodeMap = {
-    IndexSizeError: 1,
-    HierarchyRequestError: 3,
-    WrongDocumentError: 4,
-    InvalidCharacterError: 5,
-    NoModificationAllowedError: 7,
-    NotFoundError: 8,
-    NotSupportedError: 9,
-    InUseAttributeError: 10,
-    InvalidStateError: 11,
-    SyntaxError: 12,
-    InvalidModificationError: 13,
-    NamespaceError: 14,
-    InvalidAccessError: 15,
-    TypeMismatchError: 17,
-    SecurityError: 18,
-    NetworkError: 19,
-    AbortError: 20,
-    URLMismatchError: 21,
-    QuotaExceededError: 22,
-    TimeoutError: 23,
-    InvalidNodeTypeError: 24,
-    DataCloneError: 25,
-
-    EncodingError: 0,
-    NotReadableError: 0,
-    UnknownError: 0,
-    ConstraintError: 0,
-    DataError: 0,
-    TransactionInactiveError: 0,
-    ReadOnlyError: 0,
-    VersionError: 0,
-    OperationError: 0,
-    NotAllowedError: 0,
-    OptOutError: 0
-};
-
-exports.nameCodeMap = nameCodeMap;
-
-
-class DOMException extends Error {
-  constructor(message, name) {
-    super(message);
-
-    this.name = name;
-    this.code = nameCodeMap[this.name];
-  }
-}
-
-exports.DOMException = DOMException;
-
 function overrideStack(originalError, newError) {
   // override previous error message
   const stack = originalError.stack.replace(originalError.message, newError.message);
@@ -87,6 +35,7 @@ exports.throwSanitizedError = function throwSanitizedError(err) {
   if (originalMessage.startsWith('TypeError')) {
     const msg = originalMessage.replace(/^TypeError - /, '');
     const error = new TypeError(msg);
+    overrideStack(err, error);
 
     throw error;
   } else if (originalMessage.startsWith('RangeError')) {
@@ -110,20 +59,26 @@ exports.throwSanitizedError = function throwSanitizedError(err) {
     overrideStack(err, error);
 
     throw error;
-  } if (originalMessage.startsWith('IndexSizeError')) {
+  } else if (originalMessage.startsWith('IndexSizeError')) {
     const msg = originalMessage.replace(/^IndexSizeError - /, '');
     const error = new DOMException(msg, 'IndexSizeError');
     overrideStack(err, error);
 
     throw error;
-  } if (originalMessage.startsWith('InvalidAccessError')) {
+  } else if (originalMessage.startsWith('InvalidAccessError')) {
     const msg = originalMessage.replace(/^InvalidAccessError - /, '');
     const error = new DOMException(msg, 'InvalidAccessError');
     overrideStack(err, error);
 
+    throw error;
+  } else if (originalMessage.startsWith('NotFoundError')) {
+    const msg = originalMessage.replace(/^NotFoundError - /, '');
+    const error = new DOMException(msg, 'NotFoundError');
+    overrideStack(err, error);
+
     throw error;
   }
 
-  console.warn('[lib/errors.js] Possibly unhandled error type', err.message);
+  console.warn('[lib/errors.js] Unexpected Rust error', err);
   throw err;
 }

package/js/lib/events.js

@@ -0,0 +1,10 @@
+const { isFunction } = require('./utils.js');
+
+module.exports.propagateEvent = function propagateEvent(eventTarget, event) {
+  // call attribute first if exists
+  if (isFunction(eventTarget[`on${event.type}`])) {
+    eventTarget[`on${event.type}`](event);
+  }
+  // then distach to add event listeners
+  eventTarget.dispatchEvent(event);
+}

package/js/lib/symbols.js

@@ -0,0 +1,20 @@
+module.exports.kNapiObj = Symbol('node-web-audio-api:napi-obj');
+module.exports.kAudioBuffer = Symbol('node-web-audio-api:audio-buffer');
+
+
+// semi-private keys for events listeners
+
+// # BaseAudioContext
+module.exports.kOnStateChange = Symbol.for('node-web-audio-api:onstatechange');
+// AudioContext
+module.exports.kOnSinkChange = Symbol.for('node-web-audio-api:onsinkchange');
+// # OfflineAudioContext
+// > [The onstatechange] event is fired before the complete event is fired
+// cf. https://webaudio.github.io/web-audio-api/#dom-baseaudiocontext-onstatechange
+// @fixme: for now the `complete` event is triggered **before** startRenring fulfills
+module.exports.kOnComplete = Symbol.for('node-web-audio-api:oncomplete');
+// # AudioScheduledSourceNode
+module.exports.kOnEnded = Symbol.for('node-web-audio-api:onended');
+// # ScriptProcessorNode
+module.exports.kOnAudioProcess = Symbol.for('node-web-audio-api:onaudioprocess');
+

package/js/lib/utils.js

@@ -1,16 +1,16 @@
-exports.isPlainObject = function isPlainObject(obj) {
-  return Object.prototype.toString.call(obj) === '[object Object]';
-};
-
-exports.isPositiveInt = function isPositiveInt(n) {
-  return Number.isSafeInteger(n) && 0 < n;
-};
-
-exports.isPositiveNumber = function isPositiveNumber(n) {
-  return Number(n) === n && 0 < n;
-};
-
 exports.isFunction = function isFunction(val) {
   return Object.prototype.toString.call(val) == '[object Function]' ||
     Object.prototype.toString.call(val) == '[object AsyncFunction]';
 };
+
+const kEnumerableProperty = { __proto__: null };
+kEnumerableProperty.enumerable = true;
+Object.freeze(kEnumerableProperty);
+
+exports.kEnumerableProperty = kEnumerableProperty;
+
+const kHiddenProperty = { __proto__: null };
+kHiddenProperty.enumerable = false;
+Object.freeze(kHiddenProperty);
+
+exports.kHiddenProperty = kHiddenProperty;

package/js/monkey-patch.js

@@ -18,48 +18,60 @@
 // -------------------------------------------------------------------------- //
 
 module.exports = function monkeyPatch(nativeBinding) {
+  let jsExport = {};
+
   // --------------------------------------------------------------------------
-  // Monkey Patch Web Audio API
+  // Events
   // --------------------------------------------------------------------------
+  jsExport.OfflineAudioCompletionEvent = require('./Events').OfflineAudioCompletionEvent;
+  jsExport.AudioProcessingEvent = require('./Events').AudioProcessingEvent;
+  // --------------------------------------------------------------------------
+  // Create Web Audio API facade
+  // --------------------------------------------------------------------------
+  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);
-
-  // @todo - wrap AudioBuffer interface as well
-  nativeBinding.PeriodicWave = require('./PeriodicWave.js')(nativeBinding.PeriodicWave);
+  jsExport.ScriptProcessorNode = require('./ScriptProcessorNode.js')(jsExport, nativeBinding);
+  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);
 
-  nativeBinding.AudioContext = require('./AudioContext.js')(nativeBinding);
-  nativeBinding.OfflineAudioContext = require('./OfflineAudioContext.js')(nativeBinding);
+  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');
 
-  // 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 +80,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.20.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;
-};
-
-
-