2 Copyright (C) 2013-2016 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 "subtitle_content.h"
24 #include "ffmpeg_decoder.h"
25 #include "ffmpeg_content.h"
26 #include "image_decoder.h"
27 #include "content_factory.h"
28 #include "dcp_content.h"
33 #include <libcxml/cxml.h>
34 #include <libxml++/libxml++.h>
35 #include <boost/shared_ptr.hpp>
36 #include <boost/foreach.hpp>
48 using boost::optional;
49 using boost::shared_ptr;
50 using boost::weak_ptr;
51 using boost::dynamic_pointer_cast;
60 Playlist::~Playlist ()
67 Playlist::content_changed (weak_ptr<Content> content, int property, bool frequent)
69 if (property == ContentProperty::LENGTH || property == VideoContentProperty::FRAME_TYPE) {
70 /* Don't respond to position changes here, as:
71 - sequencing after earlier/later changes is handled by move_earlier/move_later
72 - any other position changes will be timeline drags which should not result in content
79 property == ContentProperty::POSITION ||
80 property == ContentProperty::LENGTH ||
81 property == ContentProperty::TRIM_START ||
82 property == ContentProperty::TRIM_END) {
84 ContentList old = _content;
85 sort (_content.begin(), _content.end(), ContentSorter ());
86 if (_content != old) {
91 ContentChanged (content, property, frequent);
95 Playlist::maybe_sequence ()
97 if (!_sequence || _sequencing) {
103 /* Keep track of the content that we've set the position of so that we don't
112 BOOST_FOREACH (shared_ptr<Content> i, _content) {
117 if (i->video->frame_type() == VIDEO_FRAME_TYPE_3D_RIGHT) {
118 i->set_position (next_right);
119 next_right = i->end();
121 i->set_position (next_left);
122 next_left = i->end();
125 placed.push_back (i);
131 BOOST_FOREACH (shared_ptr<Content> i, _content) {
132 if (!i->subtitle || find (placed.begin(), placed.end(), i) != placed.end()) {
136 i->set_position (next);
141 /* This won't change order, so it does not need a sort */
147 Playlist::video_identifier () const
151 BOOST_FOREACH (shared_ptr<const Content> i, _content) {
152 if (i->video || (i->subtitle && i->subtitle->burn())) {
153 t += i->identifier ();
158 digester.add (t.c_str(), t.length());
159 return digester.get ();
162 /** @param film Film that this Playlist is for.
163 * @param node <Playlist> node.
164 * @param version Metadata version number.
165 * @param notes Output notes about that happened.
168 Playlist::set_from_xml (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version, list<string>& notes)
170 BOOST_FOREACH (cxml::NodePtr i, node->node_children ("Content")) {
171 _content.push_back (content_factory (film, i, version, notes));
174 /* This shouldn't be necessary but better safe than sorry (there could be old files) */
175 sort (_content.begin(), _content.end(), ContentSorter ());
180 /** @param node <Playlist> node.
181 * @param with_content_paths true to include <Path> nodes in <Content> nodes, false to omit them.
184 Playlist::as_xml (xmlpp::Node* node, bool with_content_paths)
186 BOOST_FOREACH (shared_ptr<Content> i, _content) {
187 i->as_xml (node->add_child ("Content"), with_content_paths);
192 Playlist::add (shared_ptr<Content> c)
194 _content.push_back (c);
195 sort (_content.begin(), _content.end(), ContentSorter ());
201 Playlist::remove (shared_ptr<Content> c)
203 ContentList::iterator i = _content.begin ();
204 while (i != _content.end() && *i != c) {
208 if (i != _content.end ()) {
213 /* This won't change order, so it does not need a sort */
217 Playlist::remove (ContentList c)
219 BOOST_FOREACH (shared_ptr<Content> i, c) {
220 ContentList::iterator j = _content.begin ();
221 while (j != _content.end() && *j != i) {
225 if (j != _content.end ()) {
230 /* This won't change order, so it does not need a sort */
235 class FrameRateCandidate
238 FrameRateCandidate (float source_, int dcp_)
248 Playlist::best_video_frame_rate () const
250 list<int> const allowed_dcp_frame_rates = Config::instance()->allowed_dcp_frame_rates ();
252 /* Work out what rates we could manage, including those achieved by using skip / repeat */
253 list<FrameRateCandidate> candidates;
255 /* Start with the ones without skip / repeat so they will get matched in preference to skipped/repeated ones */
256 for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
257 candidates.push_back (FrameRateCandidate (*i, *i));
260 /* Then the skip/repeat ones */
261 for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
262 candidates.push_back (FrameRateCandidate (float (*i) / 2, *i));
263 candidates.push_back (FrameRateCandidate (float (*i) * 2, *i));
266 /* Pick the best one */
267 float error = std::numeric_limits<float>::max ();
268 optional<FrameRateCandidate> best;
269 list<FrameRateCandidate>::iterator i = candidates.begin();
270 while (i != candidates.end()) {
272 float this_error = 0;
273 BOOST_FOREACH (shared_ptr<Content> j, _content) {
274 if (!j->video || !j->video_frame_rate()) {
278 /* Best error for this content; we could use the content as-is or double its rate */
279 float best_error = min (
280 float (fabs (i->source - j->video_frame_rate().get())),
281 float (fabs (i->source - j->video_frame_rate().get() * 2))
284 /* Use the largest difference between DCP and source as the "error" */
285 this_error = max (this_error, best_error);
288 if (this_error < error) {
303 /** @return length of the playlist from time 0 to the last thing on the playlist */
305 Playlist::length () const
308 BOOST_FOREACH (shared_ptr<const Content> i, _content) {
309 len = max (len, i->end());
315 /** @return position of the first thing on the playlist, if it's not empty */
317 Playlist::start () const
319 if (_content.empty ()) {
320 return optional<DCPTime> ();
323 DCPTime start = DCPTime::max ();
324 BOOST_FOREACH (shared_ptr<Content> i, _content) {
325 start = min (start, i->position ());
332 Playlist::reconnect ()
334 for (list<boost::signals2::connection>::iterator i = _content_connections.begin(); i != _content_connections.end(); ++i) {
338 _content_connections.clear ();
340 BOOST_FOREACH (shared_ptr<Content> i, _content) {
341 _content_connections.push_back (i->Changed.connect (bind (&Playlist::content_changed, this, _1, _2, _3)));
346 Playlist::video_end () const
349 BOOST_FOREACH (shared_ptr<Content> i, _content) {
351 end = max (end, i->end ());
359 Playlist::subtitle_end () const
362 BOOST_FOREACH (shared_ptr<Content> i, _content) {
364 end = max (end, i->end ());
372 Playlist::active_frame_rate_change (DCPTime t, int dcp_video_frame_rate) const
374 for (ContentList::const_reverse_iterator i = _content.rbegin(); i != _content.rend(); ++i) {
379 if ((*i)->position() <= t) {
380 /* This is the first piece of content (going backwards...) that starts before t,
381 so it's the active one.
383 if ((*i)->video_frame_rate ()) {
384 /* This content specified a rate, so use it */
385 return FrameRateChange ((*i)->video_frame_rate().get(), dcp_video_frame_rate);
387 /* No specified rate so just use the DCP one */
388 return FrameRateChange (dcp_video_frame_rate, dcp_video_frame_rate);
393 return FrameRateChange (dcp_video_frame_rate, dcp_video_frame_rate);
397 Playlist::set_sequence (bool s)
403 ContentSorter::operator() (shared_ptr<Content> a, shared_ptr<Content> b)
405 if (a->position() != b->position()) {
406 return a->position() < b->position();
409 /* Put video before audio if they start at the same time */
410 if (a->video && !b->video) {
412 } else if (!a->video && b->video) {
417 return a->digest() < b->digest();
420 /** @return content in ascending order of position */
422 Playlist::content () const
428 Playlist::repeat (ContentList c, int n)
430 pair<DCPTime, DCPTime> range (DCPTime::max (), DCPTime ());
431 BOOST_FOREACH (shared_ptr<Content> i, c) {
432 range.first = min (range.first, i->position ());
433 range.second = max (range.second, i->position ());
434 range.first = min (range.first, i->end ());
435 range.second = max (range.second, i->end ());
438 DCPTime pos = range.second;
439 for (int i = 0; i < n; ++i) {
440 BOOST_FOREACH (shared_ptr<Content> j, c) {
441 shared_ptr<Content> copy = j->clone ();
442 copy->set_position (pos + copy->position() - range.first);
443 _content.push_back (copy);
445 pos += range.second - range.first;
448 sort (_content.begin(), _content.end(), ContentSorter ());
455 Playlist::move_earlier (shared_ptr<Content> c)
457 ContentList::iterator previous = _content.end ();
458 ContentList::iterator i = _content.begin();
459 while (i != _content.end() && *i != c) {
464 DCPOMATIC_ASSERT (i != _content.end ());
465 if (previous == _content.end ()) {
469 shared_ptr<Content> previous_c = *previous;
471 DCPTime const p = previous_c->position ();
472 previous_c->set_position (p + c->length_after_trim ());
477 Playlist::move_later (shared_ptr<Content> c)
479 ContentList::iterator i = _content.begin();
480 while (i != _content.end() && *i != c) {
484 DCPOMATIC_ASSERT (i != _content.end ());
486 ContentList::iterator next = i;
489 if (next == _content.end ()) {
493 shared_ptr<Content> next_c = *next;
495 next_c->set_position (c->position ());
496 c->set_position (c->position() + next_c->length_after_trim ());
500 Playlist::required_disk_space (int j2k_bandwidth, int audio_channels, int audio_frame_rate) const
502 int64_t video = uint64_t (j2k_bandwidth / 8) * length().seconds ();
503 int64_t audio = uint64_t (audio_channels * audio_frame_rate * 3) * length().seconds ();
505 BOOST_FOREACH (shared_ptr<Content> i, _content) {
506 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (i);
508 if (d->reference_video()) {
509 video -= uint64_t (j2k_bandwidth / 8) * d->length_after_trim().seconds();
511 if (d->reference_audio()) {
512 audio -= uint64_t (audio_channels * audio_frame_rate * 3) * d->length_after_trim().seconds();
517 /* Add on 64k for bits and pieces (metadata, subs etc) */
518 return video + audio + 65536;
522 Playlist::content_summary (DCPTimePeriod period) const
526 BOOST_FOREACH (shared_ptr<Content> i, _content) {
528 optional<DCPTimePeriod> const o = DCPTimePeriod(i->position(), i->end()).overlap (period);
530 score += 100 * o.get().duration().get() / period.duration().get();
537 if (score > best_score) {
538 best_summary = i->path(0).leaf().string();
547 Playlist::video_content_at (DCPTime time) const
549 BOOST_FOREACH (shared_ptr<Content> i, _content) {
550 if (i->video && i->position() <= time && time < i->end()) {