Collaboration diagram for Filters:

Files
file	vlc_filter.h

Data Structures
struct	filter_owner_t

struct	filter_t
	Structure describing a filter. More...

Macros
#define	filter_AddProxyCallbacks(a, b, c) filter_AddProxyCallbacks(VLC_OBJECT(a), b, c)

#define	filter_DelProxyCallbacks(a, b, c) filter_DelProxyCallbacks(VLC_OBJECT(a), b, c)

#define	VIDEO_FILTER_WRAPPER(name)
	Create a picture_t ()( filter_t , picture_t ) compatible wrapper using a void ()( filter_t , picture_t , picture_t ) function. More...

#define	filter_chain_New(a, b, c) filter_chain_New( VLC_OBJECT( a ), b, c )

#define	filter_chain_NewVideo(a, b, c) filter_chain_NewVideo( VLC_OBJECT( a ), b, c )

Typedefs
typedef struct filter_owner_sys_t	filter_owner_sys_t

typedef struct filter_owner_t	filter_owner_t

typedef struct filter_chain_t	filter_chain_t
	Filter chain management API The filter chain management API is used to dynamically construct filters and add them in a chain. More...

Functions
static picture_t *	filter_NewPicture (filter_t *p_filter)
	This function will return a new picture usable by p_filter as an output buffer. More...

static void	filter_Flush (filter_t *p_filter)
	Flush a filter. More...

static void	filter_ChangeViewpoint (filter_t p_filter, const vlc_viewpoint_t vp)

static block_t *	filter_DrainAudio (filter_t *p_filter)
	This function will drain, then flush an audio filter. More...

static subpicture_t *	filter_NewSubpicture (filter_t *p_filter)
	This function will return a new subpicture usable by p_filter as an output buffer. More...

static int	filter_GetInputAttachments (filter_t p_filter, input_attachment_t *ppp_attachment, int pi_attachment)
	This function gives all input attachments at once. More...

void	filter_AddProxyCallbacks (vlc_object_t obj, filter_t filter, vlc_callback_t restart_cb)
	This function duplicates every variables from the filter, and adds a proxy callback to trigger filter events from obj. More...

void	filter_DelProxyCallbacks (vlc_object_t obj, filter_t filter, vlc_callback_t restart_cb)
	This function removes the callbacks previously added to every duplicated variables, and removes them afterward. More...

filter_t *	filter_NewBlend (vlc_object_t , const video_format_t p_dst_chroma)
	It creates a blend filter. More...

int	filter_ConfigureBlend (filter_t , int i_dst_width, int i_dst_height, const video_format_t p_src)
	It configures blend filter parameters that are allowed to changed after the creation. More...

int	filter_Blend (filter_t , picture_t p_dst, int i_dst_x, int i_dst_y, const picture_t *p_src, int i_alpha)
	It blends a picture into another one. More...

void	filter_DeleteBlend (filter_t *)
	It destroys a blend filter created by filter_NewBlend. More...

filter_chain_t *	filter_chain_New (vlc_object_t , const char , enum es_format_category_e)
	Create new filter chain. More...

filter_chain_t *	filter_chain_NewVideo (vlc_object_t obj, bool change, const filter_owner_t owner)
	Creates a new video filter chain. More...

void	filter_chain_Delete (filter_chain_t *)
	Delete filter chain will delete all filters in the chain and free all allocated data. More...

void	filter_chain_Reset (filter_chain_t , const es_format_t , const es_format_t *)
	Reset filter chain will delete all filters in the chain and reset p_fmt_in and p_fmt_out to the new values. More...

filter_t *	filter_chain_AppendFilter (filter_chain_t chain, const char name, config_chain_t cfg, const es_format_t fmt_in, const es_format_t *fmt_out)
	Append a filter to the chain. More...

int	filter_chain_AppendConverter (filter_chain_t chain, const es_format_t fmt_in, const es_format_t *fmt_out)
	Append a conversion to the chain. More...

int	filter_chain_AppendFromString (filter_chain_t chain, const char str)
	Append new filter to filter chain from string. More...

void	filter_chain_DeleteFilter (filter_chain_t chain, filter_t filter)
	Delete filter from filter chain. More...

bool	filter_chain_IsEmpty (const filter_chain_t *chain)
	Checks if the filter chain is empty. More...

const es_format_t *	filter_chain_GetFmtOut (filter_chain_t *chain)
	Get last output format of the last element in the filter chain. More...

picture_t *	filter_chain_VideoFilter (filter_chain_t chain, picture_t pic)
	Apply the filter chain to a video picture. More...

void	filter_chain_VideoFlush (filter_chain_t *)
	Flush a video filter chain. More...

void	filter_chain_SubSource (filter_chain_t chain, spu_t , vlc_tick_t display_date)
	Generate subpictures from a chain of subpicture source "filters". More...

subpicture_t *	filter_chain_SubFilter (filter_chain_t chain, subpicture_t subpic)
	Apply filter chain to subpictures. More...

int	filter_chain_MouseFilter (filter_chain_t , struct vlc_mouse_t , const struct vlc_mouse_t *)
	Apply the filter chain to a mouse state. More...

int	filter_chain_MouseEvent (filter_chain_t , const struct vlc_mouse_t , const video_format_t *)
	Inform the filter chain of mouse state. More...

int	filter_chain_ForEach (filter_chain_t chain, int(cb)(filter_t , void ), void *opaque)

Detailed Description

Audio, video, text filters

Macro Definition Documentation

◆ filter_AddProxyCallbacks

#define filter_AddProxyCallbacks	(	a,
		b,
		c
	)	filter_AddProxyCallbacks(VLC_OBJECT(a), b, c)

◆ filter_chain_New

#define filter_chain_New	(	a,
		b,
		c
	)	filter_chain_New( VLC_OBJECT( a ), b, c )

◆ filter_chain_NewVideo

#define filter_chain_NewVideo	(	a,
		b,
		c
	)	filter_chain_NewVideo( VLC_OBJECT( a ), b, c )

◆ filter_DelProxyCallbacks

#define filter_DelProxyCallbacks	(	a,
		b,
		c
	)	filter_DelProxyCallbacks(VLC_OBJECT(a), b, c)

◆ VIDEO_FILTER_WRAPPER

#define VIDEO_FILTER_WRAPPER ( name )

Value:

static picture_t *name ## _Filter ( filter_t *p_filter,             \
                                        picture_t *p_pic )              \
    {                                                                   \
        picture_t *p_outpic = filter_NewPicture( p_filter );            \
        if( p_outpic )                                                  \
        {                                                               \
            name( p_filter, p_pic, p_outpic );                          \
            picture_CopyProperties( p_outpic, p_pic );                  \
        }                                                               \
        picture_Release( p_pic );                                       \
        return p_outpic;                                                \
    }

Create a picture_t *(*)( filter_t *, picture_t * ) compatible wrapper using a void (*)( filter_t *, picture_t *, picture_t * ) function.

Currently used by the chroma video filters

Typedef Documentation

◆ filter_chain_t

typedef struct filter_chain_t filter_chain_t

Filter chain management API The filter chain management API is used to dynamically construct filters and add them in a chain.

◆ filter_owner_sys_t

typedef struct filter_owner_sys_t filter_owner_sys_t

◆ filter_owner_t

typedef struct filter_owner_t filter_owner_t

Function Documentation

◆ filter_AddProxyCallbacks()

void filter_AddProxyCallbacks	(	vlc_object_t *	obj,
		filter_t *	filter,
		vlc_callback_t	restart_cb
	)

This function duplicates every variables from the filter, and adds a proxy callback to trigger filter events from obj.

Parameters

restart_cb a vlc_callback_t to call if the event means restarting the filter (i.e. an event on a non-command variable)

References name, TriggerFilterCallback(), var_AddCallback, var_Create, var_GetAllNames(), var_Type, VLC_OBJECT, VLC_VAR_DOINHERIT, and VLC_VAR_ISCOMMAND.

◆ filter_Blend()

int filter_Blend	(	filter_t *	,
		picture_t *	p_dst,
		int	i_dst_x,
		int	i_dst_y,
		const picture_t *	p_src,
		int	i_alpha
	)

It blends a picture into another one.

The input picture is not modified and not released.

< Unspecified error

< No error

References filter_t::p_module, filter_t::pf_video_blend, VLC_EGENERIC, and VLC_SUCCESS.

Referenced by picture_BlendSubpicture().

◆ filter_chain_AppendConverter()

int filter_chain_AppendConverter	(	filter_chain_t *	chain,
		const es_format_t *	fmt_in,
		const es_format_t *	fmt_out
	)

Append a conversion to the chain.

Parameters

chain	filter chain to append a filter to
fmt_in	filter input format
fmt_out	filter output format

Return values

0	on success
-1	on failure

References filter_chain_t::conv_cap, and filter_chain_AppendInner().

◆ filter_chain_AppendFilter()

filter_t* filter_chain_AppendFilter	(	filter_chain_t *	chain,
		const char *	name,
		config_chain_t *	cfg,
		const es_format_t *	fmt_in,
		const es_format_t *	fmt_out
	)

Append a filter to the chain.

Parameters

chain	filter chain to append a filter to
name	filter name
fmt_in	filter input format
fmt_out	filter output format

Returns: a pointer to the filter or NULL on error

References filter_chain_t::filter_cap, filter_chain_AppendInner(), and name.

Referenced by filter_chain_AppendFromString().

◆ filter_chain_AppendFromString()

int filter_chain_AppendFromString	(	filter_chain_t *	chain,
		const char *	str
	)

Append new filter to filter chain from string.

Parameters

chain	filter chain to append a filter to
str	filters chain nul-terminated string

< Unspecified error

References filter_chain_t::callbacks, config_ChainCreate(), config_ChainDestroy(), chained_filter_t::filter, filter_chain_AppendFilter(), filter_chain_DeleteFilter(), filter_chain_t::last, msg_Err, name, filter_owner_t::sys, and VLC_EGENERIC.

◆ filter_chain_Delete()

void filter_chain_Delete ( filter_chain_t * p_chain )

Delete filter chain will delete all filters in the chain and free all allocated data.

The pointer to the filter chain is then no longer valid.

Parameters

p_chain pointer to filter chain

Delete filter chain will delete all filters in the chain and free all allocated data.

References es_format_Clean(), chained_filter_t::filter, filter_chain_DeleteFilter(), filter_chain_t::first, filter_chain_t::fmt_in, and filter_chain_t::fmt_out.

◆ filter_chain_DeleteFilter()

void filter_chain_DeleteFilter	(	filter_chain_t *	chain,
		filter_t *	filter
	)

Delete filter from filter chain.

This function also releases the filter object and unloads the filter modules. The pointer to p_filter is no longer valid after this function successfully returns.

Parameters

chain	filter chain to remove the filter from
filter	filter to remove from the chain and delete

References filter_chain_t::callbacks, chained(), es_format_Clean(), FilterDeletePictures(), filter_chain_t::first, filter_chain_t::last, module_unneed, chained_filter_t::mouse, msg_Dbg, chained_filter_t::next, filter_t::p_module, chained_filter_t::pending, chained_filter_t::prev, filter_owner_t::sys, and vlc_object_release.

Referenced by filter_chain_AppendFromString(), filter_chain_Delete(), and filter_chain_Reset().

◆ filter_chain_ForEach()

int filter_chain_ForEach	(	filter_chain_t *	chain,
		int()(filter_t , void *)	cb,
		void *	opaque
	)

< No error

References filter_chain_t::first, chained_filter_t::next, and VLC_SUCCESS.

◆ filter_chain_GetFmtOut()

const es_format_t* filter_chain_GetFmtOut ( filter_chain_t * chain )

Get last output format of the last element in the filter chain.

Parameters

chain filter chain

References filter_chain_t::b_allow_fmt_out_change, chained_filter_t::filter, filter_chain_t::fmt_out, filter_t::fmt_out, and filter_chain_t::last.

◆ filter_chain_IsEmpty()

bool filter_chain_IsEmpty ( const filter_chain_t * chain )

Checks if the filter chain is empty.

Parameters

chain pointer to filter chain

Returns: true if and only if there are no filters in this filter chain

References filter_chain_t::first.

◆ filter_chain_MouseEvent()

int filter_chain_MouseEvent	(	filter_chain_t *	,
		const struct vlc_mouse_t *	,
		const video_format_t *
	)

Inform the filter chain of mouse state.

It makes sense only for a sub source chain.

◆ filter_chain_MouseFilter()

int filter_chain_MouseFilter	(	filter_chain_t *	,
		struct vlc_mouse_t *	,
		const struct vlc_mouse_t *
	)

Apply the filter chain to a mouse state.

It will be applied from the output to the input. It makes sense only for a video filter chain.

The vlc_mouse_t* pointers may be the same.

◆ filter_chain_New()

filter_chain_t* filter_chain_New	(	vlc_object_t *	obj,
		const char *	cap,
		enum es_format_category_e	cat
	)

Create new filter chain.

Parameters

p_object	pointer to a vlc object
psz_capability	vlc capability of filters in filter chain

Returns: pointer to a filter chain

Create new filter chain.

References filter_chain_NewInner(), and filter_owner_t::sys.

◆ filter_chain_NewVideo()

filter_chain_t* filter_chain_NewVideo	(	vlc_object_t *	obj,
		bool	change,
		const filter_owner_t *	owner
	)

Creates a new video filter chain.

Parameters

obj	pointer to parent VLC object
change	whether to allow changing the output format
owner	owner video buffer callbacks

Returns: new filter chain, or NULL on error

◆ filter_chain_Reset()

void filter_chain_Reset	(	filter_chain_t *	p_chain,
		const es_format_t *	p_fmt_in,
		const es_format_t *	p_fmt_out
	)

Reset filter chain will delete all filters in the chain and reset p_fmt_in and p_fmt_out to the new values.

Parameters

p_chain	pointer to filter chain
p_fmt_in	new fmt_in params, may be NULL to leave input fmt unchanged
p_fmt_out	new fmt_out params, may be NULL to leave output fmt unchanged

Reset filter chain will delete all filters in the chain and reset p_fmt_in and p_fmt_out to the new values.

References es_format_Clean(), es_format_Copy(), chained_filter_t::filter, filter_chain_DeleteFilter(), filter_chain_t::first, filter_chain_t::fmt_in, and filter_chain_t::fmt_out.