1 /*****************************************************************************
2 * subtitle.c: Demux vobsub files.
3 *****************************************************************************
4 * Copyright (C) 1999-2004 the VideoLAN team
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8 * Derk-Jan Hartman <hartman at videolan dot org>
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.
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.
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 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
36 #include <sys/types.h>
39 #include <vlc_demux.h>
40 #include <vlc_charset.h>
47 /*****************************************************************************
49 *****************************************************************************/
50 static int Open ( vlc_object_t *p_this );
51 static void Close( vlc_object_t *p_this );
54 set_description( N_("Vobsub subtitles parser") )
55 set_category( CAT_INPUT )
56 set_subcategory( SUBCAT_INPUT_DEMUX )
57 set_capability( "demux", 1 )
59 set_callbacks( Open, Close )
61 add_shortcut( "vobsub" )
62 add_shortcut( "subtitle" )
65 /*****************************************************************************
67 *****************************************************************************/
75 static int TextLoad( text_t *, stream_t *s );
76 static void TextUnload( text_t * );
81 int i_vobsub_location;
90 int i_current_subtitle;
92 subtitle_t *p_subtitles;
99 int64_t i_next_demux_date;
103 stream_t *p_vobsub_stream;
107 vobsub_track_t *track;
109 int i_original_frame_width;
110 int i_original_frame_height;
112 uint32_t palette[16];
115 static int Demux( demux_t * );
116 static int Control( demux_t *, int, va_list );
118 static int ParseVobSubIDX( demux_t * );
119 static int DemuxVobSub( demux_t *, block_t *);
121 /*****************************************************************************
123 *****************************************************************************/
124 static int Open ( vlc_object_t *p_this )
126 demux_t *p_demux = (demux_t*)p_this;
128 char *psz_vobname, *s;
131 if( ( s = stream_ReadLine( p_demux->s ) ) != NULL )
133 if( !strcasestr( s, "# VobSub index file" ) )
135 msg_Dbg( p_demux, "this doesn't seem to be a vobsub file" );
137 if( stream_Seek( p_demux->s, 0 ) )
139 msg_Warn( p_demux, "failed to rewind" );
148 msg_Dbg( p_demux, "could not read vobsub IDX file" );
152 p_demux->pf_demux = Demux;
153 p_demux->pf_control = Control;
154 p_demux->p_sys = p_sys = malloc( sizeof( demux_sys_t ) );
156 p_sys->p_vobsub_stream = NULL;
158 p_sys->track = (vobsub_track_t *)malloc( sizeof( vobsub_track_t ) );
159 p_sys->i_original_frame_width = -1;
160 p_sys->i_original_frame_height = -1;
161 p_sys->b_palette = false;
162 memset( p_sys->palette, 0, 16 * sizeof( uint32_t ) );
164 /* Load the whole file */
165 TextLoad( &p_sys->txt, p_demux->s );
168 ParseVobSubIDX( p_demux );
171 TextUnload( &p_sys->txt );
173 /* Find the total length of the vobsubs */
174 if( p_sys->i_tracks > 0 )
177 for( i = 0; i < p_sys->i_tracks; i++ )
179 if( p_sys->track[i].i_subtitles > 1 )
181 if( p_sys->track[i].p_subtitles[p_sys->track[i].i_subtitles-1].i_start > p_sys->i_length )
182 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 if( asprintf( &psz_vobname, "%s://%s", p_demux->psz_access, p_demux->psz_path ) == -1 )
192 i_len = strlen( psz_vobname );
193 if( i_len >= 4 ) memcpy( psz_vobname + i_len - 4, ".sub", 4 );
196 p_sys->p_vobsub_stream = stream_UrlNew( p_demux, psz_vobname );
197 if( p_sys->p_vobsub_stream == NULL )
199 msg_Err( p_demux, "couldn't open .sub Vobsub file: %s",
210 /*****************************************************************************
211 * Close: Close subtitle demux
212 *****************************************************************************/
213 static void Close( vlc_object_t *p_this )
216 demux_t *p_demux = (demux_t*)p_this;
217 demux_sys_t *p_sys = p_demux->p_sys;
219 /* Clean all subs from all tracks */
220 for( i = 0; i < p_sys->i_tracks; i++ )
221 free( p_sys->track[i].p_subtitles );
223 free( p_sys->track );
225 if( p_sys->p_vobsub_stream )
226 stream_Delete( p_sys->p_vobsub_stream );
231 /*****************************************************************************
233 *****************************************************************************/
234 static int Control( demux_t *p_demux, int i_query, va_list args )
236 demux_sys_t *p_sys = p_demux->p_sys;
243 case DEMUX_GET_LENGTH:
244 pi64 = (int64_t*)va_arg( args, int64_t * );
245 *pi64 = (int64_t) p_sys->i_length;
249 pi64 = (int64_t*)va_arg( args, int64_t * );
250 for( i = 0; i < p_sys->i_tracks; i++ )
253 /* Check the ES is selected */
254 es_out_Control( p_demux->out, ES_OUT_GET_ES_STATE,
255 p_sys->track[i].p_es, &b_selected );
256 if( b_selected ) break;
258 if( i < p_sys->i_tracks && p_sys->track[i].i_current_subtitle < p_sys->track[i].i_subtitles )
260 *pi64 = p_sys->track[i].p_subtitles[p_sys->track[i].i_current_subtitle].i_start;
266 i64 = (int64_t)va_arg( args, int64_t );
267 for( i = 0; i < p_sys->i_tracks; i++ )
269 p_sys->track[i].i_current_subtitle = 0;
270 while( p_sys->track[i].i_current_subtitle < p_sys->track[i].i_subtitles &&
271 p_sys->track[i].p_subtitles[p_sys->track[i].i_current_subtitle].i_start < i64 )
273 p_sys->track[i].i_current_subtitle++;
276 if( p_sys->track[i].i_current_subtitle >= p_sys->track[i].i_subtitles )
281 case DEMUX_GET_POSITION:
282 pf = (double*)va_arg( args, double * );
283 for( i = 0; i < p_sys->i_tracks; i++ )
286 /* Check the ES is selected */
287 es_out_Control( p_demux->out, ES_OUT_GET_ES_STATE,
288 p_sys->track[i].p_es, &b_selected );
289 if( b_selected ) break;
291 if( p_sys->track[i].i_current_subtitle >= p_sys->track[i].i_subtitles )
295 else if( p_sys->track[i].i_subtitles > 0 )
297 *pf = (double)p_sys->track[i].p_subtitles[p_sys->track[i].i_current_subtitle].i_start /
298 (double)p_sys->i_length;
306 case DEMUX_SET_POSITION:
307 f = (double)va_arg( args, double );
308 i64 = (int64_t) f * p_sys->i_length;
310 for( i = 0; i < p_sys->i_tracks; i++ )
312 p_sys->track[i].i_current_subtitle = 0;
313 while( p_sys->track[i].i_current_subtitle < p_sys->track[i].i_subtitles &&
314 p_sys->track[i].p_subtitles[p_sys->track[i].i_current_subtitle].i_start < i64 )
316 p_sys->track[i].i_current_subtitle++;
318 if( p_sys->track[i].i_current_subtitle >= p_sys->track[i].i_subtitles )
323 case DEMUX_SET_NEXT_DEMUX_TIME:
324 p_sys->i_next_demux_date = (int64_t)va_arg( args, int64_t );
329 case DEMUX_GET_TITLE_INFO:
330 case DEMUX_HAS_UNSUPPORTED_META:
331 case DEMUX_GET_ATTACHMENTS:
332 case DEMUX_CAN_RECORD:
336 msg_Warn( p_demux, "unknown query in subtitle control" );
341 /*****************************************************************************
342 * Demux: Send subtitle to decoder
343 *****************************************************************************/
344 static int Demux( demux_t *p_demux )
346 demux_sys_t *p_sys = p_demux->p_sys;
350 for( i = 0; i < p_sys->i_tracks; i++ )
352 #define tk p_sys->track[i]
353 if( tk.i_current_subtitle >= tk.i_subtitles )
356 i_maxdate = p_sys->i_next_demux_date;
357 if( i_maxdate <= 0 && tk.i_current_subtitle < tk.i_subtitles )
359 /* Should not happen */
360 i_maxdate = tk.p_subtitles[tk.i_current_subtitle].i_start + 1;
363 while( tk.i_current_subtitle < tk.i_subtitles &&
364 tk.p_subtitles[tk.i_current_subtitle].i_start < i_maxdate )
366 int i_pos = tk.p_subtitles[tk.i_current_subtitle].i_vobsub_location;
370 /* first compute SPU size */
371 if( tk.i_current_subtitle + 1 < tk.i_subtitles )
373 i_size = tk.p_subtitles[tk.i_current_subtitle+1].i_vobsub_location - i_pos;
375 if( i_size <= 0 ) i_size = 65535; /* Invalid or EOF */
377 /* Seek at the right place */
378 if( stream_Seek( p_sys->p_vobsub_stream, i_pos ) )
381 "cannot seek in the VobSub to the correct time %d", i_pos );
382 tk.i_current_subtitle++;
386 /* allocate a packet */
387 if( ( p_block = block_New( p_demux, i_size ) ) == NULL )
389 tk.i_current_subtitle++;
394 i_read = stream_Read( p_sys->p_vobsub_stream, p_block->p_buffer, i_size );
397 block_Release( p_block );
398 tk.i_current_subtitle++;
401 p_block->i_buffer = i_read;
404 p_block->i_pts = tk.p_subtitles[tk.i_current_subtitle].i_start;
406 /* demux this block */
407 DemuxVobSub( p_demux, p_block );
409 tk.i_current_subtitle++;
415 p_sys->i_next_demux_date = 0;
420 static int TextLoad( text_t *txt, stream_t *s )
425 /* load the complete file */
428 char *psz = stream_ReadLine( s );
431 if( psz == NULL || (n >= INT_MAX/sizeof(char *)) )
434 ppsz_new = realloc( lines, (n + 1) * sizeof (char *) );
435 if( ppsz_new == NULL )
444 txt->i_line_count = n;
451 static void TextUnload( text_t *txt )
455 for( i = 0; i < txt->i_line_count; i++ )
456 free( txt->line[i] );
460 txt->i_line_count = 0;
463 static char *TextGetLine( text_t *txt )
465 if( txt->i_line >= txt->i_line_count )
468 return txt->line[txt->i_line++];
471 static int ParseVobSubIDX( demux_t *p_demux )
473 demux_sys_t *p_sys = p_demux->p_sys;
474 text_t *txt = &p_sys->txt;
476 vobsub_track_t *current_tk = NULL;
480 if( ( line = TextGetLine( txt ) ) == NULL )
482 return( VLC_EGENERIC );
485 if( *line == 0 || *line == '\r' || *line == '\n' || *line == '#' )
489 else if( !strncmp( "size:", line, 5 ) )
491 /* Store the original size of the video */
492 if( vobsub_size_parse( line, &p_sys->i_original_frame_width,
493 &p_sys->i_original_frame_height ) == VLC_SUCCESS )
495 msg_Dbg( p_demux, "original frame size: %dx%d", p_sys->i_original_frame_width, p_sys->i_original_frame_height );
499 msg_Warn( p_demux, "reading original frame size failed" );
502 else if( !strncmp( "palette:", line, 8 ) )
504 if( vobsub_palette_parse( line, p_sys->palette ) == VLC_SUCCESS )
506 p_sys->b_palette = true;
507 msg_Dbg( p_demux, "vobsub palette read" );
511 msg_Warn( p_demux, "reading original palette failed" );
514 else if( !strncmp( "id:", line, 3 ) )
520 /* Lets start a new track */
521 if( sscanf( line, "id: %2s, index: %d",
522 language, &i_track_id ) == 2 )
525 p_sys->track = realloc( p_sys->track, sizeof( vobsub_track_t ) * (p_sys->i_tracks + 1 ) );
529 current_tk = &p_sys->track[p_sys->i_tracks - 1];
530 memset( current_tk, 0, sizeof( vobsub_track_t ) );
531 current_tk->i_current_subtitle = 0;
532 current_tk->i_subtitles = 0;
533 current_tk->p_subtitles = malloc( sizeof( subtitle_t ) );;
534 current_tk->i_track_id = i_track_id;
535 current_tk->i_delay = (int64_t)0;
537 es_format_Init( &fmt, SPU_ES, VLC_CODEC_SPU );
538 fmt.subs.spu.i_original_frame_width = p_sys->i_original_frame_width;
539 fmt.subs.spu.i_original_frame_height = p_sys->i_original_frame_height;
540 fmt.psz_language = language;
541 if( p_sys->b_palette )
543 fmt.subs.spu.palette[0] = 0xBeef;
544 memcpy( &fmt.subs.spu.palette[1], p_sys->palette, 16 * sizeof( uint32_t ) );
547 current_tk->p_es = es_out_Add( p_demux->out, &fmt );
548 msg_Dbg( p_demux, "new vobsub track detected" );
552 msg_Warn( p_demux, "reading new track failed" );
555 else if( !strncmp( line, "timestamp:", 10 ) )
558 * timestamp: [sign]hh:mm:ss:mss, filepos: loc
559 * loc is the hex location of the spu in the .sub file
561 int h, m, s, ms, count, loc = 0;
563 int64_t i_start, i_location = 0;
565 if( p_sys->i_tracks > 0 &&
566 sscanf( line, "timestamp: %d%n:%d:%d:%d, filepos: %x",
567 &h, &count, &m, &s, &ms, &loc ) >= 5 )
569 vobsub_track_t *current_tk = &p_sys->track[p_sys->i_tracks - 1];
570 subtitle_t *current_sub;
572 if( line[count-3] == '-' )
577 i_start = (int64_t) ( h * 3600*1000 +
583 current_tk->i_subtitles++;
584 current_tk->p_subtitles = realloc( current_tk->p_subtitles, sizeof( subtitle_t ) * (current_tk->i_subtitles + 1 ) );
585 current_sub = ¤t_tk->p_subtitles[current_tk->i_subtitles - 1];
587 current_sub->i_start = i_start * i_sign;
588 current_sub->i_start += current_tk->i_delay;
589 current_sub->i_vobsub_location = i_location;
593 msg_Warn( p_demux, "reading timestamp failed" );
596 else if( !strncasecmp( line, "delay:", 6 ) )
599 * delay: [sign]hh:mm:ss:mss
601 int h, m, s, ms, count = 0;
605 if( p_sys->i_tracks > 0 &&
606 sscanf( line, "%*celay: %d%n:%d:%d:%d",
607 &h, &count, &m, &s, &ms ) >= 4 )
609 vobsub_track_t *current_tk = &p_sys->track[p_sys->i_tracks - 1];
610 if( line[count-3] == '-' )
615 i_gap = (int64_t) ( h * 3600*1000 +
620 current_tk->i_delay = current_tk->i_delay + (i_gap * i_sign);
621 msg_Dbg( p_demux, "sign: %+d gap: %+"PRId64" global delay: %+"PRId64"",
622 i_sign, i_gap, current_tk->i_delay );
626 msg_Warn( p_demux, "reading delay failed" );
633 static int DemuxVobSub( demux_t *p_demux, block_t *p_bk )
635 demux_sys_t *p_sys = p_demux->p_sys;
636 uint8_t *p = p_bk->p_buffer;
637 uint8_t *p_end = &p_bk->p_buffer[p_bk->i_buffer];
640 while( p + 6 < p_end )
642 int i_size = ps_pkt_size( p, p_end - p );
650 if( i_size > p_end - p )
652 msg_Warn( p_demux, "broken PES size" );
656 if( p[0] != 0 || p[1] != 0 || p[2] != 0x01 )
658 msg_Warn( p_demux, "invalid PES" );
664 /* msg_Dbg( p_demux, "we don't need these ps packets (id=0x1%2.2x)", p[3] ); */
670 p_pkt = block_New( p_demux, i_size );
671 memcpy( p_pkt->p_buffer, p, i_size);
674 i_id = ps_pkt_id( p_pkt );
675 if( (i_id&0xffe0) != 0xbd20 ||
676 ps_pkt_parse_pes( p_pkt, 1 ) )
678 block_Release( p_pkt );
682 /* msg_Dbg( p_demux, "SPU track %d size %d", i_spu, i_size ); */
684 for( i = 0; i < p_sys->i_tracks; i++ )
686 vobsub_track_t *p_tk = &p_sys->track[i];
688 p_pkt->i_dts = p_pkt->i_pts = p_bk->i_pts;
691 if( p_tk->p_es && p_tk->i_track_id == i_spu )
693 es_out_Send( p_demux->out, p_tk->p_es, p_pkt );
694 p_bk->i_pts = 0; /*only first packet has a pts */
698 if( i >= p_sys->i_tracks )
700 block_Release( p_pkt );