git.sesse.net Git - vlc/blob - modules/demux/subtitle.c

   1 /*****************************************************************************
   2  * subtitle.c: Demux for subtitle text files.
   3  *****************************************************************************
   4  * Copyright (C) 1999-2004 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   8  *          Derk-Jan Hartman <hartman at videolan dot org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 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 General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28 #include <stdlib.h>
  29
  30 #include <errno.h>
  31 #ifdef HAVE_SYS_TYPES_H
  32 #   include <sys/types.h>
  33 #endif
  34 #include <ctype.h>
  35
  36 #include <vlc/vlc.h>
  37 #include <vlc/input.h>
  38 #include "vlc_video.h"
  39
  40 /*****************************************************************************
  41  * Module descriptor
  42  *****************************************************************************/
  43 static int  Open ( vlc_object_t *p_this );
  44 static void Close( vlc_object_t *p_this );
  45
  46 #define SUB_DELAY_LONGTEXT \
  47     "Delay subtitles (in 1/10s)"
  48 #define SUB_FPS_LONGTEXT \
  49     "Override frames per second. " \
  50     "It will only work with MicroDVD subtitles."
  51 #define SUB_TYPE_LONGTEXT \
  52     "One from \"microdvd\", \"subrip\", \"ssa1\", \"ssa2-4\", \"ass\", \"vplayer\" " \
  53     "\"sami\", \"dvdsubtitle\" (auto for autodetection, it should always work)."
  54 static char *ppsz_sub_type[] =
  55 {
  56     "auto", "microdvd", "subrip", "subviewer", "ssa1",
  57     "ssa2-4", "ass", "vplayer", "sami", "dvdsubtitle"
  58 };
  59
  60 vlc_module_begin();
  61     set_shortname( _("Subtitles"));
  62     set_description( _("Text subtitles demux") );
  63     set_capability( "demux2", 0 );
  64     set_category( CAT_INPUT );
  65     set_subcategory( SUBCAT_INPUT_DEMUX );
  66     add_float( "sub-fps", 0.0, NULL,
  67                N_("Frames per second"),
  68                SUB_FPS_LONGTEXT, VLC_TRUE );
  69     add_integer( "sub-delay", 0, NULL,
  70                N_("Subtitles delay"),
  71                SUB_DELAY_LONGTEXT, VLC_TRUE );
  72     add_string( "sub-type", "auto", NULL, "Subtitles fileformat",
  73                 SUB_TYPE_LONGTEXT, VLC_TRUE );
  74         change_string_list( ppsz_sub_type, 0, 0 );
  75     set_callbacks( Open, Close );
  76
  77     add_shortcut( "subtitle" );
  78 vlc_module_end();
  79
  80 /*****************************************************************************
  81  * Prototypes:
  82  *****************************************************************************/
  83 enum
  84 {
  85     SUB_TYPE_UNKNOWN = -1,
  86     SUB_TYPE_MICRODVD,
  87     SUB_TYPE_SUBRIP,
  88     SUB_TYPE_SSA1,
  89     SUB_TYPE_SSA2_4,
  90     SUB_TYPE_ASS,
  91     SUB_TYPE_VPLAYER,
  92     SUB_TYPE_SAMI,
  93     SUB_TYPE_SUBVIEWER,
  94     SUB_TYPE_DVDSUBTITLE
  95 };
  96
  97 typedef struct
  98 {
  99     int     i_line_count;
 100     int     i_line;
 101     char    **line;
 102 } text_t;
 103 static int  TextLoad( text_t *, stream_t *s );
 104 static void TextUnload( text_t * );
 105
 106 typedef struct
 107 {
 108     int64_t i_start;
 109     int64_t i_stop;
 110
 111     char    *psz_text;
 112 } subtitle_t;
 113
 114
 115 struct demux_sys_t
 116 {
 117     int         i_type;
 118     text_t      txt;
 119     es_out_id_t *es;
 120
 121     int64_t     i_next_demux_date;
 122
 123     int64_t     i_microsecperframe;
 124     int64_t     i_original_mspf;
 125
 126     char        *psz_header;
 127     int         i_subtitle;
 128     int         i_subtitles;
 129     subtitle_t  *subtitle;
 130
 131     int64_t     i_length;
 132 };
 133
 134 static int  ParseMicroDvd   ( demux_t *, subtitle_t * );
 135 static int  ParseSubRip     ( demux_t *, subtitle_t * );
 136 static int  ParseSubViewer  ( demux_t *, subtitle_t * );
 137 static int  ParseSSA        ( demux_t *, subtitle_t * );
 138 static int  ParseVplayer    ( demux_t *, subtitle_t * );
 139 static int  ParseSami       ( demux_t *, subtitle_t * );
 140 static int  ParseDVDSubtitle( demux_t *, subtitle_t * );
 141
 142 static struct
 143 {
 144     char *psz_type_name;
 145     int  i_type;
 146     char *psz_name;
 147     int  (*pf_read)( demux_t *, subtitle_t* );
 148 } sub_read_subtitle_function [] =
 149 {
 150     { "microdvd",   SUB_TYPE_MICRODVD,    "MicroDVD",    ParseMicroDvd },
 151     { "subrip",     SUB_TYPE_SUBRIP,      "SubRIP",      ParseSubRip },
 152     { "subviewer",  SUB_TYPE_SUBVIEWER,   "SubViewer",   ParseSubViewer },
 153     { "ssa1",       SUB_TYPE_SSA1,        "SSA-1",       ParseSSA },
 154     { "ssa2-4",     SUB_TYPE_SSA2_4,      "SSA-2/3/4",   ParseSSA },
 155     { "ass",        SUB_TYPE_ASS,         "SSA/ASS",     ParseSSA },
 156     { "vplayer",    SUB_TYPE_VPLAYER,     "VPlayer",     ParseVplayer },
 157     { "sami",       SUB_TYPE_SAMI,        "SAMI",        ParseSami },
 158     { "dvdsubtitle",SUB_TYPE_DVDSUBTITLE, "DVDSubtitle", ParseDVDSubtitle },
 159     { NULL,         SUB_TYPE_UNKNOWN,     "Unknown",     NULL }
 160 };
 161
 162 static int Demux( demux_t * );
 163 static int Control( demux_t *, int, va_list );
 164
 165 /*static void Fix( demux_t * );*/
 166
 167 /*****************************************************************************
 168  * Module initializer
 169  *****************************************************************************/
 170 static int Open ( vlc_object_t *p_this )
 171 {
 172     demux_t     *p_demux = (demux_t*)p_this;
 173     demux_sys_t *p_sys;
 174     es_format_t fmt;
 175     float f_fps;
 176     char *psz_type;
 177     int  (*pf_read)( demux_t *, subtitle_t* );
 178     int i, i_max;
 179
 180     if( strcmp( p_demux->psz_demux, "subtitle" ) )
 181     {
 182         msg_Dbg( p_demux, "subtitle demux discarded" );
 183         return VLC_EGENERIC;
 184     }
 185
 186     p_demux->pf_demux = Demux;
 187     p_demux->pf_control = Control;
 188     p_demux->p_sys = p_sys = malloc( sizeof( demux_sys_t ) );
 189     p_sys->psz_header = NULL;
 190     p_sys->i_subtitle = 0;
 191     p_sys->i_subtitles= 0;
 192     p_sys->subtitle   = NULL;
 193
 194
 195     /* Get the FPS */
 196     f_fps = var_CreateGetFloat( p_demux, "sub-fps" );
 197     if( f_fps >= 1.0 )
 198     {
 199         p_sys->i_microsecperframe = (int64_t)( (float)1000000 / f_fps );
 200     }
 201     else
 202     {
 203         p_sys->i_microsecperframe = 0;
 204     }
 205
 206     f_fps = var_CreateGetFloat( p_demux, "sub-original-fps" );
 207     if( f_fps >= 1.0 )
 208     {
 209         p_sys->i_original_mspf = (int64_t)( (float)1000000 / f_fps );
 210     }
 211     else
 212     {
 213         p_sys->i_original_mspf = 0;
 214     }
 215
 216     /* Get or probe the type */
 217     p_sys->i_type = SUB_TYPE_UNKNOWN;
 218     psz_type = var_CreateGetString( p_demux, "sub-type" );
 219     if( *psz_type )
 220     {
 221         int i;
 222
 223         for( i = 0; ; i++ )
 224         {
 225             if( sub_read_subtitle_function[i].psz_type_name == NULL )
 226                 break;
 227
 228             if( !strcmp( sub_read_subtitle_function[i].psz_type_name,
 229                          psz_type ) )
 230             {
 231                 p_sys->i_type = sub_read_subtitle_function[i].i_type;
 232                 break;
 233             }
 234         }
 235     }
 236     free( psz_type );
 237
 238     /* Probe if unknown type */
 239     if( p_sys->i_type == SUB_TYPE_UNKNOWN )
 240     {
 241         int     i_try;
 242         char    *s = NULL;
 243
 244         msg_Dbg( p_demux, "autodetecting subtitle format" );
 245         for( i_try = 0; i_try < 256; i_try++ )
 246         {
 247             int i_dummy;
 248
 249             if( ( s = stream_ReadLine( p_demux->s ) ) == NULL )
 250                 break;
 251
 252             if( strcasestr( s, "<SAMI>" ) )
 253             {
 254                 p_sys->i_type = SUB_TYPE_SAMI;
 255                 break;
 256             }
 257             else if( sscanf( s, "{%d}{%d}", &i_dummy, &i_dummy ) == 2 ||
 258                      sscanf( s, "{%d}{}", &i_dummy ) == 1)
 259             {
 260                 p_sys->i_type = SUB_TYPE_MICRODVD;
 261                 break;
 262             }
 263             else if( sscanf( s,
 264                              "%d:%d:%d,%d --> %d:%d:%d,%d",
 265                              &i_dummy,&i_dummy,&i_dummy,&i_dummy,
 266                              &i_dummy,&i_dummy,&i_dummy,&i_dummy ) == 8 )
 267             {
 268                 p_sys->i_type = SUB_TYPE_SUBRIP;
 269                 break;
 270             }
 271             else if( !strncasecmp( s, "!: This is a Sub Station Alpha v1", 33 ) )
 272             {
 273                 p_sys->i_type = SUB_TYPE_SSA1;
 274                 break;
 275             }
 276             else if( !strncasecmp( s, "ScriptType: v4.00+", 18 ) )
 277             {
 278                 p_sys->i_type = SUB_TYPE_ASS;
 279                 break;
 280             }
 281             else if( !strncasecmp( s, "ScriptType: v4.00", 17 ) )
 282             {
 283                 p_sys->i_type = SUB_TYPE_SSA2_4;
 284                 break;
 285             }
 286             else if( !strncasecmp( s, "Dialogue: Marked", 16  ) )
 287             {
 288                 p_sys->i_type = SUB_TYPE_SSA2_4;
 289                 break;
 290             }
 291             else if( !strncasecmp( s, "Dialogue:", 9  ) )
 292             {
 293                 p_sys->i_type = SUB_TYPE_ASS;
 294                 break;
 295             }
 296             else if( strcasestr( s, "[INFORMATION]" ) )
 297             {
 298                 p_sys->i_type = SUB_TYPE_SUBVIEWER; /* I hope this will work */
 299                 break;
 300             }
 301             else if( sscanf( s, "%d:%d:%d:", &i_dummy, &i_dummy, &i_dummy ) == 3 ||
 302                      sscanf( s, "%d:%d:%d ", &i_dummy, &i_dummy, &i_dummy ) == 3 )
 303             {
 304                 p_sys->i_type = SUB_TYPE_VPLAYER;
 305                 break;
 306             }
 307             else if( sscanf( s, "{T %d:%d:%d:%d", &i_dummy, &i_dummy,
 308                              &i_dummy, &i_dummy ) == 4 )
 309             {
 310                 p_sys->i_type = SUB_TYPE_DVDSUBTITLE;
 311                 break;
 312             }
 313
 314             free( s );
 315             s = NULL;
 316         }
 317
 318         if( s ) free( s );
 319
 320         /* It will nearly always work even for non seekable stream thanks the
 321          * caching system, and if it fails we loose just a few sub */
 322         if( stream_Seek( p_demux->s, 0 ) )
 323         {
 324             msg_Warn( p_demux, "failed to rewind" );
 325         }
 326     }
 327     if( p_sys->i_type == SUB_TYPE_UNKNOWN )
 328     {
 329         msg_Err( p_demux, "failed to recognize subtitle type" );
 330         free( p_sys );
 331         return VLC_EGENERIC;
 332     }
 333
 334     for( i = 0; ; i++ )
 335     {
 336         if( sub_read_subtitle_function[i].i_type == p_sys->i_type )
 337         {
 338             msg_Dbg( p_demux, "detected %s format",
 339                      sub_read_subtitle_function[i].psz_name );
 340             pf_read = sub_read_subtitle_function[i].pf_read;
 341             break;
 342         }
 343     }
 344
 345     msg_Dbg( p_demux, "loading all subtitles..." );
 346
 347     /* Load the whole file */
 348     TextLoad( &p_sys->txt, p_demux->s );
 349
 350     /* Parse it */
 351     for( i_max = 0;; )
 352     {
 353         if( p_sys->i_subtitles >= i_max )
 354         {
 355             i_max += 500;
 356             if( !( p_sys->subtitle = realloc( p_sys->subtitle,
 357                                               sizeof(subtitle_t) * i_max ) ) )
 358             {
 359                 msg_Err( p_demux, "out of memory");
 360                 if( p_sys->subtitle != NULL )
 361                     free( p_sys->subtitle );
 362                 TextUnload( &p_sys->txt );
 363                 free( p_sys );
 364                 return VLC_ENOMEM;
 365             }
 366         }
 367
 368         if( pf_read( p_demux, &p_sys->subtitle[p_sys->i_subtitles] ) )
 369             break;
 370
 371         p_sys->i_subtitles++;
 372     }
 373     /* Unload */
 374     TextUnload( &p_sys->txt );
 375
 376     msg_Dbg(p_demux, "loaded %d subtitles", p_sys->i_subtitles );
 377
 378     /* Fix subtitle (order and time) *** */
 379     p_sys->i_subtitle = 0;
 380     p_sys->i_length = 0;
 381     if( p_sys->i_subtitles > 0 )
 382     {
 383         p_sys->i_length = p_sys->subtitle[p_sys->i_subtitles-1].i_stop;
 384         /* +1 to avoid 0 */
 385         if( p_sys->i_length <= 0 )
 386             p_sys->i_length = p_sys->subtitle[p_sys->i_subtitles-1].i_start+1;
 387     }
 388
 389     /* *** add subtitle ES *** */
 390     if( p_sys->i_type == SUB_TYPE_SSA1 ||
 391              p_sys->i_type == SUB_TYPE_SSA2_4 ||
 392              p_sys->i_type == SUB_TYPE_ASS )
 393     {
 394         es_format_Init( &fmt, SPU_ES, VLC_FOURCC( 's','s','a',' ' ) );
 395     }
 396     else
 397     {
 398         es_format_Init( &fmt, SPU_ES, VLC_FOURCC( 's','u','b','t' ) );
 399     }
 400     if( p_sys->psz_header != NULL )
 401     {
 402         fmt.i_extra = strlen( p_sys->psz_header ) + 1;
 403         fmt.p_extra = strdup( p_sys->psz_header );
 404     }
 405     p_sys->es = es_out_Add( p_demux->out, &fmt );
 406
 407     return VLC_SUCCESS;
 408 }
 409
 410 /*****************************************************************************
 411  * Close: Close subtitle demux
 412  *****************************************************************************/
 413 static void Close( vlc_object_t *p_this )
 414 {
 415     demux_t *p_demux = (demux_t*)p_this;
 416     demux_sys_t *p_sys = p_demux->p_sys;
 417     int i;
 418
 419     for( i = 0; i < p_sys->i_subtitles; i++ )
 420     {
 421         if( p_sys->subtitle[i].psz_text )
 422             free( p_sys->subtitle[i].psz_text );
 423     }
 424     if( p_sys->subtitle )
 425         free( p_sys->subtitle );
 426
 427     free( p_sys );
 428 }
 429
 430 /*****************************************************************************
 431  * Control:
 432  *****************************************************************************/
 433 static int Control( demux_t *p_demux, int i_query, va_list args )
 434 {
 435     demux_sys_t *p_sys = p_demux->p_sys;
 436     int64_t *pi64, i64;
 437     double *pf, f;
 438
 439     switch( i_query )
 440     {
 441         case DEMUX_GET_LENGTH:
 442             pi64 = (int64_t*)va_arg( args, int64_t * );
 443             *pi64 = p_sys->i_length;
 444             return VLC_SUCCESS;
 445
 446         case DEMUX_GET_TIME:
 447             pi64 = (int64_t*)va_arg( args, int64_t * );
 448             if( p_sys->i_subtitle < p_sys->i_subtitles )
 449             {
 450                 *pi64 = p_sys->subtitle[p_sys->i_subtitle].i_start;
 451                 return VLC_SUCCESS;
 452             }
 453             return VLC_EGENERIC;
 454
 455         case DEMUX_SET_TIME:
 456             i64 = (int64_t)va_arg( args, int64_t );
 457             p_sys->i_subtitle = 0;
 458             while( p_sys->i_subtitle < p_sys->i_subtitles &&
 459                    p_sys->subtitle[p_sys->i_subtitle].i_start < i64 )
 460             {
 461                 p_sys->i_subtitle++;
 462             }
 463
 464             if( p_sys->i_subtitle >= p_sys->i_subtitles )
 465                 return VLC_EGENERIC;
 466             return VLC_SUCCESS;
 467
 468         case DEMUX_GET_POSITION:
 469             pf = (double*)va_arg( args, double * );
 470             if( p_sys->i_subtitle >= p_sys->i_subtitles )
 471             {
 472                 *pf = 1.0;
 473             }
 474             else if( p_sys->i_subtitles > 0 )
 475             {
 476                 *pf = (double)p_sys->subtitle[p_sys->i_subtitle].i_start /
 477                       (double)p_sys->i_length;
 478             }
 479             else
 480             {
 481                 *pf = 0.0;
 482             }
 483             return VLC_SUCCESS;
 484
 485         case DEMUX_SET_POSITION:
 486             f = (double)va_arg( args, double );
 487             i64 = f * p_sys->i_length;
 488
 489             p_sys->i_subtitle = 0;
 490             while( p_sys->i_subtitle < p_sys->i_subtitles &&
 491                    p_sys->subtitle[p_sys->i_subtitle].i_start < i64 )
 492             {
 493                 p_sys->i_subtitle++;
 494             }
 495             if( p_sys->i_subtitle >= p_sys->i_subtitles )
 496                 return VLC_EGENERIC;
 497             return VLC_SUCCESS;
 498
 499         case DEMUX_SET_NEXT_DEMUX_TIME:
 500             p_sys->i_next_demux_date = (int64_t)va_arg( args, int64_t );
 501             return VLC_SUCCESS;
 502
 503         case DEMUX_GET_FPS:
 504         case DEMUX_GET_META:
 505         case DEMUX_GET_TITLE_INFO:
 506             return VLC_EGENERIC;
 507
 508         default:
 509             msg_Err( p_demux, "unknown query in subtitle control" );
 510             return VLC_EGENERIC;
 511     }
 512 }
 513
 514 /*****************************************************************************
 515  * Demux: Send subtitle to decoder
 516  *****************************************************************************/
 517 static int Demux( demux_t *p_demux )
 518 {
 519     demux_sys_t *p_sys = p_demux->p_sys;
 520     int64_t i_maxdate;
 521
 522     if( p_sys->i_subtitle >= p_sys->i_subtitles )
 523         return 0;
 524
 525     i_maxdate = p_sys->i_next_demux_date - var_GetTime( p_demux->p_parent, "spu-delay" );;
 526     if( i_maxdate <= 0 && p_sys->i_subtitle < p_sys->i_subtitles )
 527     {
 528         /* Should not happen */
 529         i_maxdate = p_sys->subtitle[p_sys->i_subtitle].i_start + 1;
 530     }
 531
 532     while( p_sys->i_subtitle < p_sys->i_subtitles &&
 533            p_sys->subtitle[p_sys->i_subtitle].i_start < i_maxdate )
 534     {
 535         block_t *p_block;
 536         int i_len = strlen( p_sys->subtitle[p_sys->i_subtitle].psz_text ) + 1;
 537
 538         if( i_len <= 1 )
 539         {
 540             /* empty subtitle */
 541             p_sys->i_subtitle++;
 542             continue;
 543         }
 544
 545         if( ( p_block = block_New( p_demux, i_len ) ) == NULL )
 546         {
 547             p_sys->i_subtitle++;
 548             continue;
 549         }
 550
 551         if( p_sys->subtitle[p_sys->i_subtitle].i_start < 0 )
 552         {
 553             p_sys->i_subtitle++;
 554             continue;
 555         }
 556
 557         p_block->i_pts = p_sys->subtitle[p_sys->i_subtitle].i_start;
 558         p_block->i_dts = p_block->i_pts;
 559         if( p_sys->subtitle[p_sys->i_subtitle].i_stop > 0 )
 560         {
 561             p_block->i_length =
 562                 p_sys->subtitle[p_sys->i_subtitle].i_stop - p_block->i_pts;
 563         }
 564
 565         memcpy( p_block->p_buffer,
 566                 p_sys->subtitle[p_sys->i_subtitle].psz_text, i_len );
 567         if( p_block->i_pts > 0 )
 568         {
 569             es_out_Send( p_demux->out, p_sys->es, p_block );
 570         }
 571         else
 572         {
 573             block_Release( p_block );
 574         }
 575         p_sys->i_subtitle++;
 576     }
 577
 578     /* */
 579     p_sys->i_next_demux_date = 0;
 580
 581     return 1;
 582 }
 583
 584 /*****************************************************************************
 585  * Fix: fix time stamp and order of subtitle
 586  *****************************************************************************/
 587 #ifdef USE_THIS_UNUSED_PIECE_OF_CODE
 588 static void Fix( demux_t *p_demux )
 589 {
 590     demux_sys_t *p_sys = p_demux->p_sys;
 591     vlc_bool_t b_done;
 592     int     i_index;
 593
 594     /* *** fix order (to be sure...) *** */
 595     /* We suppose that there are near in order and this durty bubble sort
 596      * wont take too much time
 597      */
 598     do
 599     {
 600         b_done = VLC_TRUE;
 601         for( i_index = 1; i_index < p_sys->i_subtitles; i_index++ )
 602         {
 603             if( p_sys->subtitle[i_index].i_start <
 604                     p_sys->subtitle[i_index - 1].i_start )
 605             {
 606                 subtitle_t sub_xch;
 607                 memcpy( &sub_xch,
 608                         p_sys->subtitle + i_index - 1,
 609                         sizeof( subtitle_t ) );
 610                 memcpy( p_sys->subtitle + i_index - 1,
 611                         p_sys->subtitle + i_index,
 612                         sizeof( subtitle_t ) );
 613                 memcpy( p_sys->subtitle + i_index,
 614                         &sub_xch,
 615                         sizeof( subtitle_t ) );
 616                 b_done = VLC_FALSE;
 617             }
 618         }
 619     } while( !b_done );
 620 }
 621 #endif
 622
 623 static int TextLoad( text_t *txt, stream_t *s )
 624 {
 625     int   i_line_max;
 626
 627     /* init txt */
 628     i_line_max          = 500;
 629     txt->i_line_count   = 0;
 630     txt->i_line         = 0;
 631     txt->line           = calloc( i_line_max, sizeof( char * ) );
 632
 633     /* load the complete file */
 634     for( ;; )
 635     {
 636         char *psz = stream_ReadLine( s );
 637
 638         if( psz == NULL )
 639             break;
 640
 641         txt->line[txt->i_line_count++] = psz;
 642         if( txt->i_line_count >= i_line_max )
 643         {
 644             i_line_max += 100;
 645             txt->line = realloc( txt->line, i_line_max * sizeof( char * ) );
 646         }
 647     }
 648
 649     if( txt->i_line_count <= 0 )
 650     {
 651         free( txt->line );
 652         return VLC_EGENERIC;
 653     }
 654
 655     return VLC_SUCCESS;
 656 }
 657 static void TextUnload( text_t *txt )
 658 {
 659     int i;
 660
 661     for( i = 0; i < txt->i_line_count; i++ )
 662     {
 663         free( txt->line[i] );
 664     }
 665     free( txt->line );
 666     txt->i_line       = 0;
 667     txt->i_line_count = 0;
 668 }
 669
 670 static char *TextGetLine( text_t *txt )
 671 {
 672     if( txt->i_line >= txt->i_line_count )
 673         return( NULL );
 674
 675     return txt->line[txt->i_line++];
 676 }
 677 static void TextPreviousLine( text_t *txt )
 678 {
 679     if( txt->i_line > 0 )
 680         txt->i_line--;
 681 }
 682
 683 /*****************************************************************************
 684  * Specific Subtitle function
 685  *****************************************************************************/
 686 #define MAX_LINE 8192
 687 static int ParseMicroDvd( demux_t *p_demux, subtitle_t *p_subtitle )
 688 {
 689     demux_sys_t *p_sys = p_demux->p_sys;
 690     text_t      *txt = &p_sys->txt;
 691     /*
 692      * each line:
 693      *  {n1}{n2}Line1|Line2|Line3....
 694      * where n1 and n2 are the video frame number...
 695      * {n2} can also be {}
 696      */
 697     char *s;
 698
 699     char buffer_text[MAX_LINE + 1];
 700     int    i_start;
 701     int    i_stop;
 702     unsigned int i;
 703
 704     int i_microsecperframe = 40000; /* default to 25 fps */
 705     if( p_sys->i_microsecperframe > 0 )
 706         i_microsecperframe = p_sys->i_microsecperframe;
 707
 708     p_subtitle->i_start = 0;
 709     p_subtitle->i_stop  = 0;
 710     p_subtitle->psz_text = NULL;
 711
 712     for( ;; )
 713     {
 714         if( ( s = TextGetLine( txt ) ) == NULL )
 715         {
 716             return( VLC_EGENERIC );
 717         }
 718         i_start = 0;
 719         i_stop  = 0;
 720
 721         memset( buffer_text, '\0', MAX_LINE );
 722         if( sscanf( s, "{%d}{}%[^\r\n]", &i_start, buffer_text ) == 2 ||
 723             sscanf( s, "{%d}{%d}%[^\r\n]", &i_start, &i_stop, buffer_text ) == 3)
 724         {
 725             break;
 726         }
 727     }
 728     /* replace | by \n */
 729     for( i = 0; i < strlen( buffer_text ); i++ )
 730     {
 731         if( buffer_text[i] == '|' )
 732         {
 733             buffer_text[i] = '\n';
 734         }
 735     }
 736
 737     p_subtitle->i_start = (int64_t)i_start * i_microsecperframe;
 738     p_subtitle->i_stop  = (int64_t)i_stop  * i_microsecperframe;
 739     p_subtitle->psz_text = strndup( buffer_text, MAX_LINE );
 740     return( 0 );
 741 }
 742
 743 static int  ParseSubRip( demux_t *p_demux, subtitle_t *p_subtitle )
 744 {
 745     demux_sys_t *p_sys = p_demux->p_sys;
 746     text_t      *txt = &p_sys->txt;
 747
 748     /*
 749      * n
 750      * h1:m1:s1,d1 --> h2:m2:s2,d2
 751      * Line1
 752      * Line2
 753      * ...
 754      * [empty line]
 755      *
 756      */
 757     char *s;
 758     char buffer_text[ 10 * MAX_LINE];
 759     int  i_buffer_text;
 760     int64_t     i_start;
 761     int64_t     i_stop;
 762
 763     p_subtitle->i_start = 0;
 764     p_subtitle->i_stop  = 0;
 765     p_subtitle->psz_text = NULL;
 766
 767     for( ;; )
 768     {
 769         int h1, m1, s1, d1, h2, m2, s2, d2;
 770         if( ( s = TextGetLine( txt ) ) == NULL )
 771         {
 772             return( VLC_EGENERIC );
 773         }
 774         if( sscanf( s,
 775                     "%d:%d:%d,%d --> %d:%d:%d,%d",
 776                     &h1, &m1, &s1, &d1,
 777                     &h2, &m2, &s2, &d2 ) == 8 )
 778         {
 779             i_start = ( (int64_t)h1 * 3600*1000 +
 780                         (int64_t)m1 * 60*1000 +
 781                         (int64_t)s1 * 1000 +
 782                         (int64_t)d1 ) * 1000;
 783
 784             i_stop  = ( (int64_t)h2 * 3600*1000 +
 785                         (int64_t)m2 * 60*1000 +
 786                         (int64_t)s2 * 1000 +
 787                         (int64_t)d2 ) * 1000;
 788
 789             /* Now read text until an empty line */
 790             for( i_buffer_text = 0;; )
 791             {
 792                 int i_len;
 793                 if( ( s = TextGetLine( txt ) ) == NULL )
 794                 {
 795                     return( VLC_EGENERIC );
 796                 }
 797
 798                 i_len = strlen( s );
 799                 if( i_len <= 0 )
 800                 {
 801                     /* empty line -> end of this subtitle */
 802                     buffer_text[__MAX( i_buffer_text - 1, 0 )] = '\0';
 803                     p_subtitle->i_start = i_start;
 804                     p_subtitle->i_stop = i_stop;
 805                     p_subtitle->psz_text = strdup( buffer_text );
 806                     /* If framerate is available, use sub-fps */
 807                     if( p_sys->i_microsecperframe != 0 &&
 808                         p_sys->i_original_mspf != 0)
 809                     {
 810                         p_subtitle->i_start = (int64_t)i_start *
 811                                               p_sys->i_microsecperframe/
 812                                               p_sys->i_original_mspf;
 813                         p_subtitle->i_stop  = (int64_t)i_stop  *
 814                                               p_sys->i_microsecperframe /
 815                                               p_sys->i_original_mspf;
 816                     }
 817                     return 0;
 818                 }
 819                 else
 820                 {
 821                     if( i_buffer_text + i_len + 1 < 10 * MAX_LINE )
 822                     {
 823                         memcpy( buffer_text + i_buffer_text,
 824                                 s,
 825                                 i_len );
 826                         i_buffer_text += i_len;
 827
 828                         buffer_text[i_buffer_text] = '\n';
 829                         i_buffer_text++;
 830                     }
 831                 }
 832             }
 833         }
 834     }
 835 }
 836
 837 static int  ParseSubViewer( demux_t *p_demux, subtitle_t *p_subtitle )
 838 {
 839     demux_sys_t *p_sys = p_demux->p_sys;
 840     text_t      *txt = &p_sys->txt;
 841
 842     /*
 843      * h1:m1:s1.d1,h2:m2:s2.d2
 844      * Line1[br]Line2
 845      * Line3
 846      * ...
 847      * [empty line]
 848      * ( works with subviewer and subviewer v2 )
 849      */
 850     char *s;
 851     char buffer_text[ 10 * MAX_LINE];
 852     int  i_buffer_text;
 853     int64_t     i_start;
 854     int64_t     i_stop;
 855
 856     p_subtitle->i_start = 0;
 857     p_subtitle->i_stop  = 0;
 858     p_subtitle->psz_text = NULL;
 859
 860     for( ;; )
 861     {
 862         int h1, m1, s1, d1, h2, m2, s2, d2;
 863         if( ( s = TextGetLine( txt ) ) == NULL )
 864         {
 865             return( VLC_EGENERIC );
 866         }
 867         if( sscanf( s,
 868                     "%d:%d:%d.%d,%d:%d:%d.%d",
 869                     &h1, &m1, &s1, &d1,
 870                     &h2, &m2, &s2, &d2 ) == 8 )
 871         {
 872             i_start = ( (int64_t)h1 * 3600*1000 +
 873                         (int64_t)m1 * 60*1000 +
 874                         (int64_t)s1 * 1000 +
 875                         (int64_t)d1 ) * 1000;
 876
 877             i_stop  = ( (int64_t)h2 * 3600*1000 +
 878                         (int64_t)m2 * 60*1000 +
 879                         (int64_t)s2 * 1000 +
 880                         (int64_t)d2 ) * 1000;
 881
 882             /* Now read text until an empty line */
 883             for( i_buffer_text = 0;; )
 884             {
 885                 int i_len, i;
 886                 if( ( s = TextGetLine( txt ) ) == NULL )
 887                 {
 888                     return( VLC_EGENERIC );
 889                 }
 890
 891                 i_len = strlen( s );
 892                 if( i_len <= 0 )
 893                 {
 894                     /* empty line -> end of this subtitle */
 895                     buffer_text[__MAX( i_buffer_text - 1, 0 )] = '\0';
 896                     p_subtitle->i_start = i_start;
 897                     p_subtitle->i_stop = i_stop;
 898
 899                     /* replace [br] by \n */
 900                     for( i = 0; i < i_buffer_text - 3; i++ )
 901                     {
 902                         if( buffer_text[i] == '[' && buffer_text[i+1] == 'b' &&
 903                             buffer_text[i+2] == 'r' && buffer_text[i+3] == ']' )
 904                         {
 905                             char *temp = buffer_text + i + 1;
 906                             buffer_text[i] = '\n';
 907                             memmove( temp, temp+3, strlen( temp ) -3 );
 908                             temp[strlen( temp )-3] = '\0';
 909                         }
 910                     }
 911                     p_subtitle->psz_text = strdup( buffer_text );
 912                     return( 0 );
 913                 }
 914                 else
 915                 {
 916                     if( i_buffer_text + i_len + 1 < 10 * MAX_LINE )
 917                     {
 918                         memcpy( buffer_text + i_buffer_text,
 919                                 s,
 920                                 i_len );
 921                         i_buffer_text += i_len;
 922
 923                         buffer_text[i_buffer_text] = '\n';
 924                         i_buffer_text++;
 925                     }
 926                 }
 927             }
 928         }
 929     }
 930 }
 931
 932
 933 static int  ParseSSA( demux_t *p_demux, subtitle_t *p_subtitle )
 934 {
 935     demux_sys_t *p_sys = p_demux->p_sys;
 936     text_t      *txt = &p_sys->txt;
 937
 938     char buffer_text[ 10 * MAX_LINE];
 939     char buffer_text2[ 10 * MAX_LINE];
 940     char *s;
 941     int64_t     i_start;
 942     int64_t     i_stop;
 943
 944     p_subtitle->i_start = 0;
 945     p_subtitle->i_stop  = 0;
 946     p_subtitle->psz_text = NULL;
 947
 948     for( ;; )
 949     {
 950         int h1, m1, s1, c1, h2, m2, s2, c2;
 951
 952         if( ( s = TextGetLine( txt ) ) == NULL )
 953         {
 954             return( VLC_EGENERIC );
 955         }
 956         p_subtitle->psz_text = malloc( strlen( s ) );
 957
 958         /* We expect (SSA2-4):
 959          * Format: Marked, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text
 960          * Dialogue: Marked=0,0:02:40.65,0:02:41.79,Wolf main,Cher,0000,0000,0000,,Et les enregistrements de ses ondes delta ?
 961          *
 962          * SSA-1 is similar but only has 8 commas up untill the subtitle text. Probably the Effect field is no present, but not 100 % sure.
 963          */
 964
 965         /* For ASS:
 966          * Format: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text
 967          * Dialogue: Layer#,0:02:40.65,0:02:41.79,Wolf main,Cher,0000,0000,0000,,Et les enregistrements de ses ondes delta ?
 968          */
 969         if( sscanf( s,
 970                     "Dialogue: %[^,],%d:%d:%d.%d,%d:%d:%d.%d,%[^\r\n]",
 971                     buffer_text2,
 972                     &h1, &m1, &s1, &c1,
 973                     &h2, &m2, &s2, &c2,
 974                     buffer_text ) == 10 )
 975         {
 976             i_start = ( (int64_t)h1 * 3600*1000 +
 977                         (int64_t)m1 * 60*1000 +
 978                         (int64_t)s1 * 1000 +
 979                         (int64_t)c1 * 10 ) * 1000;
 980
 981             i_stop  = ( (int64_t)h2 * 3600*1000 +
 982                         (int64_t)m2 * 60*1000 +
 983                         (int64_t)s2 * 1000 +
 984                         (int64_t)c2 * 10 ) * 1000;
 985
 986             /* The dec expects: ReadOrder, Layer, Style, Name, MarginL, MarginR, MarginV, Effect, Text */
 987             /* (Layer comes from ASS specs ... it's empty for SSA.) */
 988             if( p_sys->i_type == SUB_TYPE_SSA1 )
 989             {
 990                 sprintf( p_subtitle->psz_text,
 991                          ",%s", strdup( buffer_text) ); /* SSA1 has only 8 commas before the text starts, not 9 */
 992             }
 993             else
 994             {
 995                 sprintf( p_subtitle->psz_text,
 996                          ",,%s", strdup( buffer_text) ); /* ReadOrder, Layer, %s(rest of fields) */
 997             }
 998             p_subtitle->i_start = i_start;
 999             p_subtitle->i_stop = i_stop;
1000             return 0;
1001         }
1002         else
1003         {
1004             /* All the other stuff we add to the header field */
1005             if( p_sys->psz_header != NULL )
1006             {
1007                 if( !( p_sys->psz_header = realloc( p_sys->psz_header,
1008                           strlen( p_sys->psz_header ) + 1 + strlen( s ) + 2 ) ) )
1009                 {
1010                     msg_Err( p_demux, "out of memory");
1011                     return VLC_ENOMEM;
1012                 }
1013                 p_sys->psz_header = strcat( p_sys->psz_header,  s );
1014                 p_sys->psz_header = strcat( p_sys->psz_header, "\n" );
1015             }
1016             else
1017             {
1018                 if( !( p_sys->psz_header = malloc( strlen( s ) + 2 ) ) )
1019                 {
1020                     msg_Err( p_demux, "out of memory");
1021                     return VLC_ENOMEM;
1022                 }
1023                 p_sys->psz_header = s;
1024                 p_sys->psz_header = strcat( p_sys->psz_header, "\n" );
1025             }
1026         }
1027     }
1028 }
1029
1030 static int  ParseVplayer( demux_t *p_demux, subtitle_t *p_subtitle )
1031 {
1032     demux_sys_t *p_sys = p_demux->p_sys;
1033     text_t      *txt = &p_sys->txt;
1034
1035     /*
1036      * each line:
1037      *  h:m:s:Line1|Line2|Line3....
1038      *  or
1039      *  h:m:s Line1|Line2|Line3....
1040      *
1041      */
1042     char *p;
1043     char buffer_text[MAX_LINE + 1];
1044     int64_t    i_start;
1045     unsigned int i;
1046
1047     p_subtitle->i_start = 0;
1048     p_subtitle->i_stop  = 0;
1049     p_subtitle->psz_text = NULL;
1050
1051     for( ;; )
1052     {
1053         int h, m, s;
1054         char c;
1055
1056         if( ( p = TextGetLine( txt ) ) == NULL )
1057         {
1058             return( VLC_EGENERIC );
1059         }
1060
1061         i_start = 0;
1062
1063         memset( buffer_text, '\0', MAX_LINE );
1064         if( sscanf( p, "%d:%d:%d%[ :]%[^\r\n]", &h, &m, &s, &c, buffer_text ) == 5 )
1065         {
1066             i_start = ( (int64_t)h * 3600*1000 +
1067                         (int64_t)m * 60*1000 +
1068                         (int64_t)s * 1000 ) * 1000;
1069             break;
1070         }
1071     }
1072
1073     /* replace | by \n */
1074     for( i = 0; i < strlen( buffer_text ); i++ )
1075     {
1076         if( buffer_text[i] == '|' )
1077         {
1078             buffer_text[i] = '\n';
1079         }
1080     }
1081     p_subtitle->i_start = i_start;
1082
1083     p_subtitle->i_stop  = 0;
1084     p_subtitle->psz_text = strndup( buffer_text, MAX_LINE );
1085     return( 0 );
1086 }
1087
1088 static char *ParseSamiSearch( text_t *txt, char *psz_start, char *psz_str )
1089 {
1090     if( psz_start )
1091     {
1092         if( strcasestr( psz_start, psz_str ) )
1093         {
1094             char *s = strcasestr( psz_start, psz_str );
1095
1096             s += strlen( psz_str );
1097
1098             return( s );
1099         }
1100     }
1101     for( ;; )
1102     {
1103         char *p;
1104         if( ( p = TextGetLine( txt ) ) == NULL )
1105         {
1106             return NULL;
1107         }
1108         if( strcasestr( p, psz_str ) )
1109         {
1110             char *s = strcasestr( p, psz_str );
1111
1112             s += strlen( psz_str );
1113
1114             return(  s);
1115         }
1116     }
1117 }
1118
1119 static int  ParseSami( demux_t *p_demux, subtitle_t *p_subtitle )
1120 {
1121     demux_sys_t *p_sys = p_demux->p_sys;
1122     text_t      *txt = &p_sys->txt;
1123
1124     char *p;
1125     int64_t i_start;
1126
1127     int  i_text;
1128     char buffer_text[10*MAX_LINE + 1];
1129
1130     p_subtitle->i_start = 0;
1131     p_subtitle->i_stop  = 0;
1132     p_subtitle->psz_text = NULL;
1133
1134 #define ADDC( c ) \
1135     if( i_text < 10*MAX_LINE )      \
1136     {                               \
1137         buffer_text[i_text++] = c;  \
1138         buffer_text[i_text] = '\0'; \
1139     }
1140
1141     /* search "Start=" */
1142     if( !( p = ParseSamiSearch( txt, NULL, "Start=" ) ) )
1143     {
1144         return VLC_EGENERIC;
1145     }
1146
1147     /* get start value */
1148     i_start = strtol( p, &p, 0 );
1149
1150     /* search <P */
1151     if( !( p = ParseSamiSearch( txt, p, "<P" ) ) )
1152     {
1153         return VLC_EGENERIC;
1154     }
1155     /* search > */
1156     if( !( p = ParseSamiSearch( txt, p, ">" ) ) )
1157     {
1158         return VLC_EGENERIC;
1159     }
1160
1161     i_text = 0;
1162     buffer_text[0] = '\0';
1163     /* now get all txt until  a "Start=" line */
1164     for( ;; )
1165     {
1166         if( *p )
1167         {
1168             if( *p == '<' )
1169             {
1170                 if( !strncasecmp( p, "<br", 3 ) )
1171                 {
1172                     ADDC( '\n' );
1173                 }
1174                 else if( strcasestr( p, "Start=" ) )
1175                 {
1176                     TextPreviousLine( txt );
1177                     break;
1178                 }
1179                 p = ParseSamiSearch( txt, p, ">" );
1180             }
1181             else if( !strncmp( p, "&nbsp;", 6 ) )
1182             {
1183                 ADDC( ' ' );
1184                 p += 6;
1185             }
1186             else if( *p == '\t' )
1187             {
1188                 ADDC( ' ' );
1189                 p++;
1190             }
1191             else
1192             {
1193                 ADDC( *p );
1194                 p++;
1195             }
1196         }
1197         else
1198         {
1199             p = TextGetLine( txt );
1200         }
1201
1202         if( p == NULL )
1203         {
1204             break;
1205         }
1206     }
1207
1208     p_subtitle->i_start = i_start * 1000;
1209     p_subtitle->i_stop  = 0;
1210     p_subtitle->psz_text = strndup( buffer_text, 10*MAX_LINE );
1211
1212     return( VLC_SUCCESS );
1213 #undef ADDC
1214 }
1215
1216 static int ParseDVDSubtitle( demux_t *p_demux, subtitle_t *p_subtitle )
1217 {
1218     demux_sys_t *p_sys = p_demux->p_sys;
1219     text_t      *txt = &p_sys->txt;
1220
1221     /*
1222      * {T h1:m1:s1:c1
1223      * Line1
1224      * Line2
1225      * ...
1226      * }
1227      *
1228      */
1229     char *s;
1230     char buffer_text[ 10 * MAX_LINE];
1231     int  i_buffer_text;
1232     int64_t     i_start;
1233
1234     p_subtitle->i_start = 0;
1235     p_subtitle->i_stop  = 0;
1236     p_subtitle->psz_text = NULL;
1237
1238     for( ;; )
1239     {
1240         int h1, m1, s1, c1;
1241         if( ( s = TextGetLine( txt ) ) == NULL )
1242         {
1243             return( VLC_EGENERIC );
1244         }
1245         if( sscanf( s,
1246                     "{T %d:%d:%d:%d",
1247                     &h1, &m1, &s1, &c1 ) == 4 )
1248         {
1249             i_start = ( (int64_t)h1 * 3600*1000 +
1250                         (int64_t)m1 * 60*1000 +
1251                         (int64_t)s1 * 1000 +
1252                         (int64_t)c1 * 10) * 1000;
1253
1254             /* Now read text until a line containing "}" */
1255             for( i_buffer_text = 0;; )
1256             {
1257                 int i_len;
1258                 if( ( s = TextGetLine( txt ) ) == NULL )
1259                 {
1260                     return( VLC_EGENERIC );
1261                 }
1262
1263                 i_len = strlen( s );
1264                 if( i_len == 1 && s[0] == '}' )
1265                 {
1266                     /* "}" -> end of this subtitle */
1267                     buffer_text[__MAX( i_buffer_text - 1, 0 )] = '\0';
1268                     p_subtitle->i_start = i_start;
1269                     p_subtitle->i_stop  = 0;
1270                     p_subtitle->psz_text = strdup( buffer_text );
1271                     return 0;
1272                 }
1273                 else
1274                 {
1275                     if( i_buffer_text + i_len + 1 < 10 * MAX_LINE )
1276                     {
1277                         memcpy( buffer_text + i_buffer_text,
1278                                 s,
1279                                 i_len );
1280                         i_buffer_text += i_len;
1281
1282                         buffer_text[i_buffer_text] = '\n';
1283                         i_buffer_text++;
1284                     }
1285                 }
1286             }
1287         }
1288     }
1289 }
1290