subpicture_t Struct Reference
[Video Subpictures]

#include <vlc_video.h>

List of all members.

Public Attributes
subpicture_region_t *	p_region
void(*	pf_render )(vout_thread_t *, picture_t *, const subpicture_t *)
void(*	pf_destroy )(subpicture_t *)
subpicture_region_t *(*	pf_create_region )(vlc_object_t *, video_format_t *)
subpicture_sys_t *	p_sys
Channel ID
*int	i_channel
Type and flags
Should NOT be modified except by the vout thread
*int	i_type
int	i_status
subpicture_t *	p_next
Date properties
*mtime_t	i_start
mtime_t	i_stop
vlc_bool_t	b_ephemer
vlc_bool_t	b_fade
Display properties
These properties are only indicative and may be changed by the video output thread, or simply ignored depending of the subtitle type.
*int	i_x
int	i_y
int	i_width
int	i_height
int	i_alpha
int	i_original_picture_width
int	i_original_picture_height
vlc_bool_t	b_absolute
int	i_flags

---

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.

Definition at line 229 of file vlc_video.h.

---

Member Data Documentation

vlc_bool_t subpicture_t::b_absolute

position is absolute Definition at line 267 of file vlc_video.h.

vlc_bool_t subpicture_t::b_ephemer

If this flag is set to true the subtitle will be displayed untill the next one appear Definition at line 248 of file vlc_video.h.

vlc_bool_t subpicture_t::b_fade

enable fading Definition at line 250 of file vlc_video.h.

int subpicture_t::i_alpha

transparency Definition at line 264 of file vlc_video.h.

* int subpicture_t::i_channel

subpicture channel ID Definition at line 233 of file vlc_video.h.

int subpicture_t::i_flags

position flags Definition at line 268 of file vlc_video.h.

int subpicture_t::i_height

picture height Definition at line 263 of file vlc_video.h.

int subpicture_t::i_original_picture_height

original height of the movie Definition at line 266 of file vlc_video.h.

int subpicture_t::i_original_picture_width

original width of the movie Definition at line 265 of file vlc_video.h.

* mtime_t subpicture_t::i_start

beginning of display date Definition at line 246 of file vlc_video.h.

int subpicture_t::i_status

flags Definition at line 240 of file vlc_video.h.

mtime_t subpicture_t::i_stop

end of display date Definition at line 247 of file vlc_video.h.

* int subpicture_t::i_type

type Definition at line 239 of file vlc_video.h.

int subpicture_t::i_width

picture width Definition at line 262 of file vlc_video.h.

* int subpicture_t::i_x

offset from alignment position Definition at line 260 of file vlc_video.h.

int subpicture_t::i_y

offset from alignment position Definition at line 261 of file vlc_video.h.

subpicture_t* subpicture_t::p_next

next subtitle to be displayed Definition at line 241 of file vlc_video.h.

subpicture_region_t* subpicture_t::p_region

region list composing this subtitle Definition at line 253 of file vlc_video.h.

subpicture_sys_t* subpicture_t::p_sys

Private data - the subtitle plugin might want to put stuff here to keep track of the subpicture Definition at line 285 of file vlc_video.h.

subpicture_region_t*( * subpicture_t::pf_create_region)(vlc_object_t *, video_format_t *)

Pointer to functions for region management

void( * subpicture_t::pf_destroy)(subpicture_t *)

Pointer to function that cleans up the private data of this subtitle

void( * subpicture_t::pf_render)(vout_thread_t *, picture_t *, const subpicture_t *)

Pointer to function that renders this subtitle in a picture

---

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

• /home/huihoo/src/vlc/vlc-0.8.4a/include/vlc_video.h

---