node-web-audio-api 0.8.0 → 0.10.0

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## v0.10.0
+
+- Update upstream crate to v0.31
+
+## v0.9.0
+
+- Update upstream crate to v0.30
+
 ## v0.8.0
 
 - Implement MediaDevices enumerateDeviaces and getUserMedia

package/README.md

@@ -64,11 +64,11 @@ npm run build
 node examples/granular-scrub.mjs
 ```
 
+If
+
 ## Caveats
 
 - The async methods are not trully async for now and are just patched on the JS side. This will evolve once the "trully" async version of the methods are implemented in the upstream library.
-- On Linux systems, the audio backend is currently Alsa, which limits the number of online `AudioContext` to 1. This is subject to change in the future.
-- On Raspberry Pi, the default render quantum size (128) is too small and underruns occurs frequently. To prevent that, if you do not explicitely provide a latency hint in the AudioContext options, the value is automatically set to 'playback' which uses a buffer of 1024 samples (~21ms at 48000Hz). While this is not per se spec compliant, it allows usage of the library in a more user friendly manner. In the future, this might change according to the support of other audio backend.
 - On Raspberry Pi, the `Linux arm gnueabihf` binary provided only works on 32bit OS. We will provide a version for the 64 bit OS in the future.
 
 ## Supported Platforms
@@ -83,6 +83,22 @@ node examples/granular-scrub.mjs
 | Linux arm gnueabihf (RPi)    | ✓        | ✓      |
 
 
+## Notes for Linux users
+
+Using the library on Linux with the ALSA backend might lead to unexpected cranky sound with the default render size (i.e. 128 frames). In such cases, a simple workaround is to pass the `playback` latency hint when creating the audio context, which will increase the render size to 1024 frames:
+
+```js
+const audioContext = new AudioContext({ latencyHint: 'playback' });
+```
+
+You can pass the `WEB_AUDIO_LATENCY=playback` env variable to all examples to create the audio context with the playback latency hint, e.g.:
+
+```sh
+WEB_AUDIO_LATENCY=playback node examples/amplitude-modulation.mjs
+```
+
+For real-time and interactive applications where low latency is crucial, you should instead rely on the JACK backend provided by `cpal`. By default the audio context will use that backend if a running JACK server is found.
+
 ### Manual Build
 
 If prebuilt binaries are not shippped for your platform, you will need to:
@@ -96,13 +112,15 @@ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
 2. Install and build from github
 
 ```sh
-npm install --save git+https://github.com/ircam-ismm/node-web-audio-api.git
+git clone https://github.com/ircam-ismm/node-web-audio-api.git node_modules/node-web-audio-api
 cd node_modules/node-web-audio-api
 npm install
 npm run build
 ```
 
-The package will be built on your machine, which might take some time
+The package will be built on your machine, which might take some time.
+
+Be aware that the package won't be listed on your `package.json` file, and that it won't be re-installed if running `npm install` again. A possible workaround would be to include the above in a postinstall script.
 
 ## Development notes
 

package/monkey-patch.js

@@ -29,34 +29,6 @@ let contextIds = {
 let enumerateDevicesSync = null;
 
 function handleDefaultOptions(options, kind) {
-  if (platform === 'linux') {
-    const list = enumerateDevicesSync();
-    const jackDevice = list.find(device => device.kind === kind && device.label === 'jack');
-
-    if (jackDevice === undefined) {
-      // throw meaningfull error if several contexts are created on linux,
-      // because of alsa backend we currently use
-      if (contextIds[kind] === 1) {
-        throw new Error(`[node-web-audio-api] node-web-audio-api uses alsa as backend, therefore only one context or audio input stream can be safely created`);
-      }
-
-      // force latencyHint to "playback" on RPi if not explicitely defined
-      if (arch === 'arm') {
-        if (kind === 'audiooutput' && !('latencyHint' in options)) {
-          options.latencyHint = 'playback';
-        }
-      }
-    } else {
-      // default to jack if jack source or sink is found
-      const deviceKey = kind === 'audioinput' ? 'deviceId' : 'sinkId';
-
-      if (!(deviceKey in options)) {
-        console.log(`> JACK ${kind} device found, use as default`);
-        options[deviceKey] = jackDevice.deviceId;
-      }
-    }
-  }
-
   // increment contextIds as they are used to keep the process awake
   contextIds[kind] += 1;
 
@@ -139,22 +111,24 @@ function patchOfflineAudioContext(nativeBinding) {
     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 (typeof args[0] === 'object'
+      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];
       }
 
-      if (!isPositiveInt(args[0])) {
-        throw new NotSupportedError(`Unsupported value for numberOfChannels: ${args[0]}`);
-      } else if (!isPositiveInt(args[1])) {
-        throw new NotSupportedError(`Unsupported value for length: ${args[1]}`);
-      } else if (!isPositiveNumber(args[2])) {
-        throw new NotSupportedError(`Unsupported value for sampleRate: ${args[2]}`);
+      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(...args);
+      super(numberOfChannels, length, sampleRate);
     }
 
     // promisify sync APIs

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-web-audio-api",
-  "version": "0.8.0",
+  "version": "0.10.0",
   "author": "Benjamin Matuszewski",
   "description": "Node.js bindings for web-audio-api-rs using napi-rs",
   "exports": {
@@ -32,7 +32,7 @@
   "scripts": {
     "artifacts": "napi artifacts",
     "build": "npm run generate && napi build --platform --release",
-    "build:jack": "npm run generate && napi build --platform --features 'web-audio-api/cpal-jack' --release",
+    "build:jack": "npm run generate && napi build --platform --features jack --release",
     "build:debug": "npm run generate && napi build --platform",
     "check": "cargo fmt && cargo clippy",
     "generate": "node generator/index.mjs && cargo fmt",