VLC 4.0.0-dev
Data Fields
subpicture_t Struct Reference
VLC plug-in programming interface » Output » Video output » Video sub-pictures

Video subtitle. More...

#include <vlc_subpicture.h>

Collaboration diagram for subpicture_t:
[legend]

Data Fields

subpicture_region_t * p_region
 region list composing this subtitle More...
 
subpicture_updater_t updater
 
subpicture_private_t * p_private
 
Channel ID
ssize_t i_channel
 subpicture channel ID More...
 
Type and flags

Should NOT be modified except by the vout thread

int64_t i_order
 
subpicture_t * p_next
 an increasing unique number More...
 
Date properties
vlc_tick_t i_start
 beginning of display date More...
 
vlc_tick_t i_stop
 end of display date More...
 
bool b_ephemer
 If this flag is set to true the subtitle will be displayed until the next one appear. More...
 
bool b_fade
 enable fading More...
 
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 More...
 
bool b_absolute
 position is absolute More...
 
int i_original_picture_width
 original width of the movie More...
 
int i_original_picture_height
 original height of the movie More...
 
int i_alpha
 transparency More...
 

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_absolute

bool subpicture_t::b_absolute

position is absolute

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

◆ b_ephemer

bool subpicture_t::b_ephemer

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

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

◆ b_fade

bool subpicture_t::b_fade

enable fading

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

◆ b_subtitle

bool subpicture_t::b_subtitle

the picture is a movie subtitle

Referenced by ModuleThread_NewSpuBuffer(), spu_PrerenderText(), spu_Render(), spu_render_entry_IsSelected(), SpuRenderRegion(), SpuRenderSubpictures(), subpicture_New(), and vout_OSDEpg().

◆ i_alpha

int subpicture_t::i_alpha

transparency

Referenced by picture_BlendSubpicture(), 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(), SpuRenderCmp(), SpuRenderSubpictures(), subpicture_New(), and vlc_input_decoder_AddVoutOverlay().

◆ i_original_picture_height

int subpicture_t::i_original_picture_height

original height of the movie

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

◆ i_original_picture_width

int subpicture_t::i_original_picture_width

original width of the movie

Referenced by OSDEpgUpdate(), OSDTextUpdate(), OSDWidgetUpdate(), spu_PrerenderText(), 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_PrerenderText(), spu_PrerenderThread(), spu_PutSubpicture(), 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

Referenced by ModuleThread_QueueSpu(), OSDWidget(), spu_channel_Push(), spu_PutSubpicture(), 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().

◆ p_region

subpicture_region_t* subpicture_t::p_region

region list composing this subtitle

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

◆ updater

subpicture_updater_t subpicture_t::updater

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

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