subpicture_t Struct Reference

Video subtitle. More...

#include <vlc_subpicture.h>

Collaboration diagram for subpicture_t:

Data Fields
vlc_spu_regions	regions
	region list composing this subtitle
subpicture_updater_t	updater
subpicture_private_t *	p_private
Channel ID
ssize_t	i_channel
	subpicture channel ID
Type and flags
Should NOT be modified except by the vout thread
int64_t	i_order
subpicture_t *	p_next
	an increasing unique number
Date properties
vlc_tick_t	i_start
	beginning of display date
vlc_tick_t	i_stop
	end of display date.
bool	b_ephemer
	If this flag is set to true the subtitle will be displayed until the next one appears or if i_stop is reached when it is valid.
bool	b_fade
	enable fading
bool	b_subtitle
	subtitle with timestamps relative to the video
Display properties
These properties are only indicative and may be changed by the video output thread, or simply ignored depending of the subtitle type.
unsigned	i_original_picture_width
	original width of the movie
unsigned	i_original_picture_height
	original height of the movie
int	i_alpha
	transparency

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.

Field Documentation

b_ephemer

bool subpicture_t::b_ephemer

If this flag is set to true the subtitle will be displayed until the next one appears or if i_stop is reached when it is valid.

Referenced by OSDWidget(), spu_PutSubpicture(), vlc_input_decoder_AddVoutOverlay(), vout_OSDEpg(), vout_OSDText(), and VoutSnapshotPip().

b_fade

bool subpicture_t::b_fade

enable fading

Referenced by OSDWidget(), SpuRenderRegion(), subpicture_New(), vout_OSDEpg(), vout_OSDText(), and VoutSnapshotPip().

b_subtitle

bool subpicture_t::b_subtitle

subtitle with timestamps relative to the video

Referenced by decoder_NewSubpicture(), IsSubpicInVideo(), spu_PrerenderThread(), spu_Render(), SpuRenderRegion(), SpuRenderSubpictures(), subpicture_New(), subtitles_positions_AddRegion(), subtitles_positions_FindRegion(), and vout_OSDEpg().

i_alpha

int subpicture_t::i_alpha

transparency

Referenced by SpuRenderRegion(), and subpicture_New().

i_channel

ssize_t subpicture_t::i_channel

subpicture channel ID

Referenced by ModuleThread_NewSpuBuffer(), OSDWidget(), spu_PutSubpicture(), spu_render_entry_IsSelected(), SpuRenderCmp(), sub_new_buffer(), vlc_input_decoder_AddVoutOverlay(), vout_OSDEpg(), vout_OSDText(), and VoutSnapshotPip().

i_order

int64_t subpicture_t::i_order

Referenced by ModuleThread_NewSpuBuffer(), spu_channel_EarlyRemoveLate(), SpuRenderCmp(), SpuRenderSubpictures(), subpicture_New(), and vlc_input_decoder_AddVoutOverlay().

i_original_picture_height

unsigned subpicture_t::i_original_picture_height

original height of the movie

Referenced by OSDEpgUpdate(), OSDTextUpdate(), OSDWidgetUpdate(), spu_PrerenderText(), spu_UpdateOriginalSize(), SpuRegionPlace(), SpuRenderSubpictures(), subpicture_NewFromPicture(), and VoutSnapshotPip().

i_original_picture_width

unsigned subpicture_t::i_original_picture_width

original width of the movie

Referenced by OSDEpgUpdate(), OSDTextUpdate(), OSDWidgetUpdate(), spu_PrerenderText(), spu_UpdateOriginalSize(), SpuRegionPlace(), SpuRenderSubpictures(), subpicture_NewFromPicture(), and VoutSnapshotPip().

i_start

vlc_tick_t subpicture_t::i_start

beginning of display date

Referenced by ModuleThread_PlaySpu(), ModuleThread_QueueSpu(), OSDWidget(), spu_channel_Push(), spu_PrerenderThread(), spu_PutSubpicture(), spu_Render(), SpuRenderCmp(), SpuRenderRegion(), vlc_input_decoder_AddVoutOverlay(), vout_OSDEpg(), vout_OSDText(), and VoutSnapshotPip().

i_stop

vlc_tick_t subpicture_t::i_stop

end of display date.

Will be considered invalid if set to TICK_INVALID or less than i_start. See b_ephemer

Referenced by ModuleThread_QueueSpu(), OSDWidget(), spu_channel_Push(), spu_PutSubpicture(), spu_Render(), SpuRenderRegion(), vlc_input_decoder_AddVoutOverlay(), vout_OSDEpg(), vout_OSDText(), and VoutSnapshotPip().

p_next

subpicture_t* subpicture_t::p_next

an increasing unique number

next subtitle to be displayed

Referenced by decoder_QueueSub().

p_private

subpicture_private_t* subpicture_t::p_private

Referenced by subpicture_Delete(), subpicture_New(), and subpicture_Update().

regions

vlc_spu_regions subpicture_t::regions

region list composing this subtitle

Referenced by IsSubpicInVideo(), OSDEpgUpdate(), OSDTextUpdate(), OSDWidgetUpdate(), spu_PrerenderText(), spu_PutSubpicture(), SpuRenderSubpictures(), subpicture_Delete(), subpicture_New(), and subpicture_NewFromPicture().

updater

subpicture_updater_t subpicture_t::updater

Referenced by OSDEpgDestroy(), OSDEpgUpdate(), OSDTextDestroy(), OSDTextUpdate(), OSDWidgetDestroy(), OSDWidgetUpdate(), subpicture_Delete(), subpicture_New(), and subpicture_Update().

---

The documentation for this struct was generated from the following file:

• include/vlc_subpicture.h