@ain1084/audio-worklet-stream 0.1.8 → 1.0.0

package/dist/frame-buffer/buffer-writer.js

@@ -1,4 +1,3 @@
-import { enumFrames } from './buffer-utils';
 /**
  * FrameBufferWriter class
  * This class writes audio frame data to a shared Float32Array buffer.
@@ -6,46 +5,68 @@ import { enumFrames } from './buffer-utils';
  */
 export class FrameBufferWriter {
     _frameBuffer;
-    _usedFrameInBuffer;
+    _usedFramesInBuffer;
     _totalFrames;
     _index = 0;
     /**
      * Creates an instance of FrameBufferWriter.
      * @param frameBuffer - The shared buffer to write to.
-     * @param usedFrameInBuffer - The Uint32Array tracking the usage of the buffer.
+     * @param usedFramesInBuffer - The Uint32Array tracking the usage of the buffer.
      * @param totalFrames - The BigUint64Array tracking the total frames written to the buffer.
      */
-    constructor(frameBuffer, usedFrameInBuffer, totalFrames) {
+    constructor(frameBuffer, usedFramesInBuffer, totalFrames) {
         this._frameBuffer = frameBuffer;
-        this._usedFrameInBuffer = usedFrameInBuffer;
+        this._usedFramesInBuffer = usedFramesInBuffer;
         this._totalFrames = totalFrames;
     }
     /**
-     * Get the number of available spaces in the buffer.
-     * @returns The number of available spaces in the buffer.
+     * Get the number of available frames in the buffer.
+     * This represents the number of frames that can be written before the buffer is full.
+     * @returns The number of available frames in the buffer.
      */
-    get available() {
-        return this._frameBuffer.length - Atomics.load(this._usedFrameInBuffer, 0);
+    get availableFrames() {
+        return this._frameBuffer.frameCount - Atomics.load(this._usedFramesInBuffer, 0);
     }
     /**
      * Get the total number of frames written to the buffer.
+     *
      * @returns The total number of frames written.
      */
     get totalFrames() {
+        // This class is not used concurrently by multiple threads,
+        // so `Atomics` is not necessary when reading `totalFrames`.
         return this._totalFrames[0];
     }
     /**
-     * Write audio frame data to the buffer using the provided frameCallback.
-     * @param frameCallback - The frameCallback function to process each section of the buffer.
-     * @returns The number of frames processed.
-     * @throws RangeError - If the processed length exceeds the part length.
+     * Writes audio frame data into the buffer using the provided callback.
+     * This method handles one or more writable segments within the ring buffer
+     * and invokes the callback for each segment.
+     *
+     * @param processFrameSegment - The callback function invoked for each writable segment
+     *   of the ring buffer. It receives:
+     *   1. `buffer`: A Float32Array representing the writable segment of the buffer.
+     *   2. `offset`: The cumulative number of frames processed so far, used as the starting index
+     *      for the current segment relative to the entire data.
+     *   The callback must return the number of frames it successfully wrote.
+     *   If the callback writes fewer frames than available in the current segment,
+     *   processing will stop early.
+     *
+     * @returns The total number of frames written across all segments.
+     *   Note: The return value is in frames, not in samples.
+     *
+     * @throws RangeError - If the processFrameSegment callback returns a written length greater than the available space in the current segment.
+     *
+     * @remarks The buffer is an array of samples, but it is always provided in frame-sized segments.
+     * Each frame consists of multiple samples (e.g., for stereo, a frame contains a sample for the left channel
+     * and one for the right channel). You must access and process the buffer in frame-sized chunks,
+     * based on the structure of the frames.
      */
-    write(frameCallback) {
-        const result = enumFrames(this._frameBuffer, this._index, this.available, frameCallback);
+    write(processFrameSegment) {
+        const result = this._frameBuffer.enumFrameSegments(this._index, this.availableFrames, processFrameSegment);
         this._index = result.nextIndex;
-        Atomics.add(this._usedFrameInBuffer, 0, result.frames);
-        Atomics.add(this._totalFrames, 0, BigInt(result.frames));
-        return result.frames;
+        Atomics.add(this._usedFramesInBuffer, 0, result.totalProcessedFrames);
+        Atomics.add(this._totalFrames, 0, BigInt(result.totalProcessedFrames));
+        return result.totalProcessedFrames;
     }
 }
 //# sourceMappingURL=buffer-writer.js.map

package/dist/frame-buffer/buffer-writer.js.map

@@ -1 +1 @@
-{"version":3,"file":"buffer-writer.js","sourceRoot":"","sources":["../../src/frame-buffer/buffer-writer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAsB,MAAM,gBAAgB,CAAA;AAG/D;;;;GAIG;AACH,MAAM,OAAO,iBAAiB;IACX,YAAY,CAAa;IACzB,kBAAkB,CAAa;IAC/B,YAAY,CAAgB;IACrC,MAAM,GAAW,CAAC,CAAA;IAE1B;;;;;OAKG;IACH,YAAY,WAAwB,EAAE,iBAA8B,EAAE,WAA2B;QAC/F,IAAI,CAAC,YAAY,GAAG,WAAW,CAAA;QAC/B,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,CAAA;QAC3C,IAAI,CAAC,YAAY,GAAG,WAAW,CAAA;IACjC,CAAC;IAED;;;OAGG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAA;IAC5E,CAAC;IAED;;;OAGG;IACH,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;IAC7B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,aAA4B;QACvC,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,aAAa,CAAC,CAAA;QACxF,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,SAAS,CAAA;QAC9B,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,CAAA;QACtD,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAA;QACxD,OAAO,MAAM,CAAC,MAAM,CAAA;IACtB,CAAC;CACF"}
+{"version":3,"file":"buffer-writer.js","sourceRoot":"","sources":["../../src/frame-buffer/buffer-writer.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,OAAO,iBAAiB;IACX,YAAY,CAAa;IACzB,mBAAmB,CAAa;IAChC,YAAY,CAAgB;IACrC,MAAM,GAAW,CAAC,CAAA;IAE1B;;;;;OAKG;IACH,YAAY,WAAwB,EAAE,kBAA+B,EAAE,WAA2B;QAChG,IAAI,CAAC,YAAY,GAAG,WAAW,CAAA;QAC/B,IAAI,CAAC,mBAAmB,GAAG,kBAAkB,CAAA;QAC7C,IAAI,CAAC,YAAY,GAAG,WAAW,CAAA;IACjC,CAAC;IAED;;;;OAIG;IACH,IAAW,eAAe;QACxB,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAA;IACjF,CAAC;IAED;;;;OAIG;IACH,IAAW,WAAW;QACpB,2DAA2D;QAC3D,4DAA4D;QAC5D,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;IAC7B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACI,KAAK,CAAC,mBAAqE;QAChF,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,eAAe,EAAE,mBAAmB,CAAC,CAAA;QAC1G,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,SAAS,CAAA;QAC9B,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,EAAE,MAAM,CAAC,oBAAoB,CAAC,CAAA;QACrE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAA;QACtE,OAAO,MAAM,CAAC,oBAAoB,CAAA;IACpC,CAAC;CACF"}

package/dist/frame-buffer/buffer.d.ts

@@ -5,7 +5,7 @@
 export declare class FrameBuffer {
     private readonly _buffer;
     private readonly _samplesPerFrame;
-    private readonly _length;
+    private readonly _frameCount;
     /**
      * Creates an instance of FrameBuffer.
      * @param buffer - The Float32Array buffer to manage.
@@ -13,28 +13,39 @@ export declare class FrameBuffer {
      */
     constructor(buffer: Float32Array, samplesPerFrame: number);
     /**
-     * Sets the frame data in the buffer.
-     * @param index - The starting index in the buffer.
-     * @param samples - The samples to set in the buffer.
-     * @param sampleStart - The starting position in the samples array (default is 0).
-     * @param sampleCount - The number of samples to set (default is the length of the samples array).
-     * @returns A number of written frames.
-     * @throws Error - If the number of samples per frame does not match the specified number of samples.
+     * Gets the count of the buffer in frames.
+     * @returns The count of the buffer in frames.
      */
-    setFrames(index: number, samples: Float32Array, sampleStart?: number, sampleCount?: number): number;
+    get frameCount(): number;
+    private getFrames;
     /**
-     * Converts the frame data to output.
-     * This method is intended to be called from within the process method of the AudioWorkletProcessor.
-     * It converts the interleaved frame data to the structure expected by the process method's outputs.
-     * @param frameIndex - The index of the frame to convert.
-     * @param frames - The number of frames to convert.
-     * @param output - The output array to store the converted data.
-     * @param outputOffset - The offset in the output array at which to start storing the data.
+     * Processes sections of a Float32Array buffer using a callback function.
+     * This function handles one or more segments within the ring buffer and invokes
+     * the provided callback for each segment. It is intended for internal use only.
+     *
+     * @param startIndex - The starting index in the buffer from where processing should begin.
+     * @param availableFrames - The total number of frames available to process in the buffer.
+     * @param processFrameSegment - The callback function invoked for each segment
+     *   of the ring buffer during enumeration. It receives:
+     *   1. `buffer`: A Float32Array representing the segment to process. The buffer is an array
+     *      of samples but is always provided in frame-sized segments.
+     *   2. `offset`: The cumulative number of frames processed so far, used as the starting index
+     *      for the current segment relative to the entire data.
+     *   The callback must return the number of frames it successfully processed.
+     *   If the callback processes fewer frames than available in the current segment,
+     *   processing will stop early.
+     *
+     * @returns An object containing:
+     *          - totalProcessedFrames: The number of frames successfully processed.
+     *          - nextIndex: The index in the buffer for the next processing cycle.
+     *
+     * @throws RangeError - If the processFrameSegment callback returns a processed length greater than the available section length.
+     *
+     * @remarks The buffer is always provided in frame-sized segments, meaning that the buffer contains complete frames.
+     * You must process the buffer in frame-sized chunks based on the structure of the frames.
      */
-    convertToOutput(frameIndex: number, frames: number, output: Float32Array[], outputOffset: number): void;
-    /**
-     * Gets the length of the buffer in frames.
-     * @returns The length of the buffer in frames.
-     */
-    get length(): number;
+    enumFrameSegments(startIndex: number, availableFrames: number, processFrameSegment: (buffer: Float32Array, offset: number) => number): {
+        totalProcessedFrames: number;
+        nextIndex: number;
+    };
 }

package/dist/frame-buffer/buffer.js

@@ -5,7 +5,7 @@
 export class FrameBuffer {
     _buffer;
     _samplesPerFrame;
-    _length;
+    _frameCount;
     /**
      * Creates an instance of FrameBuffer.
      * @param buffer - The Float32Array buffer to manage.
@@ -14,52 +14,62 @@ export class FrameBuffer {
     constructor(buffer, samplesPerFrame) {
         this._buffer = buffer;
         this._samplesPerFrame = samplesPerFrame;
-        this._length = Math.floor(buffer.length / samplesPerFrame);
+        this._frameCount = Math.floor(buffer.length / samplesPerFrame);
     }
     /**
-     * Sets the frame data in the buffer.
-     * @param index - The starting index in the buffer.
-     * @param samples - The samples to set in the buffer.
-     * @param sampleStart - The starting position in the samples array (default is 0).
-     * @param sampleCount - The number of samples to set (default is the length of the samples array).
-     * @returns A number of written frames.
-     * @throws Error - If the number of samples per frame does not match the specified number of samples.
+     * Gets the count of the buffer in frames.
+     * @returns The count of the buffer in frames.
      */
-    setFrames(index, samples, sampleStart = 0, sampleCount) {
-        index *= this._samplesPerFrame;
-        const sampleEnd = (sampleCount !== undefined) ? Math.min(sampleStart + sampleCount, samples.length) : samples.length;
-        const frames = (sampleEnd - sampleStart) / this._samplesPerFrame;
-        if (!Number.isInteger(frames)) {
-            throw new Error(`Error: The number of samples per frame does not match the specified number of samples. Expected samples per frame: ${this._samplesPerFrame}, but got: ${sampleEnd - sampleStart}.`);
-        }
-        for (let sampleIndex = sampleStart; sampleIndex < sampleEnd; ++sampleIndex, ++index) {
-            this._buffer[index] = samples[sampleIndex];
-        }
-        return frames;
+    get frameCount() {
+        return this._frameCount;
     }
-    /**
-     * Converts the frame data to output.
-     * This method is intended to be called from within the process method of the AudioWorkletProcessor.
-     * It converts the interleaved frame data to the structure expected by the process method's outputs.
-     * @param frameIndex - The index of the frame to convert.
-     * @param frames - The number of frames to convert.
-     * @param output - The output array to store the converted data.
-     * @param outputOffset - The offset in the output array at which to start storing the data.
-     */
-    convertToOutput(frameIndex, frames, output, outputOffset) {
-        const samplesPerFrame = this._samplesPerFrame;
-        output.forEach((outputChannel, channelNumber) => {
-            for (let i = channelNumber, j = 0; j < frames; i += samplesPerFrame, ++j) {
-                outputChannel[outputOffset + j] = this._buffer[frameIndex + i];
-            }
-        });
+    getFrames(index, count) {
+        return this._buffer.subarray(index * this._samplesPerFrame, (index + count) * this._samplesPerFrame);
     }
     /**
-     * Gets the length of the buffer in frames.
-     * @returns The length of the buffer in frames.
+     * Processes sections of a Float32Array buffer using a callback function.
+     * This function handles one or more segments within the ring buffer and invokes
+     * the provided callback for each segment. It is intended for internal use only.
+     *
+     * @param startIndex - The starting index in the buffer from where processing should begin.
+     * @param availableFrames - The total number of frames available to process in the buffer.
+     * @param processFrameSegment - The callback function invoked for each segment
+     *   of the ring buffer during enumeration. It receives:
+     *   1. `buffer`: A Float32Array representing the segment to process. The buffer is an array
+     *      of samples but is always provided in frame-sized segments.
+     *   2. `offset`: The cumulative number of frames processed so far, used as the starting index
+     *      for the current segment relative to the entire data.
+     *   The callback must return the number of frames it successfully processed.
+     *   If the callback processes fewer frames than available in the current segment,
+     *   processing will stop early.
+     *
+     * @returns An object containing:
+     *          - totalProcessedFrames: The number of frames successfully processed.
+     *          - nextIndex: The index in the buffer for the next processing cycle.
+     *
+     * @throws RangeError - If the processFrameSegment callback returns a processed length greater than the available section length.
+     *
+     * @remarks The buffer is always provided in frame-sized segments, meaning that the buffer contains complete frames.
+     * You must process the buffer in frame-sized chunks based on the structure of the frames.
      */
-    get length() {
-        return this._length;
+    enumFrameSegments(startIndex, availableFrames, processFrameSegment) {
+        let totalProcessedFrames = 0;
+        while (totalProcessedFrames < availableFrames) {
+            // Determine the length of the current section to process
+            const sectionFrames = Math.min(this.frameCount - startIndex, availableFrames - totalProcessedFrames);
+            // Process the current section using the frameCallback function
+            const processedFrames = processFrameSegment(this.getFrames(startIndex, sectionFrames), totalProcessedFrames);
+            // Ensure the processed length does not exceed the section length
+            if (processedFrames > sectionFrames) {
+                throw new RangeError(`Processed frames (${processedFrames}) exceeds section frames (${sectionFrames})`);
+            }
+            totalProcessedFrames += processedFrames;
+            startIndex = (startIndex + processedFrames) % this.frameCount;
+            if (processedFrames < sectionFrames) {
+                break;
+            }
+        }
+        return { totalProcessedFrames, nextIndex: startIndex };
     }
 }
 //# sourceMappingURL=buffer.js.map

package/dist/frame-buffer/buffer.js.map

@@ -1 +1 @@
-{"version":3,"file":"buffer.js","sourceRoot":"","sources":["../../src/frame-buffer/buffer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,OAAO,WAAW;IACL,OAAO,CAAc;IACrB,gBAAgB,CAAQ;IACxB,OAAO,CAAQ;IAEhC;;;;OAIG;IACH,YAAmB,MAAoB,EAAE,eAAuB;QAC9D,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QACrB,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAA;QACvC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,eAAe,CAAC,CAAA;IAC5D,CAAC;IAED;;;;;;;;OAQG;IACI,SAAS,CAAC,KAAa,EAAE,OAAqB,EAAE,cAAsB,CAAC,EAAE,WAAoB;QAClG,KAAK,IAAI,IAAI,CAAC,gBAAgB,CAAA;QAC9B,MAAM,SAAS,GAAG,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,GAAG,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAA;QACpH,MAAM,MAAM,GAAG,CAAC,SAAS,GAAG,WAAW,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAA;QAChE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,sHAAsH,IAAI,CAAC,gBAAgB,cAAc,SAAS,GAAG,WAAW,GAAG,CAAC,CAAA;QACtM,CAAC;QACD,KAAK,IAAI,WAAW,GAAG,WAAW,EAAE,WAAW,GAAG,SAAS,EAAE,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,CAAC;YACpF,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;QAC5C,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;;;;;;;OAQG;IACI,eAAe,CAAC,UAAkB,EAAE,MAAc,EAAE,MAAsB,EAAE,YAAoB;QACrG,MAAM,eAAe,GAAG,IAAI,CAAC,gBAAgB,CAAA;QAC7C,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,aAAa,EAAE,EAAE;YAC9C,KAAK,IAAI,CAAC,GAAG,aAAa,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,IAAI,eAAe,EAAE,EAAE,CAAC,EAAE,CAAC;gBACzE,aAAa,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,GAAG,CAAC,CAAC,CAAA;YAChE,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;OAGG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;CACF"}
+{"version":3,"file":"buffer.js","sourceRoot":"","sources":["../../src/frame-buffer/buffer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,OAAO,WAAW;IACL,OAAO,CAAc;IACrB,gBAAgB,CAAQ;IACxB,WAAW,CAAQ;IAEpC;;;;OAIG;IACH,YAAmB,MAAoB,EAAE,eAAuB;QAC9D,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QACrB,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAA;QACvC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,eAAe,CAAC,CAAA;IAChE,CAAC;IAED;;;OAGG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAA;IACzB,CAAC;IAEO,SAAS,CAAC,KAAa,EAAE,KAAa;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC,KAAK,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAA;IACtG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACI,iBAAiB,CAAC,UAAkB,EAAE,eAAuB,EAClE,mBAAqE;QACrE,IAAI,oBAAoB,GAAG,CAAC,CAAA;QAC5B,OAAO,oBAAoB,GAAG,eAAe,EAAE,CAAC;YAC9C,yDAAyD;YACzD,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,GAAG,UAAU,EAAE,eAAe,GAAG,oBAAoB,CAAC,CAAA;YACpG,+DAA+D;YAC/D,MAAM,eAAe,GAAG,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,aAAa,CAAC,EAAE,oBAAoB,CAAC,CAAA;YAC5G,iEAAiE;YACjE,IAAI,eAAe,GAAG,aAAa,EAAE,CAAC;gBACpC,MAAM,IAAI,UAAU,CAAC,qBAAqB,eAAe,6BAA6B,aAAa,GAAG,CAAC,CAAA;YACzG,CAAC;YACD,oBAAoB,IAAI,eAAe,CAAA;YACvC,UAAU,GAAG,CAAC,UAAU,GAAG,eAAe,CAAC,GAAG,IAAI,CAAC,UAAU,CAAA;YAC7D,IAAI,eAAe,GAAG,aAAa,EAAE,CAAC;gBACpC,MAAK;YACP,CAAC;QACH,CAAC;QACD,OAAO,EAAE,oBAAoB,EAAE,SAAS,EAAE,UAAU,EAAE,CAAA;IACxD,CAAC;CACF"}

package/dist/output-message.d.ts

@@ -4,24 +4,24 @@
  * @typeParam type - The type of message. Can be 'stop' or 'underrun'.
  *
  * For 'stop' messages:
- * @property frames - The total frames processed when stopped.
+ * @property totalProcessedFrames - The total frames processed when stopped.
  *
  * For 'underrun' messages:
- * @property frames - The number of frames that have been underrun.
+ * @property underrunFrameCount - The number of frames that have been underrun.
  *
  * Example:
  * ```typescript
- * const message: MessageToAudioNode = { type: 'stop', frames: 1000n };
+ * const message: MessageToAudioNode = { type: 'stop', totalProcessedFrames: 1000n };
  * // or
- * const message: MessageToAudioNode = { type: 'underrun', frames: 256 };
+ * const message: MessageToAudioNode = { type: 'underrun', underrunFrameCount: 256 };
  * ```
  */
 export type MessageToAudioNode = {
     type: 'stop';
-    frames: bigint;
+    totalProcessedFrames: bigint;
 } | {
     type: 'underrun';
-    frames: number;
+    underrunFrameCount: number;
 };
 /**
  * Messages sent from the main thread to the processor.
@@ -29,14 +29,14 @@ export type MessageToAudioNode = {
  * @typeParam type - The type of message. Can be 'stop'.
  *
  * For 'stop' messages:
- * @property frames - The position in frames to stop at.
+ * @property framePosition - The position in frames to stop at.
  *
  * Example:
  * ```typescript
- * const message: MessageToProcessor = { type: 'stop', frames: 1000n };
+ * const message: MessageToProcessor = { type: 'stop', framePosition: 1000n };
  * ```
  */
 export type MessageToProcessor = {
     type: 'stop';
-    frames: bigint;
+    framePosition: bigint;
 };

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

@@ -1,5 +1,5 @@
 import { BufferWriteStrategy } from './write-strategy/strategy';
-import { FrameBufferConfig } from './frame-buffer/buffer-factory';
+import { FrameBufferConfig } from './frame-buffer/buffer-config';
 /**
  * Stream state
  * Represents the different states of the stream.
@@ -21,7 +21,15 @@ export declare class OutputStreamNode extends AudioWorkletNode {
      * @param bufferConfig - The configuration for the buffer.
      * @param strategy - The strategy for writing to the buffer.
      */
-    protected constructor(baseAudioContext: BaseAudioContext, bufferConfig: FrameBufferConfig, strategy: BufferWriteStrategy);
+    private constructor();
+    /**
+     * Creates an instance of OutputStreamNode.
+     * @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 OutputStreamNode.
+     */
+    static create(audioContext: BaseAudioContext, info: FrameBufferConfig, strategy: BufferWriteStrategy): Promise<OutputStreamNode>;
     /**
      * Start playback.
      * The node must be connected before starting playback using connect() method.
@@ -34,12 +42,12 @@ export declare class OutputStreamNode extends AudioWorkletNode {
      * 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,
+     * @param framePosition - The frame position at which to stop the processing, in frames.
+     *                   If framePosition 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): Promise<void>;
+    stop(framePosition?: bigint): Promise<void>;
     /**
      * Handles incoming messages from the audio processor.
      * @param event - The message event from the processor.
@@ -77,17 +85,3 @@ export declare class OutputStreamNode extends AudioWorkletNode {
      */
     get totalWriteFrames(): bigint;
 }
-/**
- * OutputStreamNodeFactory class
- * Factory class to create instances of OutputStreamNode.
- */
-export declare 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 create(audioContext: BaseAudioContext, info: FrameBufferConfig, strategy: BufferWriteStrategy): Promise<OutputStreamNode>;
-}

package/dist/output-stream-node.js

@@ -30,6 +30,20 @@ export class OutputStreamNode extends AudioWorkletNode {
         this._totalReadFrames = bufferConfig.totalReadFrames;
         this.port.onmessage = this.handleMessage.bind(this);
     }
+    /**
+     * Creates an instance of OutputStreamNode.
+     * @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 OutputStreamNode.
+     */
+    static async create(audioContext, info, strategy) {
+        const node = new OutputStreamNode(audioContext, info, strategy);
+        if (!(await strategy.onInit(node))) {
+            throw new Error('Failed to onInit.');
+        }
+        return node;
+    }
     /**
      * Start playback.
      * The node must be connected before starting playback using connect() method.
@@ -58,17 +72,17 @@ export class OutputStreamNode extends AudioWorkletNode {
      * 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,
+     * @param framePosition - The frame position at which to stop the processing, in frames.
+     *                   If framePosition 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)) {
+    stop(framePosition = BigInt(0)) {
         switch (this._state) {
             case 'started':
                 return new Promise((resolve) => {
                     this._state = 'stopping';
-                    const message = { type: 'stop', frames };
+                    const message = { type: 'stop', framePosition: framePosition };
                     this.port.postMessage(message);
                     this.addEventListener(StopEvent.type, () => {
                         resolve();
@@ -94,10 +108,10 @@ export class OutputStreamNode extends AudioWorkletNode {
         switch (event.data.type) {
             case 'stop':
                 this.handleStopped();
-                this.dispatchEvent(new StopEvent(event.data.frames));
+                this.dispatchEvent(new StopEvent(event.data.totalProcessedFrames));
                 break;
             case 'underrun':
-                this.dispatchEvent(new UnderrunEvent(event.data.frames));
+                this.dispatchEvent(new UnderrunEvent(event.data.underrunFrameCount));
                 break;
             default:
                 throw new Error(`Unexpected event value: ${event.data}`);
@@ -147,24 +161,4 @@ export class OutputStreamNode extends AudioWorkletNode {
         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

@@ -1 +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,KAAK,SAAS;gBACZ,MAAK;YACP,KAAK,UAAU;gBACb,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"}
+{"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,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,YAA8B,EAAE,IAAuB,EAAE,QAA6B;QAC/G,MAAM,IAAI,GAAG,IAAI,gBAAgB,CAAC,YAAY,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;QAC/D,IAAI,CAAC,CAAC,MAAM,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAA;QACtC,CAAC;QACD,OAAO,IAAI,CAAA;IACb,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,gBAAwB,MAAM,CAAC,CAAC,CAAC;QAC3C,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,aAAa,EAAE,aAAa,EAAE,CAAA;oBAClF,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,KAAK,SAAS;gBACZ,MAAK;YACP,KAAK,UAAU;gBACb,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,oBAAoB,CAAC,CAAC,CAAA;gBAClE,MAAK;YACP,KAAK,UAAU;gBACb,IAAI,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAA;gBACpE,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"}

package/dist/output-stream-processor.js

@@ -12,8 +12,8 @@ const createFrameBufferReader = (options) => {
 class OutputStreamProcessor extends AudioWorkletProcessor {
     _frameReader;
     _shouldStop = false;
-    _stopFrames;
-    _underrunFrames = 0;
+    _stopFramePosition;
+    _underrunFrameCount = 0;
     /**
      * Creates an instance of OutputStreamProcessor.
      * @param options - The options for the processor, including shared buffers.
@@ -31,12 +31,12 @@ class OutputStreamProcessor extends AudioWorkletProcessor {
         if (event.data.type !== 'stop') {
             throw new Error(`Unexpected message type: ${event.data.type}`);
         }
-        const frames = event.data.frames;
-        if (frames <= 0) {
+        const framePosition = event.data.framePosition;
+        if (framePosition <= 0) {
             this._shouldStop = true;
         }
         else {
-            this._stopFrames = frames;
+            this._stopFramePosition = framePosition;
         }
     }
     /**
@@ -44,25 +44,25 @@ class OutputStreamProcessor extends AudioWorkletProcessor {
      * 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).
+     * @param underrunFrameCount - The number of underrun frames to add (default is 0).
      */
-    updateUnderrun(underrunFrames = 0) {
-        if (underrunFrames !== 0) {
-            this._underrunFrames += underrunFrames;
+    updateUnderrun(underrunFrameCount = 0) {
+        if (underrunFrameCount !== 0) {
+            this._underrunFrameCount += underrunFrameCount;
             return;
         }
-        if (this._underrunFrames === 0) {
+        if (this._underrunFrameCount === 0) {
             return;
         }
-        this.port.postMessage({ type: 'underrun', frames: this._underrunFrames });
-        this._underrunFrames = 0;
+        this.port.postMessage({ type: 'underrun', underrunFrameCount: this._underrunFrameCount });
+        this._underrunFrameCount = 0;
     }
     /**
      * Checks the stop condition.
      * @param totalFrames - The total number of frames processed so far.
      */
     checkStopCondition(totalFrames) {
-        if (this._stopFrames !== undefined && totalFrames >= this._stopFrames) {
+        if (this._stopFramePosition !== undefined && totalFrames >= this._stopFramePosition) {
             this._shouldStop = true;
         }
     }
@@ -74,16 +74,23 @@ class OutputStreamProcessor extends AudioWorkletProcessor {
      */
     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 samplesPerFrame = output.length;
+        const readFrames = this._frameReader.read((buffer, offset) => {
+            const bufferFrameCount = buffer.length / samplesPerFrame;
+            const frameCount = Math.min(bufferFrameCount, output[0].length - offset);
+            // Deinterleaves interleaved audio frame data and writes it to the output.
+            output.forEach((outputChannel, channelIndex) => {
+                for (let i = channelIndex, j = 0; j < frameCount; i += samplesPerFrame, ++j) {
+                    outputChannel[offset + j] = buffer[i];
+                }
+            });
+            return frameCount;
         });
         const totalFrames = this._frameReader.totalFrames;
         this.checkStopCondition(totalFrames);
         if (this._shouldStop) {
             this.updateUnderrun();
-            this.port.postMessage({ type: 'stop', frames: totalFrames });
+            this.port.postMessage({ type: 'stop', totalProcessedFrames: totalFrames });
             this.port.close();
             return false;
         }

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

@@ -1 +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"}
+{"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,kBAAkB,CAAoB;IACtC,mBAAmB,GAAG,CAAC,CAAA;IAE/B;;;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,aAAa,GAAG,KAAK,CAAC,IAAI,CAAC,aAAa,CAAA;QAC9C,IAAI,aAAa,IAAI,CAAC,EAAE,CAAC;YACvB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAA;QACzB,CAAC;aACI,CAAC;YACJ,IAAI,CAAC,kBAAkB,GAAG,aAAa,CAAA;QACzC,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACK,cAAc,CAAC,qBAA6B,CAAC;QACnD,IAAI,kBAAkB,KAAK,CAAC,EAAE,CAAC;YAC7B,IAAI,CAAC,mBAAmB,IAAI,kBAAkB,CAAA;YAC9C,OAAM;QACR,CAAC;QACD,IAAI,IAAI,CAAC,mBAAmB,KAAK,CAAC,EAAE,CAAC;YACnC,OAAM;QACR,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,kBAAkB,EAAE,IAAI,CAAC,mBAAmB,EAAwB,CAAC,CAAA;QAC/G,IAAI,CAAC,mBAAmB,GAAG,CAAC,CAAA;IAC9B,CAAC;IAED;;;OAGG;IACK,kBAAkB,CAAC,WAAmB;QAC5C,IAAI,IAAI,CAAC,kBAAkB,KAAK,SAAS,IAAI,WAAW,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACpF,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,eAAe,GAAG,MAAM,CAAC,MAAM,CAAA;QACrC,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE;YAC3D,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,GAAG,eAAe,CAAA;YACxD,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,MAAM,CAAC,CAAA;YACxE,0EAA0E;YAC1E,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,YAAY,EAAE,EAAE;gBAC7C,KAAK,IAAI,CAAC,GAAG,YAAY,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,EAAE,CAAC,IAAI,eAAe,EAAE,EAAE,CAAC,EAAE,CAAC;oBAC5E,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;gBACvC,CAAC;YACH,CAAC,CAAC,CAAA;YACF,OAAO,UAAU,CAAA;QACnB,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,oBAAoB,EAAE,WAAW,EAAwB,CAAC,CAAA;YAChG,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

@@ -79,6 +79,16 @@ export declare class StreamNodeFactory {
      * @throws Error - If validation fails.
      */
     private static validateTimedBufferNodeParams;
+    /**
+     * Applies a default sample rate to the given parameters if the sampleRate is undefined.
+     * This function creates a new TimedBufferNodeParams object with the specified sampleRate,
+     * while keeping other properties unchanged.
+     *
+     * @param params - The original parameters for the TimedBufferNode.
+     * @param defaultSampleRate - The default sample rate to use if params.sampleRate is undefined.
+     * @returns A new TimedBufferNodeParams object with the sample rate applied.
+     */
+    private static applySampleRateToParams;
     /**
      * Get the AudioContext associated with this factory.
      * @returns The AudioContext instance.