Video Subpictures
[Video Output]

Collaboration diagram for Video Subpictures:

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


Data Structures
struct	subpicture_region_t
	Video subtitle region. More...
struct	subpicture_t
	Video subtitle. More...
Defines
#define	SUBPICTURE_ALIGN_LEFT 0x1
#define	SUBPICTURE_ALIGN_RIGHT 0x2
#define	SUBPICTURE_ALIGN_TOP 0x4
#define	SUBPICTURE_ALIGN_BOTTOM 0x8
#define	SUBPICTURE_ALIGN_MASK
Typedefs
typedef struct subpicture_region_private_t	subpicture_region_private_t
	Video subtitle region spu core private.
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 (void)
	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.

Detailed Description

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

Define Documentation

#define SUBPICTURE_ALIGN_BOTTOM 0x8

Referenced by __osd_ButtonFind(), CreateHtmlSubtitle(), CreateTextRegion(), Decode(), FilterVideo(), ParsePositionAttributeList(), ParseSSAHeader(), ParseSSAString(), ParseText(), ParseUSFHeaderTags(), SetupSimpleKateSPU(), SpuAreaFixOverlap(), SpuRegionPlace(), and Subtitle().

#define SUBPICTURE_ALIGN_LEFT 0x1

Referenced by __osd_ButtonFind(), Compose(), CreateHtmlSubtitle(), DrawBlack(), FilterVideo(), ParsePositionAttributeList(), ParseSSAHeader(), ParseSSAString(), ParseUSFHeaderTags(), Render(), RenderYUVA(), SpuRegionPlace(), and UpdateRegions().

#define SUBPICTURE_ALIGN_MASK

Value:

( SUBPICTURE_ALIGN_LEFT|SUBPICTURE_ALIGN_RIGHT| \
                                SUBPICTURE_ALIGN_TOP |SUBPICTURE_ALIGN_BOTTOM )

Referenced by osd_ShowTextAbsolute(), and vout_ShowTextAbsolute().

#define SUBPICTURE_ALIGN_RIGHT 0x2

Referenced by __osd_ButtonFind(), Compose(), CreateHtmlSubtitle(), DrawBlack(), FilterVideo(), ParsePositionAttributeList(), ParseSSAHeader(), ParseSSAString(), ParseUSFHeaderTags(), Render(), RenderYUVA(), and SpuRegionPlace().

#define SUBPICTURE_ALIGN_TOP 0x4

Referenced by __osd_ButtonFind(), CreateHtmlSubtitle(), FilterVideo(), ParsePositionAttributeList(), ParseSSAHeader(), ParseUSFHeaderTags(), SpuAreaFixOverlap(), SpuRegionPlace(), and UpdateRegions().

Typedef Documentation

typedef struct subpicture_region_private_t subpicture_region_private_t

Video subtitle region spu core private.

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_region, subpicture_t::pf_destroy, and subpicture_region_ChainDelete().

Referenced by DecoderFlushBuffering(), DecoderPlaySpu(), DecoderProcessSpu(), osd_ShowTextAbsolute(), spu_del_buffer(), spu_DisplaySubpicture(), SpuHeapClean(), SpuHeapDeleteAt(), sub_del_buffer(), transcode_osd_process(), and vout_ShowTextAbsolute().

subpicture_t* subpicture_New ( void )

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_t::i_alpha, subpicture_t::i_order, subpicture_t::p_region, subpicture_t::p_sys, and subpicture_t::pf_destroy.

Referenced by osd_CreateWidget(), osd_ShowTextAbsolute(), spu_new_buffer(), sub_new_buffer(), subpicture_NewFromPicture(), and vout_ShowTextAbsolute().

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_aspect, 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 Filter(), subpicture_Delete(), and SubpictureReleaseRegions().

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, SpuRegionPrivateDelete(), and text_style_Delete().

Referenced by CreateTextRegion(), Filter(), RenderText(), and 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_aspect, video_format_t::i_chroma, video_format_t::i_height, video_format_t::i_width, 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_New(), subpicture_region_t::psz_text, VLC_CODEC_TEXT, and VLC_CODEC_YUVP.

Referenced by create_picture_region(), CreatePicture(), CreateTextRegion(), Decode(), DecodePacket(), Filter(), FilterSub(), LoadEmbeddedImage(), osd_ShowTextAbsolute(), ParseText(), Render(), render(), RenderText(), SetupSimpleKateSPU(), Subpicture(), subpicture_NewFromPicture(), Subtitle(), UpdateRegions(), and vout_ShowTextAbsolute().

Video Subpictures [Video Output]

Data Structures

Defines

Typedefs

Functions

Detailed Description

Define Documentation

Typedef Documentation

Function Documentation

Video Subpictures
[Video Output]