VLC  3.0.0-git
Files | Data Structures | Macros | Typedefs | Functions
Filters

Audio, video, text filters. More...

Collaboration diagram for Filters:

Files

file  vlc_filter.h
 Filter modules interface.
 

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_tfilter_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_tfilter_DrainAudio (filter_t *p_filter)
 This function will drain, then flush an audio filter. More...
 
static subpicture_tfilter_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_tfilter_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_tfilter_chain_New (vlc_object_t *, const char *, enum es_format_category_e)
 Create new filter chain. More...
 
filter_chain_tfilter_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_tfilter_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_tfilter_chain_GetFmtOut (filter_chain_t *chain)
 Get last output format of the last element in the filter chain. More...
 
picture_tfilter_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 *, mtime_t display_date)
 Generate subpictures from a chain of subpicture source "filters". More...
 
subpicture_tfilter_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,
 
)    filter_AddProxyCallbacks(VLC_OBJECT(a), b, c)

◆ filter_chain_New

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

Referenced by spu_Create().

◆ filter_chain_NewVideo

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

◆ filter_DelProxyCallbacks

#define filter_DelProxyCallbacks (   a,
  b,
 
)    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; \
}
Video picture.
Definition: vlc_picture.h:69
static picture_t * filter_NewPicture(filter_t *p_filter)
This function will return a new picture usable by p_filter as an output buffer.
Definition: vlc_filter.h:164
const char name[16]
Definition: httpd.c:1262
Structure describing a filter.
Definition: vlc_filter.h:66

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

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

◆ 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_cba 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
chainfilter chain to append a filter to
fmt_infilter input format
fmt_outfilter output format
Return values
0on success
-1on failure

References filter_chain_t::conv_cap, and filter_chain_AppendInner().

Referenced by ThreadChangeFilters(), and VoutDisplayCreateRender().

◆ 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
chainfilter chain to append a filter to
namefilter name
fmt_infilter input format
fmt_outfilter output format
Returns
a pointer to the filter or NULL on error

References filter_chain_t::filter_cap, and filter_chain_AppendInner().

Referenced by filter_chain_AppendFromString(), and ThreadChangeFilters().

◆ filter_chain_AppendFromString()

int filter_chain_AppendFromString ( filter_chain_t chain,
const char *  str 
)

Append new filter to filter chain from string.

Parameters
chainfilter chain to append a filter to
strfilters 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, chained_filter_t::next, filter_owner_t::sys, and VLC_EGENERIC.

Referenced by spu_PutSubpicture(), and spu_Render().

◆ 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_chainpointer 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.

Referenced by spu_Destroy(), ThreadStart(), ThreadStop(), VoutDisplayCreateRender(), and VoutDisplayDestroyRender().

◆ 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
chainfilter chain to remove the filter from
filterfilter 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 
)

◆ 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
chainfilter 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.

Referenced by ThreadChangeFilters().

◆ filter_chain_IsEmpty()

bool filter_chain_IsEmpty ( const filter_chain_t chain)

Checks if the filter chain is empty.

Parameters
chainpointer to filter chain
Returns
true if and only if there are no filters in this filter chain

References filter_chain_t::first.

Referenced by spu_PutSubpicture(), vout_IsDisplayFiltered(), and VoutVideoFilterStaticNewPicture().

◆ 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_objectpointer to a vlc object
psz_capabilityvlc 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
objpointer to parent VLC object
changewhether to allow changing the output format
ownerowner 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_chainpointer to filter chain
p_fmt_innew fmt_in params, may be NULL to leave input fmt unchanged
p_fmt_outnew 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.

Referenced by spu_PutSubpicture(), spu_Render(), ThreadChangeFilters(), and VoutDisplayCreateRender().

◆ filter_chain_SubFilter()

subpicture_t* filter_chain_SubFilter ( filter_chain_t chain,
subpicture_t subpic 
)

Apply filter chain to subpictures.

Parameters
chainfilter chain
subpicsubpicture to apply filters on
Returns
modified subpicture after applying all subpicture filters

References filter_chain_t::first, chained_filter_t::next, and filter_t::pf_sub_filter.

Referenced by spu_PutSubpicture().

◆ filter_chain_SubSource()

void filter_chain_SubSource ( filter_chain_t chain,
spu_t ,
mtime_t  display_date 
)

Generate subpictures from a chain of subpicture source "filters".

Parameters
chainfilter chain
display_dateof subpictures

References filter_chain_t::first, chained_filter_t::next, filter_t::pf_sub_source, and spu_PutSubpicture().

Referenced by spu_Render().

◆ filter_chain_VideoFilter()

picture_t* filter_chain_VideoFilter ( filter_chain_t chain,
picture_t pic 
)

Apply the filter chain to a video picture.

Parameters
chainpointer to filter chain
picpicture to apply filters to
Returns
modified picture after applying all video filters

References FilterChainVideoFilter(), filter_chain_t::first, filter_chain_t::last, picture_t::p_next, and chained_filter_t::prev.

Referenced by ThreadDisplayPreparePicture(), ThreadDisplayRenderPicture(), and vout_FilterDisplay().

◆ filter_chain_VideoFlush()

void filter_chain_VideoFlush ( filter_chain_t )

Flush a video filter chain.

References filter_Flush(), FilterDeletePictures(), filter_chain_t::first, and chained_filter_t::next.

Referenced by ThreadFilterFlush().

◆ filter_ChangeViewpoint()

static void filter_ChangeViewpoint ( filter_t p_filter,
const vlc_viewpoint_t vp 
)
inlinestatic

◆ filter_ConfigureBlend()

int filter_ConfigureBlend ( filter_t ,
int  i_dst_width,
int  i_dst_height,
const video_format_t p_src 
)

◆ filter_DeleteBlend()

void filter_DeleteBlend ( filter_t )

It destroys a blend filter created by filter_NewBlend.

References module_unneed, filter_t::p_module, and vlc_object_release.

Referenced by ThreadDisplayRenderPicture(), and ThreadStop().

◆ filter_DelProxyCallbacks()

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.

Parameters
restart_cbthe same vlc_callback_t passed to filter_AddProxyCallbacks

References name, TriggerFilterCallback(), var_DelCallback, var_Destroy, var_GetAllNames(), var_Type, VLC_OBJECT, and VLC_VAR_ISCOMMAND.

◆ filter_DrainAudio()

static block_t* filter_DrainAudio ( filter_t p_filter)
inlinestatic

This function will drain, then flush an audio filter.

References filter_t::pf_audio_drain.

Referenced by aout_FiltersPipelineDrain().

◆ filter_Flush()

static void filter_Flush ( filter_t p_filter)
inlinestatic

Flush a filter.

This function will flush the state of a filter (audio or video).

References filter_t::pf_flush.

Referenced by aout_FiltersPipelineFlush(), and filter_chain_VideoFlush().

◆ filter_GetInputAttachments()

static int filter_GetInputAttachments ( filter_t p_filter,
input_attachment_t ***  ppp_attachment,
int *  pi_attachment 
)
inlinestatic

This function gives all input attachments at once.

You MUST release the returned values

< Unspecified error

References filter_AddProxyCallbacks, filter_t::pf_get_attachments, VLC_API, and VLC_EGENERIC.

◆ filter_NewBlend()

filter_t* filter_NewBlend ( vlc_object_t ,
const video_format_t p_dst_chroma 
)

◆ filter_NewPicture()

static picture_t* filter_NewPicture ( filter_t p_filter)
inlinestatic

This function will return a new picture usable by p_filter as an output buffer.

You have to release it using picture_Release or by returning it to the caller as a pf_video_filter return value. Provided for convenience.

Parameters
p_filterfilter_t object
Returns
new picture on success or NULL on failure

References msg_Warn, filter_t::owner, and filter_owner_t::video.

Referenced by ImageConvert().

◆ filter_NewSubpicture()

static subpicture_t* filter_NewSubpicture ( filter_t p_filter)
inlinestatic

This function will return a new subpicture usable by p_filter as an output buffer.

You have to release it using subpicture_Delete or by returning it to the caller as a pf_sub_source return value. Provided for convenience.

Parameters
p_filterfilter_t object
Returns
new subpicture

References msg_Warn, filter_t::owner, and filter_owner_t::sub.