AVFilter Struct Reference

Filter definition. More...

#include <avfilter.h>


Data Fields

const char * name
 filter name
int priv_size
 size of private data to allocate for the filter
int(* init )(AVFilterContext *ctx, const char *args, void *opaque)
 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.
const AVFilterPadinputs
 NULL terminated list of inputs. NULL if none.
const AVFilterPadoutputs
 NULL terminated list of outputs. NULL if none.
const char * description
 A description 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 415 of file avfilter.h.


Field Documentation

const char * AVFilter::name

size of private data to allocate for the filter

Definition at line 419 of file avfilter.h.

Referenced by avfilter_open().

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

Filter initialization function.

Args contains the user-supplied parameters. FIXME: maybe an AVOption-based system would be better? opaque is data provided by the code requesting creation of the filter, and is used to pass data to the filter.

Referenced by avfilter_init_filter(), and query_formats().

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

Filter uninitialization function.

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

Referenced by avfilter_destroy().

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

Referenced by query_formats().

NULL terminated list of inputs. NULL if none.

Definition at line 446 of file avfilter.h.

Referenced by avfilter_open().

NULL terminated list of outputs. NULL if none.

Definition at line 447 of file avfilter.h.

Referenced by avfilter_open().

const char * AVFilter::description

A description for the filter.

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

Definition at line 453 of file avfilter.h.


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

Generated on Tue Apr 20 17:40:02 2010 for FFmpeg by  doxygen 1.5.6