1 /*****************************************************************************
2 * vobsub.c: Demux vobsub files.
3 *****************************************************************************
4 * Copyright (C) 1999-2004 VLC authors and 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 it
11 * under the terms of the GNU Lesser General Public License as published by
12 * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public License
21 * along with this program; if not, write to the Free Software Foundation,
22 * 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 #include "subtitle_helper.h"
44 /*****************************************************************************
46 *****************************************************************************/
47 static int Open ( vlc_object_t
*p_this
);
48 static void Close( vlc_object_t
*p_this
);
51 set_description( N_("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", "subtitle" )
61 /*****************************************************************************
63 *****************************************************************************/
75 int i_vobsub_location
;
83 int i_current_subtitle
;
85 subtitle_t
*p_subtitles
;
92 int64_t i_next_demux_date
;
96 stream_t
*p_vobsub_stream
;
100 vobsub_track_t
*track
;
102 int i_original_frame_width
;
103 int i_original_frame_height
;
105 uint32_t palette
[16];
109 static int Demux( demux_t
* );
110 static int Control( demux_t
*, int, va_list );
112 static int TextLoad( text_t
*, stream_t
*s
);
113 static void TextUnload( text_t
* );
114 static int ParseVobSubIDX( demux_t
* );
115 static int DemuxVobSub( demux_t
*, block_t
*);
117 /*****************************************************************************
119 *****************************************************************************/
120 static int Open ( vlc_object_t
*p_this
)
122 demux_t
*p_demux
= (demux_t
*)p_this
;
124 char *psz_vobname
, *s
;
126 uint64_t i_read_offset
= 0;
128 if( ( s
= peek_Readline( p_demux
->s
, &i_read_offset
) ) != NULL
)
130 if( !strcasestr( s
, "# VobSub index file" ) )
132 msg_Dbg( p_demux
, "this doesn't seem to be a vobsub file" );
140 msg_Dbg( p_demux
, "could not read vobsub IDX file" );
145 p_demux
->p_sys
= p_sys
= malloc( sizeof( demux_sys_t
) );
146 if( unlikely( !p_sys
) )
150 p_sys
->p_vobsub_stream
= NULL
;
152 p_sys
->track
= malloc( sizeof( vobsub_track_t
) );
153 if( unlikely( !p_sys
->track
) )
155 p_sys
->i_original_frame_width
= -1;
156 p_sys
->i_original_frame_height
= -1;
157 p_sys
->b_palette
= false;
158 memset( p_sys
->palette
, 0, 16 * sizeof( uint32_t ) );
160 /* Load the whole file */
161 TextLoad( &p_sys
->txt
, p_demux
->s
);
164 ParseVobSubIDX( p_demux
);
167 TextUnload( &p_sys
->txt
);
169 /* Find the total length of the vobsubs */
170 if( p_sys
->i_tracks
> 0 )
172 for( int i
= 0; i
< p_sys
->i_tracks
; i
++ )
174 if( p_sys
->track
[i
].i_subtitles
> 1 )
176 if( p_sys
->track
[i
].p_subtitles
[p_sys
->track
[i
].i_subtitles
-1].i_start
> p_sys
->i_length
)
177 p_sys
->i_length
= (int64_t) p_sys
->track
[i
].p_subtitles
[p_sys
->track
[i
].i_subtitles
-1].i_start
+ ( 1 *1000 *1000 );
182 if( asprintf( &psz_vobname
, "%s://%s", p_demux
->psz_access
, p_demux
->psz_location
) == -1 )
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
= vlc_stream_NewURL( p_demux
, psz_vobname
);
190 if( p_sys
->p_vobsub_stream
== NULL
)
192 msg_Err( p_demux
, "couldn't open .sub Vobsub file: %s",
199 p_demux
->pf_demux
= Demux
;
200 p_demux
->pf_control
= Control
;
205 /* Clean all subs from all tracks */
206 for( int i
= 0; i
< p_sys
->i_tracks
; i
++ )
207 free( p_sys
->track
[i
].p_subtitles
);
208 free( p_sys
->track
);
214 /*****************************************************************************
215 * Close: Close subtitle demux
216 *****************************************************************************/
217 static void Close( vlc_object_t
*p_this
)
219 demux_t
*p_demux
= (demux_t
*)p_this
;
220 demux_sys_t
*p_sys
= p_demux
->p_sys
;
222 if( p_sys
->p_vobsub_stream
)
223 vlc_stream_Delete( p_sys
->p_vobsub_stream
);
225 /* Clean all subs from all tracks */
226 for( int i
= 0; i
< p_sys
->i_tracks
; i
++ )
227 free( p_sys
->track
[i
].p_subtitles
);
228 free( p_sys
->track
);
232 /*****************************************************************************
234 *****************************************************************************/
235 static int Control( demux_t
*p_demux
, int i_query
, va_list args
)
237 demux_sys_t
*p_sys
= p_demux
->p_sys
;
245 *va_arg( args
, bool * ) = true;
248 case DEMUX_GET_LENGTH
:
249 pi64
= va_arg( args
, int64_t * );
250 *pi64
= (int64_t) p_sys
->i_length
;
254 pi64
= 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
= 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
= 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
= 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
= 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( int 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( vlc_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_Alloc( i_size
) ) == NULL
)
395 tk
.i_current_subtitle
++;
400 i_read
= vlc_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 block_Release( p_block
);
417 tk
.i_current_subtitle
++;
423 p_sys
->i_next_demux_date
= 0;
428 static int TextLoad( text_t
*txt
, stream_t
*s
)
433 /* load the complete file */
436 char *psz
= vlc_stream_ReadLine( s
);
439 if( psz
== NULL
|| (n
>= INT_MAX
/sizeof(char *)) )
445 ppsz_new
= realloc( lines
, (n
+ 1) * sizeof (char *) );
446 if( ppsz_new
== NULL
)
455 txt
->i_line_count
= n
;
462 static void TextUnload( text_t
*txt
)
464 for( int i
= 0; i
< txt
->i_line_count
; i
++ )
465 free( txt
->line
[i
] );
469 txt
->i_line_count
= 0;
472 static char *TextGetLine( text_t
*txt
)
474 if( txt
->i_line
>= txt
->i_line_count
)
477 return txt
->line
[txt
->i_line
++];
480 static int ParseVobSubIDX( demux_t
*p_demux
)
482 demux_sys_t
*p_sys
= p_demux
->p_sys
;
483 text_t
*txt
= &p_sys
->txt
;
488 if( ( line
= TextGetLine( txt
) ) == NULL
)
490 return( VLC_EGENERIC
);
493 if( *line
== 0 || *line
== '\r' || *line
== '\n' || *line
== '#' )
497 else if( !strncmp( "size:", line
, 5 ) )
499 /* Store the original size of the video */
500 if( vobsub_size_parse( line
, &p_sys
->i_original_frame_width
,
501 &p_sys
->i_original_frame_height
) == VLC_SUCCESS
)
503 msg_Dbg( p_demux
, "original frame size: %dx%d", p_sys
->i_original_frame_width
, p_sys
->i_original_frame_height
);
507 msg_Warn( p_demux
, "reading original frame size failed" );
510 else if( !strncmp( "palette:", line
, 8 ) )
512 if( vobsub_palette_parse( line
, p_sys
->palette
) == VLC_SUCCESS
)
514 p_sys
->b_palette
= true;
515 msg_Dbg( p_demux
, "vobsub palette read" );
519 msg_Warn( p_demux
, "reading original palette failed" );
522 else if( !strncmp( "id:", line
, 3 ) )
524 char language
[33]; /* Usually 2 or 3 letters, sometimes more.
525 Spec (or lack of) doesn't define any limit */
529 /* Lets start a new track */
530 if( sscanf( line
, "id: %32[^ ,], index: %d",
531 language
, &i_track_id
) != 2 )
533 if( sscanf( line
, "id: , index: %d", &i_track_id
) != 1 )
535 msg_Warn( p_demux
, "reading new track failed" );
542 p_sys
->track
= xrealloc( p_sys
->track
,
543 sizeof( vobsub_track_t
) * (p_sys
->i_tracks
+ 1 ) );
546 vobsub_track_t
*current_tk
= &p_sys
->track
[p_sys
->i_tracks
- 1];
547 memset( current_tk
, 0, sizeof( vobsub_track_t
) );
548 current_tk
->i_current_subtitle
= 0;
549 current_tk
->i_subtitles
= 0;
550 current_tk
->p_subtitles
= xmalloc( sizeof( subtitle_t
) );
551 current_tk
->i_track_id
= i_track_id
;
552 current_tk
->i_delay
= (int64_t)0;
554 es_format_Init( &fmt
, SPU_ES
, VLC_CODEC_SPU
);
555 fmt
.subs
.spu
.i_original_frame_width
= p_sys
->i_original_frame_width
;
556 fmt
.subs
.spu
.i_original_frame_height
= p_sys
->i_original_frame_height
;
557 fmt
.psz_language
= language
;
558 if( p_sys
->b_palette
)
560 fmt
.subs
.spu
.palette
[0] = SPU_PALETTE_DEFINED
;
561 memcpy( &fmt
.subs
.spu
.palette
[1], p_sys
->palette
, 16 * sizeof( uint32_t ) );
564 current_tk
->p_es
= es_out_Add( p_demux
->out
, &fmt
);
565 msg_Dbg( p_demux
, "New vobsub track detected: %i [%s]", i_track_id
, language
);
567 else if( !strncmp( line
, "timestamp:", 10 ) )
570 * timestamp: [sign]hh:mm:ss:mss, filepos: loc
571 * loc is the hex location of the spu in the .sub file
573 int h
, m
, s
, ms
, count
, loc
= 0;
575 int64_t i_start
, i_location
= 0;
577 if( p_sys
->i_tracks
> 0 &&
578 sscanf( line
, "timestamp: %d%n:%d:%d:%d, filepos: %x",
579 &h
, &count
, &m
, &s
, &ms
, &loc
) >= 5 )
581 vobsub_track_t
*current_tk
= &p_sys
->track
[p_sys
->i_tracks
- 1];
582 subtitle_t
*current_sub
;
584 if( line
[count
-3] == '-' )
589 i_start
= (int64_t) ( h
* 3600*1000 +
595 current_tk
->i_subtitles
++;
596 current_tk
->p_subtitles
=
597 xrealloc( current_tk
->p_subtitles
,
598 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
= i_start
* i_sign
;
602 current_sub
->i_start
+= current_tk
->i_delay
;
603 current_sub
->i_vobsub_location
= i_location
;
607 msg_Warn( p_demux
, "reading timestamp failed" );
610 else if( !strncasecmp( line
, "delay:", 6 ) )
613 * delay: [sign]hh:mm:ss:mss
615 int h
, m
, s
, ms
, count
= 0;
619 if( p_sys
->i_tracks
> 0 &&
620 sscanf( line
, "%*celay: %d%n:%d:%d:%d",
621 &h
, &count
, &m
, &s
, &ms
) >= 4 )
623 vobsub_track_t
*current_tk
= &p_sys
->track
[p_sys
->i_tracks
- 1];
624 if( line
[count
-3] == '-' )
629 i_gap
= (int64_t) ( h
* 3600*1000 +
634 current_tk
->i_delay
= current_tk
->i_delay
+ (i_gap
* i_sign
);
635 msg_Dbg( p_demux
, "sign: %+d gap: %+"PRId64
" global delay: %+"PRId64
"",
636 i_sign
, i_gap
, current_tk
->i_delay
);
640 msg_Warn( p_demux
, "reading delay failed" );
647 static int DemuxVobSub( demux_t
*p_demux
, block_t
*p_bk
)
649 demux_sys_t
*p_sys
= p_demux
->p_sys
;
650 uint8_t *p
= p_bk
->p_buffer
;
651 uint8_t *p_end
= &p_bk
->p_buffer
[p_bk
->i_buffer
];
654 while( p
+ 6 < p_end
)
656 int i_size
= ps_pkt_size( p
, p_end
- p
);
664 if( i_size
> p_end
- p
)
666 msg_Warn( p_demux
, "broken PES size" );
670 if( p
[0] != 0 || p
[1] != 0 || p
[2] != 0x01 )
672 msg_Warn( p_demux
, "invalid PES" );
678 /* msg_Dbg( p_demux, "we don't need these ps packets (id=0x1%2.2x)", p[3] ); */
684 p_pkt
= block_Alloc( i_size
);
685 if( unlikely(p_pkt
== NULL
) )
687 memcpy( p_pkt
->p_buffer
, p
, i_size
);
690 i_id
= ps_pkt_id( p_pkt
);
691 if( (i_id
&0xffe0) != 0xbd20 ||
692 ps_pkt_parse_pes( VLC_OBJECT(p_demux
), p_pkt
, 1 ) )
694 block_Release( p_pkt
);
698 /* msg_Dbg( p_demux, "SPU track %d size %d", i_spu, i_size ); */
700 for( i
= 0; i
< p_sys
->i_tracks
; i
++ )
702 vobsub_track_t
*p_tk
= &p_sys
->track
[i
];
704 p_pkt
->i_dts
= p_pkt
->i_pts
= p_bk
->i_pts
;
707 if( p_tk
->p_es
&& p_tk
->i_track_id
== i_spu
)
709 es_out_Send( p_demux
->out
, p_tk
->p_es
, p_pkt
);
710 p_bk
->i_pts
= VLC_TS_INVALID
; /*only first packet has a pts */
714 if( i
>= p_sys
->i_tracks
)
716 block_Release( p_pkt
);