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

Subpictures are pictures that should be displayed on top of the video, like subtitles and OSD. More...

Collaboration diagram for Video sub-pictures:

Files

file  vlc_subpicture.h
 Subpictures functions.
 

Data Structures

struct  subpicture_region_t
 Video subtitle region. More...
 
struct  vlc_spu_highlight_t
 
struct  vlc_spu_updater_ops
 Subpicture updater operation virtual table. More...
 
struct  subpicture_updater_t
 
struct  vlc_render_subpicture
 
struct  subpicture_t
 Video subtitle. More...
 

Macros

#define VLC_SUBPIC_TEXT_FLAG_NO_REGION_BG   (1 << 4)
 
#define VLC_SUBPIC_TEXT_FLAG_GRID_MODE   (1 << 5)
 if the decoder sends row/cols based output
 
#define VLC_SUBPIC_TEXT_FLAG_TEXT_NOT_BALANCED   (1 << 6)
 don't try to balance wrapped text lines
 
#define VLC_SUBPIC_TEXT_FLAG_IS_TEXT   (1 << 7)
 mark the subpicture region as a text flag
 
#define vlc_spu_regions_init(p_rs)    vlc_list_init((p_rs))
 
#define vlc_spu_regions_push(p_rs, reg)    vlc_list_append(&(reg)->node, (p_rs))
 
#define vlc_spu_regions_foreach(reg, p_rs)    vlc_list_foreach(reg, (p_rs), node)
 
#define vlc_spu_regions_foreach_const(reg, p_rs)    vlc_list_foreach_const(reg, (p_rs), node)
 
#define vlc_spu_regions_is_empty(p_rs)    vlc_list_is_empty((p_rs))
 
#define vlc_spu_regions_first_or_null(p_rs)    vlc_list_first_entry_or_null((p_rs), subpicture_region_t, node)
 
#define vlc_spu_regions_remove(p_rs, reg)    vlc_list_remove(&(reg)->node)
 
#define SUBPICTURE_ALIGN_LEFT   0x1
 
#define SUBPICTURE_ALIGN_RIGHT   0x2
 
#define SUBPICTURE_ALIGN_TOP   0x4
 
#define SUBPICTURE_ALIGN_BOTTOM   0x8
 
#define SUBPICTURE_ALIGN_MASK
 
#define subpicture_region_IsText(r)    (((r)->text_flags & VLC_SUBPIC_TEXT_FLAG_IS_TEXT) != 0)
 Tells if the region is a text-based region.
 

Typedefs

typedef struct subpicture_region_private_t subpicture_region_private_t
 Video subtitle region spu core private.
 
typedef struct vlc_spu_highlight_t vlc_spu_highlight_t
 
typedef struct filter_t vlc_blender_t
 render background under text only
 
typedef struct vlc_list vlc_spu_regions
 
typedef struct subpicture_private_t subpicture_private_t
 
typedef struct vlc_render_subpicture vlc_render_subpicture
 

Functions

subpicture_region_tsubpicture_region_New (const video_format_t *p_fmt)
 This function will create a new subpicture region.
 
subpicture_region_tsubpicture_region_NewText (void)
 This function will create a new text subpicture region.
 
subpicture_region_tsubpicture_region_ForPicture (const video_format_t *p_fmt, picture_t *pic)
 Create a subpicture region containing the picture.
 
void subpicture_region_Delete (subpicture_region_t *p_region)
 This function will destroy a subpicture region allocated by subpicture_region_New.
 
void vlc_spu_regions_Clear (vlc_spu_regions *)
 This function will clear a list of subpicture regions allocated by subpicture_region_New.
 
subpicture_tsubpicture_New (const subpicture_updater_t *)
 This function create a new empty subpicture.
 
void subpicture_Delete (subpicture_t *p_subpic)
 This function delete a subpicture created by subpicture_New.
 
subpicture_tsubpicture_NewFromPicture (vlc_object_t *, picture_t *, vlc_fourcc_t i_chroma)
 This function will create a subpicture having one region in the requested chroma showing the given picture.
 
void subpicture_Update (subpicture_t *, const video_format_t *src, const video_format_t *, vlc_tick_t)
 This function will update the content of a subpicture created with a non NULL subpicture_updater_t.
 
unsigned picture_BlendSubpicture (picture_t *, vlc_blender_t *, vlc_render_subpicture *)
 This function will blend a given subpicture onto a picture.
 
vlc_render_subpicturevlc_render_subpicture_New (void)
 Create a vlc_render_subpicture.
 
void vlc_render_subpicture_Delete (vlc_render_subpicture *)
 Destroy a vlc_render_subpicture.
 

Detailed Description

Subpictures are pictures that should be displayed on top of the video, like subtitles and OSD.

Macro Definition Documentation

◆ SUBPICTURE_ALIGN_BOTTOM

#define SUBPICTURE_ALIGN_BOTTOM   0x8

◆ SUBPICTURE_ALIGN_LEFT

#define SUBPICTURE_ALIGN_LEFT   0x1

◆ SUBPICTURE_ALIGN_MASK

#define SUBPICTURE_ALIGN_MASK
Value:
#define SUBPICTURE_ALIGN_TOP
Definition vlc_subpicture.h:121
#define SUBPICTURE_ALIGN_LEFT
Definition vlc_subpicture.h:119
#define SUBPICTURE_ALIGN_RIGHT
Definition vlc_subpicture.h:120
#define SUBPICTURE_ALIGN_BOTTOM
Definition vlc_subpicture.h:122

◆ SUBPICTURE_ALIGN_RIGHT

#define SUBPICTURE_ALIGN_RIGHT   0x2

◆ SUBPICTURE_ALIGN_TOP

#define SUBPICTURE_ALIGN_TOP   0x4

◆ subpicture_region_IsText

#define subpicture_region_IsText (   r)     (((r)->text_flags & VLC_SUBPIC_TEXT_FLAG_IS_TEXT) != 0)

Tells if the region is a text-based region.

◆ vlc_spu_regions_first_or_null

#define vlc_spu_regions_first_or_null (   p_rs)     vlc_list_first_entry_or_null((p_rs), subpicture_region_t, node)

◆ vlc_spu_regions_foreach

#define vlc_spu_regions_foreach (   reg,
  p_rs 
)     vlc_list_foreach(reg, (p_rs), node)

◆ vlc_spu_regions_foreach_const

#define vlc_spu_regions_foreach_const (   reg,
  p_rs 
)     vlc_list_foreach_const(reg, (p_rs), node)

◆ vlc_spu_regions_init

#define vlc_spu_regions_init (   p_rs)     vlc_list_init((p_rs))

◆ vlc_spu_regions_is_empty

#define vlc_spu_regions_is_empty (   p_rs)     vlc_list_is_empty((p_rs))

◆ vlc_spu_regions_push

#define vlc_spu_regions_push (   p_rs,
  reg 
)     vlc_list_append(&(reg)->node, (p_rs))

◆ vlc_spu_regions_remove

#define vlc_spu_regions_remove (   p_rs,
  reg 
)     vlc_list_remove(&(reg)->node)

◆ VLC_SUBPIC_TEXT_FLAG_GRID_MODE

#define VLC_SUBPIC_TEXT_FLAG_GRID_MODE   (1 << 5)

if the decoder sends row/cols based output

◆ VLC_SUBPIC_TEXT_FLAG_IS_TEXT

#define VLC_SUBPIC_TEXT_FLAG_IS_TEXT   (1 << 7)

mark the subpicture region as a text flag

◆ VLC_SUBPIC_TEXT_FLAG_NO_REGION_BG

#define VLC_SUBPIC_TEXT_FLAG_NO_REGION_BG   (1 << 4)

◆ VLC_SUBPIC_TEXT_FLAG_TEXT_NOT_BALANCED

#define VLC_SUBPIC_TEXT_FLAG_TEXT_NOT_BALANCED   (1 << 6)

don't try to balance wrapped text lines

Typedef Documentation

◆ subpicture_private_t

◆ subpicture_region_private_t

Video subtitle region spu core private.

◆ vlc_blender_t

typedef struct filter_t vlc_blender_t

render background under text only

◆ vlc_render_subpicture

◆ vlc_spu_highlight_t

◆ vlc_spu_regions

typedef struct vlc_list vlc_spu_regions

Function Documentation

◆ picture_BlendSubpicture()

◆ subpicture_Delete()

◆ subpicture_New()

◆ subpicture_NewFromPicture()

◆ subpicture_region_Delete()

void subpicture_region_Delete ( subpicture_region_t p_region)

◆ subpicture_region_ForPicture()

subpicture_region_t * subpicture_region_ForPicture ( const video_format_t p_fmt,
picture_t pic 
)

Create a subpicture region containing the picture.

A reference will be added to the picture on success.

You must use subpicture_region_Delete to destroy it.

The chroma of the format must match the one of the picture. The dimensions of the format should not exceed the ones of the picture. This is not checked explicitly in the function.

Parameters
p_fmtformat for the subpicture cropping/SAR (may be NULL)
Note
if p_fmt is NULL, the format of the picture will be used.

References subpicture_region_t::fmt, picture_t::format, video_format_t::i_chroma, video_format_t::p_palette, subpicture_region_t::p_picture, picture_Hold(), subpicture_region_NewInternal(), video_format_Clean(), video_format_Copy(), video_format_IsSameChroma(), VLC_CODEC_RGBP, and VLC_CODEC_YUVP.

Referenced by spuregion_CreateFromPicture(), SpuRenderRegion(), and subpicture_NewFromPicture().

◆ subpicture_region_New()

◆ subpicture_region_NewText()

subpicture_region_t * subpicture_region_NewText ( void  )

This function will create a new text subpicture region.

You must use subpicture_region_Delete to destroy it.

References subpicture_region_t::fmt, subpicture_region_NewInternal(), subpicture_region_t::text_flags, video_format_Init(), and VLC_SUBPIC_TEXT_FLAG_IS_TEXT.

Referenced by OSDTextUpdate(), and vout_OSDTextRegion().

◆ subpicture_Update()

void subpicture_Update ( subpicture_t p_subpicture,
const video_format_t src,
const video_format_t p_fmt_dst,
vlc_tick_t  i_ts 
)

◆ vlc_render_subpicture_Delete()

void vlc_render_subpicture_Delete ( vlc_render_subpicture p_subpic)

◆ vlc_render_subpicture_New()

◆ vlc_spu_regions_Clear()

void vlc_spu_regions_Clear ( vlc_spu_regions regions)

This function will clear a list of subpicture regions allocated by subpicture_region_New.

Provided for convenience.

References subpicture_region_Delete(), vlc_spu_regions_foreach, and vlc_spu_regions_remove.

Referenced by OSDEpgUpdate(), OSDTextUpdate(), OSDWidgetUpdate(), subpicture_Delete(), and vlc_render_subpicture_Delete().