2 Copyright (C) 2013-2018 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
22 #include "video_content.h"
23 #include "caption_content.h"
24 #include "ffmpeg_decoder.h"
25 #include "ffmpeg_content.h"
26 #include "image_decoder.h"
27 #include "audio_content.h"
28 #include "content_factory.h"
29 #include "dcp_content.h"
34 #include <libcxml/cxml.h>
35 #include <libxml++/libxml++.h>
36 #include <boost/shared_ptr.hpp>
37 #include <boost/foreach.hpp>
49 using boost::optional;
50 using boost::shared_ptr;
51 using boost::weak_ptr;
52 using boost::dynamic_pointer_cast;
61 Playlist::~Playlist ()
68 Playlist::content_changed (weak_ptr<Content> content, int property, bool frequent)
71 property == ContentProperty::TRIM_START ||
72 property == ContentProperty::TRIM_END ||
73 property == ContentProperty::LENGTH ||
74 property == VideoContentProperty::FRAME_TYPE
76 /* Don't respond to position changes here, as:
77 - sequencing after earlier/later changes is handled by move_earlier/move_later
78 - any other position changes will be timeline drags which should not result in content
85 property == ContentProperty::POSITION ||
86 property == ContentProperty::LENGTH ||
87 property == ContentProperty::TRIM_START ||
88 property == ContentProperty::TRIM_END) {
90 ContentList old = _content;
91 sort (_content.begin(), _content.end(), ContentSorter ());
92 if (_content != old) {
97 ContentChanged (content, property, frequent);
101 Playlist::maybe_sequence ()
103 if (!_sequence || _sequencing) {
109 /* Keep track of the content that we've set the position of so that we don't
118 BOOST_FOREACH (shared_ptr<Content> i, _content) {
123 if (i->video->frame_type() == VIDEO_FRAME_TYPE_3D_RIGHT) {
124 i->set_position (next_right);
125 next_right = i->end();
127 i->set_position (next_left);
128 next_left = i->end();
131 placed.push_back (i);
137 BOOST_FOREACH (shared_ptr<Content> i, _content) {
138 if (!i->caption || find (placed.begin(), placed.end(), i) != placed.end()) {
142 i->set_position (next);
147 /* This won't change order, so it does not need a sort */
153 Playlist::video_identifier () const
157 BOOST_FOREACH (shared_ptr<const Content> i, _content) {
158 if (i->video || (i->caption && i->caption->burn())) {
159 t += i->identifier ();
164 digester.add (t.c_str(), t.length());
165 return digester.get ();
168 /** @param film Film that this Playlist is for.
169 * @param node <Playlist> node.
170 * @param version Metadata version number.
171 * @param notes Output notes about that happened.
174 Playlist::set_from_xml (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version, list<string>& notes)
176 BOOST_FOREACH (cxml::NodePtr i, node->node_children ("Content")) {
177 _content.push_back (content_factory (film, i, version, notes));
180 /* This shouldn't be necessary but better safe than sorry (there could be old files) */
181 sort (_content.begin(), _content.end(), ContentSorter ());
186 /** @param node <Playlist> node.
187 * @param with_content_paths true to include <Path> nodes in <Content> nodes, false to omit them.
190 Playlist::as_xml (xmlpp::Node* node, bool with_content_paths)
192 BOOST_FOREACH (shared_ptr<Content> i, _content) {
193 i->as_xml (node->add_child ("Content"), with_content_paths);
198 Playlist::add (shared_ptr<Content> c)
200 _content.push_back (c);
201 sort (_content.begin(), _content.end(), ContentSorter ());
207 Playlist::remove (shared_ptr<Content> c)
209 ContentList::iterator i = _content.begin ();
210 while (i != _content.end() && *i != c) {
214 if (i != _content.end ()) {
219 /* This won't change order, so it does not need a sort */
223 Playlist::remove (ContentList c)
225 BOOST_FOREACH (shared_ptr<Content> i, c) {
226 ContentList::iterator j = _content.begin ();
227 while (j != _content.end() && *j != i) {
231 if (j != _content.end ()) {
236 /* This won't change order, so it does not need a sort */
241 class FrameRateCandidate
244 FrameRateCandidate (float source_, int dcp_)
254 Playlist::best_video_frame_rate () const
256 list<int> const allowed_dcp_frame_rates = Config::instance()->allowed_dcp_frame_rates ();
258 /* Work out what rates we could manage, including those achieved by using skip / repeat */
259 list<FrameRateCandidate> candidates;
261 /* Start with the ones without skip / repeat so they will get matched in preference to skipped/repeated ones */
262 for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
263 candidates.push_back (FrameRateCandidate (*i, *i));
266 /* Then the skip/repeat ones */
267 for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
268 candidates.push_back (FrameRateCandidate (float (*i) / 2, *i));
269 candidates.push_back (FrameRateCandidate (float (*i) * 2, *i));
272 /* Pick the best one */
273 float error = std::numeric_limits<float>::max ();
274 optional<FrameRateCandidate> best;
275 list<FrameRateCandidate>::iterator i = candidates.begin();
276 while (i != candidates.end()) {
278 float this_error = 0;
279 BOOST_FOREACH (shared_ptr<Content> j, _content) {
280 if (!j->video || !j->video_frame_rate()) {
284 /* Best error for this content; we could use the content as-is or double its rate */
285 float best_error = min (
286 float (fabs (i->source - j->video_frame_rate().get())),
287 float (fabs (i->source - j->video_frame_rate().get() * 2))
290 /* Use the largest difference between DCP and source as the "error" */
291 this_error = max (this_error, best_error);
294 if (this_error < error) {
309 /** @return length of the playlist from time 0 to the last thing on the playlist */
311 Playlist::length () const
314 BOOST_FOREACH (shared_ptr<const Content> i, _content) {
315 len = max (len, i->end());
321 /** @return position of the first thing on the playlist, if it's not empty */
323 Playlist::start () const
325 if (_content.empty ()) {
326 return optional<DCPTime> ();
329 DCPTime start = DCPTime::max ();
330 BOOST_FOREACH (shared_ptr<Content> i, _content) {
331 start = min (start, i->position ());
338 Playlist::reconnect ()
340 for (list<boost::signals2::connection>::iterator i = _content_connections.begin(); i != _content_connections.end(); ++i) {
344 _content_connections.clear ();
346 BOOST_FOREACH (shared_ptr<Content> i, _content) {
347 _content_connections.push_back (i->Changed.connect (bind (&Playlist::content_changed, this, _1, _2, _3)));
352 Playlist::video_end () const
355 BOOST_FOREACH (shared_ptr<Content> i, _content) {
357 end = max (end, i->end ());
365 Playlist::subtitle_end () const
368 BOOST_FOREACH (shared_ptr<Content> i, _content) {
370 end = max (end, i->end ());
378 Playlist::active_frame_rate_change (DCPTime t, int dcp_video_frame_rate) const
380 for (ContentList::const_reverse_iterator i = _content.rbegin(); i != _content.rend(); ++i) {
385 if ((*i)->position() <= t) {
386 /* This is the first piece of content (going backwards...) that starts before t,
387 so it's the active one.
389 if ((*i)->video_frame_rate ()) {
390 /* This content specified a rate, so use it */
391 return FrameRateChange ((*i)->video_frame_rate().get(), dcp_video_frame_rate);
393 /* No specified rate so just use the DCP one */
394 return FrameRateChange (dcp_video_frame_rate, dcp_video_frame_rate);
399 return FrameRateChange (dcp_video_frame_rate, dcp_video_frame_rate);
403 Playlist::set_sequence (bool s)
409 ContentSorter::operator() (shared_ptr<Content> a, shared_ptr<Content> b)
411 if (a->position() != b->position()) {
412 return a->position() < b->position();
415 /* Put video before audio if they start at the same time */
416 if (a->video && !b->video) {
418 } else if (!a->video && b->video) {
423 return a->digest() < b->digest();
426 /** @return content in ascending order of position */
428 Playlist::content () const
434 Playlist::repeat (ContentList c, int n)
436 pair<DCPTime, DCPTime> range (DCPTime::max (), DCPTime ());
437 BOOST_FOREACH (shared_ptr<Content> i, c) {
438 range.first = min (range.first, i->position ());
439 range.second = max (range.second, i->position ());
440 range.first = min (range.first, i->end ());
441 range.second = max (range.second, i->end ());
444 DCPTime pos = range.second;
445 for (int i = 0; i < n; ++i) {
446 BOOST_FOREACH (shared_ptr<Content> j, c) {
447 shared_ptr<Content> copy = j->clone ();
448 copy->set_position (pos + copy->position() - range.first);
449 _content.push_back (copy);
451 pos += range.second - range.first;
454 sort (_content.begin(), _content.end(), ContentSorter ());
461 Playlist::move_earlier (shared_ptr<Content> c)
463 ContentList::iterator previous = _content.end ();
464 ContentList::iterator i = _content.begin();
465 while (i != _content.end() && *i != c) {
470 DCPOMATIC_ASSERT (i != _content.end ());
471 if (previous == _content.end ()) {
475 shared_ptr<Content> previous_c = *previous;
477 DCPTime const p = previous_c->position ();
478 previous_c->set_position (p + c->length_after_trim ());
483 Playlist::move_later (shared_ptr<Content> c)
485 ContentList::iterator i = _content.begin();
486 while (i != _content.end() && *i != c) {
490 DCPOMATIC_ASSERT (i != _content.end ());
492 ContentList::iterator next = i;
495 if (next == _content.end ()) {
499 shared_ptr<Content> next_c = *next;
501 next_c->set_position (c->position ());
502 c->set_position (c->position() + next_c->length_after_trim ());
506 Playlist::required_disk_space (int j2k_bandwidth, int audio_channels, int audio_frame_rate) const
508 int64_t video = uint64_t (j2k_bandwidth / 8) * length().seconds ();
509 int64_t audio = uint64_t (audio_channels * audio_frame_rate * 3) * length().seconds ();
511 BOOST_FOREACH (shared_ptr<Content> i, _content) {
512 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (i);
514 if (d->reference_video()) {
515 video -= uint64_t (j2k_bandwidth / 8) * d->length_after_trim().seconds();
517 if (d->reference_audio()) {
518 audio -= uint64_t (audio_channels * audio_frame_rate * 3) * d->length_after_trim().seconds();
523 /* Add on 64k for bits and pieces (metadata, subs etc) */
524 return video + audio + 65536;
528 Playlist::content_summary (DCPTimePeriod period) const
532 BOOST_FOREACH (shared_ptr<Content> i, _content) {
534 optional<DCPTimePeriod> const o = DCPTimePeriod(i->position(), i->end()).overlap (period);
536 score += 100 * o.get().duration().get() / period.duration().get();
543 if (score > best_score) {
544 best_summary = i->path(0).leaf().string();
553 Playlist::speed_up_range (int dcp_video_frame_rate) const
555 pair<double, double> range (DBL_MAX, -DBL_MAX);
557 BOOST_FOREACH (shared_ptr<Content> i, _content) {
561 if (i->video_frame_rate()) {
562 FrameRateChange const frc (i->video_frame_rate().get(), dcp_video_frame_rate);
563 range.first = min (range.first, frc.speed_up);
564 range.second = max (range.second, frc.speed_up);
566 FrameRateChange const frc (dcp_video_frame_rate, dcp_video_frame_rate);
567 range.first = min (range.first, frc.speed_up);
568 range.second = max (range.second, frc.speed_up);