VLC 4.0.0-dev
Loading...
Searching...
No Matches

Video subtitle. More...

#include <vlc_subpicture.h>

Collaboration diagram for subpicture_t:
[legend]

Data Fields

vlc_spu_regions regions
 region list composing this subtitle
 
subpicture_updater_t updater
 
subpicture_private_tp_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_tp_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
 
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
 
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_absolute

◆ 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

◆ b_subtitle

◆ i_alpha

int subpicture_t::i_alpha

transparency

Referenced by SpuRenderRegion(), and subpicture_New().

◆ i_channel

◆ i_order

◆ i_original_picture_height

unsigned subpicture_t::i_original_picture_height

◆ i_original_picture_width

◆ i_start

◆ 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

◆ regions

◆ updater


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