node-av 0.0.1

package/dist/lib/input-format.d.ts

@@ -0,0 +1,216 @@
+import type { AVFormatFlag } from './constants.js';
+import type { NativeInputFormat, NativeIOContext, NativeWrapper } from './native-types.js';
+/**
+ * Input format (demuxer) descriptor.
+ *
+ * Describes a supported input container format for demuxing.
+ * Provides format information like name, extensions, and capabilities.
+ * These are read-only format descriptors managed by FFmpeg.
+ *
+ * Direct mapping to FFmpeg's AVInputFormat.
+ *
+ * @example
+ * ```typescript
+ * import { InputFormat, FormatContext, FFmpegError } from 'node-av';
+ *
+ * // Find a specific input format
+ * const mp4Format = InputFormat.findInputFormat('mp4');
+ * if (mp4Format) {
+ *   console.log(`Format: ${mp4Format.longName}`);
+ *   console.log(`Extensions: ${mp4Format.extensions}`);
+ * }
+ *
+ * // Use with FormatContext
+ * const ctx = new FormatContext();
+ * ctx.allocContext();
+ *
+ * // Force a specific input format
+ * const movFormat = InputFormat.findInputFormat('mov');
+ * const ret = await ctx.openInput('video.dat', movFormat, null);
+ * FFmpegError.throwIfError(ret, 'openInput');
+ * ```
+ *
+ * @see {@link FormatContext} For using input formats
+ * @see {@link OutputFormat} For output formats
+ */
+export declare class InputFormat implements NativeWrapper<NativeInputFormat> {
+    private native;
+    /**
+     * Constructor is internal - use static factory methods.
+     *
+     * InputFormats are obtained via static methods, not created directly.
+     * FFmpeg manages these format descriptors internally.
+     *
+     * @internal
+     *
+     * @param native - Native AVInputFormat to wrap
+     *
+     * @example
+     * ```typescript
+     * import { InputFormat } from 'node-av';
+     *
+     * // Don't use constructor directly
+     * // const format = new InputFormat(); // Wrong
+     *
+     * // Use static factory methods instead
+     * const format = InputFormat.findInputFormat('mp4'); // Correct
+     * ```
+     */
+    constructor(native: NativeInputFormat);
+    /**
+     * Find a registered input format with matching name.
+     *
+     * Searches FFmpeg's registered demuxers by short name.
+     * Useful for forcing a specific format when auto-detection fails.
+     *
+     * Direct mapping to av_find_input_format()
+     *
+     * @param shortName - Short name of the format (e.g., 'mp4', 'mov', 'avi')
+     *
+     * @returns InputFormat if found, null otherwise
+     *
+     * @example
+     * ```typescript
+     * import { InputFormat, FormatContext, FFmpegError } from 'node-av';
+     *
+     * const format = InputFormat.findInputFormat('mp4');
+     * if (format) {
+     *   console.log(`Found: ${format.longName}`);
+     * }
+     *
+     * // Force specific format when opening
+     * const movFormat = InputFormat.findInputFormat('mov');
+     * if (movFormat) {
+     *   const ctx = new FormatContext();
+     *   ctx.allocContext();
+     *   const ret = await ctx.openInput('video.dat', movFormat, null);
+     *   FFmpegError.throwIfError(ret, 'openInput');
+     * }
+     * ```
+     */
+    static findInputFormat(shortName: string): InputFormat | null;
+    /**
+     * Probe input format from buffer data.
+     *
+     * Attempts to detect the input format based on buffer contents.
+     * This is a synchronous operation that analyzes buffer data to identify the format.
+     *
+     * Direct mapping to av_probe_input_format3()
+     *
+     * @param buffer - Buffer containing media data to probe
+     * @param filename - Optional filename hint to aid detection
+     *
+     * @returns InputFormat if detected, null otherwise
+     *
+     * @example
+     * ```typescript
+     * import { InputFormat } from 'node-av';
+     * import { readFileSync } from 'fs';
+     *
+     * // Read first few KB of a media file
+     * const buffer = readFileSync('video.mp4', { length: 4096 });
+     * const format = InputFormat.probe(buffer, 'video.mp4');
+     *
+     * if (format) {
+     *   console.log(`Detected format: ${format.longName}`);
+     * }
+     * ```
+     */
+    static probe(buffer: Buffer, filename?: string): InputFormat | null;
+    /**
+     * Probe input format from IOContext buffer.
+     *
+     * Attempts to detect the input format by reading from an IOContext.
+     * This is an asynchronous operation that reads data from the IOContext to identify the format.
+     * The IOContext position may be changed during probing.
+     *
+     * Direct mapping to av_probe_input_buffer2()
+     *
+     * @param ioContext - IOContext to read data from for probing
+     * @param maxProbeSize - Maximum bytes to read for probing (0 for default)
+     *
+     * @returns Promise resolving to InputFormat if detected, null otherwise
+     *
+     * @example
+     * ```typescript
+     * import { InputFormat, IOContext } from 'node-av';
+     *
+     * // Open an IOContext
+     * const io = new IOContext();
+     * await io.open2('video.mp4', AVIO_FLAG_READ);
+     *
+     * // Probe the format
+     * const format = await InputFormat.probeBuffer(io);
+     *
+     * if (format) {
+     *   console.log(`Detected format: ${format.longName}`);
+     * }
+     *
+     * await io.closep();
+     * ```
+     */
+    static probeBuffer(ioContext: {
+        getNative(): NativeIOContext;
+    }, maxProbeSize?: number): Promise<InputFormat | null>;
+    /**
+     * A comma separated list of short names for the format.
+     *
+     * Direct mapping to AVInputFormat->name
+     *
+     * @readonly
+     */
+    get name(): string | null;
+    /**
+     * Descriptive name for the format.
+     *
+     * Direct mapping to AVInputFormat->long_name
+     *
+     * Meant to be more human-readable than the short name.
+     * @readonly
+     */
+    get longName(): string | null;
+    /**
+     * Comma-separated list of file extensions.
+     *
+     * Direct mapping to AVInputFormat->extensions
+     *
+     * If extensions are defined, then no probe is done.
+     * @readonly
+     */
+    get extensions(): string | null;
+    /**
+     * Comma-separated list of mime types.
+     *
+     * Direct mapping to AVInputFormat->mime_type
+     *
+     * @readonly
+     */
+    get mimeType(): string | null;
+    /**
+     * Format flags.
+     *
+     * Direct mapping to AVInputFormat->flags
+     *
+     * Combination of AVFMT_* flags:
+     * - AVFMT_NOFILE: No file is opened
+     * - AVFMT_NEEDNUMBER: Needs '%d' in filename
+     * - AVFMT_SHOW_IDS: Show format stream IDs
+     * - AVFMT_GLOBALHEADER: Format wants global headers
+     * - AVFMT_NOTIMESTAMPS: Format does not need/have timestamps
+     * - AVFMT_GENERIC_INDEX: Use generic index building code
+     * - AVFMT_TS_DISCONT: Format allows timestamp discontinuities
+     * - AVFMT_NOBINSEARCH: Format does not allow seeking by bytes
+     * - AVFMT_NOGENSEARCH: Format does not allow seeking by timestamp
+     * - AVFMT_NO_BYTE_SEEK: Format does not allow seeking by bytes
+     * - AVFMT_SEEK_TO_PTS: Seeking is based on PTS
+     * @readonly
+     */
+    get flags(): AVFormatFlag;
+    /**
+     * Get the native FFmpeg AVInputFormat pointer.
+     *
+     * @internal For use by other wrapper classes
+     * @returns The underlying native input format object
+     */
+    getNative(): NativeInputFormat;
+}

package/dist/lib/input-format.js

@@ -0,0 +1,246 @@
+import { bindings } from './binding.js';
+/**
+ * Input format (demuxer) descriptor.
+ *
+ * Describes a supported input container format for demuxing.
+ * Provides format information like name, extensions, and capabilities.
+ * These are read-only format descriptors managed by FFmpeg.
+ *
+ * Direct mapping to FFmpeg's AVInputFormat.
+ *
+ * @example
+ * ```typescript
+ * import { InputFormat, FormatContext, FFmpegError } from 'node-av';
+ *
+ * // Find a specific input format
+ * const mp4Format = InputFormat.findInputFormat('mp4');
+ * if (mp4Format) {
+ *   console.log(`Format: ${mp4Format.longName}`);
+ *   console.log(`Extensions: ${mp4Format.extensions}`);
+ * }
+ *
+ * // Use with FormatContext
+ * const ctx = new FormatContext();
+ * ctx.allocContext();
+ *
+ * // Force a specific input format
+ * const movFormat = InputFormat.findInputFormat('mov');
+ * const ret = await ctx.openInput('video.dat', movFormat, null);
+ * FFmpegError.throwIfError(ret, 'openInput');
+ * ```
+ *
+ * @see {@link FormatContext} For using input formats
+ * @see {@link OutputFormat} For output formats
+ */
+export class InputFormat {
+    native;
+    /**
+     * Constructor is internal - use static factory methods.
+     *
+     * InputFormats are obtained via static methods, not created directly.
+     * FFmpeg manages these format descriptors internally.
+     *
+     * @internal
+     *
+     * @param native - Native AVInputFormat to wrap
+     *
+     * @example
+     * ```typescript
+     * import { InputFormat } from 'node-av';
+     *
+     * // Don't use constructor directly
+     * // const format = new InputFormat(); // Wrong
+     *
+     * // Use static factory methods instead
+     * const format = InputFormat.findInputFormat('mp4'); // Correct
+     * ```
+     */
+    constructor(native) {
+        this.native = native;
+    }
+    /**
+     * Find a registered input format with matching name.
+     *
+     * Searches FFmpeg's registered demuxers by short name.
+     * Useful for forcing a specific format when auto-detection fails.
+     *
+     * Direct mapping to av_find_input_format()
+     *
+     * @param shortName - Short name of the format (e.g., 'mp4', 'mov', 'avi')
+     *
+     * @returns InputFormat if found, null otherwise
+     *
+     * @example
+     * ```typescript
+     * import { InputFormat, FormatContext, FFmpegError } from 'node-av';
+     *
+     * const format = InputFormat.findInputFormat('mp4');
+     * if (format) {
+     *   console.log(`Found: ${format.longName}`);
+     * }
+     *
+     * // Force specific format when opening
+     * const movFormat = InputFormat.findInputFormat('mov');
+     * if (movFormat) {
+     *   const ctx = new FormatContext();
+     *   ctx.allocContext();
+     *   const ret = await ctx.openInput('video.dat', movFormat, null);
+     *   FFmpegError.throwIfError(ret, 'openInput');
+     * }
+     * ```
+     */
+    static findInputFormat(shortName) {
+        const native = bindings.InputFormat.findInputFormat(shortName);
+        if (!native) {
+            return null;
+        }
+        return new InputFormat(native);
+    }
+    /**
+     * Probe input format from buffer data.
+     *
+     * Attempts to detect the input format based on buffer contents.
+     * This is a synchronous operation that analyzes buffer data to identify the format.
+     *
+     * Direct mapping to av_probe_input_format3()
+     *
+     * @param buffer - Buffer containing media data to probe
+     * @param filename - Optional filename hint to aid detection
+     *
+     * @returns InputFormat if detected, null otherwise
+     *
+     * @example
+     * ```typescript
+     * import { InputFormat } from 'node-av';
+     * import { readFileSync } from 'fs';
+     *
+     * // Read first few KB of a media file
+     * const buffer = readFileSync('video.mp4', { length: 4096 });
+     * const format = InputFormat.probe(buffer, 'video.mp4');
+     *
+     * if (format) {
+     *   console.log(`Detected format: ${format.longName}`);
+     * }
+     * ```
+     */
+    static probe(buffer, filename) {
+        const native = bindings.InputFormat.probe(buffer, filename);
+        if (!native) {
+            return null;
+        }
+        return new InputFormat(native);
+    }
+    /**
+     * Probe input format from IOContext buffer.
+     *
+     * Attempts to detect the input format by reading from an IOContext.
+     * This is an asynchronous operation that reads data from the IOContext to identify the format.
+     * The IOContext position may be changed during probing.
+     *
+     * Direct mapping to av_probe_input_buffer2()
+     *
+     * @param ioContext - IOContext to read data from for probing
+     * @param maxProbeSize - Maximum bytes to read for probing (0 for default)
+     *
+     * @returns Promise resolving to InputFormat if detected, null otherwise
+     *
+     * @example
+     * ```typescript
+     * import { InputFormat, IOContext } from 'node-av';
+     *
+     * // Open an IOContext
+     * const io = new IOContext();
+     * await io.open2('video.mp4', AVIO_FLAG_READ);
+     *
+     * // Probe the format
+     * const format = await InputFormat.probeBuffer(io);
+     *
+     * if (format) {
+     *   console.log(`Detected format: ${format.longName}`);
+     * }
+     *
+     * await io.closep();
+     * ```
+     */
+    static async probeBuffer(ioContext, maxProbeSize) {
+        const native = await bindings.InputFormat.probeBuffer(ioContext.getNative(), maxProbeSize);
+        if (!native) {
+            return null;
+        }
+        return new InputFormat(native);
+    }
+    /**
+     * A comma separated list of short names for the format.
+     *
+     * Direct mapping to AVInputFormat->name
+     *
+     * @readonly
+     */
+    get name() {
+        return this.native.name;
+    }
+    /**
+     * Descriptive name for the format.
+     *
+     * Direct mapping to AVInputFormat->long_name
+     *
+     * Meant to be more human-readable than the short name.
+     * @readonly
+     */
+    get longName() {
+        return this.native.longName;
+    }
+    /**
+     * Comma-separated list of file extensions.
+     *
+     * Direct mapping to AVInputFormat->extensions
+     *
+     * If extensions are defined, then no probe is done.
+     * @readonly
+     */
+    get extensions() {
+        return this.native.extensions;
+    }
+    /**
+     * Comma-separated list of mime types.
+     *
+     * Direct mapping to AVInputFormat->mime_type
+     *
+     * @readonly
+     */
+    get mimeType() {
+        return this.native.mimeType;
+    }
+    /**
+     * Format flags.
+     *
+     * Direct mapping to AVInputFormat->flags
+     *
+     * Combination of AVFMT_* flags:
+     * - AVFMT_NOFILE: No file is opened
+     * - AVFMT_NEEDNUMBER: Needs '%d' in filename
+     * - AVFMT_SHOW_IDS: Show format stream IDs
+     * - AVFMT_GLOBALHEADER: Format wants global headers
+     * - AVFMT_NOTIMESTAMPS: Format does not need/have timestamps
+     * - AVFMT_GENERIC_INDEX: Use generic index building code
+     * - AVFMT_TS_DISCONT: Format allows timestamp discontinuities
+     * - AVFMT_NOBINSEARCH: Format does not allow seeking by bytes
+     * - AVFMT_NOGENSEARCH: Format does not allow seeking by timestamp
+     * - AVFMT_NO_BYTE_SEEK: Format does not allow seeking by bytes
+     * - AVFMT_SEEK_TO_PTS: Seeking is based on PTS
+     * @readonly
+     */
+    get flags() {
+        return this.native.flags;
+    }
+    /**
+     * Get the native FFmpeg AVInputFormat pointer.
+     *
+     * @internal For use by other wrapper classes
+     * @returns The underlying native input format object
+     */
+    getNative() {
+        return this.native;
+    }
+}
+//# sourceMappingURL=input-format.js.map

package/dist/lib/input-format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"input-format.js","sourceRoot":"","sources":["../../src/lib/input-format.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAKxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,OAAO,WAAW;IACd,MAAM,CAAoB;IAElC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,YAAY,MAAyB;QACnC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,MAAM,CAAC,eAAe,CAAC,SAAiB;QACtC,MAAM,MAAM,GAAG,QAAQ,CAAC,WAAW,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;QAC/D,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,MAAM,CAAC,KAAK,CAAC,MAAc,EAAE,QAAiB;QAC5C,MAAM,MAAM,GAAG,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAC5D,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,SAA2C,EAAE,YAAqB;QACzF,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,WAAW,CAAC,WAAW,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,YAAY,CAAC,CAAC;QAC3F,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;OAMG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;IAC1B,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;IAC9B,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;IAChC,CAAC;IAED;;;;;;OAMG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;CACF"}