Video Subpictures

Subpictures are pictures that should be displayed on top of the video, like subtitles and OSD. More...

Collaboration diagram for Video Subpictures:

Data Structures
struct	subpicture_region_t
	Video subtitle region. More...
struct	subpicture_updater_t
struct	subpicture_t
	Video subtitle. More...

Macros
#define	SUBPICTURE_ALIGN_LEFT   0x1
#define	SUBPICTURE_ALIGN_RIGHT   0x2
#define	SUBPICTURE_ALIGN_TOP   0x4
#define	SUBPICTURE_ALIGN_BOTTOM   0x8
#define	SUBPICTURE_ALIGN_LEAVETEXT   0x10
	Align the subpicture, but not the text inside.
#define	SUBPICTURE_ALIGN_MASK

Typedefs
typedef struct subpicture_region_private_t	subpicture_region_private_t
	Video subtitle region spu core private.
typedef struct subpicture_updater_sys_t	subpicture_updater_sys_t
typedef struct subpicture_private_t	subpicture_private_t

Functions
subpicture_region_t *	subpicture_region_New (const video_format_t *p_fmt)
	This function will create a new subpicture region.
void	subpicture_region_Delete (subpicture_region_t *p_region)
	This function will destroy a subpicture region allocated by subpicture_region_New.
void	subpicture_region_ChainDelete (subpicture_region_t *p_head)
	This function will destroy a list of subpicture regions allocated by subpicture_region_New.
subpicture_t *	subpicture_New (const subpicture_updater_t *)
	This function create a new empty subpicture.
void	subpicture_Delete (subpicture_t *p_subpic)
	This function delete a subpicture created by subpicture_New.
subpicture_t *	subpicture_NewFromPicture (vlc_object_t *, picture_t *, vlc_fourcc_t i_chroma)
	This function will create a subpicture having one region in the requested chroma showing the given picture.
void	subpicture_Update (subpicture_t *, const video_format_t *src, const video_format_t *, mtime_t)
	This function will update the content of a subpicture created with a non NULL subpicture_updater_t.

Detailed Description

Subpictures are pictures that should be displayed on top of the video, like subtitles and OSD.

Macro Definition Documentation

#define SUBPICTURE_ALIGN_BOTTOM   0x8

Referenced by OSDTextUpdate(), SpuAreaFixOverlap(), and SpuRegionPlace().

#define SUBPICTURE_ALIGN_LEAVETEXT   0x10

Align the subpicture, but not the text inside.

#define SUBPICTURE_ALIGN_LEFT   0x1

Referenced by OSDTextUpdate(), and SpuRegionPlace().

#define SUBPICTURE_ALIGN_MASK

Value:

( SUBPICTURE_ALIGN_LEFT|SUBPICTURE_ALIGN_RIGHT| \
                                SUBPICTURE_ALIGN_TOP |SUBPICTURE_ALIGN_BOTTOM| \
                                SUBPICTURE_ALIGN_LEAVETEXT )

Referenced by vout_OSDText().

#define SUBPICTURE_ALIGN_RIGHT   0x2

Referenced by OSDTextUpdate(), SpuRegionPlace(), and vout_OSDMessage().

#define SUBPICTURE_ALIGN_TOP   0x4

Referenced by OSDTextUpdate(), SpuAreaFixOverlap(), SpuRegionPlace(), and vout_OSDMessage().

Typedef Documentation

typedef struct subpicture_private_t subpicture_private_t

typedef struct subpicture_region_private_t subpicture_region_private_t

Video subtitle region spu core private.

typedef struct subpicture_updater_sys_t subpicture_updater_sys_t

Function Documentation

void subpicture_Delete

(

subpicture_t *

p_subpic

)

This function delete a subpicture created by subpicture_New.

You may give it NULL.

References subpicture_t::p_private, subpicture_t::p_region, subpicture_updater_t::pf_destroy, subpicture_region_ChainDelete(), and subpicture_t::updater.

Referenced by DecoderFlushBuffering(), DecoderPlaySpu(), DecoderProcessSpu(), spu_del_buffer(), spu_PutSubpicture(), SpuHeapClean(), SpuHeapDeleteAt(), sub_del_buffer(), ThreadDisplayRenderPicture(), and vout_control_cmd_Clean().

subpicture_t* subpicture_New

(

const subpicture_updater_t *

)

This function create a new empty subpicture.

You must use subpicture_Delete to destroy it.

References subpicture_t::b_absolute, subpicture_t::b_fade, subpicture_t::b_subtitle, subpicture_private_t::dst, subpicture_t::i_alpha, subpicture_t::i_order, subpicture_t::p_private, subpicture_t::p_region, subpicture_updater_t::p_sys, subpicture_updater_t::pf_destroy, subpicture_updater_t::pf_update, subpicture_updater_t::pf_validate, subpicture_private_t::src, subpicture_t::updater, and video_format_Init().

Referenced by OSDWidget(), spu_new_buffer(), SpuRenderSubpictures(), sub_new_buffer(), subpicture_NewFromPicture(), vout_OSDEpg(), and vout_OSDText().

subpicture_t* subpicture_NewFromPicture	(	vlc_object_t *	,
		picture_t *	,
		vlc_fourcc_t	i_chroma
	)

This function will create a subpicture having one region in the requested chroma showing the given picture.

The picture_t given is not released nor used inside the returned subpicture_t.

References picture_t::format, video_format_t::i_chroma, video_format_t::i_height, subpicture_t::i_original_picture_height, subpicture_t::i_original_picture_width, video_format_t::i_sar_den, video_format_t::i_sar_num, video_format_t::i_width, image_Convert, image_HandlerCreate, image_HandlerDelete(), subpicture_region_t::p_picture, subpicture_t::p_region, picture_Release(), subpicture_New(), and subpicture_region_New().

Referenced by VoutSnapshotPip().

void subpicture_region_ChainDelete

(

subpicture_region_t *

p_head

)

This function will destroy a list of subpicture regions allocated by subpicture_region_New.

Provided for convenience.

References subpicture_region_t::p_next, and subpicture_region_Delete().

Referenced by subpicture_Delete(), and subpicture_Update().

void subpicture_region_Delete

(

subpicture_region_t *

p_region

)

This function will destroy a subpicture region allocated by subpicture_region_New.

You may give it NULL.

References subpicture_region_t::fmt, video_format_t::p_palette, subpicture_region_t::p_picture, subpicture_region_t::p_private, subpicture_region_t::p_style, picture_Release(), subpicture_region_t::psz_html, subpicture_region_t::psz_text, subpicture_region_private_Delete(), and text_style_Delete().

Referenced by subpicture_region_ChainDelete().

subpicture_region_t* subpicture_region_New

(

const video_format_t *

p_fmt

)

This function will create a new subpicture region.

You must use subpicture_region_Delete to destroy it.

References subpicture_region_t::fmt, subpicture_region_t::i_alpha, video_format_t::i_chroma, subpicture_region_t::p_next, video_format_t::p_palette, subpicture_region_t::p_picture, subpicture_region_t::p_private, subpicture_region_t::p_style, picture_NewFromFormat(), subpicture_region_t::psz_text, VLC_CODEC_TEXT, and VLC_CODEC_YUVP.

Referenced by OSDRegion(), OSDTextUpdate(), SpuRenderRegion(), subpicture_NewFromPicture(), vout_OSDEpgSlider(), and vout_OSDEpgText().

void subpicture_Update	(	subpicture_t *	,
		const video_format_t *	src,
		const video_format_t *	,
		mtime_t
	)

This function will update the content of a subpicture created with a non NULL subpicture_updater_t.

References subpicture_private_t::dst, subpicture_t::p_private, subpicture_t::p_region, subpicture_updater_t::pf_update, subpicture_updater_t::pf_validate, subpicture_private_t::src, subpicture_region_ChainDelete(), subpicture_t::updater, video_format_Clean(), video_format_Copy(), and video_format_IsSimilar().

Referenced by spu_Render().