VLC  4.0.0-dev
Modules | Files | Data Structures | Macros | Typedefs | Functions
Collaboration diagram for Sub-picture channels:


 On-screen display


file  vlc_spu.h

Data Structures

struct  spu_t
 Subpicture unit descriptor. More...


#define spu_Create(a, b)   spu_Create(VLC_OBJECT(a),b)


typedef struct spu_private_t spu_private_t


spu_tspu_Create (vlc_object_t *, vout_thread_t *)
 Creates the subpicture unit. More...
void spu_Destroy (spu_t *)
 Destroy the subpicture unit. More...
void spu_PutSubpicture (spu_t *, subpicture_t *)
 This function sends a subpicture to the spu_t core. More...
subpicture_tspu_Render (spu_t *, const vlc_fourcc_t *p_chroma_list, const video_format_t *p_fmt_dst, const video_format_t *p_fmt_src, mtime_t render_subtitle_date, mtime_t render_osd_date, bool ignore_osd)
 This function will return an unique subpicture containing the OSD and subtitles visibles at the requested date. More...
int spu_RegisterChannel (spu_t *)
 It registers a new SPU channel. More...
void spu_ClearChannel (spu_t *, int)
 It clears all subpictures associated to a SPU channel. More...
void spu_ChangeSources (spu_t *, const char *)
 It changes the sub sources list. More...
void spu_ChangeFilters (spu_t *, const char *)
 It changes the sub filters list. More...

Detailed Description

Macro Definition Documentation

◆ spu_Create

#define spu_Create (   a,
)    spu_Create(VLC_OBJECT(a),b)

Referenced by VoutCreate().

Typedef Documentation

◆ spu_private_t

typedef struct spu_private_t spu_private_t

Function Documentation

◆ spu_ChangeFilters()

void spu_ChangeFilters ( spu_t ,
const char *   

◆ spu_ChangeSources()

void spu_ChangeSources ( spu_t ,
const char *   

◆ spu_ClearChannel()

void spu_ClearChannel ( spu_t ,

◆ spu_Create()

spu_t* spu_Create ( vlc_object_t object,
vout_thread_t vout 

◆ spu_Destroy()

void spu_Destroy ( spu_t spu)

◆ spu_PutSubpicture()

void spu_PutSubpicture ( spu_t spu,
subpicture_t subpic 

This function sends a subpicture to the spu_t core.

You cannot use the provided subpicture anymore. The spu_t core will destroy it at its convenience.

This function sends a subpicture to the spu_t core.

Remove the reservation flag of a subpicture, which will cause it to be ready for display.

sputhe subpicture unit object
subpicthe subpicture to display

References spu_private_t::filter_chain, filter_chain_AppendFromString(), filter_chain_ForEach(), filter_chain_IsEmpty(), spu_private_t::filter_chain_lock, filter_chain_Reset(), filter_chain_SubFilter(), spu_private_t::filter_chain_update, spu_private_t::heap, subpicture_t::i_channel, spu_private_t::lock, msg_Err, spu_t::p, subpicture_region_t::p_next, subpicture_t::p_region, spu_private_t::source_chain_current, spu_private_t::source_chain_update, spu_ClearChannel(), SpuHeapPush(), strdup(), SubFilterAddProxyCallbacks(), SubFilterDelProxyCallbacks(), subpicture_Delete(), vlc_mutex_lock(), vlc_mutex_unlock(), spu_private_t::vout, and VOUT_SPU_CHANNEL_OSD.

Referenced by filter_chain_SubSource(), and ThreadDisplaySubpicture().

◆ spu_RegisterChannel()

int spu_RegisterChannel ( spu_t )

◆ spu_Render()

subpicture_t* spu_Render ( spu_t ,
const vlc_fourcc_t p_chroma_list,
const video_format_t p_fmt_dst,
const video_format_t p_fmt_src,
mtime_t  render_subtitle_date,
mtime_t  render_osd_date,
bool  ignore_osd 

This function will return an unique subpicture containing the OSD and subtitles visibles at the requested date.

p_chroma_listis a list of supported chroma for the output (can be NULL)
p_fmt_dstis the format of the picture on which the return subpicture will be rendered.
p_fmt_srcis the format of the original(source) video.

The returned value if non NULL must be released by subpicture_Delete().

References subpicture_t::b_subtitle, filter_chain_AppendFromString(), filter_chain_ForEach(), filter_chain_Reset(), filter_chain_SubSource(), video_format_t::i_chroma, spu_private_t::lock, spu_t::p, spu_private_t::source_chain, spu_private_t::source_chain_lock, spu_private_t::source_chain_update, SpuRenderSubpictures(), SpuSelectSubpictures(), subpicture_Update(), SubpictureCmp(), SubSourceAddProxyCallbacks(), SubSourceClean(), SubSourceDelProxyCallbacks(), SubSourceInit(), VLC_CODEC_ARGB, VLC_CODEC_BGRA, VLC_CODEC_RGBA, VLC_CODEC_YUVA, VLC_CODEC_YUVP, vlc_fourcc_IsYUV(), vlc_mutex_lock(), vlc_mutex_unlock(), spu_private_t::vout, and VOUT_MAX_SUBPICTURES.

Referenced by ThreadDisplayRenderPicture().