A link between two filters. More...

#include <avfilter.h>

Public Types
enum	{ AVLINK_UNINIT = 0, AVLINK_STARTINIT, AVLINK_INIT }
	stage of the initialization of the link properties (dimensions, etc) More...

Data Fields
AVFilterContext *	src
	source filter More...

AVFilterPad *	srcpad
	output pad on the source filter More...

AVFilterContext *	dst
	dest filter More...

AVFilterPad *	dstpad
	input pad on the dest filter More...

enum AVMediaType	type
	filter media type More...

int	w
	agreed upon image width More...

int	h
	agreed upon image height More...

AVRational	sample_aspect_ratio
	agreed upon sample aspect ratio More...

uint64_t	channel_layout
	channel layout of current buffer (see libavutil/channel_layout.h) More...

int	sample_rate
	samples per second More...

int	format
	agreed upon media format More...

AVRational	time_base
	Define the time base used by the PTS of the frames/samples which will pass through this link. More...

AVFilterFormats *	in_formats
	Lists of formats and channel layouts supported by the input and output filters respectively. More...

AVFilterFormats *	out_formats

AVFilterFormats *	in_samplerates
	Lists of channel layouts and sample rates used for automatic negotiation. More...

AVFilterFormats *	out_samplerates

struct AVFilterChannelLayouts *	in_channel_layouts

struct AVFilterChannelLayouts *	out_channel_layouts

int	request_samples
	Audio only, the destination filter sets this to a non-zero value to request that buffers with the given number of samples should be sent to it. More...

enum AVFilterLink:: { ... }	init_state
	stage of the initialization of the link properties (dimensions, etc) More...

struct AVFilterGraph *	graph
	Graph the filter belongs to. More...

int64_t	current_pts
	Current timestamp of the link, as defined by the most recent frame(s), in link time_base units. More...

int64_t	current_pts_us
	Current timestamp of the link, as defined by the most recent frame(s), in AV_TIME_BASE units. More...

int	age_index
	Index in the age array. More...

AVRational	frame_rate
	Frame rate of the stream on the link, or 1/0 if unknown or variable; if left to 0/0, will be automatically copied from the first input of the source filter if it exists. More...

AVFrame *	partial_buf
	Buffer partially filled with samples to achieve a fixed/minimum size. More...

int	partial_buf_size
	Size of the partial buffer to allocate. More...

int	min_samples
	Minimum number of samples to filter at once. More...

int	max_samples
	Maximum number of samples to filter at once. More...

int	channels
	Number of channels. More...

unsigned	flags
	Link processing flags. More...

int64_t	frame_count_in
	Number of past frames sent through the link. More...

int64_t	frame_count_out

void *	frame_pool
	A pointer to a FFFramePool struct. More...

int	frame_wanted_out
	True if a frame is currently wanted on the output of this filter. More...

AVBufferRef *	hw_frames_ctx
	For hwaccel pixel formats, this should be a reference to the AVHWFramesContext describing the frames. More...

char	reserved [0xF000]
	Internal structure members. More...

Detailed Description

A link between two filters.

This contains pointers to the source and destination filters between which this link exists, and the indexes of the pads involved. In addition, this link also contains the parameters which have been negotiated and agreed upon between the filter, such as image dimensions, format, etc.

Applications must not normally access the link structure directly. Use the buffersrc and buffersink API instead. In the future, access to the header may be reserved for filters implementation.

Examples:: filtering_audio.c.

Definition at line 408 of file avfilter.h.

Member Enumeration Documentation

anonymous enum

stage of the initialization of the link properties (dimensions, etc)

Enumerator
AVLINK_UNINIT	not started
AVLINK_STARTINIT	started, but incomplete
AVLINK_INIT	complete

Definition at line 472 of file avfilter.h.

Field Documentation

AVFilterContext* AVFilterLink::src

source filter

Definition at line 409 of file avfilter.h.

Referenced by aeval_config_output(), avfilter_config_links(), avfilter_graph_dump_to_buf(), avfilter_insert_filter(), avfilter_link(), compand_drain(), compressor_config_output(), config_audio_output(), config_input(), config_out_props(), config_output(), config_output_props(), config_props(), config_props_out(), config_props_output(), config_props_ref(), config_video(), config_video_output(), cudaupload_config_output(), deint_vaapi_config_output(), ff_avfilter_link_set_out_status(), ff_framesync_request_frame(), ff_inlink_request_frame(), ff_poll_frame(), ff_request_frame(), ff_request_frame_to_filter(), ff_tlog_link(), flush_frame(), free_link(), graph_check_validity(), horizontal_frame_pack(), hwdownload_config_output(), hwmap_config_output(), hwupload_config_output(), join_config_output(), join_request_frame(), movie_config_output_props(), movie_request_frame(), nppscale_config_props(), output_frame(), pick_format(), poll_frame(), push_frame(), push_samples(), push_single_pic(), qsvdeint_config_props(), qsvdeint_request_frame(), qsvscale_config_props(), query_formats(), request_frame(), request_frame_ref(), scale_vaapi_config_output(), source_config_props(), source_request_frame(), spatial_frame_pack(), and vertical_frame_pack().

AVFilterPad* AVFilterLink::srcpad

output pad on the source filter

Definition at line 410 of file avfilter.h.

Referenced by avfilter_config_links(), avfilter_graph_dump_to_buf(), avfilter_link(), config_output(), ff_poll_frame(), ff_request_frame_to_filter(), free_link(), and print_digraph().

AVFilterContext* AVFilterLink::dst

dest filter

Definition at line 412 of file avfilter.h.

Referenced by add_to_queue(), agate_config_input(), apply_lut(), apply_palette(), avfilter_config_links(), avfilter_graph_dump_to_buf(), avfilter_graph_request_oldest(), avfilter_insert_filter(), avfilter_link(), channelmap_config_input(), channelmap_filter_frame(), config_audio_input(), config_input(), config_input0(), config_input1(), config_input_main(), config_input_overlay(), config_input_palette(), config_input_props(), config_input_ref(), config_inputx(), config_inputy(), config_output(), config_props(), config_props_in(), config_props_input(), consume_update(), cudaupload_filter_frame(), default_filter_frame(), deint_vaapi_config_input(), deint_vaapi_filter_frame(), ff_avfilter_link_set_in_status(), ff_avfilter_link_set_out_status(), ff_filter_frame(), ff_filter_frame_framed(), ff_filter_frame_to_filter(), ff_inlink_evaluate_timeline_at_frame(), ff_inlink_make_frame_writable(), ff_inlink_process_commands(), ff_null_get_audio_buffer(), ff_null_get_video_buffer(), ff_request_frame(), ff_tlog_link(), filter_frame(), filter_frame16(), filter_frame8(), filter_frame_left(), filter_frame_magnitude(), filter_frame_phase(), filter_frame_ref(), filter_frame_right(), free_link(), geq_config_props(), geq_filter_frame(), get_aspect_ratio(), get_audio_buffer(), get_video_buffer(), graph_check_validity(), hwdownload_config_input(), hwdownload_filter_frame(), hwmap_filter_frame(), hwmap_get_buffer(), hwupload_filter_frame(), inject_frame(), interpolate(), nppscale_filter_frame(), pick_format(), plot_freqs(), plot_spectrum_column(), pp_config_props(), pp_filter_frame(), print_digraph(), process_frame(), qsvdeint_filter_frame(), qsvscale_filter_frame(), query_formats(), scale_slice(), scale_vaapi_config_input(), scale_vaapi_filter_frame(), select_frame(), shuffleplanes_config_input(), and shuffleplanes_filter_frame().

AVFilterPad* AVFilterLink::dstpad

input pad on the dest filter

Definition at line 413 of file avfilter.h.

Referenced by avfilter_config_links(), avfilter_graph_dump_to_buf(), avfilter_graph_request_oldest(), avfilter_insert_filter(), avfilter_link(), ff_filter_frame_framed(), ff_get_audio_buffer(), ff_get_video_buffer(), free_link(), graph_insert_fifos(), and print_digraph().

enum AVMediaType AVFilterLink::type

int AVFilterLink::w

agreed upon image width

Definition at line 418 of file avfilter.h.

Referenced by alloc_out_frame(), apply_lut(), apply_palette(), apply_unsharp_c(), avfilter_config_links(), blend_frame(), blend_frames16(), blend_frames8(), calc_persp_luts(), config_input(), config_input0(), config_input1(), config_input_overlay(), config_input_palette(), config_input_props(), config_input_ref(), config_inputx(), config_out_props(), config_output(), config_output_props(), config_props(), config_props_input(), config_props_output(), config_props_ref(), config_video(), config_video_output(), copy_picture_field(), create_weave_frame(), cudaupload_config_output(), cudaupload_filter_frame(), deint_vaapi_config_output(), draw_background(), draw_blank_frame(), ff_filter_frame(), ff_inlink_evaluate_timeline_at_frame(), ff_inlink_make_frame_writable(), ff_opencl_apply_unsharp(), ff_scale_eval_dimensions(), ff_tlog_link(), filter(), filter_color(), filter_color2(), filter_frame(), filter_frame16(), filter_frame8(), filter_mono(), geq_filter_frame(), get_aspect_ratio(), get_current_tile_pos(), get_frame(), get_palette_frame(), hwdownload_config_output(), hwdownload_filter_frame(), hwmap_config_output(), hwupload_config_output(), hwupload_filter_frame(), init_out_session(), movie_config_output_props(), nppscale_config_props(), nppscale_filter_frame(), output_single_frame(), plot_cqt(), plot_freqs(), pp_config_props(), pp_filter_frame(), print_digraph(), print_link_prop(), process_frame(), push_single_pic(), qsvscale_config_props(), qsvscale_filter_frame(), return_frame(), scale_vaapi_config_output(), source_config_props(), source_request_frame(), try_push_frame(), and update_context().

int AVFilterLink::h

agreed upon image height

Definition at line 419 of file avfilter.h.

Referenced by alloc_out_frame(), apply_lut(), apply_palette(), apply_unsharp_c(), avfilter_config_links(), blend_frame(), blend_frames16(), blend_frames8(), calc_persp_luts(), config_input(), config_input0(), config_input1(), config_input_overlay(), config_input_palette(), config_input_props(), config_input_ref(), config_inputx(), config_out_props(), config_output(), config_output_props(), config_props(), config_props_input(), config_props_output(), config_props_ref(), config_video(), config_video_output(), copy_picture_field(), create_weave_frame(), cudaupload_config_output(), cudaupload_filter_frame(), deint_vaapi_config_output(), draw_background(), draw_blank_frame(), ff_filter_frame(), ff_inlink_evaluate_timeline_at_frame(), ff_inlink_make_frame_writable(), ff_opencl_apply_unsharp(), ff_opencl_deshake_process_inout_buf(), ff_opencl_unsharp_process_inout_buf(), ff_scale_eval_dimensions(), ff_tlog_link(), filter(), filter_color(), filter_color2(), filter_frame(), filter_frame16(), filter_frame8(), filter_mono(), geq_filter_frame(), get_aspect_ratio(), get_current_tile_pos(), get_frame(), get_palette_frame(), hwdownload_config_output(), hwdownload_filter_frame(), hwmap_config_output(), hwupload_config_output(), hwupload_filter_frame(), init_out_session(), movie_config_output_props(), nppscale_config_props(), nppscale_filter_frame(), output_single_frame(), plot_cqt(), plot_freq(), plot_freqs(), plot_spectrum_column(), pp_config_props(), pp_filter_frame(), print_digraph(), print_link_prop(), process_frame(), push_single_pic(), qsvscale_config_props(), qsvscale_filter_frame(), request_frame(), return_frame(), scale_vaapi_config_output(), source_config_props(), source_request_frame(), try_push_frame(), and update_context().

AVRational AVFilterLink::sample_aspect_ratio

agreed upon sample aspect ratio

Definition at line 420 of file avfilter.h.

Referenced by avfilter_config_links(), config_input(), config_out_props(), config_output(), config_props(), config_props_output(), config_props_ref(), config_video(), config_video_output(), ff_scale_eval_dimensions(), filter_frame(), get_aspect_ratio(), nppscale_config_props(), print_link_prop(), qsvscale_config_props(), and source_config_props().

uint64_t AVFilterLink::channel_layout

channel layout of current buffer (see libavutil/channel_layout.h)

Examples:: filtering_audio.c.

Definition at line 422 of file avfilter.h.

Referenced by aeval_config_output(), channelmap_config_input(), channelmap_filter_frame(), config_audio_output(), config_input(), config_output(), config_props(), ff_default_get_audio_buffer(), ff_filter_frame(), ff_tlog_link(), filter_frame(), generate_kernel(), get_speaker_pos(), guess_map_any(), guess_map_matching(), init_filters(), join_config_output(), pick_format(), print_digraph(), print_link_prop(), push_samples(), and try_push_frame().

int AVFilterLink::sample_rate

samples per second

Examples:: filtering_audio.c.

Definition at line 423 of file avfilter.h.

Referenced by add_filter(), aeval_config_output(), agate_config_input(), alloc_out_frame(), avfilter_config_links(), buffer_offset(), compand_delay(), compand_drain(), compressor_config_output(), config_audio_input(), config_audio_output(), config_input(), config_output(), config_output_props(), config_props(), connect_ports(), dump_fir(), ff_default_get_audio_buffer(), ff_filter_frame(), ff_tlog_link(), filter_frame(), flush_frame(), generate_kernel(), init_cqt(), init_filters(), pick_format(), print_digraph(), print_link_prop(), process_command(), push_frame(), push_samples(), request_frame(), send_silence(), and try_push_frame().

int AVFilterLink::format

agreed upon media format

Examples:: filtering_audio.c.

Definition at line 425 of file avfilter.h.

Referenced by avfilter_link(), buffer_offset(), config_audio_output(), config_input(), config_input0(), config_input1(), config_input_main(), config_input_overlay(), config_input_ref(), config_inputx(), config_inputy(), config_out_props(), config_output(), config_props(), config_props_output(), copy_picture_field(), cudaupload_config_output(), ff_default_get_audio_buffer(), ff_default_get_video_buffer(), ff_filter_frame(), ff_opencl_deshake_process_inout_buf(), ff_scale_eval_dimensions(), ff_tlog_link(), filter_frame(), geq_config_props(), get_aspect_ratio(), hwdownload_config_output(), hwmap_config_output(), hwmap_filter_frame(), hwupload_config_output(), hwupload_filter_frame(), init_filters(), movie_push_frame(), output_single_frame(), pick_format(), pick_formats(), pp_config_props(), print_digraph(), print_link_prop(), process_frame(), push_samples(), read_fft_data(), return_audio_frame(), send_silence(), shuffleplanes_config_input(), take_samples(), and try_push_frame().

AVRational AVFilterLink::time_base

Define the time base used by the PTS of the frames/samples which will pass through this link.

During the configuration stage, each filter is supposed to change only the output timebase, while the timebase of the input link is assumed to be an unchangeable property.

Examples:: filtering_video.c.

Definition at line 434 of file avfilter.h.

Referenced by alloc_out_frame(), avfilter_config_links(), buffer_offset(), check_black_end(), compand_delay(), config_input(), config_out_props(), config_output(), config_output_props(), config_props(), config_props_output(), config_props_ref(), DEFINE_BLEND8(), describe_frame_to_str(), do_blend(), draw_text(), ff_dualinput_init(), ff_inlink_evaluate_timeline_at_frame(), ff_inlink_process_commands(), ff_update_link_current_pts(), filter_frame(), geq_filter_frame(), init_out_session(), interpolate(), main(), movie_config_output_props(), movie_push_frame(), output_single_frame(), print_digraph(), process_frame(), push_frame(), push_samples(), request_frame(), select_frame(), send_silence(), source_config_props(), submit_frame(), take_samples(), and update_context().

AVFilterFormats* AVFilterLink::in_formats

Lists of formats and channel layouts supported by the input and output filters respectively.

These lists are used for negotiating the format to actually be used, which will be loaded into the format and channel_layout members, above, when chosen.

Definition at line 450 of file avfilter.h.

Referenced by cudaupload_query_formats(), deint_vaapi_query_formats(), formats_declared(), free_link(), hwdownload_query_formats(), hwmap_query_formats(), hwupload_query_formats(), movie_query_formats(), pick_format(), pick_formats(), query_formats(), query_formats_src(), scale_vaapi_query_formats(), and swap_sample_fmts_on_filter().

AVFilterFormats* AVFilterLink::out_formats

Definition at line 451 of file avfilter.h.

Referenced by avfilter_insert_filter(), cudaupload_query_formats(), deint_vaapi_query_formats(), formats_declared(), free_link(), hwdownload_query_formats(), hwmap_query_formats(), hwupload_query_formats(), pick_format(), query_formats(), scale_vaapi_query_formats(), and swap_sample_fmts_on_filter().

AVFilterFormats* AVFilterLink::in_samplerates

Lists of channel layouts and sample rates used for automatic negotiation.

Definition at line 457 of file avfilter.h.

Referenced by formats_declared(), free_link(), movie_query_formats(), pick_format(), query_formats(), and swap_samplerates_on_filter().

AVFilterFormats* AVFilterLink::out_samplerates

Definition at line 458 of file avfilter.h.

Referenced by avfilter_insert_filter(), formats_declared(), free_link(), pick_format(), query_formats(), and swap_samplerates_on_filter().

struct AVFilterChannelLayouts* AVFilterLink::in_channel_layouts

Definition at line 459 of file avfilter.h.

Referenced by aeval_query_formats(), channelmap_query_formats(), filter_query_formats(), formats_declared(), free_link(), join_query_formats(), movie_query_formats(), pick_format(), query_formats(), reduce_formats_on_filter(), and swap_channel_layouts_on_filter().

struct AVFilterChannelLayouts* AVFilterLink::out_channel_layouts

Definition at line 460 of file avfilter.h.

Referenced by aeval_query_formats(), avfilter_insert_filter(), channelmap_query_formats(), filter_query_formats(), formats_declared(), free_link(), join_query_formats(), pick_format(), query_formats(), reduce_formats_on_filter(), and swap_channel_layouts_on_filter().

int AVFilterLink::request_samples

Audio only, the destination filter sets this to a non-zero value to request that buffers with the given number of samples should be sent to it.

AVFilterPad.needs_fifo must also be set on the corresponding input pad. Last buffer before EOF will be padded with silence.

Definition at line 469 of file avfilter.h.

Referenced by filter_frame(), request_frame(), and return_audio_frame().

enum { ... } AVFilterLink::init_state

stage of the initialization of the link properties (dimensions, etc)

Referenced by avfilter_config_links().

struct AVFilterGraph* AVFilterLink::graph

Graph the filter belongs to.

Definition at line 481 of file avfilter.h.

Referenced by ff_filter_graph_remove_filter(), ff_update_link_current_pts(), filter_frame(), and graph_config_pointers().

int64_t AVFilterLink::current_pts

Current timestamp of the link, as defined by the most recent frame(s), in link time_base units.

Definition at line 487 of file avfilter.h.

Referenced by avfilter_config_links(), ff_inlink_acknowledge_status(), and ff_update_link_current_pts().

int64_t AVFilterLink::current_pts_us

Current timestamp of the link, as defined by the most recent frame(s), in AV_TIME_BASE units.

Definition at line 493 of file avfilter.h.

Referenced by avfilter_config_links(), ff_update_link_current_pts(), heap_bubble_down(), and heap_bubble_up().

int AVFilterLink::age_index

Index in the age array.

Definition at line 498 of file avfilter.h.

Referenced by avfilter_graph_request_oldest(), ff_avfilter_graph_update_heap(), ff_update_link_current_pts(), graph_config_pointers(), heap_bubble_down(), and heap_bubble_up().

AVRational AVFilterLink::frame_rate

Frame rate of the stream on the link, or 1/0 if unknown or variable; if left to 0/0, will be automatically copied from the first input of the source filter if it exists.

Sources should set it to the best estimation of the real frame rate. If the source frame rate is unknown or variable, set this to 1/0. Filters should update it if necessary depending on their function. Sinks can use it to set a default output frame rate. It is similar to the r_frame_rate field in AVStream.

Definition at line 511 of file avfilter.h.

Referenced by avfilter_config_links(), config_input(), config_out_props(), config_output(), config_output_props(), config_props(), config_props_output(), config_video_output(), init_out_session(), movie_config_output_props(), qsvdeint_config_props(), source_config_props(), submit_frame(), and update_pts().

AVFrame* AVFilterLink::partial_buf

Buffer partially filled with samples to achieve a fixed/minimum size.

Definition at line 516 of file avfilter.h.

int AVFilterLink::partial_buf_size

Size of the partial buffer to allocate.

Must be between min_samples and max_samples.

Definition at line 522 of file avfilter.h.

Referenced by av_buffersink_set_frame_size(), config_audio_input(), config_input(), and filter_frame().

int AVFilterLink::min_samples

Minimum number of samples to filter at once.

If filter_frame() is called with fewer samples, it will accumulate them in partial_buf. This field and the related ones must not be changed after filtering has started. If 0, all related fields are ignored.

Definition at line 531 of file avfilter.h.

Referenced by av_buffersink_get_frame_flags(), av_buffersink_set_frame_size(), config_audio_input(), config_input(), ff_filter_activate_default(), ff_filter_frame_to_filter(), filter_frame(), and take_samples().