AVFilter Struct Reference

Filter definition. More...

#include <avfilter.h>

Data Fields

const char * name
 filter name
const char * description
 A description for the filter.
const AVFilterPadinputs
 NULL terminated list of inputs. NULL if none.
const AVFilterPadoutputs
 NULL terminated list of outputs. NULL if none.
int(* init )(AVFilterContext *ctx, const char *args)
 Filter initialization function.
void(* uninit )(AVFilterContext *ctx)
 Filter uninitialization function.
int(* query_formats )(AVFilterContext *)
 Queries formats supported by the filter and its pads, and sets the in_formats for links connected to its output pads, and out_formats for links connected to its input pads.
int priv_size
 size of private data to allocate for the filter

Detailed Description

Filter definition.

This defines the pads a filter contains, and all the callback functions used to interact with the filter.

Definition at line 371 of file avfilter.h.

Field Documentation

const char* AVFilter::description

A description for the filter.

You should use the NULL_IF_CONFIG_SMALL() macro to define it.

Definition at line 378 of file avfilter.h.

int(* AVFilter::init)(AVFilterContext *ctx, const char *args)

Filter initialization function.

Args contains the user-supplied parameters. FIXME: maybe an AVOption-based system would be better?

Definition at line 395 of file avfilter.h.

Referenced by avfilter_init_filter().

const AVFilterPad* AVFilter::inputs

NULL terminated list of inputs. NULL if none.

Definition at line 380 of file avfilter.h.

Referenced by avfilter_open(), main(), and split_init().

const char* AVFilter::name
const AVFilterPad* AVFilter::outputs

NULL terminated list of outputs. NULL if none.

Definition at line 381 of file avfilter.h.

Referenced by avfilter_open(), and main().

int AVFilter::priv_size

size of private data to allocate for the filter

Definition at line 414 of file avfilter.h.

Referenced by avfilter_open().

int(* AVFilter::query_formats)(AVFilterContext *)

Queries formats supported by the filter and its pads, and sets the in_formats for links connected to its output pads, and out_formats for links connected to its input pads.

Returns
zero on success, a negative value corresponding to an AVERROR code otherwise

Definition at line 412 of file avfilter.h.

Referenced by main(), and query_formats().

void(* AVFilter::uninit)(AVFilterContext *ctx)

Filter uninitialization function.

Should deallocate any memory held by the filter, release any buffer references, etc. This does not need to deallocate the AVFilterContext->priv memory itself.

Definition at line 402 of file avfilter.h.

Referenced by avfilter_free().


The documentation for this struct was generated from the following file: