#include "avfilter.h"
#include "internal.h"

Macros
#define	FFERROR_NOT_READY FFERRTAG('N','R','D','Y')
	Filters implementation helper functions. More...

#define	FF_FILTER_FORWARD_STATUS_BACK(outlink, inlink)
	Forward the status on an output link to an input link. More...

#define	FF_FILTER_FORWARD_STATUS_BACK_ALL(outlink, filter)
	Forward the status on an output link to all input links. More...

#define	FF_FILTER_FORWARD_STATUS(inlink, outlink)
	Acknowledge the status on an input link and forward it to an output link. More...

#define	FF_FILTER_FORWARD_STATUS_ALL(inlink, filter)
	Acknowledge the status on an input link and forward it to an output link. More...

#define	FF_FILTER_FORWARD_WANTED(outlink, inlink)
	Forward the frame_wanted_out flag from an output link to an input link. More...

Functions
void	ff_filter_set_ready (AVFilterContext *filter, unsigned priority)
	Mark a filter ready and schedule it for activation. More...

int	ff_inlink_process_commands (AVFilterLink link, const AVFrame frame)
	Process the commands queued in the link up to the time of the frame. More...

int	ff_inlink_evaluate_timeline_at_frame (AVFilterLink link, const AVFrame frame)
	Evaluate the timeline expression of the link for the time and properties of the frame. More...

size_t	ff_inlink_queued_frames (AVFilterLink *link)
	Get the number of frames available on the link. More...

int	ff_inlink_check_available_frame (AVFilterLink *link)
	Test if a frame is available on the link. More...

int	ff_inlink_queued_samples (AVFilterLink *link)

int	ff_inlink_check_available_samples (AVFilterLink *link, unsigned min)
	Test if enough samples are available on the link. More...

int	ff_inlink_consume_frame (AVFilterLink link, AVFrame *rframe)
	Take a frame from the link's FIFO and update the link's stats. More...

int	ff_inlink_consume_samples (AVFilterLink link, unsigned min, unsigned max, AVFrame *rframe)
	Take samples from the link's FIFO and update the link's stats. More...

AVFrame *	ff_inlink_peek_frame (AVFilterLink *link, size_t idx)
	Access a frame in the link fifo without consuming it. More...

int	ff_inlink_make_frame_writable (AVFilterLink link, AVFrame *rframe)
	Make sure a frame is writable. More...

int	ff_inlink_acknowledge_status (AVFilterLink link, int rstatus, int64_t *rpts)
	Test and acknowledge the change of status on the link. More...

void	ff_inlink_request_frame (AVFilterLink *link)
	Mark that a frame is wanted on the link. More...

void	ff_inlink_set_status (AVFilterLink *link, int status)
	Set the status on an input link. More...

static int	ff_outlink_frame_wanted (AVFilterLink *link)
	Test if a frame is wanted on an output link. More...

int	ff_outlink_get_status (AVFilterLink *link)
	Get the status on an output link. More...

static void	ff_outlink_set_status (AVFilterLink *link, int status, int64_t pts)
	Set the status field of a link from the source filter. More...

int	ff_inoutlink_check_flow (AVFilterLink inlink, AVFilterLink outlink)
	Check for flow control between input and output. More...

Macro Definition Documentation

◆ FFERROR_NOT_READY

#define FFERROR_NOT_READY FFERRTAG('N','R','D','Y')

Filters implementation helper functions.

Special return code when activate() did not do anything.

Definition at line 34 of file filters.h.

◆ FF_FILTER_FORWARD_STATUS_BACK

#define FF_FILTER_FORWARD_STATUS_BACK	(	outlink,
		inlink
	)

Value:

    do { \
    int ret = ff_outlink_get_status(outlink); \
    if (ret) { \
        ff_inlink_set_status(inlink, ret); \
        return 0; \
    } \
} while (0)

Forward the status on an output link to an input link.

If the status is set, it will discard all queued frames and this macro will return immediately.

Definition at line 199 of file filters.h.

◆ FF_FILTER_FORWARD_STATUS_BACK_ALL

#define FF_FILTER_FORWARD_STATUS_BACK_ALL	(	outlink,
		filter
	)

Value:

    do { \
    int ret = ff_outlink_get_status(outlink); \
    if (ret) { \
        unsigned i; \
        for (i = 0; i < filter->nb_inputs; i++) \
            ff_inlink_set_status(filter->inputs[i], ret); \
        return 0; \
    } \
} while (0)

Forward the status on an output link to all input links.

If the status is set, it will discard all queued frames and this macro will return immediately.

Definition at line 212 of file filters.h.

◆ FF_FILTER_FORWARD_STATUS

#define FF_FILTER_FORWARD_STATUS	(	inlink,
		outlink
	)

Value:

    do { \
    int status; \
    int64_t pts; \
    if (ff_inlink_acknowledge_status(inlink, &status, &pts)) { \
        ff_outlink_set_status(outlink, status, pts); \
        return 0; \
    } \
} while (0)

Acknowledge the status on an input link and forward it to an output link.

If the status is set, this macro will return immediately.

Definition at line 226 of file filters.h.

◆ FF_FILTER_FORWARD_STATUS_ALL

#define FF_FILTER_FORWARD_STATUS_ALL	(	inlink,
		filter
	)

Value:

    do { \
    int status; \
    int64_t pts; \
    if (ff_inlink_acknowledge_status(inlink, &status, &pts)) { \
        unsigned i; \
        for (i = 0; i < filter->nb_outputs; i++) \
            ff_outlink_set_status(filter->outputs[i], status, pts); \
        return 0; \
    } \
} while (0)

Acknowledge the status on an input link and forward it to an output link.

If the status is set, this macro will return immediately.

Definition at line 239 of file filters.h.

◆ FF_FILTER_FORWARD_WANTED

#define FF_FILTER_FORWARD_WANTED	(	outlink,
		inlink
	)

Value:

    do { \
    if (ff_outlink_frame_wanted(outlink)) { \
        ff_inlink_request_frame(inlink); \
        return 0; \
    } \
} while (0)

Forward the frame_wanted_out flag from an output link to an input link.

If the flag is set, this macro will return immediately.

Definition at line 254 of file filters.h.

Function Documentation

◆ ff_filter_set_ready()

void ff_filter_set_ready	(	AVFilterContext *	filter,
		unsigned	priority
	)

Mark a filter ready and schedule it for activation.

This is automatically done when something happens to the filter (queued frame, status change, request on output). Filters implementing the activate callback can call it directly to perform one more round of processing later. It is also useful for filters reacting to external or asynchronous events.

Definition at line 204 of file avfilter.c.

Referenced by activate(), ff_avfilter_link_set_in_status(), ff_avfilter_link_set_out_status(), ff_filter_frame(), ff_filter_frame_to_filter(), ff_inlink_request_frame(), ff_request_frame(), filter_frame(), forward_status_change(), process_frame(), spatial_activate(), xfade_activate(), and xfade_opencl_activate().

◆ ff_inlink_process_commands()

int ff_inlink_process_commands	(	AVFilterLink *	link,
		const AVFrame *	frame
	)

Process the commands queued in the link up to the time of the frame.

Commands will trigger the process_command() callback.

Returns: >= 0 or AVERROR code.

Definition at line 1448 of file avfilter.c.

Referenced by consume_update(), and ff_filter_frame_framed().

◆ ff_inlink_evaluate_timeline_at_frame()

int ff_inlink_evaluate_timeline_at_frame	(	AVFilterLink *	link,
		const AVFrame *	frame
	)

Evaluate the timeline expression of the link for the time and properties of the frame.

Returns: >0 if enabled, 0 if disabled

Note: It does not update link->dst->is_disabled.

Definition at line 1463 of file avfilter.c.

Referenced by consume_update(), and ff_filter_frame_framed().

◆ ff_inlink_queued_frames()

size_t ff_inlink_queued_frames ( AVFilterLink * link )

Get the number of frames available on the link.

Returns: the number of frames available in the link fifo.

Definition at line 1333 of file avfilter.c.

Referenced by activate(), create_frame(), filter_frame(), filter_have_queued(), xfade_activate(), and xfade_opencl_activate().

◆ ff_inlink_check_available_frame()

int ff_inlink_check_available_frame ( AVFilterLink * link )

Test if a frame is available on the link.

Returns: >0 if a frame is available

Definition at line 1338 of file avfilter.c.

Referenced by activate(), ff_inlink_consume_frame(), and ff_inoutlink_check_flow().

◆ ff_inlink_queued_samples()

int ff_inlink_queued_samples ( AVFilterLink * link )

Definition at line 1343 of file avfilter.c.

Referenced by activate(), check_ir(), convert_coeffs(), filter_frame(), plot_spectrum_column(), and try_push_frame().

◆ ff_inlink_check_available_samples()

int ff_inlink_check_available_samples	(	AVFilterLink *	link,
		unsigned	min
	)

Test if enough samples are available on the link.

Returns: >0 if enough samples are available

Note: on EOF and error, min becomes 1

Definition at line 1348 of file avfilter.c.

Referenced by activate(), and ff_inlink_consume_samples().

◆ ff_inlink_consume_frame()

int ff_inlink_consume_frame	(	AVFilterLink *	link,
		AVFrame **	rframe
	)

Take a frame from the link's FIFO and update the link's stats.

If ff_inlink_check_available_frame() was previously called, the preferred way of expressing it is "av_assert1(ret);" immediately after ff_inlink_consume_frame(). Negative error codes must still be checked.

Note: May trigger process_command() and/or update is_disabled.

Returns: >0 if a frame is available, 0 and set rframe to NULL if no frame available, or AVERROR code

Definition at line 1364 of file avfilter.c.

Referenced by activate(), consume_from_fifos(), dnn_classify_activate(), dnn_detect_activate(), ff_filter_frame_to_filter(), filter_frame(), get_frame_internal(), read_frame(), spatial_activate(), xfade_activate(), and xfade_opencl_activate().

◆ ff_inlink_consume_samples()

int ff_inlink_consume_samples	(	AVFilterLink *	link,
		unsigned	min,
		unsigned	max,
		AVFrame **	rframe
	)

Take samples from the link's FIFO and update the link's stats.

If ff_inlink_check_available_samples() was previously called, the preferred way of expressing it is "av_assert1(ret);" immediately after ff_inlink_consume_samples(). Negative error codes must still be checked.

Note: May trigger process_command() and/or update is_disabled.

Returns: >0 if a frame is available, 0 and set rframe to NULL if no frame available, or AVERROR code

Definition at line 1383 of file avfilter.c.

Referenced by activate(), convert_coeffs(), ff_filter_frame_to_filter(), ff_inlink_consume_frame(), get_frame_internal(), and try_push_frame().

◆ ff_inlink_peek_frame()

AVFrame* ff_inlink_peek_frame	(	AVFilterLink *	link,
		size_t	idx
	)

Access a frame in the link fifo without consuming it.

The first frame is numbered 0; the designated frame must exist.

Returns: the frame at idx position in the link fifo.

Definition at line 1403 of file avfilter.c.

Referenced by activate(), xfade_activate(), and xfade_opencl_activate().

◆ ff_inlink_make_frame_writable()

int ff_inlink_make_frame_writable	(	AVFilterLink *	link,
		AVFrame **	rframe
	)

Make sure a frame is writable.

This is similar to av_frame_make_writable() except it uses the link's buffer allocation callback, and therefore allows direct rendering.

Definition at line 1408 of file avfilter.c.

Referenced by activate(), apply_palette(), ff_filter_frame_framed(), ff_framesync_dualinput_get_writable(), ff_framesync_get_frame(), filter_frame(), filter_frame16(), filter_frame8(), overlay_cuda_blend(), and plot_spectrum_column().

◆ ff_inlink_acknowledge_status()

int ff_inlink_acknowledge_status	(	AVFilterLink *	link,
		int *	rstatus,
		int64_t *	rpts
	)

Test and acknowledge the change of status on the link.

Status means EOF or an error condition; a change from the normal (0) status to a non-zero status can be queued in a filter's input link, it becomes relevant after the frames queued in the link's FIFO are processed. This function tests if frames are still queued and if a queued status change has not yet been processed. In that case it performs basic treatment (updating the link's timestamp) and returns a positive value to let the filter do its own treatments (flushing...).

Filters implementing the activate callback should call this function when they think it might succeed (usually after checking unsuccessfully for a queued frame). Filters implementing the filter_frame and request_frame callbacks do not need to call that since the same treatment happens in ff_filter_frame().

Parameters

[out]	rstatus	new or current status
[out]	rpts	current timestamp of the link in link time base

Returns: >0 if status changed, <0 if status already acked, 0 otherwise

Definition at line 1318 of file avfilter.c.

Referenced by activate(), consume_from_fifos(), dnn_classify_activate(), dnn_detect_activate(), get_frame_internal(), xfade_activate(), and xfade_opencl_activate().

◆ ff_inlink_request_frame()

void ff_inlink_request_frame ( AVFilterLink * link )

Mark that a frame is wanted on the link.

Unlike ff_filter_frame(), it must not be called when the link has a non-zero status, and thus does not acknowledge it. Also it cannot fail.

Definition at line 1481 of file avfilter.c.

Referenced by activate(), consume_from_fifos(), get_frame_internal(), if(), request_samples(), spatial_activate(), xfade_activate(), and xfade_opencl_activate().

◆ ff_inlink_set_status()

void ff_inlink_set_status	(	AVFilterLink *	link,
		int	status
	)

Set the status on an input link.

Also discard all frames in the link's FIFO.

Definition at line 1489 of file avfilter.c.

Referenced by activate(), and if().

◆ ff_outlink_frame_wanted()

static int ff_outlink_frame_wanted ( AVFilterLink * link )

inlinestatic

Test if a frame is wanted on an output link.

Definition at line 172 of file filters.h.

◆ ff_outlink_get_status()

int ff_outlink_get_status ( AVFilterLink * link )

Get the status on an output link.

Definition at line 1504 of file avfilter.c.

Referenced by activate(), draw_items(), filter_frame(), plot_spectrum_column(), try_push_frame(), xfade_activate(), and xfade_opencl_activate().

◆ ff_outlink_set_status()

static void ff_outlink_set_status	(	AVFilterLink *	link,
		int	status,
		int64_t	pts
	)

inlinestatic

Set the status field of a link from the source filter.

The pts should reflect the timestamp of the status change, in link time base and relative to the frames timeline. In particular, for AVERROR_EOF, it should reflect the end time of the last frame.

Definition at line 189 of file filters.h.

Referenced by activate(), dnn_classify_activate(), dnn_detect_activate(), framesync_eof(), output_frame(), try_push_frame(), xfade_activate(), and xfade_opencl_activate().

◆ ff_inoutlink_check_flow()

int ff_inoutlink_check_flow	(	AVFilterLink *	inlink,
		AVFilterLink *	outlink
	)

Check for flow control between input and output.

This is necessary for filters that may produce several output frames for a single input event, otherwise they may produce them all at once, causing excessive memory consumption.

Definition at line 1509 of file avfilter.c.

Referenced by activate().

Macros

Functions

Macro Definition Documentation

◆ FFERROR_NOT_READY

◆ FF_FILTER_FORWARD_STATUS_BACK

◆ FF_FILTER_FORWARD_STATUS_BACK_ALL

◆ FF_FILTER_FORWARD_STATUS

◆ FF_FILTER_FORWARD_STATUS_ALL

◆ FF_FILTER_FORWARD_WANTED

Function Documentation

◆ ff_filter_set_ready()

◆ ff_inlink_process_commands()

◆ ff_inlink_evaluate_timeline_at_frame()

◆ ff_inlink_queued_frames()

◆ ff_inlink_check_available_frame()

◆ ff_inlink_queued_samples()

◆ ff_inlink_check_available_samples()

◆ ff_inlink_consume_frame()

◆ ff_inlink_consume_samples()

◆ ff_inlink_peek_frame()

◆ ff_inlink_make_frame_writable()

◆ ff_inlink_acknowledge_status()

◆ ff_inlink_request_frame()

◆ ff_inlink_set_status()

◆ ff_outlink_frame_wanted()

◆ ff_outlink_get_status()

◆ ff_outlink_set_status()

◆ ff_inoutlink_check_flow()