1 /*****************************************************************************
2 * subsusf.c : USF subtitles decoder
3 *****************************************************************************
4 * Copyright (C) 2000-2006 the VideoLAN team
7 * Authors: Bernie Purcell <bitmap@videolan.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
28 #include <vlc_plugin.h>
31 /*****************************************************************************
33 *****************************************************************************/
34 static int OpenDecoder ( vlc_object_t * );
35 static void CloseDecoder ( vlc_object_t * );
37 static subpicture_t *DecodeBlock ( decoder_t *, block_t ** );
38 static char *CreatePlainText( char * );
39 static int ParseImageAttachments( decoder_t *p_dec );
41 static subpicture_t *ParseText ( decoder_t *, block_t * );
42 static void ParseUSFHeader( decoder_t * );
43 static subpicture_region_t *ParseUSFString( decoder_t *, char * );
44 static subpicture_region_t *LoadEmbeddedImage( decoder_t *p_dec, const char *psz_filename, int i_transparent_color );
46 /*****************************************************************************
48 *****************************************************************************/
51 set_capability( "decoder", 40 )
52 set_shortname( N_("USFSubs"))
53 set_description( N_("USF subtitles decoder") )
54 set_callbacks( OpenDecoder, CloseDecoder )
55 set_category( CAT_INPUT )
56 set_subcategory( SUBCAT_INPUT_SCODEC )
57 /* We inherit subsdec-align and subsdec-formatted from subsdec.c */
60 /*****************************************************************************
61 * OpenDecoder: probe the decoder and return score
62 *****************************************************************************
63 * Tries to launch a decoder and return score so that the interface is able
65 *****************************************************************************/
66 static int OpenDecoder( vlc_object_t *p_this )
68 decoder_t *p_dec = (decoder_t*)p_this;
71 if( p_dec->fmt_in.i_codec != VLC_CODEC_USF )
74 /* Allocate the memory needed to store the decoder's structure */
75 if( ( p_dec->p_sys = p_sys = calloc(1, sizeof(decoder_sys_t)) ) == NULL )
78 p_dec->pf_decode_sub = DecodeBlock;
79 p_dec->fmt_out.i_cat = SPU_ES;
80 p_dec->fmt_out.i_codec = 0;
82 /* Unused fields of p_sys - not needed for USF decoding */
84 p_sys->iconv_handle = (vlc_iconv_t)-1;
85 p_sys->b_autodetect_utf8 = false;
89 p_sys->i_original_height = 0;
90 p_sys->i_original_width = 0;
91 TAB_INIT( p_sys->i_ssa_styles, p_sys->pp_ssa_styles );
92 TAB_INIT( p_sys->i_images, p_sys->pp_images );
94 /* USF subtitles are mandated to be UTF-8, so don't need vlc_iconv */
96 p_sys->i_align = var_CreateGetInteger( p_dec, "subsdec-align" );
98 ParseImageAttachments( p_dec );
100 if( var_CreateGetBool( p_dec, "subsdec-formatted" ) )
102 if( p_dec->fmt_in.i_extra > 0 )
103 ParseUSFHeader( p_dec );
109 /****************************************************************************
110 * DecodeBlock: the whole thing
111 ****************************************************************************
112 * This function must be fed with complete subtitles units.
113 ****************************************************************************/
114 static subpicture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
119 if( !pp_block || *pp_block == NULL )
124 p_spu = ParseText( p_dec, p_block );
126 block_Release( p_block );
132 /*****************************************************************************
133 * CloseDecoder: clean up the decoder
134 *****************************************************************************/
135 static void CloseDecoder( vlc_object_t *p_this )
137 decoder_t *p_dec = (decoder_t *)p_this;
138 decoder_sys_t *p_sys = p_dec->p_sys;
140 if( p_sys->pp_ssa_styles )
143 for( i = 0; i < p_sys->i_ssa_styles; i++ )
145 if( !p_sys->pp_ssa_styles[i] )
148 free( p_sys->pp_ssa_styles[i]->psz_stylename );
149 //FIXME: Make font_style a pointer and use text_style_* functions
150 free( p_sys->pp_ssa_styles[i]->font_style.psz_fontname );
151 free( p_sys->pp_ssa_styles[i] );
153 TAB_CLEAN( p_sys->i_ssa_styles, p_sys->pp_ssa_styles );
155 if( p_sys->pp_images )
158 for( i = 0; i < p_sys->i_images; i++ )
160 if( !p_sys->pp_images[i] )
163 if( p_sys->pp_images[i]->p_pic )
164 picture_Release( p_sys->pp_images[i]->p_pic );
165 free( p_sys->pp_images[i]->psz_filename );
167 free( p_sys->pp_images[i] );
169 TAB_CLEAN( p_sys->i_images, p_sys->pp_images );
175 /*****************************************************************************
176 * ParseText: parse an text subtitle packet and send it to the video output
177 *****************************************************************************/
178 static subpicture_t *ParseText( decoder_t *p_dec, block_t *p_block )
180 decoder_sys_t *p_sys = p_dec->p_sys;
181 subpicture_t *p_spu = NULL;
182 char *psz_subtitle = NULL;
184 /* We cannot display a subpicture with no date */
185 if( p_block->i_pts <= VLC_TS_INVALID )
187 msg_Warn( p_dec, "subtitle without a date" );
191 /* Check validity of packet data */
192 /* An "empty" line containing only \0 can be used to force
193 and ephemer picture from the screen */
194 if( p_block->i_buffer < 1 )
196 msg_Warn( p_dec, "no subtitle data" );
200 /* Should be resiliant against bad subtitles */
201 psz_subtitle = strndup( (const char *)p_block->p_buffer,
203 if( psz_subtitle == NULL )
206 /* USF Subtitles are mandated to be UTF-8 -- make sure it is */
207 if (EnsureUTF8( psz_subtitle ) == NULL)
209 msg_Err( p_dec, "USF subtitles must be in UTF-8 format.\n"
210 "This stream contains USF subtitles which aren't." );
213 /* Create the subpicture unit */
214 p_spu = decoder_NewSubpicture( p_dec, NULL );
217 msg_Warn( p_dec, "can't get spu buffer" );
218 free( psz_subtitle );
222 /* Decode USF strings */
223 p_spu->p_region = ParseUSFString( p_dec, psz_subtitle );
225 p_spu->i_start = p_block->i_pts;
226 p_spu->i_stop = p_block->i_pts + p_block->i_length;
227 p_spu->b_ephemer = (p_block->i_length == 0);
228 p_spu->b_absolute = false;
229 p_spu->i_original_picture_width = p_sys->i_original_width;
230 p_spu->i_original_picture_height = p_sys->i_original_height;
232 free( psz_subtitle );
237 static char *GrabAttributeValue( const char *psz_attribute,
238 const char *psz_tag_start )
240 if( psz_attribute && psz_tag_start )
242 char *psz_tag_end = strchr( psz_tag_start, '>' );
243 char *psz_found = strcasestr( psz_tag_start, psz_attribute );
247 psz_found += strlen( psz_attribute );
249 if(( *(psz_found++) == '=' ) &&
250 ( *(psz_found++) == '\"' ))
252 if( psz_found < psz_tag_end )
254 int i_len = strcspn( psz_found, "\"" );
255 return strndup( psz_found, i_len );
263 static ssa_style_t *ParseStyle( decoder_sys_t *p_sys, char *psz_subtitle )
265 ssa_style_t *p_ssa_style = NULL;
266 char *psz_style = GrabAttributeValue( "style", psz_subtitle );
272 for( i = 0; i < p_sys->i_ssa_styles; i++ )
274 if( !strcmp( p_sys->pp_ssa_styles[i]->psz_stylename, psz_style ) )
275 p_ssa_style = p_sys->pp_ssa_styles[i];
282 static int ParsePositionAttributeList( char *psz_subtitle, int *i_align,
287 char *psz_align = GrabAttributeValue( "alignment", psz_subtitle );
288 char *psz_margin_x = GrabAttributeValue( "horizontal-margin", psz_subtitle );
289 char *psz_margin_y = GrabAttributeValue( "vertical-margin", psz_subtitle );
291 char *psz_relative = GrabAttributeValue( "relative-to", psz_subtitle );
292 char *psz_rotate_x = GrabAttributeValue( "rotate-x", psz_subtitle );
293 char *psz_rotate_y = GrabAttributeValue( "rotate-y", psz_subtitle );
294 char *psz_rotate_z = GrabAttributeValue( "rotate-z", psz_subtitle );
297 *i_align = SUBPICTURE_ALIGN_BOTTOM;
303 if( !strcasecmp( "TopLeft", psz_align ) )
304 *i_align = SUBPICTURE_ALIGN_TOP | SUBPICTURE_ALIGN_LEFT;
305 else if( !strcasecmp( "TopCenter", psz_align ) )
306 *i_align = SUBPICTURE_ALIGN_TOP;
307 else if( !strcasecmp( "TopRight", psz_align ) )
308 *i_align = SUBPICTURE_ALIGN_TOP | SUBPICTURE_ALIGN_RIGHT;
309 else if( !strcasecmp( "MiddleLeft", psz_align ) )
310 *i_align = SUBPICTURE_ALIGN_LEFT;
311 else if( !strcasecmp( "MiddleCenter", psz_align ) )
313 else if( !strcasecmp( "MiddleRight", psz_align ) )
314 *i_align = SUBPICTURE_ALIGN_RIGHT;
315 else if( !strcasecmp( "BottomLeft", psz_align ) )
316 *i_align = SUBPICTURE_ALIGN_BOTTOM | SUBPICTURE_ALIGN_LEFT;
317 else if( !strcasecmp( "BottomCenter", psz_align ) )
318 *i_align = SUBPICTURE_ALIGN_BOTTOM;
319 else if( !strcasecmp( "BottomRight", psz_align ) )
320 *i_align = SUBPICTURE_ALIGN_BOTTOM | SUBPICTURE_ALIGN_RIGHT;
322 i_mask |= ATTRIBUTE_ALIGNMENT;
327 *i_x = atoi( psz_margin_x );
328 if( strchr( psz_margin_x, '%' ) )
329 i_mask |= ATTRIBUTE_X_PERCENT;
331 i_mask |= ATTRIBUTE_X;
333 free( psz_margin_x );
337 *i_y = atoi( psz_margin_y );
338 if( strchr( psz_margin_y, '%' ) )
339 i_mask |= ATTRIBUTE_Y_PERCENT;
341 i_mask |= ATTRIBUTE_Y;
343 free( psz_margin_y );
348 static void SetupPositions( subpicture_region_t *p_region, char *psz_subtitle )
354 i_mask = ParsePositionAttributeList( psz_subtitle, &i_align, &i_x, &i_y );
356 if( i_mask & ATTRIBUTE_ALIGNMENT )
357 p_region->i_align = i_align;
359 /* TODO: Setup % based offsets properly, without adversely affecting
360 * everything else in vlc. Will address with separate patch, to
361 * prevent this one being any more complicated.
363 if( i_mask & ATTRIBUTE_X )
365 else if( i_mask & ATTRIBUTE_X_PERCENT )
368 if( i_mask & ATTRIBUTE_Y )
370 else if( i_mask & ATTRIBUTE_Y_PERCENT )
374 static subpicture_region_t *CreateTextRegion( decoder_t *p_dec,
379 decoder_sys_t *p_sys = p_dec->p_sys;
380 subpicture_region_t *p_text_region;
383 /* Create a new subpicture region */
384 memset( &fmt, 0, sizeof(video_format_t) );
385 fmt.i_chroma = VLC_CODEC_TEXT;
386 fmt.i_width = fmt.i_height = 0;
387 fmt.i_x_offset = fmt.i_y_offset = 0;
388 p_text_region = subpicture_region_New( &fmt );
390 if( p_text_region != NULL )
392 ssa_style_t *p_ssa_style = NULL;
394 p_text_region->psz_text = NULL;
395 p_text_region->psz_html = strndup( psz_subtitle, i_len );
396 if( ! p_text_region->psz_html )
398 subpicture_region_Delete( p_text_region );
402 p_ssa_style = ParseStyle( p_sys, p_text_region->psz_html );
407 for( i = 0; i < p_sys->i_ssa_styles; i++ )
409 if( !strcasecmp( p_sys->pp_ssa_styles[i]->psz_stylename, "Default" ) )
410 p_ssa_style = p_sys->pp_ssa_styles[i];
416 msg_Dbg( p_dec, "style is: %s", p_ssa_style->psz_stylename );
418 p_text_region->p_style = text_style_Duplicate( &p_ssa_style->font_style );
419 p_text_region->i_align = p_ssa_style->i_align;
421 /* TODO: Setup % based offsets properly, without adversely affecting
422 * everything else in vlc. Will address with separate patch,
423 * to prevent this one being any more complicated.
425 * p_ssa_style->i_margin_percent_h;
426 * p_ssa_style->i_margin_percent_v;
428 p_text_region->i_x = p_ssa_style->i_margin_h;
429 p_text_region->i_y = p_ssa_style->i_margin_v;
434 p_text_region->i_align = SUBPICTURE_ALIGN_BOTTOM | i_sys_align;
435 p_text_region->i_x = i_sys_align ? 20 : 0;
436 p_text_region->i_y = 10;
438 /* Look for position arguments which may override the style-based
441 SetupPositions( p_text_region, psz_subtitle );
443 p_text_region->p_next = NULL;
445 return p_text_region;
448 static int ParseImageAttachments( decoder_t *p_dec )
450 decoder_sys_t *p_sys = p_dec->p_sys;
451 input_attachment_t **pp_attachments;
452 int i_attachments_cnt;
455 if( VLC_SUCCESS != decoder_GetInputAttachments( p_dec, &pp_attachments, &i_attachments_cnt ))
458 for( k = 0; k < i_attachments_cnt; k++ )
460 input_attachment_t *p_attach = pp_attachments[k];
462 vlc_fourcc_t type = image_Mime2Fourcc( p_attach->psz_mime );
465 ( p_attach->i_data > 0 ) &&
466 ( p_attach->p_data != NULL ) )
468 picture_t *p_pic = NULL;
469 image_handler_t *p_image;
471 p_image = image_HandlerCreate( p_dec );
472 if( p_image != NULL )
476 p_block = block_New( p_image->p_parent, p_attach->i_data );
478 if( p_block != NULL )
480 video_format_t fmt_in;
481 video_format_t fmt_out;
483 memcpy( p_block->p_buffer, p_attach->p_data, p_attach->i_data );
485 memset( &fmt_in, 0, sizeof( video_format_t));
486 memset( &fmt_out, 0, sizeof( video_format_t));
488 fmt_in.i_chroma = type;
489 fmt_out.i_chroma = VLC_CODEC_YUVA;
491 /* Find a suitable decoder module */
492 if( module_exists( "sdl_image" ) )
494 /* ffmpeg thinks it can handle bmp properly but it can't (at least
495 * not all of them), so use sdl_image if it is available */
499 var_Create( p_dec, "codec", VLC_VAR_MODULE | VLC_VAR_DOINHERIT );
500 val.psz_string = (char*) "sdl_image";
501 var_Set( p_dec, "codec", val );
504 p_pic = image_Read( p_image, p_block, &fmt_in, &fmt_out );
505 var_Destroy( p_dec, "codec" );
508 image_HandlerDelete( p_image );
512 image_attach_t *p_picture = malloc( sizeof(image_attach_t) );
516 p_picture->psz_filename = strdup( p_attach->psz_name );
517 p_picture->p_pic = p_pic;
519 TAB_APPEND( p_sys->i_images, p_sys->pp_images, p_picture );
523 vlc_input_attachment_Delete( pp_attachments[ k ] );
525 free( pp_attachments );
530 static void ParseUSFHeaderTags( decoder_t *p_dec, xml_reader_t *p_xml_reader )
532 decoder_sys_t *p_sys = p_dec->p_sys;
534 ssa_style_t *p_ssa_style = NULL;
535 int i_style_level = 0;
536 int i_metadata_level = 0;
538 while ( xml_ReaderRead( p_xml_reader ) == 1 )
540 switch ( xml_ReaderNodeType( p_xml_reader ) )
542 case XML_READER_TEXT:
543 case XML_READER_NONE:
545 case XML_READER_ENDELEM:
546 psz_node = xml_ReaderName( p_xml_reader );
550 switch (i_style_level)
553 if( !strcasecmp( "metadata", psz_node ) && (i_metadata_level == 1) )
559 if( !strcasecmp( "styles", psz_node ) )
565 if( !strcasecmp( "style", psz_node ) )
567 TAB_APPEND( p_sys->i_ssa_styles, p_sys->pp_ssa_styles, p_ssa_style );
577 case XML_READER_STARTELEM:
578 psz_node = xml_ReaderName( p_xml_reader );
583 if( !strcasecmp( "metadata", psz_node ) && (i_style_level == 0) )
587 else if( !strcasecmp( "resolution", psz_node ) &&
588 ( i_metadata_level == 1) )
590 while ( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
592 char *psz_name = xml_ReaderName ( p_xml_reader );
593 char *psz_value = xml_ReaderValue ( p_xml_reader );
595 if( psz_name && psz_value )
597 if( !strcasecmp( "x", psz_name ) )
598 p_sys->i_original_width = atoi( psz_value );
599 else if( !strcasecmp( "y", psz_name ) )
600 p_sys->i_original_height = atoi( psz_value );
606 else if( !strcasecmp( "styles", psz_node ) && (i_style_level == 0) )
610 else if( !strcasecmp( "style", psz_node ) && (i_style_level == 1) )
614 p_ssa_style = calloc( 1, sizeof(ssa_style_t) );
620 /* All styles are supposed to default to Default, and then
621 * one or more settings are over-ridden.
622 * At the moment this only effects styles defined AFTER
626 for( i = 0; i < p_sys->i_ssa_styles; i++ )
628 if( !strcasecmp( p_sys->pp_ssa_styles[i]->psz_stylename, "Default" ) )
630 ssa_style_t *p_default_style = p_sys->pp_ssa_styles[i];
632 memcpy( p_ssa_style, p_default_style, sizeof( ssa_style_t ) );
633 //FIXME: Make font_style a pointer. Actually we double copy some data here,
634 // we use text_style_Copy to avoid copying psz_fontname, though .
635 text_style_Copy( &p_ssa_style->font_style, &p_default_style->font_style );
636 p_ssa_style->psz_stylename = NULL;
640 while ( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
642 char *psz_name = xml_ReaderName ( p_xml_reader );
643 char *psz_value = xml_ReaderValue ( p_xml_reader );
645 if( psz_name && psz_value )
647 if( !strcasecmp( "name", psz_name ) )
648 p_ssa_style->psz_stylename = strdup( psz_value );
654 else if( !strcasecmp( "fontstyle", psz_node ) && (i_style_level == 2) )
656 while ( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
658 char *psz_name = xml_ReaderName ( p_xml_reader );
659 char *psz_value = xml_ReaderValue ( p_xml_reader );
661 if( psz_name && psz_value )
663 if( !strcasecmp( "face", psz_name ) )
665 free( p_ssa_style->font_style.psz_fontname );
666 p_ssa_style->font_style.psz_fontname = strdup( psz_value );
668 else if( !strcasecmp( "size", psz_name ) )
670 if( ( *psz_value == '+' ) || ( *psz_value == '-' ) )
672 int i_value = atoi( psz_value );
674 if( ( i_value >= -5 ) && ( i_value <= 5 ) )
675 p_ssa_style->font_style.i_font_size +=
676 ( i_value * p_ssa_style->font_style.i_font_size ) / 10;
677 else if( i_value < -5 )
678 p_ssa_style->font_style.i_font_size = - i_value;
679 else if( i_value > 5 )
680 p_ssa_style->font_style.i_font_size = i_value;
683 p_ssa_style->font_style.i_font_size = atoi( psz_value );
685 else if( !strcasecmp( "italic", psz_name ) )
687 if( !strcasecmp( "yes", psz_value ))
688 p_ssa_style->font_style.i_style_flags |= STYLE_ITALIC;
690 p_ssa_style->font_style.i_style_flags &= ~STYLE_ITALIC;
692 else if( !strcasecmp( "weight", psz_name ) )
694 if( !strcasecmp( "bold", psz_value ))
695 p_ssa_style->font_style.i_style_flags |= STYLE_BOLD;
697 p_ssa_style->font_style.i_style_flags &= ~STYLE_BOLD;
699 else if( !strcasecmp( "underline", psz_name ) )
701 if( !strcasecmp( "yes", psz_value ))
702 p_ssa_style->font_style.i_style_flags |= STYLE_UNDERLINE;
704 p_ssa_style->font_style.i_style_flags &= ~STYLE_UNDERLINE;
706 else if( !strcasecmp( "color", psz_name ) )
708 if( *psz_value == '#' )
710 unsigned long col = strtol(psz_value+1, NULL, 16);
711 p_ssa_style->font_style.i_font_color = (col & 0x00ffffff);
712 p_ssa_style->font_style.i_font_alpha = (col >> 24) & 0xff;
715 else if( !strcasecmp( "outline-color", psz_name ) )
717 if( *psz_value == '#' )
719 unsigned long col = strtol(psz_value+1, NULL, 16);
720 p_ssa_style->font_style.i_outline_color = (col & 0x00ffffff);
721 p_ssa_style->font_style.i_outline_alpha = (col >> 24) & 0xff;
724 else if( !strcasecmp( "outline-level", psz_name ) )
726 p_ssa_style->font_style.i_outline_width = atoi( psz_value );
728 else if( !strcasecmp( "shadow-color", psz_name ) )
730 if( *psz_value == '#' )
732 unsigned long col = strtol(psz_value+1, NULL, 16);
733 p_ssa_style->font_style.i_shadow_color = (col & 0x00ffffff);
734 p_ssa_style->font_style.i_shadow_alpha = (col >> 24) & 0xff;
737 else if( !strcasecmp( "shadow-level", psz_name ) )
739 p_ssa_style->font_style.i_shadow_width = atoi( psz_value );
741 else if( !strcasecmp( "back-color", psz_name ) )
743 if( *psz_value == '#' )
745 unsigned long col = strtol(psz_value+1, NULL, 16);
746 p_ssa_style->font_style.i_karaoke_background_color = (col & 0x00ffffff);
747 p_ssa_style->font_style.i_karaoke_background_alpha = (col >> 24) & 0xff;
750 else if( !strcasecmp( "spacing", psz_name ) )
752 p_ssa_style->font_style.i_spacing = atoi( psz_value );
759 else if( !strcasecmp( "position", psz_node ) && (i_style_level == 2) )
761 while ( xml_ReaderNextAttr( p_xml_reader ) == VLC_SUCCESS )
763 char *psz_name = xml_ReaderName ( p_xml_reader );
764 char *psz_value = xml_ReaderValue ( p_xml_reader );
766 if( psz_name && psz_value )
768 if( !strcasecmp( "alignment", psz_name ) )
770 if( !strcasecmp( "TopLeft", psz_value ) )
771 p_ssa_style->i_align = SUBPICTURE_ALIGN_TOP | SUBPICTURE_ALIGN_LEFT;
772 else if( !strcasecmp( "TopCenter", psz_value ) )
773 p_ssa_style->i_align = SUBPICTURE_ALIGN_TOP;
774 else if( !strcasecmp( "TopRight", psz_value ) )
775 p_ssa_style->i_align = SUBPICTURE_ALIGN_TOP | SUBPICTURE_ALIGN_RIGHT;
776 else if( !strcasecmp( "MiddleLeft", psz_value ) )
777 p_ssa_style->i_align = SUBPICTURE_ALIGN_LEFT;
778 else if( !strcasecmp( "MiddleCenter", psz_value ) )
779 p_ssa_style->i_align = 0;
780 else if( !strcasecmp( "MiddleRight", psz_value ) )
781 p_ssa_style->i_align = SUBPICTURE_ALIGN_RIGHT;
782 else if( !strcasecmp( "BottomLeft", psz_value ) )
783 p_ssa_style->i_align = SUBPICTURE_ALIGN_BOTTOM | SUBPICTURE_ALIGN_LEFT;
784 else if( !strcasecmp( "BottomCenter", psz_value ) )
785 p_ssa_style->i_align = SUBPICTURE_ALIGN_BOTTOM;
786 else if( !strcasecmp( "BottomRight", psz_value ) )
787 p_ssa_style->i_align = SUBPICTURE_ALIGN_BOTTOM | SUBPICTURE_ALIGN_RIGHT;
789 else if( !strcasecmp( "horizontal-margin", psz_name ) )
791 if( strchr( psz_value, '%' ) )
793 p_ssa_style->i_margin_h = 0;
794 p_ssa_style->i_margin_percent_h = atoi( psz_value );
798 p_ssa_style->i_margin_h = atoi( psz_value );
799 p_ssa_style->i_margin_percent_h = 0;
802 else if( !strcasecmp( "vertical-margin", psz_name ) )
804 if( strchr( psz_value, '%' ) )
806 p_ssa_style->i_margin_v = 0;
807 p_ssa_style->i_margin_percent_v = atoi( psz_value );
811 p_ssa_style->i_margin_v = atoi( psz_value );
812 p_ssa_style->i_margin_percent_v = 0;
830 static subpicture_region_t *ParseUSFString( decoder_t *p_dec,
833 decoder_sys_t *p_sys = p_dec->p_sys;
834 subpicture_region_t *p_region_first = NULL;
835 subpicture_region_t *p_region_upto = p_region_first;
837 while( *psz_subtitle )
839 if( *psz_subtitle == '<' )
841 char *psz_end = NULL;
843 if(( !strncasecmp( psz_subtitle, "<text ", 6 )) ||
844 ( !strncasecmp( psz_subtitle, "<text>", 6 )))
846 psz_end = strcasestr( psz_subtitle, "</text>" );
850 subpicture_region_t *p_text_region;
852 psz_end += strcspn( psz_end, ">" ) + 1;
854 p_text_region = CreateTextRegion( p_dec,
856 psz_end - psz_subtitle,
861 p_text_region->psz_text = CreatePlainText( p_text_region->psz_html );
863 if( ! var_CreateGetBool( p_dec, "subsdec-formatted" ) )
865 free( p_text_region->psz_html );
866 p_text_region->psz_html = NULL;
870 if( !p_region_first )
872 p_region_first = p_region_upto = p_text_region;
874 else if( p_text_region )
876 p_region_upto->p_next = p_text_region;
877 p_region_upto = p_region_upto->p_next;
881 else if(( !strncasecmp( psz_subtitle, "<karaoke ", 9 )) ||
882 ( !strncasecmp( psz_subtitle, "<karaoke>", 9 )))
884 psz_end = strcasestr( psz_subtitle, "</karaoke>" );
888 subpicture_region_t *p_text_region;
890 psz_end += strcspn( psz_end, ">" ) + 1;
892 p_text_region = CreateTextRegion( p_dec,
894 psz_end - psz_subtitle,
899 if( ! var_CreateGetBool( p_dec, "subsdec-formatted" ) )
901 free( p_text_region->psz_html );
902 p_text_region->psz_html = NULL;
905 if( !p_region_first )
907 p_region_first = p_region_upto = p_text_region;
909 else if( p_text_region )
911 p_region_upto->p_next = p_text_region;
912 p_region_upto = p_region_upto->p_next;
916 else if(( !strncasecmp( psz_subtitle, "<image ", 7 )) ||
917 ( !strncasecmp( psz_subtitle, "<image>", 7 )))
919 subpicture_region_t *p_image_region = NULL;
921 char *psz_end = strcasestr( psz_subtitle, "</image>" );
922 char *psz_content = strchr( psz_subtitle, '>' );
923 int i_transparent = -1;
925 /* If a colorkey parameter is specified, then we have to map
926 * that index in the picture through as transparent (it is
927 * required by the USF spec but is also recommended that if the
928 * creator really wants a transparent colour that they use a
929 * type like PNG that properly supports it; this goes doubly
930 * for VLC because the pictures are stored internally in YUV
931 * and the resulting colour-matching may not produce the
934 char *psz_tmp = GrabAttributeValue( "colorkey", psz_subtitle );
937 if( *psz_tmp == '#' )
938 i_transparent = strtol( psz_tmp + 1, NULL, 16 ) & 0x00ffffff;
941 if( psz_content && ( psz_content < psz_end ) )
943 char *psz_filename = strndup( &psz_content[1], psz_end - &psz_content[1] );
946 p_image_region = LoadEmbeddedImage( p_dec,
947 psz_filename, i_transparent );
948 free( psz_filename );
952 if( psz_end ) psz_end += strcspn( psz_end, ">" ) + 1;
956 SetupPositions( p_image_region, psz_subtitle );
958 p_image_region->p_next = NULL;
959 p_image_region->psz_text = NULL;
960 p_image_region->psz_html = NULL;
963 if( !p_region_first )
965 p_region_first = p_region_upto = p_image_region;
967 else if( p_image_region )
969 p_region_upto->p_next = p_image_region;
970 p_region_upto = p_region_upto->p_next;
974 psz_subtitle = psz_end - 1;
976 psz_subtitle += strcspn( psz_subtitle, ">" );
982 return p_region_first;
985 /*****************************************************************************
986 * ParseUSFHeader: Retrieve global formatting information etc
987 *****************************************************************************/
988 static void ParseUSFHeader( decoder_t *p_dec )
990 stream_t *p_sub = NULL;
992 xml_reader_t *p_xml_reader = NULL;
994 p_sub = stream_MemoryNew( VLC_OBJECT(p_dec),
995 p_dec->fmt_in.p_extra,
996 p_dec->fmt_in.i_extra,
1001 p_xml = xml_Create( p_dec );
1004 p_xml_reader = xml_ReaderCreate( p_xml, p_sub );
1007 /* Look for Root Node */
1008 if( xml_ReaderRead( p_xml_reader ) == 1 )
1010 char *psz_node = xml_ReaderName( p_xml_reader );
1012 if( !strcasecmp( "usfsubtitles", psz_node ) )
1013 ParseUSFHeaderTags( p_dec, p_xml_reader );
1018 xml_ReaderDelete( p_xml, p_xml_reader );
1020 xml_Delete( p_xml );
1022 stream_Delete( p_sub );
1025 /* Function now handles tags which has attribute values, and tries
1026 * to deal with &' commands too. It no longer modifies the string
1027 * in place, so that the original text can be reused
1029 static char *StripTags( char *psz_subtitle )
1031 char *psz_text_start;
1034 psz_text = psz_text_start = malloc( strlen( psz_subtitle ) + 1 );
1035 if( !psz_text_start )
1038 while( *psz_subtitle )
1040 /* Mask out any pre-existing LFs in the subtitle */
1041 if( *psz_subtitle == '\n' )
1042 *psz_subtitle = ' ';
1044 if( *psz_subtitle == '<' )
1046 if( strncasecmp( psz_subtitle, "<br/>", 5 ) == 0 )
1049 psz_subtitle += strcspn( psz_subtitle, ">" );
1051 else if( *psz_subtitle == '&' )
1053 if( !strncasecmp( psz_subtitle, "<", 4 ))
1056 psz_subtitle += strcspn( psz_subtitle, ";" );
1058 else if( !strncasecmp( psz_subtitle, ">", 4 ))
1061 psz_subtitle += strcspn( psz_subtitle, ";" );
1063 else if( !strncasecmp( psz_subtitle, "&", 5 ))
1066 psz_subtitle += strcspn( psz_subtitle, ";" );
1068 else if( !strncasecmp( psz_subtitle, """, 6 ))
1071 psz_subtitle += strcspn( psz_subtitle, ";" );
1075 /* Assume it is just a normal ampersand */
1081 *psz_text++ = *psz_subtitle;
1088 char *psz = realloc( psz_text_start, strlen( psz_text_start ) + 1 );
1089 if( psz ) psz_text_start = psz;
1091 return psz_text_start;
1094 /* Turn a HTML subtitle, turn into a plain-text version,
1095 * complete with sensible whitespace compaction
1098 static char *CreatePlainText( char *psz_subtitle )
1100 char *psz_text = StripTags( psz_subtitle );
1106 s = strpbrk( psz_text, "\t\r\n " );
1111 int i_whitespace = strspn( s, "\t\r\n " );
1113 /* Favour '\n' over other whitespaces - if one of these
1114 * occurs in the whitespace use a '\n' as our value,
1115 * otherwise just use a ' '
1117 for( k = 0; k < i_whitespace; k++ )
1118 if( s[k] == '\n' ) spc = '\n';
1120 if( i_whitespace > 1 )
1124 strlen( s ) - i_whitespace + 1 );
1128 s = strpbrk( s, "\t\r\n " );
1133 /****************************************************************************
1134 * download and resize image located at psz_url
1135 ***************************************************************************/
1136 static subpicture_region_t *LoadEmbeddedImage( decoder_t *p_dec,
1137 const char *psz_filename,
1138 int i_transparent_color )
1140 decoder_sys_t *p_sys = p_dec->p_sys;
1141 subpicture_region_t *p_region;
1142 video_format_t fmt_out;
1143 picture_t *p_pic = NULL;
1145 for( int k = 0; k < p_sys->i_images; k++ )
1147 if( p_sys->pp_images &&
1148 !strcmp( p_sys->pp_images[k]->psz_filename, psz_filename ) )
1150 p_pic = p_sys->pp_images[k]->p_pic;
1157 msg_Err( p_dec, "Unable to read image %s", psz_filename );
1161 /* Display the feed's image */
1162 memset( &fmt_out, 0, sizeof( video_format_t));
1164 fmt_out.i_chroma = VLC_CODEC_YUVA;
1165 fmt_out.i_sar_num = fmt_out.i_sar_den = 1;
1167 fmt_out.i_visible_width = p_pic->format.i_visible_width;
1169 fmt_out.i_visible_height = p_pic->format.i_visible_height;
1171 p_region = subpicture_region_New( &fmt_out );
1174 msg_Err( p_dec, "cannot allocate SPU region" );
1177 assert( p_pic->format.i_chroma == VLC_CODEC_YUVA );
1178 /* FIXME the copy is probably not needed anymore */
1179 picture_CopyPixels( p_region->p_picture, p_pic );
1181 /* This isn't the best way to do this - if you really want transparency, then
1182 * you're much better off using an image type that supports it like PNG. The
1183 * spec requires this support though.
1185 if( i_transparent_color > 0 )
1187 int i_r = ( i_transparent_color >> 16 ) & 0xff;
1188 int i_g = ( i_transparent_color >> 8 ) & 0xff;
1189 int i_b = ( i_transparent_color ) & 0xff;
1191 /* FIXME it cannot work as the yuv conversion code will probably NOT match
1193 int i_y = ( ( ( 66 * i_r + 129 * i_g + 25 * i_b + 128 ) >> 8 ) + 16 );
1194 int i_u = ( ( -38 * i_r - 74 * i_g + 112 * i_b + 128 ) >> 8 ) + 128 ;
1195 int i_v = ( ( 112 * i_r - 94 * i_g - 18 * i_b + 128 ) >> 8 ) + 128 ;
1197 assert( p_region->fmt.i_chroma == VLC_CODEC_YUVA );
1198 for( unsigned int y = 0; y < p_region->fmt.i_height; y++ )
1200 for( unsigned int x = 0; x < p_region->fmt.i_width; x++ )
1202 if( p_region->p_picture->Y_PIXELS[y*p_region->p_picture->Y_PITCH + x] != i_y ||
1203 p_region->p_picture->U_PIXELS[y*p_region->p_picture->U_PITCH + x] != i_u ||
1204 p_region->p_picture->V_PIXELS[y*p_region->p_picture->V_PITCH + x] != i_v )
1206 p_region->p_picture->A_PIXELS[y*p_region->p_picture->A_PITCH + x] = 0;