1 /*****************************************************************************
2 * subtitle.c: Demux vobsub files.
3 *****************************************************************************
4 * Copyright (C) 1999-2004 VideoLAN
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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
23 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
31 #include <sys/types.h>
34 #include <vlc/input.h>
35 #include "vlc_video.h"
41 /*****************************************************************************
43 *****************************************************************************/
44 static int Open ( vlc_object_t *p_this );
45 static void Close( vlc_object_t *p_this );
48 set_description( _("Vobsub subtitles demux") );
49 set_capability( "demux2", 1 );
51 set_callbacks( Open, Close );
53 add_shortcut( "vobsub" );
54 add_shortcut( "subtitle" );
57 /*****************************************************************************
59 *****************************************************************************/
67 static int TextLoad( text_t *, stream_t *s );
68 static void TextUnload( text_t * );
73 int i_vobsub_location;
82 int i_current_subtitle;
84 subtitle_t *p_subtitles;
89 int64_t i_next_demux_date;
97 vobsub_track_t *track;
99 int i_original_frame_width;
100 int i_original_frame_height;
103 static int Demux( demux_t * );
104 static int Control( demux_t *, int, va_list );
106 static int ParseVobSubIDX( demux_t * );
107 static int DemuxVobSub( demux_t *, block_t *);
109 /*****************************************************************************
111 *****************************************************************************/
112 static int Open ( vlc_object_t *p_this )
114 demux_t *p_demux = (demux_t*)p_this;
119 p_demux->pf_demux = Demux;
120 p_demux->pf_control = Control;
121 p_demux->p_sys = p_sys = malloc( sizeof( demux_sys_t ) );
123 p_sys->p_vobsub_file = NULL;
125 p_sys->track = (vobsub_track_t*)malloc( sizeof( vobsub_track_t ) );
126 p_sys->i_original_frame_width = -1;
127 p_sys->i_original_frame_height = -1;
130 if( ( s = stream_ReadLine( p_demux->s ) ) != NULL )
132 if( !strcasestr( s, "# VobSub index file" ) )
134 msg_Err( p_demux, "this doesn't seem to be a vobsub file, bailing" );
141 if( stream_Seek( p_demux->s, 0 ) )
143 msg_Warn( p_demux, "failed to rewind" );
148 msg_Err( p_demux, "could not read vobsub IDX file" );
152 /* Load the whole file */
153 TextLoad( &p_sys->txt, p_demux->s );
156 ParseVobSubIDX( p_demux );
159 TextUnload( &p_sys->txt );
161 /* Find the total length of the vobsubs */
162 if( p_sys->i_tracks > 0 )
165 for( i = 0; i < p_sys->i_tracks; i++ )
167 if( p_sys->track[i].i_subtitles > 1 )
169 if( p_sys->track[i].p_subtitles[p_sys->track[i].i_subtitles-1].i_start > p_sys->i_length )
170 p_sys->i_length = (mtime_t) p_sys->track[i].p_subtitles[p_sys->track[i].i_subtitles-1].i_start + 1 * 1000 * 1000;
175 i_len = strlen( p_demux->psz_path );
176 psz_vobname = strdup( p_demux->psz_path );
178 strcpy( psz_vobname + i_len - 4, ".sub" );
181 if( !( p_sys->p_vobsub_file = fopen( psz_vobname, "rb" ) ) )
183 msg_Err( p_demux, "couldn't open .sub Vobsub file: %s",
191 /*****************************************************************************
192 * Close: Close subtitle demux
193 *****************************************************************************/
194 static void Close( vlc_object_t *p_this )
196 demux_t *p_demux = (demux_t*)p_this;
197 demux_sys_t *p_sys = p_demux->p_sys;
199 /* Clean all subs from all tracks
200 if( p_sys->subtitle )
201 free( p_sys->subtitle );
203 if( p_sys->p_vobsub_file )
204 fclose( p_sys->p_vobsub_file );
209 /*****************************************************************************
211 *****************************************************************************/
212 static int Control( demux_t *p_demux, int i_query, va_list args )
214 demux_sys_t *p_sys = p_demux->p_sys;
220 case DEMUX_GET_LENGTH:
221 pi64 = (int64_t*)va_arg( args, int64_t * );
222 *pi64 = p_sys->i_length;
226 pi64 = (int64_t*)va_arg( args, int64_t * );
227 /*if( p_sys->i_current_subtitle < p_sys->i_subtitles )
229 *pi64 = p_sys->subtitle[p_sys->i_current_subtitle].i_start;
235 i64 = (int64_t)va_arg( args, int64_t );
236 /*p_sys->i_current_subtitle = 0;
237 while( p_sys->i_current_subtitle < p_sys->i_subtitles &&
238 p_sys->subtitle[p_sys->i_current_subtitle].i_start < i64 )
240 p_sys->i_current_subtitle++;
243 if( p_sys->i_current_subtitle >= p_sys->i_subtitles )
244 return VLC_EGENERIC;*/
247 case DEMUX_GET_POSITION:
248 pf = (double*)va_arg( args, double * );
249 /*if( p_sys->i_current_subtitle >= p_sys->i_subtitles )
253 else if( p_sys->i_subtitles > 0 )
255 *pf = (double)p_sys->subtitle[p_sys->i_current_subtitle].i_start /
256 (double)p_sys->i_length;
264 case DEMUX_SET_POSITION:
265 f = (double)va_arg( args, double );
266 /*i64 = f * p_sys->i_length;
268 p_sys->i_current_subtitle = 0;
269 while( p_sys->i_current_subtitle < p_sys->i_subtitles &&
270 p_sys->subtitle[p_sys->i_current_subtitle].i_start < i64 )
272 p_sys->i_current_subtitle++;
274 if( p_sys->i_current_subtitle >= p_sys->i_subtitles )
275 return VLC_EGENERIC;*/
278 case DEMUX_SET_NEXT_DEMUX_TIME:
279 p_sys->i_next_demux_date = (int64_t)va_arg( args, int64_t );
284 case DEMUX_GET_TITLE_INFO:
288 msg_Err( p_demux, "unknown query in subtitle control" );
293 /*****************************************************************************
294 * Demux: Send subtitle to decoder
295 *****************************************************************************/
296 static int Demux( demux_t *p_demux )
298 demux_sys_t *p_sys = p_demux->p_sys;
302 for( i = 0; i < p_sys->i_tracks; i++ )
304 #define tk p_sys->track[i]
305 if( tk.i_current_subtitle >= tk.i_subtitles )
308 i_maxdate = p_sys->i_next_demux_date;
309 if( i_maxdate <= 0 && tk.i_current_subtitle < tk.i_subtitles )
311 /* Should not happen */
312 i_maxdate = tk.p_subtitles[tk.i_current_subtitle].i_start + 1;
315 while( tk.i_current_subtitle < tk.i_subtitles &&
316 tk.p_subtitles[tk.i_current_subtitle].i_start < i_maxdate )
318 int i_pos = tk.p_subtitles[tk.i_current_subtitle].i_vobsub_location;
322 /* first compute SPU size */
323 if( tk.i_current_subtitle + 1 < tk.i_subtitles )
325 i_size = tk.p_subtitles[tk.i_current_subtitle+1].i_vobsub_location - i_pos;
327 if( i_size <= 0 ) i_size = 65535; /* Invalid or EOF */
329 /* Seek at the right place */
330 if( fseek( p_sys->p_vobsub_file, i_pos, SEEK_SET ) )
333 "cannot seek at right vobsub location %d", i_pos );
334 tk.i_current_subtitle++;
338 /* allocate a packet */
339 if( ( p_block = block_New( p_demux, i_size ) ) == NULL )
341 tk.i_current_subtitle++;
346 p_block->i_buffer = fread( p_block->p_buffer, 1, i_size,
347 p_sys->p_vobsub_file );
348 if( p_block->i_buffer <= 6 )
350 block_Release( p_block );
351 tk.i_current_subtitle++;
356 p_block->i_pts = tk.p_subtitles[tk.i_current_subtitle].i_start;
358 /* demux this block */
359 DemuxVobSub( p_demux, p_block );
361 tk.i_current_subtitle++;
367 p_sys->i_next_demux_date = 0;
372 static int TextLoad( text_t *txt, stream_t *s )
378 txt->i_line_count = 0;
380 txt->line = calloc( i_line_max, sizeof( char * ) );
382 /* load the complete file */
385 char *psz = stream_ReadLine( s );
390 txt->line[txt->i_line_count++] = psz;
391 if( txt->i_line_count >= i_line_max )
394 txt->line = realloc( txt->line, i_line_max * sizeof( char*) );
398 if( txt->i_line_count <= 0 )
406 static void TextUnload( text_t *txt )
410 for( i = 0; i < txt->i_line_count; i++ )
412 free( txt->line[i] );
416 txt->i_line_count = 0;
419 static char *TextGetLine( text_t *txt )
421 if( txt->i_line >= txt->i_line_count )
424 return txt->line[txt->i_line++];
427 static int ParseVobSubIDX( demux_t *p_demux )
429 demux_sys_t *p_sys = p_demux->p_sys;
430 text_t *txt = &p_sys->txt;
432 vobsub_track_t *current_tk;
436 if( ( line = TextGetLine( txt ) ) == NULL )
438 return( VLC_EGENERIC );
441 if( *line == 0 || *line == '\r' || *line == '\n' || *line == '#' )
443 else if( !strncmp( "size:", line, 5 ) )
445 /* Store the original size of the video */
446 if( sscanf( line, "size: %dx%d",
447 &p_sys->i_original_frame_width, &p_sys->i_original_frame_height ) == 2 )
449 msg_Dbg( p_demux, "original frame size: %dx%d", p_sys->i_original_frame_width, p_sys->i_original_frame_height );
453 msg_Warn( p_demux, "reading original frame size failed" );
456 else if( !strncmp( "id:", line, 3 ) )
462 /* Lets start a new track */
463 if( sscanf( line, "id: %2s, index: %d",
464 language, &i_track_id ) == 2 )
467 p_sys->track = (vobsub_track_t*)realloc( p_sys->track, sizeof( vobsub_track_t ) * (p_sys->i_tracks + 1 ) );
470 current_tk = &p_sys->track[p_sys->i_tracks - 1];
471 memset( current_tk, 0, sizeof( vobsub_track_t ) );
472 current_tk->i_current_subtitle = 0;
473 current_tk->i_subtitles = 0;
474 current_tk->p_subtitles = (subtitle_t*)malloc( sizeof( subtitle_t ) );;
475 current_tk->i_track_id = i_track_id;
477 es_format_Init( &fmt, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
478 fmt.subs.spu.i_original_frame_width = p_sys->i_original_frame_width;
479 fmt.subs.spu.i_original_frame_height = p_sys->i_original_frame_height;
480 fmt.psz_language = strdup( language );
481 current_tk->p_es = es_out_Add( p_demux->out, &fmt );
483 msg_Dbg( p_demux, "new vobsub track detected" );
487 msg_Warn( p_demux, "reading new track failed" );
490 else if( !strncmp( line, "timestamp:", 10 ) )
493 * timestamp: hh:mm:ss:mss, filepos: loc
494 * loc is the hex location of the spu in the .sub file
497 unsigned int h, m, s, ms, loc;
498 int i_start, i_location = 0;
500 vobsub_track_t *current_tk = &p_sys->track[p_sys->i_tracks - 1];
502 if( sscanf( line, "timestamp: %d:%d:%d:%d, filepos: %x",
503 &h, &m, &s, &ms, &loc ) == 5 )
505 subtitle_t *current_sub;
507 i_start = ( (mtime_t)h * 3600*1000 +
508 (mtime_t)m * 60*1000 +
510 (mtime_t)ms ) * 1000;
513 current_tk->i_subtitles++;
514 current_tk->p_subtitles = (subtitle_t*)realloc( current_tk->p_subtitles, sizeof( subtitle_t ) * (current_tk->i_subtitles + 1 ) );
515 current_sub = ¤t_tk->p_subtitles[current_tk->i_subtitles - 1];
517 current_sub->i_start = i_start;
518 current_sub->i_vobsub_location = i_location;
525 static int DemuxVobSub( demux_t *p_demux, block_t *p_bk )
527 demux_sys_t *p_sys = p_demux->p_sys;
528 uint8_t *p = p_bk->p_buffer;
529 uint8_t *p_end = &p_bk->p_buffer[p_bk->i_buffer];
534 int i_size = ps_pkt_size( p, p_end - p );
543 if( p[0] != 0 || p[1] != 0 || p[2] != 0x01 )
545 msg_Warn( p_demux, "invalid PES" );
551 msg_Dbg( p_demux, "we don't need these ps packets (id=0x1%2.2x)", p[3] );
557 p_pkt = block_New( p_demux, i_size );
558 memcpy( p_pkt->p_buffer, p, i_size);
561 i_id = ps_pkt_id( p_pkt );
562 if( (i_id&0xffe0) != 0xbd20 ||
563 ps_pkt_parse_pes( p_pkt, 1 ) )
565 block_Release( p_pkt );
569 msg_Dbg( p_demux, "SPU track %d size %d", i_spu, i_size );
571 /* FIXME i_spu == determines which of the spu tracks we will show. */
572 for( i = 0; i < p_sys->i_tracks; i++ )
574 #define tk p_sys->track[i]
575 p_pkt->i_dts = p_pkt->i_pts = p_bk->i_pts;
578 if( tk.p_es && tk.i_track_id == i_spu )
580 es_out_Send( p_demux->out, tk.p_es, p_pkt );
581 p_bk->i_pts = 0; /*only first packet has a pts */
584 else if( i == p_sys->i_tracks - 1 )
586 block_Release( p_pkt );