node-web-audio-api 0.20.0 → 0.21.0

package/load-native.cjs

@@ -0,0 +1,87 @@
+const { platform, arch } = process;
+
+let nativeBinding = null;
+let loadError = null;
+
+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}`);
+}
+
+if (!nativeBinding) {
+  if (loadError) {
+    throw loadError;
+  }
+
+  throw new Error(`Failed to load native binding for OS: ${platform}, architecture: ${arch}`);
+}
+
+module.exports = nativeBinding;
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-web-audio-api",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "author": "Benjamin Matuszewski",
   "description": "Node.js bindings for web-audio-api-rs using napi-rs",
   "exports": {
@@ -73,6 +73,8 @@
   "dependencies": {
     "@napi-rs/cli": "^2.14.3",
     "@node-rs/helper": "^1.3.3",
+    "caller": "^1.1.0",
+    "node-fetch": "^3.3.2",
     "webidl-conversions": "^7.0.0"
   }
 }

package/TODOS.md

@@ -1,143 +0,0 @@
-# TODO
-
-## MISC
-
-- [x] decode audio data in dedicated thread
-- [x] Use node DOMExeption <https://nodejs.org/api/globals.html#domexception>
-- [x] connect / disconnect
-- [x] _napi_ review tsfn store implementation _or remove_
-- [x] implement ScriptProcesorNode _on going_
-- [x] _napi_ clean internal audio_buffer __internal_caller__, use JsNull instead
-- [x] Refactor Events:
-    + [x] extend Event for all specific event types
-    + [x] Register AudioScheduledSourceNode listener only on start
-    
-- [ ] reuse event objects across calls
-
--> proxy EventListener
-    
-- [ ] wpt: mock for `URL.createObjectURL`
-- [ ] wpt: mock for `requestAnimationFrame` cf. https://github.com/nodejs/help/issues/2483
-- [ ] make sure we don't try to use `in` operator on null values
-
-- [ ] _rust_ AudioParam failing tests
-- [ ] _rust_ AudioBufferSourceNode failing tests
-- [ ] _rust_ IIRFilter node
-
-- [ ] refactor - Add context string in `throwSanitizedError` and to `toSanitizedSequence`
-- [ ] Rust - review Symbol.toStringTag https://github.com/nodejs/node/issues/41358
-      cf. https://github.com/nodejs/node/issues/41358#issuecomment-1003595890
-```
-// fails...
-let symbols = ctx
-    .env
-    .get_global()?
-    .get_named_property::<JsUnknown>("Symbol")?
-    .coerce_to_object()?;
-let to_string_tag = symbols.get_named_property("toStringTag")?;
-
-js_this.set_property(to_string_tag, &ctx.env.create_string("AudioContext")?);
-
-// ----
-151 |     js_this.set_property(to_string_tag, &ctx.env.create_string("AudioContext")?);
-    |             ------------ ^^^^^^^^^^^^^ the trait `napi::NapiRaw` is not implemented for `()`
-```
-
-- [ ] wpt bot
-- [ ] wpt - handle loading of 4-channels sound file
-
-- [ ] _rust_ decodeAudioData should throw EncodingError
-      - review JS side when done
-
-- [-] AnalyserNode -> requires script processor and request animation frame
-
-- [x] DelayNode
-- [x] protect AudioBuffer arguments
-- [x] AudioNode setters (handle enum types, cf audio param too)
-- [x] This is weird `jsExport.AudioBuffer = require('./AudioBuffer.js').AudioBuffer(nativeBinding.AudioBuffer);`
-- [x] Ended event in AudioScheduledSourceNode for offline audio context
-
-- cf. util.types.isSharedArrayBuffer(value)
-
-## Notes
-
-- wpt/webaudio/the-audio-api/the-dynamicscompressornode-interface/dynamicscompressor-basic.html sometimes pass, sometimes fail because audio context is resumed
-
-------------------------------------------------------------------------
-
-## `onstatechnage` and `onsinkchange`
-
-### https://webaudio.github.io/web-audio-api/#eventdef-baseaudiocontext-statechange
- 
-> A newly-created AudioContext will always begin in the suspended state, and a state change event will be fired whenever the state changes to a different state. This event is fired before the complete event is fired.
-
-### https://webaudio.github.io/web-audio-api/#dom-audiocontext-onsinkchange
-  
-> NOTE: This is not dispatched for the initial device selection in the construction of AudioContext. The statechange event is available to check the readiness of the initial output device.
-
-cf. the-audiocontext-interface/audiocontext-sinkid-state-change.https.html
-
-### Notes
-
-We should explicitly resume context at startup, just as a context created in a console or localhost
-
-What happens when sinkId is changed while context is suspended? It seems that it is resumed:
-
-```rs
-Startup { graph } => {
-    debug_assert!(self.graph.is_none());
-    self.graph = Some(graph);
-    self.set_state(AudioContextState::Running);
-}
-```
-
-@todo - create a test bed
-
-- testing AudioContextOptions.sinkId requires this fix
-  the-audiocontext-interface/audiocontext-sinkid-constructor.https.html
-- setting sink on supended audioContext test too
-  the-audiocontext-interface/audiocontext-sinkid-state-change.https.html
-
-------------------------------------------------------------------------
-
-## Issue in spec / wpt
-
-- [ ] review waveshaper curve (need to be able to set back to null) 
-    <https://webaudio.github.io/web-audio-api/#dom-waveshapernode-curve>
-    To set the curve attribute, execute these steps:
-    - Let new curve be a Float32Array to be assigned to curve or null. .
-    - If new curve is not null and [[curve set]] is true, throw an InvalidStateError and abort these steps.
-    - If new curve is not null, set [[curve set]] to true.
-    - Assign new curve to the curve attribute.
-    
-    -> Spec is not inline with wpt tests, both chrome and firefox accept setting curve several times (which makes sens...), without passing to null first
-    -> Curve defined as sequence<float> in arguments but as Float32Array in attributes
-    -> Means that we can't pass non finite values in ctor but we can with setter
-
-- [ ] AudioDestination::numberOfOutputs
-    - implementation and wpt report 0
-      cf. webaudio/the-audio-api/the-audionode-interface/audionode.html
-    - spec specifies 1: https://webaudio.github.io/web-audio-api/#AudioDestinationNode
-    
-- [ ] Analyser::fftSize
-    - wpt defines that when set to -1 it should throw an IndexSizeError, when not a type error as it is defined as unsigned long?
-    cf. the-analysernode-interface/realtimeanalyser-fft-sizing.html
-    cf. https://webidl.spec.whatwg.org/#js-attributes
-        setter step 4.6
-    - same with getChannelData
-    
-- [ ] wpt - propose patch to remove patch regarding `audiobuffersource-multi-channels-expected.wav`in XMLHttpRequest Mock
-
-- [ ] Propose a test for decodeAudioData
-      "Let error be a DOMException whose name is EncodingError."
-
-- [ ] ScriptProcessorNode rehabilitation
-    - padenot mail vs spec
-
-------------------------------------------------------------------------
-
-ls wpt/webaudio/the-audio-api/the-audiocontext-interface | xargs -I {} ./run-wpt.sh {} 
-ls wpt/webaudio/the-audio-api/the-dynamicscompressornode-interface | xargs -I {} ./run-wpt.sh {} 
-
-
-971

package/js/monkey-patch.js

@@ -1,84 +0,0 @@
-// -------------------------------------------------------------------------- //
-// -------------------------------------------------------------------------- //
-//                                                                            //
-//                                                                            //
-//                                                                            //
-//    ██╗    ██╗ █████╗ ██████╗ ███╗   ██╗██╗███╗   ██╗ ██████╗               //
-//    ██║    ██║██╔══██╗██╔══██╗████╗  ██║██║████╗  ██║██╔════╝               //
-//    ██║ █╗ ██║███████║██████╔╝██╔██╗ ██║██║██╔██╗ ██║██║  ███╗              //
-//    ██║███╗██║██╔══██║██╔══██╗██║╚██╗██║██║██║╚██╗██║██║   ██║              //
-//    ╚███╔███╔╝██║  ██║██║  ██║██║ ╚████║██║██║ ╚████║╚██████╔╝              //
-//     ╚══╝╚══╝ ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═══╝╚═╝╚═╝  ╚═══╝ ╚═════╝               //
-//                                                                            //
-//                                                                            //
-//    - This file has been generated ---------------------------              //
-//                                                                            //
-//                                                                            //
-// -------------------------------------------------------------------------- //
-// -------------------------------------------------------------------------- //
-
-module.exports = function monkeyPatch(nativeBinding) {
-  let jsExport = {};
-
-  // --------------------------------------------------------------------------
-  // 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);
-
-  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);
-
-  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');
-
-  jsExport.PeriodicWave = require('./PeriodicWave.js')(jsExport, nativeBinding);
-  jsExport.AudioBuffer = require('./AudioBuffer.js')(jsExport, nativeBinding);
-
-  // --------------------------------------------------------------------------
-  // Promisify MediaDevices API
-  // --------------------------------------------------------------------------
-  jsExport.mediaDevices = {};
-
-  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');
-    }
-
-    const stream = getUserMediaSync(options);
-    return Promise.resolve(stream);
-  };
-
-  return jsExport;
-};

package/run-wpt.md

@@ -1,27 +0,0 @@
-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/simple-test.cjs

@@ -1,20 +0,0 @@
-const { AudioContext, mediaDevices } = require('./index.cjs');
-
-const audioContext = new AudioContext();
-
-setInterval(() => {
-  const now = audioContext.currentTime;
-
-  const env = audioContext.createGain();
-  env.connect(audioContext.destination);
-  env.gain.value = 0;
-  env.gain.setValueAtTime(0, now);
-  env.gain.linearRampToValueAtTime(0.1, now + 0.02);
-  env.gain.exponentialRampToValueAtTime(0.0001, now + 1);
-
-  const osc = audioContext.createOscillator();
-  osc.frequency.value = 200 + Math.random() * 2800;
-  osc.connect(env);
-  osc.start(now);
-  osc.stop(now + 1);
-}, 100);

package/simple-test.mjs

@@ -1,20 +0,0 @@
-import { AudioContext, mediaDevices } from './index.mjs';
-
-const audioContext = new AudioContext();
-
-setInterval(() => {
-  const now = audioContext.currentTime;
-
-  const env = audioContext.createGain();
-  env.connect(audioContext.destination);
-  env.gain.value = 0;
-  env.gain.setValueAtTime(0, now);
-  env.gain.linearRampToValueAtTime(0.1, now + 0.02);
-  env.gain.exponentialRampToValueAtTime(0.0001, now + 1);
-
-  const osc = audioContext.createOscillator();
-  osc.frequency.value = 200 + Math.random() * 2800;
-  osc.connect(env);
-  osc.start(now);
-  osc.stop(now + 1);
-}, 100);