Refactor media options types to unify Demuxer and Muxer configurations

Author: seydx

src/api/demuxer.ts

@@ -35,7 +35,7 @@ import { StreamingUtils } from './utilities/streaming.js';
 
 import type { AVMediaType, AVSeekFlag, AVSeekWhence } from '../constants/index.js';
 import type { Stream } from '../lib/stream.js';
-import type { IOInputCallbacks, MediaInputOptions, RawData, RTPMediaInput } from './types.js';
+import type { DemuxerOptions, IOInputCallbacks, RawData, RTPDemuxer } from './types.js';
 
 /**
  * Per-stream timestamp processing state.
@@ -96,7 +96,7 @@ export class Demuxer implements AsyncDisposable, Disposable {
   private _streams: Stream[] = [];
   private ioContext?: IOContext;
   private isClosed = false;
-  private options: Required<MediaInputOptions>;
+  private options: Required<DemuxerOptions>;
 
   // Timestamp processing state (per-stream)
   private streamStates = new Map<number, StreamState>();
@@ -122,7 +122,7 @@ export class Demuxer implements AsyncDisposable, Disposable {
    *
    * @internal
    */
-  private constructor(formatContext: FormatContext, options: Required<MediaInputOptions>, ioContext?: IOContext) {
+  private constructor(formatContext: FormatContext, options: Required<DemuxerOptions>, ioContext?: IOContext) {
     this.formatContext = formatContext;
     this.ioContext = ioContext;
     this._streams = formatContext.streams ?? [];
@@ -382,18 +382,18 @@ export class Demuxer implements AsyncDisposable, Disposable {
    * });
    * ```
    *
-   * @see {@link MediaInputOptions} For configuration options
+   * @see {@link DemuxerOptions} For configuration options
    * @see {@link RawData} For raw data input
    * @see {@link IOInputCallbacks} For custom I/O interface
    */
-  static async open(input: string | Buffer, options?: MediaInputOptions): Promise<Demuxer>;
-  static async open(input: IOInputCallbacks, options: (MediaInputOptions | undefined) & { format: string }): Promise<Demuxer>;
-  static async open(rawData: RawData, options?: MediaInputOptions): Promise<Demuxer>;
-  static async open(input: string | Buffer | RawData | IOInputCallbacks, options: MediaInputOptions = {}): Promise<Demuxer> {
+  static async open(input: string | Buffer, options?: DemuxerOptions): Promise<Demuxer>;
+  static async open(input: IOInputCallbacks, options: (DemuxerOptions | undefined) & { format: string }): Promise<Demuxer>;
+  static async open(rawData: RawData, options?: DemuxerOptions): Promise<Demuxer>;
+  static async open(input: string | Buffer | RawData | IOInputCallbacks, options: DemuxerOptions = {}): Promise<Demuxer> {
     // Check if input is raw data
     if (typeof input === 'object' && 'type' in input && ('width' in input || 'sampleRate' in input)) {
       // Build options for raw data
-      const rawOptions: MediaInputOptions & { format: string } = {
+      const rawOptions: DemuxerOptions & { format: string } = {
         bufferSize: options.bufferSize,
         format: options.format ?? (input.type === 'video' ? 'rawvideo' : 's16le'),
         options: {
@@ -513,7 +513,7 @@ export class Demuxer implements AsyncDisposable, Disposable {
       }
 
       // Apply defaults to options
-      const fullOptions: Required<MediaInputOptions> = {
+      const fullOptions: Required<DemuxerOptions> = {
         bufferSize,
         format: options.format ?? '',
         skipStreamInfo: options.skipStreamInfo ?? false,
@@ -614,14 +614,14 @@ export class Demuxer implements AsyncDisposable, Disposable {
    * @see {@link open} For async version
    * @see {@link IOInputCallbacks} For custom I/O interface
    */
-  static openSync(input: string | Buffer, options?: MediaInputOptions): Demuxer;
-  static openSync(input: IOInputCallbacks, options: (MediaInputOptions | undefined) & { format: string }): Demuxer;
-  static openSync(rawData: RawData, options?: MediaInputOptions): Demuxer;
-  static openSync(input: string | Buffer | RawData | IOInputCallbacks, options: MediaInputOptions = {}): Demuxer {
+  static openSync(input: string | Buffer, options?: DemuxerOptions): Demuxer;
+  static openSync(input: IOInputCallbacks, options: (DemuxerOptions | undefined) & { format: string }): Demuxer;
+  static openSync(rawData: RawData, options?: DemuxerOptions): Demuxer;
+  static openSync(input: string | Buffer | RawData | IOInputCallbacks, options: DemuxerOptions = {}): Demuxer {
     // Check if input is raw data
     if (typeof input === 'object' && 'type' in input && ('width' in input || 'sampleRate' in input)) {
       // Build options for raw data
-      const rawOptions: MediaInputOptions & { format: string } = {
+      const rawOptions: DemuxerOptions & { format: string } = {
         bufferSize: options.bufferSize,
         format: options.format ?? (input.type === 'video' ? 'rawvideo' : 's16le'),
         options: {
@@ -727,7 +727,7 @@ export class Demuxer implements AsyncDisposable, Disposable {
       }
 
       // Apply defaults to options
-      const fullOptions: Required<MediaInputOptions> = {
+      const fullOptions: Required<DemuxerOptions> = {
         bufferSize,
         format: options.format ?? '',
         skipStreamInfo: options.skipStreamInfo ?? false,
@@ -808,7 +808,7 @@ export class Demuxer implements AsyncDisposable, Disposable {
    *
    * @see {@link StreamingUtils.createInputSDP} to generate SDP content.
    */
-  static async openSDP(sdpContent: string): Promise<RTPMediaInput> {
+  static async openSDP(sdpContent: string): Promise<RTPDemuxer> {
     // Extract all ports from SDP (supports multi-stream: video + audio)
     const ports = StreamingUtils.extractPortsFromSDP(sdpContent);
     if (ports.length === 0) {
@@ -933,7 +933,7 @@ export class Demuxer implements AsyncDisposable, Disposable {
    * @see {@link StreamingUtils.createInputSDP} to generate SDP content.
    * @see {@link openSDP} For async version
    */
-  static openSDPSync(sdpContent: string): RTPMediaInput {
+  static openSDPSync(sdpContent: string): RTPDemuxer {
     // Extract all ports from SDP (supports multi-stream: video + audio)
     const ports = StreamingUtils.extractPortsFromSDP(sdpContent);
     if (ports.length === 0) {

src/api/fmp4-stream.ts

@@ -22,7 +22,7 @@ import { pipeline } from './pipeline.js';
 
 import type { AVCodecID, AVHWDeviceType, FFHWDeviceType } from '../constants/index.js';
 import type { PipelineControl } from './pipeline.js';
-import type { EncoderOptions, IOOutputCallbacks, MediaInputOptions } from './types.js';
+import type { DemuxerOptions, EncoderOptions, IOOutputCallbacks } from './types.js';
 
 export type MP4BoxType =
   // Top-level structure
@@ -148,7 +148,7 @@ export interface FMP4StreamOptions {
   /**
    * Input media options passed to Demuxer.
    */
-  inputOptions?: MediaInputOptions;
+  inputOptions?: DemuxerOptions;
 
   /**
    * Buffer size for I/O operations in bytes (output).
@@ -231,7 +231,7 @@ export const FMP4_CODECS = {
 export class FMP4Stream {
   private options: Required<FMP4StreamOptions>;
   private inputUrl: string;
-  private inputOptions: MediaInputOptions;
+  private inputOptions: DemuxerOptions;
   private input?: Demuxer;
   private output?: Muxer;
   private hardwareContext?: HardwareContext | null;

src/api/io-stream.ts

@@ -3,7 +3,7 @@ import { IOContext } from '../lib/index.js';
 import { IO_BUFFER_SIZE } from './constants.js';
 
 import type { AVSeekWhence } from '../constants/index.js';
-import type { IOInputCallbacks, MediaInputOptions } from './types.js';
+import type { DemuxerOptions, IOInputCallbacks } from './types.js';
 
 /**
  * Factory for creating custom I/O contexts.
@@ -67,7 +67,7 @@ export class IOStream {
    * });
    * ```
    */
-  static create(buffer: Buffer, options?: MediaInputOptions): IOContext;
+  static create(buffer: Buffer, options?: DemuxerOptions): IOContext;
   /**
    * Create I/O context from callbacks.
    *
@@ -94,8 +94,8 @@ export class IOStream {
    * });
    * ```
    */
-  static create(callbacks: IOInputCallbacks, options?: MediaInputOptions): IOContext;
-  static create(input: Buffer | IOInputCallbacks, options: MediaInputOptions = {}): IOContext | Promise<IOContext> {
+  static create(callbacks: IOInputCallbacks, options?: DemuxerOptions): IOContext;
+  static create(input: Buffer | IOInputCallbacks, options: DemuxerOptions = {}): IOContext | Promise<IOContext> {
     const { bufferSize = IO_BUFFER_SIZE } = options;
 
     // Handle Buffer

src/api/muxer.ts

@@ -31,7 +31,7 @@ import { Encoder } from './encoder.js';
 import { AsyncQueue } from './utilities/async-queue.js';
 
 import type { IRational, OutputFormat, Stream } from '../lib/index.js';
-import type { IOOutputCallbacks, MediaOutputOptions } from './types.js';
+import type { IOOutputCallbacks, MuxerOptions } from './types.js';
 
 export interface AddStreamOptionsWithEncoder {
   encoder?: Encoder;
@@ -114,7 +114,7 @@ interface WriteJob {
  */
 export class Muxer implements AsyncDisposable, Disposable {
   private formatContext: FormatContext;
-  private options: MediaOutputOptions;
+  private options: MuxerOptions;
   private _streams = new Map<number, StreamDescription>();
   private ioContext?: IOContext;
   private headerWritten = false;
@@ -132,7 +132,7 @@ export class Muxer implements AsyncDisposable, Disposable {
    *
    * @internal
    */
-  private constructor(options?: MediaOutputOptions) {
+  private constructor(options?: MuxerOptions) {
     this.options = {
       copyInitialNonkeyframes: false,
       exitOnError: true,
@@ -197,12 +197,12 @@ export class Muxer implements AsyncDisposable, Disposable {
    * });
    * ```
    *
-   * @see {@link MediaOutputOptions} For configuration options
+   * @see {@link MuxerOptions} For configuration options
    * @see {@link IOOutputCallbacks} For custom I/O interface
    */
-  static async open(target: string, options?: MediaOutputOptions): Promise<Muxer>;
-  static async open(target: IOOutputCallbacks, options: MediaOutputOptions & { format: string }): Promise<Muxer>;
-  static async open(target: string | IOOutputCallbacks, options?: MediaOutputOptions): Promise<Muxer> {
+  static async open(target: string, options?: MuxerOptions): Promise<Muxer>;
+  static async open(target: IOOutputCallbacks, options: MuxerOptions & { format: string }): Promise<Muxer>;
+  static async open(target: string | IOOutputCallbacks, options?: MuxerOptions): Promise<Muxer> {
     const output = new Muxer(options);
 
     try {
@@ -328,9 +328,9 @@ export class Muxer implements AsyncDisposable, Disposable {
    *
    * @see {@link open} For async version
    */
-  static openSync(target: string, options?: MediaOutputOptions): Muxer;
-  static openSync(target: IOOutputCallbacks, options: MediaOutputOptions & { format: string }): Muxer;
-  static openSync(target: string | IOOutputCallbacks, options?: MediaOutputOptions): Muxer {
+  static openSync(target: string, options?: MuxerOptions): Muxer;
+  static openSync(target: IOOutputCallbacks, options: MuxerOptions & { format: string }): Muxer;
+  static openSync(target: string | IOOutputCallbacks, options?: MuxerOptions): Muxer {
     const output = new Muxer(options);
 
     try {

src/api/rtp-stream.ts

@@ -15,7 +15,7 @@ import { pipeline } from './pipeline.js';
 
 import type { AVCodecID, AVHWDeviceType, AVSampleFormat, FFAudioEncoder, FFHWDeviceType, FFVideoEncoder } from '../constants/index.js';
 import type { PipelineControl } from './pipeline.js';
-import type { EncoderOptions, MediaInputOptions } from './types.js';
+import type { DemuxerOptions, EncoderOptions } from './types.js';
 
 /**
  * Options for configuring RTP streaming.
@@ -71,7 +71,7 @@ export interface RTPStreamOptions {
   /**
    * Input media options passed to Demuxer.
    */
-  inputOptions?: MediaInputOptions;
+  inputOptions?: DemuxerOptions;
 
   /**
    * Video stream configuration.
@@ -133,7 +133,7 @@ export interface RTPStreamOptions {
 export class RTPStream {
   private options: Required<RTPStreamOptions>;
   private inputUrl: string;
-  private inputOptions: MediaInputOptions;
+  private inputOptions: DemuxerOptions;
   private input?: Demuxer;
   private videoOutput?: Muxer;
   private audioOutput?: Muxer;

src/api/types.ts

@@ -120,7 +120,7 @@ export type RawData = VideoRawData | AudioRawData;
  * Configures how media files are opened and packets are read.
  * Supports format detection, buffering, and FFmpeg options.
  */
-export interface MediaInputOptions {
+export interface DemuxerOptions {
   /**
    * Buffer size for reading/writing operations.
    *
@@ -211,7 +211,7 @@ export interface MediaInputOptions {
  *
  * Configures output container format and buffering.
  */
-export interface MediaOutputOptions {
+export interface MuxerOptions {
   /**
    * Input media for automatic metadata and property copying.
    *
@@ -223,7 +223,7 @@ export interface MediaOutputOptions {
    *
    * This matches FFmpeg CLI behavior which copies metadata by default.
    */
-  input?: Demuxer | RTPMediaInput;
+  input?: Demuxer | RTPDemuxer;
 
   /**
    * Preferred output format.
@@ -727,7 +727,10 @@ export interface IOOutputCallbacks {
   read?: (size: number) => Buffer | null | number;
 }
 
-export interface RTPMediaInput {
+/**
+ * RTP Demuxer interface.
+ */
+export interface RTPDemuxer {
   /**
    * Demuxer configured for RTP/SRTP reception.
    *