@ain1084/audio-worklet-stream 1.0.3 → 1.0.5

package/src/output-stream-node.ts

@@ -1,5 +1,4 @@
 import type { MessageToProcessor, MessageToAudioNode } from './output-message'
-import type { OutputStreamProcessorOptions } from './output-stream-processor'
 import { PROCESSOR_NAME } from './constants'
 import { StopEvent, UnderrunEvent } from './events'
 import { BufferWriteStrategy } from './write-strategy/strategy'
@@ -41,13 +40,9 @@ export class OutputStreamNode extends AudioWorkletNode {
     bufferConfig: FrameBufferConfig,
     strategy: BufferWriteStrategy,
   ) {
-    const processorOptions: OutputStreamProcessorOptions = {
-      ...bufferConfig,
-      totalFrames: bufferConfig.totalReadFrames,
-    }
     super(baseAudioContext, PROCESSOR_NAME, {
       outputChannelCount: [bufferConfig.samplesPerFrame],
-      processorOptions,
+      processorOptions: bufferConfig,
     })
     this._strategy = strategy
     this._totalWriteFrames = bufferConfig.totalWriteFrames
@@ -56,14 +51,15 @@ export class OutputStreamNode extends AudioWorkletNode {
   }
 
   /**
+   * @internal
    * Creates an instance of OutputStreamNode.
    * @param audioContext - The audio context to use.
-   * @param info - The configuration for the buffer.
+   * @param config - The configuration for the buffer.
    * @param strategy - The strategy for writing to the buffer.
    * @returns A promise that resolves to an instance of OutputStreamNode.
    */
-  public static async create(audioContext: BaseAudioContext, info: FrameBufferConfig, strategy: BufferWriteStrategy): Promise<OutputStreamNode> {
-    const node = new OutputStreamNode(audioContext, info, strategy)
+  public static async create(audioContext: BaseAudioContext, config: FrameBufferConfig, strategy: BufferWriteStrategy): Promise<OutputStreamNode> {
+    const node = new OutputStreamNode(audioContext, config, strategy)
     if (!(await strategy.onInit(node))) {
       throw new Error('Failed to onInit.')
     }

package/src/output-stream-processor.ts

@@ -1,28 +1,7 @@
 import { FrameBufferReader } from './frame-buffer/buffer-reader'
 import { PROCESSOR_NAME } from './constants'
 import type { MessageToAudioNode, MessageToProcessor } from './output-message'
-import { FrameBuffer } from './frame-buffer/buffer'
-
-/**
- * Options for the OutputStreamProcessor
- * @property sampleBuffer - The shared buffer for audio data frames.
- * @property samplesPerFrame - The number of samples per frame.
- * @property usedFramesInBuffer - The usage count of the frames in the buffer.
- * @property totalFrames - The current position in the buffer, in frames.
- */
-export type OutputStreamProcessorOptions = Readonly<{
-  sampleBuffer: Float32Array
-  samplesPerFrame: number
-  usedFramesInBuffer: Uint32Array
-  totalFrames: BigUint64Array
-}>
-
-const createFrameBufferReader = (options: OutputStreamProcessorOptions) => {
-  return new FrameBufferReader(
-    new FrameBuffer(options.sampleBuffer, options.samplesPerFrame),
-    options.usedFramesInBuffer, options.totalFrames,
-  )
-}
+import type { FrameBufferConfig } from './frame-buffer/buffer-config'
 
 /**
  * OutputStreamProcessor class
@@ -41,7 +20,7 @@ class OutputStreamProcessor extends AudioWorkletProcessor {
    */
   constructor(options: AudioWorkletNodeOptions) {
     super()
-    this._frameReader = createFrameBufferReader(options.processorOptions as OutputStreamProcessorOptions)
+    this._frameReader = new FrameBufferReader(options.processorOptions as FrameBufferConfig)
     this.port.onmessage = this.handleMessage.bind(this)
   }
 

package/src/stream-node-factory.ts

@@ -1,43 +1,52 @@
 import processor from './output-stream-processor?worker&url'
-import { ManualBufferWriteStrategy } from './write-strategy/manual'
+import { ManualBufferWriteStrategy } from './write-strategy/manual-strategy'
 import { createFillerFrameBufferConfig, createFrameBufferConfig } from './frame-buffer/buffer-config'
 import type { OutputStreamNode } from './output-stream-node'
-import { TimedBufferWriteStrategy } from './write-strategy/timed'
+import { TimedBufferWriteStrategy } from './write-strategy/timed-strategy'
 import type { FrameBufferFiller } from './frame-buffer/buffer-filler'
 import { FrameBufferWriter } from './frame-buffer/buffer-writer'
-import { WorkerBufferWriteStrategy } from './write-strategy/worker/strategy'
+import { WorkerBufferWriteStrategy } from './write-strategy/worker-strategy'
 
 /**
  * Parameters for creating a manual buffer node.
+ * Used in the {@link StreamNodeFactory.createManualBufferNode} function.
  */
-export type ManualBufferNodeParams = Readonly<{
+export type ManualBufferNodeParams = {
   /** The number of audio channels. */
-  channelCount: number
+  readonly channelCount: number
   /** The size of the frame buffer in frames. */
-  frameBufferSize: number
-}>
+  readonly frameBufferSize: number
+}
 
 /**
  * Parameters for creating a timed buffer node.
+ * Used in the {@link StreamNodeFactory.createTimedBufferNode} function.
  */
-export type TimedBufferNodeParams = Readonly<{
+export type TimedBufferNodeParams = {
   /** The number of audio channels. */
-  channelCount: number
+  readonly channelCount: number
   /** Optional. The number of chunks in the frame buffer. */
-  frameBufferChunks?: number
+  readonly frameBufferChunks?: number
   /** Optional. The interval in milliseconds for filling the buffer. */
-  fillInterval?: number
+  readonly fillInterval?: number
   /** Optional. The sample rate of the audio context. */
-  sampleRate?: number
-}>
+  readonly sampleRate?: number
+}
 
 /**
  * Parameters for creating a worker buffer node.
+ * Used in the {@link StreamNodeFactory.createWorkerBufferNode} function.
+ *
+ * @template FillerParams - The parameters used by the FrameBufferFiller in the worker.
  */
-export type WorkerBufferNodeParams<T> = TimedBufferNodeParams & Readonly<{
-  /** Parameters specific to the filler used in the worker. */
-  fillerParams: T
-}>
+export type WorkerBufferNodeParams<FillerParams> = TimedBufferNodeParams & {
+  /**
+  * Parameters passed to the constructor when the Worker instantiates the FrameBufferFiller implementation class.
+  * Note: The values passed as FillerParams must be serializable (e.g., primitives, arrays, objects).
+  * Non-serializable values such as functions or DOM elements cannot be passed.
+  */
+  readonly fillerParams: FillerParams
+}
 
 /**
  * StreamNodeFactory class

package/src/write-strategy/{manual.ts → manual-strategy.ts}

@@ -1,5 +1,5 @@
-import { BufferWriteStrategy } from './strategy'
-import { createFrameBufferWriter, FrameBufferConfig } from '../frame-buffer/buffer-config'
+import type { BufferWriteStrategy } from './strategy'
+import type { FrameBufferConfig } from '../frame-buffer/buffer-config'
 import { FrameBufferWriter } from '../frame-buffer/buffer-writer'
 
 /**
@@ -14,7 +14,7 @@ export class ManualBufferWriteStrategy implements BufferWriteStrategy {
    * @param config - The configuration for the frame buffer.
    */
   constructor(config: FrameBufferConfig) {
-    this._writer = createFrameBufferWriter(config)
+    this._writer = new FrameBufferWriter(config)
   }
 
   /**

package/src/write-strategy/{timed.ts → timed-strategy.ts}

@@ -1,8 +1,8 @@
-import { BufferWriteStrategy } from './strategy'
-import { createFrameBufferWriter, FillerFrameBufferConfig } from '../frame-buffer/buffer-config'
+import type { BufferWriteStrategy } from './strategy'
+import type { FillerFrameBufferConfig } from '../frame-buffer/buffer-config'
 import { FrameBufferWriter } from '../frame-buffer/buffer-writer'
-import { FrameBufferFiller } from '../frame-buffer/buffer-filler'
-import { OutputStreamNode } from '../output-stream-node'
+import type { FrameBufferFiller } from '../frame-buffer/buffer-filler'
+import type { OutputStreamNode } from '../output-stream-node'
 
 /**
  * PlayContext class
@@ -63,7 +63,7 @@ export class TimedBufferWriteStrategy implements BufferWriteStrategy {
    * @param filler - The FrameBufferFiller instance.
    */
   constructor(config: FillerFrameBufferConfig, filler: FrameBufferFiller) {
-    this._writer = createFrameBufferWriter(config)
+    this._writer = new FrameBufferWriter(config)
     this._filler = filler
     this._interval = config.fillInterval
     this._isContinuePlayback = this._filler.fill(this._writer)

package/src/write-strategy/worker/worker.ts

@@ -1,6 +1,6 @@
-import { createFrameBufferWriter, FillerFrameBufferConfig } from '../../frame-buffer/buffer-config'
+import type { FillerFrameBufferConfig } from '../../frame-buffer/buffer-config'
 import type { FrameBufferFiller } from '../../frame-buffer/buffer-filler'
-import type { FrameBufferWriter } from '../../frame-buffer/buffer-writer'
+import { FrameBufferWriter } from '../../frame-buffer/buffer-writer'
 import { MessageToStrategy, MessageToWorker } from './message'
 
 /**
@@ -20,7 +20,7 @@ class Context {
    * @param frameBufferFiller - The FrameBufferFiller instance.
    */
   constructor(config: FillerFrameBufferConfig, frameBufferFiller: FrameBufferFiller) {
-    this._frameBufferWriter = createFrameBufferWriter(config)
+    this._frameBufferWriter = new FrameBufferWriter(config)
     this._frameBufferFiller = frameBufferFiller
     this._fillInterval = config.fillInterval
     this._isContinuePlayback = this.fillBuffer()
@@ -76,7 +76,9 @@ class Context {
 /**
  * BufferFillWorker class
  * Manages the communication between the main thread and the worker.
- */
+ *
+ * @template FillerParams - The parameters used by the FrameBufferFiller in the worker.
+*/
 export class BufferFillWorker<FillerParams> {
   private _context: Context | null = null
   private _frameBufferFillerGenerator: new (params: FillerParams) => FrameBufferFiller
@@ -84,7 +86,7 @@ export class BufferFillWorker<FillerParams> {
 
   /**
    * Creates an instance of BufferFillWorker.
-   * @param generator - A generator function to create the FrameBufferFiller instance.
+   * @param generator - A constructor function to create an instance of the FrameBufferFiller class.
    * @param init - An optional initialization function.
    */
   constructor(generator: new (params: FillerParams) => FrameBufferFiller, init?: () => Promise<void>) {

package/src/write-strategy/{worker/strategy.ts → worker-strategy.ts}

@@ -1,7 +1,7 @@
-import type { BufferWriteStrategy } from '../strategy'
-import type { FillerFrameBufferConfig } from '../../frame-buffer/buffer-config'
-import type { MessageToStrategy, MessageToWorker } from './message'
-import type { OutputStreamNode } from '../../output-stream-node'
+import type { BufferWriteStrategy } from './strategy'
+import type { FillerFrameBufferConfig } from '../frame-buffer/buffer-config'
+import type { MessageToStrategy, MessageToWorker } from './worker/message'
+import type { OutputStreamNode } from '../output-stream-node'
 
 /**
  * Parameters for creating a PlayContext.