node-web-audio-api 0.2.1

package/LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2021-2022 IRCAM – Centre Pompidou (France, Paris)
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+* Neither the name of the IRCAM nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,67 @@
+# `node-web-audio-api`
+
+> Nodejs bindings for [`orottier/web-audio-api-rs`](https://github.com/orottier/web-audio-api-rs/) using [`napi-rs`](https://github.com/napi-rs/napi-rs/)
+
+## Install
+
+```
+npm install [--save] node-web-audio-api
+```
+
+## Example
+
+```js
+import { AudioContext, OscillatorNode, GainNode } from 'node-web-audio-api';
+
+const audioContext = new AudioContext();
+
+setInterval(() => {
+  const now = audioContext.currentTime;
+
+  const env = new GainNode(audioContext);
+  env.connect(audioContext.destination);
+  env.gain.value = 0;
+  env.gain.setValueAtTime(0, now);
+  env.gain.linearRampToValueAtTime(1, now + 0.02);
+  env.gain.exponentialRampToValueAtTime(0.0001, now + 1);
+
+  const osc = new OscillatorNode(audioContext);
+  osc.frequency.value = 200 + Math.random() * 2800;
+  osc.connect(env);
+  osc.start(now);
+  osc.stop(now + 1);
+}, 50);
+```
+
+
+
+## Build manually
+
+If prebuilt binaries are not shippped for your platform, you will need to install 
+the rust toolchain and install and build the package from github.
+
+1. Install rust toolchain
+
+```
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+```
+
+2. Install from github
+
+```
+npm install --save git+https://github.com/b-ma/node-web-audio-api.git
+```
+
+Note that the package will be built on your machine, so the install process might be a bit long
+
+## Roadmap
+
+- Make a few nodes work properly with clean and predictable code
+- Generate bindings from IDL [https://webaudio.github.io/web-audio-api/#idl-index](https://webaudio.github.io/web-audio-api/#idl-index)
+- Publish on `npm` with binaries
+- Implement prototype chain (?)
+- Follow developments of `web-audio-api-rs`
+
+## License
+
+This project is licensed under the [BSD-3-Clause license](./LICENSE).

package/index.js

@@ -0,0 +1,93 @@
+const { existsSync, readFileSync } = require('fs');
+const { join } = require('path');
+const { patchAudioContext } = require('./monkey-patch.js');
+
+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}`);
+}
+
+nativeBinding.AudioContext = patchAudioContext(nativeBinding.AudioContext);
+
+module.exports = nativeBinding;
+

package/monkey-patch.js

@@ -0,0 +1,38 @@
+
+let contextId = 0;
+
+module.exports.patchAudioContext = function(NativeAudioContext) {
+  class AudioContext extends NativeAudioContext {
+    constructor(...args) {
+      super(...args);
+      // prevent garbage collection
+      const processId = `__AudioContext_${contextId}`;
+      process[processId] = this;
+      this.__processId = processId;
+
+      contextId += 1;
+      // keep process awake
+      this.__keepAwakeId = setInterval(() => {}, 10000);
+    }
+
+    // @todo
+    // resume() {
+    //   this.__keepAwakeId = setInterval(() => {}, 2000);
+    //   return super.resume();
+    // }
+
+    // suspend() {
+    //   // not sure to be confirmed
+    //   clearTimeout(this.__keepAwakeId);
+    //   return super.suspend();
+    // }
+
+    // close() {
+    //    delete process[this.__processId];
+    //    clearTimeout(this.__keepAwakeId);
+    //    return super.close();
+    // }
+  }
+
+  return AudioContext;
+}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "node-web-audio-api",
+  "version": "0.2.1",
+  "author": "Benjamin Matuszewski",
+  "description": "Node.js bindings for web-audio-api-rs using napi-rs",
+  "main": "index.js",
+  "repository": "git@github.com:b-ma/node-web-audio-api.git",
+  "license": "BSD-3-Clause",
+  "keywords": [
+    "audio",
+    "web audio api",
+    "rust",
+    "n-api"
+  ],
+  "engines": {
+    "node": ">= 14"
+  },
+  "napi": {
+    "name": "node-web-audio-api"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "scripts": {
+    "artifacts": "napi artifacts",
+    "build": "napi build --platform --release",
+    "build:debug": "napi build --platform",
+    "check": "cargo fmt && cargo clippy",
+    "generate": "node generator/index.js",
+    "preversion": "npm run generate"
+  },
+  "devDependencies": {
+    "chalk": "^5.0.1",
+    "dotenv": "^16.0.2",
+    "node-ssh": "^13.0.0",
+    "octokit": "^2.0.7",
+    "ping": "^0.4.2"
+  },
+  "dependencies": {
+    "@napi-rs/cli": "^2.10.0",
+    "@node-rs/helper": "^1.3.3"
+  }
+}

package/simple-test.cjs

@@ -0,0 +1,21 @@
+const { AudioContext } = require('./index.js');
+
+const audioContext = new AudioContext();
+process.audioContext = 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

@@ -0,0 +1,21 @@
+import webaudio from './index.js';
+
+const audioContext = new webaudio.AudioContext();
+// process.audioContext = 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);