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/layouts supported by the filter and its pads, and sets the in_formats/in_chlayouts for links connected to its output pads, and out_formats/out_chlayouts 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.
int(* process_command )(AVFilterContext *, const char *cmd, const char *arg, char *res, int res_len, int flags)
 Make the filter instance process a command.

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 527 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 564 of file avfilter.h.

int(* AVFilter::init)(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.

Definition at line 538 of file avfilter.h.

Referenced by av_vsrc_buffer_add_video_buffer_ref(), avfilter_init_filter(), and reconfigure_filter().

NULL terminated list of inputs. NULL if none.

Definition at line 557 of file avfilter.h.

Referenced by avfilter_open(), and main().

NULL terminated list of outputs. NULL if none.

Definition at line 558 of file avfilter.h.

Referenced by avfilter_open(), and main().

size of private data to allocate for the filter

Definition at line 530 of file avfilter.h.

Referenced by avfilter_open(), and reconfigure_filter().

int(* AVFilter::process_command)(AVFilterContext *, const char *cmd, const char *arg, char *res, int res_len, int flags)

Make the filter instance process a command.

Parameters:
cmdthe command to process, for handling simplicity all commands must be alphanumeric only
argthe argument for the command
resa buffer with size res_size where the filter(s) can return a response. This must not change when the command is not supported.
flagsif AVFILTER_CMD_FLAG_FAST is set and the command would be time consuming then a filter should treat it like an unsupported command
Returns:
>=0 on success otherwise an error code. AVERROR(ENOSYS) on unsupported commands

Definition at line 578 of file avfilter.h.

Referenced by avfilter_process_command().

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

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

Definition at line 555 of file avfilter.h.

Referenced by insert_conv_filter(), main(), and query_formats().

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 545 of file avfilter.h.

Referenced by avfilter_free(), and reconfigure_filter().


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