subpicture_t Struct Reference
[Video Subpictures]

Video subtitle. More...

Collaboration diagram for subpicture_t:

[legend]


Data Fields
subpicture_region_t *	p_region
	region list composing this subtitle
void(*	pf_render )(vout_thread_t , picture_t , const subpicture_t *)
	Pointer to function that renders this subtitle in a picture.
void(*	pf_destroy )(subpicture_t *)
	Pointer to function that cleans up the private data of this subtitle.
subpicture_region_t (	pf_create_region )(vlc_object_t , video_format_t )
	Pointer to functions for region management.
subpicture_region_t (	pf_make_region )(vlc_object_t , video_format_t , picture_t *)
void(*	pf_destroy_region )(vlc_object_t , subpicture_region_t )
void(*	pf_pre_render )(video_format_t , spu_t , subpicture_t *)
void(*	pf_update_regions )(video_format_t , spu_t , subpicture_t *, mtime_t)
subpicture_sys_t *	p_sys
	Private data - the subtitle plugin might want to put stuff here to keep track of the subpicture.
Channel ID
int	i_channel
	subpicture channel ID
Type and flags
Should NOT be modified except by the vout thread
int	i_type
	type
int	i_status
	flags
subpicture_t *	p_next
	next subtitle to be displayed
Date properties
mtime_t	i_start
	beginning of display date
mtime_t	i_stop
	end of display date
bool	b_ephemer
	If this flag is set to true the subtitle will be displayed untill the next one appear.
bool	b_fade
	enable fading
bool	b_pausable
	subpicture will be paused if stream is paused
Display properties
These properties are only indicative and may be changed by the video output thread, or simply ignored depending of the subtitle type.
int	i_x
	offset from alignment position
int	i_y
	offset from alignment position
int	i_width
	picture width
int	i_height
	picture height
int	i_alpha
	transparency
int	i_original_picture_width
	original width of the movie
int	i_original_picture_height
	original height of the movie
bool	b_absolute
	position is absolute
int	i_flags
	position flags

Detailed Description

Video subtitle.

Any subtitle destined to be displayed by a video output thread should be stored in this structure from it's creation to it's effective display. Subtitle type and flags should only be modified by the output thread. Note that an empty subtitle MUST have its flags set to 0.