Video Subpictures

Classes
struct	subpicture_region_t
struct	subpicture_updater_t
struct	subpicture_t

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
#define	SUBPICTURE_ALIGN_MASK

Typedefs
typedef struct subpicture_region_private_t	subpicture_region_private_t
typedef struct subpicture_updater_sys_t	subpicture_updater_sys_t
typedef struct subpicture_private_t	subpicture_private_t

Functions
VLC_API subpicture_region_t *	subpicture_region_New (const video_format_t *p_fmt)
VLC_API void	subpicture_region_Delete (subpicture_region_t *p_region)
VLC_API void	subpicture_region_ChainDelete (subpicture_region_t *p_head)
VLC_API subpicture_t *	subpicture_New (const subpicture_updater_t *)
VLC_API void	subpicture_Delete (subpicture_t *p_subpic)
VLC_API subpicture_t *	subpicture_NewFromPicture (vlc_object_t *, picture_t *, vlc_fourcc_t i_chroma)
VLC_API void	subpicture_Update (subpicture_t *, const video_format_t *src, const video_format_t *, mtime_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_LEAVETEXT   0x10

Align the subpicture, but not the text inside

#define SUBPICTURE_ALIGN_MASK

Value:

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

Typedef Documentation

typedef struct subpicture_region_private_t subpicture_region_private_t

Video subtitle region spu core private

Function Documentation

VLC_API void subpicture_Delete

(

subpicture_t *

p_subpic

)

This function delete a subpicture created by subpicture_New. You may give it NULL.

VLC_API subpicture_t* subpicture_New

(

const subpicture_updater_t *

)

This function create a new empty subpicture.

You must use subpicture_Delete to destroy it.

VLC_API 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.

VLC_API 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.

VLC_API 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.

VLC_API 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.

VLC_API 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.