FFmpeg 5.1.6
Data Fields
AVFilterContext Struct Reference

An instance of a filter. More...

#include <libavfilter/avfilter.h>

Data Fields

const AVClassav_class
 needed for av_log() and filters common options More...
 
const AVFilterfilter
 the AVFilter of which this is an instance More...
 
char * name
 name of this filter instance More...
 
AVFilterPadinput_pads
 array of input pads More...
 
AVFilterLink ** inputs
 array of pointers to input links More...
 
unsigned nb_inputs
 number of input pads More...
 
AVFilterPadoutput_pads
 array of output pads More...
 
AVFilterLink ** outputs
 array of pointers to output links More...
 
unsigned nb_outputs
 number of output pads More...
 
void * priv
 private data for use by the filter More...
 
struct AVFilterGraphgraph
 filtergraph this filter belongs to More...
 
int thread_type
 Type of multithreading being allowed/used. More...
 
AVFilterInternalinternal
 An opaque struct for libavfilter internal use. More...
 
struct AVFilterCommand * command_queue
 
char * enable_str
 enable expression string More...
 
void * enable
 parsed expression (AVExpr*) More...
 
double * var_values
 variable values for the enable expression More...
 
int is_disabled
 the enabled state from the last expression evaluation More...
 
AVBufferRefhw_device_ctx
 For filters which will create hardware frames, sets the device the filter should create them in. More...
 
int nb_threads
 Max number of threads allowed in this filter instance. More...
 
unsigned ready
 Ready status of the filter. More...
 
int extra_hw_frames
 Sets the number of extra hardware frames which the filter will allocate on its output links for use in following filters or by the caller. More...
 

Detailed Description

An instance of a filter.

Examples
filter_audio.c, filtering_audio.c, filtering_video.c, and transcoding.c.

Definition at line 408 of file avfilter.h.

Field Documentation

◆ av_class

const AVClass* AVFilterContext::av_class

needed for av_log() and filters common options

Definition at line 409 of file avfilter.h.

◆ filter

const AVFilter* AVFilterContext::filter

the AVFilter of which this is an instance

Definition at line 411 of file avfilter.h.

◆ name

char* AVFilterContext::name

name of this filter instance

Definition at line 413 of file avfilter.h.

◆ input_pads

AVFilterPad* AVFilterContext::input_pads

array of input pads

Definition at line 415 of file avfilter.h.

◆ inputs

AVFilterLink** AVFilterContext::inputs

array of pointers to input links

Examples
filtering_audio.c, and filtering_video.c.

Definition at line 416 of file avfilter.h.

Referenced by init_filters(), and main().

◆ nb_inputs

unsigned AVFilterContext::nb_inputs

number of input pads

Definition at line 417 of file avfilter.h.

◆ output_pads

AVFilterPad* AVFilterContext::output_pads

array of output pads

Definition at line 419 of file avfilter.h.

◆ outputs

AVFilterLink** AVFilterContext::outputs

array of pointers to output links

Definition at line 420 of file avfilter.h.

◆ nb_outputs

unsigned AVFilterContext::nb_outputs

number of output pads

Definition at line 421 of file avfilter.h.

◆ priv

void* AVFilterContext::priv

private data for use by the filter

Definition at line 423 of file avfilter.h.

◆ graph

struct AVFilterGraph* AVFilterContext::graph

filtergraph this filter belongs to

Definition at line 425 of file avfilter.h.

◆ thread_type

int AVFilterContext::thread_type

Type of multithreading being allowed/used.

A combination of AVFILTER_THREAD_* flags.

May be set by the caller before initializing the filter to forbid some or all kinds of multithreading for this filter. The default is allowing everything.

When the filter is initialized, this field is combined using bit AND with AVFilterGraph.thread_type to get the final mask used for determining allowed threading types. I.e. a threading type needs to be set in both to be allowed.

After the filter is initialized, libavfilter sets this field to the threading type that is actually used (0 for no multithreading).

Definition at line 443 of file avfilter.h.

◆ internal

AVFilterInternal* AVFilterContext::internal

An opaque struct for libavfilter internal use.

Definition at line 448 of file avfilter.h.

◆ command_queue

struct AVFilterCommand* AVFilterContext::command_queue

Definition at line 450 of file avfilter.h.

◆ enable_str

char* AVFilterContext::enable_str

enable expression string

Definition at line 452 of file avfilter.h.

◆ enable

void* AVFilterContext::enable

parsed expression (AVExpr*)

Definition at line 453 of file avfilter.h.

◆ var_values

double* AVFilterContext::var_values

variable values for the enable expression

Definition at line 454 of file avfilter.h.

◆ is_disabled

int AVFilterContext::is_disabled

the enabled state from the last expression evaluation

Definition at line 455 of file avfilter.h.

◆ hw_device_ctx

AVBufferRef* AVFilterContext::hw_device_ctx

For filters which will create hardware frames, sets the device the filter should create them in.

All other filters will ignore this field: in particular, a filter which consumes or processes hardware frames will instead use the hw_frames_ctx field in AVFilterLink to carry the hardware context information.

Definition at line 464 of file avfilter.h.

◆ nb_threads

int AVFilterContext::nb_threads

Max number of threads allowed in this filter instance.

If <= 0, its value is ignored. Overrides global number of threads set per filter graph.

Definition at line 471 of file avfilter.h.

◆ ready

unsigned AVFilterContext::ready

Ready status of the filter.

A non-0 value means that the filter needs activating; a higher value suggests a more urgent activation.

Definition at line 478 of file avfilter.h.

◆ extra_hw_frames

int AVFilterContext::extra_hw_frames

Sets the number of extra hardware frames which the filter will allocate on its output links for use in following filters or by the caller.

Some hardware filters require all frames that they will use for output to be defined in advance before filtering starts. For such filters, any hardware frame pools used for output must therefore be of fixed size. The extra frames set here are on top of any number that the filter needs internally in order to operate normally.

This field must be set before the graph containing this filter is configured.

Definition at line 494 of file avfilter.h.


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