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

AVFilterPad *	srcpad
	output pad on the source filter

AVFilterContext *	dst
	dest filter

AVFilterPad *	dstpad
	input pad on the dest filter

enum AVMediaType	type
	filter media type

int	w
	agreed upon image width

int	h
	agreed upon image height

AVRational	sample_aspect_ratio
	agreed upon sample aspect ratio

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

int	sample_rate
	samples per second

int	format
	agreed upon media format

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

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

AVFilterFormats *	out_formats

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

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.

enum AVFilterLink:: { ... }	init_state

struct AVFilterPool *	pool

struct AVFilterGraph *	graph
	Graph the filter belongs to.

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

int	age_index
	Index in the age array.

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

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

int	partial_buf_size
	Size of the partial buffer to allocate.

int	min_samples
	Minimum number of samples to filter at once.

int	max_samples
	Maximum number of samples to filter at once.

AVFilterBufferRef *	cur_buf_copy
	The buffer reference currently being received across the link by the destination filter.

int	closed
	True if the link is closed.

int	channels
	Number of channels.

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.

Examples:: doc/examples/filtering_audio.c.

Definition at line 516 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 580 of file avfilter.h.

Field Documentation

AVFilterPad* AVFilterLink::srcpad

output pad on the source filter

Definition at line 518 of file avfilter.h.

Referenced by avfilter_config_links(), avfilter_free(), avfilter_graph_dump_to_buf(), avfilter_link(), ff_filter_frame_framed(), ff_poll_frame(), ff_request_frame(), and print_digraph().

AVFilterContext* AVFilterLink::dst

dest filter

Definition at line 520 of file avfilter.h.

Referenced by add_to_queue(), avfilter_config_links(), avfilter_free(), avfilter_graph_dump_to_buf(), avfilter_graph_request_oldest(), avfilter_insert_filter(), avfilter_link(), channelmap_config_input(), channelmap_filter_frame(), config_inprops(), config_input(), config_input_main(), config_input_overlay(), config_input_props(), config_input_top(), config_output(), config_props(), config_props_input(), default_filter_frame(), ff_filter_frame(), ff_filter_frame_framed(), ff_filter_frame_needs_framing(), ff_null_get_audio_buffer(), ff_null_get_video_buffer(), ff_tlog_link(), filter_frame(), filter_frame_main(), filter_frame_over(), geq_config_props(), geq_filter_frame(), get_audio_buffer(), get_video_buffer(), graph_check_validity(), pick_format(), plot_spectrum_column(), pp_config_props(), pp_filter_frame(), print_digraph(), process_frame(), query_formats(), scale_slice(), and select_frame().

AVFilterPad* AVFilterLink::dstpad

input pad on the dest filter

Definition at line 521 of file avfilter.h.

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

enum AVMediaType AVFilterLink::type

int AVFilterLink::w

int AVFilterLink::h

AVRational AVFilterLink::sample_aspect_ratio

agreed upon sample aspect ratio

Definition at line 528 of file avfilter.h.

Referenced by avfilter_config_links(), config_input(), config_output(), config_props(), config_props_output(), config_video_output(), lavfi_read_header(), print_link_prop(), source_config_props(), and transcode_init().

uint64_t AVFilterLink::channel_layout

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

Examples:: doc/examples/filtering_audio.c.

Definition at line 530 of file avfilter.h.

Referenced by av_buffersink_read_samples(), buffer_offset(), channelmap_config_input(), channelmap_filter_frame(), config_audio_output(), config_output(), config_props(), config_props_output(), ff_buffersink_read_samples_compat(), ff_default_get_audio_buffer(), ff_filter_frame(), ff_tlog_link(), filter_frame(), guess_map_any(), guess_map_matching(), init_filters(), join_config_output(), join_request_frame(), lavfi_read_header(), pick_format(), print_digraph(), print_link_prop(), push_samples(), return_audio_frame(), send_silence(), and transcode_init().

int AVFilterLink::sample_rate

samples per second

Examples:: doc/examples/filtering_audio.c.

Definition at line 531 of file avfilter.h.

Referenced by avfilter_config_links(), buffer_offset(), config_input(), config_output(), config_output_props(), config_props(), ff_buffersink_read_samples_compat(), ff_default_get_audio_buffer(), ff_filter_frame(), ff_filter_frame_needs_framing(), ff_tlog_link(), filter_frame(), init_filters(), lavfi_read_header(), pick_format(), plot_spectrum_column(), print_digraph(), print_link_prop(), push_frame(), push_samples(), read_from_fifo(), request_frame(), send_out(), send_silence(), and transcode_init().

int AVFilterLink::format

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:: doc/examples/filtering_video.c.

Definition at line 542 of file avfilter.h.

Referenced by avfilter_config_links(), blend_frame(), buffer_offset(), check_black_end(), config_input(), config_output(), config_output_props(), config_props(), describe_bufref_to_str(), draw_text(), ff_buffersink_read_samples_compat(), ff_filter_frame_framed(), ff_filter_frame_needs_framing(), ff_update_link_current_pts(), ff_vf_next_put_image(), filter_frame(), geq_filter_frame(), lavfi_read_header(), lavfi_read_packet(), main(), movie_config_output_props(), plot_spectrum_column(), print_digraph(), push_frame(), read_from_fifo(), reap_filters(), request_frame(), select_frame(), send_out(), send_silence(), source_config_props(), transcode_init(), try_filter_frame(), and video_thread().

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

Referenced by avfilter_free(), movie_query_formats(), pick_format(), pick_formats(), query_formats(), and swap_sample_fmts_on_filter().

AVFilterFormats* AVFilterLink::out_formats

Definition at line 559 of file avfilter.h.

Referenced by avfilter_free(), avfilter_insert_filter(), pick_format(), 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 565 of file avfilter.h.

Referenced by avfilter_free(), movie_query_formats(), pick_format(), query_formats(), and swap_samplerates_on_filter().

AVFilterFormats* AVFilterLink::out_samplerates

Definition at line 566 of file avfilter.h.

Referenced by avfilter_free(), avfilter_insert_filter(), pick_format(), query_formats(), and swap_samplerates_on_filter().

struct AVFilterChannelLayouts* AVFilterLink::in_channel_layouts

Definition at line 567 of file avfilter.h.

Referenced by avfilter_free(), channelmap_query_formats(), filter_query_formats(), 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 568 of file avfilter.h.

Referenced by avfilter_free(), avfilter_insert_filter(), channelmap_query_formats(), filter_query_formats(), 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 577 of file avfilter.h.

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

enum { ... } AVFilterLink::init_state

Referenced by avfilter_config_links().

struct AVFilterPool* AVFilterLink::pool

Definition at line 586 of file avfilter.h.

Referenced by ff_default_get_video_buffer().

struct AVFilterGraph* AVFilterLink::graph

Graph the filter belongs to.

Definition at line 591 of file avfilter.h.

Referenced by ff_avfilter_graph_config_pointers(), ff_update_link_current_pts(), and filter_frame().

int64_t AVFilterLink::current_pts

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

Definition at line 597 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 602 of file avfilter.h.

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

AVRational AVFilterLink::frame_rate

Frame rate of the stream on the link, or 1/0 if unknown; if left to 0/0, will be automatically be 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. 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 614 of file avfilter.h.

Referenced by av_buffersink_get_frame_rate(), avfilter_config_links(), config_input(), config_output(), config_output_props(), config_props(), and movie_config_output_props().

AVFilterBufferRef* AVFilterLink::partial_buf

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

Definition at line 619 of file avfilter.h.

Referenced by ff_filter_frame(), ff_filter_frame_needs_framing(), and ff_request_frame().

int AVFilterLink::partial_buf_size

Size of the partial buffer to allocate.

Must be between min_samples and max_samples.

Definition at line 625 of file avfilter.h.

Referenced by av_buffersink_set_frame_size(), and ff_filter_frame_needs_framing().

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

Referenced by av_buffersink_set_frame_size(), ff_filter_frame(), and ff_filter_frame_needs_framing().

int AVFilterLink::max_samples

Maximum number of samples to filter at once.

If filter_frame() is called with more samples, it will split them.

Definition at line 640 of file avfilter.h.

Referenced by av_buffersink_set_frame_size(), and ff_filter_frame().

AVFilterBufferRef* AVFilterLink::cur_buf_copy

The buffer reference currently being received across the link by the destination filter.

This is used internally by the filter system to allow automatic copying of buffers which do not have sufficient permissions for the destination. This should not be accessed directly by the filters.

Definition at line 649 of file avfilter.h.

int AVFilterLink::closed

True if the link is closed.

If set, all attemps of start_frame, filter_frame or request_frame will fail with AVERROR_EOF, and if necessary the reference will be destroyed. If request_frame returns AVERROR_EOF, this flag is set on the corresponding link. It can be set also be set by either the source or the destination filter.

Definition at line 661 of file avfilter.h.

Referenced by avfilter_link_set_closed(), ff_filter_frame_framed(), ff_request_frame(), and filter_frame().

int AVFilterLink::channels

Number of channels.

Definition at line 666 of file avfilter.h.

Referenced by avfilter_link_get_channels(), config_output(), ff_default_get_audio_buffer(), ff_filter_frame(), filter_frame(), and pick_format().

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

libavfilter/avfilter.h

Public Types

Data Fields

Detailed Description

Member Enumeration Documentation

Field Documentation