node-av 0.0.1

package/dist/lib/filter.js

@@ -0,0 +1,260 @@
+import { bindings } from './binding.js';
+import { AVMEDIA_TYPE_AUDIO, AVMEDIA_TYPE_VIDEO } from './constants.js';
+/**
+ * Filter definition for media processing.
+ *
+ * Represents a static filter definition (immutable template).
+ * Defines the filter's capabilities, inputs, outputs, and properties.
+ * Actual filtering operations are performed through FilterContext instances.
+ *
+ * Direct mapping to FFmpeg's AVFilter.
+ *
+ * @example
+ * ```typescript
+ * import { Filter } from 'node-av';
+ *
+ * // Find a filter by name
+ * const scaleFilter = Filter.getByName('scale');
+ * if (!scaleFilter) throw new Error('Scale filter not found');
+ *
+ * // Check filter properties
+ * console.log(`Filter: ${scaleFilter.name}`);
+ * console.log(`Description: ${scaleFilter.description}`);
+ * console.log(`Inputs: ${scaleFilter.inputs.length}`);
+ * console.log(`Outputs: ${scaleFilter.outputs.length}`);
+ *
+ * // Get all video filters
+ * const allFilters = Filter.getList();
+ * const videoFilters = allFilters.filter(f => f.isVideo());
+ * console.log(`Found ${videoFilters.length} video filters`);
+ * ```
+ */
+export class Filter {
+    native;
+    /**
+     * Constructor is internal - use static factory methods.
+     *
+     * Filters are global immutable objects managed by FFmpeg.
+     * Use the static factory methods to obtain filter instances.
+     *
+     * @internal
+     *
+     * @param native - Native AVFilter to wrap
+     *
+     * @example
+     * ```typescript
+     * import { Filter } from 'node-av';
+     *
+     * // Don't use constructor directly
+     * // const filter = new Filter(); // Wrong
+     *
+     * // Use static factory methods instead
+     * const filter = Filter.getByName('scale'); // Correct
+     * const filters = Filter.getList(); // Correct
+     * ```
+     */
+    constructor(native) {
+        this.native = native;
+    }
+    /**
+     * Find a filter by name.
+     *
+     * Searches for a filter by its exact name.
+     * Returns the filter definition if found.
+     *
+     * Direct mapping to avfilter_get_by_name()
+     *
+     * @param name - Filter name (e.g., "scale", "overlay", "volume")
+     *
+     * @returns The filter if found, null otherwise
+     *
+     * @example
+     * ```typescript
+     * import { Filter } from 'node-av';
+     *
+     * // Find the scale filter
+     * const scaleFilter = Filter.getByName('scale');
+     * if (!scaleFilter) {
+     *   throw new Error('Scale filter not available');
+     * }
+     *
+     * // Find audio volume filter
+     * const volumeFilter = Filter.getByName('volume');
+     * if (!volumeFilter) {
+     *   throw new Error('Volume filter not available');
+     * }
+     * ```
+     *
+     * @see {@link getList} To get all available filters
+     */
+    static getByName(name) {
+        const native = bindings.Filter.getByName(name);
+        return native ? new Filter(native) : null;
+    }
+    /**
+     * Get list of all available filters.
+     *
+     * Returns all registered filters in the system.
+     * Internally uses avfilter_iterate() to collect all filters.
+     *
+     * Direct mapping to avfilter_iterate()
+     *
+     * @returns Array of all registered filters
+     *
+     * @example
+     * ```typescript
+     * import { Filter } from 'node-av';
+     *
+     * // Get all video filters
+     * const allFilters = Filter.getList();
+     * const videoFilters = allFilters.filter(f => f.isVideo());
+     * console.log(`Found ${videoFilters.length} video filters`);
+     *
+     * // Find all source filters
+     * const sourceFilters = allFilters.filter(f => f.isSource());
+     * sourceFilters.forEach(f => {
+     *   console.log(`Source filter: ${f.name}`);
+     * });
+     * ```
+     *
+     * @see {@link getByName} To find a specific filter
+     */
+    static getList() {
+        const natives = bindings.Filter.getList();
+        return natives.map((native) => new Filter(native));
+    }
+    /**
+     * Filter name.
+     *
+     * Direct mapping to AVFilter->name
+     *
+     * The short name of the filter (e.g., "scale", "overlay", "volume").
+     */
+    get name() {
+        return this.native.name;
+    }
+    /**
+     * Filter description.
+     *
+     * Direct mapping to AVFilter->description
+     *
+     * Human-readable description of what the filter does.
+     */
+    get description() {
+        return this.native.description;
+    }
+    /**
+     * Input pads.
+     *
+     * Direct mapping to AVFilter->inputs
+     *
+     * Array of input connection points for the filter.
+     * Empty array for source filters.
+     */
+    get inputs() {
+        return this.native.inputs;
+    }
+    /**
+     * Output pads.
+     *
+     * Direct mapping to AVFilter->outputs
+     *
+     * Array of output connection points for the filter.
+     * Empty array for sink filters.
+     */
+    get outputs() {
+        return this.native.outputs;
+    }
+    /**
+     * Filter flags.
+     *
+     * Direct mapping to AVFilter->flags
+     *
+     * Bitwise flags indicating filter capabilities (AVFILTER_FLAG_*).
+     */
+    get flags() {
+        return this.native.flags;
+    }
+    /**
+     * Check if this is a source filter.
+     *
+     * Source filters have no inputs and generate data.
+     *
+     * @returns true if the filter has no input pads, false otherwise
+     *
+     * @example
+     * ```typescript
+     * const filter = Filter.getByName('buffer');
+     * if (filter && filter.isSource()) {
+     *   console.log('This is a source filter');
+     * }
+     * ```
+     */
+    isSource() {
+        return this.inputs.length === 0;
+    }
+    /**
+     * Check if this is a sink filter.
+     *
+     * Sink filters have no outputs and consume data.
+     *
+     * @returns true if the filter has no output pads, false otherwise
+     *
+     * @example
+     * ```typescript
+     * const filter = Filter.getByName('buffersink');
+     * if (filter && filter.isSink()) {
+     *   console.log('This is a sink filter');
+     * }
+     * ```
+     */
+    isSink() {
+        return this.outputs.length === 0;
+    }
+    /**
+     * Check if this is a video filter.
+     *
+     * Checks if any input or output pad handles video data.
+     *
+     * @returns true if the filter processes video data, false otherwise
+     *
+     * @example
+     * ```typescript
+     * const filter = Filter.getByName('scale');
+     * if (filter && filter.isVideo()) {
+     *   console.log('This filter processes video');
+     * }
+     * ```
+     */
+    isVideo() {
+        return this.inputs.some((i) => i.type === AVMEDIA_TYPE_VIDEO) || this.outputs.some((o) => o.type === AVMEDIA_TYPE_VIDEO);
+    }
+    /**
+     * Check if this is an audio filter.
+     *
+     * Checks if any input or output pad handles audio data.
+     *
+     * @returns true if the filter processes audio data, false otherwise
+     *
+     * @example
+     * ```typescript
+     * const filter = Filter.getByName('volume');
+     * if (filter && filter.isAudio()) {
+     *   console.log('This filter processes audio');
+     * }
+     * ```
+     */
+    isAudio() {
+        return this.inputs.some((i) => i.type === AVMEDIA_TYPE_AUDIO) || this.outputs.some((o) => o.type === AVMEDIA_TYPE_AUDIO);
+    }
+    /**
+     * Get the native FFmpeg AVFilter pointer.
+     *
+     * @internal For use by other wrapper classes
+     * @returns The underlying native filter object
+     */
+    getNative() {
+        return this.native;
+    }
+}
+//# sourceMappingURL=filter.js.map

package/dist/lib/filter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter.js","sourceRoot":"","sources":["../../src/lib/filter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAKxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,OAAO,MAAM;IACT,MAAM,CAAe;IAE7B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,YAAY,MAAoB;QAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,MAAM,CAAC,SAAS,CAAC,IAAY;QAC3B,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC/C,OAAO,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC5C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,OAAO;QACZ,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QAC1C,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;OAMG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACH,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;IACjC,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAC5B,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,QAAQ;QACN,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,kBAAkB,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,kBAAkB,CAAC,CAAC;IAC3H,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,kBAAkB,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,kBAAkB,CAAC,CAAC;IAC3H,CAAC;IAED;;;;;OAKG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;CACF"}