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
32 #include <vlc_picture.h>
33 #include <vlc_text_style.h>
36 * \defgroup subpicture Video sub-pictures
37 * \ingroup video_output
38 * Subpictures are pictures that should be displayed on top of the video, like
42 * Subpictures functions
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, relative to alignment */
63 int i_y
; /**< position of region, relative to alignment */
64 int i_align
; /**< alignment flags of region and content */
65 int i_alpha
; /**< transparency */
67 text_segment_t
*p_text
; /**< subtitle text, made of a list of segments */
68 bool b_noregionbg
; /**< render background under text only */
69 bool b_gridmode
; /** if the decoder sends row/cols based output */
70 int i_max_width
; /** horizontal rendering/cropping limit */
71 int i_max_height
; /** vertical rendering/cropping limit */
73 subpicture_region_t
*p_next
; /**< next region in the list */
74 subpicture_region_private_t
*p_private
; /**< Private data for spu_t *only* */
77 /* Subpicture region position flags */
78 #define SUBPICTURE_ALIGN_LEFT 0x1
79 #define SUBPICTURE_ALIGN_RIGHT 0x2
80 #define SUBPICTURE_ALIGN_TOP 0x4
81 #define SUBPICTURE_ALIGN_BOTTOM 0x8
82 #define SUBPICTURE_ALIGN_LEAVETEXT 0x10 /**< Align the subpicture, but not the text inside */
83 #define SUBPICTURE_ALIGN_MASK ( SUBPICTURE_ALIGN_LEFT|SUBPICTURE_ALIGN_RIGHT| \
84 SUBPICTURE_ALIGN_TOP |SUBPICTURE_ALIGN_BOTTOM| \
85 SUBPICTURE_ALIGN_LEAVETEXT )
87 * This function will create a new subpicture region.
89 * You must use subpicture_region_Delete to destroy it.
91 VLC_API subpicture_region_t
* subpicture_region_New( const video_format_t
*p_fmt
);
94 * This function will destroy a subpicture region allocated by
95 * subpicture_region_New.
97 * You may give it NULL.
99 VLC_API
void subpicture_region_Delete( subpicture_region_t
*p_region
);
102 * This function will destroy a list of subpicture regions allocated by
103 * subpicture_region_New.
105 * Provided for convenience.
107 VLC_API
void subpicture_region_ChainDelete( subpicture_region_t
*p_head
);
110 * This function will copy a subpicture region to a new allocated one
111 * and transfer all the properties
113 * Provided for convenience.
115 VLC_API subpicture_region_t
*subpicture_region_Copy( subpicture_region_t
*p_region
);
120 typedef struct subpicture_updater_sys_t subpicture_updater_sys_t
;
123 /** Optional pre update callback, usually useful on video format change.
124 * Will skip pf_update on VLC_SUCCESS, or will delete every region before
125 * the call to pf_update */
126 int (*pf_validate
)( subpicture_t
*,
127 bool has_src_changed
, const video_format_t
*p_fmt_src
,
128 bool has_dst_changed
, const video_format_t
*p_fmt_dst
,
130 /** Mandatory callback called after pf_validate and doing
131 * the main job of creating the subpicture regions for the
132 * current video_format */
133 void (*pf_update
) ( subpicture_t
*,
134 const video_format_t
*p_fmt_src
,
135 const video_format_t
*p_fmt_dst
,
137 /** Optional callback for subpicture private data cleanup */
138 void (*pf_destroy
) ( subpicture_t
* );
139 subpicture_updater_sys_t
*p_sys
;
140 } subpicture_updater_t
;
142 typedef struct subpicture_private_t subpicture_private_t
;
147 * Any subtitle destined to be displayed by a video output thread should
148 * be stored in this structure from it's creation to it's effective display.
149 * Subtitle type and flags should only be modified by the output thread. Note
150 * that an empty subtitle MUST have its flags set to 0.
154 /** \name Channel ID */
156 int i_channel
; /**< subpicture channel ID */
159 /** \name Type and flags
160 Should NOT be modified except by the vout thread */
162 int64_t i_order
; /** an increasing unique number */
163 subpicture_t
* p_next
; /**< next subtitle to be displayed */
166 subpicture_region_t
*p_region
; /**< region list composing this subtitle */
168 /** \name Date properties */
170 mtime_t i_start
; /**< beginning of display date */
171 mtime_t i_stop
; /**< end of display date */
172 bool b_ephemer
; /**< If this flag is set to true the subtitle
173 will be displayed until the next one appear */
174 bool b_fade
; /**< enable fading */
177 /** \name Display properties
178 * These properties are only indicative and may be
179 * changed by the video output thread, or simply ignored depending of the
182 bool b_subtitle
; /**< the picture is a movie subtitle */
183 bool b_absolute
; /**< position is absolute */
184 int i_original_picture_width
; /**< original width of the movie */
185 int i_original_picture_height
;/**< original height of the movie */
186 int i_alpha
; /**< transparency */
189 subpicture_updater_t updater
;
191 subpicture_private_t
*p_private
; /* Reserved to the core */
195 * This function create a new empty subpicture.
197 * You must use subpicture_Delete to destroy it.
199 VLC_API subpicture_t
* subpicture_New( const subpicture_updater_t
* );
202 * This function delete a subpicture created by subpicture_New.
203 * You may give it NULL.
205 VLC_API
void subpicture_Delete( subpicture_t
*p_subpic
);
208 * This function will create a subpicture having one region in the requested
209 * chroma showing the given picture.
211 * The picture_t given is not released nor used inside the
212 * returned subpicture_t.
214 VLC_API subpicture_t
* subpicture_NewFromPicture( vlc_object_t
*, picture_t
*, vlc_fourcc_t i_chroma
);
217 * This function will update the content of a subpicture created with
218 * a non NULL subpicture_updater_t.
220 VLC_API
void subpicture_Update( subpicture_t
*, const video_format_t
*src
, const video_format_t
*, mtime_t
);
223 * This function will blend a given subpicture onto a picture.
225 * The subpicture and all its region must:
228 * - not have the fade flag.
229 * - contains only picture (no text rendering).
230 * \return the number of region(s) successfully blent
232 VLC_API
unsigned picture_BlendSubpicture( picture_t
*, filter_t
*p_blend
, subpicture_t
* );
236 #endif /* _VLC_VIDEO_H */