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 node <Playlist> node */
164 Playlist::set_from_xml (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version, list<string>& notes)
166 BOOST_FOREACH (cxml::NodePtr i, node->node_children ("Content")) {
167 _content.push_back (content_factory (film, i, version, notes));
170 /* This shouldn't be necessary but better safe than sorry (there could be old files) */
171 sort (_content.begin(), _content.end(), ContentSorter ());
176 /** @param node <Playlist> node */
178 Playlist::as_xml (xmlpp::Node* node, bool with_content_paths)
180 BOOST_FOREACH (shared_ptr<Content> i, _content) {
181 i->as_xml (node->add_child ("Content"), with_content_paths);
186 Playlist::add (shared_ptr<Content> c)
188 _content.push_back (c);
189 sort (_content.begin(), _content.end(), ContentSorter ());
195 Playlist::remove (shared_ptr<Content> c)
197 ContentList::iterator i = _content.begin ();
198 while (i != _content.end() && *i != c) {
202 if (i != _content.end ()) {
207 /* This won't change order, so it does not need a sort */
211 Playlist::remove (ContentList c)
213 BOOST_FOREACH (shared_ptr<Content> i, c) {
214 ContentList::iterator j = _content.begin ();
215 while (j != _content.end() && *j != i) {
219 if (j != _content.end ()) {
224 /* This won't change order, so it does not need a sort */
229 class FrameRateCandidate
232 FrameRateCandidate (float source_, int dcp_)
242 Playlist::best_video_frame_rate () const
244 list<int> const allowed_dcp_frame_rates = Config::instance()->allowed_dcp_frame_rates ();
246 /* Work out what rates we could manage, including those achieved by using skip / repeat */
247 list<FrameRateCandidate> candidates;
249 /* Start with the ones without skip / repeat so they will get matched in preference to skipped/repeated ones */
250 for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
251 candidates.push_back (FrameRateCandidate (*i, *i));
254 /* Then the skip/repeat ones */
255 for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
256 candidates.push_back (FrameRateCandidate (float (*i) / 2, *i));
257 candidates.push_back (FrameRateCandidate (float (*i) * 2, *i));
260 /* Pick the best one */
261 float error = std::numeric_limits<float>::max ();
262 optional<FrameRateCandidate> best;
263 list<FrameRateCandidate>::iterator i = candidates.begin();
264 while (i != candidates.end()) {
266 float this_error = 0;
267 BOOST_FOREACH (shared_ptr<Content> j, _content) {
268 if (!j->video || !j->video_frame_rate()) {
272 /* Best error for this content; we could use the content as-is or double its rate */
273 float best_error = min (
274 float (fabs (i->source - j->video_frame_rate().get())),
275 float (fabs (i->source - j->video_frame_rate().get() * 2))
278 /* Use the largest difference between DCP and source as the "error" */
279 this_error = max (this_error, best_error);
282 if (this_error < error) {
297 /** @return length of the playlist from time 0 to the last thing on the playlist */
299 Playlist::length () const
302 BOOST_FOREACH (shared_ptr<const Content> i, _content) {
303 len = max (len, i->end());
309 /** @return position of the first thing on the playlist, if it's not empty */
311 Playlist::start () const
313 if (_content.empty ()) {
314 return optional<DCPTime> ();
317 DCPTime start = DCPTime::max ();
318 BOOST_FOREACH (shared_ptr<Content> i, _content) {
319 start = min (start, i->position ());
326 Playlist::reconnect ()
328 for (list<boost::signals2::connection>::iterator i = _content_connections.begin(); i != _content_connections.end(); ++i) {
332 _content_connections.clear ();
334 BOOST_FOREACH (shared_ptr<Content> i, _content) {
335 _content_connections.push_back (i->Changed.connect (bind (&Playlist::content_changed, this, _1, _2, _3)));
340 Playlist::video_end () const
343 BOOST_FOREACH (shared_ptr<Content> i, _content) {
345 end = max (end, i->end ());
353 Playlist::subtitle_end () const
356 BOOST_FOREACH (shared_ptr<Content> i, _content) {
358 end = max (end, i->end ());
366 Playlist::active_frame_rate_change (DCPTime t, int dcp_video_frame_rate) const
368 for (ContentList::const_reverse_iterator i = _content.rbegin(); i != _content.rend(); ++i) {
373 if ((*i)->position() <= t) {
374 /* This is the first piece of content (going backwards...) that starts before t,
375 so it's the active one.
377 if ((*i)->video_frame_rate ()) {
378 /* This content specified a rate, so use it */
379 return FrameRateChange ((*i)->video_frame_rate().get(), dcp_video_frame_rate);
381 /* No specified rate so just use the DCP one */
382 return FrameRateChange (dcp_video_frame_rate, dcp_video_frame_rate);
387 return FrameRateChange (dcp_video_frame_rate, dcp_video_frame_rate);
391 Playlist::set_sequence (bool s)
397 ContentSorter::operator() (shared_ptr<Content> a, shared_ptr<Content> b)
399 if (a->position() != b->position()) {
400 return a->position() < b->position();
403 /* Put video before audio if they start at the same time */
404 if (a->video && !b->video) {
406 } else if (!a->video && b->video) {
411 return a->digest() < b->digest();
414 /** @return content in ascending order of position */
416 Playlist::content () const
422 Playlist::repeat (ContentList c, int n)
424 pair<DCPTime, DCPTime> range (DCPTime::max (), DCPTime ());
425 BOOST_FOREACH (shared_ptr<Content> i, c) {
426 range.first = min (range.first, i->position ());
427 range.second = max (range.second, i->position ());
428 range.first = min (range.first, i->end ());
429 range.second = max (range.second, i->end ());
432 DCPTime pos = range.second;
433 for (int i = 0; i < n; ++i) {
434 BOOST_FOREACH (shared_ptr<Content> j, c) {
435 shared_ptr<Content> copy = j->clone ();
436 copy->set_position (pos + copy->position() - range.first);
437 _content.push_back (copy);
439 pos += range.second - range.first;
442 sort (_content.begin(), _content.end(), ContentSorter ());
449 Playlist::move_earlier (shared_ptr<Content> c)
451 ContentList::iterator previous = _content.end ();
452 ContentList::iterator i = _content.begin();
453 while (i != _content.end() && *i != c) {
458 DCPOMATIC_ASSERT (i != _content.end ());
459 if (previous == _content.end ()) {
463 shared_ptr<Content> previous_c = *previous;
465 DCPTime const p = previous_c->position ();
466 previous_c->set_position (p + c->length_after_trim ());
471 Playlist::move_later (shared_ptr<Content> c)
473 ContentList::iterator i = _content.begin();
474 while (i != _content.end() && *i != c) {
478 DCPOMATIC_ASSERT (i != _content.end ());
480 ContentList::iterator next = i;
483 if (next == _content.end ()) {
487 shared_ptr<Content> next_c = *next;
489 next_c->set_position (c->position ());
490 c->set_position (c->position() + next_c->length_after_trim ());
494 Playlist::required_disk_space (int j2k_bandwidth, int audio_channels, int audio_frame_rate) const
496 int64_t video = uint64_t (j2k_bandwidth / 8) * length().seconds ();
497 int64_t audio = uint64_t (audio_channels * audio_frame_rate * 3) * length().seconds ();
499 BOOST_FOREACH (shared_ptr<Content> i, _content) {
500 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (i);
502 if (d->reference_video()) {
503 video -= uint64_t (j2k_bandwidth / 8) * d->length_after_trim().seconds();
505 if (d->reference_audio()) {
506 audio -= uint64_t (audio_channels * audio_frame_rate * 3) * d->length_after_trim().seconds();
511 /* Add on 64k for bits and pieces (metadata, subs etc) */
512 return video + audio + 65536;
516 Playlist::content_summary (DCPTimePeriod period) const
520 BOOST_FOREACH (shared_ptr<Content> i, _content) {
522 optional<DCPTimePeriod> const o = DCPTimePeriod(i->position(), i->end()).overlap (period);
524 score += 100 * o.get().duration().get() / period.duration().get();
531 if (score > best_score) {
532 best_summary = i->path(0).leaf().string();