@node-3d/webaudio 6.0.2 → 6.0.3

package/README.md

@@ -24,8 +24,22 @@ Import any class you like from the module and then follow the
 import { AudioContext } from '@node-3d/webaudio'; // usually this is enough
 ```
 
+Create a silent PCM buffer using the Web Audio arguments, then write samples:
+
+```ts
+const context = new AudioContext();
+const buffer = context.createBuffer(1, context.sampleRate, context.sampleRate);
+const samples = buffer.getChannelData(0);
+samples[0] = 0.5;
+```
+
+`new AudioBuffer({ length, sampleRate, numberOfChannels? })` is also supported.
+`createBuffer()` requires all three arguments. Invalid buffer dimensions and
+sample rates throw `NotSupportedError`; an invalid channel index throws
+`IndexSizeError`.
+
 **This module is WORK IN PROGRESS.**
-Some features are missing for good.
+Unimplemented or noncompliant Web Audio behavior remains work to fix.
 
 Currently exported classes:
 

package/dist/audio-buffer.d.ts

@@ -1,10 +1,12 @@
 import { inspect } from 'node:util';
-declare const AudioBuffer: import("./native.js").TNativeEs5Constructor<[context: import("./native.js").TBaseAudioContext, source?: Readonly<{
-    length?: number;
+import type { TAudioBufferOptions, TBaseAudioContext, TNativeExternal } from './native.js';
+declare const AudioBuffer: import("./native.js").TNativeEs5Constructor<[options: Readonly<{
+    length: number;
     numberOfChannels?: number;
-    sampleRate?: number;
-}> | import("./native.js").TNativeExternal | undefined], import("./native.js").TAudioBuffer>;
+    sampleRate: number;
+}>] | [context: TBaseAudioContext, source: TNativeExternal], import("./native.js").TAudioBuffer>;
 declare class JsAudioBuffer extends AudioBuffer {
+    constructor(options: TAudioBufferOptions);
     [inspect.custom](): string;
     toString(): string;
 }

package/dist/base-audio-context.d.ts

@@ -5,7 +5,7 @@ export type TJsBaseAudioContext = TBaseAudioContext & {
     _initListener: (destinationCtor: typeof AudioDestinationNode, listenerCtor: typeof AudioListener, sampleRate: number) => void;
     createAnalyser: (opts?: TAudioNodeOptions) => TAnalyserNode;
     createBiquadFilter: (opts?: TAudioNodeOptions) => TBiquadFilterNode;
-    createBuffer: (opts?: TAudioNodeOptions) => TAudioBuffer;
+    createBuffer: (numberOfChannels: number, length: number, sampleRate: number) => TAudioBuffer;
     createBufferSource: (opts?: TAudioNodeOptions) => TAudioBufferSourceNode;
     createConvolver: (opts?: TAudioNodeOptions) => TConvolverNode;
     createDelay: (maxDelayTime?: number) => TDelayNode;

package/dist/index.js

@@ -28,6 +28,13 @@ const { AudioBuffer: AudioBuffer } = native_native;
 inherits(AudioBuffer, node_events);
 audio_buffer_computedKey = _to_property_key(inspect.custom);
 class JsAudioBuffer extends AudioBuffer {
+    constructor(options, source){
+        if ('length' in options) super(options);
+        else {
+            if (void 0 === source) throw new TypeError('AudioBuffer requires an options object');
+            super(options, source);
+        }
+    }
     [audio_buffer_computedKey]() {
         return this.toString();
     }
@@ -268,8 +275,14 @@ const baseAudioContextPrototype = {
     createBiquadFilter (opts = {}) {
         return new nodes.BiquadFilterNode(this, opts);
     },
-    createBuffer (opts = {}) {
-        return new JsAudioBuffer(this, opts);
+    createBuffer (numberOfChannels, length, sampleRate) {
+        if (arguments.length < 3) throw new TypeError('createBuffer requires numberOfChannels, length, and sampleRate');
+        const options = {
+            numberOfChannels,
+            length,
+            sampleRate
+        };
+        return new JsAudioBuffer(options);
     },
     createBufferSource (opts = {}) {
         return new nodes.AudioBufferSourceNode(this, opts);

package/dist/native.d.ts

@@ -22,11 +22,10 @@ export type TNativeConstructor<TArgs extends readonly unknown[], TInstance exten
     new (...args: TArgs): TInstance;
 };
 export type TNativeEs5Constructor<TArgs extends readonly unknown[], TInstance extends object> = TNativeConstructor<TArgs, TInstance> & ((...args: TArgs) => TInstance);
-export type TAudioBufferData = ArrayLike<number> & object;
 export type TAudioBufferOptions = Readonly<{
-    length?: number;
+    length: number;
     numberOfChannels?: number;
-    sampleRate?: number;
+    sampleRate: number;
 }>;
 export type TAudioContextOptions = Readonly<{
     sampleRate?: number;
@@ -70,9 +69,9 @@ export type TAudioBuffer = TAudioObject & {
     readonly length: number;
     readonly numberOfChannels: number;
     readonly sampleRate: number;
-    copyFromChannel: (destination: TAudioBufferData, channelNumber: number, startInChannel: number) => void;
-    copyToChannel: (source: TAudioBufferData, channelNumber: number, startInChannel: number) => void;
-    getChannelData: (channelIndex: number) => void;
+    copyFromChannel: (destination: Float32Array, channelNumber: number, bufferOffset?: number) => void;
+    copyToChannel: (source: Float32Array, channelNumber: number, bufferOffset?: number) => void;
+    getChannelData: (channelIndex: number) => Float32Array;
 };
 export type TAudioListener = TAudioObject & {
     readonly forwardX: TAudioParam;
@@ -182,9 +181,8 @@ export type TNative = Readonly<{
         opts: TAudioNodeOptions
     ], TAnalyserNode>;
     AudioBuffer: TNativeEs5Constructor<[
-        context: TBaseAudioContext,
-        source?: TNativeExternal | TAudioBufferOptions
-    ], TAudioBuffer>;
+        options: TAudioBufferOptions
+    ] | [context: TBaseAudioContext, source: TNativeExternal], TAudioBuffer>;
     AudioBufferSourceNode: TNativeEs5Constructor<[
         context: TBaseAudioContext,
         paramCtor: TAudioParamConstructor,

package/install.js

@@ -2,6 +2,6 @@ import packageJson from './package.json' with { type: 'json' };
 import { getInstallCandidateUrl, install } from '@node-3d/addon-tools';
 
 const prefix = 'https://github.com/node-3d/webaudio/releases/download';
-const tag = '6.0.0';
+const tag = '6.0.3';
 
 await install(getInstallCandidateUrl(packageJson.name) || `${prefix}/${tag}`);

package/package.json

@@ -1,7 +1,7 @@
 {
 	"author": "Luis Blanco <luisblanco1337@gmail.com>",
 	"name": "@node-3d/webaudio",
-	"version": "6.0.2",
+	"version": "6.0.3",
 	"description": "Web Audio for Node.js",
 	"license": "MIT",
 	"main": "dist/index.js",