node-web-audio-api 0.19.0 → 0.21.0

package/js/BaseAudioContext.js

@@ -24,12 +24,16 @@ const {
 } = require('./lib/utils.js');
 const {
   kNapiObj,
+  kPrivateConstructor,
 } = require('./lib/symbols.js');
 
+const AudioWorklet = require('./AudioWorklet.js');
+
 module.exports = (jsExport, _nativeBinding) => {
   class BaseAudioContext extends EventTarget {
-    #listener = null;
+    #audioWorklet = null;
     #destination = null;
+    #listener = null;
 
     constructor(options) {
       // Make constructor "private"
@@ -47,24 +51,23 @@ module.exports = (jsExport, _nativeBinding) => {
         ...kHiddenProperty,
       });
 
-      this.#listener = null; // lazily instanciated
+      this.#audioWorklet = new AudioWorklet({
+        [kPrivateConstructor]: true,
+        workletId: this[kNapiObj].workletId,
+        sampleRate: this[kNapiObj].sampleRate,
+      });
+
       this.#destination = new jsExport.AudioDestinationNode(this, {
         [kNapiObj]: this[kNapiObj].destination,
       });
     }
 
-    get listener() {
+    get audioWorklet() {
       if (!(this instanceof BaseAudioContext)) {
         throw new TypeError('Invalid Invocation: Value of \'this\' must be of type \'BaseAudioContext\'');
       }
 
-      if (this.#listener === null) {
-        this.#listener = new jsExport.AudioListener({
-          [kNapiObj]: this[kNapiObj].listener,
-        });
-      }
-
-      return this.#listener;
+      return this.#audioWorklet;
     }
 
     get destination() {
@@ -75,6 +78,20 @@ module.exports = (jsExport, _nativeBinding) => {
       return this.#destination;
     }
 
+    get listener() {
+      if (!(this instanceof BaseAudioContext)) {
+        throw new TypeError('Invalid Invocation: Value of \'this\' must be of type \'BaseAudioContext\'');
+      }
+
+      if (this.#listener === null) {
+        this.#listener = new jsExport.AudioListener({
+          [kNapiObj]: this[kNapiObj].listener,
+        });
+      }
+
+      return this.#listener;
+    }
+
     get sampleRate() {
       if (!(this instanceof BaseAudioContext)) {
         throw new TypeError('Invalid Invocation: Value of \'this\' must be of type \'BaseAudioContext\'');
@@ -91,6 +108,15 @@ module.exports = (jsExport, _nativeBinding) => {
       return this[kNapiObj].currentTime;
     }
 
+    // @todo - implement in upstream crate + pass to AudioWorkletGlobalScope
+    // get renderQuantumSize() {
+    //   if (!(this instanceof BaseAudioContext)) {
+    //     throw new TypeError("Invalid Invocation: Value of 'this' must be of type 'BaseAudioContext'");
+    //   }
+
+    //   return this[kNapiObj].renderQuantumSize;
+    // }
+
     get state() {
       if (!(this instanceof BaseAudioContext)) {
         throw new TypeError('Invalid Invocation: Value of \'this\' must be of type \'BaseAudioContext\'');
@@ -99,9 +125,6 @@ module.exports = (jsExport, _nativeBinding) => {
       return this[kNapiObj].state;
     }
 
-    // renderQuantumSize
-    // audioWorklet
-
     get onstatechange() {
       if (!(this instanceof BaseAudioContext)) {
         throw new TypeError('Invalid Invocation: Value of \'this\' must be of type \'BaseAudioContext\'');
@@ -210,6 +233,20 @@ module.exports = (jsExport, _nativeBinding) => {
     // --------------------------------------------------------------------
     // Factory Methods (use the patched AudioNodes)
     // --------------------------------------------------------------------
+    createScriptProcessor(bufferSize = 0, numberOfInputChannels = 2, numberOfOutputChannels = 2) {
+      if (!(this instanceof BaseAudioContext)) {
+        throw new TypeError('Invalid Invocation: Value of \'this\' must be of type \'BaseAudioContext\'');
+      }
+
+      const options = {
+        bufferSize,
+        numberOfInputChannels,
+        numberOfOutputChannels,
+      };
+
+      return new jsExport.ScriptProcessorNode(this, options);
+    }
+
     createAnalyser() {
       if (!(this instanceof BaseAudioContext)) {
         throw new TypeError('Invalid Invocation: Value of \'this\' must be of type \'BaseAudioContext\'');
@@ -389,6 +426,7 @@ module.exports = (jsExport, _nativeBinding) => {
       configurable: true,
       value: 'BaseAudioContext',
     },
+    createScriptProcessor: kEnumerableProperty,
     createAnalyser: kEnumerableProperty,
     createBufferSource: kEnumerableProperty,
     createBiquadFilter: kEnumerableProperty,

package/js/BiquadFilterNode.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/ChannelMergerNode.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/ChannelSplitterNode.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/ConstantSourceNode.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');
@@ -82,9 +79,6 @@ module.exports = (jsExport, nativeBinding) => {
         [kNapiObj]: napiObj,
       });
 
-      // Bridge Rust native event to Node EventTarget
-      bridgeEventTarget(this);
-
       this.#offset = new jsExport.AudioParam({
         [kNapiObj]: this[kNapiObj].offset,
       });

package/js/ConvolverNode.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/DelayNode.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/DynamicsCompressorNode.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/Events.js

@@ -0,0 +1,230 @@
+const { kEnumerableProperty } = require('./lib/utils.js');
+
+class OfflineAudioCompletionEvent extends Event {
+  #renderedBuffer = null;
+
+  constructor(type, eventInitDict) {
+    super(type);
+
+    if (
+      typeof eventInitDict !== 'object'
+      || eventInitDict === null
+      || !('renderedBuffer' in eventInitDict)
+    ) {
+      throw TypeError(`Failed to construct 'OfflineAudioCompletionEvent': Invalid 'OfflineAudioCompletionEventInit' dict given`);
+    }
+
+    this.#renderedBuffer = eventInitDict.renderedBuffer;
+  }
+
+  get renderedBuffer() {
+    return this.#renderedBuffer;
+  }
+}
+
+Object.defineProperties(OfflineAudioCompletionEvent.prototype, {
+  [Symbol.toStringTag]: {
+    __proto__: null,
+    writable: false,
+    enumerable: false,
+    configurable: true,
+    value: 'OfflineAudioCompletionEvent',
+  },
+  renderedBuffer: kEnumerableProperty,
+});
+
+class AudioProcessingEvent extends Event {
+  #playbackTime = null;
+  #inputBuffer = null;
+  #outputBuffer = null;
+
+  constructor(type, eventInitDict) {
+    if (
+      typeof eventInitDict !== 'object'
+      || eventInitDict === null
+      || !('playbackTime' in eventInitDict)
+      || !('inputBuffer' in eventInitDict)
+      || !('outputBuffer' in eventInitDict)
+    ) {
+      throw TypeError(`Failed to construct 'AudioProcessingEvent': Invalid 'AudioProcessingEventInit' dict given`);
+    }
+
+    super(type);
+
+    this.#playbackTime = eventInitDict.playbackTime;
+    this.#inputBuffer = eventInitDict.inputBuffer;
+    this.#outputBuffer = eventInitDict.outputBuffer;
+  }
+
+  get playbackTime() {
+    return this.#playbackTime;
+  }
+
+  get inputBuffer() {
+    return this.#inputBuffer;
+  }
+
+  get outputBuffer() {
+    return this.#outputBuffer;
+  }
+}
+
+Object.defineProperties(AudioProcessingEvent.prototype, {
+  [Symbol.toStringTag]: {
+    __proto__: null,
+    writable: false,
+    enumerable: false,
+    configurable: true,
+    value: 'AudioProcessingEvent',
+  },
+  playbackTime: kEnumerableProperty,
+  inputBuffer: kEnumerableProperty,
+  outputBuffer: kEnumerableProperty,
+});
+
+class AudioRenderCapacityEvent extends Event {
+  #timestamp = 0;
+  #averageLoad = 0;
+  #peakLoad = 0;
+  #underrunRatio = 0;
+
+  constructor(type, eventInitDict) {
+    if (
+      typeof eventInitDict !== 'object'
+      || eventInitDict === null
+      || !('timestamp' in eventInitDict)
+      || !('averageLoad' in eventInitDict)
+      || !('peakLoad' in eventInitDict)
+      || !('underrunRatio' in eventInitDict)
+    ) {
+      throw TypeError(`Failed to construct 'AudioRenderCapacityEvent': Invalid 'AudioRenderCapacityEventInit' dict given`);
+    }
+
+    super(type);
+
+    this.#timestamp = eventInitDict.timestamp;
+    this.#averageLoad = eventInitDict.averageLoad;
+    this.#peakLoad = eventInitDict.peakLoad;
+    this.#underrunRatio = eventInitDict.underrunRatio;
+  }
+
+  get timestamp() {
+    return this.#timestamp;
+  }
+
+  get averageLoad() {
+    return this.#averageLoad;
+  }
+
+  get peakLoad() {
+    return this.#peakLoad;
+  }
+
+  get underrunRatio() {
+    return this.#underrunRatio;
+  }
+}
+
+Object.defineProperties(AudioRenderCapacityEvent.prototype, {
+  [Symbol.toStringTag]: {
+    __proto__: null,
+    writable: false,
+    enumerable: false,
+    configurable: true,
+    value: 'AudioRenderCapacityEvent',
+  },
+  timestamp: kEnumerableProperty,
+  averageLoad: kEnumerableProperty,
+  peakLoad: kEnumerableProperty,
+  underrunRatio: kEnumerableProperty,
+});
+
+// https://html.spec.whatwg.org/multipage/webappapis.html#errorevent
+// interface ErrorEvent : Event {
+//   constructor(DOMString type, optional ErrorEventInit eventInitDict = {});
+
+//   readonly attribute DOMString message;
+//   readonly attribute USVString filename;
+//   readonly attribute unsigned long lineno;
+//   readonly attribute unsigned long colno;
+//   readonly attribute any error;
+// };
+
+// dictionary ErrorEventInit : EventInit {
+//   DOMString message = "";
+//   USVString filename = "";
+//   unsigned long lineno = 0;
+//   unsigned long colno = 0;
+//   any error;
+// };
+class ErrorEvent extends Event {
+  #message = '';
+  #filename = '';
+  #lineno = 0;
+  #colno = 0;
+  #error = undefined;
+
+  constructor(type, eventInitDict = {}) {
+    super(type);
+
+    if (eventInitDict && typeof eventInitDict.message === 'string') {
+      this.#message = eventInitDict.message;
+    }
+
+    if (eventInitDict && typeof eventInitDict.filename === 'string') {
+      this.#filename = eventInitDict.filename;
+    }
+
+    if (eventInitDict && Number.isFinite(eventInitDict.lineno)) {
+      this.#lineno = eventInitDict.lineno;
+    }
+
+    if (eventInitDict && Number.isFinite(eventInitDict.colno)) {
+      this.#colno = eventInitDict.colno;
+    }
+
+    if (eventInitDict && eventInitDict.error instanceof Error) {
+      this.#error = eventInitDict.error;
+    }
+  }
+
+  get message() {
+    return this.#message;
+  }
+
+  get filename() {
+    return this.#filename;
+  }
+
+  get lineno() {
+    return this.#lineno;
+  }
+
+  get colno() {
+    return this.#colno;
+  }
+
+  get error() {
+    return this.#error;
+  }
+}
+
+Object.defineProperties(ErrorEvent.prototype, {
+  [Symbol.toStringTag]: {
+    __proto__: null,
+    writable: false,
+    enumerable: false,
+    configurable: true,
+    value: 'ErrorEvent',
+  },
+  message: kEnumerableProperty,
+  filename: kEnumerableProperty,
+  lineno: kEnumerableProperty,
+  colno: kEnumerableProperty,
+  error: kEnumerableProperty,
+});
+
+module.exports.OfflineAudioCompletionEvent = OfflineAudioCompletionEvent;
+module.exports.AudioProcessingEvent = AudioProcessingEvent;
+module.exports.AudioRenderCapacityEvent = AudioRenderCapacityEvent;
+module.exports.ErrorEvent = ErrorEvent;

package/js/GainNode.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/IIRFilterNode.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/MediaStreamAudioSourceNode.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/OfflineAudioContext.js

@@ -1,7 +1,7 @@
 const conversions = require('webidl-conversions');
 
 const {
-  bridgeEventTarget,
+  propagateEvent,
 } = require('./lib/events.js');
 const {
   throwSanitizedError,
@@ -11,19 +11,17 @@ const {
   kEnumerableProperty,
 } = require('./lib/utils.js');
 const {
-  kNapiObj
+  kNapiObj,
+  kWorkletRelease,
+  kOnStateChange,
+  kOnComplete,
+  kCheckProcessorsCreated,
 } = require('./lib/symbols.js');
 
-// constructor(OfflineAudioContextOptions contextOptions);
-// constructor(unsigned long numberOfChannels, unsigned long length, float sampleRate);
-// Promise<AudioBuffer> startRendering();
-// Promise<undefined> resume();
-// Promise<undefined> suspend(double suspendTime);
-// readonly attribute unsigned long length;
-// attribute EventHandler oncomplete;
-
 module.exports = function patchOfflineAudioContext(jsExport, nativeBinding) {
   class OfflineAudioContext extends jsExport.BaseAudioContext {
+    #renderedBuffer = null;
+
     constructor(...args) {
       if (arguments.length < 1) {
         throw new TypeError(`Failed to construct 'OfflineAudioContext': 1 argument required, but only ${arguments.length} present`);
@@ -52,7 +50,7 @@ module.exports = function patchOfflineAudioContext(jsExport, nativeBinding) {
         args = [
           options.numberOfChannels,
           options.length,
-          options.sampleRate
+          options.sampleRate,
         ];
       }
 
@@ -60,16 +58,16 @@ module.exports = function patchOfflineAudioContext(jsExport, nativeBinding) {
 
       numberOfChannels = conversions['unsigned long'](numberOfChannels, {
         enforceRange: true,
-        context: `Failed to construct 'OfflineAudioContext': Failed to read the 'numberOfChannels' property from OfflineContextOptions; The provided value (${numberOfChannels})`
+        context: `Failed to construct 'OfflineAudioContext': Failed to read the 'numberOfChannels' property from OfflineContextOptions; The provided value (${numberOfChannels})`,
       });
 
       length = conversions['unsigned long'](length, {
         enforceRange: true,
-        context: `Failed to construct 'OfflineAudioContext': Failed to read the 'length' property from OfflineContextOptions; The provided value (${length})`
+        context: `Failed to construct 'OfflineAudioContext': Failed to read the 'length' property from OfflineContextOptions; The provided value (${length})`,
       });
 
       sampleRate = conversions['float'](sampleRate, {
-        context: `Failed to construct 'OfflineAudioContext': Failed to read the 'sampleRate' property from OfflineContextOptions; The provided value (${sampleRate})`
+        context: `Failed to construct 'OfflineAudioContext': Failed to read the 'sampleRate' property from OfflineContextOptions; The provided value (${sampleRate})`,
       });
 
       let napiObj;
@@ -81,11 +79,41 @@ module.exports = function patchOfflineAudioContext(jsExport, nativeBinding) {
       }
 
       super({ [kNapiObj]: napiObj });
+
+      // Add function to Napi object to bridge from Rust events to JS EventTarget
+      // They will be effectively registered on rust side when `startRendering` is called
+      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 event is, per spec, the last trigerred one
+      this[kNapiObj][kOnComplete] = (err, rawEvent) => {
+        if (typeof rawEvent !== 'object' && !('type' in rawEvent)) {
+          throw new TypeError('Invalid [kOnComplete] Invocation: rawEvent should have a type property');
+        }
+
+        // @fixme: workaround the fact that this event seems to be triggered before
+        // startRendering fulfills and that we want to return the exact same instance
+        if (this.#renderedBuffer === null) {
+          this.#renderedBuffer = new jsExport.AudioBuffer({ [kNapiObj]: rawEvent.renderedBuffer });
+        }
+
+        const event = new jsExport.OfflineAudioCompletionEvent(rawEvent.type, {
+          renderedBuffer: this.#renderedBuffer,
+        });
+
+        propagateEvent(this, event);
+      };
     }
 
     get length() {
       if (!(this instanceof OfflineAudioContext)) {
-        throw new TypeError("Invalid Invocation: Value of 'this' must be of type 'OfflineAudioContext'");
+        throw new TypeError(`Invalid Invocation: Value of 'this' must be of type 'OfflineAudioContext'`);
       }
 
       return this[kNapiObj].length;
@@ -93,7 +121,7 @@ module.exports = function patchOfflineAudioContext(jsExport, nativeBinding) {
 
     get oncomplete() {
       if (!(this instanceof OfflineAudioContext)) {
-        throw new TypeError("Invalid Invocation: Value of 'this' must be of type 'OfflineAudioContext'");
+        throw new TypeError(`Invalid Invocation: Value of 'this' must be of type 'OfflineAudioContext'`);
       }
 
       return this._complete || null;
@@ -101,7 +129,7 @@ module.exports = function patchOfflineAudioContext(jsExport, nativeBinding) {
 
     set oncomplete(value) {
       if (!(this instanceof OfflineAudioContext)) {
-        throw new TypeError("Invalid Invocation: Value of 'this' must be of type 'OfflineAudioContext'");
+        throw new TypeError(`Invalid Invocation: Value of 'this' must be of type 'OfflineAudioContext'`);
       }
 
       if (isFunction(value) || value === null) {
@@ -111,11 +139,11 @@ module.exports = function patchOfflineAudioContext(jsExport, nativeBinding) {
 
     async startRendering() {
       if (!(this instanceof OfflineAudioContext)) {
-        throw new TypeError("Invalid Invocation: Value of 'this' must be of type 'OfflineAudioContext'");
+        throw new TypeError(`Invalid Invocation: Value of 'this' must be of type 'OfflineAudioContext'`);
       }
 
-      // Lazily register event callback on rust side
-      bridgeEventTarget(this);
+      // ensure all AudioWorkletProcessor have finished their instanciation
+      await this.audioWorklet[kCheckProcessorsCreated]();
 
       let nativeAudioBuffer;
 
@@ -125,26 +153,21 @@ module.exports = function patchOfflineAudioContext(jsExport, nativeBinding) {
         throwSanitizedError(err);
       }
 
-      const audioBuffer = new jsExport.AudioBuffer({ [kNapiObj]: nativeAudioBuffer });
-
-      // We dispatch the complete event manually to simplify the sharing of the
-      // `AudioBuffer` instance. This also simplifies code on the rust side as
-      // we don't need to deal with the `OfflineAudioCompletionEvent` type.
-      const event = new Event('complete');
-      event.renderedBuffer = audioBuffer;
+      // release audio worklet, if any
+      await this.audioWorklet[kWorkletRelease]();
 
-      if (isFunction(this[`oncomplete`])) {
-        this[`oncomplete`](event);
+      // workaround the fact that this event seems to be triggered before
+      // startRendering fulfills and that we want to return the exact same instance
+      if (this.#renderedBuffer === null) {
+        this.#renderedBuffer = new jsExport.AudioBuffer({ [kNapiObj]: nativeAudioBuffer });
       }
 
-      this.dispatchEvent(event);
-
-      return audioBuffer;
+      return this.#renderedBuffer;
     }
 
     async resume() {
       if (!(this instanceof OfflineAudioContext)) {
-        throw new TypeError("Invalid Invocation: Value of 'this' must be of type 'OfflineAudioContext'");
+        throw new TypeError(`Invalid Invocation: Value of 'this' must be of type 'OfflineAudioContext'`);
       }
 
       try {
@@ -156,7 +179,7 @@ module.exports = function patchOfflineAudioContext(jsExport, nativeBinding) {
 
     async suspend(suspendTime) {
       if (!(this instanceof OfflineAudioContext)) {
-        throw new TypeError("Invalid Invocation: Value of 'this' must be of type 'OfflineAudioContext'");
+        throw new TypeError(`Invalid Invocation: Value of 'this' must be of type 'OfflineAudioContext'`);
       }
 
       if (arguments.length < 1) {

package/js/OscillatorNode.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');
@@ -140,9 +137,6 @@ module.exports = (jsExport, nativeBinding) => {
         [kNapiObj]: napiObj,
       });
 
-      // Bridge Rust native event to Node EventTarget
-      bridgeEventTarget(this);
-
       this.#frequency = new jsExport.AudioParam({
         [kNapiObj]: this[kNapiObj].frequency,
       });

package/js/PannerNode.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');