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 AVFilterPad *	inputs
	NULL terminated list of inputs. NULL if none.
const AVFilterPad *	outputs
	NULL terminated list of outputs. NULL if none.
const AVClass *	priv_class
	A class for the private data, used to access filter private AVOptions.
int	flags
	A combination of AVFILTER_FLAG_*.
int(*	init )(AVFilterContext *ctx)
	Filter initialization function.
int(*	init_dict )(AVFilterContext *ctx, AVDictionary **options)
	Should be set instead of init by the filters that want to pass a dictionary of AVOptions to nested contexts that are allocated in init.
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.
int	priv_size
	size of private data to allocate for the filter
struct AVFilter *	next
int(*	process_command )(AVFilterContext *, const char *cmd, const char *arg, char *res, int res_len, int flags)
	Make the filter instance process a command.
int(*	init_opaque )(AVFilterContext *ctx, void *opaque)
	Filter initialization function, alternative to the init() callback.

Detailed Description

Filter definition.

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

Examples:

doc/examples/filtering_audio.c, and doc/examples/filtering_video.c.

Definition at line 458 of file avfilter.h.

Field Documentation

const char* AVFilter::name

filter name

Definition at line 459 of file avfilter.h.

Referenced by av_buffersink_get_frame_rate(), av_buffersink_poll_frame(), avfilter_get_by_name(), avfilter_graph_dump_to_buf(), avfilter_graph_parse(), avfilter_graph_queue_command(), avfilter_graph_send_command(), avfilter_init_str(), avfilter_process_command(), default_filter_name(), ff_filter_frame(), ff_tlog_link(), filter_frame(), graph_check_validity(), init(), lavfi_read_header(), link_filter(), link_filter_inouts(), movie_common_init(), print_digraph(), and set_enable_expr().

const char* AVFilter::description

A description for the filter.

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

Definition at line 465 of file avfilter.h.

const AVFilterPad* AVFilter::inputs

NULL terminated list of inputs. NULL if none.

Definition at line 467 of file avfilter.h.

Referenced by avfilter_register(), ff_filter_alloc(), init(), main(), and split_init().

const AVFilterPad* AVFilter::outputs

NULL terminated list of outputs. NULL if none.

Definition at line 468 of file avfilter.h.

Referenced by ff_filter_alloc(), init(), and main().

const AVClass* AVFilter::priv_class

A class for the private data, used to access filter private AVOptions.

Definition at line 474 of file avfilter.h.

Referenced by avfilter_free(), avfilter_init_dict(), avfilter_init_str(), ff_filter_alloc(), filter_child_class_next(), and filter_child_next().

int AVFilter::flags

A combination of AVFILTER_FLAG_*.

Definition at line 479 of file avfilter.h.

Referenced by avfilter_register(), ff_filter_frame_framed(), and set_enable_expr().

int(* AVFilter::init)(AVFilterContext *ctx)

Filter initialization function.

Called when all the options have been set.

Definition at line 493 of file avfilter.h.

Referenced by avfilter_init_dict().

int(* AVFilter::init_dict)(AVFilterContext *ctx, AVDictionary **options)

Should be set instead of init by the filters that want to pass a dictionary of AVOptions to nested contexts that are allocated in init.

Definition at line 500 of file avfilter.h.

Referenced by avfilter_init_dict().

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

Referenced by avfilter_free().

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

Returns

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

Definition at line 517 of file avfilter.h.

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

int AVFilter::priv_size

size of private data to allocate for the filter

Definition at line 519 of file avfilter.h.

Referenced by ff_filter_alloc().

struct AVFilter* AVFilter::next

Definition at line 521 of file avfilter.h.

Referenced by avfilter_next(), and avfilter_register().

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

cmd	the command to process, for handling simplicity all commands must be alphanumeric only
arg	the argument for the command
res	a buffer with size res_size where the filter(s) can return a response. This must not change when the command is not supported.
flags	if 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 535 of file avfilter.h.

Referenced by avfilter_process_command().

int(* AVFilter::init_opaque)(AVFilterContext *ctx, void *opaque)

Filter initialization function, alternative to the init() callback.

Args contains the user-supplied parameters, opaque is used for providing binary data.

Definition at line 542 of file avfilter.h.

Referenced by avfilter_init_dict().

---

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

• libavfilter/avfilter.h