node-web-audio-api 0.3.0 → 0.5.0

package/.eslintrc

@@ -0,0 +1,3 @@
+{
+  "extends": "@ircam"
+}

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+## v0.4.0
+
+- Implement offline audio context
+- Update web-audio-api-rs to v0.24.0 
+- Implement `audio_node.disconnect()`
+- Properly support ESM
+- Limit number of online contexts to 1 on Linux
+- Force latencyHint to 'playback' if not manually set on RPi

package/README.md

@@ -11,7 +11,7 @@ npm install [--save] node-web-audio-api
 ## Example
 
 ```js
-const { AudioContext, OscillatorNode, GainNode } = require('node-web-audio-api');
+import { AudioContext, OscillatorNode, GainNode } from 'node-web-audio-api';
 
 const audioContext = new AudioContext();
 
@@ -30,14 +30,13 @@ setInterval(() => {
   osc.connect(env);
   osc.start(now);
   osc.stop(now + 1);
-}, 50);
+}, 80);
 ```
 
-or using with EcmaScript module syntax
+or using with old fashionned commonjs syntax
 
 ```js
-import wabaudioapi from 'node-web-audio-api';
-const { AudioContext, OscillatorNode, GainNode } = webaudioapi;
+const { AudioContext, OscillatorNode, GainNode } = require('node-web-audio-api');
 
 const audioContext = new AudioContext();
 //...
@@ -46,13 +45,17 @@ const audioContext = new AudioContext();
 ## Caveats
 
 - Currently the library does not provide any way of chosing the output interface, system default interface will be used. As the spec and web-audio-api evolve evolve, thus should change in the future see [https://github.com/orottier/web-audio-api-rs/issues/216](https://github.com/orottier/web-audio-api-rs/issues/216)
-- On Linux systems, the audio backend is Alsa, this is subject to change in the future.
+- On Linux systems, the audio backend is Alsa, which limits the number of online
+AudioContext to 1. This is subject to change in the future.
 
 ### Raspberry Pi
 
 On Raspberry Pi, the default render quantum size (128) is too small and underruns 
-occurs frequently. To prevent that you should provide a latency hint when building
-an audio context:
+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. While this is not per se spec compliant, it allow usage
+of the library in a more user friendly manner. In the future, this might change according
+to the support of other audio backend, which is now alsa.
 
 ```js
 const audioContext = new AudioContext({ latencyHint: 'playback' });

package/dummy.mjs

@@ -0,0 +1,19 @@
+import { AudioContext } from './index.mjs';
+
+const audioContext = new AudioContext();
+
+const now = audioContext.currentTime;
+
+const gain = audioContext.createGain();
+gain.gain.setValueAtTime(0, now);
+gain.connect(audioContext.destination);
+
+const src = audioContext.createOscillator();
+src.connect(gain);
+src.start();
+
+
+gain.gain.setValueCurveAtTime(new Float32Array([0, 1, 0]), now + 1, 2);
+// gain.gain.setValueCurveAtTime(new Float32Array([0, 1, 0]), now + 1, 2);
+
+gain.gain.linear(new Float32Array([0, 1, 0]), now + 1, 2);

package/{index.js → index.cjs}

@@ -1,6 +1,3 @@
-const { existsSync, readFileSync } = require('fs');
-const { join } = require('path');
-
 const { platform, arch } = process;
 
 let nativeBinding = null;
@@ -13,67 +10,67 @@ switch (platform) {
         try {
           nativeBinding = require('./node-web-audio-api.win32-x64-msvc.node');
         } catch (e) {
-          loadError = e
+          loadError = e;
         }
-        break
+        break;
       case 'arm64':
         try {
           nativeBinding = require('./node-web-audio-api.win32-arm64-msvc.node');
         } catch (e) {
-          loadError = e
+          loadError = e;
         }
-        break
+        break;
       default:
         throw new Error(`Unsupported architecture on Windows: ${arch}`);
     }
-    break
+    break;
   case 'darwin':
     switch (arch) {
       case 'x64':
         try {
           nativeBinding = require('./node-web-audio-api.darwin-x64.node');
         } catch (e) {
-          loadError = e
+          loadError = e;
         }
-        break
+        break;
       case 'arm64':
         try {
           nativeBinding = require('./node-web-audio-api.darwin-arm64.node');
         } catch (e) {
-          loadError = e
+          loadError = e;
         }
-        break
+        break;
       default:
         throw new Error(`Unsupported architecture on macOS: ${arch}`);
     }
-    break
+    break;
   case 'linux':
     switch (arch) {
       case 'x64':
         try {
           nativeBinding = require('./node-web-audio-api.linux-x64-gnu.node');
         } catch (e) {
-          loadError = e
+          loadError = e;
         }
-        break
+        break;
       case 'arm64':
         try {
           nativeBinding = require('./node-web-audio-api.linux-arm64-gnu.node');
         } catch (e) {
-          loadError = e
+          loadError = e;
         }
-        break
+        break;
       case 'arm':
         try {
           nativeBinding = require('./node-web-audio-api.linux-arm-gnueabihf.node');
         } catch (e) {
-          loadError = e
+          loadError = e;
         }
-        break
+        break;
       default:
         throw new Error(`Unsupported architecture on Linux: ${arch}`);
     }
-    break
+    break;
   default:
     throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`);
 }
@@ -86,9 +83,14 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding for OS: ${platform}, architecture: ${arch}`);
 }
 
-const { patchAudioContext, load } = require('./monkey-patch.js');
+const {
+  patchAudioContext,
+  patchOfflineAudioContext,
+  load,
+} = require('./monkey-patch.js');
 
 nativeBinding.AudioContext = patchAudioContext(nativeBinding.AudioContext);
+nativeBinding.OfflineAudioContext = patchOfflineAudioContext(nativeBinding.OfflineAudioContext);
 nativeBinding.load = load;
 
 module.exports = nativeBinding;

package/index.mjs

@@ -0,0 +1,39 @@
+// ---------------------------------------------------------- //
+// ---------------------------------------------------------- //
+//    - WARNING - DO NOT EDIT                               - //
+//    - This file has been generated                        - //
+// ---------------------------------------------------------- //
+// ---------------------------------------------------------- //
+
+// re-export index.js to support clean esm syntax
+// see https://github.com/nodejs/node/issues/40541#issuecomment-951609570
+
+import { createRequire } from 'module';
+const require = createRequire(import.meta.url);
+
+const nativeModule = require('./index.cjs');
+export const {
+  AudioContext,
+  OfflineAudioContext,
+  AudioBuffer,
+  PeriodicWave,
+  // generated supported nodes
+  AudioBufferSourceNode,
+  BiquadFilterNode,
+  ChannelMergerNode,
+  ChannelSplitterNode,
+  ConstantSourceNode,
+  DelayNode,
+  DynamicsCompressorNode,
+  GainNode,
+  IIRFilterNode,
+  OscillatorNode,
+  StereoPannerNode,
+  WaveShaperNode,
+  // helper methods
+  load,
+} = nativeModule;
+
+export default nativeModule;
+
+  

package/monkey-patch.js

@@ -1,15 +1,49 @@
 const fs = require('fs');
 
-let contextId = 0;
-
 const isPlainObject = function(obj) {
   return Object.prototype.toString.call(obj) === '[object Object]';
 };
 
-module.exports.patchAudioContext = function(NativeAudioContext) {
+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 contextId = 0;
+
+function patchAudioContext(NativeAudioContext) {
   class AudioContext extends NativeAudioContext {
-    constructor(...args) {
-      super(...args);
+    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)
+      if (platform === 'linux') {
+        // throw meaningfull error if several contexts are created on linux,
+        // because of alsa backend we currently use
+        if (contextId === 1) {
+          throw new Error(`[node-web-audio-api] node-web-audio-api currently uses alsa as backend, therefore only one context can be safely created`);
+        }
+
+        // fallback latencyHint to "playback" on RPi if not explicitely defined
+        if (arch === 'arm') {
+          if (!('latencyHint' in options)) {
+            options.latencyHint = 'playback';
+          }
+        }
+      }
+
+      super(options);
       // prevent garbage collection
       const processId = `__AudioContext_${contextId}`;
       process[processId] = this;
@@ -44,9 +78,9 @@ module.exports.patchAudioContext = function(NativeAudioContext) {
     }
 
     close() {
-       delete process[this.__processId];
-       clearTimeout(this.__keepAwakeId);
-       return Promise.resolve(super.close());
+      delete process[this.__processId];
+      clearTimeout(this.__keepAwakeId);
+      return Promise.resolve(super.close());
     }
 
     decodeAudioData(audioData) {
@@ -66,6 +100,70 @@ module.exports.patchAudioContext = function(NativeAudioContext) {
   return AudioContext;
 }
 
+function patchOfflineAudioContext(NativeOfflineAudioContext) {
+  class OfflineAudioContext extends NativeOfflineAudioContext {
+    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'
+          && '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]}`);
+      }
+
+      super(...args);
+
+      // not sure this is usefull, to be tested
+      const keepAwakeId = setInterval(() => {}, 10000);
+      Object.defineProperty(this, '__keepAwakeId', {
+        value: keepAwakeId,
+        enumerable: false,
+        writable: true,
+        configurable: false,
+      });
+    }
+
+    // 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 (!isPlainObject(audioData) || !('path' in audioData)) {
+        throw new Error(`Invalid argument, please consider using the load helper`);
+      }
+
+      try {
+        const audioBuffer = super.decodeAudioData(audioData);
+        return Promise.resolve(audioBuffer);
+      } catch (err) {
+        return Promise.reject(err);
+      }
+    }
+  }
+
+  return OfflineAudioContext;
+}
+
+module.exports.patchAudioContext = patchAudioContext;
+module.exports.patchOfflineAudioContext = patchOfflineAudioContext;
+
 // dumb method provided to mock an xhr call and mimick browser's API
 // see also `AudioContext.decodeAudioData`
 module.exports.load = function(path) {
@@ -74,4 +172,4 @@ module.exports.load = function(path) {
   }
 
   return { path };
-}
+};

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "node-web-audio-api",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "author": "Benjamin Matuszewski",
   "description": "Node.js bindings for web-audio-api-rs using napi-rs",
-  "main": "index.js",
+  "exports": {
+    "import": "./index.mjs",
+    "require": "./index.cjs"
+  },
   "repository": "https://github.com/ircam-ismm/node-web-audio-api",
   "license": "BSD-3-Clause",
   "keywords": [
@@ -28,14 +31,17 @@
     "build:debug": "npm run generate && napi build --platform",
     "check": "cargo fmt && cargo clippy",
     "generate": "node generator/index.mjs && cargo fmt",
+    "lint": "eslint monkey-patch.js index.cjs index.mjs && eslint examples/*.mjs",
     "preversion": "yarn install && npm run generate",
     "postversion": "cargo bump $npm_package_version && git commit -am \"v$npm_package_version\""
   },
   "devDependencies": {
+    "@ircam/eslint-config": "^1.2.0",
     "@sindresorhus/slugify": "^2.1.0",
-    "chalk": "^5.0.1",
     "camelcase": "^6.3.0",
+    "chalk": "^5.0.1",
     "dotenv": "^16.0.2",
+    "eslint": "^8.27.0",
     "node-ssh": "^13.0.0",
     "octokit": "^2.0.7",
     "ping": "^0.4.2",

package/simple-test.mjs

@@ -1,7 +1,6 @@
-import webaudio from './index.js';
+import { AudioContext } from './index.mjs';
 
-const audioContext = new webaudio.AudioContext();
-// process.audioContext = audioContext;
+const audioContext = new AudioContext();
 
 setInterval(() => {
   const now = audioContext.currentTime;