subpicture_t Struct Reference [Video Subpictures]

Video subtitle. More...

Collaboration diagram for subpicture_t:

Data Fields
subpicture_region_t *	p_region
	region list composing this subtitle
subpicture_updater_t	updater
subpicture_private_t *	p_private
Channel ID
int	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
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
Display properties
These properties are only indicative and may be changed by the video output thread, or simply ignored depending of the subtitle type.
bool	b_subtitle
	the picture is a movie subtitle
bool	b_absolute
	position is absolute
int	i_original_picture_width
	original width of the movie
int	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

bool subpicture_t::b_absolute

position is absolute

Referenced by osd_ShowTextAbsolute(), OSDTextUpdate(), OSDWidget(), picture_BlendSubpicture(), SpuRegionPlace(), SpuRenderRegion(), SpuRenderSubpictures(), subpicture_New(), SubpictureCmp(), vout_OSDEpg(), and vout_OSDText().

bool subpicture_t::b_ephemer

If this flag is set to true the subtitle will be displayed untill the next one appear.

Referenced by osd_ShowTextAbsolute(), OSDWidget(), SpuSelectSubpictures(), vout_OSDEpg(), vout_OSDText(), and VoutSnapshotPip().

bool subpicture_t::b_fade

enable fading

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

bool subpicture_t::b_subtitle

the picture is a movie subtitle

Referenced by spu_new_buffer(), spu_OffsetSubtitleDate(), spu_Render(), SpuRenderRegion(), SpuRenderSubpictures(), SpuSelectSubpictures(), and subpicture_New().

int subpicture_t::i_alpha

transparency

Referenced by picture_BlendSubpicture(), SpuRenderRegion(), and subpicture_New().

int subpicture_t::i_channel

subpicture channel ID

Referenced by osd_ShowTextAbsolute(), OSDWidget(), spu_ClearChannel(), spu_new_buffer(), spu_PutSubpicture(), SpuSelectSubpictures(), sub_new_buffer(), SubpictureCmp(), vout_OSDEpg(), vout_OSDText(), and VoutSnapshotPip().

int64_t subpicture_t::i_order

Referenced by spu_new_buffer(), SpuSelectSubpictures(), subpicture_New(), and SubpictureCmp().

int subpicture_t::i_original_picture_height

original height of the movie

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

int subpicture_t::i_original_picture_width

original width of the movie

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

mtime_t subpicture_t::i_start

beginning of display date

Referenced by DecoderPlaySpu(), DecoderProcessSpu(), osd_ShowTextAbsolute(), OSDWidget(), spu_OffsetSubtitleDate(), SpuRenderRegion(), SpuSelectSubpictures(), SubpictureCmp(), vout_OSDEpg(), vout_OSDText(), and VoutSnapshotPip().

mtime_t subpicture_t::i_stop

end of display date

Referenced by DecoderPlaySpu(), DecoderProcessSpu(), osd_ShowTextAbsolute(), OSDWidget(), spu_OffsetSubtitleDate(), SpuRenderRegion(), SpuSelectSubpictures(), vout_OSDEpg(), vout_OSDText(), and VoutSnapshotPip().

subpicture_t* subpicture_t::p_next

an increasing unique number

next subtitle to be displayed

Referenced by DecoderFlushBuffering(), and DecoderPlaySpu().

subpicture_private_t* subpicture_t::p_private

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

subpicture_region_t* subpicture_t::p_region

region list composing this subtitle

Referenced by osd_ShowTextAbsolute(), OSDEpgUpdate(), OSDTextUpdate(), OSDWidgetUpdate(), picture_BlendSubpicture(), spu_PutSubpicture(), SpuRenderSubpictures(), subpicture_Delete(), subpicture_New(), subpicture_NewFromPicture(), and subpicture_Update().

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