vlc_subpicture.h 6.72 KB
 Laurent Aimar committed May 16, 2009 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 ``````/***************************************************************************** * vlc_subpicture.h: subpicture definitions ***************************************************************************** * Copyright (C) 1999 - 2009 the VideoLAN team * \$Id\$ * * Authors: Vincent Seguin * Samuel Hocevar * Olivier Aubert * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ #ifndef VLC_SUBPICTURE_H #define VLC_SUBPICTURE_H 1 /** * \file * This file defines subpicture structures and functions in vlc */ #include /** * \defgroup subpicture Video Subpictures * Subpictures are pictures that should be displayed on top of the video, like * subtitles and OSD * \ingroup video_output * @{ */ /** * Video subtitle region spu core private */ typedef struct subpicture_region_private_t subpicture_region_private_t; /** * Video subtitle region * * A subtitle region is defined by a picture (graphic) and its rendering * coordinates. * Subtitles contain a list of regions. */ struct subpicture_region_t { video_format_t fmt; /**< format of the picture */ picture_t *p_picture; /**< picture comprising this region */ int i_x; /**< position of region */ int i_y; /**< position of region */ int i_align; /**< alignment within a region */ int i_alpha; /**< transparency */ char *psz_text; /**< text string comprising this region */ char *psz_html; /**< HTML version of subtitle (NULL = use psz_text) */ text_style_t *p_style; /**< a description of the text style formatting */ subpicture_region_t *p_next; /**< next region in the list */ subpicture_region_private_t *p_private; /**< Private data for spu_t *only* */ }; /* Subpicture region position flags */ #define SUBPICTURE_ALIGN_LEFT 0x1 #define SUBPICTURE_ALIGN_RIGHT 0x2 #define SUBPICTURE_ALIGN_TOP 0x4 #define SUBPICTURE_ALIGN_BOTTOM 0x8 #define SUBPICTURE_ALIGN_MASK ( SUBPICTURE_ALIGN_LEFT|SUBPICTURE_ALIGN_RIGHT| \ SUBPICTURE_ALIGN_TOP |SUBPICTURE_ALIGN_BOTTOM ) /** * This function will create a new subpicture region. * * You must use subpicture_region_Delete to destroy it. */ VLC_EXPORT( subpicture_region_t *, subpicture_region_New, ( const video_format_t *p_fmt ) ); /** * This function will destroy a subpicture region allocated by * subpicture_region_New. * * You may give it NULL. */ VLC_EXPORT( void, subpicture_region_Delete, ( subpicture_region_t *p_region ) ); /** * This function will destroy a list of subpicture regions allocated by * subpicture_region_New. * * Provided for convenience. */ VLC_EXPORT( void, subpicture_region_ChainDelete, ( subpicture_region_t *p_head ) ); /** * 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. */ struct subpicture_t { /** \name Channel ID */ /**@{*/ int i_channel; /**< subpicture channel ID */ /**@}*/ /** \name Type and flags Should NOT be modified except by the vout thread */ /**@{*/ int64_t i_order; /** an increasing unique number */ subpicture_t * p_next; /**< next subtitle to be displayed */ /**@}*/ `````` Rémi Duraffort committed Dec 28, 2009 127 128 `````` subpicture_region_t *p_region; /**< region list composing this subtitle */ `````` Laurent Aimar committed May 16, 2009 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 `````` /** \name Date properties */ /**@{*/ mtime_t i_start; /**< beginning of display date */ mtime_t i_stop; /**< end of display date */ bool b_ephemer; /**< If this flag is set to true the subtitle will be displayed untill the next one appear */ bool b_fade; /**< enable fading */ /**@}*/ /** \name 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 */ `````` Rémi Duraffort committed Dec 28, 2009 145 146 `````` int i_original_picture_width; /**< original width of the movie */ int i_original_picture_height;/**< original height of the movie */ `````` Laurent Aimar committed May 16, 2009 147 148 149 150 151 152 `````` int i_alpha; /**< transparency */ /**@}*/ /** Pointer to function that cleans up the private data of this subtitle */ void ( *pf_destroy ) ( subpicture_t * ); `````` Laurent Aimar committed Jul 28, 2009 153 `````` /** Pointer to function that update the regions before rendering (optionnal) */ `````` Laurent Aimar committed May 16, 2009 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 `````` void (*pf_update_regions)( spu_t *, subpicture_t *, const video_format_t *, mtime_t ); /** Private data - the subtitle plugin might want to put stuff here to * keep track of the subpicture */ subpicture_sys_t *p_sys; /* subpicture data */ }; /** * This function create a new empty subpicture. * * You must use subpicture_Delete to destroy it. */ VLC_EXPORT( subpicture_t *, subpicture_New, ( void ) ); /** * This function delete a subpicture created by subpicture_New. * You may give it NULL. */ VLC_EXPORT( void, subpicture_Delete, ( subpicture_t *p_subpic ) ); `````` Laurent Aimar committed May 31, 2009 176 177 178 179 180 181 182 183 184 ``````/** * This function will create a subpicture having one region in the requested * chroma showing the given picture. * * The picture_t given is not released nor used inside the * returned subpicture_t. */ VLC_EXPORT( subpicture_t *, subpicture_NewFromPicture, ( vlc_object_t *, picture_t *, vlc_fourcc_t i_chroma ) ); `````` Laurent Aimar committed May 16, 2009 185 186 187 ``````/**@}*/ #endif /* _VLC_VIDEO_H */``````