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