[demux/avi] Enable dirac support (Set PTS on first output block)
[vlc/davidf-public.git] / modules / demux / vobsub.c
blobfe9cf2782d9c25e8b303dbff8ca857728472e640
1 /*****************************************************************************
2 * subtitle.c: Demux vobsub files.
3 *****************************************************************************
4 * Copyright (C) 1999-2004 the VideoLAN team
5 * $Id$
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 /*****************************************************************************
26 * Preamble
27 *****************************************************************************/
28 #ifdef HAVE_CONFIG_H
29 # include "config.h"
30 #endif
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
35 #include <errno.h>
36 #include <sys/types.h>
38 #include <vlc_demux.h>
39 #include <vlc_charset.h>
41 #include "ps.h"
43 #define MAX_LINE 8192
45 /*****************************************************************************
46 * Module descriptor
47 *****************************************************************************/
48 static int Open ( vlc_object_t *p_this );
49 static void Close( vlc_object_t *p_this );
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 );
57 set_callbacks( Open, Close );
59 add_shortcut( "vobsub" );
60 add_shortcut( "subtitle" );
61 vlc_module_end();
63 /*****************************************************************************
64 * Prototypes:
65 *****************************************************************************/
67 typedef struct
69 int i_line_count;
70 int i_line;
71 char **line;
72 } text_t;
73 static int TextLoad( text_t *, stream_t *s );
74 static void TextUnload( text_t * );
76 typedef struct
78 int64_t i_start;
79 int i_vobsub_location;
80 } subtitle_t;
82 typedef struct
84 es_format_t fmt;
85 es_out_id_t *p_es;
86 int i_track_id;
88 int i_current_subtitle;
89 int i_subtitles;
90 subtitle_t *p_subtitles;
92 int64_t i_delay;
93 } vobsub_track_t;
95 struct demux_sys_t
97 int64_t i_next_demux_date;
98 int64_t i_length;
100 text_t txt;
101 stream_t *p_vobsub_stream;
103 /* all tracks */
104 int i_tracks;
105 vobsub_track_t *track;
107 int i_original_frame_width;
108 int i_original_frame_height;
109 bool b_palette;
110 uint32_t palette[16];
113 static int Demux( demux_t * );
114 static int Control( demux_t *, int, va_list );
116 static int ParseVobSubIDX( demux_t * );
117 static int DemuxVobSub( demux_t *, block_t *);
119 /*****************************************************************************
120 * Module initializer
121 *****************************************************************************/
122 static int Open ( vlc_object_t *p_this )
124 demux_t *p_demux = (demux_t*)p_this;
125 demux_sys_t *p_sys;
126 char *psz_vobname, *s;
127 int i_len;
129 if( ( s = stream_ReadLine( p_demux->s ) ) != NULL )
131 if( !strcasestr( s, "# VobSub index file" ) )
133 msg_Dbg( p_demux, "this doesn't seem to be a vobsub file" );
134 free( s );
135 if( stream_Seek( p_demux->s, 0 ) )
137 msg_Warn( p_demux, "failed to rewind" );
139 return VLC_EGENERIC;
141 free( s );
144 else
146 msg_Dbg( p_demux, "could not read vobsub IDX file" );
147 return VLC_EGENERIC;
150 p_demux->pf_demux = Demux;
151 p_demux->pf_control = Control;
152 p_demux->p_sys = p_sys = malloc( sizeof( demux_sys_t ) );
153 p_sys->i_length = 0;
154 p_sys->p_vobsub_stream = NULL;
155 p_sys->i_tracks = 0;
156 p_sys->track = (vobsub_track_t *)malloc( sizeof( vobsub_track_t ) );
157 p_sys->i_original_frame_width = -1;
158 p_sys->i_original_frame_height = -1;
159 p_sys->b_palette = false;
160 memset( p_sys->palette, 0, 16 * sizeof( uint32_t ) );
162 /* Load the whole file */
163 TextLoad( &p_sys->txt, p_demux->s );
165 /* Parse it */
166 ParseVobSubIDX( p_demux );
168 /* Unload */
169 TextUnload( &p_sys->txt );
171 /* Find the total length of the vobsubs */
172 if( p_sys->i_tracks > 0 )
174 int i;
175 for( i = 0; i < p_sys->i_tracks; i++ )
177 if( p_sys->track[i].i_subtitles > 1 )
179 if( p_sys->track[i].p_subtitles[p_sys->track[i].i_subtitles-1].i_start > p_sys->i_length )
180 p_sys->i_length = (int64_t) p_sys->track[i].p_subtitles[p_sys->track[i].i_subtitles-1].i_start + ( 1 *1000 *1000 );
185 if( asprintf( &psz_vobname, "%s://%s", p_demux->psz_access, p_demux->psz_path ) == -1 )
187 free( p_sys );
188 return VLC_EGENERIC;
190 i_len = strlen( psz_vobname );
191 if( i_len >= 4 ) memcpy( psz_vobname + i_len - 4, ".sub", 4 );
193 /* open file */
194 p_sys->p_vobsub_stream = stream_UrlNew( p_demux, psz_vobname );
195 if( p_sys->p_vobsub_stream == NULL )
197 msg_Err( p_demux, "couldn't open .sub Vobsub file: %s",
198 psz_vobname );
199 free( psz_vobname );
200 free( p_sys );
201 return VLC_EGENERIC;
203 free( psz_vobname );
205 return VLC_SUCCESS;
208 /*****************************************************************************
209 * Close: Close subtitle demux
210 *****************************************************************************/
211 static void Close( vlc_object_t *p_this )
213 int i;
214 demux_t *p_demux = (demux_t*)p_this;
215 demux_sys_t *p_sys = p_demux->p_sys;
217 /* Clean all subs from all tracks */
218 for( i = 0; i < p_sys->i_tracks; i++ )
219 free( p_sys->track[i].p_subtitles );
221 free( p_sys->track );
223 if( p_sys->p_vobsub_stream )
224 stream_Delete( p_sys->p_vobsub_stream );
226 free( p_sys );
229 /*****************************************************************************
230 * Control:
231 *****************************************************************************/
232 static int Control( demux_t *p_demux, int i_query, va_list args )
234 demux_sys_t *p_sys = p_demux->p_sys;
235 int64_t *pi64, i64;
236 int i;
237 double *pf, f;
239 switch( i_query )
241 case DEMUX_GET_LENGTH:
242 pi64 = (int64_t*)va_arg( args, int64_t * );
243 *pi64 = (int64_t) p_sys->i_length;
244 return VLC_SUCCESS;
246 case DEMUX_GET_TIME:
247 pi64 = (int64_t*)va_arg( args, int64_t * );
248 for( i = 0; i < p_sys->i_tracks; i++ )
250 bool b_selected;
251 /* Check the ES is selected */
252 es_out_Control( p_demux->out, ES_OUT_GET_ES_STATE,
253 p_sys->track[i].p_es, &b_selected );
254 if( b_selected ) break;
256 if( i < p_sys->i_tracks && p_sys->track[i].i_current_subtitle < p_sys->track[i].i_subtitles )
258 *pi64 = p_sys->track[i].p_subtitles[p_sys->track[i].i_current_subtitle].i_start;
259 return VLC_SUCCESS;
261 return VLC_EGENERIC;
263 case DEMUX_SET_TIME:
264 i64 = (int64_t)va_arg( args, int64_t );
265 for( i = 0; i < p_sys->i_tracks; i++ )
267 p_sys->track[i].i_current_subtitle = 0;
268 while( p_sys->track[i].i_current_subtitle < p_sys->track[i].i_subtitles &&
269 p_sys->track[i].p_subtitles[p_sys->track[i].i_current_subtitle].i_start < i64 )
271 p_sys->track[i].i_current_subtitle++;
274 if( p_sys->track[i].i_current_subtitle >= p_sys->track[i].i_subtitles )
275 return VLC_EGENERIC;
277 return VLC_SUCCESS;
279 case DEMUX_GET_POSITION:
280 pf = (double*)va_arg( args, double * );
281 for( i = 0; i < p_sys->i_tracks; i++ )
283 bool b_selected;
284 /* Check the ES is selected */
285 es_out_Control( p_demux->out, ES_OUT_GET_ES_STATE,
286 p_sys->track[i].p_es, &b_selected );
287 if( b_selected ) break;
289 if( p_sys->track[i].i_current_subtitle >= p_sys->track[i].i_subtitles )
291 *pf = 1.0;
293 else if( p_sys->track[i].i_subtitles > 0 )
295 *pf = (double)p_sys->track[i].p_subtitles[p_sys->track[i].i_current_subtitle].i_start /
296 (double)p_sys->i_length;
298 else
300 *pf = 0.0;
302 return VLC_SUCCESS;
304 case DEMUX_SET_POSITION:
305 f = (double)va_arg( args, double );
306 i64 = (int64_t) f * p_sys->i_length;
308 for( i = 0; i < p_sys->i_tracks; i++ )
310 p_sys->track[i].i_current_subtitle = 0;
311 while( p_sys->track[i].i_current_subtitle < p_sys->track[i].i_subtitles &&
312 p_sys->track[i].p_subtitles[p_sys->track[i].i_current_subtitle].i_start < i64 )
314 p_sys->track[i].i_current_subtitle++;
316 if( p_sys->track[i].i_current_subtitle >= p_sys->track[i].i_subtitles )
317 return VLC_EGENERIC;
319 return VLC_SUCCESS;
321 case DEMUX_SET_NEXT_DEMUX_TIME:
322 p_sys->i_next_demux_date = (int64_t)va_arg( args, int64_t );
323 return VLC_SUCCESS;
325 case DEMUX_GET_FPS:
326 case DEMUX_GET_META:
327 case DEMUX_GET_TITLE_INFO:
328 case DEMUX_HAS_UNSUPPORTED_META:
329 case DEMUX_GET_ATTACHMENTS:
330 case DEMUX_CAN_RECORD:
331 return VLC_EGENERIC;
333 default:
334 msg_Warn( p_demux, "unknown query in subtitle control" );
335 return VLC_EGENERIC;
339 /*****************************************************************************
340 * Demux: Send subtitle to decoder
341 *****************************************************************************/
342 static int Demux( demux_t *p_demux )
344 demux_sys_t *p_sys = p_demux->p_sys;
345 int64_t i_maxdate;
346 int i, i_read;
348 for( i = 0; i < p_sys->i_tracks; i++ )
350 #define tk p_sys->track[i]
351 if( tk.i_current_subtitle >= tk.i_subtitles )
352 continue;
354 i_maxdate = p_sys->i_next_demux_date;
355 if( i_maxdate <= 0 && tk.i_current_subtitle < tk.i_subtitles )
357 /* Should not happen */
358 i_maxdate = tk.p_subtitles[tk.i_current_subtitle].i_start + 1;
361 while( tk.i_current_subtitle < tk.i_subtitles &&
362 tk.p_subtitles[tk.i_current_subtitle].i_start < i_maxdate )
364 int i_pos = tk.p_subtitles[tk.i_current_subtitle].i_vobsub_location;
365 block_t *p_block;
366 int i_size = 0;
368 /* first compute SPU size */
369 if( tk.i_current_subtitle + 1 < tk.i_subtitles )
371 i_size = tk.p_subtitles[tk.i_current_subtitle+1].i_vobsub_location - i_pos;
373 if( i_size <= 0 ) i_size = 65535; /* Invalid or EOF */
375 /* Seek at the right place */
376 if( stream_Seek( p_sys->p_vobsub_stream, i_pos ) )
378 msg_Warn( p_demux,
379 "cannot seek in the VobSub to the correct time %d", i_pos );
380 tk.i_current_subtitle++;
381 continue;
384 /* allocate a packet */
385 if( ( p_block = block_New( p_demux, i_size ) ) == NULL )
387 tk.i_current_subtitle++;
388 continue;
391 /* read data */
392 i_read = stream_Read( p_sys->p_vobsub_stream, p_block->p_buffer, i_size );
393 if( i_read <= 6 )
395 block_Release( p_block );
396 tk.i_current_subtitle++;
397 continue;
399 p_block->i_buffer = i_read;
401 /* pts */
402 p_block->i_pts = tk.p_subtitles[tk.i_current_subtitle].i_start;
404 /* demux this block */
405 DemuxVobSub( p_demux, p_block );
407 tk.i_current_subtitle++;
409 #undef tk
412 /* */
413 p_sys->i_next_demux_date = 0;
415 return 1;
418 static int TextLoad( text_t *txt, stream_t *s )
420 int i_line_max;
422 /* init txt */
423 i_line_max = 500;
424 txt->i_line_count = 0;
425 txt->i_line = 0;
426 txt->line = calloc( i_line_max, sizeof( char * ) );
427 if( !txt->line )
428 return VLC_EGENERIC;
430 /* load the complete file */
431 for( ;; )
433 char *psz = stream_ReadLine( s );
435 if( psz == NULL )
436 break;
438 txt->line[txt->i_line_count++] = psz;
439 if( txt->i_line_count >= i_line_max )
441 char **ppsz_old = txt->line;
443 i_line_max += 100;
444 txt->line = realloc( txt->line, i_line_max * sizeof( char*) );
445 if( !txt->line )
447 free( ppsz_old );
448 break;
453 if( txt->i_line_count <= 0 )
455 free( txt->line );
456 return VLC_EGENERIC;
459 return VLC_SUCCESS;
461 static void TextUnload( text_t *txt )
463 int i;
465 for( i = 0; i < txt->i_line_count; i++ )
466 free( txt->line[i] );
468 free( txt->line );
469 txt->i_line = 0;
470 txt->i_line_count = 0;
473 static char *TextGetLine( text_t *txt )
475 if( txt->i_line >= txt->i_line_count )
476 return( NULL );
478 return txt->line[txt->i_line++];
481 static int ParseVobSubIDX( demux_t *p_demux )
483 demux_sys_t *p_sys = p_demux->p_sys;
484 text_t *txt = &p_sys->txt;
485 char *line;
486 vobsub_track_t *current_tk = NULL;
488 for( ;; )
490 if( ( line = TextGetLine( txt ) ) == NULL )
492 return( VLC_EGENERIC );
495 if( *line == 0 || *line == '\r' || *line == '\n' || *line == '#' )
497 continue;
499 else if( !strncmp( "size:", line, 5 ) )
501 /* Store the original size of the video */
502 if( sscanf( line, "size: %dx%d",
503 &p_sys->i_original_frame_width, &p_sys->i_original_frame_height ) == 2 )
505 msg_Dbg( p_demux, "original frame size: %dx%d", p_sys->i_original_frame_width, p_sys->i_original_frame_height );
507 else
509 msg_Warn( p_demux, "reading original frame size failed" );
512 else if( !strncmp( "palette:", line, 8 ) )
514 int i;
516 /* Store the palette of the subs */
517 if( sscanf( line, "palette: %x, %x, %x, %x, %x, %x, %x, %x, %x, %x, %x, %x, %x, %x, %x, %x",
518 &p_sys->palette[0], &p_sys->palette[1], &p_sys->palette[2], &p_sys->palette[3],
519 &p_sys->palette[4], &p_sys->palette[5], &p_sys->palette[6], &p_sys->palette[7],
520 &p_sys->palette[8], &p_sys->palette[9], &p_sys->palette[10], &p_sys->palette[11],
521 &p_sys->palette[12], &p_sys->palette[13], &p_sys->palette[14], &p_sys->palette[15] ) == 16 )
523 for( i = 0; i < 16; i++ )
525 uint8_t r = 0, g = 0, b = 0;
526 uint8_t y = 0, u = 0, v = 0;
527 r = (p_sys->palette[i] >> 16) & 0xff;
528 g = (p_sys->palette[i] >> 8) & 0xff;
529 b = (p_sys->palette[i] >> 0) & 0xff;
530 /* msg_Dbg( p_demux, "palette %d: R=%x, G=%x, B=%x", i, r, g, b ); */
531 y = (uint8_t) __MIN(abs(r * 2104 + g * 4130 + b * 802 + 4096 + 131072) >> 13, 235);
532 u = (uint8_t) __MIN(abs(r * -1214 + g * -2384 + b * 3598 + 4096 + 1048576) >> 13, 240);
533 v = (uint8_t) __MIN(abs(r * 3598 + g * -3013 + b * -585 + 4096 + 1048576) >> 13, 240);
534 p_sys->palette[i] = 0;
535 p_sys->palette[i] |= (y&0xff)<<16;
536 p_sys->palette[i] |= (u&0xff);
537 p_sys->palette[i] |= (v&0xff)<<8;
538 /* msg_Dbg( p_demux, "palette %d: y=%x, u=%x, v=%x", i, y, u, v ); */
541 p_sys->b_palette = true;
542 msg_Dbg( p_demux, "vobsub palette read" );
544 else
546 msg_Warn( p_demux, "reading original palette failed" );
549 else if( !strncmp( "id:", line, 3 ) )
551 char language[20];
552 int i_track_id;
553 es_format_t fmt;
555 /* Lets start a new track */
556 if( sscanf( line, "id: %2s, index: %d",
557 language, &i_track_id ) == 2 )
559 p_sys->i_tracks++;
560 p_sys->track = realloc( p_sys->track, sizeof( vobsub_track_t ) * (p_sys->i_tracks + 1 ) );
562 /* Init the track */
563 current_tk = &p_sys->track[p_sys->i_tracks - 1];
564 memset( current_tk, 0, sizeof( vobsub_track_t ) );
565 current_tk->i_current_subtitle = 0;
566 current_tk->i_subtitles = 0;
567 current_tk->p_subtitles = malloc( sizeof( subtitle_t ) );;
568 current_tk->i_track_id = i_track_id;
569 current_tk->i_delay = (int64_t)0;
571 es_format_Init( &fmt, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
572 fmt.subs.spu.i_original_frame_width = p_sys->i_original_frame_width;
573 fmt.subs.spu.i_original_frame_height = p_sys->i_original_frame_height;
574 fmt.psz_language = strdup( language );
575 if( p_sys->b_palette )
577 fmt.subs.spu.palette[0] = 0xBeef;
578 memcpy( &fmt.subs.spu.palette[1], p_sys->palette, 16 * sizeof( uint32_t ) );
581 current_tk->p_es = es_out_Add( p_demux->out, &fmt );
582 msg_Dbg( p_demux, "new vobsub track detected" );
584 else
586 msg_Warn( p_demux, "reading new track failed" );
589 else if( !strncmp( line, "timestamp:", 10 ) )
592 * timestamp: [sign]hh:mm:ss:mss, filepos: loc
593 * loc is the hex location of the spu in the .sub file
595 int h, m, s, ms, count, loc = 0;
596 int i_sign = 1;
597 int64_t i_start, i_location = 0;
599 if( p_sys->i_tracks > 0 &&
600 sscanf( line, "timestamp: %d%n:%d:%d:%d, filepos: %x",
601 &h, &count, &m, &s, &ms, &loc ) >= 5 )
603 vobsub_track_t *current_tk = &p_sys->track[p_sys->i_tracks - 1];
604 subtitle_t *current_sub;
606 if( line[count-3] == '-' )
608 i_sign = -1;
609 h = -h;
611 i_start = (int64_t) ( h * 3600*1000 +
612 m * 60*1000 +
613 s * 1000 +
614 ms ) * 1000;
615 i_location = loc;
617 current_tk->i_subtitles++;
618 current_tk->p_subtitles = realloc( current_tk->p_subtitles, sizeof( subtitle_t ) * (current_tk->i_subtitles + 1 ) );
619 current_sub = &current_tk->p_subtitles[current_tk->i_subtitles - 1];
621 current_sub->i_start = i_start * i_sign;
622 current_sub->i_start += current_tk->i_delay;
623 current_sub->i_vobsub_location = i_location;
625 else
627 msg_Warn( p_demux, "reading timestamp failed" );
630 else if( !strncasecmp( line, "delay:", 6 ) )
633 * delay: [sign]hh:mm:ss:mss
635 int h, m, s, ms, count = 0;
636 int i_sign = 1;
637 int64_t i_gap = 0;
639 if( p_sys->i_tracks > 0 &&
640 sscanf( line, "%*celay: %d%n:%d:%d:%d",
641 &h, &count, &m, &s, &ms ) >= 4 )
643 vobsub_track_t *current_tk = &p_sys->track[p_sys->i_tracks - 1];
644 if( line[count-3] == '-' )
646 i_sign = -1;
647 h = -h;
649 i_gap = (int64_t) ( h * 3600*1000 +
650 m * 60*1000 +
651 s * 1000 +
652 ms ) * 1000;
654 current_tk->i_delay = current_tk->i_delay + (i_gap * i_sign);
655 msg_Dbg( p_demux, "sign: %+d gap: %+lld global delay: %+lld",
656 i_sign, (long long)i_gap,
657 (long long)current_tk->i_delay );
659 else
661 msg_Warn( p_demux, "reading delay failed" );
665 return( 0 );
668 static int DemuxVobSub( demux_t *p_demux, block_t *p_bk )
670 demux_sys_t *p_sys = p_demux->p_sys;
671 uint8_t *p = p_bk->p_buffer;
672 uint8_t *p_end = &p_bk->p_buffer[p_bk->i_buffer];
673 int i;
675 while( p + 6 < p_end )
677 int i_size = ps_pkt_size( p, p_end - p );
678 block_t *p_pkt;
679 int i_id;
680 int i_spu;
682 if( i_size <= 0 )
683 break;
685 if( i_size > p_end - p )
687 msg_Warn( p_demux, "broken PES size" );
688 break;
691 if( p[0] != 0 || p[1] != 0 || p[2] != 0x01 )
693 msg_Warn( p_demux, "invalid PES" );
694 break;
697 if( p[3] != 0xbd )
699 /* msg_Dbg( p_demux, "we don't need these ps packets (id=0x1%2.2x)", p[3] ); */
700 p += i_size;
701 continue;
704 /* Create a block */
705 p_pkt = block_New( p_demux, i_size );
706 memcpy( p_pkt->p_buffer, p, i_size);
707 p += i_size;
709 i_id = ps_pkt_id( p_pkt );
710 if( (i_id&0xffe0) != 0xbd20 ||
711 ps_pkt_parse_pes( p_pkt, 1 ) )
713 block_Release( p_pkt );
714 continue;
716 i_spu = i_id&0x1f;
717 /* msg_Dbg( p_demux, "SPU track %d size %d", i_spu, i_size ); */
719 for( i = 0; i < p_sys->i_tracks; i++ )
721 vobsub_track_t *p_tk = &p_sys->track[i];
723 p_pkt->i_dts = p_pkt->i_pts = p_bk->i_pts;
724 p_pkt->i_length = 0;
726 if( p_tk->p_es && p_tk->i_track_id == i_spu )
728 es_out_Send( p_demux->out, p_tk->p_es, p_pkt );
729 p_bk->i_pts = 0; /*only first packet has a pts */
730 break;
733 if( i >= p_sys->i_tracks )
735 block_Release( p_pkt );
739 return VLC_SUCCESS;