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