node-av 4.0.0 → 5.0.0

package/dist/api/encoder.d.ts

@@ -1,9 +1,9 @@
 import { CodecContext } from '../lib/codec-context.js';
 import { Codec } from '../lib/codec.js';
+import { Frame } from '../lib/frame.js';
 import { Packet } from '../lib/packet.js';
 import { SchedulerControl } from './utilities/scheduler.js';
-import type { AVCodecFlag, AVCodecID, FFEncoderCodec } from '../constants/index.js';
-import type { Frame } from '../lib/frame.js';
+import type { AVCodecFlag, AVCodecID, EOFSignal, FFEncoderCodec } from '../constants/index.js';
 import type { Muxer } from './muxer.js';
 import type { EncoderOptions } from './types.js';
 /**
@@ -342,28 +342,31 @@ export declare class Encoder implements Disposable {
      */
     isReady(): boolean;
     /**
-     * Encode a frame to a packet.
+     * Send a frame to the encoder.
      *
-     * Sends a frame to the encoder and attempts to receive an encoded packet.
+     * Sends a raw frame to the encoder for encoding.
+     * Does not return encoded packets - use {@link receive} to retrieve packets.
      * On first frame, automatically initializes encoder with frame properties.
-     * Handles internal buffering - may return null if more frames needed.
+     * A single frame can produce zero, one, or multiple packets depending on codec buffering.
      *
-     * **Note**: This method receives only ONE packet per call.
-     * A single frame can produce multiple packets (e.g., B-frames, codec buffering).
-     * To receive all packets from a frame, use {@link encodeAll} or {@link packets} instead.
+     * **Important**: This method only SENDS the frame to the encoder.
+     * You must call {@link receive} separately (potentially multiple times) to get encoded packets.
      *
-     * Direct mapping to avcodec_send_frame() and avcodec_receive_packet().
-     *
-     * @param frame - Raw frame to encode (or null to flush)
+     * Direct mapping to avcodec_send_frame().
      *
-     * @returns Encoded packet, null if more data needed, or null if encoder is closed
+     * @param frame - Raw frame to send to encoder
      *
-     * @throws {FFmpegError} If encoding fails
+     * @throws {FFmpegError} If sending frame fails
      *
      * @example
      * ```typescript
-     * const packet = await encoder.encode(frame);
-     * if (packet) {
+     * // Send frame and receive packets
+     * await encoder.encode(frame);
+     *
+     * // Receive all available packets
+     * while (true) {
+     *   const packet = await encoder.receive();
+     *   if (!packet) break;
      *   console.log(`Encoded packet with PTS: ${packet.pts}`);
      *   await output.writePacket(packet);
      *   packet.free();
@@ -372,10 +375,13 @@ export declare class Encoder implements Disposable {
      *
      * @example
      * ```typescript
-     * // Encode loop
      * for await (const frame of decoder.frames(input.packets())) {
-     *   const packet = await encoder.encode(frame);
-     *   if (packet) {
+     *   // Send frame
+     *   await encoder.encode(frame);
+     *
+     *   // Receive available packets
+     *   let packet;
+     *   while ((packet = await encoder.receive())) {
      *     await output.writePacket(packet);
      *     packet.free();
      *   }
@@ -383,61 +389,52 @@ export declare class Encoder implements Disposable {
      * }
      * ```
      *
-     * @see {@link encodeAll} For multiple packet encoding
+     * @see {@link receive} For receiving encoded packets
+     * @see {@link encodeAll} For combined send+receive operation
      * @see {@link packets} For automatic frame iteration
      * @see {@link flush} For end-of-stream handling
      * @see {@link encodeSync} For synchronous version
      */
-    encode(frame: Frame | null): Promise<Packet | null>;
+    encode(frame: Frame): Promise<void>;
     /**
-     * Encode a frame to a packet synchronously.
+     * Send a frame to the encoder synchronously.
      * Synchronous version of encode.
      *
-     * Sends a frame to the encoder and attempts to receive an encoded packet.
+     * Sends a raw frame to the encoder for encoding.
+     * Does not return encoded packets - use {@link receiveSync} to retrieve packets.
      * On first frame, automatically initializes encoder with frame properties.
-     * Handles internal buffering - may return null if more frames needed.
+     * A single frame can produce zero, one, or multiple packets depending on codec buffering.
      *
-     * **Note**: This method receives only ONE packet per call.
-     * A single frame can produce multiple packets (e.g., B-frames, codec buffering).
-     * To receive all packets from a frame, use {@link encodeAllSync} or {@link packetsSync} instead.
+     * **Important**: This method only SENDS the frame to the encoder.
+     * You must call {@link receiveSync} separately (potentially multiple times) to get encoded packets.
      *
-     * Direct mapping to avcodec_send_frame() and avcodec_receive_packet().
-     *
-     * @param frame - Raw frame to encode (or null to flush)
+     * Direct mapping to avcodec_send_frame().
      *
-     * @returns Encoded packet, null if more data needed, or null if encoder is closed
+     * @param frame - Raw frame to send to encoder
      *
-     * @throws {FFmpegError} If encoding fails
+     * @throws {FFmpegError} If sending frame fails
      *
      * @example
      * ```typescript
-     * const packet = encoder.encodeSync(frame);
-     * if (packet) {
+     * // Send frame and receive packets
+     * encoder.encodeSync(frame);
+     *
+     * // Receive all available packets
+     * let packet;
+     * while ((packet = encoder.receiveSync())) {
      *   console.log(`Encoded packet with PTS: ${packet.pts}`);
      *   output.writePacketSync(packet);
      *   packet.free();
      * }
      * ```
      *
-     * @example
-     * ```typescript
-     * // Encode loop
-     * for (const frame of decoder.framesSync(packets)) {
-     *   const packet = encoder.encodeSync(frame);
-     *   if (packet) {
-     *     output.writePacketSync(packet);
-     *     packet.free();
-     *   }
-     *   frame.free();
-     * }
-     * ```
-     *
-     * @see {@link encodeAllSync} For multiple packet encoding
+     * @see {@link receiveSync} For receiving encoded packets
+     * @see {@link encodeAllSync} For combined send+receive operation
      * @see {@link packetsSync} For automatic frame iteration
      * @see {@link flushSync} For end-of-stream handling
      * @see {@link encode} For async version
      */
-    encodeSync(frame: Frame | null): Packet | null;
+    encodeSync(frame: Frame): void;
     /**
      * Encode a frame to packets.
      *
@@ -533,20 +530,28 @@ export declare class Encoder implements Disposable {
      * Encode frame stream to packet stream.
      *
      * High-level async generator for complete encoding pipeline.
-     * Automatically manages frame memory, encoder state,
-     * and flushes buffered packets at end.
+     * Encoder is only flushed when EOF (null) signal is explicitly received.
      * Primary interface for stream-based encoding.
      *
-     * @param frames - Async iterable of frames (freed automatically)
+     * **EOF Handling:**
+     * - Send null to flush encoder and get remaining buffered packets
+     * - Generator yields null after flushing when null is received
+     * - No automatic flushing - encoder stays open until EOF or close()
+     *
+     * @param frames - Async iterable of frames, single frame, or null to flush
      *
-     * @yields {Packet} Encoded packets (caller must free)
+     * @yields {Packet | null} Encoded packets, followed by null when explicitly flushed
      *
      * @throws {FFmpegError} If encoding fails
      *
      * @example
      * ```typescript
-     * // Basic encoding pipeline
+     * // Stream of frames with automatic EOF propagation
      * for await (const packet of encoder.packets(decoder.frames(input.packets()))) {
+     *   if (packet === null) {
+     *     console.log('Encoder flushed');
+     *     break;
+     *   }
      *   await output.writePacket(packet);
      *   packet.free(); // Must free output packets
      * }
@@ -554,61 +559,60 @@ export declare class Encoder implements Disposable {
      *
      * @example
      * ```typescript
-     * // With frame filtering
-     * async function* filteredFrames() {
-     *   for await (const frame of decoder.frames(input.packets())) {
-     *     const filtered = await filter.process(frame);
-     *     if (filtered) {
-     *       yield filtered;
-     *     }
-     *     frame.free();
-     *   }
-     * }
-     *
-     * for await (const packet of encoder.packets(filteredFrames())) {
+     * // Single frame - no automatic flush
+     * for await (const packet of encoder.packets(singleFrame)) {
      *   await output.writePacket(packet);
      *   packet.free();
      * }
+     * // Encoder remains open, buffered packets not flushed
      * ```
      *
      * @example
      * ```typescript
-     * // Pipeline integration
-     * import { pipeline } from 'node-av/api';
-     *
-     * const control = pipeline(
-     *   input,
-     *   decoder,
-     *   encoder,
-     *   output
-     * );
-     * await control.completion;
+     * // Explicit flush with EOF
+     * for await (const packet of encoder.packets(null)) {
+     *   if (packet === null) {
+     *     console.log('All buffered packets flushed');
+     *     break;
+     *   }
+     *   console.log('Buffered packet:', packet.pts);
+     *   await output.writePacket(packet);
+     *   packet.free();
+     * }
      * ```
      *
      * @see {@link encode} For single frame encoding
      * @see {@link Decoder.frames} For frame source
      * @see {@link packetsSync} For sync version
      */
-    packets(frames: AsyncIterable<Frame | null>): AsyncGenerator<Packet | null>;
+    packets(frames: AsyncIterable<Frame | null> | Frame | null): AsyncGenerator<Packet | null>;
     /**
      * Encode frame stream to packet stream synchronously.
      * Synchronous version of packets.
      *
      * High-level sync generator for complete encoding pipeline.
-     * Automatically manages frame memory, encoder state,
-     * and flushes buffered packets at end.
+     * Encoder is only flushed when EOF (null) signal is explicitly received.
      * Primary interface for stream-based encoding.
      *
-     * @param frames - Iterable of frames (freed automatically)
+     * **EOF Handling:**
+     * - Send null to flush encoder and get remaining buffered packets
+     * - Generator yields null after flushing when null is received
+     * - No automatic flushing - encoder stays open until EOF or close()
      *
-     * @yields {Packet} Encoded packets (caller must free)
+     * @param frames - Iterable of frames, single frame, or null to flush
+     *
+     * @yields {Packet | null} Encoded packets, followed by null when explicitly flushed
      *
      * @throws {FFmpegError} If encoding fails
      *
      * @example
      * ```typescript
-     * // Basic encoding pipeline
+     * // Stream of frames with automatic EOF propagation
      * for (const packet of encoder.packetsSync(decoder.framesSync(packets))) {
+     *   if (packet === null) {
+     *     console.log('Encoder flushed');
+     *     break;
+     *   }
      *   output.writePacketSync(packet);
      *   packet.free(); // Must free output packets
      * }
@@ -616,18 +620,23 @@ export declare class Encoder implements Disposable {
      *
      * @example
      * ```typescript
-     * // With frame filtering
-     * function* filteredFrames() {
-     *   for (const frame of decoder.framesSync(packets)) {
-     *     const filtered = filter.processSync(frame);
-     *     if (filtered) {
-     *       yield filtered;
-     *     }
-     *     frame.free();
-     *   }
+     * // Single frame - no automatic flush
+     * for (const packet of encoder.packetsSync(singleFrame)) {
+     *   output.writePacketSync(packet);
+     *   packet.free();
      * }
+     * // Encoder remains open, buffered packets not flushed
+     * ```
      *
-     * for (const packet of encoder.packetsSync(filteredFrames())) {
+     * @example
+     * ```typescript
+     * // Explicit flush with EOF
+     * for (const packet of encoder.packetsSync(null)) {
+     *   if (packet === null) {
+     *     console.log('All buffered packets flushed');
+     *     break;
+     *   }
+     *   console.log('Buffered packet:', packet.pts);
      *   output.writePacketSync(packet);
      *   packet.free();
      * }
@@ -637,7 +646,7 @@ export declare class Encoder implements Disposable {
      * @see {@link Decoder.framesSync} For frame source
      * @see {@link packets} For async version
      */
-    packetsSync(frames: Iterable<Frame | null>): Generator<Packet | null>;
+    packetsSync(frames: Iterable<Frame | null> | Frame | null): Generator<Packet | null>;
     /**
      * Flush encoder and signal end-of-stream.
      *
@@ -749,19 +758,25 @@ export declare class Encoder implements Disposable {
      *
      * Gets encoded packets from the codec's internal buffer.
      * Handles packet cloning and error checking.
-     * Returns null if encoder is closed, not initialized, or no packets available.
-     * Call repeatedly until null to drain all buffered packets.
+     * Implements FFmpeg's send/receive pattern.
+     *
+     * **Return Values:**
+     * - `Packet` - Successfully encoded packet (AVERROR >= 0)
+     * - `null` - Need more input frames (AVERROR_EAGAIN), or encoder not initialized
+     * - `undefined` - End of stream reached (AVERROR_EOF), or encoder is closed
      *
      * Direct mapping to avcodec_receive_packet().
      *
-     * @returns Cloned packet or null if no packets available
+     * @returns Cloned packet, null if need more data, or undefined if stream ended
      *
      * @throws {FFmpegError} If receive fails with error other than AVERROR_EAGAIN or AVERROR_EOF
      *
      * @example
      * ```typescript
-     * const packet = await encoder.receive();
-     * if (packet) {
+     * // Process all buffered packets
+     * while (true) {
+     *   const packet = await encoder.receive();
+     *   if (!packet) break; // Stop on EAGAIN or EOF
      *   console.log(`Got packet with PTS: ${packet.pts}`);
      *   await output.writePacket(packet);
      *   packet.free();
@@ -770,10 +785,14 @@ export declare class Encoder implements Disposable {
      *
      * @example
      * ```typescript
-     * // Drain all buffered packets
-     * let packet;
-     * while ((packet = await encoder.receive()) !== null) {
-     *   console.log(`Packet size: ${packet.size}`);
+     * // Handle each return value explicitly
+     * const packet = await encoder.receive();
+     * if (packet === EOF) {
+     *   console.log('Encoder stream ended');
+     * } else if (packet === null) {
+     *   console.log('Need more input frames');
+     * } else {
+     *   console.log(`Got packet: pts=${packet.pts}`);
      *   await output.writePacket(packet);
      *   packet.free();
      * }
@@ -782,27 +801,34 @@ export declare class Encoder implements Disposable {
      * @see {@link encode} For sending frames and receiving packets
      * @see {@link flush} For signaling end-of-stream
      * @see {@link receiveSync} For synchronous version
+     * @see {@link EOF} For end-of-stream signal
      */
-    receive(): Promise<Packet | null>;
+    receive(): Promise<Packet | EOFSignal | null>;
     /**
      * Receive packet from encoder synchronously.
      * Synchronous version of receive.
      *
      * Gets encoded packets from the codec's internal buffer.
      * Handles packet cloning and error checking.
-     * Returns null if encoder is closed, not initialized, or no packets available.
-     * Call repeatedly until null to drain all buffered packets.
+     * Implements FFmpeg's send/receive pattern.
+     *
+     * **Return Values:**
+     * - `Packet` - Successfully encoded packet (AVERROR >= 0)
+     * - `null` - Need more input frames (AVERROR_EAGAIN), or encoder not initialized
+     * - `undefined` - End of stream reached (AVERROR_EOF), or encoder is closed
      *
      * Direct mapping to avcodec_receive_packet().
      *
-     * @returns Cloned packet or null if no packets available
+     * @returns Cloned packet, null if need more data, or undefined if stream ended
      *
      * @throws {FFmpegError} If receive fails with error other than AVERROR_EAGAIN or AVERROR_EOF
      *
      * @example
      * ```typescript
-     * const packet = encoder.receiveSync();
-     * if (packet) {
+     * // Process all buffered packets
+     * while (true) {
+     *   const packet = encoder.receiveSync();
+     *   if (!packet) break; // Stop on EAGAIN or EOF
      *   console.log(`Got packet with PTS: ${packet.pts}`);
      *   output.writePacketSync(packet);
      *   packet.free();
@@ -811,10 +837,14 @@ export declare class Encoder implements Disposable {
      *
      * @example
      * ```typescript
-     * // Drain all buffered packets
-     * let packet;
-     * while ((packet = encoder.receiveSync()) !== null) {
-     *   console.log(`Packet size: ${packet.size}`);
+     * // Handle each return value explicitly
+     * const packet = encoder.receiveSync();
+     * if (packet === EOF) {
+     *   console.log('Encoder stream ended');
+     * } else if (packet === null) {
+     *   console.log('Need more input frames');
+     * } else {
+     *   console.log(`Got packet: pts=${packet.pts}`);
      *   output.writePacketSync(packet);
      *   packet.free();
      * }
@@ -823,8 +853,9 @@ export declare class Encoder implements Disposable {
      * @see {@link encodeSync} For sending frames and receiving packets
      * @see {@link flushSync} For signaling end-of-stream
      * @see {@link receive} For async version
+     * @see {@link EOF} For end-of-stream signal
      */
-    receiveSync(): Packet | null;
+    receiveSync(): Packet | EOFSignal | null;
     /**
      * Pipe encoded packets to muxer.
      *
@@ -894,9 +925,19 @@ export declare class Encoder implements Disposable {
      */
     private runWorker;
     /**
-     * Send frame to input queue.
+     * Send frame to input queue or flush the pipeline.
      *
-     * @param frame - Frame to send
+     * When frame is provided, queues it for encoding.
+     * When null is provided, triggers flush sequence:
+     * - Closes input queue
+     * - Waits for worker completion
+     * - Flushes encoder and sends remaining packets to output queue
+     * - Closes output queue
+     * - Waits for pipeTo task completion (writes to muxer)
+     *
+     * Used by scheduler system for pipeline control.
+     *
+     * @param frame - Frame to send, or null to flush
      *
      * @internal
      */
@@ -909,14 +950,6 @@ export declare class Encoder implements Disposable {
      * @internal
      */
     private receiveFromQueue;
-    /**
-     * Flush the entire filter pipeline.
-     *
-     * Propagates flush through worker, output queue, and next component.
-     *
-     * @internal
-     */
-    private flushPipeline;
     /**
      * Initialize encoder from first frame.
      *