node-web-audio-api 1.0.0-beta.0 → 1.0.1

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## v1.0.1 (17/01/2025)
+
+- Update upstream crate to [v1.2.0](https://github.com/orottier/web-audio-api-rs/blob/main/CHANGELOG.md#version-120-2025-01-16)
+
+## v1.0.0 (11/01/2025)
+
+- Align version with upstream crate
+- Refactor CI
+
 ## v0.21.5 (23/12/2024)
 
 - Fix: Use module import for `AudioWorklet#addModule`
@@ -57,7 +66,7 @@
 
 - Update upstream create to [v0.42.0](https://github.com/orottier/web-audio-api-rs/blob/main/CHANGELOG.md#version-0420-2024-02-05)
 - Improve Error handling
-- Add channelCounnt to media constraints
+- Add channelCount to media constraints
 
 ## v0.15.0 (16/01/2024)
 
@@ -97,7 +106,7 @@
 
 ## v0.8.0 (19/05/2023)
 
-- Implement MediaDevices enumerateDeviaces and getUserMedia
+- Implement MediaDevices enumerateDevices and getUserMedia
 - Use jack as default output if exists on linux
 
 ## v0.7.0 (23/02/2023)

package/README.md

@@ -60,24 +60,36 @@ npm run build
 
 3. Run the examples from the project's root directory
 ```sh
-node examples/granular-scrub.mjs
+node examples/granular-scrub.js
 ```
 
 ## Caveats
 
+- `AudioBuffer#getChannelData` is implemented but not reliable in some situations. Your should prefer `AudioBuffer#copyToChannel` and `AudioBuffer#copyFromChannel` when you want to access or manipulate the underlying samples in a safe way.
 - `Streams`: only a minimal audio input stream and the `MediaStreamSourceNode` are provided. All other `MediaStream` features are left on the side for now as they principally concern a different API specification, which is not a trivial problem.
 
-## Supported Platforms
+## Supported Platforms - Prebuilt Binaries
+
+We provide prebuilt binaries for the following platforms:
+
+|                                                     | binaries |
+|-----------------------------------------------------|:--------:|
+| Windows x64                                         | ✓        |
+| Windows arm64                                       | ✓        |
+| macOS x64                                           | ✓        |
+| macOS aarch64                                       | ✓        |
+| Linux x64 gnu (jack / pipewire-jack)                | ✓        |
+| Linux arm gnueabihf (jack / pipewire-jack)          | ✓        |
+| Linux arm64 gnu     (jack / pipewire-jack)          | ✓        |
+
+
+
+### Important notes
+
+- If you need support for another platform, please fill an [issue](https://github.com/ircam-ismm/node-web-audio-api/issues) and we will see what we can do.
+
+- All provided Linux binaries are built with the `jack` flag, which should work either with properly configured [Jack](https://jackaudio.org/) or [pipewire-jack](https://pipewire.org/) backends. If this is a limitation for you, please fill an [issue](https://github.com/ircam-ismm/node-web-audio-api/issues) and we will see what we can do.
 
-|                              | binaries | tested |
-| ---------------------------  | ------   | ------ |
-| Windows x64                  | ✓        |        |
-| Windows arm64                | ✓        |        |
-| macOS x64                    | ✓        | ✓      |
-| macOS aarch64                | ✓        | ✓      |
-| Linux x64 gnu                | ✓        |        |
-| Linux arm gnueabihf (RPi)    | ✓        | ✓      |
-| Linux arm64 gnu (RPi)        | ✓        | ✓      |
 
 ## Manual Build
 
@@ -161,7 +173,7 @@ Then run:
 npm run wpt                      # build in debug mode and run all wpt test
 npm run wpt:only                 # run all wpt test without build
 npm run wpt -- --list            # list all wpt test files
-npm run wpt -- --filter <string> # apply <string> filter on executed/listed wpt tests 
+npm run wpt -- --filter <string> # apply <string> filter on executed/listed wpt tests
 ```
 
 ## License

package/js/AudioWorklet.js

@@ -85,7 +85,7 @@ const resolveModule = async (moduleUrl) => {
         try {
           // try resolve according to process.cwd()
           absPathname = require.resolve(moduleUrl, { paths: [process.cwd()] });
-        } catch (err) {
+        } catch {
           throw new DOMException(`Failed to execute 'addModule' on 'AudioWorklet': Cannot resolve module ${moduleUrl}`, 'AbortError');
         }
       }

package/js/AudioWorkletGlobalScope.js

@@ -101,7 +101,7 @@ function isIterable(obj) {
 function isConstructor(f) {
   try {
     Reflect.construct(String, [], f);
-  } catch (e) {
+  } catch {
     return false;
   }
   return true;

package/js/AudioWorkletNode.js

@@ -1,4 +1,3 @@
-/* eslint-disable no-unused-vars */
 const conversions = require('webidl-conversions');
 const {
   toSanitizedSequence,
@@ -23,8 +22,6 @@ const {
   ErrorEvent,
 } = require('./Events.js');
 
-/* eslint-enable no-unused-vars */
-
 const AudioNode = require('./AudioNode.js');
 const AudioParamMap = require('./AudioParamMap.js');
 const IMPLEMENTATION_MAX_NUMBER_OF_CHANNELS = 32;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-web-audio-api",
-  "version": "1.0.0-beta.0",
+  "version": "1.0.1",
   "author": "Benjamin Matuszewski",
   "description": "Web Audio API implementation for Node.js",
   "exports": {
@@ -41,7 +41,7 @@
     "build:only": "cargo build --release && node ./.scripts/move-artifact.mjs --release",
     "check": "cargo fmt && cargo clippy",
     "generate": "node generator/index.mjs && cargo fmt",
-    "lint": "npx eslint index.cjs index.mjs && npx eslint js/*.js && npx eslint examples/*.mjs",
+    "lint": "npx eslint index.cjs index.mjs && npx eslint js/*.js && npx eslint examples/*.js",
     "preversion": "npm install && npm run generate",
     "postversion": "cargo bump $npm_package_version && git commit -am \"v$npm_package_version\" && node .scripts/check-changelog.mjs",
     "test": "mocha tests/*.spec.mjs",
@@ -51,23 +51,20 @@
     "wpt:only": "node ./.scripts/wpt-harness.mjs"
   },
   "devDependencies": {
-    "@ircam/eslint-config": "^1.3.0",
-    "@ircam/sc-gettime": "^1.0.0",
-    "@ircam/sc-scheduling": "^0.1.7",
-    "@ircam/sc-utils": "^1.3.3",
+    "@ircam/eslint-config": "^2.0.0",
+    "@ircam/sc-scheduling": "^1.0.0",
+    "@ircam/sc-utils": "^1.9.0",
     "@sindresorhus/slugify": "^2.1.1",
-    "camelcase": "^7.0.1",
-    "chai": "^4.3.7",
+    "camelcase": "^8.0.0",
+    "chai": "^5.1.2",
     "chalk": "^5.3.0",
     "cli-table": "^0.3.11",
-    "commander": "^11.1.0",
+    "commander": "^13.0.0",
     "dotenv": "^16.0.3",
-    "eslint": "^8.57.0",
+    "eslint": "^9.18.0",
     "js-beautify": "^1.15.1",
-    "mocha": "^10.2.0",
-    "node-ssh": "^13.0.0",
-    "octokit": "^2.0.11",
-    "ping": "^0.4.2",
+    "mocha": "^11.0.1",
+    "octokit": "^4.1.0",
     "template-literal": "^1.0.4",
     "webidl2": "^24.2.0",
     "wpt-runner": "^5.0.0"

package/.eslintrc

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

package/Cross.toml

@@ -1,17 +0,0 @@
-[target.aarch64-unknown-linux-gnu]
-pre-build = [
-  "dpkg --add-architecture $CROSS_DEB_ARCH",
-  "apt-get update && apt-get --assume-yes install libasound2-dev:$CROSS_DEB_ARCH libjack-jackd2-dev:$CROSS_DEB_ARCH"
-]
-
-[target.armv7-unknown-linux-gnueabihf]
-pre-build = [
-  "dpkg --add-architecture $CROSS_DEB_ARCH",
-  "apt-get update && apt-get --assume-yes install libasound2-dev:$CROSS_DEB_ARCH libjack-jackd2-dev:$CROSS_DEB_ARCH"
-]
-
-[target.x86_64-unknown-linux-gnu]
-pre-build = [
-  "dpkg --add-architecture $CROSS_DEB_ARCH",
-  "apt-get update && apt-get --assume-yes install libasound2-dev:$CROSS_DEB_ARCH libjack-jackd2-dev:$CROSS_DEB_ARCH"
-]

package/all-checks.sh

@@ -1,18 +0,0 @@
-#!/bin/bash
-
-
-echo "-----------------------------------------------"
-echo "> cargo fmt -- --check --color always"
-echo "-----------------------------------------------"
-cargo fmt -- --check --color always
-
-echo "-----------------------------------------------"
-echo "> cargo clippy --all-targets -- -D warnings"
-echo "-----------------------------------------------"
-cargo clippy --all-targets -- -D warnings
-
-echo "-----------------------------------------------"
-echo "> Run js tests"
-echo "-----------------------------------------------"
-npm run test
-

package/run-wpt.sh

@@ -1,5 +0,0 @@
-#!/bin/bash
-echo $1
-echo ~~~~~~~~~~~~~~~~~
-node ./.scripts/wpt-harness.mjs --filter "$1" 2>&1 | grep -A 3 RESULTS
-echo