@ain1084/audio-worklet-stream 0.1.2

package/dist/output-stream-node.js

@@ -0,0 +1,166 @@
+import { PROCESSOR_NAME } from './constants';
+import { StopEvent, UnderrunEvent } from './events';
+/**
+ * OutputStreamNode class
+ * This class extends AudioWorkletNode to handle audio processing.
+ * It manages a buffer using a FrameBufferWriter instance and tracks the current frame position.
+ */
+export class OutputStreamNode extends AudioWorkletNode {
+    _totalWriteFrames;
+    _totalReadFrames;
+    _strategy;
+    _state = 'ready';
+    /**
+     * Creates an instance of OutputStreamNode.
+     * @param baseAudioContext - The audio context to use.
+     * @param bufferConfig - The configuration for the buffer.
+     * @param strategy - The strategy for writing to the buffer.
+     */
+    constructor(baseAudioContext, bufferConfig, strategy) {
+        const processorOptions = {
+            ...bufferConfig,
+            totalFrames: bufferConfig.totalReadFrames,
+        };
+        super(baseAudioContext, PROCESSOR_NAME, {
+            outputChannelCount: [bufferConfig.samplesPerFrame],
+            processorOptions,
+        });
+        this._strategy = strategy;
+        this._totalWriteFrames = bufferConfig.totalWriteFrames;
+        this._totalReadFrames = bufferConfig.totalReadFrames;
+        this.port.onmessage = this.handleMessage.bind(this);
+    }
+    /**
+     * Start playback.
+     * The node must be connected before starting playback using connect() method.
+     * Output samples must be written to the buffer before starting.
+     * Playback can only be started once. Once stopped, it cannot be restarted.
+     * @returns A boolean indicating whether the playback started successfully.
+     */
+    start() {
+        if (this.numberOfOutputs === 0) {
+            throw new Error('Cannot start playback. Node is not connected.');
+        }
+        switch (this._state) {
+            case 'ready':
+                this._state = 'started';
+                if (!this._strategy.onStart(this)) {
+                    this.stop(this.totalWriteFrames);
+                }
+                return true;
+            case 'started':
+                return false;
+            default:
+                throw new Error(`Cannot start playback. Current state: ${this._state}`);
+        }
+    }
+    /**
+     * Stop the node processing at a given frame position.
+     * Returns a Promise that resolves when the node has completely stopped.
+     * The node is disconnected once stopping is complete.
+     * @param frames - The frame position at which to stop the processing, in frames.
+     *                   If frames is 0 or if the current playback frame position has already passed the specified value,
+     *                   the node will stop immediately.
+     * @returns A promise that resolves when the node has stopped.
+     */
+    stop(frames = BigInt(0)) {
+        switch (this._state) {
+            case 'started':
+                return new Promise((resolve) => {
+                    this._state = 'stopping';
+                    const message = { type: 'stop', frames };
+                    this.port.postMessage(message);
+                    this.addEventListener(StopEvent.type, () => {
+                        resolve();
+                    }, { once: true });
+                });
+            case 'ready':
+                this.handleStopped();
+                break;
+            default:
+                throw new Error(`Cannot stop playback. Current state: ${this._state}`);
+        }
+        return Promise.resolve();
+    }
+    /**
+     * Handles incoming messages from the audio processor.
+     * @param event - The message event from the processor.
+     */
+    handleMessage(event) {
+        switch (event.data.type) {
+            case 'stop':
+                this.handleStopped();
+                this.dispatchEvent(new StopEvent(event.data.frames));
+                break;
+            case 'underrun':
+                this.dispatchEvent(new UnderrunEvent(event.data.frames));
+                break;
+            default:
+                throw new Error(`Unexpected event value: ${event.data}`);
+        }
+    }
+    /**
+     * Handles the stopping of the node.
+     * Disconnects the node and closes the port.
+     */
+    handleStopped() {
+        this._strategy.onStopped();
+        this.disconnect();
+        this.port.close();
+        this.port.onmessage = null;
+        this._state = 'stopped';
+    }
+    /**
+     * Checks if playback has started.
+     * @returns A boolean indicating if playback has started.
+     */
+    get isStart() {
+        return this._state === 'started';
+    }
+    /**
+     * Get the current frame position since the start of playback.
+     * The position is in frames and increases by 1 for each frame.
+     * It represents the total number of frames processed by the AudioWorkletProcessor.
+     * - AudioWorkletProcessor has read this total number of frames from the buffer.
+     *   It closely indicates the playback position in frames.
+     * - totalReadFrames will never exceed the number of frames written to the buffer,
+     *   ensuring it is always less than or equal to totalWriteFrames.
+     * - The difference between totalWriteFrames and totalReadFrames represents the delay
+     *   in samples before playback (excluding processing beyond the AudioNode).
+     * @returns The current frame position as a bigint.
+     */
+    get totalReadFrames() {
+        return Atomics.load(this._totalReadFrames, 0);
+    }
+    /**
+     * Get the total number of frames written to the buffer.
+     * This reflects the total frames written by the BufferWriteStrategy.
+     * Note: The method of writing to the buffer is implemented by the BufferWriteStrategy.
+     * The OutputStreamNode itself does not modify this value.
+     * @returns The total number of frames written as a bigint.
+     */
+    get totalWriteFrames() {
+        return Atomics.load(this._totalWriteFrames, 0);
+    }
+}
+/**
+ * OutputStreamNodeFactory class
+ * Factory class to create instances of OutputStreamNode.
+ */
+export class OutputStreamNodeFactory extends OutputStreamNode {
+    /**
+     * Creates an instance of OutputStreamNodeFactory.
+     * @param audioContext - The audio context to use.
+     * @param info - The configuration for the buffer.
+     * @param strategy - The strategy for writing to the buffer.
+     * @returns A promise that resolves to an instance of OutputStreamNodeFactory.
+     */
+    static async create(audioContext, info, strategy) {
+        const node = new OutputStreamNodeFactory(audioContext, info, strategy);
+        if (!(await strategy.onInit(node))) {
+            throw new Error('Failed to onPrepare.');
+        }
+        return node;
+    }
+}
+//# sourceMappingURL=output-stream-node.js.map

package/dist/output-stream-node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"output-stream-node.js","sourceRoot":"","sources":["../src/output-stream-node.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAkBnD;;;;GAIG;AACH,MAAM,OAAO,gBAAiB,SAAQ,gBAAgB;IACnC,iBAAiB,CAAgB;IACjC,gBAAgB,CAAgB;IAChC,SAAS,CAAqB;IACvC,MAAM,GAAgB,OAAO,CAAA;IAErC;;;;;OAKG;IACH,YACE,gBAAkC,EAClC,YAA+B,EAC/B,QAA6B;QAE7B,MAAM,gBAAgB,GAAiC;YACrD,GAAG,YAAY;YACf,WAAW,EAAE,YAAY,CAAC,eAAe;SAC1C,CAAA;QACD,KAAK,CAAC,gBAAgB,EAAE,cAAc,EAAE;YACtC,kBAAkB,EAAE,CAAC,YAAY,CAAC,eAAe,CAAC;YAClD,gBAAgB;SACjB,CAAC,CAAA;QACF,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAA;QACzB,IAAI,CAAC,iBAAiB,GAAG,YAAY,CAAC,gBAAgB,CAAA;QACtD,IAAI,CAAC,gBAAgB,GAAG,YAAY,CAAC,eAAe,CAAA;QACpD,IAAI,CAAC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACrD,CAAC;IAED;;;;;;OAMG;IACI,KAAK;QACV,IAAI,IAAI,CAAC,eAAe,KAAK,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;QAClE,CAAC;QACD,QAAQ,IAAI,CAAC,MAAM,EAAE,CAAC;YACpB,KAAK,OAAO;gBACV,IAAI,CAAC,MAAM,GAAG,SAAS,CAAA;gBACvB,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBAClC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;gBAClC,CAAC;gBACD,OAAO,IAAI,CAAA;YACb,KAAK,SAAS;gBACZ,OAAO,KAAK,CAAA;YACd;gBACE,MAAM,IAAI,KAAK,CAAC,yCAAyC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAA;QAC3E,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACI,IAAI,CAAC,SAAiB,MAAM,CAAC,CAAC,CAAC;QACpC,QAAQ,IAAI,CAAC,MAAM,EAAE,CAAC;YACpB,KAAK,SAAS;gBACZ,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;oBAC7B,IAAI,CAAC,MAAM,GAAG,UAAU,CAAA;oBACxB,MAAM,OAAO,GAAuB,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAA;oBAC5D,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;oBAC9B,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE;wBACzC,OAAO,EAAE,CAAA;oBACX,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAA;gBACpB,CAAC,CAAC,CAAA;YACJ,KAAK,OAAO;gBACV,IAAI,CAAC,aAAa,EAAE,CAAA;gBACpB,MAAK;YACP;gBACE,MAAM,IAAI,KAAK,CAAC,wCAAwC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAA;QAC1E,CAAC;QACD,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;IAC1B,CAAC;IAED;;;OAGG;IACK,aAAa,CAAC,KAAuC;QAC3D,QAAQ,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACxB,KAAK,MAAM;gBACT,IAAI,CAAC,aAAa,EAAE,CAAA;gBACpB,IAAI,CAAC,aAAa,CAAC,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAA;gBACpD,MAAK;YACP,KAAK,UAAU;gBACb,IAAI,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAA;gBACxD,MAAK;YACP;gBACE,MAAM,IAAI,KAAK,CAAC,2BAA2B,KAAK,CAAC,IAAI,EAAE,CAAC,CAAA;QAC5D,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,aAAa;QACnB,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAA;QAC1B,IAAI,CAAC,UAAU,EAAE,CAAA;QACjB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAA;QACjB,IAAI,CAAC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA;QAC1B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAA;IACzB,CAAC;IAED;;;OAGG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,MAAM,KAAK,SAAS,CAAA;IAClC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAW,eAAe;QACxB,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAA;IAC/C,CAAC;IAED;;;;;;OAMG;IACH,IAAW,gBAAgB;QACzB,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC,CAAA;IAChD,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,uBAAwB,SAAQ,gBAAgB;IAC3D;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,YAA8B,EAAE,IAAuB,EAAE,QAA6B;QAC/G,MAAM,IAAI,GAAG,IAAI,uBAAuB,CAAC,YAAY,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;QACtE,IAAI,CAAC,CAAC,MAAM,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;QACzC,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;CACF"}

package/dist/output-stream-processor.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Options for the OutputStreamProcessor
+ * @property sampleBuffer - The shared buffer for audio data frames.
+ * @property samplesPerFrame - The number of samples per frame.
+ * @property usedFramesInBuffer - The usage count of the frames in the buffer.
+ * @property totalFrames - The current position in the buffer, in frames.
+ */
+export type OutputStreamProcessorOptions = Readonly<{
+    sampleBuffer: Float32Array;
+    samplesPerFrame: number;
+    usedFramesInBuffer: Uint32Array;
+    totalFrames: BigUint64Array;
+}>;

package/dist/output-stream-processor.js

@@ -0,0 +1,99 @@
+import { FrameBufferReader } from './frame-buffer/buffer-reader';
+import { PROCESSOR_NAME } from './constants';
+import { FrameBuffer } from './frame-buffer/buffer';
+const createFrameBufferReader = (options) => {
+    return new FrameBufferReader(new FrameBuffer(options.sampleBuffer, options.samplesPerFrame), options.usedFramesInBuffer, options.totalFrames);
+};
+/**
+ * OutputStreamProcessor class
+ * This class extends AudioWorkletProcessor to process audio data.
+ * It uses a FrameBufferReader instance to read from a shared buffer and manage the audio data.
+ */
+class OutputStreamProcessor extends AudioWorkletProcessor {
+    _frameReader;
+    _shouldStop = false;
+    _stopFrames;
+    _underrunFrames = 0;
+    /**
+     * Creates an instance of OutputStreamProcessor.
+     * @param options - The options for the processor, including shared buffers.
+     */
+    constructor(options) {
+        super();
+        this._frameReader = createFrameBufferReader(options.processorOptions);
+        this.port.onmessage = this.handleMessage.bind(this);
+    }
+    /**
+     * Handles incoming messages from the audio node.
+     * @param event - The message event from the audio node.
+     */
+    handleMessage(event) {
+        if (event.data.type !== 'stop') {
+            throw new Error(`Unexpected message type: ${event.data.type}`);
+        }
+        const frames = event.data.frames;
+        if (frames <= 0) {
+            this._shouldStop = true;
+        }
+        else {
+            this._stopFrames = frames;
+        }
+    }
+    /**
+     * Updates the underrun frame count.
+     * If underrunFrames is provided and not zero, it adds to the current underrun frame count.
+     * If underrunFrames is 0, it indicates that the underrun state has been resolved,
+     * and the total underrun frame count is sent to the main thread before being reset.
+     * @param underrunFrames - The number of underrun frames to add (default is 0).
+     */
+    updateUnderrun(underrunFrames = 0) {
+        if (underrunFrames !== 0) {
+            this._underrunFrames += underrunFrames;
+            return;
+        }
+        if (this._underrunFrames === 0) {
+            return;
+        }
+        this.port.postMessage({ type: 'underrun', frames: this._underrunFrames });
+        this._underrunFrames = 0;
+    }
+    /**
+     * Checks the stop condition.
+     * @param totalFrames - The total number of frames processed so far.
+     */
+    checkStopCondition(totalFrames) {
+        if (this._stopFrames !== undefined && totalFrames >= this._stopFrames) {
+            this._shouldStop = true;
+        }
+    }
+    /**
+     * Processes the audio data.
+     * @param _inputs - The input audio data.
+     * @param outputs - The output audio data.
+     * @returns A boolean indicating whether to continue processing.
+     */
+    process(_inputs, outputs) {
+        const output = outputs[0];
+        const readFrames = this._frameReader.read((frame, offset) => {
+            const frames = Math.min(frame.frames, output[0].length - offset);
+            frame.buffer.convertToOutput(frame.index, frames, output, offset);
+            return frames;
+        });
+        const totalFrames = this._frameReader.totalFrames;
+        this.checkStopCondition(totalFrames);
+        if (this._shouldStop) {
+            this.updateUnderrun();
+            this.port.postMessage({ type: 'stop', frames: totalFrames });
+            this.port.close();
+            return false;
+        }
+        const underrunFrames = output[0].length - readFrames;
+        // It seems process may be called before connect?
+        if (totalFrames !== BigInt(0)) {
+            this.updateUnderrun(underrunFrames);
+        }
+        return true;
+    }
+}
+registerProcessor(PROCESSOR_NAME, OutputStreamProcessor);
+//# sourceMappingURL=output-stream-processor.js.map

package/dist/output-stream-processor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"output-stream-processor.js","sourceRoot":"","sources":["../src/output-stream-processor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAE5C,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAgBnD,MAAM,uBAAuB,GAAG,CAAC,OAAqC,EAAE,EAAE;IACxE,OAAO,IAAI,iBAAiB,CAC1B,IAAI,WAAW,CAAC,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,eAAe,CAAC,EAC9D,OAAO,CAAC,kBAAkB,EAAE,OAAO,CAAC,WAAW,CAChD,CAAA;AACH,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,qBAAsB,SAAQ,qBAAqB;IACtC,YAAY,CAAmB;IACxC,WAAW,GAAG,KAAK,CAAA;IACnB,WAAW,CAAoB;IAC/B,eAAe,GAAG,CAAC,CAAA;IAE3B;;;OAGG;IACH,YAAY,OAAgC;QAC1C,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,YAAY,GAAG,uBAAuB,CAAC,OAAO,CAAC,gBAAgD,CAAC,CAAA;QACrG,IAAI,CAAC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACrD,CAAC;IAED;;;OAGG;IACK,aAAa,CAAC,KAAuC;QAC3D,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,4BAA4B,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;QAChE,CAAC;QACD,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAA;QAChC,IAAI,MAAM,IAAI,CAAC,EAAE,CAAC;YAChB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAA;QACzB,CAAC;aACI,CAAC;YACJ,IAAI,CAAC,WAAW,GAAG,MAAM,CAAA;QAC3B,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACK,cAAc,CAAC,iBAAyB,CAAC;QAC/C,IAAI,cAAc,KAAK,CAAC,EAAE,CAAC;YACzB,IAAI,CAAC,eAAe,IAAI,cAAc,CAAA;YACtC,OAAM;QACR,CAAC;QACD,IAAI,IAAI,CAAC,eAAe,KAAK,CAAC,EAAE,CAAC;YAC/B,OAAM;QACR,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,eAAe,EAAwB,CAAC,CAAA;QAC/F,IAAI,CAAC,eAAe,GAAG,CAAC,CAAA;IAC1B,CAAC;IAED;;;OAGG;IACK,kBAAkB,CAAC,WAAmB;QAC5C,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,IAAI,WAAW,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACtE,IAAI,CAAC,WAAW,GAAG,IAAI,CAAA;QACzB,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAAC,OAAyB,EAAE,OAAyB;QAC1D,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;QACzB,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YAC1D,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,MAAM,CAAC,CAAA;YAChE,KAAK,CAAC,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;YACjE,OAAO,MAAM,CAAA;QACf,CAAC,CAAC,CAAA;QACF,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,CAAA;QACjD,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAA;QACpC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,IAAI,CAAC,cAAc,EAAE,CAAA;YACrB,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAwB,CAAC,CAAA;YAClF,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAA;YACjB,OAAO,KAAK,CAAA;QACd,CAAC;QACD,MAAM,cAAc,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,UAAU,CAAA;QACpD,iDAAiD;QACjD,IAAI,WAAW,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;YAC9B,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,CAAA;QACrC,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AAED,iBAAiB,CAAC,cAAc,EAAE,qBAAqB,CAAC,CAAA"}

package/dist/stream-node-factory.d.ts

@@ -0,0 +1,87 @@
+import type { OutputStreamNode } from './output-stream-node';
+import type { FrameBufferFiller } from './frame-buffer/buffer-filler';
+import { FrameBufferWriter } from './frame-buffer/buffer-writer';
+/**
+ * Parameters for creating a manual buffer node.
+ */
+export type ManualBufferNodeParams = Readonly<{
+    /** The number of audio channels. */
+    channelCount: number;
+    /** The size of the frame buffer in frames. */
+    frameBufferSize: number;
+}>;
+/**
+ * Parameters for creating a timed buffer node.
+ */
+export type TimedBufferNodeParams = Readonly<{
+    /** The number of audio channels. */
+    channelCount: number;
+    /** Optional. The number of chunks in the frame buffer. */
+    frameBufferChunks?: number;
+    /** Optional. The interval in milliseconds for filling the buffer. */
+    fillInterval?: number;
+    /** Optional. The sample rate of the audio context. */
+    sampleRate?: number;
+}>;
+/**
+ * Parameters for creating a worker buffer node.
+ */
+export type WorkerBufferNodeParams<T> = TimedBufferNodeParams & Readonly<{
+    /** Parameters specific to the filler used in the worker. */
+    fillerParams: T;
+}>;
+/**
+ * StreamNodeFactory class
+ * Factory class to create instances of OutputStreamNode with specific BufferWriteStrategy.
+ * This class provides methods to create different types of OutputStreamNodes,
+ * such as those using manual, timed, or worker-based buffer writing strategies.
+ */
+export declare class StreamNodeFactory {
+    private _audioContext;
+    private readonly _outputStreamNodeFactory;
+    /**
+     * Constructor for StreamNodeFactory.
+     * @param context - The AudioContext to use.
+     * @param outputStreamNodeFactory - The factory for creating OutputStreamNode instances.
+     */
+    private constructor();
+    /**
+     * Create an instance of StreamNodeFactory.
+     * This method loads necessary modules and creates node creators.
+     * @param context - The AudioContext to use.
+     * @returns A promise that resolves to an instance of StreamNodeFactory.
+     * @throws Error - If module loading fails.
+     */
+    static create(context: AudioContext): Promise<StreamNodeFactory>;
+    /**
+     * Creates an OutputStreamNode with manual buffer writing strategy.
+     * @param params - The parameters for manual buffer node creation.
+     * @returns A promise that resolves to an OutputStreamNode and FrameBufferWriter instance.
+     */
+    createManualBufferNode(params: ManualBufferNodeParams): Promise<[OutputStreamNode, FrameBufferWriter]>;
+    /**
+     * Creates an OutputStreamNode with timed buffer writing strategy.
+     * @param frameFiller - The FrameBufferFiller instance.
+     * @param params - The parameters for timed buffer node creation.
+     * @returns A promise that resolves to an OutputStreamNode instance.
+     */
+    createTimedBufferNode(frameFiller: FrameBufferFiller, params: TimedBufferNodeParams): Promise<OutputStreamNode>;
+    /**
+     * Creates an OutputStreamNode with worker buffer writing strategy.
+     * @param worker - The worker instance.
+     * @param params - The parameters for worker buffer node creation.
+     * @returns A promise that resolves to an OutputStreamNode instance.
+     */
+    createWorkerBufferNode<FillerParams>(worker: new () => Worker, params: WorkerBufferNodeParams<FillerParams>): Promise<OutputStreamNode>;
+    /**
+     * Validates the parameters for timed buffer node creation.
+     * @param params - The parameters to validate.
+     * @throws Error - If validation fails.
+     */
+    private static validateTimedBufferNodeParams;
+    /**
+     * Get the AudioContext associated with this factory.
+     * @returns The AudioContext instance.
+     */
+    get audioContext(): BaseAudioContext;
+}

package/dist/stream-node-factory.js

@@ -0,0 +1,113 @@
+import processor from './output-stream-processor?worker&url';
+import { ManualBufferWriteStrategy } from './write-strategy/manual';
+import { FrameBufferFactory } from './frame-buffer/buffer-factory';
+import { TimedBufferWriteStrategy } from './write-strategy/timed';
+import { WorkerBufferWriteStrategy } from './write-strategy/worker/strategy';
+/**
+ * StreamNodeFactory class
+ * Factory class to create instances of OutputStreamNode with specific BufferWriteStrategy.
+ * This class provides methods to create different types of OutputStreamNodes,
+ * such as those using manual, timed, or worker-based buffer writing strategies.
+ */
+export class StreamNodeFactory {
+    _audioContext;
+    _outputStreamNodeFactory;
+    /**
+     * Constructor for StreamNodeFactory.
+     * @param context - The AudioContext to use.
+     * @param outputStreamNodeFactory - The factory for creating OutputStreamNode instances.
+     */
+    constructor(context, outputStreamNodeFactory) {
+        this._audioContext = context;
+        this._outputStreamNodeFactory = outputStreamNodeFactory;
+    }
+    /**
+     * Create an instance of StreamNodeFactory.
+     * This method loads necessary modules and creates node creators.
+     * @param context - The AudioContext to use.
+     * @returns A promise that resolves to an instance of StreamNodeFactory.
+     * @throws Error - If module loading fails.
+     */
+    static async create(context) {
+        try {
+            const loadResults = await Promise.all([
+                context.audioWorklet.addModule(processor),
+                import('./output-stream-node'),
+            ]);
+            return new StreamNodeFactory(context, loadResults[1].OutputStreamNodeFactory);
+        }
+        catch (error) {
+            throw new Error('Failed to load modules: ' + error);
+        }
+    }
+    /**
+     * Creates an OutputStreamNode with manual buffer writing strategy.
+     * @param params - The parameters for manual buffer node creation.
+     * @returns A promise that resolves to an OutputStreamNode and FrameBufferWriter instance.
+     */
+    async createManualBufferNode(params) {
+        if (params.channelCount <= 0 || !Number.isInteger(params.channelCount)) {
+            throw new Error('Invalid channelCount: must be a positive integer.');
+        }
+        if (params.frameBufferSize <= 0 || !Number.isInteger(params.frameBufferSize)) {
+            throw new Error('Invalid frameBufferSize: must be a positive integer.');
+        }
+        const bufferConfig = FrameBufferFactory.createFrameBufferConfig({ ...params });
+        const strategy = new ManualBufferWriteStrategy(bufferConfig);
+        return [await this._outputStreamNodeFactory.create(this.audioContext, bufferConfig, strategy), strategy.writer];
+    }
+    /**
+     * Creates an OutputStreamNode with timed buffer writing strategy.
+     * @param frameFiller - The FrameBufferFiller instance.
+     * @param params - The parameters for timed buffer node creation.
+     * @returns A promise that resolves to an OutputStreamNode instance.
+     */
+    async createTimedBufferNode(frameFiller, params) {
+        StreamNodeFactory.validateTimedBufferNodeParams(params);
+        if (typeof frameFiller !== 'object' || frameFiller === null) {
+            throw new Error('Invalid frameFiller: must be an object.');
+        }
+        const config = FrameBufferFactory.createFillerFrameBufferConfig(this._audioContext.sampleRate, { ...params });
+        const strategy = new TimedBufferWriteStrategy(config, frameFiller);
+        return this._outputStreamNodeFactory.create(this.audioContext, config, strategy);
+    }
+    /**
+     * Creates an OutputStreamNode with worker buffer writing strategy.
+     * @param worker - The worker instance.
+     * @param params - The parameters for worker buffer node creation.
+     * @returns A promise that resolves to an OutputStreamNode instance.
+     */
+    async createWorkerBufferNode(worker, params) {
+        StreamNodeFactory.validateTimedBufferNodeParams(params);
+        const config = FrameBufferFactory.createFillerFrameBufferConfig(this._audioContext.sampleRate, { ...params });
+        const strategy = new WorkerBufferWriteStrategy(config, worker, params.fillerParams);
+        return this._outputStreamNodeFactory.create(this._audioContext, config, strategy);
+    }
+    /**
+     * Validates the parameters for timed buffer node creation.
+     * @param params - The parameters to validate.
+     * @throws Error - If validation fails.
+     */
+    static validateTimedBufferNodeParams(params) {
+        // Check if 'channelCount' is a positive integer
+        if (!Number.isInteger(params.channelCount) || params.channelCount <= 0) {
+            throw new Error('Invalid channelCount: must be a positive integer.');
+        }
+        // Check if 'fillInterval' is a positive number if provided
+        if (params.fillInterval !== undefined && (typeof params.fillInterval !== 'number' || params.fillInterval <= 0)) {
+            throw new Error('Invalid fillInterval: must be a positive number.');
+        }
+        // Check if 'frameBufferChunks' is a positive integer if provided
+        if (params.frameBufferChunks !== undefined && (!Number.isInteger(params.frameBufferChunks) || params.frameBufferChunks <= 0)) {
+            throw new Error('Invalid frameBufferChunks: must be a positive integer.');
+        }
+    }
+    /**
+     * Get the AudioContext associated with this factory.
+     * @returns The AudioContext instance.
+     */
+    get audioContext() {
+        return this._audioContext;
+    }
+}
+//# sourceMappingURL=stream-node-factory.js.map

package/dist/stream-node-factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream-node-factory.js","sourceRoot":"","sources":["../src/stream-node-factory.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,sCAAsC,CAAA;AAC5D,OAAO,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAA;AACnE,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAA;AAElE,OAAO,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAA;AAGjE,OAAO,EAAE,yBAAyB,EAAE,MAAM,kCAAkC,CAAA;AAkC5E;;;;;GAKG;AACH,MAAM,OAAO,iBAAiB;IACpB,aAAa,CAAc;IAClB,wBAAwB,CAAgC;IAEzE;;;;OAIG;IACH,YAAoB,OAAqB,EAAE,uBAAuD;QAChG,IAAI,CAAC,aAAa,GAAG,OAAO,CAAA;QAC5B,IAAI,CAAC,wBAAwB,GAAG,uBAAuB,CAAA;IACzD,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAqB;QAC9C,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBACpC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,SAAS,CAAC;gBACzC,MAAM,CAAC,sBAAsB,CAAC;aAC/B,CAAC,CAAA;YACF,OAAO,IAAI,iBAAiB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,uBAAuB,CAAC,CAAA;QAC/E,CAAC;QACD,OAAO,KAAK,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,0BAA0B,GAAG,KAAK,CAAC,CAAA;QACrD,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,sBAAsB,CAAC,MAA8B;QAChE,IAAI,MAAM,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;YACvE,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAA;QACtE,CAAC;QACD,IAAI,MAAM,CAAC,eAAe,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC;YAC7E,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;QACzE,CAAC;QACD,MAAM,YAAY,GAAG,kBAAkB,CAAC,uBAAuB,CAAC,EAAE,GAAG,MAAM,EAAE,CAAC,CAAA;QAC9E,MAAM,QAAQ,GAAG,IAAI,yBAAyB,CAAC,YAAY,CAAC,CAAA;QAC5D,OAAO,CAAC,MAAM,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,YAAY,EAAE,QAAQ,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IACjH,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,qBAAqB,CAChC,WAA8B,EAAE,MAA6B;QAE7D,iBAAiB,CAAC,6BAA6B,CAAC,MAAM,CAAC,CAAA;QACvD,IAAI,OAAO,WAAW,KAAK,QAAQ,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;YAC5D,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAA;QAC5D,CAAC;QACD,MAAM,MAAM,GAAG,kBAAkB,CAAC,6BAA6B,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,CAAA;QAC7G,MAAM,QAAQ,GAAG,IAAI,wBAAwB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;QAClE,OAAO,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAA;IAClF,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,sBAAsB,CACjC,MAAwB,EAAE,MAA4C;QAEtE,iBAAiB,CAAC,6BAA6B,CAAC,MAAM,CAAC,CAAA;QACvD,MAAM,MAAM,GAAG,kBAAkB,CAAC,6BAA6B,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,CAAA;QAC7G,MAAM,QAAQ,GAAG,IAAI,yBAAyB,CAAe,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,YAAY,CAAC,CAAA;QACjG,OAAO,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAA;IACnF,CAAC;IAED;;;;OAIG;IACK,MAAM,CAAC,6BAA6B,CAAC,MAA6B;QACxE,gDAAgD;QAChD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,MAAM,CAAC,YAAY,IAAI,CAAC,EAAE,CAAC;YACvE,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAA;QACtE,CAAC;QAED,2DAA2D;QAC3D,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,IAAI,CAAC,OAAO,MAAM,CAAC,YAAY,KAAK,QAAQ,IAAI,MAAM,CAAC,YAAY,IAAI,CAAC,CAAC,EAAE,CAAC;YAC/G,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAA;QACrE,CAAC;QAED,iEAAiE;QACjE,IAAI,MAAM,CAAC,iBAAiB,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,MAAM,CAAC,iBAAiB,IAAI,CAAC,CAAC,EAAE,CAAC;YAC7H,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAA;QAC3E,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAA;IAC3B,CAAC;CACF"}

package/dist/write-strategy/manual.d.ts

@@ -0,0 +1,36 @@
+import { BufferWriteStrategy } from './strategy';
+import { FrameBufferConfig } from '../frame-buffer/buffer-factory';
+import { FrameBufferWriter } from '../frame-buffer/buffer-writer';
+/**
+  * ManualBufferWriteStrategy class
+  * Implements the BufferWriteStrategy interface for manually writing to the buffer.
+  */
+export declare class ManualBufferWriteStrategy implements BufferWriteStrategy {
+    private readonly _writer;
+    /**
+     * Creates an instance of ManualBufferWriteStrategy.
+     * @param config - The configuration for the frame buffer.
+     */
+    constructor(config: FrameBufferConfig);
+    /**
+     * Gets the FrameBufferWriter instance.
+     * @returns The FrameBufferWriter instance.
+     */
+    get writer(): FrameBufferWriter;
+    /**
+     * Initializes the strategy.
+     * @param node - The OutputStreamNode instance.
+     * @returns A promise that resolves to true when initialization is complete.
+     */
+    onInit(): Promise<boolean>;
+    /**
+     * Starts the strategy.
+     * @param node - The OutputStreamNode instance.
+     * @returns A boolean indicating whether the strategy started successfully.
+     */
+    onStart(): boolean;
+    /**
+     * Stops the strategy.
+     */
+    onStopped(): void;
+}

package/dist/write-strategy/manual.js

@@ -0,0 +1,43 @@
+import { createFrameBufferWriter } from '../frame-buffer/buffer-factory';
+/**
+  * ManualBufferWriteStrategy class
+  * Implements the BufferWriteStrategy interface for manually writing to the buffer.
+  */
+export class ManualBufferWriteStrategy {
+    _writer;
+    /**
+     * Creates an instance of ManualBufferWriteStrategy.
+     * @param config - The configuration for the frame buffer.
+     */
+    constructor(config) {
+        this._writer = createFrameBufferWriter(config);
+    }
+    /**
+     * Gets the FrameBufferWriter instance.
+     * @returns The FrameBufferWriter instance.
+     */
+    get writer() {
+        return this._writer;
+    }
+    /**
+     * Initializes the strategy.
+     * @param node - The OutputStreamNode instance.
+     * @returns A promise that resolves to true when initialization is complete.
+     */
+    async onInit( /* node: OutputStreamNode */) {
+        return true;
+    }
+    /**
+     * Starts the strategy.
+     * @param node - The OutputStreamNode instance.
+     * @returns A boolean indicating whether the strategy started successfully.
+     */
+    onStart( /* node: OutputStreamNode */) {
+        return true;
+    }
+    /**
+     * Stops the strategy.
+     */
+    onStopped() { }
+}
+//# sourceMappingURL=manual.js.map

package/dist/write-strategy/manual.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"manual.js","sourceRoot":"","sources":["../../src/write-strategy/manual.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uBAAuB,EAAqB,MAAM,gCAAgC,CAAA;AAG3F;;;IAGI;AACJ,MAAM,OAAO,yBAAyB;IACnB,OAAO,CAAmB;IAE3C;;;OAGG;IACH,YAAY,MAAyB;QACnC,IAAI,CAAC,OAAO,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAA;IAChD,CAAC;IAED;;;OAGG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,EAAC,4BAA4B;QACvC,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;OAIG;IACH,OAAO,EAAC,4BAA4B;QAClC,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;OAEG;IACH,SAAS,KAAU,CAAC;CACrB"}

package/dist/write-strategy/strategy.d.ts

@@ -0,0 +1,23 @@
+import type { OutputStreamNode } from '../output-stream-node';
+/**
+ * BufferWriteStrategy interface
+ * Defines the methods for buffer writing strategies.
+ */
+export interface BufferWriteStrategy {
+    /**
+     * Initializes the strategy.
+     * @param node - The OutputStreamNode instance.
+     * @returns A promise that resolves to true when initialization is complete.
+     */
+    onInit(node: OutputStreamNode): Promise<boolean>;
+    /**
+     * Starts the strategy.
+     * @param node - The OutputStreamNode instance.
+     * @returns A boolean indicating whether the strategy started successfully.
+     */
+    onStart(node: OutputStreamNode): boolean;
+    /**
+     * Stops the strategy.
+     */
+    onStopped(): void;
+}

package/dist/write-strategy/strategy.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=strategy.js.map

package/dist/write-strategy/strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"strategy.js","sourceRoot":"","sources":["../../src/write-strategy/strategy.ts"],"names":[],"mappings":""}

package/dist/write-strategy/timed.d.ts

@@ -0,0 +1,36 @@
+import { BufferWriteStrategy } from './strategy';
+import { FillerFrameBufferConfig } from '../frame-buffer/buffer-factory';
+import { FrameBufferFiller } from '../frame-buffer/buffer-filler';
+import { OutputStreamNode } from '../output-stream-node';
+/**
+ * TimedBufferWriteStrategy class
+ * Implements the BufferWriteStrategy interface using a timer to manage buffer filling.
+ */
+export declare class TimedBufferWriteStrategy implements BufferWriteStrategy {
+    private readonly _writer;
+    private readonly _filler;
+    private readonly _interval;
+    private readonly _isContinuePlayback;
+    private _context;
+    /**
+     * Creates an instance of TimedBufferWriteStrategy.
+     * @param config - The configuration for the filler frame buffer.
+     * @param filler - The FrameBufferFiller instance.
+     */
+    constructor(config: FillerFrameBufferConfig, filler: FrameBufferFiller);
+    /**
+     * Initializes the strategy.
+     * @returns A promise that resolves to true when initialization is complete.
+     */
+    onInit(): Promise<boolean>;
+    /**
+     * Starts the strategy.
+     * @param node - The OutputStreamNode instance.
+     * @returns A boolean indicating whether the strategy started successfully.
+     */
+    onStart(node: OutputStreamNode): boolean;
+    /**
+     * Stops the strategy.
+     */
+    onStopped(): void;
+}