git.sesse.net Git - vlc/blob - modules/codec/subsass.c

   1 /*****************************************************************************
   2  * subsass.c : ASS/SSA subtitles decoder
   3  *****************************************************************************
   4  * Copyright (C) 2000-2006 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Gildas Bazin <gbazin@videolan.org>
   8  *          Samuel Hocevar <sam@zoy.org>
   9  *          Derk-Jan Hartman <hartman at videolan dot org>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  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 General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  24  *****************************************************************************/
  25 #ifdef HAVE_CONFIG_H
  26 # include "config.h"
  27 #endif
  28
  29 #include "subsdec.h"
  30
  31
  32 void ParseSSAString( decoder_t *p_dec,
  33                      char *psz_subtitle,
  34                      subpicture_t *p_spu_in )
  35 {
  36     /* We expect MKV formatted SSA:
  37      * ReadOrder, Layer, Style, CharacterName, MarginL, MarginR,
  38      * MarginV, Effect, Text */
  39     decoder_sys_t   *p_sys = p_dec->p_sys;
  40     subpicture_t    *p_spu = p_spu_in;
  41     ssa_style_t     *p_ssa_style = NULL;
  42     char            *psz_new_subtitle = NULL;
  43     char            *psz_buffer_sub = NULL;
  44     char            *psz_style = NULL;
  45     char            *psz_style_start = NULL;
  46     char            *psz_style_end = NULL;
  47     int             i_text = 0, i_comma = 0, i_strlen = 0, i;
  48     int             i_margin_l = 0, i_margin_r = 0, i_margin_v = 0;
  49
  50     psz_buffer_sub = psz_subtitle;
  51
  52     p_spu->p_region->psz_html = NULL;
  53
  54     i_comma = 0;
  55     while( i_comma < 8 && *psz_buffer_sub != '\0' )
  56     {
  57         if( *psz_buffer_sub == ',' )
  58         {
  59             i_comma++;
  60             if( i_comma == 2 )
  61                 psz_style_start = &psz_buffer_sub[1];
  62             else if( i_comma == 3 )
  63                 psz_style_end = &psz_buffer_sub[0];
  64             else if( i_comma == 4 )
  65                 i_margin_l = (int)strtol( &psz_buffer_sub[1], NULL, 10 );
  66             else if( i_comma == 5 )
  67                 i_margin_r = (int)strtol( &psz_buffer_sub[1], NULL, 10 );
  68             else if( i_comma == 6 )
  69                 i_margin_v = (int)strtol( &psz_buffer_sub[1], NULL, 10 );
  70         }
  71         psz_buffer_sub++;
  72     }
  73
  74     if( *psz_buffer_sub == '\0' && i_comma == 8 )
  75     {
  76         msg_Dbg( p_dec, "couldn't find all fields in this SSA line" );
  77         return;
  78     }
  79
  80     psz_new_subtitle = malloc( strlen( psz_buffer_sub ) + 1);
  81     i_text = 0;
  82     while( psz_buffer_sub[0] != '\0' )
  83     {
  84         if( psz_buffer_sub[0] == '\\' && psz_buffer_sub[1] == 'n' )
  85         {
  86             psz_new_subtitle[i_text] = ' ';
  87             i_text++;
  88             psz_buffer_sub += 2;
  89         }
  90         else if( psz_buffer_sub[0] == '\\' && psz_buffer_sub[1] == 'N' )
  91         {
  92             psz_new_subtitle[i_text] = '\n';
  93             i_text++;
  94             psz_buffer_sub += 2;
  95         }
  96         else if( psz_buffer_sub[0] == '{' )
  97         {
  98             /* { } Control code in SSA. Cannot be escaped */
  99             while( psz_buffer_sub[0] != '\0' &&
 100                    psz_buffer_sub[0] != '}' )
 101             {
 102                 psz_buffer_sub++;
 103             }
 104             if( psz_buffer_sub[0] == '}' ) psz_buffer_sub++;
 105         }
 106         else
 107         {
 108             psz_new_subtitle[i_text] = psz_buffer_sub[0];
 109             i_text++;
 110             psz_buffer_sub++;
 111         }
 112     }
 113     psz_new_subtitle[i_text] = '\0';
 114
 115     i_strlen = __MAX( psz_style_end - psz_style_start, 0);
 116     psz_style = strndup( psz_style_start, i_strlen );
 117
 118     for( i = 0; i < p_sys->i_ssa_styles; i++ )
 119     {
 120         if( !strcmp( p_sys->pp_ssa_styles[i]->psz_stylename, psz_style ) )
 121             p_ssa_style = p_sys->pp_ssa_styles[i];
 122     }
 123     free( psz_style );
 124
 125     p_spu->p_region->psz_text = psz_new_subtitle;
 126     if( p_ssa_style == NULL )
 127     {
 128         p_spu->p_region->i_align = SUBPICTURE_ALIGN_BOTTOM | p_sys->i_align;
 129         p_spu->p_region->i_x = p_sys->i_align ? 20 : 0;
 130         p_spu->p_region->i_y = 10;
 131     }
 132     else
 133     {
 134         msg_Dbg( p_dec, "style is: %s", p_ssa_style->psz_stylename );
 135         p_spu->p_region->p_style = text_style_Duplicate( &p_ssa_style->font_style );
 136         p_spu->p_region->i_align = p_ssa_style->i_align;
 137         if( p_ssa_style->i_align & SUBPICTURE_ALIGN_LEFT )
 138         {
 139             p_spu->p_region->i_x = (i_margin_l) ? i_margin_l : p_ssa_style->i_margin_h;
 140         }
 141         else if( p_ssa_style->i_align & SUBPICTURE_ALIGN_RIGHT )
 142         {
 143             p_spu->p_region->i_x = (i_margin_r) ? i_margin_r : p_ssa_style->i_margin_h;
 144         }
 145         p_spu->p_region->i_y = (i_margin_v) ? i_margin_v : p_ssa_style->i_margin_v;
 146     }
 147 }
 148
 149 /*****************************************************************************
 150  * ParseColor: SSA stores color in BBGGRR, in ASS it uses AABBGGRR
 151  * The string value in the string can be a pure integer, or hexadecimal &HBBGGRR
 152  *****************************************************************************/
 153 static void ParseColor( char *psz_color, int *pi_color, int *pi_alpha )
 154 {
 155     int i_color = 0;
 156     if( !strncasecmp( psz_color, "&H", 2 ) )
 157     {
 158         /* textual HEX representation */
 159         i_color = (int) strtol( psz_color+2, NULL, 16 );
 160     }
 161     else i_color = (int) strtol( psz_color, NULL, 0 );
 162
 163     *pi_color = 0;
 164     *pi_color |= ( ( i_color & 0x000000FF ) << 16 ); /* Red */
 165     *pi_color |= ( ( i_color & 0x0000FF00 ) );       /* Green */
 166     *pi_color |= ( ( i_color & 0x00FF0000 ) >> 16 ); /* Blue */
 167
 168     if( pi_alpha != NULL )
 169         *pi_alpha = ( i_color & 0xFF000000 ) >> 24;
 170 }
 171
 172 /*****************************************************************************
 173  * ParseSSAHeader: Retrieve global formatting information etc
 174  *****************************************************************************/
 175 void ParseSSAHeader( decoder_t *p_dec )
 176 {
 177     decoder_sys_t *p_sys = p_dec->p_sys;
 178     char *psz_parser = NULL;
 179     char *psz_header = malloc( p_dec->fmt_in.i_extra+1 );
 180     int i_section_type = 1;
 181
 182     memcpy( psz_header, p_dec->fmt_in.p_extra, p_dec->fmt_in.i_extra );
 183     psz_header[ p_dec->fmt_in.i_extra] = '\0';
 184
 185     /* Handle [Script Info] section */
 186     psz_parser = strcasestr( psz_header, "[Script Info]" );
 187     if( psz_parser == NULL ) goto eof;
 188
 189     psz_parser = GotoNextLine( psz_parser );
 190
 191     while( psz_parser[0] != '\0' )
 192     {
 193         int temp;
 194         char buffer_text[MAX_LINE + 1];
 195
 196         if( psz_parser[0] == '!' || psz_parser[0] == ';' ) /* comment */;
 197         else if( sscanf( psz_parser, "PlayResX: %d", &temp ) == 1 )
 198             p_sys->i_original_width = ( temp > 0 ) ? temp : -1;
 199         else if( sscanf( psz_parser, "PlayResY: %d", &temp ) == 1 )
 200             p_sys->i_original_height = ( temp > 0 ) ? temp : -1;
 201         else if( sscanf( psz_parser, "Script Type: %8192s", buffer_text ) == 1 )
 202         {
 203             if( !strcasecmp( buffer_text, "V4.00+" ) ) p_sys->b_ass = true;
 204         }
 205         else if( !strncasecmp( psz_parser, "[V4 Styles]", 11 ) )
 206             i_section_type = 1;
 207         else if( !strncasecmp( psz_parser, "[V4+ Styles]", 12) )
 208         {
 209             i_section_type = 2;
 210             p_sys->b_ass = true;
 211         }
 212         else if( !strncasecmp( psz_parser, "[Events]", 8 ) )
 213             i_section_type = 4;
 214         else if( !strncasecmp( psz_parser, "Style:", 6 ) )
 215         {
 216             int i_font_size, i_bold, i_italic, i_border, i_outline, i_shadow,
 217                 i_underline, i_strikeout, i_scale_x, i_scale_y, i_spacing,
 218                 i_align, i_margin_l, i_margin_r, i_margin_v;
 219
 220             char psz_temp_stylename[MAX_LINE+1];
 221             char psz_temp_fontname[MAX_LINE+1];
 222             char psz_temp_color1[MAX_LINE+1];
 223             char psz_temp_color2[MAX_LINE+1];
 224             char psz_temp_color3[MAX_LINE+1];
 225             char psz_temp_color4[MAX_LINE+1];
 226
 227             if( i_section_type == 1 ) /* V4 */
 228             {
 229                 if( sscanf( psz_parser, "Style: %8192[^,],%8192[^,],%d,%8192[^,],%8192[^,],%8192[^,],%8192[^,],%d,%d,%d,%d,%d,%d,%d,%d,%d%*[^\r\n]",
 230                     psz_temp_stylename, psz_temp_fontname, &i_font_size,
 231                     psz_temp_color1, psz_temp_color2, psz_temp_color3,
 232                     psz_temp_color4, &i_bold, &i_italic,
 233                     &i_border, &i_outline, &i_shadow, &i_align, &i_margin_l,
 234                     &i_margin_r, &i_margin_v ) == 16 )
 235                 {
 236                     ssa_style_t *p_ssa_style = malloc( sizeof(ssa_style_t) );
 237
 238                     p_ssa_style->psz_stylename = strdup( psz_temp_stylename );
 239                     p_ssa_style->font_style.psz_fontname = strdup( psz_temp_fontname );
 240                     p_ssa_style->font_style.i_font_size = i_font_size;
 241
 242                     ParseColor( psz_temp_color1, &p_ssa_style->font_style.i_font_color, NULL );
 243                     ParseColor( psz_temp_color4, &p_ssa_style->font_style.i_shadow_color, NULL );
 244                     p_ssa_style->font_style.i_outline_color = p_ssa_style->font_style.i_shadow_color;
 245                     p_ssa_style->font_style.i_font_alpha = p_ssa_style->font_style.i_outline_alpha
 246                                                      = p_ssa_style->font_style.i_shadow_alpha = 0x00;
 247                     p_ssa_style->font_style.i_style_flags = 0;
 248                     if( i_bold ) p_ssa_style->font_style.i_style_flags |= STYLE_BOLD;
 249                     if( i_italic ) p_ssa_style->font_style.i_style_flags |= STYLE_ITALIC;
 250
 251                     if( i_border == 1 )
 252                         p_ssa_style->font_style.i_style_flags |= (STYLE_ITALIC | STYLE_OUTLINE);
 253                     else if( i_border == 3 )
 254                     {
 255                         p_ssa_style->font_style.i_style_flags |= STYLE_BACKGROUND;
 256                         p_ssa_style->font_style.i_background_color = p_ssa_style->font_style.i_shadow_color;
 257                         p_ssa_style->font_style.i_background_alpha = p_ssa_style->font_style.i_shadow_alpha;
 258                     }
 259                     p_ssa_style->font_style.i_shadow_width = i_shadow;
 260                     p_ssa_style->font_style.i_outline_width = i_outline;
 261
 262                     p_ssa_style->i_align = 0;
 263                     if( i_align == 1 || i_align == 5 || i_align == 9 )
 264                         p_ssa_style->i_align |= SUBPICTURE_ALIGN_LEFT;
 265                     if( i_align == 3 || i_align == 7 || i_align == 11 )
 266                         p_ssa_style->i_align |= SUBPICTURE_ALIGN_RIGHT;
 267                     if( i_align < 4 )
 268                         p_ssa_style->i_align |= SUBPICTURE_ALIGN_BOTTOM;
 269                     else if( i_align < 8 )
 270                         p_ssa_style->i_align |= SUBPICTURE_ALIGN_TOP;
 271
 272                     p_ssa_style->i_margin_h = ( p_ssa_style->i_align & SUBPICTURE_ALIGN_RIGHT ) ?
 273                                                         i_margin_r : i_margin_l;
 274                     p_ssa_style->i_margin_v = i_margin_v;
 275                     p_ssa_style->i_margin_percent_h = 0;
 276                     p_ssa_style->i_margin_percent_v = 0;
 277
 278                     p_ssa_style->font_style.i_karaoke_background_color = 0xffffff;
 279                     p_ssa_style->font_style.i_karaoke_background_alpha = 0xff;
 280
 281                     TAB_APPEND( p_sys->i_ssa_styles, p_sys->pp_ssa_styles, p_ssa_style );
 282                 }
 283                 else msg_Warn( p_dec, "SSA v4 styleline parsing failed" );
 284             }
 285             else if( i_section_type == 2 ) /* V4+ */
 286             {
 287                 /* Format: Name, Fontname, Fontsize, PrimaryColour, SecondaryColour, OutlineColour, BackColour,
 288                    Bold, Italic, Underline, StrikeOut, ScaleX, ScaleY, Spacing, Angle, BorderStyle, Outline,
 289                    Shadow, Alignment, MarginL, MarginR, MarginV, Encoding
 290                 */
 291                 if( sscanf( psz_parser, "Style: %8192[^,],%8192[^,],%d,%8192[^,],%8192[^,],%8192[^,],%8192[^,],%d,%d,%d,%d,%d,%d,%d,%*f,%d,%d,%d,%d,%d,%d,%d%*[^\r\n]",
 292                     psz_temp_stylename, psz_temp_fontname, &i_font_size,
 293                     psz_temp_color1, psz_temp_color2, psz_temp_color3, psz_temp_color4, &i_bold, &i_italic,
 294                     &i_underline, &i_strikeout, &i_scale_x, &i_scale_y, &i_spacing, &i_border, &i_outline,
 295                     &i_shadow, &i_align, &i_margin_l, &i_margin_r, &i_margin_v ) == 21 )
 296                 {
 297                     ssa_style_t *p_ssa_style = malloc( sizeof(ssa_style_t) );
 298
 299                     p_ssa_style->psz_stylename = strdup( psz_temp_stylename );
 300                     p_ssa_style->font_style.psz_fontname = strdup( psz_temp_fontname );
 301                     p_ssa_style->font_style.i_font_size = i_font_size;
 302                     ParseColor( psz_temp_color1, &p_ssa_style->font_style.i_font_color,
 303                                 &p_ssa_style->font_style.i_font_alpha );
 304                     ParseColor( psz_temp_color3, &p_ssa_style->font_style.i_outline_color,
 305                                 &p_ssa_style->font_style.i_outline_alpha );
 306                     ParseColor( psz_temp_color4, &p_ssa_style->font_style.i_shadow_color,
 307                                 &p_ssa_style->font_style.i_shadow_alpha );
 308
 309                     p_ssa_style->font_style.i_style_flags = 0;
 310                     if( i_bold ) p_ssa_style->font_style.i_style_flags |= STYLE_BOLD;
 311                     if( i_italic ) p_ssa_style->font_style.i_style_flags |= STYLE_ITALIC;
 312                     if( i_underline ) p_ssa_style->font_style.i_style_flags |= STYLE_UNDERLINE;
 313                     if( i_strikeout ) p_ssa_style->font_style.i_style_flags |= STYLE_STRIKEOUT;
 314                     if( i_border == 1 ) p_ssa_style->font_style.i_style_flags |= (STYLE_ITALIC | STYLE_OUTLINE);
 315                     else if( i_border == 3 )
 316                     {
 317                         p_ssa_style->font_style.i_style_flags |= STYLE_BACKGROUND;
 318                         p_ssa_style->font_style.i_background_color = p_ssa_style->font_style.i_shadow_color;
 319                         p_ssa_style->font_style.i_background_alpha = p_ssa_style->font_style.i_shadow_alpha;
 320                     }
 321                     p_ssa_style->font_style.i_shadow_width  = ( i_border == 1 ) ? i_shadow : 0;
 322                     p_ssa_style->font_style.i_outline_width = ( i_border == 1 ) ? i_outline : 0;
 323                     p_ssa_style->font_style.i_spacing = i_spacing;
 324                     //p_ssa_style->font_style.f_angle = f_angle;
 325
 326                     p_ssa_style->i_align = 0;
 327                     if( i_align == 0x1 || i_align == 0x4 || i_align == 0x7 )
 328                         p_ssa_style->i_align |= SUBPICTURE_ALIGN_LEFT;
 329                     if( i_align == 0x3 || i_align == 0x6 || i_align == 0x9 )
 330                         p_ssa_style->i_align |= SUBPICTURE_ALIGN_RIGHT;
 331                     if( i_align == 0x7 || i_align == 0x8 || i_align == 0x9 )
 332                         p_ssa_style->i_align |= SUBPICTURE_ALIGN_TOP;
 333                     if( i_align == 0x1 || i_align == 0x2 || i_align == 0x3 )
 334                         p_ssa_style->i_align |= SUBPICTURE_ALIGN_BOTTOM;
 335                     p_ssa_style->i_margin_h = ( p_ssa_style->i_align & SUBPICTURE_ALIGN_RIGHT ) ?
 336                                             i_margin_r : i_margin_l;
 337                     p_ssa_style->i_margin_v = i_margin_v;
 338                     p_ssa_style->i_margin_percent_h = 0;
 339                     p_ssa_style->i_margin_percent_v = 0;
 340
 341                     p_ssa_style->font_style.i_karaoke_background_color = 0xffffff;
 342                     p_ssa_style->font_style.i_karaoke_background_alpha = 0xff;
 343
 344                     /*TODO: Ignored: angle i_scale_x|y (fontscaling), i_encoding */
 345                     TAB_APPEND( p_sys->i_ssa_styles, p_sys->pp_ssa_styles, p_ssa_style );
 346                 }
 347                 else msg_Dbg( p_dec, "SSA V4+ styleline parsing failed" );
 348             }
 349         }
 350         psz_parser = GotoNextLine( psz_parser );
 351     }
 352
 353 eof:
 354     free( psz_header );
 355     return;
 356 }
 357
 358