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 "text_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_change (ChangeType type, weak_ptr<Content> content, int property, bool frequent)
70 if (type == CHANGE_TYPE_DONE) {
72 property == ContentProperty::TRIM_START ||
73 property == ContentProperty::TRIM_END ||
74 property == ContentProperty::LENGTH ||
75 property == VideoContentProperty::FRAME_TYPE
77 /* Don't respond to position changes here, as:
78 - sequencing after earlier/later changes is handled by move_earlier/move_later
79 - any other position changes will be timeline drags which should not result in content
86 property == ContentProperty::POSITION ||
87 property == ContentProperty::LENGTH ||
88 property == ContentProperty::TRIM_START ||
89 property == ContentProperty::TRIM_END) {
91 ContentList old = _content;
92 sort (_content.begin(), _content.end(), ContentSorter ());
93 if (_content != old) {
99 ContentChange (type, content, property, frequent);
103 Playlist::maybe_sequence ()
105 if (!_sequence || _sequencing) {
111 /* Keep track of the content that we've set the position of so that we don't
120 BOOST_FOREACH (shared_ptr<Content> i, _content) {
125 if (i->video->frame_type() == VIDEO_FRAME_TYPE_3D_RIGHT) {
126 i->set_position (next_right);
127 next_right = i->end();
129 i->set_position (next_left);
130 next_left = i->end();
133 placed.push_back (i);
139 BOOST_FOREACH (shared_ptr<Content> i, _content) {
140 if (i->text.empty() || find (placed.begin(), placed.end(), i) != placed.end()) {
144 i->set_position (next);
149 /* This won't change order, so it does not need a sort */
155 Playlist::video_identifier () const
159 BOOST_FOREACH (shared_ptr<const Content> i, _content) {
161 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
166 if (i->video || burn) {
167 t += i->identifier ();
172 digester.add (t.c_str(), t.length());
173 return digester.get ();
176 /** @param film Film that this Playlist is for.
177 * @param node <Playlist> node.
178 * @param version Metadata version number.
179 * @param notes Output notes about that happened.
182 Playlist::set_from_xml (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version, list<string>& notes)
184 BOOST_FOREACH (cxml::NodePtr i, node->node_children ("Content")) {
185 _content.push_back (content_factory (film, i, version, notes));
188 /* This shouldn't be necessary but better safe than sorry (there could be old files) */
189 sort (_content.begin(), _content.end(), ContentSorter ());
194 /** @param node <Playlist> node.
195 * @param with_content_paths true to include <Path> nodes in <Content> nodes, false to omit them.
198 Playlist::as_xml (xmlpp::Node* node, bool with_content_paths)
200 BOOST_FOREACH (shared_ptr<Content> i, _content) {
201 i->as_xml (node->add_child ("Content"), with_content_paths);
206 Playlist::add (shared_ptr<Content> c)
208 Change (CHANGE_TYPE_PENDING);
209 _content.push_back (c);
210 sort (_content.begin(), _content.end(), ContentSorter ());
212 Change (CHANGE_TYPE_DONE);
216 Playlist::remove (shared_ptr<Content> c)
218 Change (CHANGE_TYPE_PENDING);
220 ContentList::iterator i = _content.begin ();
221 while (i != _content.end() && *i != c) {
225 if (i != _content.end ()) {
227 Change (CHANGE_TYPE_DONE);
229 Change (CHANGE_TYPE_CANCELLED);
232 /* This won't change order, so it does not need a sort */
236 Playlist::remove (ContentList c)
238 Change (CHANGE_TYPE_PENDING);
240 BOOST_FOREACH (shared_ptr<Content> i, c) {
241 ContentList::iterator j = _content.begin ();
242 while (j != _content.end() && *j != i) {
246 if (j != _content.end ()) {
251 /* This won't change order, so it does not need a sort */
253 Change (CHANGE_TYPE_DONE);
256 class FrameRateCandidate
259 FrameRateCandidate (float source_, int dcp_)
269 Playlist::best_video_frame_rate () const
271 list<int> const allowed_dcp_frame_rates = Config::instance()->allowed_dcp_frame_rates ();
273 /* Work out what rates we could manage, including those achieved by using skip / repeat */
274 list<FrameRateCandidate> candidates;
276 /* Start with the ones without skip / repeat so they will get matched in preference to skipped/repeated ones */
277 for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
278 candidates.push_back (FrameRateCandidate (*i, *i));
281 /* Then the skip/repeat ones */
282 for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
283 candidates.push_back (FrameRateCandidate (float (*i) / 2, *i));
284 candidates.push_back (FrameRateCandidate (float (*i) * 2, *i));
287 /* Pick the best one */
288 float error = std::numeric_limits<float>::max ();
289 optional<FrameRateCandidate> best;
290 list<FrameRateCandidate>::iterator i = candidates.begin();
291 while (i != candidates.end()) {
293 float this_error = 0;
294 BOOST_FOREACH (shared_ptr<Content> j, _content) {
295 if (!j->video || !j->video_frame_rate()) {
299 /* Best error for this content; we could use the content as-is or double its rate */
300 float best_error = min (
301 float (fabs (i->source - j->video_frame_rate().get())),
302 float (fabs (i->source - j->video_frame_rate().get() * 2))
305 /* Use the largest difference between DCP and source as the "error" */
306 this_error = max (this_error, best_error);
309 if (this_error < error) {
324 /** @return length of the playlist from time 0 to the last thing on the playlist */
326 Playlist::length () const
329 BOOST_FOREACH (shared_ptr<const Content> i, _content) {
330 len = max (len, i->end());
336 /** @return position of the first thing on the playlist, if it's not empty */
338 Playlist::start () const
340 if (_content.empty ()) {
341 return optional<DCPTime> ();
344 DCPTime start = DCPTime::max ();
345 BOOST_FOREACH (shared_ptr<Content> i, _content) {
346 start = min (start, i->position ());
353 Playlist::reconnect ()
355 for (list<boost::signals2::connection>::iterator i = _content_connections.begin(); i != _content_connections.end(); ++i) {
359 _content_connections.clear ();
361 BOOST_FOREACH (shared_ptr<Content> i, _content) {
362 _content_connections.push_back (i->Change.connect(boost::bind(&Playlist::content_change, this, _1, _2, _3, _4)));
367 Playlist::video_end () const
370 BOOST_FOREACH (shared_ptr<Content> i, _content) {
372 end = max (end, i->end ());
380 Playlist::text_end () const
383 BOOST_FOREACH (shared_ptr<Content> i, _content) {
384 if (!i->text.empty ()) {
385 end = max (end, i->end ());
393 Playlist::active_frame_rate_change (DCPTime t, int dcp_video_frame_rate) const
395 for (ContentList::const_reverse_iterator i = _content.rbegin(); i != _content.rend(); ++i) {
400 if ((*i)->position() <= t) {
401 /* This is the first piece of content (going backwards...) that starts before t,
402 so it's the active one.
404 if ((*i)->video_frame_rate ()) {
405 /* This content specified a rate, so use it */
406 return FrameRateChange ((*i)->video_frame_rate().get(), dcp_video_frame_rate);
408 /* No specified rate so just use the DCP one */
409 return FrameRateChange (dcp_video_frame_rate, dcp_video_frame_rate);
414 return FrameRateChange (dcp_video_frame_rate, dcp_video_frame_rate);
418 Playlist::set_sequence (bool s)
424 ContentSorter::operator() (shared_ptr<Content> a, shared_ptr<Content> b)
426 if (a->position() != b->position()) {
427 return a->position() < b->position();
430 /* Put video before audio if they start at the same time */
431 if (a->video && !b->video) {
433 } else if (!a->video && b->video) {
438 return a->digest() < b->digest();
441 /** @return content in ascending order of position */
443 Playlist::content () const
449 Playlist::repeat (ContentList c, int n)
451 pair<DCPTime, DCPTime> range (DCPTime::max (), DCPTime ());
452 BOOST_FOREACH (shared_ptr<Content> i, c) {
453 range.first = min (range.first, i->position ());
454 range.second = max (range.second, i->position ());
455 range.first = min (range.first, i->end ());
456 range.second = max (range.second, i->end ());
459 Change (CHANGE_TYPE_PENDING);
461 DCPTime pos = range.second;
462 for (int i = 0; i < n; ++i) {
463 BOOST_FOREACH (shared_ptr<Content> j, c) {
464 shared_ptr<Content> copy = j->clone ();
465 copy->set_position (pos + copy->position() - range.first);
466 _content.push_back (copy);
468 pos += range.second - range.first;
471 sort (_content.begin(), _content.end(), ContentSorter ());
474 Change (CHANGE_TYPE_DONE);
478 Playlist::move_earlier (shared_ptr<Content> c)
480 ContentList::iterator previous = _content.end ();
481 ContentList::iterator i = _content.begin();
482 while (i != _content.end() && *i != c) {
487 DCPOMATIC_ASSERT (i != _content.end ());
488 if (previous == _content.end ()) {
492 shared_ptr<Content> previous_c = *previous;
494 DCPTime const p = previous_c->position ();
495 previous_c->set_position (p + c->length_after_trim ());
500 Playlist::move_later (shared_ptr<Content> c)
502 ContentList::iterator i = _content.begin();
503 while (i != _content.end() && *i != c) {
507 DCPOMATIC_ASSERT (i != _content.end ());
509 ContentList::iterator next = i;
512 if (next == _content.end ()) {
516 shared_ptr<Content> next_c = *next;
518 next_c->set_position (c->position ());
519 c->set_position (c->position() + next_c->length_after_trim ());
523 Playlist::required_disk_space (int j2k_bandwidth, int audio_channels, int audio_frame_rate) const
525 int64_t video = uint64_t (j2k_bandwidth / 8) * length().seconds ();
526 int64_t audio = uint64_t (audio_channels * audio_frame_rate * 3) * length().seconds ();
528 BOOST_FOREACH (shared_ptr<Content> i, _content) {
529 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (i);
531 if (d->reference_video()) {
532 video -= uint64_t (j2k_bandwidth / 8) * d->length_after_trim().seconds();
534 if (d->reference_audio()) {
535 audio -= uint64_t (audio_channels * audio_frame_rate * 3) * d->length_after_trim().seconds();
540 /* Add on 64k for bits and pieces (metadata, subs etc) */
541 return video + audio + 65536;
545 Playlist::content_summary (DCPTimePeriod period) const
549 BOOST_FOREACH (shared_ptr<Content> i, _content) {
551 optional<DCPTimePeriod> const o = DCPTimePeriod(i->position(), i->end()).overlap (period);
553 score += 100 * o.get().duration().get() / period.duration().get();
560 if (score > best_score) {
561 best_summary = i->path(0).leaf().string();
570 Playlist::speed_up_range (int dcp_video_frame_rate) const
572 pair<double, double> range (DBL_MAX, -DBL_MAX);
574 BOOST_FOREACH (shared_ptr<Content> i, _content) {
578 if (i->video_frame_rate()) {
579 FrameRateChange const frc (i->video_frame_rate().get(), dcp_video_frame_rate);
580 range.first = min (range.first, frc.speed_up);
581 range.second = max (range.second, frc.speed_up);
583 FrameRateChange const frc (dcp_video_frame_rate, dcp_video_frame_rate);
584 range.first = min (range.first, frc.speed_up);
585 range.second = max (range.second, frc.speed_up);