Subpictures functions. More...

Include dependency graph for vlc_subpicture.h:

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

struct	vlc_spu_highlight_t

struct	vlc_spu_updater_ops
	Subpicture updater operation virtual table. More...

struct	subpicture_updater_t

struct	subpicture_region_rendered

struct	vlc_render_subpicture

struct	subpicture_t
	Video subtitle. More...

Macros
#define	VLC_SUBPIC_TEXT_FLAG_NO_REGION_BG (1 << 4)

#define	VLC_SUBPIC_TEXT_FLAG_GRID_MODE (1 << 5)
	if the decoder sends row/cols based output

#define	VLC_SUBPIC_TEXT_FLAG_TEXT_NOT_BALANCED (1 << 6)
	don't try to balance wrapped text lines

#define	VLC_SUBPIC_TEXT_FLAG_IS_TEXT (1 << 7)
	mark the subpicture region as a text flag

#define	vlc_spu_regions_init(p_rs) vlc_list_init((p_rs))

#define	vlc_spu_regions_push(p_rs, reg) vlc_list_append(&(reg)->node, (p_rs))

#define	vlc_spu_regions_foreach(reg, p_rs) vlc_list_foreach(reg, (p_rs), node)

#define	vlc_spu_regions_foreach_const(reg, p_rs) vlc_list_foreach_const(reg, (p_rs), node)

#define	vlc_spu_regions_is_empty(p_rs) vlc_list_is_empty((p_rs))

#define	vlc_spu_regions_first_or_null(p_rs) vlc_list_first_entry_or_null((p_rs), subpicture_region_t, node)

#define	vlc_spu_regions_remove(p_rs, reg) vlc_list_remove(&(reg)->node)

#define	SUBPICTURE_ALIGN_LEFT 0x1

#define	SUBPICTURE_ALIGN_RIGHT 0x2

#define	SUBPICTURE_ALIGN_TOP 0x4

#define	SUBPICTURE_ALIGN_BOTTOM 0x8

#define	SUBPICTURE_ALIGN_MASK

#define	subpicture_region_IsText(r) (((r)->text_flags & VLC_SUBPIC_TEXT_FLAG_IS_TEXT) != 0)
	Tells if the region is a text-based region.

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

typedef struct vlc_spu_highlight_t	vlc_spu_highlight_t

typedef struct filter_t	vlc_blender_t
	render background under text only

typedef struct vlc_list	vlc_spu_regions

typedef struct subpicture_private_t	subpicture_private_t

typedef struct vlc_render_subpicture	vlc_render_subpicture

Functions
subpicture_region_t *	subpicture_region_New (const video_format_t *p_fmt)
	This function will create a new subpicture region.

subpicture_region_t *	subpicture_region_NewText (void)
	This function will create a new text subpicture region.

subpicture_region_t *	subpicture_region_ForPicture (const video_format_t p_fmt, picture_t pic)
	Create a subpicture region containing the picture.

void	subpicture_region_Delete (subpicture_region_t *p_region)
	This function will destroy a subpicture region allocated by subpicture_region_New.

void	vlc_spu_regions_Clear (vlc_spu_regions *)
	This function will clear 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 *, vlc_tick_t)
	This function will update the content of a subpicture created with a non NULL subpicture_updater_t.

unsigned	picture_BlendSubpicture (picture_t , vlc_blender_t , vlc_render_subpicture *)
	This function will blend a given subpicture onto a picture.

vlc_render_subpicture *	vlc_render_subpicture_New (void)
	Create a vlc_render_subpicture.

void	vlc_render_subpicture_Delete (vlc_render_subpicture *)
	Destroy a vlc_render_subpicture.

Detailed Description

Subpictures functions.

Data Structures

Macros

Typedefs

Functions

Detailed Description