1 /*****************************************************************************
2 * mkv.cpp : matroska demuxer
3 *****************************************************************************
4 * Copyright (C) 2003-2004 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"
38 /*****************************************************************************
40 *****************************************************************************/
41 static int Open ( vlc_object_t * );
42 static void Close( vlc_object_t * );
45 set_shortname( "Matroska" )
46 set_description( N_("Matroska stream demuxer" ) )
47 set_capability( "demux", 50 )
48 set_callbacks( Open, Close )
49 set_category( CAT_INPUT )
50 set_subcategory( SUBCAT_INPUT_DEMUX )
52 add_bool( "mkv-use-ordered-chapters", true, NULL,
53 N_("Ordered chapters"),
54 N_("Play ordered chapters as specified in the segment."), true );
56 add_bool( "mkv-use-chapter-codec", true, NULL,
58 N_("Use chapter codecs found in the segment."), true );
60 add_bool( "mkv-preload-local-dir", false, NULL,
61 N_("Preload Directory"),
62 N_("Preload matroska files from the same family in the same directory (not good for broken files)."), true );
64 add_bool( "mkv-seek-percent", false, NULL,
65 N_("Seek based on percent not time"),
66 N_("Seek based on percent not time."), true );
68 add_bool( "mkv-use-dummy", false, NULL,
70 N_("Read and discard unknown EBML elements (not good for broken files)."), true );
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, chapter_item_c *psz_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" );
125 p_sys->streams.push_back( p_stream );
127 p_stream->p_in = p_io_callback;
128 p_stream->p_es = 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_InheritInteger( 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_path[0] != '\0' && !strcmp(p_demux->psz_access, ""))
147 // assume it's a regular file
148 // get the directory path
149 s_path = p_demux->psz_path;
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_path))
176 if (!s_filename.compare(p_demux->psz_path))
180 continue; // don't reuse the original opened file
183 #if defined(__GNUC__) && (__GNUC__ < 3)
184 if (!s_filename.compare("mkv", s_filename.length() - 3, 3) ||
185 !s_filename.compare("mka", s_filename.length() - 3, 3))
187 if (!s_filename.compare(s_filename.length() - 3, 3, "mkv") ||
188 !s_filename.compare(s_filename.length() - 3, 3, "mka"))
191 // test wether this file belongs to our family
192 const uint8_t *p_peek;
193 bool file_ok = false;
194 stream_t *p_file_stream = stream_UrlNew(
197 /* peek the begining */
199 stream_Peek( p_file_stream, &p_peek, 4 ) >= 4
200 && p_peek[0] == 0x1a && p_peek[1] == 0x45 &&
201 p_peek[2] == 0xdf && p_peek[3] == 0xa3 ) file_ok = true;
205 vlc_stream_io_callback *p_file_io = new vlc_stream_io_callback( p_file_stream, true );
206 EbmlStream *p_estream = new EbmlStream(*p_file_io);
208 p_stream = p_sys->AnalyseAllSegmentsFound( p_demux, p_estream );
210 if ( p_stream == NULL )
212 msg_Dbg( p_demux, "the file '%s' will not be used", s_filename.c_str() );
218 p_stream->p_in = p_file_io;
219 p_stream->p_es = p_estream;
220 p_sys->streams.push_back( p_stream );
225 if( p_file_stream ) {
226 stream_Delete( p_file_stream );
228 msg_Dbg( p_demux, "the file '%s' cannot be opened", s_filename.c_str() );
234 closedir( p_src_dir );
238 p_sys->PreloadFamily( *p_segment );
241 p_sys->PreloadLinked( p_segment );
243 if ( !p_sys->PreparePlayback( NULL ) )
245 msg_Err( p_demux, "cannot use the segment" );
249 p_sys->StartUiThread();
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;
269 /*****************************************************************************
271 *****************************************************************************/
272 static int Control( demux_t *p_demux, int i_query, va_list args )
274 demux_sys_t *p_sys = p_demux->p_sys;
281 input_attachment_t ***ppp_attach;
286 case DEMUX_GET_ATTACHMENTS:
287 ppp_attach = (input_attachment_t***)va_arg( args, input_attachment_t*** );
288 pi_int = (int*)va_arg( args, int * );
290 if( p_sys->stored_attachments.size() <= 0 )
293 *pi_int = p_sys->stored_attachments.size();
294 *ppp_attach = (input_attachment_t**)malloc( sizeof(input_attachment_t**) *
295 p_sys->stored_attachments.size() );
298 for( size_t i = 0; i < p_sys->stored_attachments.size(); i++ )
300 attachment_c *a = p_sys->stored_attachments[i];
301 (*ppp_attach)[i] = vlc_input_attachment_New( a->psz_file_name.c_str(), a->psz_mime_type.c_str(), NULL,
302 a->p_data, a->i_size );
307 p_meta = (vlc_meta_t*)va_arg( args, vlc_meta_t* );
308 vlc_meta_Merge( p_meta, p_sys->meta );
311 case DEMUX_GET_LENGTH:
312 pi64 = (int64_t*)va_arg( args, int64_t * );
313 if( p_sys->f_duration > 0.0 )
315 *pi64 = (int64_t)(p_sys->f_duration * 1000);
320 case DEMUX_GET_POSITION:
321 pf = (double*)va_arg( args, double * );
322 if ( p_sys->f_duration > 0.0 )
323 *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);
326 case DEMUX_SET_POSITION:
327 f = (double)va_arg( args, double );
328 Seek( p_demux, -1, f, NULL );
332 pi64 = (int64_t*)va_arg( args, int64_t * );
333 *pi64 = p_sys->i_pts;
336 case DEMUX_GET_TITLE_INFO:
337 if( p_sys->titles.size() > 1 || ( p_sys->titles.size() == 1 && p_sys->titles[0]->i_seekpoint > 0 ) )
339 input_title_t ***ppp_title = (input_title_t***)va_arg( args, input_title_t*** );
340 int *pi_int = (int*)va_arg( args, int* );
342 *pi_int = p_sys->titles.size();
343 *ppp_title = (input_title_t**)malloc( sizeof( input_title_t**) * p_sys->titles.size() );
345 for( size_t i = 0; i < p_sys->titles.size(); i++ )
347 (*ppp_title)[i] = vlc_input_title_Duplicate( p_sys->titles[i] );
353 case DEMUX_SET_TITLE:
354 /* TODO handle editions as titles */
355 i_idx = (int)va_arg( args, int );
356 if( i_idx < p_sys->used_segments.size() )
358 p_sys->JumpTo( *p_sys->used_segments[i_idx], NULL );
363 case DEMUX_SET_SEEKPOINT:
364 i_skp = (int)va_arg( args, int );
366 // TODO change the way it works with the << & >> buttons on the UI (+1/-1 instead of a number)
367 if( p_sys->titles.size() && i_skp < p_sys->titles[p_sys->i_current_title]->i_seekpoint)
369 Seek( p_demux, (int64_t)p_sys->titles[p_sys->i_current_title]->seekpoint[i_skp]->i_time_offset, -1, NULL);
370 p_demux->info.i_seekpoint |= INPUT_UPDATE_SEEKPOINT;
371 p_demux->info.i_seekpoint = i_skp;
377 pf = (double *)va_arg( args, double * );
379 if( p_sys->p_current_segment && p_sys->p_current_segment->Segment() )
381 const matroska_segment_c *p_segment = p_sys->p_current_segment->Segment();
382 for( size_t i = 0; i < p_segment->tracks.size(); i++ )
384 mkv_track_t *tk = p_segment->tracks[i];
385 if( tk->fmt.i_cat == VIDEO_ES && tk->fmt.video.i_frame_rate_base > 0 )
387 *pf = (double)tk->fmt.video.i_frame_rate / tk->fmt.video.i_frame_rate_base;
401 static void Seek( demux_t *p_demux, mtime_t i_date, double f_percent, chapter_item_c *psz_chapter )
403 demux_sys_t *p_sys = p_demux->p_sys;
404 virtual_segment_c *p_vsegment = p_sys->p_current_segment;
405 matroska_segment_c *p_segment = p_vsegment->Segment();
406 mtime_t i_time_offset = 0;
407 int64_t i_global_position = -1;
411 msg_Dbg( p_demux, "seek request to %"PRId64" (%f%%)", i_date, f_percent );
412 if( i_date < 0 && f_percent < 0 )
414 msg_Warn( p_demux, "cannot seek nowhere !" );
417 if( f_percent > 1.0 )
419 msg_Warn( p_demux, "cannot seek so far !" );
423 /* seek without index or without date */
424 if( f_percent >= 0 && (var_InheritInteger( p_demux, "mkv-seek-percent" ) || !p_segment->b_cues || i_date < 0 ))
426 if( p_sys->f_duration >= 0 && p_segment->b_cues )
428 i_date = int64_t( f_percent * p_sys->f_duration * 1000.0 );
432 int64_t i_pos = int64_t( f_percent * stream_Size( p_demux->s ) );
434 msg_Dbg( p_demux, "inaccurate way of seeking for pos:%"PRId64, i_pos );
435 for( i_index = 0; i_index < p_segment->i_index; i_index++ )
437 if( p_segment->b_cues && p_segment->p_indexes[i_index].i_position < i_pos )
439 if( !p_segment->b_cues && p_segment->p_indexes[i_index].i_position >= i_pos && p_segment->p_indexes[i_index].i_time > 0 )
442 if( i_index == p_segment->i_index )
447 i_date = p_segment->p_indexes[i_index].i_time;
449 if( !p_segment->b_cues && ( p_segment->p_indexes[i_index].i_position < i_pos || p_segment->p_indexes[i_index].i_position - i_pos > 2000000 ))
451 msg_Dbg( p_demux, "no cues, seek request to global pos: %"PRId64, i_pos );
452 i_global_position = i_pos;
457 p_vsegment->Seek( *p_demux, i_date, i_time_offset, psz_chapter, i_global_position );
460 /* Utility function for BlockDecode */
461 static block_t *MemToBlock( demux_t *p_demux, uint8_t *p_mem, size_t i_mem, size_t offset)
464 if( !(p_block = block_New( p_demux, i_mem + offset ) ) ) return NULL;
465 memcpy( p_block->p_buffer + offset, p_mem, i_mem );
466 //p_block->i_rate = p_input->stream.control.i_rate;
470 /* Needed by matroska_segment::Seek() and Seek */
471 void BlockDecode( demux_t *p_demux, KaxBlock *block, KaxSimpleBlock *simpleblock,
472 mtime_t i_pts, mtime_t i_duration, bool f_mandatory )
474 demux_sys_t *p_sys = p_demux->p_sys;
475 matroska_segment_c *p_segment = p_sys->p_current_segment->Segment();
481 if( p_segment->BlockFindTrackIndex( &i_track, block, simpleblock ) )
483 msg_Err( p_demux, "invalid track number" );
487 mkv_track_t *tk = p_segment->tracks[i_track];
489 if( tk->fmt.i_cat != NAV_ES && tk->p_es == NULL )
491 msg_Err( p_demux, "unknown track number" );
494 if( i_pts + i_duration < p_sys->i_start_pts && tk->fmt.i_cat == AUDIO_ES )
496 return; /* discard audio packets that shouldn't be rendered */
499 if ( tk->fmt.i_cat != NAV_ES )
501 es_out_Control( p_demux->out, ES_OUT_GET_ES_STATE, tk->p_es, &b );
505 tk->b_inited = false;
511 /* First send init data */
512 if( !tk->b_inited && tk->i_data_init > 0 )
516 msg_Dbg( p_demux, "sending header (%d bytes)", tk->i_data_init );
517 p_init = MemToBlock( p_demux, tk->p_data_init, tk->i_data_init, 0 );
518 if( p_init ) es_out_Send( p_demux->out, tk->p_es, p_init );
524 (block != NULL && i < block->NumberFrames()) || (simpleblock != NULL && i < simpleblock->NumberFrames());
529 if( simpleblock != NULL )
531 data = &simpleblock->GetBuffer(i);
532 // condition when the DTS is correct (keyframe or B frame == NOT P frame)
533 f_mandatory = simpleblock->IsDiscardable() || simpleblock->IsKeyframe();
537 data = &block->GetBuffer(i);
539 if( !data->Buffer() || data->Size() > SIZE_MAX )
542 if( tk->i_compression_type == MATROSKA_COMPRESSION_HEADER && tk->p_compression_data != NULL )
543 p_block = MemToBlock( p_demux, data->Buffer(), data->Size(), tk->p_compression_data->GetSize() );
545 p_block = MemToBlock( p_demux, data->Buffer(), data->Size(), 0 );
547 if( p_block == NULL )
552 #if defined(HAVE_ZLIB_H)
553 if( tk->i_compression_type == MATROSKA_COMPRESSION_ZLIB )
555 p_block = block_zlib_decompress( VLC_OBJECT(p_demux), p_block );
556 if( p_block == NULL )
561 if( tk->i_compression_type == MATROSKA_COMPRESSION_HEADER )
563 memcpy( p_block->p_buffer, tk->p_compression_data->GetBuffer(), tk->p_compression_data->GetSize() );
566 if ( tk->fmt.i_cat == NAV_ES )
568 // TODO handle the start/stop times of this packet
569 if ( p_sys->b_ui_hooked )
571 vlc_mutex_lock( &p_sys->p_ev->lock );
572 memcpy( &p_sys->pci_packet, &p_block->p_buffer[1], sizeof(pci_t) );
573 p_sys->SwapButtons();
574 p_sys->b_pci_packet_set = true;
575 vlc_mutex_unlock( &p_sys->p_ev->lock );
576 block_Release( p_block );
580 // correct timestamping when B frames are used
581 if( tk->fmt.i_cat != VIDEO_ES )
583 p_block->i_dts = p_block->i_pts = i_pts;
589 p_block->i_pts = VLC_TS_INVALID;
590 p_block->i_dts = i_pts;
594 p_block->i_pts = i_pts;
596 p_block->i_dts = p_block->i_pts;
598 p_block->i_dts = min( i_pts, tk->i_last_dts + (mtime_t)(tk->i_default_duration >> 10));
599 p_sys->i_pts = p_block->i_dts;
602 tk->i_last_dts = p_block->i_dts;
605 msg_Dbg( p_demux, "block i_dts: %"PRId64" / i_pts: %"PRId64, p_block->i_dts, p_block->i_pts);
607 if( strcmp( tk->psz_codec, "S_VOBSUB" ) )
609 p_block->i_length = i_duration * 1000;
612 /* FIXME remove when VLC_TS_INVALID work is done */
613 if( i == 0 || p_block->i_dts > VLC_TS_INVALID )
614 p_block->i_dts += VLC_TS_0;
615 if( !tk->b_dts_only && ( i == 0 || p_block->i_pts > VLC_TS_INVALID ) )
616 p_block->i_pts += VLC_TS_0;
618 es_out_Send( p_demux->out, tk->p_es, p_block );
620 /* use time stamp only for first block */
621 i_pts = VLC_TS_INVALID;
625 /*****************************************************************************
626 * Demux: reads and demuxes data packets
627 *****************************************************************************
628 * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
629 *****************************************************************************/
630 static int Demux( demux_t *p_demux)
632 demux_sys_t *p_sys = p_demux->p_sys;
634 vlc_mutex_lock( &p_sys->lock_demuxer );
636 virtual_segment_c *p_vsegment = p_sys->p_current_segment;
637 matroska_segment_c *p_segment = p_vsegment->Segment();
638 if ( p_segment == NULL ) return 0;
639 int i_block_count = 0;
644 if ( p_sys->demuxer.b_die )
647 if( p_sys->i_pts >= p_sys->i_start_pts )
648 if ( p_vsegment->UpdateCurrentToChapter( *p_demux ) )
654 if ( p_vsegment->Edition() && p_vsegment->Edition()->b_ordered && p_vsegment->CurrentChapter() == NULL )
656 /* nothing left to read in this ordered edition */
657 if ( !p_vsegment->SelectNext() )
659 p_segment->UnSelect( );
661 es_out_Control( p_demux->out, ES_OUT_RESET_PCR );
663 /* switch to the next segment */
664 p_segment = p_vsegment->Segment();
665 if ( !p_segment->Select( 0 ) )
667 msg_Err( p_demux, "Failed to select new segment" );
674 KaxSimpleBlock *simpleblock;
675 int64_t i_block_duration = 0;
677 bool b_discardable_picture;
678 if( p_segment->BlockGet( block, simpleblock, &b_key_picture, &b_discardable_picture, &i_block_duration ) )
680 if ( p_vsegment->Edition() && p_vsegment->Edition()->b_ordered )
682 const chapter_item_c *p_chap = p_vsegment->CurrentChapter();
683 // check if there are more chapters to read
684 if ( p_chap != NULL )
686 /* TODO handle successive chapters with the same user_start_time/user_end_time
687 if ( p_chap->i_user_start_time == p_chap->i_user_start_time )
688 p_vsegment->SelectNext();
690 p_sys->i_pts = p_chap->i_user_end_time;
691 p_sys->i_pts++; // trick to avoid staying on segments with no duration and no content
700 msg_Warn( p_demux, "cannot get block EOF?" );
701 p_segment->UnSelect( );
703 es_out_Control( p_demux->out, ES_OUT_RESET_PCR );
705 /* switch to the next segment */
706 if ( !p_vsegment->SelectNext() )
707 // no more segments in this stream
709 p_segment = p_vsegment->Segment();
710 if ( !p_segment->Select( 0 ) )
712 msg_Err( p_demux, "Failed to select new segment" );
720 if( simpleblock != NULL )
721 p_sys->i_pts = (p_sys->i_chapter_time + simpleblock->GlobalTimecode()) / (mtime_t) 1000;
723 p_sys->i_pts = (p_sys->i_chapter_time + block->GlobalTimecode()) / (mtime_t) 1000;
726 es_out_Control( p_demux->out, ES_OUT_SET_PCR, VLC_TS_0 + p_sys->i_pts );
728 if( p_sys->i_pts >= p_sys->i_start_pts )
730 if ( p_vsegment->UpdateCurrentToChapter( *p_demux ) )
738 if ( p_vsegment->Edition() && p_vsegment->Edition()->b_ordered && p_vsegment->CurrentChapter() == NULL )
740 /* nothing left to read in this ordered edition */
741 if ( !p_vsegment->SelectNext() )
746 p_segment->UnSelect( );
748 es_out_Control( p_demux->out, ES_OUT_RESET_PCR );
750 /* switch to the next segment */
751 p_segment = p_vsegment->Segment();
752 if ( !p_segment->Select( 0 ) )
754 msg_Err( p_demux, "Failed to select new segment" );
762 BlockDecode( p_demux, block, simpleblock, p_sys->i_pts, i_block_duration, b_key_picture || b_discardable_picture );
767 // TODO optimize when there is need to leave or when seeking has been called
768 if( i_block_count > 5 )
775 vlc_mutex_unlock( &p_sys->lock_demuxer );