node-web-audio-api 1.0.0 → 1.0.2

package/CHANGELOG.md

@@ -1,127 +1,135 @@
 # CHANGELOG
 
-## v1.0.0 (11/01/2024)
+## v1.0.2 - 2025-03-01
 
-- Align version with upsteam crate
+- Fix error handling when setting buffer in ABSN and Convolver
+
+## v1.0.1 - 2025-01-17
+
+- 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 - 2025-01-11
+
+- Align version with upstream crate
 - Refactor CI
 
-## v0.21.5 (23/12/2024)
+## v0.21.5 - 2024-12-23
 
 - Fix: Use module import for `AudioWorklet#addModule`
 - Feat: Resolve `AudioWorkletNode` when installed in `node_modules`
 - Ensure support of `AudioWorkletNode` that use Web Assembly
 
-## v0.21.4 (16/12/2024)
+## v0.21.4 - 2024-12-16
 
 - Update upstream crate to [v1.1.0](https://github.com/orottier/web-audio-api-rs/blob/main/CHANGELOG.md#version-110-2024-12-11)
 
-## v0.21.3 (06/10/2024)
+## v0.21.3 - 2024-10-06
 
 - Fix typescript export
 
-## v0.21.2 (20/09/2024)
+## v0.21.2 - 2024-09-20
 
 - Update upstream crate to [v1.0.1](https://github.com/orottier/web-audio-api-rs/blob/main/CHANGELOG.md#version-101-2024-09-18)
 - Fix: Make sure `AudioBuffer` returned by `OfflineContext` is valid
 - Fix: Allow contexts to be properly garbage collected
 
-## v0.21.1 (10/06/2024)
+## v0.21.1 - 2024-06-10
 
 - Feat: Buffer pool for AudioWorketProcessor
 - Fix: Propagate `addModule` errors to main thread
 - Fix: Memory leak due to `onended` events
 
-## v0.21.0 (17/05/2024)
+## v0.21.0 - 2024-05-17
 
 - Feat: Implement AudioWorkletNode
 
-## v0.20.0 (29/04/2024)
+## v0.20.0 - 2024-04-29
 
 - Update upstream crate to [v0.44.0](https://github.com/orottier/web-audio-api-rs/blob/main/CHANGELOG.md#version-0440-2024-04-22)
 - Implement ScriptProcessorNode
 - Fix memory leak introduced in v0.19.0
 - Improve events compliance
 
-## v0.19.0 (17/04/2024)
+## v0.19.0 - 2024-04-17
 
 - Update upstream crate to [1.0.0-rc.5](https://github.com/orottier/web-audio-api-rs/blob/main/CHANGELOG.md#version-0430--100-rc5-2024-04-15)
 - Provide JS facades with proper inheritance chain for all exposed interfaces
 - Implement all AudioNode connect / disconnect alternatives
 - Improve compliance and error handling
 
-## v0.18.0 (13/03/2024)
+## v0.18.0 - 2024-03-13
 
 - Fix `MediaStreamAudioSourceNode`
 
-## v0.17.0 (08/03/2024)
+## v0.17.0 - 2024-03-08
 
 - Update upstream crate to [1.0.0-rc.2](https://github.com/orottier/web-audio-api-rs/blob/main/CHANGELOG.md#version-100-rc2-2024-03-07)
 - Improve compliance and error handling
 
-## v0.16.0 (09/02/2024)
+## v0.16.0 - 2024-02-09
 
 - 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)
+## v0.15.0 - 2024-01-16
 
 - Update upstream create to [v0.41.1](https://github.com/orottier/web-audio-api-rs/blob/main/CHANGELOG.md#version-0411-2024-01-11)
 - Better error handling
 - Implement online AudioContext and AudioScheduledSourceNode events
 - Test against wpt
 
-## v0.14.0 (06/12/2023)
+## v0.14.0 - 2023-12-06
 
 - Update upstream create to [v0.38.0](https://github.com/orottier/web-audio-api-rs/blob/main/CHANGELOG.md#version-0380-2023-12-03)
 - Implement AudioListener
 
-## v0.13.0 (08/11/2023)
+## v0.13.0 - 2023-11-08
 
 - Update upstream crate to [v0.36.1](https://github.com/orottier/web-audio-api-rs/blob/main/CHANGELOG.md#version-0361-2023-11-08)
 - Ship build for linux arm64
 - Typescript support
 
-## v0.12.0 (04/09/2023)
+## v0.12.0 - 2023-09-04
 
 - Update upstream crate to [v0.33](https://github.com/orottier/web-audio-api-rs/blob/main/CHANGELOG.md#version-0330-2023-07-27)
 
-## v0.11.0 (21/07/2023)
+## v0.11.0 - 2023-07-21
 
 - Update upstream crate to [v0.32](https://github.com/orottier/web-audio-api-rs/blob/main/CHANGELOG.md#version-0320-2023-07-16)
 - Implement AudioDestination API
 - Make decodeAudioData(arrayBuffer) API compliant (drop `load` helper)
 
-## v0.10.0 (26/05/2023)
+## v0.10.0 - 2023-05-26
 
 - Update upstream crate to [v0.31](https://github.com/orottier/web-audio-api-rs/blob/main/CHANGELOG.md#version-0310-2023-06-25)
 
-## v0.9.0 (08/06/2023)
+## v0.9.0 - 2023-06-08
 
 - Update upstream crate to [v0.30](https://github.com/orottier/web-audio-api-rs/blob/main/CHANGELOG.md#version-0300-2023-06-07)
 
-## v0.8.0 (19/05/2023)
+## v0.8.0 - 2023-05-19
 
-- 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)
+## v0.7.0 - 2023-02-23
 
 - Improve readme & doc
 - Fix AudioParam method names
 
-## v0.6.0 (01/02/2023)
+## v0.6.0 - 2023-02-01
 
 - Basic support for mediaDevices & MediaStreamAudioSourceNode
 - Add bindings to ConvolverNode, AnalyserNode & Panner nodes
 - Update upstream crate to [v0.26](https://github.com/orottier/web-audio-api-rs/blob/main/CHANGELOG.md#version-0250-2022-11-06)
 
-## v0.5.0 (19/12/2022)
+## v0.5.0 - 2022-12-19
 
 - Implement AudioParam#setValueCurveAtTime
 - Offline context constructor
 
-## v0.4.0 (07/11/2022)
+## v0.4.0 - 2022-11-07
 
 - Implement offline audio context
 - Update upstream crate to [v0.24](https://github.com/orottier/web-audio-api-rs/blob/main/CHANGELOG.md#version-0240-2022-09-10)

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/AudioBufferSourceNode.js

@@ -179,7 +179,7 @@ module.exports = (jsExport, nativeBinding) => {
       if (value === null) {
         console.warn('Setting the \'buffer\' property on \'AudioBufferSourceNode\' to \'null\' is not supported yet');
         return;
-      } else if (!(kNapiObj in value)) {
+      } else if (!(value instanceof jsExport.AudioBuffer)) {
         throw new TypeError('Failed to set the \'buffer\' property on \'AudioBufferSourceNode\': Failed to convert value to \'AudioBuffer\'');
       }
 

package/js/ConvolverNode.js

@@ -141,7 +141,7 @@ module.exports = (jsExport, nativeBinding) => {
       if (value === null) {
         console.warn('Setting the \'buffer\' property on \'ConvolverNode\' to \'null\' is not supported yet');
         return;
-      } else if (!(kNapiObj in value)) {
+      } else if (!(value instanceof jsExport.AudioBuffer)) {
         throw new TypeError('Failed to set the \'buffer\' property on \'ConvolverNode\': Failed to convert value to \'AudioBuffer\'');
       }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-web-audio-api",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "author": "Benjamin Matuszewski",
   "description": "Web Audio API implementation for Node.js",
   "exports": {