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 <vlc_common.h>
36 #include <vlc_plugin.h>
37 #include <vlc_demux.h>
42 /*****************************************************************************
44 *****************************************************************************/
45 static int Open ( vlc_object_t
*p_this
);
46 static void Close( vlc_object_t
*p_this
);
49 set_description( N_("Vobsub subtitles parser") )
50 set_category( CAT_INPUT
)
51 set_subcategory( SUBCAT_INPUT_DEMUX
)
52 set_capability( "demux", 1 )
54 set_callbacks( Open
, Close
)
56 add_shortcut( "vobsub", "subtitle" )
59 /*****************************************************************************
61 *****************************************************************************/
73 int i_vobsub_location
;
82 int i_current_subtitle
;
84 subtitle_t
*p_subtitles
;
91 int64_t i_next_demux_date
;
95 stream_t
*p_vobsub_stream
;
99 vobsub_track_t
*track
;
101 int i_original_frame_width
;
102 int i_original_frame_height
;
104 uint32_t palette
[16];
108 static int Demux( demux_t
* );
109 static int Control( demux_t
*, int, va_list );
111 static int TextLoad( text_t
*, stream_t
*s
);
112 static void TextUnload( text_t
* );
113 static int ParseVobSubIDX( demux_t
* );
114 static int DemuxVobSub( demux_t
*, block_t
*);
116 /*****************************************************************************
118 *****************************************************************************/
119 static int Open ( vlc_object_t
*p_this
)
121 demux_t
*p_demux
= (demux_t
*)p_this
;
123 char *psz_vobname
, *s
;
126 if( ( s
= stream_ReadLine( p_demux
->s
) ) != NULL
)
128 if( !strcasestr( s
, "# VobSub index file" ) )
130 msg_Dbg( p_demux
, "this doesn't seem to be a vobsub file" );
132 if( stream_Seek( p_demux
->s
, 0 ) )
134 msg_Warn( p_demux
, "failed to rewind" );
142 msg_Dbg( p_demux
, "could not read vobsub IDX file" );
147 p_demux
->p_sys
= p_sys
= malloc( sizeof( demux_sys_t
) );
148 if( unlikely( !p_sys
) )
152 p_sys
->p_vobsub_stream
= NULL
;
154 p_sys
->track
= malloc( sizeof( vobsub_track_t
) );
155 if( unlikely( !p_sys
->track
) )
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
);
166 ParseVobSubIDX( p_demux
);
169 TextUnload( &p_sys
->txt
);
171 /* Find the total length of the vobsubs */
172 if( p_sys
->i_tracks
> 0 )
174 for( int 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 if( asprintf( &psz_vobname
, "%s://%s", p_demux
->psz_access
, p_demux
->psz_location
) == -1 )
187 i_len
= strlen( psz_vobname
);
188 if( i_len
>= 4 ) memcpy( psz_vobname
+ i_len
- 4, ".sub", 4 );
191 p_sys
->p_vobsub_stream
= stream_UrlNew( p_demux
, psz_vobname
);
192 if( p_sys
->p_vobsub_stream
== NULL
)
194 msg_Err( p_demux
, "couldn't open .sub Vobsub file: %s",
201 p_demux
->pf_demux
= Demux
;
202 p_demux
->pf_control
= Control
;
207 /* Clean all subs from all tracks */
208 for( int i
= 0; i
< p_sys
->i_tracks
; i
++ )
209 free( p_sys
->track
[i
].p_subtitles
);
210 free( p_sys
->track
);
216 /*****************************************************************************
217 * Close: Close subtitle demux
218 *****************************************************************************/
219 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 if( p_sys
->p_vobsub_stream
)
225 stream_Delete( p_sys
->p_vobsub_stream
);
227 /* Clean all subs from all tracks */
228 for( int i
= 0; i
< p_sys
->i_tracks
; i
++ )
229 free( p_sys
->track
[i
].p_subtitles
);
230 free( p_sys
->track
);
234 /*****************************************************************************
236 *****************************************************************************/
237 static int Control( demux_t
*p_demux
, int i_query
, va_list args
)
239 demux_sys_t
*p_sys
= p_demux
->p_sys
;
246 case DEMUX_GET_LENGTH
:
247 pi64
= (int64_t*)va_arg( args
, int64_t * );
248 *pi64
= (int64_t) p_sys
->i_length
;
252 pi64
= (int64_t*)va_arg( args
, int64_t * );
253 for( i
= 0; i
< p_sys
->i_tracks
; i
++ )
256 /* Check the ES is selected */
257 es_out_Control( p_demux
->out
, ES_OUT_GET_ES_STATE
,
258 p_sys
->track
[i
].p_es
, &b_selected
);
259 if( b_selected
) break;
261 if( i
< p_sys
->i_tracks
&& p_sys
->track
[i
].i_current_subtitle
< p_sys
->track
[i
].i_subtitles
)
263 *pi64
= p_sys
->track
[i
].p_subtitles
[p_sys
->track
[i
].i_current_subtitle
].i_start
;
269 i64
= (int64_t)va_arg( args
, int64_t );
270 for( i
= 0; i
< p_sys
->i_tracks
; i
++ )
272 p_sys
->track
[i
].i_current_subtitle
= 0;
273 while( p_sys
->track
[i
].i_current_subtitle
< p_sys
->track
[i
].i_subtitles
&&
274 p_sys
->track
[i
].p_subtitles
[p_sys
->track
[i
].i_current_subtitle
].i_start
< i64
)
276 p_sys
->track
[i
].i_current_subtitle
++;
279 if( p_sys
->track
[i
].i_current_subtitle
>= p_sys
->track
[i
].i_subtitles
)
284 case DEMUX_GET_POSITION
:
285 pf
= (double*)va_arg( args
, double * );
286 for( i
= 0; i
< p_sys
->i_tracks
; i
++ )
289 /* Check the ES is selected */
290 es_out_Control( p_demux
->out
, ES_OUT_GET_ES_STATE
,
291 p_sys
->track
[i
].p_es
, &b_selected
);
292 if( b_selected
) break;
294 if( p_sys
->track
[i
].i_current_subtitle
>= p_sys
->track
[i
].i_subtitles
)
298 else if( p_sys
->track
[i
].i_subtitles
> 0 )
300 *pf
= (double)p_sys
->track
[i
].p_subtitles
[p_sys
->track
[i
].i_current_subtitle
].i_start
/
301 (double)p_sys
->i_length
;
309 case DEMUX_SET_POSITION
:
310 f
= (double)va_arg( args
, double );
311 i64
= (int64_t) f
* p_sys
->i_length
;
313 for( i
= 0; i
< p_sys
->i_tracks
; i
++ )
315 p_sys
->track
[i
].i_current_subtitle
= 0;
316 while( p_sys
->track
[i
].i_current_subtitle
< p_sys
->track
[i
].i_subtitles
&&
317 p_sys
->track
[i
].p_subtitles
[p_sys
->track
[i
].i_current_subtitle
].i_start
< i64
)
319 p_sys
->track
[i
].i_current_subtitle
++;
321 if( p_sys
->track
[i
].i_current_subtitle
>= p_sys
->track
[i
].i_subtitles
)
326 case DEMUX_SET_NEXT_DEMUX_TIME
:
327 p_sys
->i_next_demux_date
= (int64_t)va_arg( args
, int64_t );
330 case DEMUX_GET_PTS_DELAY
:
333 case DEMUX_GET_TITLE_INFO
:
334 case DEMUX_HAS_UNSUPPORTED_META
:
335 case DEMUX_GET_ATTACHMENTS
:
336 case DEMUX_CAN_RECORD
:
340 msg_Warn( p_demux
, "unknown query in subtitle control" );
345 /*****************************************************************************
346 * Demux: Send subtitle to decoder
347 *****************************************************************************/
348 static int Demux( demux_t
*p_demux
)
350 demux_sys_t
*p_sys
= p_demux
->p_sys
;
354 for( int i
= 0; i
< p_sys
->i_tracks
; i
++ )
356 #define tk p_sys->track[i]
357 if( tk
.i_current_subtitle
>= tk
.i_subtitles
)
360 i_maxdate
= p_sys
->i_next_demux_date
;
361 if( i_maxdate
<= 0 && tk
.i_current_subtitle
< tk
.i_subtitles
)
363 /* Should not happen */
364 i_maxdate
= tk
.p_subtitles
[tk
.i_current_subtitle
].i_start
+ 1;
367 while( tk
.i_current_subtitle
< tk
.i_subtitles
&&
368 tk
.p_subtitles
[tk
.i_current_subtitle
].i_start
< i_maxdate
)
370 int i_pos
= tk
.p_subtitles
[tk
.i_current_subtitle
].i_vobsub_location
;
374 /* first compute SPU size */
375 if( tk
.i_current_subtitle
+ 1 < tk
.i_subtitles
)
377 i_size
= tk
.p_subtitles
[tk
.i_current_subtitle
+1].i_vobsub_location
- i_pos
;
379 if( i_size
<= 0 ) i_size
= 65535; /* Invalid or EOF */
381 /* Seek at the right place */
382 if( stream_Seek( p_sys
->p_vobsub_stream
, i_pos
) )
385 "cannot seek in the VobSub to the correct time %d", i_pos
);
386 tk
.i_current_subtitle
++;
390 /* allocate a packet */
391 if( ( p_block
= block_New( p_demux
, i_size
) ) == NULL
)
393 tk
.i_current_subtitle
++;
398 i_read
= stream_Read( p_sys
->p_vobsub_stream
, p_block
->p_buffer
, i_size
);
401 block_Release( p_block
);
402 tk
.i_current_subtitle
++;
405 p_block
->i_buffer
= i_read
;
408 p_block
->i_pts
= VLC_TS_0
+ tk
.p_subtitles
[tk
.i_current_subtitle
].i_start
;
410 /* demux this block */
411 DemuxVobSub( p_demux
, p_block
);
413 tk
.i_current_subtitle
++;
419 p_sys
->i_next_demux_date
= 0;
424 static int TextLoad( text_t
*txt
, stream_t
*s
)
429 /* load the complete file */
432 char *psz
= stream_ReadLine( s
);
435 if( psz
== NULL
|| (n
>= INT_MAX
/sizeof(char *)) )
438 ppsz_new
= realloc( lines
, (n
+ 1) * sizeof (char *) );
439 if( ppsz_new
== NULL
)
448 txt
->i_line_count
= n
;
455 static void TextUnload( text_t
*txt
)
457 for( int i
= 0; i
< txt
->i_line_count
; i
++ )
458 free( txt
->line
[i
] );
462 txt
->i_line_count
= 0;
465 static char *TextGetLine( text_t
*txt
)
467 if( txt
->i_line
>= txt
->i_line_count
)
470 return txt
->line
[txt
->i_line
++];
473 static int ParseVobSubIDX( demux_t
*p_demux
)
475 demux_sys_t
*p_sys
= p_demux
->p_sys
;
476 text_t
*txt
= &p_sys
->txt
;
478 vobsub_track_t
*current_tk
= NULL
;
482 if( ( line
= TextGetLine( txt
) ) == NULL
)
484 return( VLC_EGENERIC
);
487 if( *line
== 0 || *line
== '\r' || *line
== '\n' || *line
== '#' )
491 else if( !strncmp( "size:", line
, 5 ) )
493 /* Store the original size of the video */
494 if( vobsub_size_parse( line
, &p_sys
->i_original_frame_width
,
495 &p_sys
->i_original_frame_height
) == VLC_SUCCESS
)
497 msg_Dbg( p_demux
, "original frame size: %dx%d", p_sys
->i_original_frame_width
, p_sys
->i_original_frame_height
);
501 msg_Warn( p_demux
, "reading original frame size failed" );
504 else if( !strncmp( "palette:", line
, 8 ) )
506 if( vobsub_palette_parse( line
, p_sys
->palette
) == VLC_SUCCESS
)
508 p_sys
->b_palette
= true;
509 msg_Dbg( p_demux
, "vobsub palette read" );
513 msg_Warn( p_demux
, "reading original palette failed" );
516 else if( !strncmp( "id:", line
, 3 ) )
518 char language
[33]; /* Usually 2 or 3 letters, sometimes more.
519 Spec (or lack of) doesn't define any limit */
523 /* Lets start a new track */
524 if( sscanf( line
, "id: %32[^ ,], index: %d",
525 language
, &i_track_id
) == 2 )
528 p_sys
->track
= xrealloc( p_sys
->track
,
529 sizeof( vobsub_track_t
) * (p_sys
->i_tracks
+ 1 ) );
532 current_tk
= &p_sys
->track
[p_sys
->i_tracks
- 1];
533 memset( current_tk
, 0, sizeof( vobsub_track_t
) );
534 current_tk
->i_current_subtitle
= 0;
535 current_tk
->i_subtitles
= 0;
536 current_tk
->p_subtitles
= xmalloc( sizeof( subtitle_t
) );
537 current_tk
->i_track_id
= i_track_id
;
538 current_tk
->i_delay
= (int64_t)0;
540 es_format_Init( &fmt
, SPU_ES
, VLC_CODEC_SPU
);
541 fmt
.subs
.spu
.i_original_frame_width
= p_sys
->i_original_frame_width
;
542 fmt
.subs
.spu
.i_original_frame_height
= p_sys
->i_original_frame_height
;
543 fmt
.psz_language
= language
;
544 if( p_sys
->b_palette
)
546 fmt
.subs
.spu
.palette
[0] = 0xBeef;
547 memcpy( &fmt
.subs
.spu
.palette
[1], p_sys
->palette
, 16 * sizeof( uint32_t ) );
550 current_tk
->p_es
= es_out_Add( p_demux
->out
, &fmt
);
551 msg_Dbg( p_demux
, "new vobsub track detected" );
555 msg_Warn( p_demux
, "reading new track failed" );
558 else if( !strncmp( line
, "timestamp:", 10 ) )
561 * timestamp: [sign]hh:mm:ss:mss, filepos: loc
562 * loc is the hex location of the spu in the .sub file
564 int h
, m
, s
, ms
, count
, loc
= 0;
566 int64_t i_start
, i_location
= 0;
568 if( p_sys
->i_tracks
> 0 &&
569 sscanf( line
, "timestamp: %d%n:%d:%d:%d, filepos: %x",
570 &h
, &count
, &m
, &s
, &ms
, &loc
) >= 5 )
572 vobsub_track_t
*current_tk
= &p_sys
->track
[p_sys
->i_tracks
- 1];
573 subtitle_t
*current_sub
;
575 if( line
[count
-3] == '-' )
580 i_start
= (int64_t) ( h
* 3600*1000 +
586 current_tk
->i_subtitles
++;
587 current_tk
->p_subtitles
=
588 xrealloc( current_tk
->p_subtitles
,
589 sizeof( subtitle_t
) * (current_tk
->i_subtitles
+ 1 ) );
590 current_sub
= ¤t_tk
->p_subtitles
[current_tk
->i_subtitles
- 1];
592 current_sub
->i_start
= i_start
* i_sign
;
593 current_sub
->i_start
+= current_tk
->i_delay
;
594 current_sub
->i_vobsub_location
= i_location
;
598 msg_Warn( p_demux
, "reading timestamp failed" );
601 else if( !strncasecmp( line
, "delay:", 6 ) )
604 * delay: [sign]hh:mm:ss:mss
606 int h
, m
, s
, ms
, count
= 0;
610 if( p_sys
->i_tracks
> 0 &&
611 sscanf( line
, "%*celay: %d%n:%d:%d:%d",
612 &h
, &count
, &m
, &s
, &ms
) >= 4 )
614 vobsub_track_t
*current_tk
= &p_sys
->track
[p_sys
->i_tracks
- 1];
615 if( line
[count
-3] == '-' )
620 i_gap
= (int64_t) ( h
* 3600*1000 +
625 current_tk
->i_delay
= current_tk
->i_delay
+ (i_gap
* i_sign
);
626 msg_Dbg( p_demux
, "sign: %+d gap: %+"PRId64
" global delay: %+"PRId64
"",
627 i_sign
, i_gap
, current_tk
->i_delay
);
631 msg_Warn( p_demux
, "reading delay failed" );
638 static int DemuxVobSub( demux_t
*p_demux
, block_t
*p_bk
)
640 demux_sys_t
*p_sys
= p_demux
->p_sys
;
641 uint8_t *p
= p_bk
->p_buffer
;
642 uint8_t *p_end
= &p_bk
->p_buffer
[p_bk
->i_buffer
];
645 while( p
+ 6 < p_end
)
647 int i_size
= ps_pkt_size( p
, p_end
- p
);
655 if( i_size
> p_end
- p
)
657 msg_Warn( p_demux
, "broken PES size" );
661 if( p
[0] != 0 || p
[1] != 0 || p
[2] != 0x01 )
663 msg_Warn( p_demux
, "invalid PES" );
669 /* msg_Dbg( p_demux, "we don't need these ps packets (id=0x1%2.2x)", p[3] ); */
675 p_pkt
= block_New( p_demux
, i_size
);
676 memcpy( p_pkt
->p_buffer
, p
, i_size
);
679 i_id
= ps_pkt_id( p_pkt
);
680 if( (i_id
&0xffe0) != 0xbd20 ||
681 ps_pkt_parse_pes( p_pkt
, 1 ) )
683 block_Release( p_pkt
);
687 /* msg_Dbg( p_demux, "SPU track %d size %d", i_spu, i_size ); */
689 for( i
= 0; i
< p_sys
->i_tracks
; i
++ )
691 vobsub_track_t
*p_tk
= &p_sys
->track
[i
];
693 p_pkt
->i_dts
= p_pkt
->i_pts
= p_bk
->i_pts
;
696 if( p_tk
->p_es
&& p_tk
->i_track_id
== i_spu
)
698 es_out_Send( p_demux
->out
, p_tk
->p_es
, p_pkt
);
699 p_bk
->i_pts
= VLC_TS_INVALID
; /*only first packet has a pts */
703 if( i
>= p_sys
->i_tracks
)
705 block_Release( p_pkt
);