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