@ain1084/audio-worklet-stream 0.1.2

package/LICENSE

@@ -0,0 +1,222 @@
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!) The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,243 @@
+# Audio Worklet Stream Library
+
+This library provides a way to work with audio worklets and streams using modern web technologies. It allows for the manual writing of audio frames to a buffer and supports various buffer writing strategies.
+
+## Features
+
+- **Manual Buffer Writing**: Provides the ability to manually write audio frames to a buffer.
+- **Multiple Buffer Writing Strategies**: Includes support for various strategies like manual, timer-based, and worker-based buffer writing.
+- **Worker-Based Stability**: Utilizes Workers to ensure stable and consistent audio playback.
+- **Vite Integration**: Leverages Vite for easy worker loading and configuration without complex setup.
+- **Audio Worklet Integration**: Seamlessly integrates with the Web Audio API's Audio Worklet for real-time audio processing.
+
+## Prerequisites
+
+- **Node.js** and **npm**: Make sure you have Node.js (version 20 or higher) and npm installed. This library hasn't been tested on versions below 20.
+- **Vite**: This library uses Vite as the bundler for its simplicity in loading and configuring workers. The developer uses Nuxt3, which is compatible with Vite.
+
+## Installation
+
+To install the library, run:
+
+```bash
+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**
+```typescript
+import { defineConfig } from 'vite'
+
+export default defineConfig({
+  optimizeDeps: {
+    exclude: ['@ain1084/audio-worklet-stream']
+  },
+  plugins: [
+    {
+      name: 'configure-response-headers',
+      configureServer: (server) => {
+        server.middlewares.use((_req, res, next) => {
+          res.setHeader('Cross-Origin-Embedder-Policy', 'require-corp')
+          res.setHeader('Cross-Origin-Opener-Policy', 'same-origin')
+          next()
+        })
+      },
+    },
+  ],
+})
+```
+
+If you are using Nuxt3, add it under vite in `nuxt.config.ts`.
+
+**nuxt.config.ts**
+```typescript
+export default defineNuxtConfig({
+  vite: {
+    optimizeDeps: {
+      exclude: ['@ain1084/audio-worklet-stream']
+    },
+    plugins: [
+      {
+        name: 'configure-response-headers',
+        configureServer: (server) => {
+          server.middlewares.use((_req, res, next) => {
+            res.setHeader('Cross-Origin-Embedder-Policy', 'require-corp')
+            res.setHeader('Cross-Origin-Opener-Policy', 'same-origin')
+            next()
+          })
+        },
+      },
+    ],
+  },
+})
+```
+
+Additionally, add the Nitro configuration (needed when running `npm run build`).
+
+**nuxt.config.ts**
+```typescript
+export default defineNuxtConfig({
+  nitro: {
+    rollupConfig: {
+      external: '@ain1084/audio-worklet-stream',
+    },
+    routeRules: {
+      '/**': {
+        cors: true,
+        headers: {
+          'Cross-Origin-Embedder-Policy': 'require-corp',
+          'Cross-Origin-Opener-Policy': 'same-origin',
+        },
+      },
+    },
+  },
+})
+```
+
+## Usage
+
+### Overview
+
+This library continuously plays audio sample frames using `AudioWorkletNode`. The audio sample frames need to be supplied externally via a ring buffer. The library provides functionality to retrieve the number of written and read (played) frames and allows stopping playback at a specified frame.
+
+### Buffer Writing Methods
+
+- **Manual**: The consumer is responsible for writing to the ring buffer. If the buffer becomes empty, silence is played. This method requires active management to ensure the buffer is always filled with audio data.
+  - *Example*：
+    ```typescript
+    const writer = await main.createManualNode();
+    // Write arbitrary audio frames
+    writer.write(...);
+    main.start();
+    ```
+
+- **Timed**: Uses a UI thread timer to periodically write to the buffer. Frames to be written to the buffer are requested through `FrameBufferFiller`.
+  - *Example*：
+    ```typescript
+    await main.createTimedNode();
+    main.start();
+    ```
+
+- **Worker**: Similar to Timed but uses a timer in a Worker instead of the UI thread. This approach provides more stable playback by avoiding UI thread throttling. See the [MDN Web Docs on setInterval delay restrictions](https://developer.mozilla.org/en-US/docs/Web/API/setInterval#delay_restrictions) for more details.
+  - *Example*：
+    ```typescript
+    await main.createWorkerNode();
+    main.start();
+    ```
+
+Below is a reference implementation of `main` used in the examples.
+
+Note: The imported `sine-wave-frame-buffer-filler` and `worker` can be found in the `example/src/` directory.
+
+```typescript
+import { StreamNodeFactory, type OutputStreamNode } from '@ain1084/audio-worklet-stream';
+import worker from './worker?worker';
+import type { FillerParameters } from './sine-wave-frame-buffer-filler';
+import { SineWaveFrameBufferFiller } from './sine-wave-frame-buffer-filler';
+
+class Main {
+  private factory: StreamNodeFactory | null = null;
+  private streamNode: OutputStreamNode | null = null;
+
+  // Initialize the AudioContext and StreamNodeFactory
+  async init() {
+    const audioContext = new AudioContext();
+    this.factory = await StreamNodeFactory.create(audioContext);
+  }
+
+  // Create a manual buffer node
+  async createManualNode() {
+    if (!this.factory) throw new Error('Factory not initialized');
+    const [node, writer] = await this.factory.createManualBufferNode({
+      channelCount: 2,
+      frameBufferSize: 4096,
+    });
+    this.streamNode = node;
+    return writer;
+  }
+
+  // Create a timed buffer node
+  async createTimedNode() {
+    if (!this.factory) throw new Error('Factory not initialized');
+    const filler = new SineWaveFrameBufferFiller({ frequency: 440, sampleRate: 44100 });
+    this.streamNode = await this.factory.createTimedBufferNode(filler, {
+      channelCount: 2,
+      fillInterval: 20,
+      sampleRate: 44100,
+    });
+  }
+
+  // Create a worker buffer node
+  async createWorkerNode() {
+    if (!this.factory) throw new Error('Factory not initialized');
+    this.streamNode = await this.factory.createWorkerBufferNode<FillerParameters>(worker, {
+      channelCount: 2,
+      fillInterval: 20,
+      sampleRate: 44100,
+      fillerParams: { frequency: 440, sampleRate: 44100 },
+    });
+  }
+
+  // Start the audio stream
+  start() {
+    if (!this.streamNode) throw new Error('Stream node not created');
+    this.streamNode.connect(this.streamNode.context.destination);
+    this.streamNode.start();
+  }
+
+  // Stop the audio stream
+  stop() {
+    if (!this.streamNode) throw new Error('Stream node not created');
+    this.streamNode.stop();
+  }
+}
+
+export default new Main();
+```
+
+## Documentation
+
+For more detailed documentation, visit the [API documentation](https://ain1084.github.io/audio-worklet-stream/).
+
+## Provided Example
+
+The provided example demonstrates how to use the library to manually write audio frames to a buffer. It includes:
+
+- **Main Application** (`example/src/main.ts`): Sets up and starts the audio stream using different buffer writing strategies.
+- **Sine Wave Filler** (`example/src/sine-wave-frame-buffer-filler.ts`): Implements a frame buffer filler that generates a sine wave.
+- **Sine Wave Generator** (`example/src/sine-wave-generator.ts`): Generates sine wave values for the buffer filler.
+- **Worker** (`example/src/worker.ts`): Sets up a worker to handle buffer filling tasks.
+- **HTML Entry Point** (`example/index.html`): Provides the HTML structure and buttons to control the audio stream.
+
+For more details, refer to the `example/README.md`.
+
+## Future Plans and Known Issues
+
+### Future Plans
+1. **Enhanced Documentation**: Improve the documentation with more examples and detailed explanations.
+
+### Known Issues
+1. **Buffer Underruns**: Occasional buffer underruns under heavy CPU load.
+2. **Limited Worker Support**: Advanced features in workers might not be fully supported across all browsers.
+3. **Overhead at the Start of Playback**: The ring buffer is being generated each time.
+4. **Overhead during Worker Playback**: It seems that the Worker is being loaded every time playback starts (although it hits the cache).
+
+We are continuously working on these areas to improve the library. Contributions and suggestions are always welcome!
+
+## Notes
+
+- **Vite as a Bundler**: This library utilizes Vite to enable the loading and placement of workers without complex configurations. It may not work out-of-the-box with WebPack due to differences in how bundlers handle workers. While similar methods may exist for WebPack, this library currently only supports Vite. Initially, a bundler-independent approach was considered, but a suitable method could not be found.
+
+- **Security Requirements**: Since this library uses `SharedArrayBuffer`, ensuring browser compatibility requires meeting specific security requirements. For more details, refer to the [MDN Web Docs on SharedArrayBuffer Security Requirements](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer#security_requirements).
+
+
+## Contribution
+
+Contributions are welcome! Please open an issue or submit a pull request on GitHub.
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.

package/dist/constants.d.ts

@@ -0,0 +1,12 @@
+/**
+ * The name of the output stream processor, used as the name of the AudioWorkletProcessor.
+ */
+export declare const PROCESSOR_NAME = "@ain1084/audio-worklet-stream/output-stream-processor";
+/**
+ * The event type for the stop event.
+ */
+export declare const STOP_EVENT_TYPE = "@ain1084/audio-worklet-stream/stop";
+/**
+ * The event type for the underrun event.
+ */
+export declare const UNDERRUN_EVENT_TYPE = "@ain1084/audio-worklet-stream/underrun";

package/dist/constants.js

@@ -0,0 +1,15 @@
+// Constants file
+const PREFIX = '@ain1084/audio-worklet-stream';
+/**
+ * The name of the output stream processor, used as the name of the AudioWorkletProcessor.
+ */
+export const PROCESSOR_NAME = `${PREFIX}/output-stream-processor`;
+/**
+ * The event type for the stop event.
+ */
+export const STOP_EVENT_TYPE = `${PREFIX}/stop`;
+/**
+ * The event type for the underrun event.
+ */
+export const UNDERRUN_EVENT_TYPE = `${PREFIX}/underrun`;
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,iBAAiB;AAEjB,MAAM,MAAM,GAAG,+BAA+B,CAAA;AAE9C;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,MAAM,0BAA0B,CAAA;AAEjE;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,GAAG,MAAM,OAAO,CAAA;AAE/C;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,MAAM,WAAW,CAAA"}

package/dist/events.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Represents a custom event indicating that the audio processing has stopped.
+ * This event is dispatched when the audio processing stops.
+ */
+export declare class StopEvent extends Event {
+    readonly frames: 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.
+     */
+    constructor(frames: bigint);
+}
+/**
+ * Represents a custom event indicating that an underrun occurred in the audio processing.
+ * UnderrunEvent is triggered not at the moment the underrun occurs, but when the underrun is resolved
+ * or just before the node stops.
+ */
+export declare class UnderrunEvent extends Event {
+    readonly frames: 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.
+     */
+    constructor(frames: number);
+}
+/**
+ * Extends the AudioWorkletNodeEventMap interface to include the custom events.
+ * This allows the custom events to be used in the context of AudioWorkletNode.
+ */
+declare global {
+    interface AudioWorkletNodeEventMap {
+        [StopEvent.type]: StopEvent;
+        [UnderrunEvent.type]: UnderrunEvent;
+    }
+}

package/dist/events.js

@@ -0,0 +1,35 @@
+import { STOP_EVENT_TYPE, UNDERRUN_EVENT_TYPE } from './constants';
+/**
+ * Represents a custom event indicating that the audio processing has stopped.
+ * This event is dispatched when the audio processing stops.
+ */
+export class StopEvent extends Event {
+    frames;
+    static type = STOP_EVENT_TYPE;
+    /**
+     * Creates an instance of StopEvent.
+     * @param frames - The position in the audio stream where the stop occurred.
+     */
+    constructor(frames) {
+        super(StopEvent.type);
+        this.frames = frames;
+    }
+}
+/**
+ * Represents a custom event indicating that an underrun occurred in the audio processing.
+ * UnderrunEvent is triggered not at the moment the underrun occurs, but when the underrun is resolved
+ * or just before the node stops.
+ */
+export class UnderrunEvent extends Event {
+    frames;
+    static type = UNDERRUN_EVENT_TYPE;
+    /**
+     * Creates an instance of UnderrunEvent.
+     * @param frames - The number of frames that were not processed due to the underrun.
+     */
+    constructor(frames) {
+        super(UnderrunEvent.type);
+        this.frames = frames;
+    }
+}
+//# sourceMappingURL=events.js.map

package/dist/events.js.map

@@ -0,0 +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"}

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

@@ -0,0 +1,77 @@
+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;
+/**
+ * FrameBufferFactory class
+ * Provides static methods to create frame buffer configurations and writers.
+ */
+export declare class FrameBufferFactory {
+    static readonly DEFAULT_FILL_INTERVAL_MS = 20;
+    static readonly DEFAULT_FRAME_BUFFER_CHUNKS = 5;
+    static readonly PROCESS_UNIT = 128;
+    /**
+     * Creates a FrameBufferConfig instance.
+     * @param params - The parameters for the FrameBuffer.
+     * @returns A new instance of FrameBufferConfig.
+     */
+    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;
+}