1 /*****************************************************************************
2 * mkv.cpp : matroska demuxer
3 *****************************************************************************
4 * Copyright (C) 2003-2005, 2008, 2010 the VideoLAN team
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8 * Steve Lhomme <steve.lhomme@free.fr>
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 *****************************************************************************/
28 #include "matroska_segment.hpp"
31 #include "chapters.hpp"
32 #include "Ebml_parser.hpp"
34 #include "stream_io_callback.hpp"
39 /*****************************************************************************
41 *****************************************************************************/
42 static int Open ( vlc_object_t * );
43 static void Close( vlc_object_t * );
46 set_shortname( "Matroska" )
47 set_description( N_("Matroska stream demuxer" ) )
48 set_capability( "demux", 50 )
49 set_callbacks( Open, Close )
50 set_category( CAT_INPUT )
51 set_subcategory( SUBCAT_INPUT_DEMUX )
53 add_bool( "mkv-use-ordered-chapters", true,
54 N_("Respect ordered chapters"),
55 N_("Play chapters in the order specified in the segment."), false );
57 add_bool( "mkv-use-chapter-codec", true,
59 N_("Use chapter codecs found in the segment."), true );
61 add_bool( "mkv-preload-local-dir", false,
62 N_("Preload MKV files in the same directory"),
63 N_("Preload matroska files in the same directory to find linked segments (not good for broken files)."), false );
65 add_bool( "mkv-seek-percent", false,
66 N_("Seek based on percent not time"),
67 N_("Seek based on percent not time."), true );
69 add_bool( "mkv-use-dummy", false,
71 N_("Read and discard unknown EBML elements (not good for broken files)."), true );
73 add_shortcut( "mka", "mkv" )
78 static int Demux ( demux_t * );
79 static int Control( demux_t *, int, va_list );
80 static void Seek ( demux_t *, mtime_t i_date, double f_percent, virtual_chapter_c *p_chapter );
82 /*****************************************************************************
83 * Open: initializes matroska demux structures
84 *****************************************************************************/
85 static int Open( vlc_object_t * p_this )
87 demux_t *p_demux = (demux_t*)p_this;
89 matroska_stream_c *p_stream;
90 matroska_segment_c *p_segment;
91 const uint8_t *p_peek;
92 std::string s_path, s_filename;
93 vlc_stream_io_callback *p_io_callback;
94 EbmlStream *p_io_stream;
96 /* peek the begining */
97 if( stream_Peek( p_demux->s, &p_peek, 4 ) < 4 ) return VLC_EGENERIC;
100 if( p_peek[0] != 0x1a || p_peek[1] != 0x45 ||
101 p_peek[2] != 0xdf || p_peek[3] != 0xa3 ) return VLC_EGENERIC;
103 /* Set the demux function */
104 p_demux->pf_demux = Demux;
105 p_demux->pf_control = Control;
106 p_demux->p_sys = p_sys = new demux_sys_t( *p_demux );
108 p_io_callback = new vlc_stream_io_callback( p_demux->s, false );
109 p_io_stream = new EbmlStream( *p_io_callback );
111 if( p_io_stream == NULL )
113 msg_Err( p_demux, "failed to create EbmlStream" );
114 delete p_io_callback;
119 p_stream = p_sys->AnalyseAllSegmentsFound( p_demux, p_io_stream, true );
120 if( p_stream == NULL )
122 msg_Err( p_demux, "cannot find KaxSegment or missing mandatory KaxInfo" );
125 p_sys->streams.push_back( p_stream );
127 p_stream->p_io_callback = p_io_callback;
128 p_stream->p_estream = p_io_stream;
130 for (size_t i=0; i<p_stream->segments.size(); i++)
132 p_stream->segments[i]->Preload();
135 p_segment = p_stream->segments[0];
136 if( p_segment->cluster == NULL )
138 msg_Err( p_demux, "cannot find any cluster, damaged file ?" );
142 if (var_InheritBool( p_demux, "mkv-preload-local-dir" ))
144 /* get the files from the same dir from the same family (based on p_demux->psz_path) */
145 if ( p_demux->psz_file && !strcmp( p_demux->psz_access, "file" ) )
147 // assume it's a regular file
148 // get the directory path
149 s_path = p_demux->psz_file;
150 if (s_path.at(s_path.length() - 1) == DIR_SEP_CHAR)
152 s_path = s_path.substr(0,s_path.length()-1);
156 if (s_path.find_last_of(DIR_SEP_CHAR) > 0)
158 s_path = s_path.substr(0,s_path.find_last_of(DIR_SEP_CHAR));
162 DIR *p_src_dir = vlc_opendir(s_path.c_str());
164 if (p_src_dir != NULL)
167 while ((psz_file = vlc_readdir(p_src_dir)) != NULL)
169 if (strlen(psz_file) > 4)
171 s_filename = s_path + DIR_SEP_CHAR + psz_file;
174 if (!strcasecmp(s_filename.c_str(), p_demux->psz_file))
176 if (!s_filename.compare(p_demux->psz_file))
180 continue; // don't reuse the original opened file
183 if (!s_filename.compare(s_filename.length() - 3, 3, "mkv") ||
184 !s_filename.compare(s_filename.length() - 3, 3, "mka"))
186 // test wether this file belongs to our family
187 const uint8_t *p_peek;
188 bool file_ok = false;
189 std::string s_url = make_URI( s_filename.c_str(), "file" );
190 stream_t *p_file_stream = stream_UrlNew(
193 /* peek the begining */
195 stream_Peek( p_file_stream, &p_peek, 4 ) >= 4
196 && p_peek[0] == 0x1a && p_peek[1] == 0x45 &&
197 p_peek[2] == 0xdf && p_peek[3] == 0xa3 ) file_ok = true;
201 vlc_stream_io_callback *p_file_io = new vlc_stream_io_callback( p_file_stream, true );
202 EbmlStream *p_estream = new EbmlStream(*p_file_io);
204 p_stream = p_sys->AnalyseAllSegmentsFound( p_demux, p_estream );
206 if ( p_stream == NULL )
208 msg_Dbg( p_demux, "the file '%s' will not be used", s_filename.c_str() );
214 p_stream->p_io_callback = p_file_io;
215 p_stream->p_estream = p_estream;
216 p_sys->streams.push_back( p_stream );
221 if( p_file_stream ) {
222 stream_Delete( p_file_stream );
224 msg_Dbg( p_demux, "the file '%s' cannot be opened", s_filename.c_str() );
230 closedir( p_src_dir );
234 p_sys->PreloadFamily( *p_segment );
237 if ( !p_sys->PreloadLinked() ||
238 !p_sys->PreparePlayback( NULL ) )
240 msg_Err( p_demux, "cannot use the segment" );
253 /*****************************************************************************
254 * Close: frees unused data
255 *****************************************************************************/
256 static void Close( vlc_object_t *p_this )
258 demux_t *p_demux = (demux_t*)p_this;
259 demux_sys_t *p_sys = p_demux->p_sys;
264 /*****************************************************************************
266 *****************************************************************************/
267 static int Control( demux_t *p_demux, int i_query, va_list args )
269 demux_sys_t *p_sys = p_demux->p_sys;
276 input_attachment_t ***ppp_attach;
281 case DEMUX_GET_ATTACHMENTS:
282 ppp_attach = (input_attachment_t***)va_arg( args, input_attachment_t*** );
283 pi_int = (int*)va_arg( args, int * );
285 if( p_sys->stored_attachments.size() <= 0 )
288 *pi_int = p_sys->stored_attachments.size();
289 *ppp_attach = (input_attachment_t**)malloc( sizeof(input_attachment_t**) *
290 p_sys->stored_attachments.size() );
293 for( size_t i = 0; i < p_sys->stored_attachments.size(); i++ )
295 attachment_c *a = p_sys->stored_attachments[i];
296 (*ppp_attach)[i] = vlc_input_attachment_New( a->fileName(), a->mimeType(), NULL,
297 a->p_data, a->size() );
302 p_meta = (vlc_meta_t*)va_arg( args, vlc_meta_t* );
303 vlc_meta_Merge( p_meta, p_sys->meta );
306 case DEMUX_GET_LENGTH:
307 pi64 = (int64_t*)va_arg( args, int64_t * );
308 if( p_sys->f_duration > 0.0 )
310 *pi64 = (int64_t)(p_sys->f_duration * 1000);
315 case DEMUX_GET_POSITION:
316 pf = (double*)va_arg( args, double * );
317 if ( p_sys->f_duration > 0.0 )
318 *pf = (double)(p_sys->i_pts >= p_sys->i_start_pts ? p_sys->i_pts : p_sys->i_start_pts ) / (1000.0 * p_sys->f_duration);
321 case DEMUX_SET_POSITION:
322 f = (double)va_arg( args, double );
323 Seek( p_demux, -1, f, NULL );
327 pi64 = (int64_t*)va_arg( args, int64_t * );
328 *pi64 = p_sys->i_pts;
331 case DEMUX_GET_TITLE_INFO:
332 if( p_sys->titles.size() > 1 || ( p_sys->titles.size() == 1 && p_sys->titles[0]->i_seekpoint > 0 ) )
334 input_title_t ***ppp_title = (input_title_t***)va_arg( args, input_title_t*** );
335 int *pi_int = (int*)va_arg( args, int* );
337 *pi_int = p_sys->titles.size();
338 *ppp_title = (input_title_t**)malloc( sizeof( input_title_t**) * p_sys->titles.size() );
340 for( size_t i = 0; i < p_sys->titles.size(); i++ )
342 (*ppp_title)[i] = vlc_input_title_Duplicate( p_sys->titles[i] );
348 case DEMUX_SET_TITLE:
349 /* TODO handle editions as titles */
350 i_idx = (int)va_arg( args, int );
351 if( i_idx < p_sys->used_segments.size() )
353 p_sys->JumpTo( *p_sys->used_segments[i_idx], NULL );
358 case DEMUX_SET_SEEKPOINT:
359 i_skp = (int)va_arg( args, int );
361 // TODO change the way it works with the << & >> buttons on the UI (+1/-1 instead of a number)
362 if( p_sys->titles.size() && i_skp < p_sys->titles[p_sys->i_current_title]->i_seekpoint)
364 Seek( p_demux, (int64_t)p_sys->titles[p_sys->i_current_title]->seekpoint[i_skp]->i_time_offset, -1, NULL);
365 p_demux->info.i_seekpoint |= INPUT_UPDATE_SEEKPOINT;
366 p_demux->info.i_seekpoint = i_skp;
372 pf = (double *)va_arg( args, double * );
374 if( p_sys->p_current_segment && p_sys->p_current_segment->CurrentSegment() )
376 const matroska_segment_c *p_segment = p_sys->p_current_segment->CurrentSegment();
377 for( size_t i = 0; i < p_segment->tracks.size(); i++ )
379 mkv_track_t *tk = p_segment->tracks[i];
380 if( tk->fmt.i_cat == VIDEO_ES && tk->fmt.video.i_frame_rate_base > 0 )
382 *pf = (double)tk->fmt.video.i_frame_rate / tk->fmt.video.i_frame_rate_base;
390 i64 = (int64_t) va_arg( args, int64_t );
391 msg_Dbg(p_demux,"SET_TIME to %"PRId64, i64 );
392 Seek( p_demux, i64, -1, NULL );
400 static void Seek( demux_t *p_demux, mtime_t i_date, double f_percent, virtual_chapter_c *p_chapter )
402 demux_sys_t *p_sys = p_demux->p_sys;
403 virtual_segment_c *p_vsegment = p_sys->p_current_segment;
404 matroska_segment_c *p_segment = p_vsegment->CurrentSegment();
405 mtime_t i_time_offset = 0;
406 int64_t i_global_position = -1;
410 msg_Dbg( p_demux, "seek request to %"PRId64" (%f%%)", i_date, f_percent );
411 if( i_date < 0 && f_percent < 0 )
413 msg_Warn( p_demux, "cannot seek nowhere!" );
416 if( f_percent > 1.0 )
418 msg_Warn( p_demux, "cannot seek so far!" );
421 if( p_sys->f_duration < 0 )
423 msg_Warn( p_demux, "cannot seek without duration!");
427 /* seek without index or without date */
428 if( f_percent >= 0 && (var_InheritBool( p_demux, "mkv-seek-percent" ) || !p_segment->b_cues || i_date < 0 ))
430 i_date = int64_t( f_percent * p_sys->f_duration * 1000.0 );
431 if( !p_segment->b_cues )
433 int64_t i_pos = int64_t( f_percent * stream_Size( p_demux->s ) );
435 msg_Dbg( p_demux, "lengthy way of seeking for pos:%"PRId64, i_pos );
436 for( i_index = 0; i_index < p_segment->i_index; i_index++ )
438 if( p_segment->p_indexes[i_index].i_position >= i_pos &&
439 p_segment->p_indexes[i_index].i_time > 0 )
442 if( i_index == p_segment->i_index )
445 if( p_segment->p_indexes[i_index].i_position < i_pos )
447 msg_Dbg( p_demux, "no cues, seek request to global pos: %"PRId64, i_pos );
448 i_global_position = i_pos;
452 p_vsegment->Seek( *p_demux, i_date, i_time_offset, p_chapter, i_global_position );
455 /* Utility function for BlockDecode */
456 static block_t *MemToBlock( uint8_t *p_mem, size_t i_mem, size_t offset)
458 if( unlikely( i_mem > SIZE_MAX - offset ) )
461 block_t *p_block = block_New( p_demux, i_mem + offset );
462 if( likely(p_block != NULL) )
464 memcpy( p_block->p_buffer + offset, p_mem, i_mem );
469 /* Needed by matroska_segment::Seek() and Seek */
470 void BlockDecode( demux_t *p_demux, KaxBlock *block, KaxSimpleBlock *simpleblock,
471 mtime_t i_pts, mtime_t i_duration, bool f_mandatory )
473 demux_sys_t *p_sys = p_demux->p_sys;
474 matroska_segment_c *p_segment = p_sys->p_current_segment->CurrentSegment();
476 if( !p_segment ) return;
479 if( p_segment->BlockFindTrackIndex( &i_track, block, simpleblock ) )
481 msg_Err( p_demux, "invalid track number" );
485 mkv_track_t *tk = p_segment->tracks[i_track];
487 if( tk->fmt.i_cat != NAV_ES && tk->p_es == NULL )
489 msg_Err( p_demux, "unknown track number" );
492 if( i_pts + i_duration < p_sys->i_start_pts && tk->fmt.i_cat == AUDIO_ES )
494 return; /* discard audio packets that shouldn't be rendered */
497 if ( tk->fmt.i_cat != NAV_ES )
500 es_out_Control( p_demux->out, ES_OUT_GET_ES_STATE, tk->p_es, &b );
504 tk->b_inited = false;
510 /* First send init data */
511 if( !tk->b_inited && tk->i_data_init > 0 )
515 msg_Dbg( p_demux, "sending header (%d bytes)", tk->i_data_init );
516 p_init = MemToBlock( tk->p_data_init, tk->i_data_init, 0 );
517 if( p_init ) es_out_Send( p_demux->out, tk->p_es, p_init );
522 size_t frame_size = 0;
523 size_t block_size = 0;
525 if( simpleblock != NULL )
526 block_size = simpleblock->GetSize();
528 block_size = block->GetSize();
530 for( unsigned int i = 0;
531 ( block != NULL && i < block->NumberFrames()) || ( simpleblock != NULL && i < simpleblock->NumberFrames() );
536 if( simpleblock != NULL )
538 data = &simpleblock->GetBuffer(i);
539 // condition when the DTS is correct (keyframe or B frame == NOT P frame)
540 f_mandatory = simpleblock->IsDiscardable() || simpleblock->IsKeyframe();
544 data = &block->GetBuffer(i);
545 // condition when the DTS is correct (keyframe or B frame == NOT P frame)
547 frame_size += data->Size();
548 if( !data->Buffer() || data->Size() > SIZE_MAX || frame_size > block_size )
550 msg_Warn( p_demux, "Cannot read frame (too long or no frame)" );
554 if( tk->i_compression_type == MATROSKA_COMPRESSION_HEADER && tk->p_compression_data != NULL )
555 p_block = MemToBlock( data->Buffer(), data->Size(), tk->p_compression_data->GetSize() );
557 p_block = MemToBlock( data->Buffer(), data->Size(), 0 );
559 if( p_block == NULL )
564 #if defined(HAVE_ZLIB_H)
565 if( tk->i_compression_type == MATROSKA_COMPRESSION_ZLIB )
567 p_block = block_zlib_decompress( VLC_OBJECT(p_demux), p_block );
568 if( p_block == NULL )
573 if( tk->i_compression_type == MATROSKA_COMPRESSION_HEADER )
575 memcpy( p_block->p_buffer, tk->p_compression_data->GetBuffer(), tk->p_compression_data->GetSize() );
578 if ( tk->fmt.i_cat == NAV_ES )
580 // TODO handle the start/stop times of this packet
581 p_sys->p_ev->SetPci( (const pci_t *)&p_block->p_buffer[1]);
582 block_Release( p_block );
585 // correct timestamping when B frames are used
586 if( tk->fmt.i_cat != VIDEO_ES )
588 p_block->i_dts = p_block->i_pts = i_pts;
594 p_block->i_pts = VLC_TS_INVALID;
595 p_block->i_dts = i_pts;
597 else if( tk->b_pts_only )
599 p_block->i_pts = i_pts;
600 p_block->i_dts = i_pts;
604 p_block->i_pts = i_pts;
606 p_block->i_dts = p_block->i_pts;
608 p_block->i_dts = min( i_pts, tk->i_last_dts + (mtime_t)(tk->i_default_duration >> 10));
611 tk->i_last_dts = p_block->i_dts;
614 msg_Dbg( p_demux, "block i_dts: %"PRId64" / i_pts: %"PRId64, p_block->i_dts, p_block->i_pts);
616 if( strcmp( tk->psz_codec, "S_VOBSUB" ) )
618 p_block->i_length = i_duration * 1000;
621 /* FIXME remove when VLC_TS_INVALID work is done */
622 if( i == 0 || p_block->i_dts > VLC_TS_INVALID )
623 p_block->i_dts += VLC_TS_0;
624 if( !tk->b_dts_only && ( i == 0 || p_block->i_pts > VLC_TS_INVALID ) )
625 p_block->i_pts += VLC_TS_0;
627 es_out_Send( p_demux->out, tk->p_es, p_block );
629 /* use time stamp only for first block */
630 i_pts = VLC_TS_INVALID;
634 /*****************************************************************************
635 * Demux: reads and demuxes data packets
636 *****************************************************************************
637 * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
638 *****************************************************************************/
639 static int Demux( demux_t *p_demux)
641 demux_sys_t *p_sys = p_demux->p_sys;
643 vlc_mutex_lock( &p_sys->lock_demuxer );
645 virtual_segment_c *p_vsegment = p_sys->p_current_segment;
646 matroska_segment_c *p_segment = p_vsegment->CurrentSegment();
647 if ( p_segment == NULL ) return 0;
648 int i_block_count = 0;
653 if ( p_sys->demuxer.b_die )
656 if( p_sys->i_pts >= p_sys->i_start_pts )
657 if ( p_vsegment->UpdateCurrentToChapter( *p_demux ) )
663 if ( p_vsegment->CurrentEdition() &&
664 p_vsegment->CurrentEdition()->b_ordered &&
665 p_vsegment->CurrentChapter() == NULL )
666 /* nothing left to read in this ordered edition */
670 KaxSimpleBlock *simpleblock;
671 int64_t i_block_duration = 0;
673 bool b_discardable_picture;
674 if( p_segment->BlockGet( block, simpleblock, &b_key_picture, &b_discardable_picture, &i_block_duration ) )
676 if ( p_vsegment->CurrentEdition() && p_vsegment->CurrentEdition()->b_ordered )
678 const virtual_chapter_c *p_chap = p_vsegment->CurrentChapter();
679 // check if there are more chapters to read
680 if ( p_chap != NULL )
682 /* TODO handle successive chapters with the same user_start_time/user_end_time
684 p_sys->i_pts = p_chap->i_virtual_stop_time;
685 p_sys->i_pts++; // trick to avoid staying on segments with no duration and no content
694 msg_Warn( p_demux, "cannot get block EOF?" );
695 p_segment->UnSelect();
697 es_out_Control( p_demux->out, ES_OUT_RESET_PCR );
702 if( simpleblock != NULL )
703 p_sys->i_pts = p_sys->i_chapter_time + ( simpleblock->GlobalTimecode() / (mtime_t) 1000 );
705 p_sys->i_pts = p_sys->i_chapter_time + ( block->GlobalTimecode() / (mtime_t) 1000 );
707 /* The blocks are in coding order so we can safely consider that only references are in chronological order */
708 if( simpleblock == NULL || b_key_picture )
709 es_out_Control( p_demux->out, ES_OUT_SET_PCR, VLC_TS_0 + p_sys->i_pts );
711 if( p_sys->i_pts >= p_sys->i_start_pts )
713 if ( p_vsegment->UpdateCurrentToChapter( *p_demux ) )
721 if ( p_vsegment->CurrentEdition() &&
722 p_vsegment->CurrentEdition()->b_ordered &&
723 p_vsegment->CurrentChapter() == NULL )
725 /* nothing left to read in this ordered edition */
730 BlockDecode( p_demux, block, simpleblock, p_sys->i_pts, i_block_duration, b_key_picture || b_discardable_picture );
735 // TODO optimize when there is need to leave or when seeking has been called
736 if( i_block_count > 5 )
743 vlc_mutex_unlock( &p_sys->lock_demuxer );