1 /***************************************************************************** 2 * vlc_text_style.h: text_style_t definition and helpers. 3 ***************************************************************************** 4 * Copyright (C) 1999-2010 VLC authors and VideoLAN 5 * $Id: c24d76adcfedf63514255bb31483acb9325df1b1 $ 6 * 7 * Authors: Derk-Jan Hartman <hartman _AT_ videolan _DOT_ org> 8 * basOS G <noxelia 4t gmail , com> 9 * 10 * This program is free software; you can redistribute it and/or modify it 11 * under the terms of the GNU Lesser General Public License as published by 12 * the Free Software Foundation; either version 2.1 of the License, or 13 * (at your option) any later version. 14 * 15 * This program is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License for more details. 19 * 20 * You should have received a copy of the GNU Lesser General Public License 21 * along with this program; if not, write to the Free Software Foundation, 22 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. 23 *****************************************************************************/ 24 25 #ifndef VLC_TEXT_STYLE_H 26 #define VLC_TEXT_STYLE_H 1 27 28 #ifdef __cplusplus 29 extern "C" { 30 #endif 31 32 /** 33 * Text style 34 * 35 * A text style is used to specify the formatting of text. 36 * A font renderer can use the supplied information to render the 37 * text specified. 38 */ 39 typedef struct 40 { 41 /* Family font names */ 42 char * psz_fontname; /**< The name of the font */ 43 char * psz_monofontname; /**< The name of the mono font */ 44 45 uint16_t i_features; /**< Feature flags (means non default) */ 46 uint16_t i_style_flags; /**< Formatting style flags */ 47 48 /* Font style */ 49 float f_font_relsize; /**< The font size in video height % */ 50 int i_font_size; /**< The font size in pixels */ 51 int i_font_color; /**< The color of the text 0xRRGGBB 52 (native endianness) */ 53 uint8_t i_font_alpha; /**< The transparency of the text.*/ 54 int i_spacing; /**< The spaceing between glyphs in pixels */ 55 56 /* Outline */ 57 int i_outline_color; /**< The color of the outline 0xRRGGBB */ 58 uint8_t i_outline_alpha; /**< The transparency of the outline */ 59 int i_outline_width; /**< The width of the outline in pixels */ 60 61 /* Shadow */ 62 int i_shadow_color; /**< The color of the shadow 0xRRGGBB */ 63 uint8_t i_shadow_alpha; /**< The transparency of the shadow. */ 64 int i_shadow_width; /**< The width of the shadow in pixels */ 65 66 /* Background (and karaoke) */ 67 int i_background_color;/**< The color of the background 0xRRGGBB */ 68 uint8_t i_background_alpha;/**< The transparency of the background */ 69 int i_karaoke_background_color;/**< Background color for karaoke 0xRRGGBB */ 70 uint8_t i_karaoke_background_alpha;/**< The transparency of the karaoke bg */ 71 72 /* Line breaking */ 73 enum 74 { 75 STYLE_WRAP_DEFAULT = 0, /**< Breaks on whitespace or fallback on char */ 76 STYLE_WRAP_CHAR, /**< Breaks at character level only */ 77 STYLE_WRAP_NONE, /**< No line breaks (except explicit ones) */ 78 } e_wrapinfo; 79 } text_style_t; 80 81 #define STYLE_ALPHA_OPAQUE 0xFF 82 #define STYLE_ALPHA_TRANSPARENT 0x00 83 84 /* Features flags for \ref i_features */ 85 #define STYLE_NO_DEFAULTS 0x0 86 #define STYLE_FULLY_SET 0xFFFF 87 #define STYLE_HAS_FONT_COLOR (1 << 0) 88 #define STYLE_HAS_FONT_ALPHA (1 << 1) 89 #define STYLE_HAS_FLAGS (1 << 2) 90 #define STYLE_HAS_OUTLINE_COLOR (1 << 3) 91 #define STYLE_HAS_OUTLINE_ALPHA (1 << 4) 92 #define STYLE_HAS_SHADOW_COLOR (1 << 5) 93 #define STYLE_HAS_SHADOW_ALPHA (1 << 6) 94 #define STYLE_HAS_BACKGROUND_COLOR (1 << 7) 95 #define STYLE_HAS_BACKGROUND_ALPHA (1 << 8) 96 #define STYLE_HAS_K_BACKGROUND_COLOR (1 << 9) 97 #define STYLE_HAS_K_BACKGROUND_ALPHA (1 << 10) 98 #define STYLE_HAS_WRAP_INFO (1 << 11) 99 100 /* Style flags for \ref text_style_t */ 101 #define STYLE_BOLD (1 << 0) 102 #define STYLE_ITALIC (1 << 1) 103 #define STYLE_OUTLINE (1 << 2) 104 #define STYLE_SHADOW (1 << 3) 105 #define STYLE_BACKGROUND (1 << 4) 106 #define STYLE_UNDERLINE (1 << 5) 107 #define STYLE_STRIKEOUT (1 << 6) 108 #define STYLE_HALFWIDTH (1 << 7) 109 #define STYLE_MONOSPACED (1 << 8) 110 #define STYLE_DOUBLEWIDTH (1 << 9) 111 #define STYLE_BLINK_FOREGROUND (1 << 10) 112 #define STYLE_BLINK_BACKGROUND (1 << 11) 113 114 #define STYLE_DEFAULT_FONT_SIZE 20 115 #define STYLE_DEFAULT_REL_FONT_SIZE 6.25 116 117 118 typedef struct text_segment_t text_segment_t; 119 /** 120 * Text segment for subtitles 121 * 122 * This structure is used to store a formatted text, with mixed styles 123 * Every segment is comprised of one text and a unique style 124 * 125 * On style change, a new segment is created with the next part of text 126 * and the new style, and chained to the list 127 * 128 * Create with text_segment_New and clean the chain with 129 * text_segment_ChainDelete 130 */ 131 struct text_segment_t { 132 char *psz_text; /**< text string of the segment */ 133 text_style_t *style; /**< style applied to this segment */ 134 text_segment_t *p_next; /**< next segment */ 135 }; 136 137 /** 138 * Create a default text style 139 */ 140 VLC_API text_style_t * text_style_New( void ); 141 142 /** 143 * Create a text style 144 * 145 * Set feature flags as argument if you want to set style defaults 146 */ 147 VLC_API text_style_t * text_style_Create( int ); 148 149 /** 150 * Copy a text style into another 151 */ 152 VLC_API text_style_t * text_style_Copy( text_style_t *, const text_style_t * ); 153 154 /** 155 * Duplicate a text style 156 */ 157 VLC_API text_style_t * text_style_Duplicate( const text_style_t * ); 158 159 /** 160 * Merge two styles using non default values 161 * 162 * Set b_override to true if you also want to overwrite non-defaults 163 */ 164 VLC_API void text_style_Merge( text_style_t *, const text_style_t *, bool b_override ); 165 166 /** 167 * Delete a text style created by text_style_New or text_style_Duplicate 168 */ 169 VLC_API void text_style_Delete( text_style_t * ); 170 171 /** 172 * This function will create a new text segment. 173 * 174 * You should use text_segment_ChainDelete to destroy it, to clean all 175 * the linked segments, or text_segment_Delete to free a specic one 176 * 177 * This duplicates the string passed as argument 178 */ 179 VLC_API text_segment_t *text_segment_New( const char * ); 180 181 /** 182 * This function will create a new text segment and duplicates the style passed as argument 183 * 184 * You should use text_segment_ChainDelete to destroy it, to clean all 185 * the linked segments, or text_segment_Delete to free a specic one 186 * 187 * This doesn't initialize the text. 188 */ 189 VLC_API text_segment_t *text_segment_NewInheritStyle( const text_style_t* p_style ); 190 191 /** 192 * Delete a text segment and its content. 193 * 194 * This assumes the segment is not part of a chain 195 */ 196 VLC_API void text_segment_Delete( text_segment_t * ); 197 198 /** 199 * This function will destroy a list of text segments allocated 200 * by text_segment_New. 201 * 202 * You may pass it NULL. 203 */ 204 VLC_API void text_segment_ChainDelete( text_segment_t * ); 205 206 /** 207 * This function will copy a text_segment and its chain into a new one 208 * 209 * You may give it NULL, but it will return NULL. 210 */ 211 VLC_API text_segment_t * text_segment_Copy( text_segment_t * ); 212 213 static const struct { 214 const char *psz_name; 215 uint32_t i_value; 216 } p_html_colors[] = { 217 /* Official html colors */ 218 { "Aqua", 0x00FFFF }, 219 { "Black", 0x000000 }, 220 { "Blue", 0x0000FF }, 221 { "Fuchsia", 0xFF00FF }, 222 { "Gray", 0x808080 }, 223 { "Green", 0x008000 }, 224 { "Lime", 0x00FF00 }, 225 { "Maroon", 0x800000 }, 226 { "Navy", 0x000080 }, 227 { "Olive", 0x808000 }, 228 { "Purple", 0x800080 }, 229 { "Red", 0xFF0000 }, 230 { "Silver", 0xC0C0C0 }, 231 { "Teal", 0x008080 }, 232 { "White", 0xFFFFFF }, 233 { "Yellow", 0xFFFF00 }, 234 235 /* Common ones */ 236 { "AliceBlue", 0xF0F8FF }, 237 { "AntiqueWhite", 0xFAEBD7 }, 238 { "Aqua", 0x00FFFF }, 239 { "Aquamarine", 0x7FFFD4 }, 240 { "Azure", 0xF0FFFF }, 241 { "Beige", 0xF5F5DC }, 242 { "Bisque", 0xFFE4C4 }, 243 { "Black", 0x000000 }, 244 { "BlanchedAlmond", 0xFFEBCD }, 245 { "Blue", 0x0000FF }, 246 { "BlueViolet", 0x8A2BE2 }, 247 { "Brown", 0xA52A2A }, 248 { "BurlyWood", 0xDEB887 }, 249 { "CadetBlue", 0x5F9EA0 }, 250 { "Chartreuse", 0x7FFF00 }, 251 { "Chocolate", 0xD2691E }, 252 { "Coral", 0xFF7F50 }, 253 { "CornflowerBlue", 0x6495ED }, 254 { "Cornsilk", 0xFFF8DC }, 255 { "Crimson", 0xDC143C }, 256 { "Cyan", 0x00FFFF }, 257 { "DarkBlue", 0x00008B }, 258 { "DarkCyan", 0x008B8B }, 259 { "DarkGoldenRod", 0xB8860B }, 260 { "DarkGray", 0xA9A9A9 }, 261 { "DarkGrey", 0xA9A9A9 }, 262 { "DarkGreen", 0x006400 }, 263 { "DarkKhaki", 0xBDB76B }, 264 { "DarkMagenta", 0x8B008B }, 265 { "DarkOliveGreen", 0x556B2F }, 266 { "Darkorange", 0xFF8C00 }, 267 { "DarkOrchid", 0x9932CC }, 268 { "DarkRed", 0x8B0000 }, 269 { "DarkSalmon", 0xE9967A }, 270 { "DarkSeaGreen", 0x8FBC8F }, 271 { "DarkSlateBlue", 0x483D8B }, 272 { "DarkSlateGray", 0x2F4F4F }, 273 { "DarkSlateGrey", 0x2F4F4F }, 274 { "DarkTurquoise", 0x00CED1 }, 275 { "DarkViolet", 0x9400D3 }, 276 { "DeepPink", 0xFF1493 }, 277 { "DeepSkyBlue", 0x00BFFF }, 278 { "DimGray", 0x696969 }, 279 { "DimGrey", 0x696969 }, 280 { "DodgerBlue", 0x1E90FF }, 281 { "FireBrick", 0xB22222 }, 282 { "FloralWhite", 0xFFFAF0 }, 283 { "ForestGreen", 0x228B22 }, 284 { "Fuchsia", 0xFF00FF }, 285 { "Gainsboro", 0xDCDCDC }, 286 { "GhostWhite", 0xF8F8FF }, 287 { "Gold", 0xFFD700 }, 288 { "GoldenRod", 0xDAA520 }, 289 { "Gray", 0x808080 }, 290 { "Grey", 0x808080 }, 291 { "Green", 0x008000 }, 292 { "GreenYellow", 0xADFF2F }, 293 { "HoneyDew", 0xF0FFF0 }, 294 { "HotPink", 0xFF69B4 }, 295 { "IndianRed", 0xCD5C5C }, 296 { "Indigo", 0x4B0082 }, 297 { "Ivory", 0xFFFFF0 }, 298 { "Khaki", 0xF0E68C }, 299 { "Lavender", 0xE6E6FA }, 300 { "LavenderBlush", 0xFFF0F5 }, 301 { "LawnGreen", 0x7CFC00 }, 302 { "LemonChiffon", 0xFFFACD }, 303 { "LightBlue", 0xADD8E6 }, 304 { "LightCoral", 0xF08080 }, 305 { "LightCyan", 0xE0FFFF }, 306 { "LightGoldenRodYellow", 0xFAFAD2 }, 307 { "LightGray", 0xD3D3D3 }, 308 { "LightGrey", 0xD3D3D3 }, 309 { "LightGreen", 0x90EE90 }, 310 { "LightPink", 0xFFB6C1 }, 311 { "LightSalmon", 0xFFA07A }, 312 { "LightSeaGreen", 0x20B2AA }, 313 { "LightSkyBlue", 0x87CEFA }, 314 { "LightSlateGray", 0x778899 }, 315 { "LightSlateGrey", 0x778899 }, 316 { "LightSteelBlue", 0xB0C4DE }, 317 { "LightYellow", 0xFFFFE0 }, 318 { "Lime", 0x00FF00 }, 319 { "LimeGreen", 0x32CD32 }, 320 { "Linen", 0xFAF0E6 }, 321 { "Magenta", 0xFF00FF }, 322 { "Maroon", 0x800000 }, 323 { "MediumAquaMarine", 0x66CDAA }, 324 { "MediumBlue", 0x0000CD }, 325 { "MediumOrchid", 0xBA55D3 }, 326 { "MediumPurple", 0x9370D8 }, 327 { "MediumSeaGreen", 0x3CB371 }, 328 { "MediumSlateBlue", 0x7B68EE }, 329 { "MediumSpringGreen", 0x00FA9A }, 330 { "MediumTurquoise", 0x48D1CC }, 331 { "MediumVioletRed", 0xC71585 }, 332 { "MidnightBlue", 0x191970 }, 333 { "MintCream", 0xF5FFFA }, 334 { "MistyRose", 0xFFE4E1 }, 335 { "Moccasin", 0xFFE4B5 }, 336 { "NavajoWhite", 0xFFDEAD }, 337 { "Navy", 0x000080 }, 338 { "OldLace", 0xFDF5E6 }, 339 { "Olive", 0x808000 }, 340 { "OliveDrab", 0x6B8E23 }, 341 { "Orange", 0xFFA500 }, 342 { "OrangeRed", 0xFF4500 }, 343 { "Orchid", 0xDA70D6 }, 344 { "PaleGoldenRod", 0xEEE8AA }, 345 { "PaleGreen", 0x98FB98 }, 346 { "PaleTurquoise", 0xAFEEEE }, 347 { "PaleVioletRed", 0xD87093 }, 348 { "PapayaWhip", 0xFFEFD5 }, 349 { "PeachPuff", 0xFFDAB9 }, 350 { "Peru", 0xCD853F }, 351 { "Pink", 0xFFC0CB }, 352 { "Plum", 0xDDA0DD }, 353 { "PowderBlue", 0xB0E0E6 }, 354 { "Purple", 0x800080 }, 355 { "RebeccaPurple", 0x663399 }, 356 { "Red", 0xFF0000 }, 357 { "RosyBrown", 0xBC8F8F }, 358 { "RoyalBlue", 0x4169E1 }, 359 { "SaddleBrown", 0x8B4513 }, 360 { "Salmon", 0xFA8072 }, 361 { "SandyBrown", 0xF4A460 }, 362 { "SeaGreen", 0x2E8B57 }, 363 { "SeaShell", 0xFFF5EE }, 364 { "Sienna", 0xA0522D }, 365 { "Silver", 0xC0C0C0 }, 366 { "SkyBlue", 0x87CEEB }, 367 { "SlateBlue", 0x6A5ACD }, 368 { "SlateGray", 0x708090 }, 369 { "SlateGrey", 0x708090 }, 370 { "Snow", 0xFFFAFA }, 371 { "SpringGreen", 0x00FF7F }, 372 { "SteelBlue", 0x4682B4 }, 373 { "Tan", 0xD2B48C }, 374 { "Teal", 0x008080 }, 375 { "Thistle", 0xD8BFD8 }, 376 { "Tomato", 0xFF6347 }, 377 { "Turquoise", 0x40E0D0 }, 378 { "Violet", 0xEE82EE }, 379 { "Wheat", 0xF5DEB3 }, 380 { "White", 0xFFFFFF }, 381 { "WhiteSmoke", 0xF5F5F5 }, 382 { "Yellow", 0xFFFF00 }, 383 { "YellowGreen", 0x9ACD32 }, 384 385 { NULL, 0 } 386 }; 387 388 /** 389 * Returns an integer representation of an HTML color. 390 * 391 * @param psz_value An HTML color, which can be either: 392 * - A standard HTML color (red, cyan, ...) as defined in p_html_colors 393 * - An hexadecimal color, of the form [#][AA]RRGGBB 394 * @param ok If non-null, true will be stored in this pointer to signal 395 * a successful conversion 396 */ 397 VLC_API unsigned int vlc_html_color( const char *psz_value, bool* ok ); 398 399 #ifdef __cplusplus 400 } 401 #endif 402 403 #endif /* VLC_TEXT_STYLE_H */ 404 405