?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
qml: remove context indicator
[vlc.git] / modules / codec / subsusf.c
blob44248ff66479948d248a2db47e340f6b904b751b
1 /*****************************************************************************
2 * subsusf.c : USF subtitles decoder
3 *****************************************************************************
4 * Copyright (C) 2000-2006 VLC authors and VideoLAN
5 *
6 * Authors: Bernie Purcell <bitmap@videolan.org>
7 *
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU Lesser General Public License as published by
10 * the Free Software Foundation; either version 2.1 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public License
19 * along with this program; if not, write to the Free Software Foundation,
20 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21 *****************************************************************************/
22 #ifdef HAVE_CONFIG_H
23 # include "config.h"
24 #endif
25 #include <assert.h>
26
27 #include <vlc_common.h>
28 #include <vlc_plugin.h>
29 #include <vlc_modules.h>
30 #include <vlc_codec.h>
31 #include <vlc_input.h>
32 #include <vlc_charset.h>
33 #include <vlc_image.h>
34 #include <vlc_xml.h>
35 #include <vlc_stream.h>
36
37 /*****************************************************************************
38 * Module descriptor.
39 *****************************************************************************/
40 static int OpenDecoder ( vlc_object_t * );
41 static void CloseDecoder ( vlc_object_t * );
42
43 #define FORMAT_TEXT N_("Formatted Subtitles")
44 #define FORMAT_LONGTEXT N_("Some subtitle formats allow for text formatting. " \
45 "VLC partly implements this, but you can choose to disable all formatting.")
46
47 vlc_module_begin ()
48 set_capability( "spu decoder", 40 )
49 set_shortname( N_("USFSubs"))
50 set_description( N_("USF subtitles decoder") )
51 set_callbacks( OpenDecoder, CloseDecoder )
52 set_category( CAT_INPUT )
53 set_subcategory( SUBCAT_INPUT_SCODEC )
54 add_bool( "subsdec-formatted", true, FORMAT_TEXT, FORMAT_LONGTEXT,
55 false )
56 vlc_module_end ()
57
58
59 /*****************************************************************************
60 * Local prototypes
61 *****************************************************************************/
62 enum
63 {
64 ATTRIBUTE_ALIGNMENT = (1 << 0),
65 ATTRIBUTE_X = (1 << 1),
66 ATTRIBUTE_X_PERCENT = (1 << 2),
67 ATTRIBUTE_Y = (1 << 3),
68 ATTRIBUTE_Y_PERCENT = (1 << 4),
69 };
70
71 typedef struct
72 {
73 char *psz_filename;
74 picture_t *p_pic;
75 } image_attach_t;
76
77 typedef struct
78 {
79 char * psz_stylename; /* The name of the style, no comma's allowed */
80 text_style_t * p_style;
81 int i_align;
82 int i_margin_h;
83 int i_margin_v;
84 int i_margin_percent_h;
85 int i_margin_percent_v;
86 } ssa_style_t;
87
88 typedef struct
89 {
90 int i_original_height;
91 int i_original_width;
92 int i_align; /* Subtitles alignment on the vout */
93
94 ssa_style_t **pp_ssa_styles;
95 int i_ssa_styles;
96
97 image_attach_t **pp_images;
98 int i_images;
99 } decoder_sys_t;
100
101 static int DecodeBlock ( decoder_t *, block_t * );
102 static char *CreatePlainText( char * );
103 static char *StripTags( char *psz_subtitle );
104 static int ParseImageAttachments( decoder_t *p_dec );
105
106 static subpicture_t *ParseText ( decoder_t *, block_t * );
107 static void ParseUSFHeader( decoder_t * );
108 static subpicture_region_t *ParseUSFString( decoder_t *, char * );
109 static subpicture_region_t *LoadEmbeddedImage( decoder_t *p_dec, const char *psz_filename, int i_transparent_color );
110
111 /*****************************************************************************
112 * OpenDecoder: probe the decoder and return score
113 *****************************************************************************
114 * Tries to launch a decoder and return score so that the interface is able
115 * to chose.
116 *****************************************************************************/
117 static int OpenDecoder( vlc_object_t *p_this )
118 {
119 decoder_t *p_dec = (decoder_t*)p_this;
120 decoder_sys_t *p_sys;
121
122 if( p_dec->fmt_in.i_codec != VLC_CODEC_USF )
123 return VLC_EGENERIC;
124
125 /* Allocate the memory needed to store the decoder's structure */
126 if( ( p_dec->p_sys = p_sys = calloc(1, sizeof(decoder_sys_t)) ) == NULL )
127 return VLC_ENOMEM;
128
129 p_dec->pf_decode = DecodeBlock;
130 p_dec->fmt_out.i_codec = 0;
131
132 /* init of p_sys */
133 TAB_INIT( p_sys->i_ssa_styles, p_sys->pp_ssa_styles );
134 TAB_INIT( p_sys->i_images, p_sys->pp_images );
135
136 /* USF subtitles are mandated to be UTF-8, so don't need vlc_iconv */
137
138 p_sys->i_align = var_CreateGetInteger( p_dec, "subsdec-align" );
139
140 ParseImageAttachments( p_dec );
141
142 if( var_CreateGetBool( p_dec, "subsdec-formatted" ) )
143 {
144 if( p_dec->fmt_in.i_extra > 0 )
145 ParseUSFHeader( p_dec );
146 }
147
148 return VLC_SUCCESS;
149 }
150
151 /****************************************************************************
152 * DecodeBlock: the whole thing
153 ****************************************************************************
154 * This function must be fed with complete subtitles units.
155 ****************************************************************************/
156 static int DecodeBlock( decoder_t *p_dec, block_t *p_block )
157 {
158 subpicture_t *p_spu;
159
160 if( p_block == NULL ) /* No Drain */
161 return VLCDEC_SUCCESS;
162
163 p_spu = ParseText( p_dec, p_block );
164
165 block_Release( p_block );
166 if( p_spu != NULL )
167 decoder_QueueSub( p_dec, p_spu );
168 return VLCDEC_SUCCESS;
169 }
170
171 /*****************************************************************************
172 * CloseDecoder: clean up the decoder
173 *****************************************************************************/
174 static void CloseDecoder( vlc_object_t *p_this )
175 {
176 decoder_t *p_dec = (decoder_t *)p_this;
177 decoder_sys_t *p_sys = p_dec->p_sys;
178
179 if( p_sys->pp_ssa_styles )
180 {
181 for( int i = 0; i < p_sys->i_ssa_styles; i++ )
182 {
183 if( !p_sys->pp_ssa_styles[i] )
184 continue;
185
186 free( p_sys->pp_ssa_styles[i]->psz_stylename );
187 text_style_Delete( p_sys->pp_ssa_styles[i]->p_style );
188 free( p_sys->pp_ssa_styles[i] );
189 }
190 TAB_CLEAN( p_sys->i_ssa_styles, p_sys->pp_ssa_styles );
191 }
192 if( p_sys->pp_images )
193 {
194 for( int i = 0; i < p_sys->i_images; i++ )
195 {
196 if( !p_sys->pp_images[i] )
197 continue;
198
199 if( p_sys->pp_images[i]->p_pic )
200 picture_Release( p_sys->pp_images[i]->p_pic );
201 free( p_sys->pp_images[i]->psz_filename );
202
203 free( p_sys->pp_images[i] );
204 }
205 TAB_CLEAN( p_sys->i_images, p_sys->pp_images );
206 }
207
208 free( p_sys );
209 }
210
211 /*****************************************************************************
212 * ParseText: parse an text subtitle packet and send it to the video output
213 *****************************************************************************/
214 static subpicture_t *ParseText( decoder_t *p_dec, block_t *p_block )
215 {
216 decoder_sys_t *p_sys = p_dec->p_sys;
217 subpicture_t *p_spu = NULL;
218 char *psz_subtitle = NULL;
219
220 if( p_block->i_flags & BLOCK_FLAG_CORRUPTED )
221 return NULL;
222
223 /* We cannot display a subpicture with no date */
224 if( p_block->i_pts == VLC_TICK_INVALID )
225 {
226 msg_Warn( p_dec, "subtitle without a date" );
227 return NULL;
228 }
229
230 /* Check validity of packet data */
231 /* An "empty" line containing only \0 can be used to force
232 and ephemer picture from the screen */
233 if( p_block->i_buffer < 1 )
234 {
235 msg_Warn( p_dec, "no subtitle data" );
236 return NULL;
237 }
238
239 /* Should be resiliant against bad subtitles */
240 psz_subtitle = strndup( (const char *)p_block->p_buffer,
241 p_block->i_buffer );
242 if( psz_subtitle == NULL )
243 return NULL;
244
245 /* USF Subtitles are mandated to be UTF-8 -- make sure it is */
246 if (EnsureUTF8( psz_subtitle ) == NULL)
247 {
248 msg_Err( p_dec, "USF subtitles must be in UTF-8 format.\n"
249 "This stream contains USF subtitles which aren't." );
250 }
251
252 /* Create the subpicture unit */
253 p_spu = decoder_NewSubpicture( p_dec, NULL );
254 if( !p_spu )
255 {
256 msg_Warn( p_dec, "can't get spu buffer" );
257 free( psz_subtitle );
258 return NULL;
259 }
260
261 /* Decode USF strings */
262 p_spu->p_region = ParseUSFString( p_dec, psz_subtitle );
263
264 p_spu->i_start = p_block->i_pts;
265 p_spu->i_stop = p_block->i_pts + p_block->i_length;
266 p_spu->b_ephemer = (p_block->i_length == VLC_TICK_INVALID);
267 p_spu->b_absolute = false;
268 p_spu->i_original_picture_width = p_sys->i_original_width;
269 p_spu->i_original_picture_height = p_sys->i_original_height;
270
271 free( psz_subtitle );
272
273 return p_spu;
274 }
275
276 static char *GrabAttributeValue( const char *psz_attribute,
277 const char *psz_tag_start )
278 {
279 if( psz_attribute && psz_tag_start )
280 {
281 char *psz_tag_end = strchr( psz_tag_start, '>' );
282 char *psz_found = strcasestr( psz_tag_start, psz_attribute );
283
284 if( psz_found )
285 {
286 psz_found += strlen( psz_attribute );
287
288 if(( *(psz_found++) == '=' ) &&
289 ( *(psz_found++) == '\"' ))
290 {
291 if( psz_found < psz_tag_end )
292 {
293 int i_len = strcspn( psz_found, "\"" );
294 return strndup( psz_found, i_len );
295 }
296 }
297 }
298 }
299 return NULL;
300 }
301
302 static ssa_style_t *ParseStyle( decoder_sys_t *p_sys, char *psz_subtitle )
303 {
304 ssa_style_t *p_ssa_style = NULL;
305 char *psz_style = GrabAttributeValue( "style", psz_subtitle );
306
307 if( psz_style )
308 {
309 for( int i = 0; i < p_sys->i_ssa_styles; i++ )
310 {
311 if( !strcmp( p_sys->pp_ssa_styles[i]->psz_stylename, psz_style ) )
312 p_ssa_style = p_sys->pp_ssa_styles[i];
313 }
314 free( psz_style );
315 }
316 return p_ssa_style;
317 }
318
319 static int ParsePositionAttributeList( char *psz_subtitle, int *i_align,
320 int *i_x, int *i_y )
321 {
322 int i_mask = 0;
323
324 char *psz_align = GrabAttributeValue( "alignment", psz_subtitle );
325 char *psz_margin_x = GrabAttributeValue( "horizontal-margin", psz_subtitle );
326 char *psz_margin_y = GrabAttributeValue( "vertical-margin", psz_subtitle );
327 /* -- UNSUPPORTED
328 char *psz_relative = GrabAttributeValue( "relative-to", psz_subtitle );
329 char *psz_rotate_x = GrabAttributeValue( "rotate-x", psz_subtitle );
330 char *psz_rotate_y = GrabAttributeValue( "rotate-y", psz_subtitle );
331 char *psz_rotate_z = GrabAttributeValue( "rotate-z", psz_subtitle );
332 */
333
334 *i_align = SUBPICTURE_ALIGN_BOTTOM;
335 *i_x = 0;
336 *i_y = 0;
337
338 if( psz_align )
339 {
340 if( !strcasecmp( "TopLeft", psz_align ) )
341 *i_align = SUBPICTURE_ALIGN_TOP | SUBPICTURE_ALIGN_LEFT;
342 else if( !strcasecmp( "TopCenter", psz_align ) )
343 *i_align = SUBPICTURE_ALIGN_TOP;
344 else if( !strcasecmp( "TopRight", psz_align ) )
345 *i_align = SUBPICTURE_ALIGN_TOP | SUBPICTURE_ALIGN_RIGHT;
346 else if( !strcasecmp( "MiddleLeft", psz_align ) )
347 *i_align = SUBPICTURE_ALIGN_LEFT;
348 else if( !strcasecmp( "MiddleCenter", psz_align ) )
349 *i_align = 0;
350 else if( !strcasecmp( "MiddleRight", psz_align ) )
351 *i_align = SUBPICTURE_ALIGN_RIGHT;
352 else if( !strcasecmp( "BottomLeft", psz_align ) )
353 *i_align = SUBPICTURE_ALIGN_BOTTOM | SUBPICTURE_ALIGN_LEFT;
354 else if( !strcasecmp( "BottomCenter", psz_align ) )
355 *i_align = SUBPICTURE_ALIGN_BOTTOM;
356 else if( !strcasecmp( "BottomRight", psz_align ) )
357 *i_align = SUBPICTURE_ALIGN_BOTTOM | SUBPICTURE_ALIGN_RIGHT;
358
359 i_mask |= ATTRIBUTE_ALIGNMENT;
360 free( psz_align );
361 }
362 if( psz_margin_x )
363 {
364 *i_x = atoi( psz_margin_x );
365 if( strchr( psz_margin_x, '%' ) )
366 i_mask |= ATTRIBUTE_X_PERCENT;
367 else
368 i_mask |= ATTRIBUTE_X;
369
370 free( psz_margin_x );
371 }
372 if( psz_margin_y )
373 {
374 *i_y = atoi( psz_margin_y );
375 if( strchr( psz_margin_y, '%' ) )
376 i_mask |= ATTRIBUTE_Y_PERCENT;
377 else
378 i_mask |= ATTRIBUTE_Y;
379
380 free( psz_margin_y );
381 }
382 return i_mask;
383 }
384
385 static void SetupPositions( subpicture_region_t *p_region, char *psz_subtitle )
386 {
387 int i_mask = 0;
388 int i_align;
389 int i_x, i_y;
390
391 i_mask = ParsePositionAttributeList( psz_subtitle, &i_align, &i_x, &i_y );
392
393 if( i_mask & ATTRIBUTE_ALIGNMENT )
394 p_region->i_align = i_align;
395
396 /* TODO: Setup % based offsets properly, without adversely affecting
397 * everything else in vlc. Will address with separate patch, to
398 * prevent this one being any more complicated.
399 */
400 if( i_mask & ATTRIBUTE_X )
401 p_region->i_x = i_x;
402 else if( i_mask & ATTRIBUTE_X_PERCENT )
403 p_region->i_x = 0;
404
405 if( i_mask & ATTRIBUTE_Y )
406 p_region->i_y = i_y;
407 else if( i_mask & ATTRIBUTE_Y_PERCENT )
408 p_region->i_y = 0;
409 }
410
411 static subpicture_region_t *CreateTextRegion( decoder_t *p_dec,
412 char *psz_subtitle,
413 int i_sys_align )
414 {
415 decoder_sys_t *p_sys = p_dec->p_sys;
416 subpicture_region_t *p_text_region;
417 video_format_t fmt;
418
419 /* Create a new subpicture region */
420 video_format_Init( &fmt, VLC_CODEC_TEXT );
421 fmt.i_width = fmt.i_height = 0;
422 fmt.i_x_offset = fmt.i_y_offset = 0;
423 p_text_region = subpicture_region_New( &fmt );
424 video_format_Clean( &fmt );
425
426 if( p_text_region != NULL )
427 {
428 ssa_style_t *p_ssa_style = NULL;
429
430 p_ssa_style = ParseStyle( p_sys, psz_subtitle );
431 if( !p_ssa_style )
432 {
433 for( int i = 0; i < p_sys->i_ssa_styles; i++ )
434 {
435 if( !strcasecmp( p_sys->pp_ssa_styles[i]->psz_stylename, "Default" ) )
436 p_ssa_style = p_sys->pp_ssa_styles[i];
437 }
438 }
439
440 /* Set default or user align/magin.
441 * Style overriden if no user value. */
442 p_text_region->i_x = i_sys_align > 0 ? 20 : 0;
443 p_text_region->i_y = 10;
444 p_text_region->i_align = SUBPICTURE_ALIGN_BOTTOM |
445 ((i_sys_align > 0) ? i_sys_align : 0);
446
447 if( p_ssa_style )
448 {
449 msg_Dbg( p_dec, "style is: %s", p_ssa_style->psz_stylename );
450
451 /* TODO: Setup % based offsets properly, without adversely affecting
452 * everything else in vlc. Will address with separate patch,
453 * to prevent this one being any more complicated.
454
455 * p_ssa_style->i_margin_percent_h;
456 * p_ssa_style->i_margin_percent_v;
457 */
458 if( i_sys_align == -1 )
459 {
460 p_text_region->i_align = p_ssa_style->i_align;
461 p_text_region->i_x = p_ssa_style->i_margin_h;
462 p_text_region->i_y = p_ssa_style->i_margin_v;
463 }
464 p_text_region->p_text = text_segment_NewInheritStyle( p_ssa_style->p_style );
465 }
466 else
467 {
468 p_text_region->p_text = text_segment_New( NULL );
469 }
470 /* Look for position arguments which may override the style-based
471 * defaults.
472 */
473 SetupPositions( p_text_region, psz_subtitle );
474
475 p_text_region->p_next = NULL;
476 }
477 return p_text_region;
478 }
479
480 static int ParseImageAttachments( decoder_t *p_dec )
481 {
482 decoder_sys_t *p_sys = p_dec->p_sys;
483 input_attachment_t **pp_attachments;
484 int i_attachments_cnt;
485
486 if( VLC_SUCCESS != decoder_GetInputAttachments( p_dec, &pp_attachments, &i_attachments_cnt ))
487 return VLC_EGENERIC;
488
489 for( int k = 0; k < i_attachments_cnt; k++ )
490 {
491 input_attachment_t *p_attach = pp_attachments[k];
492
493 vlc_fourcc_t type = image_Mime2Fourcc( p_attach->psz_mime );
494
495 if( ( type != 0 ) &&
496 ( p_attach->i_data > 0 ) &&
497 ( p_attach->p_data != NULL ) )
498 {
499 picture_t *p_pic = NULL;
500 image_handler_t *p_image;
501
502 p_image = image_HandlerCreate( p_dec );
503 if( p_image != NULL )
504 {
505 block_t *p_block;
506
507 p_block = block_Alloc( p_attach->i_data );
508
509 if( p_block != NULL )
510 {
511 es_format_t es_in;
512 video_format_t fmt_out;
513
514 memcpy( p_block->p_buffer, p_attach->p_data, p_attach->i_data );
515
516 es_format_Init( &es_in, VIDEO_ES, type );
517 es_in.video.i_chroma = type;
518 video_format_Init( &fmt_out, VLC_CODEC_YUVA );
519
520 /* Find a suitable decoder module */
521 if( module_exists( "sdl_image" ) )
522 {
523 /* ffmpeg thinks it can handle bmp properly but it can't (at least
524 * not all of them), so use sdl_image if it is available */
525
526 var_Create( p_dec, "codec", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
527 var_SetString( p_dec, "codec", "sdl_image" );
528 }
529
530 p_pic = image_Read( p_image, p_block, &es_in, &fmt_out );
531 var_Destroy( p_dec, "codec" );
532 es_format_Clean( &es_in );
533 video_format_Clean( &fmt_out );
534 }
535
536 image_HandlerDelete( p_image );
537 }
538 if( p_pic )
539 {
540 image_attach_t *p_picture = malloc( sizeof(image_attach_t) );
541
542 if( p_picture )
543 {
544 p_picture->psz_filename = strdup( p_attach->psz_name );
545 p_picture->p_pic = p_pic;
546
547 TAB_APPEND( p_sys->i_images, p_sys->pp_images, p_picture );
548 }
549 }
550 }
551 vlc_input_attachment_Delete( pp_attachments[ k ] );
552 }
553 free( pp_attachments );
554
555 return VLC_SUCCESS;
556 }
557
558 static void ParseUSFHeaderTags( decoder_t *p_dec, xml_reader_t *p_xml_reader )
559 {
560 decoder_sys_t *p_sys = p_dec->p_sys;
561 const char *node;
562 ssa_style_t *p_ssa_style = NULL;
563 int i_style_level = 0;
564 int i_metadata_level = 0;
565 int type;
566
567 while( (type = xml_ReaderNextNode( p_xml_reader, &node )) > 0 )
568 {
569 switch( type )
570 {
571 case XML_READER_ENDELEM:
572 switch (i_style_level)
573 {
574 case 0:
575 if( !strcasecmp( "metadata", node ) && (i_metadata_level == 1) )
576 i_metadata_level--;
577 break;
578 case 1:
579 if( !strcasecmp( "styles", node ) )
580 i_style_level--;
581 break;
582 case 2:
583 if( !strcasecmp( "style", node ) )
584 {
585 TAB_APPEND( p_sys->i_ssa_styles, p_sys->pp_ssa_styles, p_ssa_style );
586
587 p_ssa_style = NULL;
588 i_style_level--;
589 }
590 break;
591 }
592 break;
593
594 case XML_READER_STARTELEM:
595 if( !strcasecmp( "metadata", node ) && (i_style_level == 0) )
596 i_metadata_level++;
597 else if( !strcasecmp( "resolution", node ) &&
598 ( i_metadata_level == 1) )
599 {
600 const char *attr, *val;
601 while( (attr = xml_ReaderNextAttr( p_xml_reader, &val )) )
602 {
603 if( !strcasecmp( "x", attr ) )
604 p_sys->i_original_width = atoi( val );
605 else if( !strcasecmp( "y", attr ) )
606 p_sys->i_original_height = atoi( val );
607 }
608 }
609 else if( !strcasecmp( "styles", node ) && (i_style_level == 0) )
610 {
611 i_style_level++;
612 }
613 else if( !strcasecmp( "style", node ) && (i_style_level == 1) )
614 {
615 i_style_level++;
616
617 p_ssa_style = calloc( 1, sizeof(ssa_style_t) );
618 if( unlikely(!p_ssa_style) )
619 return;
620 p_ssa_style->p_style = text_style_Create( STYLE_NO_DEFAULTS );
621 if( unlikely(!p_ssa_style->p_style) )
622 {
623 free(p_ssa_style);
624 return;
625 }
626 /* All styles are supposed to default to Default, and then
627 * one or more settings are over-ridden.
628 * At the moment this only effects styles defined AFTER
629 * Default in the XML
630 */
631 for( int i = 0; i < p_sys->i_ssa_styles; i++ )
632 {
633 if( !strcasecmp( p_sys->pp_ssa_styles[i]->psz_stylename, "Default" ) )
634 {
635 ssa_style_t *p_default_style = p_sys->pp_ssa_styles[i];
636 text_style_t *p_orig_text_style = p_ssa_style->p_style;
637
638 memcpy( p_ssa_style, p_default_style, sizeof( ssa_style_t ) );
639
640 // reset data-members that are not to be overwritten
641 p_ssa_style->p_style = p_orig_text_style;
642 p_ssa_style->psz_stylename = NULL;
643
644 //FIXME: Make font_style a pointer. Actually we double copy some data here,
645 // we use text_style_Copy to avoid copying psz_fontname, though .
646 text_style_Copy( p_ssa_style->p_style, p_default_style->p_style );
647 }
648 }
649
650 const char *attr, *val;
651 while( (attr = xml_ReaderNextAttr( p_xml_reader, &val )) )
652 {
653 if( !strcasecmp( "name", attr ) )
654 {
655 free( p_ssa_style->psz_stylename );
656 p_ssa_style->psz_stylename = strdup( val );
657 }
658 }
659 }
660 else if( !strcasecmp( "fontstyle", node ) && (i_style_level == 2) )
661 {
662 const char *attr, *val;
663 while( (attr = xml_ReaderNextAttr( p_xml_reader, &val )) )
664 {
665 if( !strcasecmp( "face", attr ) )
666 {
667 free( p_ssa_style->p_style->psz_fontname );
668 p_ssa_style->p_style->psz_fontname = strdup( val );
669 }
670 else if( !strcasecmp( "size", attr ) )
671 {
672 if( ( *val == '+' ) || ( *val == '-' ) )
673 {
674 int i_value = atoi( val );
675
676 if( ( i_value >= -5 ) && ( i_value <= 5 ) )
677 p_ssa_style->p_style->i_font_size +=
678 ( i_value * p_ssa_style->p_style->i_font_size ) / 10;
679 else if( i_value < -5 )
680 p_ssa_style->p_style->i_font_size = - i_value;
681 else if( i_value > 5 )
682 p_ssa_style->p_style->i_font_size = i_value;
683 }
684 else
685 p_ssa_style->p_style->i_font_size = atoi( val );
686 }
687 else if( !strcasecmp( "italic", attr ) )
688 {
689 if( !strcasecmp( "yes", val ))
690 p_ssa_style->p_style->i_style_flags |= STYLE_ITALIC;
691 else
692 p_ssa_style->p_style->i_style_flags &= ~STYLE_ITALIC;
693 p_ssa_style->p_style->i_features |= STYLE_HAS_FLAGS;
694 }
695 else if( !strcasecmp( "weight", attr ) )
696 {
697 if( !strcasecmp( "bold", val ))
698 p_ssa_style->p_style->i_style_flags |= STYLE_BOLD;
699 else
700 p_ssa_style->p_style->i_style_flags &= ~STYLE_BOLD;
701 p_ssa_style->p_style->i_features |= STYLE_HAS_FLAGS;
702 }
703 else if( !strcasecmp( "underline", attr ) )
704 {
705 if( !strcasecmp( "yes", val ))
706 p_ssa_style->p_style->i_style_flags |= STYLE_UNDERLINE;
707 else
708 p_ssa_style->p_style->i_style_flags &= ~STYLE_UNDERLINE;
709 p_ssa_style->p_style->i_features |= STYLE_HAS_FLAGS;
710 }
711 else if( !strcasecmp( "color", attr ) )
712 {
713 if( *val == '#' )
714 {
715 unsigned long col = strtol(val+1, NULL, 16);
716 p_ssa_style->p_style->i_font_color = (col & 0x00ffffff);
717 p_ssa_style->p_style->i_font_alpha = (col >> 24) & 0xff;
718 p_ssa_style->p_style->i_features |= STYLE_HAS_FONT_COLOR
719 | STYLE_HAS_FONT_ALPHA;
720 }
721 }
722 else if( !strcasecmp( "outline-color", attr ) )
723 {
724 if( *val == '#' )
725 {
726 unsigned long col = strtol(val+1, NULL, 16);
727 p_ssa_style->p_style->i_outline_color = (col & 0x00ffffff);
728 p_ssa_style->p_style->i_outline_alpha = (col >> 24) & 0xff;
729 p_ssa_style->p_style->i_features |= STYLE_HAS_OUTLINE_COLOR
730 | STYLE_HAS_OUTLINE_ALPHA;
731 }
732 }
733 else if( !strcasecmp( "outline-level", attr ) )
734 {
735 p_ssa_style->p_style->i_outline_width = atoi( val );
736 }
737 else if( !strcasecmp( "shadow-color", attr ) )
738 {
739 if( *val == '#' )
740 {
741 unsigned long col = strtol(val+1, NULL, 16);
742 p_ssa_style->p_style->i_shadow_color = (col & 0x00ffffff);
743 p_ssa_style->p_style->i_shadow_alpha = (col >> 24) & 0xff;
744 p_ssa_style->p_style->i_features |= STYLE_HAS_SHADOW_COLOR
745 | STYLE_HAS_SHADOW_ALPHA;
746 }
747 }
748 else if( !strcasecmp( "shadow-level", attr ) )
749 {
750 p_ssa_style->p_style->i_shadow_width = atoi( val );
751 }
752 else if( !strcasecmp( "spacing", attr ) )
753 {
754 p_ssa_style->p_style->i_spacing = atoi( val );
755 }
756 }
757 }
758 else if( !strcasecmp( "position", node ) && (i_style_level == 2) )
759 {
760 const char *attr, *val;
761 while( (attr = xml_ReaderNextAttr( p_xml_reader, &val )) )
762 {
763 if( !strcasecmp( "alignment", attr ) )
764 {
765 if( !strcasecmp( "TopLeft", val ) )
766 p_ssa_style->i_align = SUBPICTURE_ALIGN_TOP | SUBPICTURE_ALIGN_LEFT;
767 else if( !strcasecmp( "TopCenter", val ) )
768 p_ssa_style->i_align = SUBPICTURE_ALIGN_TOP;
769 else if( !strcasecmp( "TopRight", val ) )
770 p_ssa_style->i_align = SUBPICTURE_ALIGN_TOP | SUBPICTURE_ALIGN_RIGHT;
771 else if( !strcasecmp( "MiddleLeft", val ) )
772 p_ssa_style->i_align = SUBPICTURE_ALIGN_LEFT;
773 else if( !strcasecmp( "MiddleCenter", val ) )
774 p_ssa_style->i_align = 0;
775 else if( !strcasecmp( "MiddleRight", val ) )
776 p_ssa_style->i_align = SUBPICTURE_ALIGN_RIGHT;
777 else if( !strcasecmp( "BottomLeft", val ) )
778 p_ssa_style->i_align = SUBPICTURE_ALIGN_BOTTOM | SUBPICTURE_ALIGN_LEFT;
779 else if( !strcasecmp( "BottomCenter", val ) )
780 p_ssa_style->i_align = SUBPICTURE_ALIGN_BOTTOM;
781 else if( !strcasecmp( "BottomRight", val ) )
782 p_ssa_style->i_align = SUBPICTURE_ALIGN_BOTTOM | SUBPICTURE_ALIGN_RIGHT;
783 }
784 else if( !strcasecmp( "horizontal-margin", attr ) )
785 {
786 if( strchr( val, '%' ) )
787 {
788 p_ssa_style->i_margin_h = 0;
789 p_ssa_style->i_margin_percent_h = atoi( val );
790 }
791 else
792 {
793 p_ssa_style->i_margin_h = atoi( val );
794 p_ssa_style->i_margin_percent_h = 0;
795 }
796 }
797 else if( !strcasecmp( "vertical-margin", attr ) )
798 {
799 if( strchr( val, '%' ) )
800 {
801 p_ssa_style->i_margin_v = 0;
802 p_ssa_style->i_margin_percent_v = atoi( val );
803 }
804 else
805 {
806 p_ssa_style->i_margin_v = atoi( val );
807 p_ssa_style->i_margin_percent_v = 0;
808 }
809 }
810 }
811 }
812 break;
813 }
814 }
815 free( p_ssa_style );
816 }
817
818
819
820 static subpicture_region_t *ParseUSFString( decoder_t *p_dec,
821 char *psz_subtitle )
822 {
823 decoder_sys_t *p_sys = p_dec->p_sys;
824 subpicture_region_t *p_region_first = NULL;
825 subpicture_region_t *p_region_upto = p_region_first;
826
827 while( *psz_subtitle )
828 {
829 if( *psz_subtitle == '<' )
830 {
831 char *psz_end = NULL;
832
833
834 if(( !strncasecmp( psz_subtitle, "<karaoke ", 9 )) ||
835 ( !strncasecmp( psz_subtitle, "<karaoke>", 9 )))
836 {
837 psz_end = strcasestr( psz_subtitle, "</karaoke>" );
838
839 if( psz_end )
840 {
841 subpicture_region_t *p_text_region;
842
843 char *psz_flat = NULL;
844 char *psz_knodes = strndup( &psz_subtitle[9], psz_end - &psz_subtitle[9] );
845 if( psz_knodes )
846 {
847 /* remove timing <k> tags */
848 psz_flat = CreatePlainText( psz_knodes );
849 free( psz_knodes );
850 if( psz_flat )
851 {
852 p_text_region = CreateTextRegion( p_dec,
853 psz_flat,
854 p_sys->i_align );
855 if( p_text_region )
856 {
857 free( p_text_region->p_text->psz_text );
858 p_text_region->p_text->psz_text = psz_flat;
859 if( !p_region_first )
860 {
861 p_region_first = p_region_upto = p_text_region;
862 }
863 else if( p_text_region )
864 {
865 p_region_upto->p_next = p_text_region;
866 p_region_upto = p_region_upto->p_next;
867 }
868 }
869 else free( psz_flat );
870 }
871 }
872
873 psz_end += strcspn( psz_end, ">" ) + 1;
874 }
875 }
876 else if(( !strncasecmp( psz_subtitle, "<image ", 7 )) ||
877 ( !strncasecmp( psz_subtitle, "<image>", 7 )))
878 {
879 subpicture_region_t *p_image_region = NULL;
880
881 psz_end = strcasestr( psz_subtitle, "</image>" );
882 char *psz_content = strchr( psz_subtitle, '>' );
883 int i_transparent = -1;
884
885 /* If a colorkey parameter is specified, then we have to map
886 * that index in the picture through as transparent (it is
887 * required by the USF spec but is also recommended that if the
888 * creator really wants a transparent colour that they use a
889 * type like PNG that properly supports it; this goes doubly
890 * for VLC because the pictures are stored internally in YUV
891 * and the resulting colour-matching may not produce the
892 * desired results.)
893 */
894 char *psz_tmp = GrabAttributeValue( "colorkey", psz_subtitle );
895 if( psz_tmp )
896 {
897 if( *psz_tmp == '#' )
898 i_transparent = strtol( psz_tmp + 1, NULL, 16 ) & 0x00ffffff;
899 free( psz_tmp );
900 }
901 if( psz_content && ( psz_content < psz_end ) )
902 {
903 char *psz_filename = strndup( &psz_content[1], psz_end - &psz_content[1] );
904 if( psz_filename )
905 {
906 p_image_region = LoadEmbeddedImage( p_dec,
907 psz_filename, i_transparent );
908 free( psz_filename );
909 }
910 }
911
912 if( psz_end ) psz_end += strcspn( psz_end, ">" ) + 1;
913
914 if( p_image_region )
915 {
916 SetupPositions( p_image_region, psz_subtitle );
917
918 p_image_region->p_next = NULL;
919 }
920 if( !p_region_first )
921 {
922 p_region_first = p_region_upto = p_image_region;
923 }
924 else if( p_image_region )
925 {
926 p_region_upto->p_next = p_image_region;
927 p_region_upto = p_region_upto->p_next;
928 }
929 }
930 else
931 {
932 subpicture_region_t *p_text_region;
933
934 psz_end = psz_subtitle + strlen( psz_subtitle );
935
936 p_text_region = CreateTextRegion( p_dec,
937 psz_subtitle,
938 p_sys->i_align );
939
940 if( p_text_region )
941 {
942 free( p_text_region->p_text->psz_text );
943 p_text_region->p_text->psz_text = CreatePlainText( psz_subtitle );
944 }
945
946 if( !p_region_first )
947 {
948 p_region_first = p_region_upto = p_text_region;
949 }
950 else if( p_text_region )
951 {
952 p_region_upto->p_next = p_text_region;
953 p_region_upto = p_region_upto->p_next;
954 }
955 }
956 if( psz_end )
957 psz_subtitle = psz_end - 1;
958
959 psz_subtitle += strcspn( psz_subtitle, ">" );
960 }
961
962 psz_subtitle++;
963 }
964
965 return p_region_first;
966 }
967
968 /*****************************************************************************
969 * ParseUSFHeader: Retrieve global formatting information etc
970 *****************************************************************************/
971 static void ParseUSFHeader( decoder_t *p_dec )
972 {
973 stream_t *p_sub = NULL;
974 xml_reader_t *p_xml_reader = NULL;
975
976 p_sub = vlc_stream_MemoryNew( VLC_OBJECT(p_dec),
977 p_dec->fmt_in.p_extra,
978 p_dec->fmt_in.i_extra,
979 true );
980 if( !p_sub )
981 return;
982
983 p_xml_reader = xml_ReaderCreate( p_dec, p_sub );
984 if( likely(p_xml_reader) )
985 {
986 const char *node;
987
988 /* Look for Root Node */
989 if( xml_ReaderNextNode( p_xml_reader, &node ) == XML_READER_STARTELEM
990 && !strcasecmp( "usfsubtitles", node ) )
991 ParseUSFHeaderTags( p_dec, p_xml_reader );
992
993 xml_ReaderDelete( p_xml_reader );
994 }
995 vlc_stream_Delete( p_sub );
996 }
997
998 /* Function now handles tags which has attribute values, and tries
999 * to deal with &' commands too. It no longer modifies the string
1000 * in place, so that the original text can be reused
1001 */
1002 static char *StripTags( char *psz_subtitle )
1003 {
1004 char *psz_text_start;
1005 char *psz_text;
1006
1007 psz_text = psz_text_start = malloc( strlen( psz_subtitle ) + 1 );
1008 if( !psz_text_start )
1009 return NULL;
1010
1011 while( *psz_subtitle )
1012 {
1013 /* Mask out any pre-existing LFs in the subtitle */
1014 if( *psz_subtitle == '\n' )
1015 *psz_subtitle = ' ';
1016
1017 if( *psz_subtitle == '<' )
1018 {
1019 if( strncasecmp( psz_subtitle, "<br/>", 5 ) == 0 )
1020 *psz_text++ = '\n';
1021
1022 psz_subtitle += strcspn( psz_subtitle, ">" );
1023 }
1024 else if( *psz_subtitle == '&' )
1025 {
1026 if( !strncasecmp( psz_subtitle, "&lt;", 4 ))
1027 {
1028 *psz_text++ = '<';
1029 psz_subtitle += strcspn( psz_subtitle, ";" );
1030 }
1031 else if( !strncasecmp( psz_subtitle, "&gt;", 4 ))
1032 {
1033 *psz_text++ = '>';
1034 psz_subtitle += strcspn( psz_subtitle, ";" );
1035 }
1036 else if( !strncasecmp( psz_subtitle, "&amp;", 5 ))
1037 {
1038 *psz_text++ = '&';
1039 psz_subtitle += strcspn( psz_subtitle, ";" );
1040 }
1041 else if( !strncasecmp( psz_subtitle, "&quot;", 6 ))
1042 {
1043 *psz_text++ = '\"';
1044 psz_subtitle += strcspn( psz_subtitle, ";" );
1045 }
1046 else
1047 {
1048 /* Assume it is just a normal ampersand */
1049 *psz_text++ = '&';
1050 }
1051 }
1052 else
1053 {
1054 *psz_text++ = *psz_subtitle;
1055 }
1056
1057 /* Security fix: Account for the case where input ends early */
1058 if( *psz_subtitle == '\0' ) break;
1059
1060 psz_subtitle++;
1061 }
1062 *psz_text++ = '\0';
1063
1064 char *psz = realloc( psz_text_start, psz_text - psz_text_start );
1065 return likely(psz != NULL) ? psz : psz_text_start;
1066 }
1067
1068 /* Turn a HTML subtitle, turn into a plain-text version,
1069 * complete with sensible whitespace compaction
1070 */
1071
1072 static char *CreatePlainText( char *psz_subtitle )
1073 {
1074 char *psz_text = StripTags( psz_subtitle );
1075 char *s;
1076
1077 if( !psz_text )
1078 return NULL;
1079
1080 s = strpbrk( psz_text, "\t\r\n " );
1081 while( s )
1082 {
1083 char spc = ' ';
1084 int i_whitespace = strspn( s, "\t\r\n " );
1085
1086 /* Favour '\n' over other whitespaces - if one of these
1087 * occurs in the whitespace use a '\n' as our value,
1088 * otherwise just use a ' '
1089 */
1090 for( int k = 0; k < i_whitespace; k++ )
1091 if( s[k] == '\n' ) spc = '\n';
1092
1093 if( i_whitespace > 1 )
1094 {
1095 memmove( &s[1],
1096 &s[i_whitespace],
1097 strlen( s ) - i_whitespace + 1 );
1098 }
1099 *s++ = spc;
1100
1101 s = strpbrk( s, "\t\r\n " );
1102 }
1103 return psz_text;
1104 }
1105
1106 /****************************************************************************
1107 * download and resize image located at psz_url
1108 ***************************************************************************/
1109 static subpicture_region_t *LoadEmbeddedImage( decoder_t *p_dec,
1110 const char *psz_filename,
1111 int i_transparent_color )
1112 {
1113 decoder_sys_t *p_sys = p_dec->p_sys;
1114 subpicture_region_t *p_region;
1115 video_format_t fmt_out;
1116 picture_t *p_pic = NULL;
1117
1118 for( int k = 0; k < p_sys->i_images; k++ )
1119 {
1120 if( p_sys->pp_images &&
1121 !strcmp( p_sys->pp_images[k]->psz_filename, psz_filename ) )
1122 {
1123 p_pic = p_sys->pp_images[k]->p_pic;
1124 break;
1125 }
1126 }
1127
1128 if( !p_pic )
1129 {
1130 msg_Err( p_dec, "Unable to read image %s", psz_filename );
1131 return NULL;
1132 }
1133
1134 /* Display the feed's image */
1135 memset( &fmt_out, 0, sizeof( video_format_t));
1136
1137 fmt_out.i_chroma = VLC_CODEC_YUVA;
1138 fmt_out.i_sar_num = fmt_out.i_sar_den = 1;
1139 fmt_out.i_width =
1140 fmt_out.i_visible_width = p_pic->format.i_visible_width;
1141 fmt_out.i_height =
1142 fmt_out.i_visible_height = p_pic->format.i_visible_height;
1143
1144 p_region = subpicture_region_New( &fmt_out );
1145 if( !p_region )
1146 {
1147 msg_Err( p_dec, "cannot allocate SPU region" );
1148 return NULL;
1149 }
1150 assert( p_pic->format.i_chroma == VLC_CODEC_YUVA );
1151 /* FIXME the copy is probably not needed anymore */
1152 picture_CopyPixels( p_region->p_picture, p_pic );
1153
1154 /* This isn't the best way to do this - if you really want transparency, then
1155 * you're much better off using an image type that supports it like PNG. The
1156 * spec requires this support though.
1157 */
1158 if( i_transparent_color > 0 )
1159 {
1160 int i_r = ( i_transparent_color >> 16 ) & 0xff;
1161 int i_g = ( i_transparent_color >> 8 ) & 0xff;
1162 int i_b = ( i_transparent_color ) & 0xff;
1163
1164 /* FIXME it cannot work as the yuv conversion code will probably NOT match
1165 * this one */
1166 int i_y = ( ( ( 66 * i_r + 129 * i_g + 25 * i_b + 128 ) >> 8 ) + 16 );
1167 int i_u = ( ( -38 * i_r - 74 * i_g + 112 * i_b + 128 ) >> 8 ) + 128 ;
1168 int i_v = ( ( 112 * i_r - 94 * i_g - 18 * i_b + 128 ) >> 8 ) + 128 ;
1169
1170 assert( p_region->fmt.i_chroma == VLC_CODEC_YUVA );
1171 for( unsigned int y = 0; y < p_region->fmt.i_height; y++ )
1172 {
1173 for( unsigned int x = 0; x < p_region->fmt.i_width; x++ )
1174 {
1175 if( p_region->p_picture->Y_PIXELS[y*p_region->p_picture->Y_PITCH + x] != i_y ||
1176 p_region->p_picture->U_PIXELS[y*p_region->p_picture->U_PITCH + x] != i_u ||
1177 p_region->p_picture->V_PIXELS[y*p_region->p_picture->V_PITCH + x] != i_v )
1178 continue;
1179 p_region->p_picture->A_PIXELS[y*p_region->p_picture->A_PITCH + x] = 0;
1180
1181 }
1182 }
1183 }
1184 return p_region;
1185 }
VLC Development tree mirror