]> git.sesse.net Git - vlc/blob - modules/demux/vobsub.c
Use var_Inherit* instead of var_CreateGet*.
[vlc] / modules / demux / vobsub.c
1 /*****************************************************************************
2  * subtitle.c: Demux vobsub 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 #ifdef HAVE_CONFIG_H
29 # include "config.h"
30 #endif
31
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
34
35 #include <sys/types.h>
36 #include <limits.h>
37
38 #include <vlc_demux.h>
39
40 #include "ps.h"
41 #include "vobsub.h"
42
43 #define MAX_LINE 8192
44
45 /*****************************************************************************
46  * Module descriptor
47  *****************************************************************************/
48 static int  Open ( vlc_object_t *p_this );
49 static void Close( vlc_object_t *p_this );
50
51 vlc_module_begin ()
52     set_description( N_("Vobsub subtitles parser") )
53     set_category( CAT_INPUT )
54     set_subcategory( SUBCAT_INPUT_DEMUX )
55     set_capability( "demux", 1 )
56
57     set_callbacks( Open, Close )
58
59     add_shortcut( "vobsub", "subtitle" )
60 vlc_module_end ()
61
62 /*****************************************************************************
63  * Prototypes:
64  *****************************************************************************/
65
66 typedef struct
67 {
68     int     i_line_count;
69     int     i_line;
70     char    **line;
71 } text_t;
72 static int  TextLoad( text_t *, stream_t *s );
73 static void TextUnload( text_t * );
74
75 typedef struct
76 {
77     int64_t i_start;
78     int     i_vobsub_location;
79 } subtitle_t;
80
81 typedef struct
82 {
83     es_format_t fmt;
84     es_out_id_t *p_es;
85     int         i_track_id;
86
87     int         i_current_subtitle;
88     int         i_subtitles;
89     subtitle_t  *p_subtitles;
90
91     int64_t     i_delay;
92 } vobsub_track_t;
93
94 struct demux_sys_t
95 {
96     int64_t     i_next_demux_date;
97     int64_t     i_length;
98
99     text_t      txt;
100     stream_t    *p_vobsub_stream;
101
102     /* all tracks */
103     int            i_tracks;
104     vobsub_track_t *track;
105
106     int         i_original_frame_width;
107     int         i_original_frame_height;
108     bool  b_palette;
109     uint32_t    palette[16];
110 };
111
112 static int Demux( demux_t * );
113 static int Control( demux_t *, int, va_list );
114
115 static int ParseVobSubIDX( demux_t * );
116 static int DemuxVobSub( demux_t *, block_t *);
117
118 /*****************************************************************************
119  * Module initializer
120  *****************************************************************************/
121 static int Open ( vlc_object_t *p_this )
122 {
123     demux_t     *p_demux = (demux_t*)p_this;
124     demux_sys_t *p_sys;
125     char *psz_vobname, *s;
126     int i_len;
127
128     if( ( s = stream_ReadLine( p_demux->s ) ) != NULL )
129     {
130         if( !strcasestr( s, "# VobSub index file" ) )
131         {
132             msg_Dbg( p_demux, "this doesn't seem to be a vobsub file" );
133             free( s );
134             if( stream_Seek( p_demux->s, 0 ) )
135             {
136                 msg_Warn( p_demux, "failed to rewind" );
137             }
138             return VLC_EGENERIC;
139         }
140         free( s );
141
142     }
143     else
144     {
145         msg_Dbg( p_demux, "could not read vobsub IDX file" );
146         return VLC_EGENERIC;
147     }
148
149     p_demux->pf_demux = Demux;
150     p_demux->pf_control = Control;
151     p_demux->p_sys = p_sys = malloc( sizeof( demux_sys_t ) );
152     if( unlikely( !p_sys ) )
153         return VLC_ENOMEM;
154     p_sys->i_length = 0;
155     p_sys->p_vobsub_stream = NULL;
156     p_sys->i_tracks = 0;
157     p_sys->track = malloc( sizeof( vobsub_track_t ) );
158     if( unlikely( !p_sys->track ) )
159     {
160         free( p_sys );
161         return VLC_ENOMEM;
162     }
163     p_sys->i_original_frame_width = -1;
164     p_sys->i_original_frame_height = -1;
165     p_sys->b_palette = false;
166     memset( p_sys->palette, 0, 16 * sizeof( uint32_t ) );
167
168     /* Load the whole file */
169     TextLoad( &p_sys->txt, p_demux->s );
170
171     /* Parse it */
172     ParseVobSubIDX( p_demux );
173
174     /* Unload */
175     TextUnload( &p_sys->txt );
176
177     /* Find the total length of the vobsubs */
178     if( p_sys->i_tracks > 0 )
179     {
180         int i;
181         for( i = 0; i < p_sys->i_tracks; i++ )
182         {
183             if( p_sys->track[i].i_subtitles > 1 )
184             {
185                 if( p_sys->track[i].p_subtitles[p_sys->track[i].i_subtitles-1].i_start > p_sys->i_length )
186                     p_sys->i_length = (int64_t) p_sys->track[i].p_subtitles[p_sys->track[i].i_subtitles-1].i_start + ( 1 *1000 *1000 );
187             }
188         }
189     }
190
191     if( asprintf( &psz_vobname, "%s://%s", p_demux->psz_access,
192                   p_demux->psz_location ) == -1 )
193     {
194         free( p_sys );
195         return VLC_EGENERIC;
196     }
197     i_len = strlen( psz_vobname );
198     if( i_len >= 4 ) memcpy( psz_vobname + i_len - 4, ".sub", 4 );
199
200     /* open file */
201     p_sys->p_vobsub_stream = stream_UrlNew( p_demux, psz_vobname );
202     if( p_sys->p_vobsub_stream == NULL )
203     {
204         msg_Err( p_demux, "couldn't open .sub Vobsub file: %s",
205                  psz_vobname );
206         free( psz_vobname );
207         free( p_sys );
208         return VLC_EGENERIC;
209     }
210     free( psz_vobname );
211
212     return VLC_SUCCESS;
213 }
214
215 /*****************************************************************************
216  * Close: Close subtitle demux
217  *****************************************************************************/
218 static void Close( vlc_object_t *p_this )
219 {
220     int i;
221     demux_t *p_demux = (demux_t*)p_this;
222     demux_sys_t *p_sys = p_demux->p_sys;
223
224     /* Clean all subs from all tracks */
225     for( i = 0; i < p_sys->i_tracks; i++ )
226         free( p_sys->track[i].p_subtitles );
227
228     free( p_sys->track );
229
230     if( p_sys->p_vobsub_stream )
231         stream_Delete( p_sys->p_vobsub_stream );
232
233     free( p_sys );
234 }
235
236 /*****************************************************************************
237  * Control:
238  *****************************************************************************/
239 static int Control( demux_t *p_demux, int i_query, va_list args )
240 {
241     demux_sys_t *p_sys = p_demux->p_sys;
242     int64_t *pi64, i64;
243     int i;
244     double *pf, f;
245
246     switch( i_query )
247     {
248         case DEMUX_GET_LENGTH:
249             pi64 = (int64_t*)va_arg( args, int64_t * );
250             *pi64 = (int64_t) p_sys->i_length;
251             return VLC_SUCCESS;
252
253         case DEMUX_GET_TIME:
254             pi64 = (int64_t*)va_arg( args, int64_t * );
255             for( i = 0; i < p_sys->i_tracks; i++ )
256             {
257                 bool b_selected;
258                 /* Check the ES is selected */
259                 es_out_Control( p_demux->out, ES_OUT_GET_ES_STATE,
260                                 p_sys->track[i].p_es, &b_selected );
261                 if( b_selected ) break;
262             }
263             if( i < p_sys->i_tracks && p_sys->track[i].i_current_subtitle < p_sys->track[i].i_subtitles )
264             {
265                 *pi64 = p_sys->track[i].p_subtitles[p_sys->track[i].i_current_subtitle].i_start;
266                 return VLC_SUCCESS;
267             }
268             return VLC_EGENERIC;
269
270         case DEMUX_SET_TIME:
271             i64 = (int64_t)va_arg( args, int64_t );
272             for( i = 0; i < p_sys->i_tracks; i++ )
273             {
274                 p_sys->track[i].i_current_subtitle = 0;
275                 while( p_sys->track[i].i_current_subtitle < p_sys->track[i].i_subtitles &&
276                        p_sys->track[i].p_subtitles[p_sys->track[i].i_current_subtitle].i_start < i64 )
277                 {
278                     p_sys->track[i].i_current_subtitle++;
279                 }
280
281                 if( p_sys->track[i].i_current_subtitle >= p_sys->track[i].i_subtitles )
282                     return VLC_EGENERIC;
283             }
284             return VLC_SUCCESS;
285
286         case DEMUX_GET_POSITION:
287             pf = (double*)va_arg( args, double * );
288             for( i = 0; i < p_sys->i_tracks; i++ )
289             {
290                 bool b_selected;
291                 /* Check the ES is selected */
292                 es_out_Control( p_demux->out, ES_OUT_GET_ES_STATE,
293                                 p_sys->track[i].p_es, &b_selected );
294                 if( b_selected ) break;
295             }
296             if( p_sys->track[i].i_current_subtitle >= p_sys->track[i].i_subtitles )
297             {
298                 *pf = 1.0;
299             }
300             else if( p_sys->track[i].i_subtitles > 0 )
301             {
302                 *pf = (double)p_sys->track[i].p_subtitles[p_sys->track[i].i_current_subtitle].i_start /
303                       (double)p_sys->i_length;
304             }
305             else
306             {
307                 *pf = 0.0;
308             }
309             return VLC_SUCCESS;
310
311         case DEMUX_SET_POSITION:
312             f = (double)va_arg( args, double );
313             i64 = (int64_t) f * p_sys->i_length;
314
315             for( i = 0; i < p_sys->i_tracks; i++ )
316             {
317                 p_sys->track[i].i_current_subtitle = 0;
318                 while( p_sys->track[i].i_current_subtitle < p_sys->track[i].i_subtitles &&
319                        p_sys->track[i].p_subtitles[p_sys->track[i].i_current_subtitle].i_start < i64 )
320                 {
321                     p_sys->track[i].i_current_subtitle++;
322                 }
323                 if( p_sys->track[i].i_current_subtitle >= p_sys->track[i].i_subtitles )
324                     return VLC_EGENERIC;
325             }
326             return VLC_SUCCESS;
327
328         case DEMUX_SET_NEXT_DEMUX_TIME:
329             p_sys->i_next_demux_date = (int64_t)va_arg( args, int64_t );
330             return VLC_SUCCESS;
331
332         case DEMUX_GET_FPS:
333         case DEMUX_GET_META:
334         case DEMUX_GET_TITLE_INFO:
335         case DEMUX_HAS_UNSUPPORTED_META:
336         case DEMUX_GET_ATTACHMENTS:
337         case DEMUX_CAN_RECORD:
338             return VLC_EGENERIC;
339
340         default:
341             msg_Warn( p_demux, "unknown query in subtitle control" );
342             return VLC_EGENERIC;
343     }
344 }
345
346 /*****************************************************************************
347  * Demux: Send subtitle to decoder
348  *****************************************************************************/
349 static int Demux( demux_t *p_demux )
350 {
351     demux_sys_t *p_sys = p_demux->p_sys;
352     int64_t i_maxdate;
353     int i, i_read;
354
355     for( i = 0; i < p_sys->i_tracks; i++ )
356     {
357 #define tk p_sys->track[i]
358         if( tk.i_current_subtitle >= tk.i_subtitles )
359             continue;
360
361         i_maxdate = p_sys->i_next_demux_date;
362         if( i_maxdate <= 0 && tk.i_current_subtitle < tk.i_subtitles )
363         {
364             /* Should not happen */
365             i_maxdate = tk.p_subtitles[tk.i_current_subtitle].i_start + 1;
366         }
367
368         while( tk.i_current_subtitle < tk.i_subtitles &&
369                tk.p_subtitles[tk.i_current_subtitle].i_start < i_maxdate )
370         {
371             int i_pos = tk.p_subtitles[tk.i_current_subtitle].i_vobsub_location;
372             block_t *p_block;
373             int i_size = 0;
374
375             /* first compute SPU size */
376             if( tk.i_current_subtitle + 1 < tk.i_subtitles )
377             {
378                 i_size = tk.p_subtitles[tk.i_current_subtitle+1].i_vobsub_location - i_pos;
379             }
380             if( i_size <= 0 ) i_size = 65535;   /* Invalid or EOF */
381
382             /* Seek at the right place */
383             if( stream_Seek( p_sys->p_vobsub_stream, i_pos ) )
384             {
385                 msg_Warn( p_demux,
386                           "cannot seek in the VobSub to the correct time %d", i_pos );
387                 tk.i_current_subtitle++;
388                 continue;
389             }
390
391             /* allocate a packet */
392             if( ( p_block = block_New( p_demux, i_size ) ) == NULL )
393             {
394                 tk.i_current_subtitle++;
395                 continue;
396             }
397
398             /* read data */
399             i_read = stream_Read( p_sys->p_vobsub_stream, p_block->p_buffer, i_size );
400             if( i_read <= 6 )
401             {
402                 block_Release( p_block );
403                 tk.i_current_subtitle++;
404                 continue;
405             }
406             p_block->i_buffer = i_read;
407
408             /* pts */
409             p_block->i_pts = VLC_TS_0 + tk.p_subtitles[tk.i_current_subtitle].i_start;
410
411             /* demux this block */
412             DemuxVobSub( p_demux, p_block );
413
414             tk.i_current_subtitle++;
415         }
416 #undef tk
417     }
418
419     /* */
420     p_sys->i_next_demux_date = 0;
421
422     return 1;
423 }
424
425 static int TextLoad( text_t *txt, stream_t *s )
426 {
427     char **lines = NULL;
428     size_t n = 0;
429
430     /* load the complete file */
431     for( ;; )
432     {
433         char *psz = stream_ReadLine( s );
434         char **ppsz_new;
435
436         if( psz == NULL || (n >= INT_MAX/sizeof(char *)) )
437             break;
438
439         ppsz_new = realloc( lines, (n + 1) * sizeof (char *) );
440         if( ppsz_new == NULL )
441         {
442             free( psz );
443             break;
444         }
445         lines = ppsz_new;
446         lines[n++] = psz;
447     }
448
449     txt->i_line_count = n;
450     txt->i_line       = 0;
451     txt->line         = lines;
452
453     return VLC_SUCCESS;
454 }
455
456 static void TextUnload( text_t *txt )
457 {
458     int i;
459
460     for( i = 0; i < txt->i_line_count; i++ )
461         free( txt->line[i] );
462
463     free( txt->line );
464     txt->i_line       = 0;
465     txt->i_line_count = 0;
466 }
467
468 static char *TextGetLine( text_t *txt )
469 {
470     if( txt->i_line >= txt->i_line_count )
471         return( NULL );
472
473     return txt->line[txt->i_line++];
474 }
475
476 static int ParseVobSubIDX( demux_t *p_demux )
477 {
478     demux_sys_t *p_sys = p_demux->p_sys;
479     text_t      *txt = &p_sys->txt;
480     char        *line;
481     vobsub_track_t *current_tk = NULL;
482
483     for( ;; )
484     {
485         if( ( line = TextGetLine( txt ) ) == NULL )
486         {
487             return( VLC_EGENERIC );
488         }
489
490         if( *line == 0 || *line == '\r' || *line == '\n' || *line == '#' )
491         {
492             continue;
493         }
494         else if( !strncmp( "size:", line, 5 ) )
495         {
496             /* Store the original size of the video */
497             if( vobsub_size_parse( line, &p_sys->i_original_frame_width,
498                                    &p_sys->i_original_frame_height ) == VLC_SUCCESS )
499             {
500                 msg_Dbg( p_demux, "original frame size: %dx%d", p_sys->i_original_frame_width, p_sys->i_original_frame_height );
501             }
502             else
503             {
504                 msg_Warn( p_demux, "reading original frame size failed" );
505             }
506         }
507         else if( !strncmp( "palette:", line, 8 ) )
508         {
509             if( vobsub_palette_parse( line, p_sys->palette ) == VLC_SUCCESS )
510             {
511                 p_sys->b_palette = true;
512                 msg_Dbg( p_demux, "vobsub palette read" );
513             }
514             else
515             {
516                 msg_Warn( p_demux, "reading original palette failed" );
517             }
518         }
519         else if( !strncmp( "id:", line, 3 ) )
520         {
521             char language[3];
522             int i_track_id;
523             es_format_t fmt;
524
525             /* Lets start a new track */
526             if( sscanf( line, "id: %2s, index: %d",
527                         language, &i_track_id ) == 2 )
528             {
529                 p_sys->i_tracks++;
530                 p_sys->track = xrealloc( p_sys->track,
531                           sizeof( vobsub_track_t ) * (p_sys->i_tracks + 1 ) );
532                 language[2] = '\0';
533
534                 /* Init the track */
535                 current_tk = &p_sys->track[p_sys->i_tracks - 1];
536                 memset( current_tk, 0, sizeof( vobsub_track_t ) );
537                 current_tk->i_current_subtitle = 0;
538                 current_tk->i_subtitles = 0;
539                 current_tk->p_subtitles = xmalloc( sizeof( subtitle_t ) );;
540                 current_tk->i_track_id = i_track_id;
541                 current_tk->i_delay = (int64_t)0;
542
543                 es_format_Init( &fmt, SPU_ES, VLC_CODEC_SPU );
544                 fmt.subs.spu.i_original_frame_width = p_sys->i_original_frame_width;
545                 fmt.subs.spu.i_original_frame_height = p_sys->i_original_frame_height;
546                 fmt.psz_language = language;
547                 if( p_sys->b_palette )
548                 {
549                     fmt.subs.spu.palette[0] = 0xBeef;
550                     memcpy( &fmt.subs.spu.palette[1], p_sys->palette, 16 * sizeof( uint32_t ) );
551                 }
552
553                 current_tk->p_es = es_out_Add( p_demux->out, &fmt );
554                 msg_Dbg( p_demux, "new vobsub track detected" );
555             }
556             else
557             {
558                 msg_Warn( p_demux, "reading new track failed" );
559             }
560         }
561         else if( !strncmp( line, "timestamp:", 10 ) )
562         {
563             /*
564              * timestamp: [sign]hh:mm:ss:mss, filepos: loc
565              * loc is the hex location of the spu in the .sub file
566              */
567             int h, m, s, ms, count, loc = 0;
568             int i_sign = 1;
569             int64_t i_start, i_location = 0;
570
571             if( p_sys->i_tracks > 0 &&
572                 sscanf( line, "timestamp: %d%n:%d:%d:%d, filepos: %x",
573                         &h, &count, &m, &s, &ms, &loc ) >= 5  )
574             {
575                 vobsub_track_t *current_tk = &p_sys->track[p_sys->i_tracks - 1];
576                 subtitle_t *current_sub;
577
578                 if( line[count-3] == '-' )
579                 {
580                     i_sign = -1;
581                     h = -h;
582                 }
583                 i_start = (int64_t) ( h * 3600*1000 +
584                             m * 60*1000 +
585                             s * 1000 +
586                             ms ) * 1000;
587                 i_location = loc;
588
589                 current_tk->i_subtitles++;
590                 current_tk->p_subtitles =
591                     xrealloc( current_tk->p_subtitles,
592                       sizeof( subtitle_t ) * (current_tk->i_subtitles + 1 ) );
593                 current_sub = &current_tk->p_subtitles[current_tk->i_subtitles - 1];
594
595                 current_sub->i_start = i_start * i_sign;
596                 current_sub->i_start += current_tk->i_delay;
597                 current_sub->i_vobsub_location = i_location;
598             }
599             else
600             {
601                 msg_Warn( p_demux, "reading timestamp failed" );
602             }
603         }
604         else if( !strncasecmp( line, "delay:", 6 ) )
605         {
606             /*
607              * delay: [sign]hh:mm:ss:mss
608              */
609             int h, m, s, ms, count = 0;
610             int i_sign = 1;
611             int64_t i_gap = 0;
612
613             if( p_sys->i_tracks > 0 &&
614                 sscanf( line, "%*celay: %d%n:%d:%d:%d",
615                         &h, &count, &m, &s, &ms ) >= 4 )
616             {
617                 vobsub_track_t *current_tk = &p_sys->track[p_sys->i_tracks - 1];
618                 if( line[count-3] == '-' )
619                 {
620                     i_sign = -1;
621                     h = -h;
622                 }
623                 i_gap = (int64_t) ( h * 3600*1000 +
624                             m * 60*1000 +
625                             s * 1000 +
626                             ms ) * 1000;
627
628                 current_tk->i_delay = current_tk->i_delay + (i_gap * i_sign);
629                 msg_Dbg( p_demux, "sign: %+d gap: %+"PRId64" global delay: %+"PRId64"",
630                          i_sign, i_gap, current_tk->i_delay );
631             }
632             else
633             {
634                 msg_Warn( p_demux, "reading delay failed" );
635             }
636         }
637     }
638     return( 0 );
639 }
640
641 static int DemuxVobSub( demux_t *p_demux, block_t *p_bk )
642 {
643     demux_sys_t *p_sys = p_demux->p_sys;
644     uint8_t     *p = p_bk->p_buffer;
645     uint8_t     *p_end = &p_bk->p_buffer[p_bk->i_buffer];
646     int i;
647
648     while( p + 6 < p_end )
649     {
650         int i_size = ps_pkt_size( p, p_end - p );
651         block_t *p_pkt;
652         int      i_id;
653         int      i_spu;
654
655         if( i_size <= 0 )
656             break;
657
658         if( i_size > p_end - p )
659         {
660             msg_Warn( p_demux, "broken PES size" );
661             break;
662         }
663
664         if( p[0] != 0 || p[1] != 0 || p[2] != 0x01 )
665         {
666             msg_Warn( p_demux, "invalid PES" );
667             break;
668         }
669
670         if( p[3] != 0xbd )
671         {
672             /* msg_Dbg( p_demux, "we don't need these ps packets (id=0x1%2.2x)", p[3] ); */
673             p += i_size;
674             continue;
675         }
676
677         /* Create a block */
678         p_pkt = block_New( p_demux, i_size );
679         memcpy( p_pkt->p_buffer, p, i_size);
680         p += i_size;
681
682         i_id = ps_pkt_id( p_pkt );
683         if( (i_id&0xffe0) != 0xbd20 ||
684             ps_pkt_parse_pes( p_pkt, 1 ) )
685         {
686             block_Release( p_pkt );
687             continue;
688         }
689         i_spu = i_id&0x1f;
690         /* msg_Dbg( p_demux, "SPU track %d size %d", i_spu, i_size ); */
691
692         for( i = 0; i < p_sys->i_tracks; i++ )
693         {
694             vobsub_track_t *p_tk = &p_sys->track[i];
695
696             p_pkt->i_dts = p_pkt->i_pts = p_bk->i_pts;
697             p_pkt->i_length = 0;
698
699             if( p_tk->p_es && p_tk->i_track_id == i_spu )
700             {
701                 es_out_Send( p_demux->out, p_tk->p_es, p_pkt );
702                 p_bk->i_pts = VLC_TS_INVALID;     /*only first packet has a pts */
703                 break;
704             }
705         }
706         if( i >= p_sys->i_tracks )
707         {
708             block_Release( p_pkt );
709         }
710     }
711
712     return VLC_SUCCESS;
713 }
714