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 *****************************************************************************/
35 #include <sys/types.h>
37 #include <vlc_demux.h>
38 #include <vlc_charset.h>
44 /*****************************************************************************
46 *****************************************************************************/
47 static int Open ( vlc_object_t *p_this );
48 static void Close( vlc_object_t *p_this );
51 set_description( _("Vobsub subtitles parser") );
52 set_category( CAT_INPUT );
53 set_subcategory( SUBCAT_INPUT_DEMUX );
54 set_capability( "demux", 1 );
56 set_callbacks( Open, Close );
58 add_shortcut( "vobsub" );
59 add_shortcut( "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 ) );
153 p_sys->p_vobsub_stream = NULL;
155 p_sys->track = (vobsub_track_t *)malloc( sizeof( vobsub_track_t ) );
156 p_sys->i_original_frame_width = -1;
157 p_sys->i_original_frame_height = -1;
158 p_sys->b_palette = false;
159 memset( p_sys->palette, 0, 16 * sizeof( uint32_t ) );
161 /* Load the whole file */
162 TextLoad( &p_sys->txt, p_demux->s );
165 ParseVobSubIDX( p_demux );
168 TextUnload( &p_sys->txt );
170 /* Find the total length of the vobsubs */
171 if( p_sys->i_tracks > 0 )
174 for( i = 0; i < p_sys->i_tracks; i++ )
176 if( p_sys->track[i].i_subtitles > 1 )
178 if( p_sys->track[i].p_subtitles[p_sys->track[i].i_subtitles-1].i_start > p_sys->i_length )
179 p_sys->i_length = (int64_t) p_sys->track[i].p_subtitles[p_sys->track[i].i_subtitles-1].i_start + ( 1 *1000 *1000 );
184 asprintf( &psz_vobname, "%s://%s", p_demux->psz_access, p_demux->psz_path );
185 i_len = strlen( psz_vobname );
186 if( i_len >= 4 ) memcpy( psz_vobname + i_len - 4, ".sub", 4 );
189 p_sys->p_vobsub_stream = stream_UrlNew( p_demux, psz_vobname );
190 if( p_sys->p_vobsub_stream == NULL )
192 msg_Err( p_demux, "couldn't open .sub Vobsub file: %s",
203 /*****************************************************************************
204 * Close: Close subtitle demux
205 *****************************************************************************/
206 static void Close( vlc_object_t *p_this )
209 demux_t *p_demux = (demux_t*)p_this;
210 demux_sys_t *p_sys = p_demux->p_sys;
212 /* Clean all subs from all tracks */
213 for( i = 0; i < p_sys->i_tracks; i++ )
214 free( p_sys->track[i].p_subtitles );
216 free( p_sys->track );
218 if( p_sys->p_vobsub_stream )
219 stream_Delete( p_sys->p_vobsub_stream );
224 /*****************************************************************************
226 *****************************************************************************/
227 static int Control( demux_t *p_demux, int i_query, va_list args )
229 demux_sys_t *p_sys = p_demux->p_sys;
236 case DEMUX_GET_LENGTH:
237 pi64 = (int64_t*)va_arg( args, int64_t * );
238 *pi64 = (int64_t) p_sys->i_length;
242 pi64 = (int64_t*)va_arg( args, int64_t * );
243 for( i = 0; i < p_sys->i_tracks; i++ )
246 /* Check the ES is selected */
247 es_out_Control( p_demux->out, ES_OUT_GET_ES_STATE,
248 p_sys->track[i].p_es, &b_selected );
249 if( b_selected ) break;
251 if( i < p_sys->i_tracks && p_sys->track[i].i_current_subtitle < p_sys->track[i].i_subtitles )
253 *pi64 = p_sys->track[i].p_subtitles[p_sys->track[i].i_current_subtitle].i_start;
259 i64 = (int64_t)va_arg( args, int64_t );
260 for( i = 0; i < p_sys->i_tracks; i++ )
262 p_sys->track[i].i_current_subtitle = 0;
263 while( p_sys->track[i].i_current_subtitle < p_sys->track[i].i_subtitles &&
264 p_sys->track[i].p_subtitles[p_sys->track[i].i_current_subtitle].i_start < i64 )
266 p_sys->track[i].i_current_subtitle++;
269 if( p_sys->track[i].i_current_subtitle >= p_sys->track[i].i_subtitles )
274 case DEMUX_GET_POSITION:
275 pf = (double*)va_arg( args, double * );
276 for( i = 0; i < p_sys->i_tracks; i++ )
279 /* Check the ES is selected */
280 es_out_Control( p_demux->out, ES_OUT_GET_ES_STATE,
281 p_sys->track[i].p_es, &b_selected );
282 if( b_selected ) break;
284 if( p_sys->track[i].i_current_subtitle >= p_sys->track[i].i_subtitles )
288 else if( p_sys->track[i].i_subtitles > 0 )
290 *pf = (double)p_sys->track[i].p_subtitles[p_sys->track[i].i_current_subtitle].i_start /
291 (double)p_sys->i_length;
299 case DEMUX_SET_POSITION:
300 f = (double)va_arg( args, double );
301 i64 = (int64_t) f * p_sys->i_length;
303 for( i = 0; i < p_sys->i_tracks; i++ )
305 p_sys->track[i].i_current_subtitle = 0;
306 while( p_sys->track[i].i_current_subtitle < p_sys->track[i].i_subtitles &&
307 p_sys->track[i].p_subtitles[p_sys->track[i].i_current_subtitle].i_start < i64 )
309 p_sys->track[i].i_current_subtitle++;
311 if( p_sys->track[i].i_current_subtitle >= p_sys->track[i].i_subtitles )
316 case DEMUX_SET_NEXT_DEMUX_TIME:
317 p_sys->i_next_demux_date = (int64_t)va_arg( args, int64_t );
322 case DEMUX_GET_TITLE_INFO:
326 msg_Err( p_demux, "unknown query in subtitle control" );
331 /*****************************************************************************
332 * Demux: Send subtitle to decoder
333 *****************************************************************************/
334 static int Demux( demux_t *p_demux )
336 demux_sys_t *p_sys = p_demux->p_sys;
340 for( i = 0; i < p_sys->i_tracks; i++ )
342 #define tk p_sys->track[i]
343 if( tk.i_current_subtitle >= tk.i_subtitles )
346 i_maxdate = (int64_t) p_sys->i_next_demux_date;
347 if( i_maxdate <= 0 && tk.i_current_subtitle < tk.i_subtitles )
349 /* Should not happen */
350 i_maxdate = (int64_t) tk.p_subtitles[tk.i_current_subtitle].i_start + 1;
353 while( tk.i_current_subtitle < tk.i_subtitles &&
354 tk.p_subtitles[tk.i_current_subtitle].i_start < i_maxdate )
356 int i_pos = tk.p_subtitles[tk.i_current_subtitle].i_vobsub_location;
360 /* first compute SPU size */
361 if( tk.i_current_subtitle + 1 < tk.i_subtitles )
363 i_size = tk.p_subtitles[tk.i_current_subtitle+1].i_vobsub_location - i_pos;
365 if( i_size <= 0 ) i_size = 65535; /* Invalid or EOF */
367 /* Seek at the right place */
368 if( stream_Seek( p_sys->p_vobsub_stream, i_pos ) )
371 "cannot seek in the VobSub to the correct time %d", i_pos );
372 tk.i_current_subtitle++;
376 /* allocate a packet */
377 if( ( p_block = block_New( p_demux, i_size ) ) == NULL )
379 tk.i_current_subtitle++;
384 p_block->i_buffer = stream_Read( p_sys->p_vobsub_stream, p_block->p_buffer, i_size );
385 if( p_block->i_buffer <= 6 )
387 block_Release( p_block );
388 tk.i_current_subtitle++;
393 p_block->i_pts = tk.p_subtitles[tk.i_current_subtitle].i_start;
395 /* demux this block */
396 DemuxVobSub( p_demux, p_block );
398 tk.i_current_subtitle++;
404 p_sys->i_next_demux_date = 0;
409 static int TextLoad( text_t *txt, stream_t *s )
415 txt->i_line_count = 0;
417 txt->line = calloc( i_line_max, sizeof( char * ) );
419 /* load the complete file */
422 char *psz = stream_ReadLine( s );
427 txt->line[txt->i_line_count++] = psz;
428 if( txt->i_line_count >= i_line_max )
431 txt->line = realloc( txt->line, i_line_max * sizeof( char*) );
435 if( txt->i_line_count <= 0 )
443 static void TextUnload( text_t *txt )
447 for( i = 0; i < txt->i_line_count; i++ )
448 free( txt->line[i] );
452 txt->i_line_count = 0;
455 static char *TextGetLine( text_t *txt )
457 if( txt->i_line >= txt->i_line_count )
460 return txt->line[txt->i_line++];
463 static int ParseVobSubIDX( demux_t *p_demux )
465 demux_sys_t *p_sys = p_demux->p_sys;
466 text_t *txt = &p_sys->txt;
468 vobsub_track_t *current_tk;
472 if( ( line = TextGetLine( txt ) ) == NULL )
474 return( VLC_EGENERIC );
477 if( *line == 0 || *line == '\r' || *line == '\n' || *line == '#' )
479 else if( !strncmp( "size:", line, 5 ) )
481 /* Store the original size of the video */
482 if( sscanf( line, "size: %dx%d",
483 &p_sys->i_original_frame_width, &p_sys->i_original_frame_height ) == 2 )
485 msg_Dbg( p_demux, "original frame size: %dx%d", p_sys->i_original_frame_width, p_sys->i_original_frame_height );
489 msg_Warn( p_demux, "reading original frame size failed" );
492 else if( !strncmp( "palette:", line, 8 ) )
496 /* Store the palette of the subs */
497 if( sscanf( line, "palette: %x, %x, %x, %x, %x, %x, %x, %x, %x, %x, %x, %x, %x, %x, %x, %x",
498 &p_sys->palette[0], &p_sys->palette[1], &p_sys->palette[2], &p_sys->palette[3],
499 &p_sys->palette[4], &p_sys->palette[5], &p_sys->palette[6], &p_sys->palette[7],
500 &p_sys->palette[8], &p_sys->palette[9], &p_sys->palette[10], &p_sys->palette[11],
501 &p_sys->palette[12], &p_sys->palette[13], &p_sys->palette[14], &p_sys->palette[15] ) == 16 )
503 for( i = 0; i < 16; i++ )
505 uint8_t r = 0, g = 0, b = 0;
506 uint8_t y = 0, u = 0, v = 0;
507 r = (p_sys->palette[i] >> 16) & 0xff;
508 g = (p_sys->palette[i] >> 8) & 0xff;
509 b = (p_sys->palette[i] >> 0) & 0xff;
510 /* msg_Dbg( p_demux, "palette %d: R=%x, G=%x, B=%x", i, r, g, b ); */
511 y = (uint8_t) __MIN(abs(r * 2104 + g * 4130 + b * 802 + 4096 + 131072) >> 13, 235);
512 u = (uint8_t) __MIN(abs(r * -1214 + g * -2384 + b * 3598 + 4096 + 1048576) >> 13, 240);
513 v = (uint8_t) __MIN(abs(r * 3598 + g * -3013 + b * -585 + 4096 + 1048576) >> 13, 240);
514 p_sys->palette[i] = 0;
515 p_sys->palette[i] |= (y&0xff)<<16;
516 p_sys->palette[i] |= (u&0xff);
517 p_sys->palette[i] |= (v&0xff)<<8;
518 /* msg_Dbg( p_demux, "palette %d: y=%x, u=%x, v=%x", i, y, u, v ); */
521 p_sys->b_palette = true;
522 msg_Dbg( p_demux, "vobsub palette read" );
526 msg_Warn( p_demux, "reading original palette failed" );
529 else if( !strncmp( "id:", line, 3 ) )
535 /* Lets start a new track */
536 if( sscanf( line, "id: %2s, index: %d",
537 language, &i_track_id ) == 2 )
540 p_sys->track = (vobsub_track_t*)realloc( p_sys->track, sizeof( vobsub_track_t ) * (p_sys->i_tracks + 1 ) );
543 current_tk = &p_sys->track[p_sys->i_tracks - 1];
544 memset( current_tk, 0, sizeof( vobsub_track_t ) );
545 current_tk->i_current_subtitle = 0;
546 current_tk->i_subtitles = 0;
547 current_tk->p_subtitles = (subtitle_t*)malloc( sizeof( subtitle_t ) );;
548 current_tk->i_track_id = i_track_id;
549 current_tk->i_delay = (int64_t)0;
551 es_format_Init( &fmt, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
552 fmt.subs.spu.i_original_frame_width = p_sys->i_original_frame_width;
553 fmt.subs.spu.i_original_frame_height = p_sys->i_original_frame_height;
554 fmt.psz_language = strdup( language );
555 if( p_sys->b_palette )
557 fmt.subs.spu.palette[0] = 0xBeef;
558 memcpy( &fmt.subs.spu.palette[1], p_sys->palette, 16 * sizeof( uint32_t ) );
561 current_tk->p_es = es_out_Add( p_demux->out, &fmt );
562 msg_Dbg( p_demux, "new vobsub track detected" );
566 msg_Warn( p_demux, "reading new track failed" );
569 else if( !strncmp( line, "timestamp:", 10 ) )
572 * timestamp: [sign]hh:mm:ss:mss, filepos: loc
573 * loc is the hex location of the spu in the .sub file
575 int h, m, s, ms, count, loc = 0;
577 int64_t i_start, i_location = 0;
579 vobsub_track_t *current_tk = &p_sys->track[p_sys->i_tracks - 1];
581 if( sscanf( line, "timestamp: %d%n:%d:%d:%d, filepos: %x",
582 &h, &count, &m, &s, &ms, &loc ) >= 5 )
584 subtitle_t *current_sub;
586 if( line[count-3] == '-' )
591 i_start = (int64_t) ( h * 3600*1000 +
597 current_tk->i_subtitles++;
598 current_tk->p_subtitles = (subtitle_t*)realloc( current_tk->p_subtitles, sizeof( subtitle_t ) * (current_tk->i_subtitles + 1 ) );
599 current_sub = ¤t_tk->p_subtitles[current_tk->i_subtitles - 1];
601 current_sub->i_start = (int64_t) i_start * i_sign;
602 current_sub->i_start += current_tk->i_delay;
603 current_sub->i_vobsub_location = i_location;
606 else if( !strncasecmp( line, "delay:", 6 ) )
609 * delay: [sign]hh:mm:ss:mss
611 int h, m, s, ms, count = 0;
615 vobsub_track_t *current_tk = &p_sys->track[p_sys->i_tracks - 1];
617 if( sscanf( line, "%*celay: %d%n:%d:%d:%d",
618 &h, &count, &m, &s, &ms ) >= 4 )
620 if( line[count-3] == '-' )
625 i_gap = (int64_t) ( h * 3600*1000 +
630 current_tk->i_delay = current_tk->i_delay + (i_gap * i_sign);
631 msg_Dbg( p_demux, "sign: %+d gap: %+lld global delay: %+lld",
632 i_sign, (long long)i_gap,
633 (long long)current_tk->i_delay );
640 static int DemuxVobSub( demux_t *p_demux, block_t *p_bk )
642 demux_sys_t *p_sys = p_demux->p_sys;
643 uint8_t *p = p_bk->p_buffer;
644 uint8_t *p_end = &p_bk->p_buffer[p_bk->i_buffer];
649 int i_size = ps_pkt_size( p, p_end - p );
658 if( p[0] != 0 || p[1] != 0 || p[2] != 0x01 )
660 msg_Warn( p_demux, "invalid PES" );
666 /* msg_Dbg( p_demux, "we don't need these ps packets (id=0x1%2.2x)", p[3] ); */
672 p_pkt = block_New( p_demux, i_size );
673 memcpy( p_pkt->p_buffer, p, i_size);
676 i_id = ps_pkt_id( p_pkt );
677 if( (i_id&0xffe0) != 0xbd20 ||
678 ps_pkt_parse_pes( p_pkt, 1 ) )
680 block_Release( p_pkt );
684 /* msg_Dbg( p_demux, "SPU track %d size %d", i_spu, i_size ); */
686 for( i = 0; i < p_sys->i_tracks; i++ )
688 #define tk p_sys->track[i]
689 p_pkt->i_dts = p_pkt->i_pts = p_bk->i_pts;
692 if( tk.p_es && tk.i_track_id == i_spu )
694 es_out_Send( p_demux->out, tk.p_es, p_pkt );
695 p_bk->i_pts = 0; /*only first packet has a pts */
698 else if( i == p_sys->i_tracks - 1 )
700 block_Release( p_pkt );