1 /*****************************************************************************
2 * virtual_segment.cpp : virtual segment implementation in the MKV demuxer
3 *****************************************************************************
4 * Copyright © 2003-2011 VideoLAN and VLC authors
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8 * Steve Lhomme <steve.lhomme@free.fr>
9 * Denis Charmet <typx@dinauz.org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
30 matroska_segment_c * getSegmentbyUID( KaxSegmentUID * p_uid, std::vector<matroska_segment_c*> *segments )
32 for( size_t i = 0; i < (*segments).size(); i++ )
34 if( (*segments)[i]->p_segment_uid &&
35 *p_uid == *((*segments)[i]->p_segment_uid) )
36 return (*segments)[i];
41 virtual_chapter_c * virtual_chapter_c::CreateVirtualChapter( chapter_item_c * p_chap,
42 matroska_segment_c * p_main_segment,
43 std::vector<matroska_segment_c*> * segments,
44 int64_t * usertime_offset, bool b_ordered)
46 matroska_segment_c * p_segment = p_main_segment;
50 /* Dummy chapter use the whole segment */
51 return new virtual_chapter_c( p_segment, NULL, 0, p_segment->i_duration*1000 );
54 int64_t start = ( b_ordered )? *usertime_offset : p_chap->i_start_time;
55 int64_t stop = ( b_ordered )? ( *usertime_offset + p_chap->i_end_time - p_chap->i_start_time ) : p_chap->i_end_time;
57 if( p_chap->p_segment_uid &&
58 ( !( p_segment = getSegmentbyUID( (KaxSegmentUID*) p_chap->p_segment_uid,segments ) ) || !b_ordered ) )
60 msg_Warn( &p_main_segment->sys.demuxer,
61 "Couldn't find segment 0x%x or not ordered... - ignoring chapter %s",
62 *( (uint32_t *) p_chap->p_segment_uid->GetBuffer() ),p_chap->psz_name.c_str() );
67 if ( !p_segment->b_preloaded )
70 virtual_chapter_c * p_vchap = new virtual_chapter_c( p_segment, p_chap, start, stop );
75 int64_t tmp = *usertime_offset;
77 for( size_t i = 0; i < p_chap->sub_chapters.size(); i++ )
79 virtual_chapter_c * p_vsubchap = CreateVirtualChapter( p_chap->sub_chapters[i], p_segment, segments, &tmp, b_ordered );
82 p_vchap->sub_chapters.push_back( p_vsubchap );
85 if( tmp == *usertime_offset )
86 *usertime_offset += p_chap->i_end_time - p_chap->i_start_time;
88 *usertime_offset = tmp;
90 msg_Dbg( &p_main_segment->sys.demuxer,
91 "Virtual chapter %s from %"PRId64" to %"PRId64" - " ,
92 p_chap->psz_name.c_str(), p_vchap->i_virtual_start_time, p_vchap->i_virtual_stop_time );
97 virtual_chapter_c::~virtual_chapter_c()
99 for( size_t i = 0 ; i < sub_chapters.size(); i++ )
100 delete sub_chapters[i];
104 virtual_edition_c::virtual_edition_c( chapter_edition_c * p_edit, std::vector<matroska_segment_c*> *opened_segments)
106 bool b_fake_ordered = false;
107 matroska_segment_c *p_main_segment = (*opened_segments)[0];
111 int64_t usertime_offset = 0;
113 /* ordered chapters */
114 if( p_edition && p_edition->b_ordered )
117 for( size_t i = 0; i < p_edition->sub_chapters.size(); i++ )
119 virtual_chapter_c * p_vchap = virtual_chapter_c::CreateVirtualChapter( p_edition->sub_chapters[i],
120 p_main_segment, opened_segments,
121 &usertime_offset, b_ordered );
123 chapters.push_back( p_vchap );
125 i_duration = chapters[ chapters.size() - 1 ]->i_virtual_stop_time;
127 else /* Not ordered or no edition at all */
129 matroska_segment_c * p_cur = p_main_segment;
130 virtual_chapter_c * p_vchap = NULL;
133 /* check for prev linked segments */
134 /* FIXME to avoid infinite recursion we limit to 10 prev should be better as parameter */
135 for( int limit = 0; limit < 10 && p_cur->p_prev_segment_uid ; limit++ )
137 matroska_segment_c * p_prev = NULL;
138 if( ( p_prev = getSegmentbyUID( p_cur->p_prev_segment_uid, opened_segments ) ) )
141 msg_Dbg( &p_main_segment->sys.demuxer, "Prev segment 0x%x found\n",
142 *(int32_t*)p_cur->p_prev_segment_uid->GetBuffer() );
144 /* Preload segment */
145 if ( !p_prev->b_preloaded )
148 /* Create virtual_chapter from the first edition if any */
149 chapter_item_c * p_chap = ( p_prev->stored_editions.size() > 0 )? ((chapter_item_c *)p_prev->stored_editions[0]) : NULL;
151 p_vchap = virtual_chapter_c::CreateVirtualChapter( p_chap, p_prev, opened_segments, &tmp, b_ordered );
154 chapters.insert( chapters.begin(), p_vchap );
157 b_fake_ordered = true;
159 else /* segment not found */
165 /* Append the main segment */
166 p_vchap = virtual_chapter_c::CreateVirtualChapter( (chapter_item_c*) p_edit, p_main_segment,
167 opened_segments, &tmp, b_ordered );
169 chapters.push_back( p_vchap );
171 /* Append next linked segments */
172 for( int limit = 0; limit < 10 && p_cur->p_next_segment_uid; limit++ )
174 matroska_segment_c * p_next = NULL;
175 if( ( p_next = getSegmentbyUID( p_cur->p_next_segment_uid, opened_segments ) ) )
178 msg_Dbg( &p_main_segment->sys.demuxer, "Next segment 0x%x found\n",
179 *(int32_t*) p_cur->p_next_segment_uid->GetBuffer() );
181 /* Preload segment */
182 if ( !p_next->b_preloaded )
185 /* Create virtual_chapter from the first edition if any */
186 chapter_item_c * p_chap = ( p_next->stored_editions.size() > 0 )?( (chapter_item_c *)p_next->stored_editions[0] ) : NULL;
188 p_vchap = virtual_chapter_c::CreateVirtualChapter( p_chap, p_next, opened_segments, &tmp, b_ordered );
191 chapters.push_back( p_vchap );
195 b_fake_ordered = true;
197 else /* segment not found */
201 /* Retime chapters */
208 msg_Dbg( &p_main_segment->sys.demuxer, "-- RECAP-BEGIN --" );
210 msg_Dbg( &p_main_segment->sys.demuxer, "-- RECAP-END --" );
214 virtual_edition_c::~virtual_edition_c()
216 for( size_t i = 0; i < chapters.size(); i++ )
220 void virtual_edition_c::retimeSubChapters( virtual_chapter_c * p_vchap )
222 int64_t stop_time = p_vchap->i_virtual_stop_time;
223 for( size_t i = p_vchap->sub_chapters.size(); i-- > 0; )
225 virtual_chapter_c * p_vsubchap = p_vchap->sub_chapters[i];
226 p_vsubchap->i_virtual_start_time += p_vchap->i_virtual_start_time;
228 /*FIXME we artificially extend stop time if they were there before...*/
229 /* Just for comfort*/
230 p_vsubchap->i_virtual_stop_time = stop_time;
231 stop_time = p_vsubchap->i_virtual_start_time;
233 retimeSubChapters( p_vsubchap );
237 void virtual_edition_c::retimeChapters()
239 /* This function is just meant to be used on unordered chapters */
245 /* On non ordered editions we have one top chapter == one segment */
246 for( size_t i = 0; i < chapters.size(); i++ )
248 virtual_chapter_c * p_vchap = chapters[i];
250 p_vchap->i_virtual_start_time = i_duration;
251 i_duration += p_vchap->p_segment->i_duration * 1000;
252 p_vchap->i_virtual_stop_time = i_duration;
254 retimeSubChapters( p_vchap );
258 virtual_segment_c::virtual_segment_c( std::vector<matroska_segment_c*> * p_opened_segments )
261 matroska_segment_c *p_segment = (*p_opened_segments)[0];
262 i_current_edition = 0;
264 p_current_chapter = NULL;
266 for( size_t i = 0; i < p_segment->stored_editions.size(); i++ )
268 /* Get the default edition, if non use the first one */
269 if( p_segment->stored_editions[i]->b_default )
270 i_current_edition = i;
272 /* Create a virtual edition from opened */
273 virtual_edition_c * p_vedition = new virtual_edition_c( p_segment->stored_editions[i], p_opened_segments );
275 /*FIXME if p_vedition failed...*/
277 editions.push_back( p_vedition );
279 /*if we don't have edition create a dummy one*/
280 if( !p_segment->stored_editions.size() )
282 virtual_edition_c * p_vedition = new virtual_edition_c( NULL, p_opened_segments );
283 editions.push_back( p_vedition );
286 /* Set current chapter */
287 p_current_chapter = editions[i_current_edition]->getChapterbyTimecode(0);
291 virtual_segment_c::~virtual_segment_c()
293 for( size_t i = 0; i < editions.size(); i++ )
297 virtual_chapter_c *virtual_segment_c::BrowseCodecPrivate( unsigned int codec_id,
298 bool (*match)(const chapter_codec_cmds_c &data, const void *p_cookie, size_t i_cookie_size ),
299 const void *p_cookie,
300 size_t i_cookie_size )
302 virtual_edition_c * p_ved = CurrentEdition();
304 return p_ved->BrowseCodecPrivate( codec_id, match, p_cookie, i_cookie_size );
310 virtual_chapter_c * virtual_edition_c::BrowseCodecPrivate( unsigned int codec_id,
311 bool (*match)(const chapter_codec_cmds_c &data, const void *p_cookie, size_t i_cookie_size ),
312 const void *p_cookie,
313 size_t i_cookie_size )
318 for( size_t i = 0; i < chapters.size(); i++ )
320 virtual_chapter_c * p_result = chapters[i]->BrowseCodecPrivate( codec_id, match, p_cookie, i_cookie_size );
329 virtual_chapter_c * virtual_chapter_c::BrowseCodecPrivate( unsigned int codec_id,
330 bool (*match)(const chapter_codec_cmds_c &data, const void *p_cookie, size_t i_cookie_size ),
331 const void *p_cookie,
332 size_t i_cookie_size )
337 if( p_chapter->BrowseCodecPrivate( codec_id, match, p_cookie, i_cookie_size ) )
340 for( size_t i = 0; i < sub_chapters.size(); i++ )
342 virtual_chapter_c * p_result = sub_chapters[i]->BrowseCodecPrivate( codec_id, match, p_cookie, i_cookie_size );
349 virtual_chapter_c* virtual_chapter_c::getSubChapterbyTimecode( int64_t time )
351 for( size_t i = 0; i < sub_chapters.size(); i++ )
353 if( time >= sub_chapters[i]->i_virtual_start_time && time < sub_chapters[i]->i_virtual_stop_time )
354 return sub_chapters[i]->getSubChapterbyTimecode( time );
360 virtual_chapter_c* virtual_edition_c::getChapterbyTimecode( int64_t time )
362 for( size_t i = 0; i < chapters.size(); i++ )
364 if( time >= chapters[i]->i_virtual_start_time &&
365 ( chapters[i]->i_virtual_stop_time < 0 || time < chapters[i]->i_virtual_stop_time ) )
366 /*with the current implementation only the last chapter can have a negative virtual_stop_time*/
367 return chapters[i]->getSubChapterbyTimecode( time );
373 bool virtual_segment_c::UpdateCurrentToChapter( demux_t & demux )
375 demux_sys_t & sys = *demux.p_sys;
376 virtual_chapter_c *p_cur_chapter;
377 virtual_edition_c * p_cur_edition = editions[ i_current_edition ];
379 bool b_has_seeked = false;
381 p_cur_chapter = p_cur_edition->getChapterbyTimecode( sys.i_pts );
383 /* we have moved to a new chapter */
384 if ( p_cur_chapter != NULL && p_current_chapter != p_cur_chapter )
386 msg_Dbg( &demux, "NEW CHAPTER %"PRId64, sys.i_pts );
387 if ( p_cur_edition->b_ordered )
389 /* FIXME EnterAndLeave has probably been broken for a long time */
390 // Leave/Enter up to the link point
391 b_has_seeked = p_cur_chapter->EnterAndLeave( p_current_chapter );
394 // only physically seek if necessary
395 if ( p_current_chapter == NULL ||
396 ( p_current_chapter && p_current_chapter->p_segment != p_cur_chapter->p_segment ) ||
397 ( p_current_chapter->p_chapter->i_end_time != p_cur_chapter->p_chapter->i_start_time ))
399 Seek( demux, p_cur_chapter->i_virtual_start_time, 0, p_cur_chapter, -1 );
403 sys.i_start_pts = p_cur_chapter->i_virtual_start_time;;
406 p_current_chapter = p_cur_chapter;
407 if ( p_cur_chapter->i_seekpoint_num > 0 )
409 demux.info.i_update |= INPUT_UPDATE_TITLE | INPUT_UPDATE_SEEKPOINT;
410 demux.info.i_title = sys.i_current_title = i_sys_title;
411 demux.info.i_seekpoint = p_cur_chapter->i_seekpoint_num - 1;
416 else if ( p_cur_chapter == NULL )
418 /* out of the scope of the data described by chapters, leave the edition */
419 if ( p_cur_edition->b_ordered && p_current_chapter != NULL )
422 if ( !p_cur_edition->p_edition->EnterAndLeave( p_current_chapter->p_chapter, false ) )
423 p_current_chapter = NULL;
431 bool virtual_chapter_c::EnterAndLeave( virtual_chapter_c *p_item, bool b_enter )
436 return p_chapter->EnterAndLeave( p_item->p_chapter, b_enter );
439 void virtual_segment_c::Seek( demux_t & demuxer, mtime_t i_date, mtime_t i_time_offset,
440 virtual_chapter_c *p_chapter, int64_t i_global_position )
442 demux_sys_t *p_sys = demuxer.p_sys;
445 /* find the actual time for an ordered edition */
446 if ( p_chapter == NULL )
447 /* 1st, we need to know in which chapter we are */
448 p_chapter = editions[ i_current_edition ]->getChapterbyTimecode( i_date );
450 if ( p_chapter != NULL )
452 i_time_offset = p_chapter->i_virtual_start_time - ( ( p_chapter->p_chapter )? p_chapter->p_chapter->i_start_time : 0 );
453 p_sys->i_chapter_time = i_time_offset - p_chapter->p_segment->i_start_time;
454 if ( p_chapter->p_chapter && p_chapter->i_seekpoint_num > 0 )
456 demuxer.info.i_update |= INPUT_UPDATE_TITLE | INPUT_UPDATE_SEEKPOINT;
457 demuxer.info.i_title = p_sys->i_current_title = i_sys_title;
458 demuxer.info.i_seekpoint = p_chapter->i_seekpoint_num - 1;
461 if( p_current_chapter->p_segment != p_chapter->p_segment )
463 p_chapter->p_segment->Select( i_date );
464 p_current_chapter->p_segment->UnSelect();
466 p_current_chapter = p_chapter;
468 p_chapter->p_segment->Seek( i_date, i_time_offset, i_global_position );
472 virtual_chapter_c * virtual_chapter_c::FindChapter( int64_t i_find_uid )
474 if( p_chapter && ( p_chapter->i_uid == i_find_uid ) )
477 for( size_t i = 0; i < sub_chapters.size(); i++ )
479 virtual_chapter_c * p_res = sub_chapters[i]->FindChapter( i_find_uid );
487 virtual_chapter_c * virtual_segment_c::FindChapter( int64_t i_find_uid )
489 virtual_edition_c * p_edition = editions[i_current_edition];
491 for( size_t i = 0; p_edition->chapters.size(); i++ )
493 virtual_chapter_c * p_chapter = p_edition->chapters[i]->FindChapter( i_find_uid );
500 int virtual_chapter_c::PublishChapters( input_title_t & title, int & i_user_chapters, int i_level )
502 if ( p_chapter && ( !p_chapter->b_display_seekpoint || p_chapter->psz_name == "" ) )
504 p_chapter->psz_name = p_chapter->GetCodecName();
505 if ( p_chapter->psz_name != "" )
506 p_chapter->b_display_seekpoint = true;
509 if ( ( p_chapter && p_chapter->b_display_seekpoint &&
510 ( ( sub_chapters.size() > 0 && i_virtual_start_time != sub_chapters[0]->i_virtual_start_time) ||
511 sub_chapters.size() == 0 ) ) || !p_chapter )
513 seekpoint_t *sk = vlc_seekpoint_New();
515 sk->i_time_offset = i_virtual_start_time;
517 sk->psz_name = strdup( p_chapter->psz_name.c_str() );
519 sk->psz_name = strdup("dummy chapter");
521 /* A start time of '0' is ok. A missing ChapterTime element is ok, too, because '0' is its default value. */
523 title.seekpoint = (seekpoint_t**)xrealloc( title.seekpoint,
524 title.i_seekpoint * sizeof( seekpoint_t* ) );
525 title.seekpoint[title.i_seekpoint-1] = sk;
527 if ( (p_chapter && p_chapter->b_user_display ) || !p_chapter )
530 i_seekpoint_num = i_user_chapters;
532 for( size_t i = 0; i < sub_chapters.size(); i++ )
533 sub_chapters[i]->PublishChapters( title, i_user_chapters, i_level + 1 );
535 return i_user_chapters;
539 int virtual_edition_c::PublishChapters( input_title_t & title, int & i_user_chapters, int i_level )
542 /* HACK for now don't expose edition as a seekpoint if its start time is the same than it's first chapter */
543 if( chapters.size() > 0 &&
544 chapters[0]->i_virtual_start_time && p_edition )
546 seekpoint_t *sk = vlc_seekpoint_New();
548 sk->i_time_offset = 0;
549 sk->psz_name = strdup( p_edition->psz_name.c_str() );
552 title.seekpoint = (seekpoint_t**)xrealloc( title.seekpoint,
553 title.i_seekpoint * sizeof( seekpoint_t* ) );
554 title.seekpoint[title.i_seekpoint - 1] = sk;
558 i_seekpoint_num = i_user_chapters;
561 // if( chapters.size() > 1 )
562 for( size_t i = 0; i < chapters.size(); i++ )
563 chapters[i]->PublishChapters( title, i_user_chapters, i_level );
565 return i_user_chapters;
568 std::string virtual_edition_c::GetMainName()
571 return p_edition->GetMainName();
573 return std::string("");
576 bool virtual_chapter_c::Enter( bool b_do_subs )
579 return p_chapter->Enter( b_do_subs );
583 bool virtual_chapter_c::Leave( bool b_do_subs )
586 return p_chapter->Leave( b_do_subs );
591 void virtual_chapter_c::print()
593 msg_Dbg( &p_segment->sys.demuxer, "*** chapter %"PRId64" - %"PRId64" (%u)",
594 i_virtual_start_time, i_virtual_stop_time, sub_chapters.size() );
595 for( size_t i = 0; i < sub_chapters.size(); i++ )
596 sub_chapters[i]->print();