1 /*****************************************************************************
2 * vlc_subpicture.h: subpicture definitions
3 *****************************************************************************
4 * Copyright (C) 1999 - 2009 VLC authors and VideoLAN
7 * Authors: Vincent Seguin <seguin@via.ecp.fr>
8 * Samuel Hocevar <sam@via.ecp.fr>
9 * Olivier Aubert <oaubert 47 videolan d07 org>
11 * This program is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU Lesser General Public License as published by
13 * the Free Software Foundation; either version 2.1 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU Lesser General Public License for more details.
21 * You should have received a copy of the GNU Lesser General Public License
22 * along with this program; if not, write to the Free Software Foundation,
23 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
26 #ifndef VLC_SUBPICTURE_H
27 #define VLC_SUBPICTURE_H 1
31 * This file defines subpicture structures and functions in vlc
34 #include <vlc_picture.h>
35 #include <vlc_text_style.h>
38 * \defgroup subpicture Video Subpictures
39 * Subpictures are pictures that should be displayed on top of the video, like
41 * \ingroup video_output
46 * Video subtitle region spu core private
48 typedef struct subpicture_region_private_t subpicture_region_private_t;
51 * Video subtitle region
53 * A subtitle region is defined by a picture (graphic) and its rendering
55 * Subtitles contain a list of regions.
57 struct subpicture_region_t
59 video_format_t fmt; /**< format of the picture */
60 picture_t *p_picture; /**< picture comprising this region */
62 int i_x; /**< position of region */
63 int i_y; /**< position of region */
64 int i_align; /**< alignment within a region */
65 int i_alpha; /**< transparency */
67 char *psz_text; /**< text string comprising this region */
68 char *psz_html; /**< HTML version of subtitle (NULL = use psz_text) */
69 text_style_t *p_style; /**< a description of the text style formatting */
71 subpicture_region_t *p_next; /**< next region in the list */
72 subpicture_region_private_t *p_private; /**< Private data for spu_t *only* */
75 /* Subpicture region position flags */
76 #define SUBPICTURE_ALIGN_LEFT 0x1
77 #define SUBPICTURE_ALIGN_RIGHT 0x2
78 #define SUBPICTURE_ALIGN_TOP 0x4
79 #define SUBPICTURE_ALIGN_BOTTOM 0x8
80 #define SUBPICTURE_ALIGN_LEAVETEXT 0x10 /**< Align the subpicture, but not the text inside */
81 #define SUBPICTURE_ALIGN_MASK ( SUBPICTURE_ALIGN_LEFT|SUBPICTURE_ALIGN_RIGHT| \
82 SUBPICTURE_ALIGN_TOP |SUBPICTURE_ALIGN_BOTTOM| \
83 SUBPICTURE_ALIGN_LEAVETEXT )
85 * This function will create a new subpicture region.
87 * You must use subpicture_region_Delete to destroy it.
89 VLC_API subpicture_region_t * subpicture_region_New( const video_format_t *p_fmt );
92 * This function will destroy a subpicture region allocated by
93 * subpicture_region_New.
95 * You may give it NULL.
97 VLC_API void subpicture_region_Delete( subpicture_region_t *p_region );
100 * This function will destroy a list of subpicture regions allocated by
101 * subpicture_region_New.
103 * Provided for convenience.
105 VLC_API void subpicture_region_ChainDelete( subpicture_region_t *p_head );
110 typedef struct subpicture_updater_sys_t subpicture_updater_sys_t;
113 int (*pf_validate)( subpicture_t *,
114 bool has_src_changed, const video_format_t *p_fmt_src,
115 bool has_dst_changed, const video_format_t *p_fmt_dst,
117 void (*pf_update) ( subpicture_t *,
118 const video_format_t *p_fmt_src,
119 const video_format_t *p_fmt_dst,
121 void (*pf_destroy) ( subpicture_t * );
122 subpicture_updater_sys_t *p_sys;
123 } subpicture_updater_t;
125 typedef struct subpicture_private_t subpicture_private_t;
130 * Any subtitle destined to be displayed by a video output thread should
131 * be stored in this structure from it's creation to it's effective display.
132 * Subtitle type and flags should only be modified by the output thread. Note
133 * that an empty subtitle MUST have its flags set to 0.
137 /** \name Channel ID */
139 int i_channel; /**< subpicture channel ID */
142 /** \name Type and flags
143 Should NOT be modified except by the vout thread */
145 int64_t i_order; /** an increasing unique number */
146 subpicture_t * p_next; /**< next subtitle to be displayed */
149 subpicture_region_t *p_region; /**< region list composing this subtitle */
151 /** \name Date properties */
153 mtime_t i_start; /**< beginning of display date */
154 mtime_t i_stop; /**< end of display date */
155 bool b_ephemer; /**< If this flag is set to true the subtitle
156 will be displayed untill the next one appear */
157 bool b_fade; /**< enable fading */
160 /** \name Display properties
161 * These properties are only indicative and may be
162 * changed by the video output thread, or simply ignored depending of the
165 bool b_subtitle; /**< the picture is a movie subtitle */
166 bool b_absolute; /**< position is absolute */
167 int i_original_picture_width; /**< original width of the movie */
168 int i_original_picture_height;/**< original height of the movie */
169 int i_alpha; /**< transparency */
172 subpicture_updater_t updater;
174 subpicture_private_t *p_private; /* Reserved to the core */
178 * This function create a new empty subpicture.
180 * You must use subpicture_Delete to destroy it.
182 VLC_API subpicture_t * subpicture_New( const subpicture_updater_t * );
185 * This function delete a subpicture created by subpicture_New.
186 * You may give it NULL.
188 VLC_API void subpicture_Delete( subpicture_t *p_subpic );
191 * This function will create a subpicture having one region in the requested
192 * chroma showing the given picture.
194 * The picture_t given is not released nor used inside the
195 * returned subpicture_t.
197 VLC_API subpicture_t * subpicture_NewFromPicture( vlc_object_t *, picture_t *, vlc_fourcc_t i_chroma );
200 * This function will update the content of a subpicture created with
201 * a non NULL subpicture_updater_t.
203 VLC_API void subpicture_Update( subpicture_t *, const video_format_t *src, const video_format_t *, mtime_t );
207 #endif /* _VLC_VIDEO_H */