@ain1084/audio-worklet-stream 0.1.7 → 1.0.0

package/README.md

@@ -33,6 +33,7 @@ This library uses modern Web APIs and is designed for contemporary browsers only
 |Worker-Based Stability|✅|✅|✅|✅|❓|✅|❓|
 
 Legend:
+
 - ✅: Confirmed and working without issues
 - 🔺: Confirmed with limitations (e.g., unstable in background operation)
 - ❓: Not yet confirmed
@@ -61,7 +62,8 @@ npm install @ain1084/audio-worklet-stream
 
 You need to add `@ain1084/audio-worklet-stream` to the optimizeDeps.exclude section in `vite.config.ts`. Furthermore, include the necessary CORS settings to enable the use of `SharedArrayBuffer`.
 
-**vite.config.ts**
+### vite.config.ts
+
 ```typescript
 import { defineConfig } from 'vite'
 
@@ -86,7 +88,8 @@ export default defineConfig({
 
 If you are using Nuxt3, add it under vite in `nuxt.config.ts`.
 
-**nuxt.config.ts**
+### nuxt.config.ts
+
 ```typescript
 export default defineNuxtConfig({
   vite: {
@@ -141,6 +144,7 @@ Instances of OutputStreamNode cannot be constructed directly. First, an instance
 The library does not handle the construction or destruction of AudioContext. When constructing AudioContext, be sure to do so in response to a user interaction, such as a UI event (e.g., button press).
 
 Example:
+
 ```typescript
 let audioContext: AudioContext | null = null
 let factory: StreamNodeFactory | null = null
@@ -200,10 +204,12 @@ As outlined in the overview, OutputStreamNode requires external audio samples. T
 Understanding these parameters is crucial for optimal audio performance:
 
 ### channelCount (All strategies)
+
 - Specifies the number of audio channels (e.g., 2 for stereo).
 - Determines the sample composition within each frame.
 
 ### frameBufferSize (Manual strategy only)
+
 - Defines the size of the ring buffer in frames.
 - For continuous streaming, new frames must be supplied before buffer depletion.
 - Larger size: Less susceptible to interruptions, but increases latency.
@@ -212,15 +218,18 @@ Understanding these parameters is crucial for optimal audio performance:
 - Timed/Worker strategies: Calculated internally based on fillInterval.
 
 ### fillInterval (Timed and Worker strategies only)
+
 - Specifies the interval for buffer refill timer.
 - Default: 20ms.
 
 ### frameBufferChunks (Timed and Worker strategies only)
+
 - Specifies the number of chunks in the total buffer size.
 - Default: 5.
 
 Example calculation:
 For 48kHz sample rate and 20ms fillInterval:
+
 - One chunk size = 48000 * 0.02 = 960 frames
 - Total buffer size with default 5 chunks = 960 * 5 = 4800 frames
 
@@ -299,30 +308,6 @@ By following these guidelines, you can ensure that your audio application runs e
 
 This guide covers advanced usage scenarios and techniques for the Audio Worklet Stream Library.
 
-### Custom Buffer Filling Strategies
-
-While the library provides manual, timed, and worker-based strategies, you can create custom strategies:
-
-1. Implement the `BufferWriteStrategy` interface.
-2. Override the `onInit`, `onStart`, and `onStopped` methods to define your custom behavior.
-
-Example:
-```typescript
-class CustomStrategy implements BufferWriteStrategy {
-  async onInit(node: OutputStreamNode): Promise<boolean> {
-    // Custom initialization logic
-  }
-
-  onStart(node: OutputStreamNode): boolean {
-    // Custom start logic
-  }
-
-  onStopped(): void {
-    // Custom stop logic
-  }
-}
-```
-
 ### Advanced Worker Usage
 
 For complex audio processing tasks:
@@ -451,7 +436,7 @@ When using `@ain1084/audio-worklet-stream` in a Nuxt 3 project, you may encounte
 
    You can disable SSR for the component that uses the package. This can be done by using `<client-only>`:
 
-   ```
+   ```vue
    <client-only>
      <MyComponent />
    </client-only>

package/dist/events.d.ts

@@ -3,13 +3,13 @@
  * This event is dispatched when the audio processing stops.
  */
 export declare class StopEvent extends Event {
-    readonly frames: bigint;
+    readonly stoppedAtFrame: bigint;
     static readonly type = "@ain1084/audio-worklet-stream/stop";
     /**
      * Creates an instance of StopEvent.
-     * @param frames - The position in the audio stream where the stop occurred.
+     * @param stoppedAtFrame - The position in the audio stream where the stop occurred.
      */
-    constructor(frames: bigint);
+    constructor(stoppedAtFrame: bigint);
 }
 /**
  * Represents a custom event indicating that an underrun occurred in the audio processing.
@@ -17,13 +17,13 @@ export declare class StopEvent extends Event {
  * or just before the node stops.
  */
 export declare class UnderrunEvent extends Event {
-    readonly frames: number;
+    readonly frameCount: number;
     static readonly type = "@ain1084/audio-worklet-stream/underrun";
     /**
      * Creates an instance of UnderrunEvent.
-     * @param frames - The number of frames that were not processed due to the underrun.
+     * @param frameCount - The number of frames that were not processed due to the underrun.
      */
-    constructor(frames: number);
+    constructor(frameCount: number);
 }
 /**
  * Extends the AudioWorkletNodeEventMap interface to include the custom events.

package/dist/events.js

@@ -4,15 +4,15 @@ import { STOP_EVENT_TYPE, UNDERRUN_EVENT_TYPE } from './constants';
  * This event is dispatched when the audio processing stops.
  */
 export class StopEvent extends Event {
-    frames;
+    stoppedAtFrame;
     static type = STOP_EVENT_TYPE;
     /**
      * Creates an instance of StopEvent.
-     * @param frames - The position in the audio stream where the stop occurred.
+     * @param stoppedAtFrame - The position in the audio stream where the stop occurred.
      */
-    constructor(frames) {
+    constructor(stoppedAtFrame) {
         super(StopEvent.type);
-        this.frames = frames;
+        this.stoppedAtFrame = stoppedAtFrame;
     }
 }
 /**
@@ -21,15 +21,15 @@ export class StopEvent extends Event {
  * or just before the node stops.
  */
 export class UnderrunEvent extends Event {
-    frames;
+    frameCount;
     static type = UNDERRUN_EVENT_TYPE;
     /**
      * Creates an instance of UnderrunEvent.
-     * @param frames - The number of frames that were not processed due to the underrun.
+     * @param frameCount - The number of frames that were not processed due to the underrun.
      */
-    constructor(frames) {
+    constructor(frameCount) {
         super(UnderrunEvent.type);
-        this.frames = frames;
+        this.frameCount = frameCount;
     }
 }
 //# sourceMappingURL=events.js.map

package/dist/events.js.map

@@ -1 +1 @@
-{"version":3,"file":"events.js","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAA;AAElE;;;GAGG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAK;IAMN;IALrB,MAAM,CAAU,IAAI,GAAG,eAAe,CAAA;IAC7C;;;OAGG;IACH,YAA4B,MAAc;QACxC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;QADK,WAAM,GAAN,MAAM,CAAQ;IAE1C,CAAC;;AAGH;;;;GAIG;AACH,MAAM,OAAO,aAAc,SAAQ,KAAK;IAMV;IALrB,MAAM,CAAU,IAAI,GAAG,mBAAmB,CAAA;IACjD;;;OAGG;IACH,YAA4B,MAAc;QACxC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA;QADC,WAAM,GAAN,MAAM,CAAQ;IAE1C,CAAC"}
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAA;AAElE;;;GAGG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAK;IAMN;IALrB,MAAM,CAAU,IAAI,GAAG,eAAe,CAAA;IAC7C;;;OAGG;IACH,YAA4B,cAAsB;QAChD,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;QADK,mBAAc,GAAd,cAAc,CAAQ;IAElD,CAAC;;AAGH;;;;GAIG;AACH,MAAM,OAAO,aAAc,SAAQ,KAAK;IAMV;IALrB,MAAM,CAAU,IAAI,GAAG,mBAAmB,CAAA;IACjD;;;OAGG;IACH,YAA4B,UAAkB;QAC5C,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA;QADC,eAAU,GAAV,UAAU,CAAQ;IAE9C,CAAC"}

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

@@ -0,0 +1,67 @@
+import { FrameBufferWriter } from './buffer-writer';
+/**
+ * Parameters for creating a FrameBuffer.
+ * @property frameBufferSize - The size of the frame buffer.
+ * @property channelCount - The number of audio channels.
+ */
+export type FrameBufferParams = Readonly<{
+    frameBufferSize: number;
+    channelCount: number;
+}>;
+/**
+ * Parameters for creating a FillerFrameBuffer.
+ * @property channelCount - The number of audio channels.
+ * @property fillInterval - The interval in milliseconds for filling the buffer.
+ * @property sampleRate - The sample rate of the audio context.
+ * @property frameBufferChunks - The number of chunks in the frame buffer.
+ */
+export type FillerFrameBufferParams = Readonly<{
+    channelCount: number;
+    fillInterval?: number;
+    sampleRate?: number;
+    frameBufferChunks?: number;
+}>;
+/**
+ * Configuration for a FrameBuffer.
+ * This configuration is returned by the createFrameBufferConfig function.
+ * @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 totalReadFrames - The total frames read from the buffer.
+ * @property totalWriteFrames - The total frames written to the buffer.
+ */
+export type FrameBufferConfig = Readonly<{
+    sampleBuffer: Float32Array;
+    samplesPerFrame: number;
+    usedFramesInBuffer: Uint32Array;
+    totalReadFrames: BigUint64Array;
+    totalWriteFrames: BigUint64Array;
+}>;
+/**
+ * Configuration for a FillerFrameBuffer.
+ * This configuration is returned by the createFillerFrameBufferConfig function.
+ * @property sampleRate - The sample rate of the audio context.
+ * @property fillInterval - The interval in milliseconds for filling the buffer.
+ */
+export type FillerFrameBufferConfig = FrameBufferConfig & Readonly<{
+    sampleRate: number;
+    fillInterval: number;
+}>;
+/**
+ * Creates a FrameBufferWriter instance.
+ * @param config - The configuration for the FrameBuffer.
+ * @returns A new instance of FrameBufferWriter.
+ */
+export declare const createFrameBufferWriter: (config: FrameBufferConfig) => FrameBufferWriter;
+/**
+ * Creates a FrameBufferConfig instance.
+ * @param params - The parameters for the FrameBuffer.
+ * @returns A new instance of FrameBufferConfig.
+ */
+export declare const createFrameBufferConfig: (params: FrameBufferParams) => FrameBufferConfig;
+/**
+ * Creates a FillerFrameBufferConfig instance.
+ * @param params - The parameters for the FillerFrameBuffer.
+ * @returns A new instance of FillerFrameBufferConfig.
+ */
+export declare const createFillerFrameBufferConfig: (params: FillerFrameBufferParams) => FillerFrameBufferConfig;

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

@@ -0,0 +1,64 @@
+import { FrameBuffer } from './buffer';
+import { FrameBufferWriter } from './buffer-writer';
+/**
+ * The default number of chunks in the frame buffer when
+ * FillerFrameBufferParams.frameBufferChunks is not provided.
+ * A frame buffer sufficient to hold fillInterval * frameBufferChunks of playback time is allocated.
+ */
+const DEFAULT_FILL_INTERVAL_MS = 20;
+/**
+ * The default number of chunks in the frame buffer when
+ * FillerFrameBufferParams.frameBufferChunks is not provided.
+ * The total frame buffer size will be fillInterval * frameBufferChunks.
+ */
+const DEFAULT_FRAME_BUFFER_CHUNKS = 5;
+/**
+ * The unit for rounding up the frame buffer size.
+ * This value is aligned with the audio data block size used by the AudioWorkletProcessor.
+ * Reference: https://developer.mozilla.org/en-US/docs/Web/API/AudioWorkletProcessor/process
+ */
+const AUDIO_WORKLET_BLOCK_SIZE = 128;
+/**
+ * Creates a FrameBufferWriter instance.
+ * @param config - The configuration for the FrameBuffer.
+ * @returns A new instance of FrameBufferWriter.
+ */
+export const createFrameBufferWriter = (config) => {
+    return new FrameBufferWriter(new FrameBuffer(config.sampleBuffer, config.samplesPerFrame), config.usedFramesInBuffer, config.totalWriteFrames);
+};
+/**
+ * Creates a FrameBufferConfig instance.
+ * @param params - The parameters for the FrameBuffer.
+ * @returns A new instance of FrameBufferConfig.
+ */
+export const createFrameBufferConfig = (params) => {
+    return {
+        sampleBuffer: new Float32Array(new SharedArrayBuffer(params.frameBufferSize * params.channelCount * Float32Array.BYTES_PER_ELEMENT)),
+        samplesPerFrame: params.channelCount,
+        usedFramesInBuffer: new Uint32Array(new SharedArrayBuffer(Uint32Array.BYTES_PER_ELEMENT)),
+        totalReadFrames: new BigUint64Array(new SharedArrayBuffer(BigUint64Array.BYTES_PER_ELEMENT)),
+        totalWriteFrames: new BigUint64Array(new SharedArrayBuffer(BigUint64Array.BYTES_PER_ELEMENT)),
+    };
+};
+/**
+ * Creates a FillerFrameBufferConfig instance.
+ * @param params - The parameters for the FillerFrameBuffer.
+ * @returns A new instance of FillerFrameBufferConfig.
+ */
+export const createFillerFrameBufferConfig = (params) => {
+    const sampleRate = params.sampleRate;
+    // Check if 'sampleRate' is a positive integer
+    if (sampleRate === undefined || (!Number.isInteger(sampleRate) || sampleRate <= 0)) {
+        throw new Error('Invalid sampleRate: must be a positive integer.');
+    }
+    const intervalMillisecond = params.fillInterval ?? DEFAULT_FILL_INTERVAL_MS;
+    const frameBufferSize = Math.floor(sampleRate * intervalMillisecond / 1000 + (AUDIO_WORKLET_BLOCK_SIZE - 1)) & ~(AUDIO_WORKLET_BLOCK_SIZE - 1);
+    const frameBufferChunkCount = params.frameBufferChunks ?? DEFAULT_FRAME_BUFFER_CHUNKS;
+    const config = createFrameBufferConfig({ frameBufferSize: frameBufferSize * frameBufferChunkCount, channelCount: params.channelCount });
+    return {
+        ...config,
+        sampleRate,
+        fillInterval: intervalMillisecond,
+    };
+};
+//# sourceMappingURL=buffer-config.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"buffer-config.js","sourceRoot":"","sources":["../../src/frame-buffer/buffer-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AACtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AAEnD;;;;GAIG;AACH,MAAM,wBAAwB,GAAG,EAAE,CAAA;AAEnC;;;;GAIG;AACH,MAAM,2BAA2B,GAAG,CAAC,CAAA;AAErC;;;;GAIG;AACH,MAAM,wBAAwB,GAAG,GAAG,CAAA;AAsDpC;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,MAAyB,EAAqB,EAAE;IACtF,OAAO,IAAI,iBAAiB,CAC1B,IAAI,WAAW,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,eAAe,CAAC,EAC5D,MAAM,CAAC,kBAAkB,EAAE,MAAM,CAAC,gBAAgB,CACnD,CAAA;AACH,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,MAAyB,EAAqB,EAAE;IACtF,OAAO;QACL,YAAY,EAAE,IAAI,YAAY,CAC5B,IAAI,iBAAiB,CAAC,MAAM,CAAC,eAAe,GAAG,MAAM,CAAC,YAAY,GAAG,YAAY,CAAC,iBAAiB,CAAC,CACrG;QACD,eAAe,EAAE,MAAM,CAAC,YAAY;QACpC,kBAAkB,EAAE,IAAI,WAAW,CAAC,IAAI,iBAAiB,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;QACzF,eAAe,EAAE,IAAI,cAAc,CAAC,IAAI,iBAAiB,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;QAC5F,gBAAgB,EAAE,IAAI,cAAc,CAAC,IAAI,iBAAiB,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;KAC9F,CAAA;AACH,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,MAA+B,EAA2B,EAAE;IACxG,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAA;IACpC,8CAA8C;IAC9C,IAAI,UAAU,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,UAAU,IAAI,CAAC,CAAC,EAAE,CAAC;QACnF,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;IACpE,CAAC;IACD,MAAM,mBAAmB,GAAG,MAAM,CAAC,YAAY,IAAI,wBAAwB,CAAA;IAC3E,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAChC,UAAU,GAAG,mBAAmB,GAAG,IAAI,GAAG,CAAC,wBAAwB,GAAG,CAAC,CAAC,CACzE,GAAG,CAAC,CAAC,wBAAwB,GAAG,CAAC,CAAC,CAAA;IACnC,MAAM,qBAAqB,GAAG,MAAM,CAAC,iBAAiB,IAAI,2BAA2B,CAAA;IACrF,MAAM,MAAM,GAAG,uBAAuB,CACpC,EAAE,eAAe,EAAE,eAAe,GAAG,qBAAqB,EAAE,YAAY,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,CAAA;IAClG,OAAO;QACL,GAAG,MAAM;QACT,UAAU;QACV,YAAY,EAAE,mBAAmB;KAClC,CAAA;AACH,CAAC,CAAA"}

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

@@ -69,9 +69,8 @@ export declare class FrameBufferFactory {
     static createFrameBufferConfig(params: FrameBufferParams): FrameBufferConfig;
     /**
      * Creates a FillerFrameBufferConfig instance.
-     * @param defaultSampleRate - The sample rate of the audio context.
      * @param params - The parameters for the FillerFrameBuffer.
      * @returns A new instance of FillerFrameBufferConfig.
      */
-    static createFillerFrameBufferConfig(defaultSampleRate: number, params: FillerFrameBufferParams): FillerFrameBufferConfig;
+    static createFillerFrameBufferConfig(params: FillerFrameBufferParams): FillerFrameBufferConfig;
 }

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

@@ -32,12 +32,15 @@ export class FrameBufferFactory {
     }
     /**
      * Creates a FillerFrameBufferConfig instance.
-     * @param defaultSampleRate - The sample rate of the audio context.
      * @param params - The parameters for the FillerFrameBuffer.
      * @returns A new instance of FillerFrameBufferConfig.
      */
-    static createFillerFrameBufferConfig(defaultSampleRate, params) {
-        const sampleRate = params.sampleRate ?? defaultSampleRate;
+    static createFillerFrameBufferConfig(params) {
+        const sampleRate = params.sampleRate;
+        // Check if 'sampleRate' is a positive integer
+        if (sampleRate === undefined || (!Number.isInteger(sampleRate) || sampleRate <= 0)) {
+            throw new Error('Invalid sampleRate: must be a positive integer.');
+        }
         const intervalMillisecond = params.fillInterval ?? FrameBufferFactory.DEFAULT_FILL_INTERVAL_MS;
         const frameBufferSize = Math.floor(sampleRate * intervalMillisecond / 1000 + (FrameBufferFactory.PROCESS_UNIT - 1)) & ~(FrameBufferFactory.PROCESS_UNIT - 1);
         const frameBufferChunkCount = params.frameBufferChunks ?? FrameBufferFactory.DEFAULT_FRAME_BUFFER_CHUNKS;

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

@@ -1 +1 @@
-{"version":3,"file":"buffer-factory.js","sourceRoot":"","sources":["../../src/frame-buffer/buffer-factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AACtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AAsDnD;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,MAAyB,EAAqB,EAAE;IACtF,OAAO,IAAI,iBAAiB,CAC1B,IAAI,WAAW,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,eAAe,CAAC,EAC5D,MAAM,CAAC,kBAAkB,EAAE,MAAM,CAAC,gBAAgB,CACnD,CAAA;AACH,CAAC,CAAA;AAED;;;GAGG;AACH,MAAM,OAAO,kBAAkB;IACtB,MAAM,CAAU,wBAAwB,GAAG,EAAE,CAAA;IAC7C,MAAM,CAAU,2BAA2B,GAAG,CAAC,CAAA;IAC/C,MAAM,CAAU,YAAY,GAAG,GAAG,CAAA;IAEzC;;;;OAIG;IACI,MAAM,CAAC,uBAAuB,CAAC,MAAyB;QAC7D,OAAO;YACL,YAAY,EAAE,IAAI,YAAY,CAC5B,IAAI,iBAAiB,CAAC,MAAM,CAAC,eAAe,GAAG,MAAM,CAAC,YAAY,GAAG,YAAY,CAAC,iBAAiB,CAAC,CACrG;YACD,eAAe,EAAE,MAAM,CAAC,YAAY;YACpC,kBAAkB,EAAE,IAAI,WAAW,CAAC,IAAI,iBAAiB,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;YACzF,eAAe,EAAE,IAAI,cAAc,CAAC,IAAI,iBAAiB,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;YAC5F,gBAAgB,EAAE,IAAI,cAAc,CAAC,IAAI,iBAAiB,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;SAC9F,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,6BAA6B,CAAC,iBAAyB,EAAE,MAA+B;QACpG,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,IAAI,iBAAiB,CAAA;QACzD,MAAM,mBAAmB,GAAG,MAAM,CAAC,YAAY,IAAI,kBAAkB,CAAC,wBAAwB,CAAA;QAC9F,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAChC,UAAU,GAAG,mBAAmB,GAAG,IAAI,GAAG,CAAC,kBAAkB,CAAC,YAAY,GAAG,CAAC,CAAC,CAChF,GAAG,CAAC,CAAC,kBAAkB,CAAC,YAAY,GAAG,CAAC,CAAC,CAAA;QAC1C,MAAM,qBAAqB,GAAG,MAAM,CAAC,iBAAiB,IAAI,kBAAkB,CAAC,2BAA2B,CAAA;QACxG,MAAM,MAAM,GAAG,kBAAkB,CAAC,uBAAuB,CACvD,EAAE,eAAe,EAAE,eAAe,GAAG,qBAAqB,EAAE,YAAY,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,CAAA;QAClG,OAAO;YACL,GAAG,MAAM;YACT,UAAU;YACV,YAAY,EAAE,mBAAmB;SAClC,CAAA;IACH,CAAC"}
+{"version":3,"file":"buffer-factory.js","sourceRoot":"","sources":["../../src/frame-buffer/buffer-factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AACtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AAsDnD;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,MAAyB,EAAqB,EAAE;IACtF,OAAO,IAAI,iBAAiB,CAC1B,IAAI,WAAW,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,eAAe,CAAC,EAC5D,MAAM,CAAC,kBAAkB,EAAE,MAAM,CAAC,gBAAgB,CACnD,CAAA;AACH,CAAC,CAAA;AAED;;;GAGG;AACH,MAAM,OAAO,kBAAkB;IACtB,MAAM,CAAU,wBAAwB,GAAG,EAAE,CAAA;IAC7C,MAAM,CAAU,2BAA2B,GAAG,CAAC,CAAA;IAC/C,MAAM,CAAU,YAAY,GAAG,GAAG,CAAA;IAEzC;;;;OAIG;IACI,MAAM,CAAC,uBAAuB,CAAC,MAAyB;QAC7D,OAAO;YACL,YAAY,EAAE,IAAI,YAAY,CAC5B,IAAI,iBAAiB,CAAC,MAAM,CAAC,eAAe,GAAG,MAAM,CAAC,YAAY,GAAG,YAAY,CAAC,iBAAiB,CAAC,CACrG;YACD,eAAe,EAAE,MAAM,CAAC,YAAY;YACpC,kBAAkB,EAAE,IAAI,WAAW,CAAC,IAAI,iBAAiB,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;YACzF,eAAe,EAAE,IAAI,cAAc,CAAC,IAAI,iBAAiB,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;YAC5F,gBAAgB,EAAE,IAAI,cAAc,CAAC,IAAI,iBAAiB,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;SAC9F,CAAA;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,6BAA6B,CAAC,MAA+B;QACzE,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAA;QACpC,8CAA8C;QAC9C,IAAI,UAAU,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,UAAU,IAAI,CAAC,CAAC,EAAE,CAAC;YACnF,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;QACpE,CAAC;QACD,MAAM,mBAAmB,GAAG,MAAM,CAAC,YAAY,IAAI,kBAAkB,CAAC,wBAAwB,CAAA;QAC9F,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAChC,UAAU,GAAG,mBAAmB,GAAG,IAAI,GAAG,CAAC,kBAAkB,CAAC,YAAY,GAAG,CAAC,CAAC,CAChF,GAAG,CAAC,CAAC,kBAAkB,CAAC,YAAY,GAAG,CAAC,CAAC,CAAA;QAC1C,MAAM,qBAAqB,GAAG,MAAM,CAAC,iBAAiB,IAAI,kBAAkB,CAAC,2BAA2B,CAAA;QACxG,MAAM,MAAM,GAAG,kBAAkB,CAAC,uBAAuB,CACvD,EAAE,eAAe,EAAE,eAAe,GAAG,qBAAqB,EAAE,YAAY,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,CAAA;QAClG,OAAO;YACL,GAAG,MAAM;YACT,UAAU;YACV,YAAY,EAAE,mBAAmB;SAClC,CAAA;IACH,CAAC"}

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

@@ -1,4 +1,3 @@
-import { type FrameCallback } from './buffer-utils';
 import { FrameBuffer } from './buffer';
 /**
  * FrameBufferReader class
@@ -7,31 +6,51 @@ import { FrameBuffer } from './buffer';
  */
 export declare class FrameBufferReader {
     private readonly _frameBuffer;
-    private readonly _usedFrameInBuffer;
+    private readonly _usedFramesInBuffer;
     private readonly _totalFrames;
     private _index;
     /**
      * Creates an instance of FrameBufferReader.
      * @param frameBuffer - The shared buffer to read from.
-     * @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 read from the buffer.
      */
-    constructor(frameBuffer: FrameBuffer, usedFrameInBuffer: Uint32Array, totalFrames: BigUint64Array);
+    constructor(frameBuffer: FrameBuffer, usedFramesInBuffer: Uint32Array, totalFrames: BigUint64Array);
     /**
      * Get the number of available frames in the buffer.
      * @returns The number of available frames in the buffer.
      */
-    get available(): number;
+    get availableFrames(): number;
     /**
      * Get the total number of frames read from the buffer.
+     *
      * @returns The total number of frames read.
      */
     get totalFrames(): bigint;
     /**
-     * Reads audio frame data from the buffer and processes it using the provided callback.
-     * @param frameCallback - The callback function to process each section of the buffer.
-     * @returns The number of frames processed.
-     * @throws RangeError - If the processed length exceeds the part length.
+     * Reads audio frame data from the buffer using the provided callback.
+     * This method handles one or more readable segments within the ring buffer
+     * and invokes the callback for each segment.
+     *
+     * @param processFrameSegment - The callback function invoked for each readable segment
+     *   of the ring buffer. It receives:
+     *   1. `buffer`: A Float32Array representing the readable 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 processed.
+     *   If the callback processes fewer frames than available in the current segment,
+     *   processing will stop early.
+     *
+     * @returns The total number of frames processed across all segments.
+     *   Note: The return value is in frames, not in samples.
+     *
+     * @throws RangeError - If the processFrameSegment callback returns a processed length greater than the available frames 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.
+     *
      */
-    read(frameCallback: FrameCallback): number;
+    read(processFrameSegment: (buffer: Float32Array, offset: number) => number): number;
 }

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

@@ -1,4 +1,3 @@
-import { enumFrames } from './buffer-utils';
 /**
  * FrameBufferReader class
  * This class reads audio frame data from a shared Float32Array buffer and processes it.
@@ -6,46 +5,68 @@ import { enumFrames } from './buffer-utils';
  */
 export class FrameBufferReader {
     _frameBuffer;
-    _usedFrameInBuffer;
+    _usedFramesInBuffer;
     _totalFrames;
     _index = 0;
     /**
      * Creates an instance of FrameBufferReader.
      * @param frameBuffer - The shared buffer to read from.
-     * @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 read from 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 frames in the buffer.
      * @returns The number of available frames in the buffer.
      */
-    get available() {
-        return Atomics.load(this._usedFrameInBuffer, 0);
+    get availableFrames() {
+        return Atomics.load(this._usedFramesInBuffer, 0);
     }
     /**
      * Get the total number of frames read from the buffer.
+     *
      * @returns The total number of frames read.
      */
     get totalFrames() {
+        // This class is not used concurrently by multiple threads,
+        // so `Atomics` is not necessary when reading `totalFrames`.
         return this._totalFrames[0];
     }
     /**
-     * Reads audio frame data from the buffer and processes it using the provided callback.
-     * @param frameCallback - The callback function to process each section of the buffer.
-     * @returns The number of frames processed.
-     * @throws RangeError - If the processed length exceeds the part length.
+     * Reads audio frame data from the buffer using the provided callback.
+     * This method handles one or more readable segments within the ring buffer
+     * and invokes the callback for each segment.
+     *
+     * @param processFrameSegment - The callback function invoked for each readable segment
+     *   of the ring buffer. It receives:
+     *   1. `buffer`: A Float32Array representing the readable 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 processed.
+     *   If the callback processes fewer frames than available in the current segment,
+     *   processing will stop early.
+     *
+     * @returns The total number of frames processed across all segments.
+     *   Note: The return value is in frames, not in samples.
+     *
+     * @throws RangeError - If the processFrameSegment callback returns a processed length greater than the available frames 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.
+     *
      */
-    read(frameCallback) {
-        const result = enumFrames(this._frameBuffer, this._index, this.available, frameCallback);
+    read(processFrameSegment) {
+        const result = this._frameBuffer.enumFrameSegments(this._index, this.availableFrames, processFrameSegment);
         this._index = result.nextIndex;
-        Atomics.sub(this._usedFrameInBuffer, 0, result.frames);
-        Atomics.add(this._totalFrames, 0, BigInt(result.frames));
-        return result.frames;
+        Atomics.sub(this._usedFramesInBuffer, 0, result.totalProcessedFrames);
+        Atomics.add(this._totalFrames, 0, BigInt(result.totalProcessedFrames));
+        return result.totalProcessedFrames;
     }
 }
 //# sourceMappingURL=buffer-reader.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"buffer-reader.js","sourceRoot":"","sources":["../../src/frame-buffer/buffer-reader.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,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAA;IACjD,CAAC;IAED;;;OAGG;IACH,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;IAC7B,CAAC;IAED;;;;;OAKG;IACI,IAAI,CAAC,aAA4B;QACtC,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-reader.js","sourceRoot":"","sources":["../../src/frame-buffer/buffer-reader.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;;;OAGG;IACH,IAAW,eAAe;QACxB,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,CAAA;IAClD,CAAC;IAED;;;;OAIG;IACH,IAAW,WAAW;QACpB,2DAA2D;QAC3D,4DAA4D;QAC5D,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;IAC7B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACI,IAAI,CAAC,mBAAqE;QAC/E,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-utils.js

@@ -16,7 +16,7 @@ export const enumFrames = (buffer, startIndex, availableFrames, frameCallback) =
     let totalFrames = 0;
     while (totalFrames < availableFrames) {
         // Determine the length of the current section to process
-        const sectionFrames = Math.min(buffer.length - startIndex, availableFrames - totalFrames);
+        const sectionFrames = Math.min(buffer.frameCount - startIndex, availableFrames - totalFrames);
         // Process the current section using the frameCallback function
         const processedFrames = frameCallback({ buffer, index: startIndex, frames: sectionFrames }, totalFrames);
         // Ensure the processed length does not exceed the section length
@@ -24,7 +24,7 @@ export const enumFrames = (buffer, startIndex, availableFrames, frameCallback) =
             throw new RangeError(`Processed frames (${processedFrames}) exceeds section frames (${sectionFrames})`);
         }
         totalFrames += processedFrames;
-        startIndex = (startIndex + processedFrames) % buffer.length;
+        startIndex = (startIndex + processedFrames) % buffer.frameCount;
         if (processedFrames < sectionFrames) {
             break;
         }

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

@@ -1 +1 @@
-{"version":3,"file":"buffer-utils.js","sourceRoot":"","sources":["../../src/frame-buffer/buffer-utils.ts"],"names":[],"mappings":"AAcA;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,MAAmB,EAAE,UAAkB,EAAE,eAAuB,EAAE,aAA4B,EACnF,EAAE;IACtC,IAAI,WAAW,GAAG,CAAC,CAAA;IACnB,OAAO,WAAW,GAAG,eAAe,EAAE,CAAC;QACrC,yDAAyD;QACzD,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,UAAU,EAAE,eAAe,GAAG,WAAW,CAAC,CAAA;QACzF,+DAA+D;QAC/D,MAAM,eAAe,GAAG,aAAa,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,aAAa,EAAE,EAAE,WAAW,CAAC,CAAA;QACxG,iEAAiE;QACjE,IAAI,eAAe,GAAG,aAAa,EAAE,CAAC;YACpC,MAAM,IAAI,UAAU,CAAC,qBAAqB,eAAe,6BAA6B,aAAa,GAAG,CAAC,CAAA;QACzG,CAAC;QACD,WAAW,IAAI,eAAe,CAAA;QAC9B,UAAU,GAAG,CAAC,UAAU,GAAG,eAAe,CAAC,GAAG,MAAM,CAAC,MAAM,CAAA;QAC3D,IAAI,eAAe,GAAG,aAAa,EAAE,CAAC;YACpC,MAAK;QACP,CAAC;IACH,CAAC;IACD,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,CAAA;AACvD,CAAC,CAAA"}
+{"version":3,"file":"buffer-utils.js","sourceRoot":"","sources":["../../src/frame-buffer/buffer-utils.ts"],"names":[],"mappings":"AAcA;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,MAAmB,EAAE,UAAkB,EAAE,eAAuB,EAAE,aAA4B,EACnF,EAAE;IACtC,IAAI,WAAW,GAAG,CAAC,CAAA;IACnB,OAAO,WAAW,GAAG,eAAe,EAAE,CAAC;QACrC,yDAAyD;QACzD,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,GAAG,UAAU,EAAE,eAAe,GAAG,WAAW,CAAC,CAAA;QAC7F,+DAA+D;QAC/D,MAAM,eAAe,GAAG,aAAa,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,aAAa,EAAE,EAAE,WAAW,CAAC,CAAA;QACxG,iEAAiE;QACjE,IAAI,eAAe,GAAG,aAAa,EAAE,CAAC;YACpC,MAAM,IAAI,UAAU,CAAC,qBAAqB,eAAe,6BAA6B,aAAa,GAAG,CAAC,CAAA;QACzG,CAAC;QACD,WAAW,IAAI,eAAe,CAAA;QAC9B,UAAU,GAAG,CAAC,UAAU,GAAG,eAAe,CAAC,GAAG,MAAM,CAAC,UAAU,CAAA;QAC/D,IAAI,eAAe,GAAG,aAAa,EAAE,CAAC;YACpC,MAAK;QACP,CAAC;IACH,CAAC;IACD,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,CAAA;AACvD,CAAC,CAAA"}

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

@@ -1,4 +1,3 @@
-import { type FrameCallback } from './buffer-utils';
 import { FrameBuffer } from './buffer';
 /**
  * FrameBufferWriter class
@@ -7,31 +6,51 @@ import { FrameBuffer } from './buffer';
  */
 export declare class FrameBufferWriter {
     private readonly _frameBuffer;
-    private readonly _usedFrameInBuffer;
+    private readonly _usedFramesInBuffer;
     private readonly _totalFrames;
     private _index;
     /**
      * 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: FrameBuffer, usedFrameInBuffer: Uint32Array, totalFrames: BigUint64Array);
+    constructor(frameBuffer: FrameBuffer, usedFramesInBuffer: Uint32Array, totalFrames: BigUint64Array);
     /**
-     * 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(): number;
+    get availableFrames(): number;
     /**
      * Get the total number of frames written to the buffer.
+     *
      * @returns The total number of frames written.
      */
     get totalFrames(): bigint;
     /**
-     * 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: FrameCallback): number;
+    write(processFrameSegment: (buffer: Float32Array, offset: number) => number): number;
 }