framesync.c File Reference

#include "libavutil/avassert.h"
#include "libavutil/opt.h"
#include "avfilter.h"
#include "filters.h"
#include "framesync.h"
#include "internal.h"

Go to the source code of this file.

Macros
#define	OFFSET(member)   offsetof(FFFrameSync, member)
#define	FLAGS   AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_FILTERING_PARAM

Enumerations
enum	{ STATE_BOF, STATE_RUN, STATE_EOF }

Functions
static const char *	framesync_name (void *ptr)
const AVClass *	ff_framesync_child_class_iterate (void **iter)
static int	consume_from_fifos (FFFrameSync *fs)
void	ff_framesync_preinit (FFFrameSync *fs)
	Pre-initialize a frame sync structure. More...
int	ff_framesync_init (FFFrameSync *fs, AVFilterContext *parent, unsigned nb_in)
	Initialize a frame sync structure. More...
static void	framesync_eof (FFFrameSync *fs)
static void	framesync_sync_level_update (FFFrameSync *fs)
int	ff_framesync_configure (FFFrameSync *fs)
	Configure a frame sync structure. More...
static int	framesync_advance (FFFrameSync *fs)
static int64_t	framesync_pts_extrapolate (FFFrameSync *fs, unsigned in, int64_t pts)
static void	framesync_inject_frame (FFFrameSync *fs, unsigned in, AVFrame *frame)
static void	framesync_inject_status (FFFrameSync *fs, unsigned in, int status, int64_t pts)
int	ff_framesync_get_frame (FFFrameSync *fs, unsigned in, AVFrame **rframe, unsigned get)
	Get the current frame in an input. More...
void	ff_framesync_uninit (FFFrameSync *fs)
	Free all memory currently allocated. More...
int	ff_framesync_activate (FFFrameSync *fs)
	Examine the frames in the filter's input and try to produce output. More...
int	ff_framesync_init_dualinput (FFFrameSync *fs, AVFilterContext *parent)
	Initialize a frame sync structure for dualinput. More...
int	ff_framesync_dualinput_get (FFFrameSync *fs, AVFrame **f0, AVFrame **f1)
int	ff_framesync_dualinput_get_writable (FFFrameSync *fs, AVFrame **f0, AVFrame **f1)
	Same as ff_framesync_dualinput_get(), but make sure that f0 is writable. More...

Variables
static const AVOption	framesync_options []
static const AVClass	framesync_class

Macro Definition Documentation

OFFSET

#define OFFSET

(

member

)

offsetof(FFFrameSync, member)

Definition at line 28 of file framesync.c.

FLAGS

#define FLAGS   AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_FILTERING_PARAM

Definition at line 29 of file framesync.c.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
STATE_BOF
STATE_RUN
STATE_EOF

Definition at line 70 of file framesync.c.

Function Documentation

framesync_name()

static const char* framesync_name ( void *  ptr )

static

Definition at line 31 of file framesync.c.

ff_framesync_child_class_iterate()

const AVClass* ff_framesync_child_class_iterate

(

void **

iter

)

Definition at line 63 of file framesync.c.

consume_from_fifos()

static int consume_from_fifos ( FFFrameSync *  fs )

static

Definition at line 316 of file framesync.c.

Referenced by framesync_advance().

ff_framesync_preinit()

void ff_framesync_preinit

(

FFFrameSync *

fs

)

Pre-initialize a frame sync structure.

It sets the class pointer and inits the options to their default values. The entire structure is expected to be already set to 0. This step is optional, but necessary to use the options.

Definition at line 78 of file framesync.c.

Referenced by ff_framesync_init().

ff_framesync_init()

int ff_framesync_init	(	FFFrameSync *	fs,
		AVFilterContext *	parent,
		unsigned	nb_in
	)

Initialize a frame sync structure.

The entire structure is expected to be already set to 0 or preinited.

Parameters

fs	frame sync structure to initialize
parent	parent AVFilterContext object
nb_in	number of inputs

Returns

>= 0 for success or a negative error code

Definition at line 86 of file framesync.c.

Referenced by config_output(), ff_framesync_init_dualinput(), init_framesync(), lut2_config_output(), and program_opencl_config_output().

framesync_eof()

static void framesync_eof ( FFFrameSync *  fs )

static

Definition at line 103 of file framesync.c.

Referenced by framesync_advance(), and framesync_sync_level_update().

framesync_sync_level_update()

static void framesync_sync_level_update ( FFFrameSync *  fs )

static

Definition at line 110 of file framesync.c.

Referenced by ff_framesync_configure(), and framesync_inject_status().

ff_framesync_configure()

int ff_framesync_configure

(

FFFrameSync *

fs

)

Configure a frame sync structure.

Must be called after all options are set but before all use.

Returns

>= 0 for success or a negative error code

Definition at line 134 of file framesync.c.

Referenced by config_output(), config_props_output(), init_framesync(), lut2_config_output(), overlay_cuda_config_output(), overlay_opencl_config_output(), overlay_vaapi_config_output(), overlay_vulkan_config_output(), and program_opencl_config_output().

framesync_advance()

static int framesync_advance ( FFFrameSync *  fs )

static

Definition at line 184 of file framesync.c.

Referenced by ff_framesync_activate().

framesync_pts_extrapolate()

static int64_t framesync_pts_extrapolate ( FFFrameSync *  fs, unsigned  in, int64_t  pts  )

static

Definition at line 235 of file framesync.c.

Referenced by framesync_inject_status().

framesync_inject_frame()

static void framesync_inject_frame ( FFFrameSync *  fs, unsigned  in, AVFrame *  frame  )

static

Definition at line 242 of file framesync.c.

Referenced by consume_from_fifos().

framesync_inject_status()

static void framesync_inject_status ( FFFrameSync *  fs, unsigned  in, int  status, int64_t  pts  )

static

Definition at line 255 of file framesync.c.

Referenced by consume_from_fifos().

ff_framesync_get_frame()

int ff_framesync_get_frame	(	FFFrameSync *	fs,
		unsigned	in,
		AVFrame **	rframe,
		unsigned	get
	)

Get the current frame in an input.

Parameters

fs	frame sync structure
in	index of the input
rframe	used to return the current frame (or NULL)
get	if not zero, the calling code needs to get ownership of the returned frame; the current frame will either be duplicated or removed from the framesync structure

Definition at line 267 of file framesync.c.

Referenced by blend_frame(), ff_framesync_dualinput_get(), overlay_opencl_blend(), overlay_vaapi_blend(), overlay_vulkan_blend(), process_frame(), program_opencl_filter(), and remap_opencl_process_frame().

ff_framesync_uninit()

void ff_framesync_uninit

(

FFFrameSync *

fs

)

Free all memory currently allocated.

Definition at line 304 of file framesync.c.

Referenced by overlay_cuda_uninit(), overlay_opencl_uninit(), overlay_qsv_uninit(), overlay_vaapi_uninit(), overlay_vulkan_uninit(), program_opencl_uninit(), remap_opencl_uninit(), stack_uninit(), and uninit().

ff_framesync_activate()

int ff_framesync_activate

(

FFFrameSync *

fs

)

Examine the frames in the filter's input and try to produce output.

This function can be the complete implementation of the activate method of a filter using framesync.

Definition at line 355 of file framesync.c.

Referenced by activate(), overlay_cuda_activate(), overlay_opencl_activate(), overlay_vaapi_activate(), overlay_vulkan_activate(), program_opencl_activate(), and stack_activate().

ff_framesync_init_dualinput()

int ff_framesync_init_dualinput	(	FFFrameSync *	fs,
		AVFilterContext *	parent
	)

Initialize a frame sync structure for dualinput.

Compared to generic framesync, dualinput assumes the first input is the main one and the filtering is performed on it. The first input will be the only one with sync set and generic timeline support will just pass it unchanged when disabled.

Equivalent to ff_framesync_init(fs, parent, 2) then setting the time base, sync and ext modes on the inputs.

Definition at line 375 of file framesync.c.

Referenced by config_output(), config_props_output(), overlay_cuda_config_output(), overlay_opencl_config_output(), overlay_vaapi_config_output(), and overlay_vulkan_config_output().

ff_framesync_dualinput_get()

int ff_framesync_dualinput_get	(	FFFrameSync *	fs,
		AVFrame **	f0,
		AVFrame **	f1
	)

Parameters

f0	used to return the main frame
f1	used to return the second frame, or NULL if disabled

Returns

>=0 for success or AVERROR code

Note

The frame returned in f0 belongs to the caller (get = 1 in ff_framesync_get_frame()) while the frame returned in f1 is still owned by the framesync structure.

Definition at line 393 of file framesync.c.

Referenced by blend_frame_for_dualinput(), do_convolve(), do_corr(), do_identity(), do_morpho(), do_psnr(), do_ssim(), do_ssim360(), do_vmaf(), ff_framesync_dualinput_get_writable(), overlay_cuda_blend(), process_frame(), and varblur_frame().

ff_framesync_dualinput_get_writable()

int ff_framesync_dualinput_get_writable	(	FFFrameSync *	fs,
		AVFrame **	f0,
		AVFrame **	f1
	)

Same as ff_framesync_dualinput_get(), but make sure that f0 is writable.

Definition at line 413 of file framesync.c.

Referenced by do_alphamerge(), do_blend(), and load_apply_palette().

Variable Documentation

framesync_options

const AVOption framesync_options[]

static

Initial value:

= {
    { "eof_action", "Action to take when encountering EOF from secondary input ",
        OFFSET(opt_eof_action), AV_OPT_TYPE_INT, { .i64 = EOF_ACTION_REPEAT },
        EOF_ACTION_REPEAT, EOF_ACTION_PASS, .flags = FLAGS, .unit = "eof_action" },
        { "repeat", "Repeat the previous frame.",   0, AV_OPT_TYPE_CONST, { .i64 = EOF_ACTION_REPEAT }, .flags = FLAGS, .unit = "eof_action" },
        { "endall", "End both streams.",            0, AV_OPT_TYPE_CONST, { .i64 = EOF_ACTION_ENDALL }, .flags = FLAGS, .unit = "eof_action" },
        { "pass",   "Pass through the main input.", 0, AV_OPT_TYPE_CONST, { .i64 = EOF_ACTION_PASS },   .flags = FLAGS, .unit = "eof_action" },
    { "shortest", "force termination when the shortest input terminates", OFFSET(opt_shortest), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, FLAGS },
    { "repeatlast", "extend last frame of secondary streams beyond EOF", OFFSET(opt_repeatlast), AV_OPT_TYPE_BOOL, { .i64 = 1 }, 0, 1, FLAGS },
    { "ts_sync_mode", "How strictly to sync streams based on secondary input timestamps",
        OFFSET(opt_ts_sync_mode), AV_OPT_TYPE_INT, { .i64 = TS_DEFAULT },
        TS_DEFAULT, TS_NEAREST, .flags = FLAGS, .unit = "ts_sync_mode" },
        { "default", "Frame from secondary input with the nearest lower or equal timestamp to the primary input frame",
            0, AV_OPT_TYPE_CONST, { .i64 = TS_DEFAULT }, .flags = FLAGS, .unit = "ts_sync_mode" },
        { "nearest", "Frame from secondary input with the absolute nearest timestamp to the primary input frame",
            0, AV_OPT_TYPE_CONST, { .i64 = TS_NEAREST }, .flags = FLAGS, .unit = "ts_sync_mode" },
    { NULL }
}

Definition at line 36 of file framesync.c.

framesync_class

const AVClass framesync_class

static

Initial value:

= {
    .version                   = LIBAVUTIL_VERSION_INT,
    .class_name                = "framesync",
    .item_name                 = framesync_name,
    .category                  = AV_CLASS_CATEGORY_FILTER,
    .option                    = framesync_options,
    .parent_log_context_offset = OFFSET(parent),
}

Definition at line 54 of file framesync.c.

Referenced by ff_framesync_child_class_iterate(), and ff_framesync_preinit().