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", true,
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;
95 bool b_need_preload = false;
97 /* peek the begining */
98 if( stream_Peek( p_demux->s, &p_peek, 4 ) < 4 ) return VLC_EGENERIC;
100 /* is a valid file */
101 if( p_peek[0] != 0x1a || p_peek[1] != 0x45 ||
102 p_peek[2] != 0xdf || p_peek[3] != 0xa3 ) return VLC_EGENERIC;
104 /* Set the demux function */
105 p_demux->pf_demux = Demux;
106 p_demux->pf_control = Control;
107 p_demux->p_sys = p_sys = new demux_sys_t( *p_demux );
109 p_io_callback = new vlc_stream_io_callback( p_demux->s, false );
110 p_io_stream = new EbmlStream( *p_io_callback );
112 if( p_io_stream == NULL )
114 msg_Err( p_demux, "failed to create EbmlStream" );
115 delete p_io_callback;
120 p_stream = p_sys->AnalyseAllSegmentsFound( p_demux, p_io_stream, true );
121 if( p_stream == NULL )
123 msg_Err( p_demux, "cannot find KaxSegment or missing mandatory KaxInfo" );
126 p_sys->streams.push_back( p_stream );
128 p_stream->p_io_callback = p_io_callback;
129 p_stream->p_estream = p_io_stream;
131 for (size_t i=0; i<p_stream->segments.size(); i++)
133 p_stream->segments[i]->Preload();
134 b_need_preload |= p_stream->segments[i]->b_ref_external_segments;
137 p_segment = p_stream->segments[0];
138 if( p_segment->cluster == NULL )
140 msg_Err( p_demux, "cannot find any cluster, damaged file ?" );
144 if (b_need_preload && var_InheritBool( p_demux, "mkv-preload-local-dir" ))
146 msg_Dbg( p_demux, "Preloading local dir" );
147 /* get the files from the same dir from the same family (based on p_demux->psz_path) */
148 if ( p_demux->psz_file && !strcmp( p_demux->psz_access, "file" ) )
150 // assume it's a regular file
151 // get the directory path
152 s_path = p_demux->psz_file;
153 if (s_path.at(s_path.length() - 1) == DIR_SEP_CHAR)
155 s_path = s_path.substr(0,s_path.length()-1);
159 if (s_path.find_last_of(DIR_SEP_CHAR) > 0)
161 s_path = s_path.substr(0,s_path.find_last_of(DIR_SEP_CHAR));
165 DIR *p_src_dir = vlc_opendir(s_path.c_str());
167 if (p_src_dir != NULL)
170 while ((psz_file = vlc_readdir(p_src_dir)) != NULL)
172 if (strlen(psz_file) > 4)
174 s_filename = s_path + DIR_SEP_CHAR + psz_file;
176 #if defined(WIN32) || defined(__OS2__)
177 if (!strcasecmp(s_filename.c_str(), p_demux->psz_file))
179 if (!s_filename.compare(p_demux->psz_file))
183 continue; // don't reuse the original opened file
186 if (!s_filename.compare(s_filename.length() - 3, 3, "mkv") ||
187 !s_filename.compare(s_filename.length() - 3, 3, "mka"))
189 // test wether this file belongs to our family
190 const uint8_t *p_peek;
191 bool file_ok = false;
192 std::string s_url = make_URI( s_filename.c_str(), "file" );
193 stream_t *p_file_stream = stream_UrlNew(
196 /* peek the begining */
198 stream_Peek( p_file_stream, &p_peek, 4 ) >= 4
199 && p_peek[0] == 0x1a && p_peek[1] == 0x45 &&
200 p_peek[2] == 0xdf && p_peek[3] == 0xa3 ) file_ok = true;
204 vlc_stream_io_callback *p_file_io = new vlc_stream_io_callback( p_file_stream, true );
205 EbmlStream *p_estream = new EbmlStream(*p_file_io);
207 p_stream = p_sys->AnalyseAllSegmentsFound( p_demux, p_estream );
209 if ( p_stream == NULL )
211 msg_Dbg( p_demux, "the file '%s' will not be used", s_filename.c_str() );
217 p_stream->p_io_callback = p_file_io;
218 p_stream->p_estream = p_estream;
219 p_sys->streams.push_back( p_stream );
224 if( p_file_stream ) {
225 stream_Delete( p_file_stream );
227 msg_Dbg( p_demux, "the file '%s' cannot be opened", s_filename.c_str() );
233 closedir( p_src_dir );
237 p_sys->PreloadFamily( *p_segment );
239 else if (b_need_preload)
240 msg_Warn( p_demux, "This file references other files, you may want to enable the preload of local directory");
242 if ( !p_sys->PreloadLinked() ||
243 !p_sys->PreparePlayback( NULL ) )
245 msg_Err( p_demux, "cannot use the segment" );
258 /*****************************************************************************
259 * Close: frees unused data
260 *****************************************************************************/
261 static void Close( vlc_object_t *p_this )
263 demux_t *p_demux = (demux_t*)p_this;
264 demux_sys_t *p_sys = p_demux->p_sys;
265 virtual_segment_c *p_vsegment = p_sys->p_current_segment;
268 matroska_segment_c *p_segment = p_vsegment->CurrentSegment();
270 p_segment->UnSelect();
276 /*****************************************************************************
278 *****************************************************************************/
279 static int Control( demux_t *p_demux, int i_query, va_list args )
281 demux_sys_t *p_sys = p_demux->p_sys;
288 input_attachment_t ***ppp_attach;
293 case DEMUX_GET_ATTACHMENTS:
294 ppp_attach = (input_attachment_t***)va_arg( args, input_attachment_t*** );
295 pi_int = (int*)va_arg( args, int * );
297 if( p_sys->stored_attachments.size() <= 0 )
300 *pi_int = p_sys->stored_attachments.size();
301 *ppp_attach = (input_attachment_t**)malloc( sizeof(input_attachment_t**) *
302 p_sys->stored_attachments.size() );
305 for( size_t i = 0; i < p_sys->stored_attachments.size(); i++ )
307 attachment_c *a = p_sys->stored_attachments[i];
308 (*ppp_attach)[i] = vlc_input_attachment_New( a->fileName(), a->mimeType(), NULL,
309 a->p_data, a->size() );
314 p_meta = (vlc_meta_t*)va_arg( args, vlc_meta_t* );
315 vlc_meta_Merge( p_meta, p_sys->meta );
318 case DEMUX_GET_LENGTH:
319 pi64 = (int64_t*)va_arg( args, int64_t * );
320 if( p_sys->f_duration > 0.0 )
322 *pi64 = (int64_t)(p_sys->f_duration * 1000);
327 case DEMUX_GET_POSITION:
328 pf = (double*)va_arg( args, double * );
329 if ( p_sys->f_duration > 0.0 )
330 *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);
333 case DEMUX_SET_POSITION:
334 f = (double)va_arg( args, double );
335 Seek( p_demux, -1, f, NULL );
339 pi64 = (int64_t*)va_arg( args, int64_t * );
340 *pi64 = p_sys->i_pts;
343 case DEMUX_GET_TITLE_INFO:
344 if( p_sys->titles.size() > 1 || ( p_sys->titles.size() == 1 && p_sys->titles[0]->i_seekpoint > 0 ) )
346 input_title_t ***ppp_title = (input_title_t***)va_arg( args, input_title_t*** );
347 int *pi_int = (int*)va_arg( args, int* );
349 *pi_int = p_sys->titles.size();
350 *ppp_title = (input_title_t**)malloc( sizeof( input_title_t**) * p_sys->titles.size() );
352 for( size_t i = 0; i < p_sys->titles.size(); i++ )
354 (*ppp_title)[i] = vlc_input_title_Duplicate( p_sys->titles[i] );
360 case DEMUX_SET_TITLE:
361 /* TODO handle editions as titles */
362 i_idx = (int)va_arg( args, int );
363 if( i_idx < p_sys->used_segments.size() )
365 p_sys->JumpTo( *p_sys->used_segments[i_idx], NULL );
370 case DEMUX_SET_SEEKPOINT:
371 i_skp = (int)va_arg( args, int );
373 // TODO change the way it works with the << & >> buttons on the UI (+1/-1 instead of a number)
374 if( p_sys->titles.size() && i_skp < p_sys->titles[p_sys->i_current_title]->i_seekpoint)
376 Seek( p_demux, (int64_t)p_sys->titles[p_sys->i_current_title]->seekpoint[i_skp]->i_time_offset, -1, NULL);
377 p_demux->info.i_seekpoint |= INPUT_UPDATE_SEEKPOINT;
378 p_demux->info.i_seekpoint = i_skp;
384 pf = (double *)va_arg( args, double * );
386 if( p_sys->p_current_segment && p_sys->p_current_segment->CurrentSegment() )
388 const matroska_segment_c *p_segment = p_sys->p_current_segment->CurrentSegment();
389 for( size_t i = 0; i < p_segment->tracks.size(); i++ )
391 mkv_track_t *tk = p_segment->tracks[i];
392 if( tk->fmt.i_cat == VIDEO_ES && tk->fmt.video.i_frame_rate_base > 0 )
394 *pf = (double)tk->fmt.video.i_frame_rate / tk->fmt.video.i_frame_rate_base;
402 i64 = (int64_t) va_arg( args, int64_t );
403 msg_Dbg(p_demux,"SET_TIME to %"PRId64, i64 );
404 Seek( p_demux, i64, -1, NULL );
412 static void Seek( demux_t *p_demux, mtime_t i_date, double f_percent, virtual_chapter_c *p_chapter )
414 demux_sys_t *p_sys = p_demux->p_sys;
415 virtual_segment_c *p_vsegment = p_sys->p_current_segment;
416 matroska_segment_c *p_segment = p_vsegment->CurrentSegment();
417 mtime_t i_time_offset = 0;
418 int64_t i_global_position = -1;
422 msg_Dbg( p_demux, "seek request to %"PRId64" (%f%%)", i_date, f_percent );
423 if( i_date < 0 && f_percent < 0 )
425 msg_Warn( p_demux, "cannot seek nowhere!" );
428 if( f_percent > 1.0 )
430 msg_Warn( p_demux, "cannot seek so far!" );
433 if( p_sys->f_duration < 0 )
435 msg_Warn( p_demux, "cannot seek without duration!");
439 /* seek without index or without date */
440 if( f_percent >= 0 && (var_InheritBool( p_demux, "mkv-seek-percent" ) || !p_segment->b_cues || i_date < 0 ))
442 i_date = int64_t( f_percent * p_sys->f_duration * 1000.0 );
443 if( !p_segment->b_cues )
445 int64_t i_pos = int64_t( f_percent * stream_Size( p_demux->s ) );
447 msg_Dbg( p_demux, "lengthy way of seeking for pos:%"PRId64, i_pos );
448 for( i_index = 0; i_index < p_segment->i_index; i_index++ )
450 if( p_segment->p_indexes[i_index].i_position >= i_pos &&
451 p_segment->p_indexes[i_index].i_time > 0 )
454 if( i_index == p_segment->i_index )
457 if( p_segment->p_indexes[i_index].i_position < i_pos )
459 msg_Dbg( p_demux, "no cues, seek request to global pos: %"PRId64, i_pos );
460 i_global_position = i_pos;
464 p_vsegment->Seek( *p_demux, i_date, i_time_offset, p_chapter, i_global_position );
467 /* Utility function for BlockDecode */
468 static block_t *MemToBlock( uint8_t *p_mem, size_t i_mem, size_t offset)
470 if( unlikely( i_mem > SIZE_MAX - offset ) )
473 block_t *p_block = block_New( p_demux, i_mem + offset );
474 if( likely(p_block != NULL) )
476 memcpy( p_block->p_buffer + offset, p_mem, i_mem );
481 /* Needed by matroska_segment::Seek() and Seek */
482 void BlockDecode( demux_t *p_demux, KaxBlock *block, KaxSimpleBlock *simpleblock,
483 mtime_t i_pts, mtime_t i_duration, bool f_mandatory )
485 demux_sys_t *p_sys = p_demux->p_sys;
486 matroska_segment_c *p_segment = p_sys->p_current_segment->CurrentSegment();
488 if( !p_segment ) return;
491 if( p_segment->BlockFindTrackIndex( &i_track, block, simpleblock ) )
493 msg_Err( p_demux, "invalid track number" );
497 mkv_track_t *tk = p_segment->tracks[i_track];
499 if( tk->fmt.i_cat != NAV_ES && tk->p_es == NULL )
501 msg_Err( p_demux, "unknown track number" );
504 if( i_pts + i_duration < p_sys->i_start_pts && tk->fmt.i_cat == AUDIO_ES )
506 return; /* discard audio packets that shouldn't be rendered */
509 if ( tk->fmt.i_cat != NAV_ES )
512 es_out_Control( p_demux->out, ES_OUT_GET_ES_STATE, tk->p_es, &b );
516 tk->b_inited = false;
522 /* First send init data */
523 if( !tk->b_inited && tk->i_data_init > 0 )
527 msg_Dbg( p_demux, "sending header (%d bytes)", tk->i_data_init );
528 p_init = MemToBlock( tk->p_data_init, tk->i_data_init, 0 );
529 if( p_init ) es_out_Send( p_demux->out, tk->p_es, p_init );
534 size_t frame_size = 0;
535 size_t block_size = 0;
537 if( simpleblock != NULL )
538 block_size = simpleblock->GetSize();
540 block_size = block->GetSize();
542 for( unsigned int i = 0;
543 ( block != NULL && i < block->NumberFrames()) || ( simpleblock != NULL && i < simpleblock->NumberFrames() );
548 if( simpleblock != NULL )
550 data = &simpleblock->GetBuffer(i);
551 // condition when the DTS is correct (keyframe or B frame == NOT P frame)
552 f_mandatory = simpleblock->IsDiscardable() || simpleblock->IsKeyframe();
556 data = &block->GetBuffer(i);
557 // condition when the DTS is correct (keyframe or B frame == NOT P frame)
559 frame_size += data->Size();
560 if( !data->Buffer() || data->Size() > SIZE_MAX || frame_size > block_size )
562 msg_Warn( p_demux, "Cannot read frame (too long or no frame)" );
566 if( tk->i_compression_type == MATROSKA_COMPRESSION_HEADER && tk->p_compression_data != NULL )
567 p_block = MemToBlock( data->Buffer(), data->Size(), tk->p_compression_data->GetSize() );
569 p_block = MemToBlock( data->Buffer(), data->Size(), 0 );
571 if( p_block == NULL )
576 #if defined(HAVE_ZLIB_H)
577 if( tk->i_compression_type == MATROSKA_COMPRESSION_ZLIB )
579 p_block = block_zlib_decompress( VLC_OBJECT(p_demux), p_block );
580 if( p_block == NULL )
585 if( tk->i_compression_type == MATROSKA_COMPRESSION_HEADER )
587 memcpy( p_block->p_buffer, tk->p_compression_data->GetBuffer(), tk->p_compression_data->GetSize() );
590 if ( tk->fmt.i_cat == NAV_ES )
592 // TODO handle the start/stop times of this packet
593 p_sys->p_ev->SetPci( (const pci_t *)&p_block->p_buffer[1]);
594 block_Release( p_block );
597 // correct timestamping when B frames are used
598 if( tk->fmt.i_cat != VIDEO_ES )
600 p_block->i_dts = p_block->i_pts = i_pts;
606 p_block->i_pts = VLC_TS_INVALID;
607 p_block->i_dts = i_pts;
609 else if( tk->b_pts_only )
611 p_block->i_pts = i_pts;
612 p_block->i_dts = i_pts;
616 p_block->i_pts = i_pts;
618 p_block->i_dts = p_block->i_pts;
620 p_block->i_dts = min( i_pts, tk->i_last_dts + ( mtime_t )( tk->i_default_duration / 1000 ) );
623 tk->i_last_dts = p_block->i_dts;
626 msg_Dbg( p_demux, "block i_dts: %"PRId64" / i_pts: %"PRId64, p_block->i_dts, p_block->i_pts);
628 if( strcmp( tk->psz_codec, "S_VOBSUB" ) )
630 p_block->i_length = i_duration * 1000;
633 /* FIXME remove when VLC_TS_INVALID work is done */
634 if( i == 0 || p_block->i_dts > VLC_TS_INVALID )
635 p_block->i_dts += VLC_TS_0;
636 if( !tk->b_dts_only && ( i == 0 || p_block->i_pts > VLC_TS_INVALID ) )
637 p_block->i_pts += VLC_TS_0;
639 es_out_Send( p_demux->out, tk->p_es, p_block );
641 /* use time stamp only for first block */
642 i_pts = ( tk->i_default_duration )?
643 i_pts + ( mtime_t )( tk->i_default_duration / 1000 ):
648 /*****************************************************************************
649 * Demux: reads and demuxes data packets
650 *****************************************************************************
651 * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
652 *****************************************************************************/
653 static int Demux( demux_t *p_demux)
655 demux_sys_t *p_sys = p_demux->p_sys;
657 vlc_mutex_lock( &p_sys->lock_demuxer );
659 virtual_segment_c *p_vsegment = p_sys->p_current_segment;
660 matroska_segment_c *p_segment = p_vsegment->CurrentSegment();
661 if ( p_segment == NULL ) return 0;
662 int i_block_count = 0;
667 if ( p_sys->demuxer.b_die )
670 if( p_sys->i_pts >= p_sys->i_start_pts )
671 if ( p_vsegment->UpdateCurrentToChapter( *p_demux ) )
677 if ( p_vsegment->CurrentEdition() &&
678 p_vsegment->CurrentEdition()->b_ordered &&
679 p_vsegment->CurrentChapter() == NULL )
680 /* nothing left to read in this ordered edition */
684 KaxSimpleBlock *simpleblock;
685 int64_t i_block_duration = 0;
687 bool b_discardable_picture;
688 if( p_segment->BlockGet( block, simpleblock, &b_key_picture, &b_discardable_picture, &i_block_duration ) )
690 if ( p_vsegment->CurrentEdition() && p_vsegment->CurrentEdition()->b_ordered )
692 const virtual_chapter_c *p_chap = p_vsegment->CurrentChapter();
693 // check if there are more chapters to read
694 if ( p_chap != NULL )
696 /* TODO handle successive chapters with the same user_start_time/user_end_time
698 p_sys->i_pts = p_chap->i_virtual_stop_time;
699 p_sys->i_pts++; // trick to avoid staying on segments with no duration and no content
708 msg_Warn( p_demux, "cannot get block EOF?" );
713 if( simpleblock != NULL )
714 p_sys->i_pts = p_sys->i_chapter_time + ( simpleblock->GlobalTimecode() / (mtime_t) 1000 );
716 p_sys->i_pts = p_sys->i_chapter_time + ( block->GlobalTimecode() / (mtime_t) 1000 );
718 /* The blocks are in coding order so we can safely consider that only references are in chronological order */
719 if( p_sys->i_pts > p_sys->i_pcr + 300000 )
721 es_out_Control( p_demux->out, ES_OUT_SET_PCR, VLC_TS_0 + p_sys->i_pcr );
722 p_sys->i_pcr = p_sys->i_pts;
725 if( p_sys->i_pts >= p_sys->i_start_pts )
727 if ( p_vsegment->UpdateCurrentToChapter( *p_demux ) )
735 if ( p_vsegment->CurrentEdition() &&
736 p_vsegment->CurrentEdition()->b_ordered &&
737 p_vsegment->CurrentChapter() == NULL )
739 /* nothing left to read in this ordered edition */
744 BlockDecode( p_demux, block, simpleblock, p_sys->i_pts, i_block_duration, b_key_picture || b_discardable_picture );
749 // TODO optimize when there is need to leave or when seeking has been called
750 if( i_block_count > 5 )
757 vlc_mutex_unlock( &p_sys->lock_demuxer );