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>
35 #include <sys/types.h>
38 #include <vlc_demux.h>
45 /*****************************************************************************
47 *****************************************************************************/
48 static int Open ( vlc_object_t *p_this );
49 static void Close( vlc_object_t *p_this );
52 set_description( N_("Vobsub subtitles parser") )
53 set_category( CAT_INPUT )
54 set_subcategory( SUBCAT_INPUT_DEMUX )
55 set_capability( "demux", 1 )
57 set_callbacks( Open, Close )
59 add_shortcut( "vobsub", "subtitle" )
62 /*****************************************************************************
64 *****************************************************************************/
72 static int TextLoad( text_t *, stream_t *s );
73 static void TextUnload( text_t * );
78 int i_vobsub_location;
87 int i_current_subtitle;
89 subtitle_t *p_subtitles;
96 int64_t i_next_demux_date;
100 stream_t *p_vobsub_stream;
104 vobsub_track_t *track;
106 int i_original_frame_width;
107 int i_original_frame_height;
109 uint32_t palette[16];
112 static int Demux( demux_t * );
113 static int Control( demux_t *, int, va_list );
115 static int ParseVobSubIDX( demux_t * );
116 static int DemuxVobSub( demux_t *, block_t *);
118 /*****************************************************************************
120 *****************************************************************************/
121 static int Open ( vlc_object_t *p_this )
123 demux_t *p_demux = (demux_t*)p_this;
125 char *psz_vobname, *s;
128 if( ( s = stream_ReadLine( p_demux->s ) ) != NULL )
130 if( !strcasestr( s, "# VobSub index file" ) )
132 msg_Dbg( p_demux, "this doesn't seem to be a vobsub file" );
134 if( stream_Seek( p_demux->s, 0 ) )
136 msg_Warn( p_demux, "failed to rewind" );
145 msg_Dbg( p_demux, "could not read vobsub IDX file" );
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 ) )
155 p_sys->p_vobsub_stream = NULL;
157 p_sys->track = malloc( sizeof( vobsub_track_t ) );
158 if( unlikely( !p_sys->track ) )
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 ) );
168 /* Load the whole file */
169 TextLoad( &p_sys->txt, p_demux->s );
172 ParseVobSubIDX( p_demux );
175 TextUnload( &p_sys->txt );
177 /* Find the total length of the vobsubs */
178 if( p_sys->i_tracks > 0 )
181 for( i = 0; i < p_sys->i_tracks; i++ )
183 if( p_sys->track[i].i_subtitles > 1 )
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 );
191 if( asprintf( &psz_vobname, "%s://%s", p_demux->psz_access,
192 p_demux->psz_location ) == -1 )
197 i_len = strlen( psz_vobname );
198 if( i_len >= 4 ) memcpy( psz_vobname + i_len - 4, ".sub", 4 );
201 p_sys->p_vobsub_stream = stream_UrlNew( p_demux, psz_vobname );
202 if( p_sys->p_vobsub_stream == NULL )
204 msg_Err( p_demux, "couldn't open .sub Vobsub file: %s",
215 /*****************************************************************************
216 * Close: Close subtitle demux
217 *****************************************************************************/
218 static void Close( vlc_object_t *p_this )
221 demux_t *p_demux = (demux_t*)p_this;
222 demux_sys_t *p_sys = p_demux->p_sys;
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 );
228 free( p_sys->track );
230 if( p_sys->p_vobsub_stream )
231 stream_Delete( p_sys->p_vobsub_stream );
236 /*****************************************************************************
238 *****************************************************************************/
239 static int Control( demux_t *p_demux, int i_query, va_list args )
241 demux_sys_t *p_sys = p_demux->p_sys;
248 case DEMUX_GET_LENGTH:
249 pi64 = (int64_t*)va_arg( args, int64_t * );
250 *pi64 = (int64_t) p_sys->i_length;
254 pi64 = (int64_t*)va_arg( args, int64_t * );
255 for( i = 0; i < p_sys->i_tracks; i++ )
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;
263 if( i < p_sys->i_tracks && p_sys->track[i].i_current_subtitle < p_sys->track[i].i_subtitles )
265 *pi64 = p_sys->track[i].p_subtitles[p_sys->track[i].i_current_subtitle].i_start;
271 i64 = (int64_t)va_arg( args, int64_t );
272 for( i = 0; i < p_sys->i_tracks; i++ )
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 )
278 p_sys->track[i].i_current_subtitle++;
281 if( p_sys->track[i].i_current_subtitle >= p_sys->track[i].i_subtitles )
286 case DEMUX_GET_POSITION:
287 pf = (double*)va_arg( args, double * );
288 for( i = 0; i < p_sys->i_tracks; i++ )
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;
296 if( p_sys->track[i].i_current_subtitle >= p_sys->track[i].i_subtitles )
300 else if( p_sys->track[i].i_subtitles > 0 )
302 *pf = (double)p_sys->track[i].p_subtitles[p_sys->track[i].i_current_subtitle].i_start /
303 (double)p_sys->i_length;
311 case DEMUX_SET_POSITION:
312 f = (double)va_arg( args, double );
313 i64 = (int64_t) f * p_sys->i_length;
315 for( i = 0; i < p_sys->i_tracks; i++ )
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 )
321 p_sys->track[i].i_current_subtitle++;
323 if( p_sys->track[i].i_current_subtitle >= p_sys->track[i].i_subtitles )
328 case DEMUX_SET_NEXT_DEMUX_TIME:
329 p_sys->i_next_demux_date = (int64_t)va_arg( args, int64_t );
332 case DEMUX_GET_PTS_DELAY:
335 case DEMUX_GET_TITLE_INFO:
336 case DEMUX_HAS_UNSUPPORTED_META:
337 case DEMUX_GET_ATTACHMENTS:
338 case DEMUX_CAN_RECORD:
342 msg_Warn( p_demux, "unknown query in subtitle control" );
347 /*****************************************************************************
348 * Demux: Send subtitle to decoder
349 *****************************************************************************/
350 static int Demux( demux_t *p_demux )
352 demux_sys_t *p_sys = p_demux->p_sys;
356 for( i = 0; i < p_sys->i_tracks; i++ )
358 #define tk p_sys->track[i]
359 if( tk.i_current_subtitle >= tk.i_subtitles )
362 i_maxdate = p_sys->i_next_demux_date;
363 if( i_maxdate <= 0 && tk.i_current_subtitle < tk.i_subtitles )
365 /* Should not happen */
366 i_maxdate = tk.p_subtitles[tk.i_current_subtitle].i_start + 1;
369 while( tk.i_current_subtitle < tk.i_subtitles &&
370 tk.p_subtitles[tk.i_current_subtitle].i_start < i_maxdate )
372 int i_pos = tk.p_subtitles[tk.i_current_subtitle].i_vobsub_location;
376 /* first compute SPU size */
377 if( tk.i_current_subtitle + 1 < tk.i_subtitles )
379 i_size = tk.p_subtitles[tk.i_current_subtitle+1].i_vobsub_location - i_pos;
381 if( i_size <= 0 ) i_size = 65535; /* Invalid or EOF */
383 /* Seek at the right place */
384 if( stream_Seek( p_sys->p_vobsub_stream, i_pos ) )
387 "cannot seek in the VobSub to the correct time %d", i_pos );
388 tk.i_current_subtitle++;
392 /* allocate a packet */
393 if( ( p_block = block_New( p_demux, i_size ) ) == NULL )
395 tk.i_current_subtitle++;
400 i_read = stream_Read( p_sys->p_vobsub_stream, p_block->p_buffer, i_size );
403 block_Release( p_block );
404 tk.i_current_subtitle++;
407 p_block->i_buffer = i_read;
410 p_block->i_pts = VLC_TS_0 + tk.p_subtitles[tk.i_current_subtitle].i_start;
412 /* demux this block */
413 DemuxVobSub( p_demux, p_block );
415 tk.i_current_subtitle++;
421 p_sys->i_next_demux_date = 0;
426 static int TextLoad( text_t *txt, stream_t *s )
431 /* load the complete file */
434 char *psz = stream_ReadLine( s );
437 if( psz == NULL || (n >= INT_MAX/sizeof(char *)) )
440 ppsz_new = realloc( lines, (n + 1) * sizeof (char *) );
441 if( ppsz_new == NULL )
450 txt->i_line_count = n;
457 static void TextUnload( text_t *txt )
461 for( i = 0; i < txt->i_line_count; i++ )
462 free( txt->line[i] );
466 txt->i_line_count = 0;
469 static char *TextGetLine( text_t *txt )
471 if( txt->i_line >= txt->i_line_count )
474 return txt->line[txt->i_line++];
477 static int ParseVobSubIDX( demux_t *p_demux )
479 demux_sys_t *p_sys = p_demux->p_sys;
480 text_t *txt = &p_sys->txt;
482 vobsub_track_t *current_tk = NULL;
486 if( ( line = TextGetLine( txt ) ) == NULL )
488 return( VLC_EGENERIC );
491 if( *line == 0 || *line == '\r' || *line == '\n' || *line == '#' )
495 else if( !strncmp( "size:", line, 5 ) )
497 /* Store the original size of the video */
498 if( vobsub_size_parse( line, &p_sys->i_original_frame_width,
499 &p_sys->i_original_frame_height ) == VLC_SUCCESS )
501 msg_Dbg( p_demux, "original frame size: %dx%d", p_sys->i_original_frame_width, p_sys->i_original_frame_height );
505 msg_Warn( p_demux, "reading original frame size failed" );
508 else if( !strncmp( "palette:", line, 8 ) )
510 if( vobsub_palette_parse( line, p_sys->palette ) == VLC_SUCCESS )
512 p_sys->b_palette = true;
513 msg_Dbg( p_demux, "vobsub palette read" );
517 msg_Warn( p_demux, "reading original palette failed" );
520 else if( !strncmp( "id:", line, 3 ) )
522 char language[33]; /* Usually 2 or 3 letters, sometimes more.
523 Spec (or lack of) doesn't define any limit */
527 /* Lets start a new track */
528 if( sscanf( line, "id: %32[^ ,], index: %d",
529 language, &i_track_id ) == 2 )
532 p_sys->track = xrealloc( p_sys->track,
533 sizeof( vobsub_track_t ) * (p_sys->i_tracks + 1 ) );
536 current_tk = &p_sys->track[p_sys->i_tracks - 1];
537 memset( current_tk, 0, sizeof( vobsub_track_t ) );
538 current_tk->i_current_subtitle = 0;
539 current_tk->i_subtitles = 0;
540 current_tk->p_subtitles = xmalloc( sizeof( subtitle_t ) );
541 current_tk->i_track_id = i_track_id;
542 current_tk->i_delay = (int64_t)0;
544 es_format_Init( &fmt, SPU_ES, VLC_CODEC_SPU );
545 fmt.subs.spu.i_original_frame_width = p_sys->i_original_frame_width;
546 fmt.subs.spu.i_original_frame_height = p_sys->i_original_frame_height;
547 fmt.psz_language = language;
548 if( p_sys->b_palette )
550 fmt.subs.spu.palette[0] = 0xBeef;
551 memcpy( &fmt.subs.spu.palette[1], p_sys->palette, 16 * sizeof( uint32_t ) );
554 current_tk->p_es = es_out_Add( p_demux->out, &fmt );
555 msg_Dbg( p_demux, "new vobsub track detected" );
559 msg_Warn( p_demux, "reading new track failed" );
562 else if( !strncmp( line, "timestamp:", 10 ) )
565 * timestamp: [sign]hh:mm:ss:mss, filepos: loc
566 * loc is the hex location of the spu in the .sub file
568 int h, m, s, ms, count, loc = 0;
570 int64_t i_start, i_location = 0;
572 if( p_sys->i_tracks > 0 &&
573 sscanf( line, "timestamp: %d%n:%d:%d:%d, filepos: %x",
574 &h, &count, &m, &s, &ms, &loc ) >= 5 )
576 vobsub_track_t *current_tk = &p_sys->track[p_sys->i_tracks - 1];
577 subtitle_t *current_sub;
579 if( line[count-3] == '-' )
584 i_start = (int64_t) ( h * 3600*1000 +
590 current_tk->i_subtitles++;
591 current_tk->p_subtitles =
592 xrealloc( current_tk->p_subtitles,
593 sizeof( subtitle_t ) * (current_tk->i_subtitles + 1 ) );
594 current_sub = ¤t_tk->p_subtitles[current_tk->i_subtitles - 1];
596 current_sub->i_start = i_start * i_sign;
597 current_sub->i_start += current_tk->i_delay;
598 current_sub->i_vobsub_location = i_location;
602 msg_Warn( p_demux, "reading timestamp failed" );
605 else if( !strncasecmp( line, "delay:", 6 ) )
608 * delay: [sign]hh:mm:ss:mss
610 int h, m, s, ms, count = 0;
614 if( p_sys->i_tracks > 0 &&
615 sscanf( line, "%*celay: %d%n:%d:%d:%d",
616 &h, &count, &m, &s, &ms ) >= 4 )
618 vobsub_track_t *current_tk = &p_sys->track[p_sys->i_tracks - 1];
619 if( line[count-3] == '-' )
624 i_gap = (int64_t) ( h * 3600*1000 +
629 current_tk->i_delay = current_tk->i_delay + (i_gap * i_sign);
630 msg_Dbg( p_demux, "sign: %+d gap: %+"PRId64" global delay: %+"PRId64"",
631 i_sign, i_gap, current_tk->i_delay );
635 msg_Warn( p_demux, "reading delay failed" );
642 static int DemuxVobSub( demux_t *p_demux, block_t *p_bk )
644 demux_sys_t *p_sys = p_demux->p_sys;
645 uint8_t *p = p_bk->p_buffer;
646 uint8_t *p_end = &p_bk->p_buffer[p_bk->i_buffer];
649 while( p + 6 < p_end )
651 int i_size = ps_pkt_size( p, p_end - p );
659 if( i_size > p_end - p )
661 msg_Warn( p_demux, "broken PES size" );
665 if( p[0] != 0 || p[1] != 0 || p[2] != 0x01 )
667 msg_Warn( p_demux, "invalid PES" );
673 /* msg_Dbg( p_demux, "we don't need these ps packets (id=0x1%2.2x)", p[3] ); */
679 p_pkt = block_New( p_demux, i_size );
680 memcpy( p_pkt->p_buffer, p, i_size);
683 i_id = ps_pkt_id( p_pkt );
684 if( (i_id&0xffe0) != 0xbd20 ||
685 ps_pkt_parse_pes( p_pkt, 1 ) )
687 block_Release( p_pkt );
691 /* msg_Dbg( p_demux, "SPU track %d size %d", i_spu, i_size ); */
693 for( i = 0; i < p_sys->i_tracks; i++ )
695 vobsub_track_t *p_tk = &p_sys->track[i];
697 p_pkt->i_dts = p_pkt->i_pts = p_bk->i_pts;
700 if( p_tk->p_es && p_tk->i_track_id == i_spu )
702 es_out_Send( p_demux->out, p_tk->p_es, p_pkt );
703 p_bk->i_pts = VLC_TS_INVALID; /*only first packet has a pts */
707 if( i >= p_sys->i_tracks )
709 block_Release( p_pkt );