node-av 6.2.0-beta.3 → 6.2.0-beta.30

package/dist/api/rtp-stream.d.ts

@@ -25,6 +25,10 @@ export interface RTPStreamOptions {
     /**
      * Callback invoked when the stream is closed or encounters an error.
      *
+     * Called once per started session. On an error the stream has already been
+     * stopped and its resources (including the input connection) released.
+     * Exceptions thrown by the callback are logged and do not propagate.
+     *
      * @param error - Optional error if stream closed due to an error
      */
     onClose?: (error?: Error) => void;
@@ -67,6 +71,8 @@ export interface RTPStreamOptions {
         fps?: number;
         width?: number;
         height?: number;
+        bitrate?: number;
+        dumpExtra?: boolean;
         encoderOptions?: EncoderOptions['options'];
     };
     /**
@@ -143,6 +149,7 @@ export declare class RTPStream {
     private videoDecoder?;
     private videoFilter?;
     private videoEncoder?;
+    private videoBitstreamFilter?;
     private audioDecoder?;
     private audioFilter?;
     private audioEncoder?;
@@ -152,6 +159,11 @@ export declare class RTPStream {
     private supportedVideoCodecs;
     private supportedAudioCodecs;
     private videoKeyframeRequested;
+    private abortHandler?;
+    private stopRequested;
+    private stopPromise?;
+    private startAbort?;
+    private stopSignal;
     /**
      * @param input - Media input URL or pre-opened Demuxer
      *
@@ -206,6 +218,10 @@ export declare class RTPStream {
     /**
      * Check if the stream is active.
      *
+     * Stays true while a requested stop is still unwinding: the pipeline reports
+     * itself stopped as soon as stop() is called, but its packets keep flowing
+     * and its native resources stay open until completion settles.
+     *
      * @returns True if the stream is active, false otherwise
      */
     get isStreamActive(): boolean;
@@ -293,17 +309,65 @@ export declare class RTPStream {
      * @internal
      */
     private doStart;
+    /**
+     * Abort an in-flight startup once stop() was requested.
+     *
+     * Checked after every await in the startup path: the resources created so
+     * far are all assigned to instance fields, so the stop() that is waiting on
+     * this startup tears them down the moment it unwinds.
+     *
+     * @throws {Error} If stop() was called while starting
+     *
+     * @internal
+     */
+    private throwIfStopRequested;
+    /**
+     * Cap the video bitrate on the encoder context.
+     *
+     * Sets the target bitrate together with a VBV cap (maxrate + a 1s buffer).
+     * Encoder.create() always seeds a default target bitrate (1 Mbps for video),
+     * so the target MUST be lowered along with the cap.
+     *
+     * @param ctx - Encoder codec context
+     *
+     * @param bitrate - Maximum bitrate in bits per second, or undefined
+     *
+     * @internal
+     */
+    private applyBitrate;
     /**
      * Wire the pipeline completion to the onClose/error callbacks.
      *
      * On success invokes `onClose()`; on error stops the stream and invokes
-     * `onClose(error)`. Runs in the background (not awaited).
+     * `onClose(error)`. Either way `onClose` runs exactly once and the detached
+     * chain never rejects. Runs in the background (not awaited).
      *
      * @param completion - The pipeline completion promise
      *
      * @internal
      */
     private attachCompletion;
+    /**
+     * Invoke the owner's onClose callback.
+     *
+     * The completion chain runs detached, so an exception from the callback
+     * could only surface as an unhandled rejection - it is logged instead.
+     *
+     * @param error - Pipeline error, or undefined for a clean end
+     *
+     * @internal
+     */
+    private emitClose;
+    /**
+     * Whether a pipeline rejection was caused by an intentional shutdown.
+     *
+     * @param error - The pipeline rejection reason
+     *
+     * @returns True when stop() is in flight or the owner's signal aborted
+     *
+     * @internal
+     */
+    private isDeliberateStop;
     /**
      * Set up encoders and RTP outputs for a pre-composited frame source and start
      * encoding. No demuxer or decoder is involved - the provided frames are encoded
@@ -318,12 +382,10 @@ export declare class RTPStream {
     /**
      * Create the RTP video output muxer.
      *
-     * Rewrites RTP sequence numbers (continuous) and timestamps (90 kHz, advanced
-     * per frame at `fps`) in the write callback, then forwards each packet to
-     * `onVideoPacket`. Uses `this.input` when present (demuxer path) and no input
-     * for the frame-source path.
-     *
-     * @param fps - Frame rate used for the RTP timestamp increment
+     * Rewrites RTP sequence numbers (continuous) and rebases the PTS-derived
+     * timestamps (90 kHz) onto a random initial value in the write callback, then
+     * forwards each packet to `onVideoPacket`. Uses `this.input` when present
+     * (demuxer path) and no input for the frame-source path.
      *
      * @returns The configured video muxer
      *
@@ -353,7 +415,8 @@ export declare class RTPStream {
      *
      * Stops the pipeline, closes output, and releases all FFmpeg resources.
      * Safe to call multiple times. After stopping, you can call start() again
-     * to restart the stream.
+     * to restart the stream. Resolves even if the pipeline had failed; that
+     * error is reported through `onClose(error)`.
      *
      * @example
      * ```typescript
@@ -367,6 +430,12 @@ export declare class RTPStream {
      * ```
      */
     stop(): Promise<void>;
+    /**
+     * Perform the actual teardown (see {@link stop}).
+     *
+     * @internal
+     */
+    private doStop;
     /**
      * Check if the given audio codec is supported.
      *