node-web-audio-api 0.14.0 → 0.15.0

package/js/WaveShaperNode.js

@@ -0,0 +1,75 @@
+// -------------------------------------------------------------------------- //
+// -------------------------------------------------------------------------- //
+//                                                                            //
+//                                                                            //
+//                                                                            //
+//    ██╗    ██╗ █████╗ ██████╗ ███╗   ██╗██╗███╗   ██╗ ██████╗               //
+//    ██║    ██║██╔══██╗██╔══██╗████╗  ██║██║████╗  ██║██╔════╝               //
+//    ██║ █╗ ██║███████║██████╔╝██╔██╗ ██║██║██╔██╗ ██║██║  ███╗              //
+//    ██║███╗██║██╔══██║██╔══██╗██║╚██╗██║██║██║╚██╗██║██║   ██║              //
+//    ╚███╔███╔╝██║  ██║██║  ██║██║ ╚████║██║██║ ╚████║╚██████╔╝              //
+//     ╚══╝╚══╝ ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═══╝╚═╝╚═╝  ╚═══╝ ╚═════╝               //
+//                                                                            //
+//                                                                            //
+//    - This file has been generated ---------------------------              //
+//                                                                            //
+//                                                                            //
+// -------------------------------------------------------------------------- //
+// -------------------------------------------------------------------------- //
+
+// eslint-disable-next-line no-unused-vars
+const { throwSanitizedError } = require('./lib/errors.js');
+// eslint-disable-next-line no-unused-vars
+const { AudioParam } = require('./AudioParam.js');
+const EventTargetMixin = require('./EventTarget.mixin.js');
+const AudioNodeMixin = require('./AudioNode.mixin.js');
+
+
+module.exports = (NativeWaveShaperNode) => {
+
+  const EventTarget = EventTargetMixin(NativeWaveShaperNode);
+  const AudioNode = AudioNodeMixin(EventTarget);
+
+  class WaveShaperNode extends AudioNode {
+    constructor(context, options) {
+      super(context, options);
+
+    }
+
+    // getters
+
+    get curve() {
+      return super.curve;
+    }
+
+    get oversample() {
+      return super.oversample;
+    }
+
+    // setters
+
+    set curve(value) {
+      try {
+        super.curve = value;
+      } catch (err) {
+        throwSanitizedError(err);
+      }
+    }
+
+    set oversample(value) {
+      try {
+        super.oversample = value;
+      } catch (err) {
+        throwSanitizedError(err);
+      }
+    }
+
+    // methods
+    
+  }
+
+  return WaveShaperNode;
+};
+
+
+  

package/js/lib/errors.js

@@ -0,0 +1,108 @@
+const { EOL } = require('os');
+const path = require('path');
+
+const internalPath = path.join('node-web-audio-api', 'js');
+const internalRe = new RegExp(internalPath);
+
+class NotSupportedError extends Error {
+  constructor(message) {
+    super(message);
+    this.name = 'NotSupportedError';
+  }
+}
+
+class InvalidStateError extends Error {
+  constructor(message) {
+    super(message);
+    this.name = 'InvalidStateError';
+  }
+}
+
+class IndexSizeError extends Error {
+  constructor(message) {
+    super(message);
+    this.name = 'IndexSizeError';
+  }
+}
+
+class InvalidAccessError extends Error {
+  constructor(message) {
+    super(message);
+    this.name = 'InvalidAccessError';
+  }
+}
+
+exports.NotSupportedError = NotSupportedError;
+exports.InvalidStateError = InvalidStateError;
+exports.IndexSizeError = IndexSizeError;
+
+function overrideStack(originalError, newError) {
+  // override previous error message
+  const stack = originalError.stack.replace(originalError.message, newError.message);
+  const lines = stack.split(EOL);
+
+  // remove all lines that refer to internal classes, i.e. contains `node-web-audio-api/js`
+  for (let i = lines.length - 1; i > 0; i--) {
+    const line = lines[i];
+    if (internalRe.test(line)) {
+      lines.splice(i, 1);
+    }
+  }
+
+  // override new stack with modified one
+  newError.stack = lines.join(EOL);
+}
+
+exports.throwSanitizedError = function throwSanitizedError(err) {
+  // We also need to handle output of `assert_ne!` as well, e.g.
+  // assertion `left != right` failed: NotSupportedError - StereoPannerNode channel count mode cannot be set to max
+  //   left: Max
+  //   right: Max
+  let originalMessage = err.message;
+  originalMessage = originalMessage.replace('assertion `left != right` failed: ', '');
+  originalMessage = originalMessage.split(EOL)[0]; // keep only first line
+
+  // "Native Errors"
+  if (originalMessage.startsWith('TypeError')) {
+    const msg = originalMessage.replace(/^TypeError - /, '');
+    const error = new TypeError(msg);
+
+    throw error;
+  } else if (originalMessage.startsWith('RangeError')) {
+    const msg = originalMessage.replace(/^RangeError - /, '');
+    const error = new RangeError(msg);
+    overrideStack(err, error);
+
+    throw error;
+  }
+
+  // "other errors"
+  if (originalMessage.startsWith('NotSupportedError')) {
+    const msg = originalMessage.replace(/^NotSupportedError - /, '');
+    const error = new NotSupportedError(msg);
+    overrideStack(err, error);
+
+    throw error;
+  } else  if (originalMessage.startsWith('InvalidStateError')) {
+    const msg = originalMessage.replace(/^InvalidStateError - /, '');
+    const error = new InvalidStateError(msg);
+    overrideStack(err, error);
+
+    throw error;
+  } if (originalMessage.startsWith('IndexSizeError')) {
+    const msg = originalMessage.replace(/^IndexSizeError - /, '');
+    const error = new IndexSizeError(msg);
+    overrideStack(err, error);
+
+    throw error;
+  } if (originalMessage.startsWith('InvalidAccessError')) {
+    const msg = originalMessage.replace(/^InvalidAccessError - /, '');
+    const error = new InvalidAccessError(msg);
+    overrideStack(err, error);
+
+    throw error;
+  }
+
+  console.warn('[lib/errors.js] Unhandled error type', err.name, err.message);
+  throw err;
+}

package/js/lib/utils.js

@@ -0,0 +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]';
+};

package/js/monkey-patch.js

@@ -0,0 +1,67 @@
+// -------------------------------------------------------------------------- //
+// -------------------------------------------------------------------------- //
+//                                                                            //
+//                                                                            //
+//                                                                            //
+//    ██╗    ██╗ █████╗ ██████╗ ███╗   ██╗██╗███╗   ██╗ ██████╗               //
+//    ██║    ██║██╔══██╗██╔══██╗████╗  ██║██║████╗  ██║██╔════╝               //
+//    ██║ █╗ ██║███████║██████╔╝██╔██╗ ██║██║██╔██╗ ██║██║  ███╗              //
+//    ██║███╗██║██╔══██║██╔══██╗██║╚██╗██║██║██║╚██╗██║██║   ██║              //
+//    ╚███╔███╔╝██║  ██║██║  ██║██║ ╚████║██║██║ ╚████║╚██████╔╝              //
+//     ╚══╝╚══╝ ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═══╝╚═╝╚═╝  ╚═══╝ ╚═════╝               //
+//                                                                            //
+//                                                                            //
+//    - This file has been generated ---------------------------              //
+//                                                                            //
+//                                                                            //
+// -------------------------------------------------------------------------- //
+// -------------------------------------------------------------------------- //
+
+module.exports = function monkeyPatch(nativeBinding) {
+  // --------------------------------------------------------------------------
+  // Monkey Patch Web Audio API
+  // --------------------------------------------------------------------------
+
+  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.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);
+
+  nativeBinding.AudioContext = require('./AudioContext.js')(nativeBinding);
+  nativeBinding.OfflineAudioContext = require('./OfflineAudioContext.js')(nativeBinding);
+
+  // --------------------------------------------------------------------------
+  // Promisify MediaDevices API
+  // --------------------------------------------------------------------------
+  const enumerateDevicesSync = nativeBinding.mediaDevices.enumerateDevices;
+  nativeBinding.mediaDevices.enumerateDevices = async function enumerateDevices() {
+    const list = enumerateDevicesSync();
+    return Promise.resolve(list);
+  };
+
+  const getUserMediaSync = nativeBinding.mediaDevices.getUserMedia;
+  nativeBinding.mediaDevices.getUserMedia = async function getUserMedia(options) {
+    if (options === undefined) {
+      throw new TypeError('Failed to execute "getUserMedia" on "MediaDevices": audio must be requested');
+    }
+
+    const stream = getUserMediaSync(options);
+    return Promise.resolve(stream);
+  };
+
+  return nativeBinding;
+};
+
+
+  

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-web-audio-api",
-  "version": "0.14.0",
+  "version": "0.15.0",
   "author": "Benjamin Matuszewski",
   "description": "Node.js bindings for web-audio-api-rs using napi-rs",
   "exports": {
@@ -38,10 +38,12 @@
     "build:only": "napi build --platform --release",
     "check": "cargo fmt && cargo clippy",
     "generate": "node generator/index.mjs && cargo fmt",
-    "lint": "eslint monkey-patch.js index.cjs index.mjs && eslint examples/*.mjs",
+    "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 bin/check-changelog.mjs",
-    "test": "mocha"
+    "postversion": "cargo bump $npm_package_version && git commit -am \"v$npm_package_version\" && node .scripts/check-changelog.mjs",
+    "test": "mocha",
+    "wpt": "npm run build && node ./.scripts/wpt-harness.mjs",
+    "wpt:only": "node ./.scripts/wpt-harness.mjs"
   },
   "devDependencies": {
     "@ircam/eslint-config": "^1.3.0",
@@ -49,8 +51,9 @@
     "@sindresorhus/slugify": "^2.1.1",
     "camelcase": "^7.0.1",
     "chai": "^4.3.7",
-    "chalk": "^5.2.0",
+    "chalk": "^5.3.0",
     "cli-table": "^0.3.11",
+    "commander": "^11.1.0",
     "dotenv": "^16.0.3",
     "eslint": "^8.32.0",
     "mocha": "^10.2.0",
@@ -59,7 +62,8 @@
     "ping": "^0.4.2",
     "template-literal": "^1.0.4",
     "waves-masters": "^2.3.1",
-    "webidl2": "^24.2.0"
+    "webidl2": "^24.2.0",
+    "wpt-runner": "^5.0.0"
   },
   "dependencies": {
     "@napi-rs/cli": "^2.14.3",

package/monkey-patch.js

@@ -1,184 +0,0 @@
-const fs = require('fs');
-
-const isPlainObject = function(obj) {
-  return Object.prototype.toString.call(obj) === '[object Object]';
-};
-
-const isPositiveInt = function(n) {
-  return Number.isSafeInteger(n) && 0 < n;
-};
-
-const isPositiveNumber = function(n) {
-  return Number(n) === n && 0 < n;
-};
-
-class NotSupportedError extends Error {
-  constructor(message) {
-    super(message);
-    this.name = 'NotSupportedError';
-  }
-}
-
-const { platform, arch } = process;
-
-let contextIds = {
-  audioinput: 0,
-  audiooutput: 0,
-};
-
-let enumerateDevicesSync = null;
-
-function handleDefaultOptions(options, kind) {
-  // increment contextIds as they are used to keep the process awake
-  contextIds[kind] += 1;
-
-  return options;
-}
-
-function patchAudioContext(nativeBinding) {
-  class AudioContext extends nativeBinding.AudioContext {
-    constructor(options = {}) {
-      // special handling of options on linux, these are not spec compliant but are
-      // ment to be more user-friendly than what we have now (is subject to change)
-      options = handleDefaultOptions(options, 'audiooutput');
-      super(options);
-      // prevent garbage collection
-      const processId = `__AudioContext_${contextIds['audiooutput']}`;
-      process[processId] = this;
-
-      Object.defineProperty(this, '__processId', {
-        value: processId,
-        enumerable: false,
-        writable: false,
-        configurable: false,
-      });
-
-      // keep process awake
-      const keepAwakeId = setInterval(() => {}, 10000);
-      Object.defineProperty(this, '__keepAwakeId', {
-        value: keepAwakeId,
-        enumerable: false,
-        writable: true,
-        configurable: false,
-      });
-    }
-
-    // promisify sync APIs
-    resume() {
-      clearTimeout(this.__keepAwakeId);
-      this.__keepAwakeId = setInterval(() => {}, 2000);
-      return Promise.resolve(super.resume());
-    }
-
-    suspend() {
-      return Promise.resolve(super.suspend());
-    }
-
-    close() {
-      delete process[this.__processId];
-      clearTimeout(this.__keepAwakeId);
-      return Promise.resolve(super.close());
-    }
-
-    setSinkId(sinkId) {
-      try {
-        super.setSinkId(sinkId);
-        Promise.resolve(undefined);
-      } catch (err) {
-        Promise.reject(err);
-      }
-    }
-
-    decodeAudioData(audioData) {
-      if (!audioData instanceof ArrayBuffer) {
-        throw new Error('Invalid argument, please provide an ArrayBuffer');
-      }
-      try {
-        const audioBuffer = super.decodeAudioData(audioData);
-        return Promise.resolve(audioBuffer);
-      } catch (err) {
-        return Promise.reject(err);
-      }
-    }
-  }
-
-  return AudioContext;
-}
-
-function patchOfflineAudioContext(nativeBinding) {
-  class OfflineAudioContext extends nativeBinding.OfflineAudioContext {
-    constructor(...args) {
-      // handle initialisation with either an options object or a sequence of parameters
-      // https://webaudio.github.io/web-audio-api/#dom-offlineaudiocontext-constructor-contextoptions-contextoptions
-      if (isPlainObject(args[0])
-          && 'numberOfChannels' in args[0] && 'length' in args[0] && 'sampleRate' in args[0]
-      ) {
-        const { numberOfChannels, length, sampleRate } = args[0];
-        args = [numberOfChannels, length, sampleRate];
-      }
-
-      const [numberOfChannels, length, sampleRate] = args;
-
-      if (!isPositiveInt(numberOfChannels)) {
-        throw new NotSupportedError(`Unsupported value for numberOfChannels: ${numberOfChannels}`);
-      } else if (!isPositiveInt(length)) {
-        throw new NotSupportedError(`Unsupported value for length: ${length}`);
-      } else if (!isPositiveNumber(sampleRate)) {
-        throw new NotSupportedError(`Unsupported value for sampleRate: ${sampleRate}`);
-      }
-
-      super(numberOfChannels, length, sampleRate);
-    }
-
-    // promisify sync APIs
-    startRendering() {
-      try {
-        const audioBuffer = super.startRendering();
-
-        clearTimeout(this.__keepAwakeId);
-        return Promise.resolve(audioBuffer);
-      } catch (err) {
-        return Promise.reject(err);
-      }
-    }
-
-    decodeAudioData(audioData) {
-      if (!audioData instanceof ArrayBuffer) {
-        throw new Error('Invalid argument, please provide an ArrayBuffer');
-      }
-      try {
-        const audioBuffer = super.decodeAudioData(audioData);
-        return Promise.resolve(audioBuffer);
-      } catch (err) {
-        return Promise.reject(err);
-      }
-    }
-  }
-
-  return OfflineAudioContext;
-}
-
-module.exports = function monkeyPatch(nativeBinding) {
-  nativeBinding.AudioContext = patchAudioContext(nativeBinding);
-  nativeBinding.OfflineAudioContext = patchOfflineAudioContext(nativeBinding);
-
-  // Promisify MediaDevices API
-  enumerateDevicesSync = nativeBinding.mediaDevices.enumerateDevices;
-  nativeBinding.mediaDevices.enumerateDevices = async function enumerateDevices(options) {
-    const list = enumerateDevicesSync();
-    return Promise.resolve(list);
-  }
-
-  const getUserMediaSync = nativeBinding.mediaDevices.getUserMedia;
-  nativeBinding.mediaDevices.getUserMedia = async function getUserMedia(options) {
-    if (options === undefined) {
-      throw new TypeError("Failed to execute 'getUserMedia' on 'MediaDevices': audio must be requested")
-    }
-
-    options = handleDefaultOptions(options, 'audioinput');
-    const stream = getUserMediaSync(options);
-    return Promise.resolve(stream);
-  }
-
-  return nativeBinding;
-}