node-av-lgpl 0.0.0 → 7.1.0-beta.2

package/dist/lib/stream.d.ts

@@ -0,0 +1,384 @@
+import { CodecParameters } from './codec-parameters.js';
+import { CodecParser } from './codec-parser.js';
+import { Dictionary } from './dictionary.js';
+import { Packet } from './packet.js';
+import { Rational } from './rational.js';
+import type { AVDiscard, AVDisposition, AVStreamEventFlag } from '../constants/constants.js';
+import type { NativeStream, NativeWrapper } from './native-types.js';
+/**
+ * Media stream within a format context.
+ *
+ * Represents a single stream (video, audio, subtitle, etc.) within a media container.
+ * Contains stream-specific information including codec parameters, timing information,
+ * metadata, and disposition flags. Each stream in a file has a unique index and may
+ * contain packets of compressed data.
+ *
+ * A stream belongs to its format context. Once that context is closed or freed, the
+ * stream and its codecpar read their defaults (e.g. index -1) and ignore writes;
+ * copy what must outlive the context first.
+ *
+ * Direct mapping to FFmpeg's AVStream.
+ *
+ * @example
+ * ```typescript
+ * import { FormatContext, FFmpegError } from 'node-av';
+ * import { AVMEDIA_TYPE_VIDEO, AVMEDIA_TYPE_AUDIO } from 'node-av/constants';
+ *
+ * // Access streams from format context
+ * const formatContext = new FormatContext();
+ * await formatContext.openInput('video.mp4');
+ *
+ * // Iterate through streams
+ * for (let i = 0; i < formatContext.nbStreams; i++) {
+ *   const stream = formatContext.streams[i];
+ *   const codecpar = stream.codecpar;
+ *
+ *   if (codecpar.codecType === AVMEDIA_TYPE_VIDEO) {
+ *     console.log(`Video stream ${stream.index}:`);
+ *     console.log(`  Codec: ${codecpar.codecId}`);
+ *     console.log(`  Resolution: ${codecpar.width}x${codecpar.height}`);
+ *     console.log(`  Frame rate: ${stream.avgFrameRate.num}/${stream.avgFrameRate.den}`);
+ *   } else if (codecpar.codecType === AVMEDIA_TYPE_AUDIO) {
+ *     console.log(`Audio stream ${stream.index}:`);
+ *     console.log(`  Sample rate: ${codecpar.sampleRate} Hz`);
+ *     console.log(`  Channels: ${codecpar.channels}`);
+ *   }
+ * }
+ * ```
+ *
+ * @see [AVStream](https://ffmpeg.org/doxygen/trunk/structAVStream.html) - FFmpeg Doxygen
+ * @see {@link FormatContext} For container operations
+ * @see {@link CodecParameters} For codec configuration
+ */
+export declare class Stream implements NativeWrapper<NativeStream> {
+    private native;
+    private _codecpar?;
+    /**
+     * @param native - The native stream instance
+     *
+     * @internal
+     */
+    constructor(native: NativeStream);
+    /**
+     * Stream index.
+     *
+     * Zero-based index of this stream in the format context.
+     * Used to identify packets belonging to this stream.
+     *
+     * Direct mapping to AVStream->index.
+     */
+    get index(): number;
+    /**
+     * Stream ID.
+     *
+     * Format-specific stream identifier.
+     * May be used by some formats for internal stream identification.
+     *
+     * Direct mapping to AVStream->id.
+     */
+    get id(): number;
+    set id(value: number);
+    /**
+     * Codec parameters.
+     *
+     * Contains essential codec configuration for this stream.
+     * Used to initialize decoders and describe stream properties.
+     * Reads defaults once the format context is closed or freed.
+     *
+     * Direct mapping to AVStream->codecpar.
+     */
+    get codecpar(): CodecParameters;
+    set codecpar(value: CodecParameters);
+    /**
+     * Stream time base.
+     *
+     * Unit of time for timestamps in this stream.
+     * All timestamps (PTS/DTS) are in units of this time base.
+     *
+     * Direct mapping to AVStream->time_base.
+     */
+    get timeBase(): Rational;
+    set timeBase(value: Rational);
+    /**
+     * Start time.
+     *
+     * First timestamp of the stream in stream time base units.
+     * AV_NOPTS_VALUE if unknown.
+     *
+     * Direct mapping to AVStream->start_time.
+     */
+    get startTime(): bigint;
+    set startTime(value: bigint);
+    /**
+     * Stream duration.
+     *
+     * Total duration in stream time base units.
+     * AV_NOPTS_VALUE if unknown.
+     *
+     * Direct mapping to AVStream->duration.
+     */
+    get duration(): bigint;
+    set duration(value: bigint);
+    /**
+     * Number of frames.
+     *
+     * Total number of frames in this stream.
+     * 0 if unknown.
+     *
+     * Direct mapping to AVStream->nb_frames.
+     */
+    get nbFrames(): bigint;
+    set nbFrames(value: bigint);
+    /**
+     * Stream disposition flags.
+     *
+     * Combination of AV_DISPOSITION_* flags indicating stream properties
+     * (e.g., default, forced subtitles, visual impaired, etc.).
+     *
+     * Direct mapping to AVStream->disposition.
+     */
+    get disposition(): AVDisposition;
+    set disposition(value: AVDisposition);
+    /**
+     * Discard setting.
+     *
+     * Indicates which packets can be discarded during demuxing.
+     * Used to skip non-essential packets for performance.
+     *
+     * Direct mapping to AVStream->discard.
+     */
+    get discard(): AVDiscard;
+    set discard(value: AVDiscard);
+    /**
+     * Sample aspect ratio.
+     *
+     * Pixel aspect ratio for video streams.
+     * 0/1 if unknown or not applicable.
+     *
+     * Direct mapping to AVStream->sample_aspect_ratio.
+     */
+    get sampleAspectRatio(): Rational;
+    set sampleAspectRatio(value: Rational);
+    /**
+     * Average frame rate.
+     *
+     * Average framerate of the stream.
+     * 0/1 if unknown or variable frame rate.
+     *
+     * Direct mapping to AVStream->avg_frame_rate.
+     */
+    get avgFrameRate(): Rational;
+    set avgFrameRate(value: Rational);
+    /**
+     * Real frame rate.
+     *
+     * Real base frame rate of the stream.
+     * This is the lowest common multiple of all frame rates in the stream.
+     *
+     * Direct mapping to AVStream->r_frame_rate.
+     */
+    get rFrameRate(): Rational;
+    set rFrameRate(value: Rational);
+    /**
+     * Number of bits for PTS wrap-around detection.
+     *
+     * Used for timestamp wrap-around correction in formats with limited timestamp bits.
+     * Common values: 33 (MPEG-TS), 31 (DVB), 64 (no wrapping).
+     *
+     * Direct mapping to AVStream->pts_wrap_bits.
+     */
+    get ptsWrapBits(): number;
+    set ptsWrapBits(value: number);
+    /**
+     * Stream metadata.
+     *
+     * Dictionary containing stream-specific metadata
+     * (e.g., language, title, encoder settings).
+     *
+     * Returns a copy of AVStream->metadata - mutating the returned Dictionary
+     * does not affect the stream. Assign it back to apply changes.
+     */
+    get metadata(): Dictionary | null;
+    set metadata(value: Dictionary | null);
+    /**
+     * Attached picture.
+     *
+     * For streams with AV_DISPOSITION_ATTACHED_PIC set,
+     * contains the attached picture (e.g., album art).
+     *
+     * Direct mapping to AVStream->attached_pic.
+     */
+    get attachedPic(): Packet | null;
+    /**
+     * Event flags.
+     *
+     * Flags indicating events that happened to the stream.
+     * Used for signaling format changes.
+     *
+     * Direct mapping to AVStream->event_flags.
+     */
+    get eventFlags(): AVStreamEventFlag;
+    set eventFlags(value: AVStreamEventFlag);
+    /**
+     * Get the state of the codec parser attached to this stream.
+     *
+     * FFmpeg creates a parser for certain formats and codecs. The returned parser is a copy of its
+     * state as of the last packet read from this stream, e.g. repeat_pict for interlaced video. It
+     * cannot parse: the stream's parser belongs to the thread that reads the input, which frees it at
+     * the end of the stream and on a seek.
+     *
+     * Based on av_stream_get_parser().
+     *
+     * @returns Parser state, or null before the first packet and when the stream had no parser for it
+     *
+     * @example
+     * ```typescript
+     * const parser = stream.parser;
+     * if (parser) {
+     *   const fields = 1 + parser.repeatPict;
+     *   console.log(`Frame uses ${fields} fields`);
+     * }
+     * ```
+     *
+     * @see {@link CodecParser} For parser details
+     */
+    get parser(): CodecParser | null;
+    /**
+     * Set stream event flags.
+     *
+     * Sets one or more event flags using bitwise OR. Allows setting multiple flags
+     * without manually performing bitwise operations.
+     *
+     * @param flags - One or more event flag values to set
+     *
+     * @example
+     * ```typescript
+     * import { AVSTREAM_EVENT_FLAG_METADATA_UPDATED, AVSTREAM_EVENT_FLAG_NEW_PACKETS } from 'node-av/constants';
+     *
+     * // Set multiple event flags at once
+     * stream.setEventFlags(AVSTREAM_EVENT_FLAG_METADATA_UPDATED, AVSTREAM_EVENT_FLAG_NEW_PACKETS);
+     * ```
+     *
+     * @see {@link clearEventFlags} To unset event flags
+     * @see {@link hasEventFlags} To check event flags
+     * @see {@link eventFlags} For direct event flag access
+     */
+    setEventFlags(...flags: AVStreamEventFlag[]): void;
+    /**
+     * Clear stream event flags.
+     *
+     * Clears one or more event flags using bitwise AND NOT. Allows clearing multiple
+     * flags without manually performing bitwise operations.
+     *
+     * @param flags - One or more event flag values to clear
+     *
+     * @example
+     * ```typescript
+     * import { AVSTREAM_EVENT_FLAG_METADATA_UPDATED } from 'node-av/constants';
+     *
+     * // Clear specific event flag
+     * stream.clearEventFlags(AVSTREAM_EVENT_FLAG_METADATA_UPDATED);
+     * ```
+     *
+     * @see {@link setEventFlags} To set event flags
+     * @see {@link hasEventFlags} To check event flags
+     * @see {@link eventFlags} For direct event flag access
+     */
+    clearEventFlags(...flags: AVStreamEventFlag[]): void;
+    /**
+     * Check if stream has specific event flags.
+     *
+     * Tests whether all specified event flags are set using bitwise AND.
+     *
+     * @param flags - One or more event flag values to check
+     *
+     * @returns true if all specified event flags are set, false otherwise
+     *
+     * @example
+     * ```typescript
+     * import { AVSTREAM_EVENT_FLAG_METADATA_UPDATED } from 'node-av/constants';
+     *
+     * if (stream.hasEventFlags(AVSTREAM_EVENT_FLAG_METADATA_UPDATED)) {
+     *   console.log('Stream metadata was updated');
+     * }
+     * ```
+     *
+     * @see {@link setEventFlags} To set event flags
+     * @see {@link clearEventFlags} To unset event flags
+     * @see {@link eventFlags} For direct event flag access
+     */
+    hasEventFlags(...flags: AVStreamEventFlag[]): boolean;
+    /**
+     * Set stream disposition flags.
+     *
+     * Sets one or more disposition flags using bitwise OR. Allows setting multiple flags
+     * without manually performing bitwise operations.
+     *
+     * @param flags - One or more disposition flag values to set
+     *
+     * @example
+     * ```typescript
+     * import { AV_DISPOSITION_DEFAULT, AV_DISPOSITION_FORCED } from 'node-av/constants';
+     *
+     * // Set multiple disposition flags at once
+     * stream.setDisposition(AV_DISPOSITION_DEFAULT, AV_DISPOSITION_FORCED);
+     * ```
+     *
+     * @see {@link clearDisposition} To unset disposition flags
+     * @see {@link hasDisposition} To check disposition flags
+     * @see {@link disposition} For direct disposition flag access
+     */
+    setDisposition(...flags: AVDisposition[]): void;
+    /**
+     * Clear stream disposition flags.
+     *
+     * Clears one or more disposition flags using bitwise AND NOT. Allows clearing multiple
+     * flags without manually performing bitwise operations.
+     *
+     * @param flags - One or more disposition flag values to clear
+     *
+     * @example
+     * ```typescript
+     * import { AV_DISPOSITION_FORCED } from 'node-av/constants';
+     *
+     * // Clear specific disposition flag
+     * stream.clearDisposition(AV_DISPOSITION_FORCED);
+     * ```
+     *
+     * @see {@link setDisposition} To set disposition flags
+     * @see {@link hasDisposition} To check disposition flags
+     * @see {@link disposition} For direct disposition flag access
+     */
+    clearDisposition(...flags: AVDisposition[]): void;
+    /**
+     * Check if stream has specific disposition flags.
+     *
+     * Tests whether all specified disposition flags are set using bitwise AND.
+     *
+     * @param flags - One or more disposition flag values to check
+     *
+     * @returns true if all specified disposition flags are set, false otherwise
+     *
+     * @example
+     * ```typescript
+     * import { AV_DISPOSITION_DEFAULT } from 'node-av/constants';
+     *
+     * if (stream.hasDisposition(AV_DISPOSITION_DEFAULT)) {
+     *   console.log('Stream is marked as default');
+     * }
+     * ```
+     *
+     * @see {@link setDisposition} To set disposition flags
+     * @see {@link clearDisposition} To unset disposition flags
+     * @see {@link disposition} For direct disposition flag access
+     */
+    hasDisposition(...flags: AVDisposition[]): boolean;
+    /**
+     * Get the underlying native Stream object.
+     *
+     * @returns The native Stream binding object
+     *
+     * @internal
+     */
+    getNative(): NativeStream;
+}