X-Git-Url: https://git.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Fplaylist.cc;h=c18a438821b9a91fd0e4e23b7d629363e81216f0;hp=f03f8a9a1747eb7fcd061c2c4f078ce93a598ec5;hb=182b9d2e2feb6545592868606aaf0f0146095481;hpb=6f344b876689a1234a5eb75041882f06f5d9fe5c diff --git a/src/lib/playlist.cc b/src/lib/playlist.cc index f03f8a9a1..c18a43882 100644 --- a/src/lib/playlist.cc +++ b/src/lib/playlist.cc @@ -1,98 +1,128 @@ /* - Copyright (C) 2013-2016 Carl Hetherington + Copyright (C) 2013-2021 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of DCP-o-matic. + + DCP-o-matic is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - This program is distributed in the hope that it will be useful, + DCP-o-matic is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + along with DCP-o-matic. If not, see . */ -#include "playlist.h" -#include "sndfile_content.h" -#include "sndfile_decoder.h" -#include "video_content.h" -#include "ffmpeg_decoder.h" -#include "ffmpeg_content.h" -#include "image_decoder.h" + +#include "audio_content.h" +#include "compose.hpp" +#include "config.h" #include "content_factory.h" #include "dcp_content.h" +#include "digester.h" +#include "ffmpeg_content.h" +#include "ffmpeg_decoder.h" +#include "image_decoder.h" #include "job.h" -#include "config.h" +#include "playlist.h" +#include "text_content.h" #include "util.h" -#include "md5_digester.h" +#include "video_content.h" #include #include -#include -#include +#include #include #include "i18n.h" -using std::list; + using std::cout; -using std::vector; -using std::min; +using std::dynamic_pointer_cast; +using std::list; using std::max; -using std::string; +using std::min; using std::pair; +using std::shared_ptr; +using std::string; +using std::vector; +using std::weak_ptr; using boost::optional; -using boost::shared_ptr; -using boost::weak_ptr; -using boost::dynamic_pointer_cast; +using namespace dcpomatic; +#if BOOST_VERSION >= 106100 +using namespace boost::placeholders; +#endif + Playlist::Playlist () - : _sequence (true) - , _sequencing (false) { } + Playlist::~Playlist () { + boost::mutex::scoped_lock lm (_mutex); _content.clear (); - reconnect (); + disconnect (); } + void -Playlist::content_changed (weak_ptr content, int property, bool frequent) +Playlist::content_change (weak_ptr weak_film, ChangeType type, weak_ptr content, int property, bool frequent) { - if (property == ContentProperty::LENGTH || property == VideoContentProperty::VIDEO_FRAME_TYPE) { - /* Don't respond to position changes here, as: - - sequencing after earlier/later changes is handled by move_earlier/move_later - - any other position changes will be timeline drags which should not result in content - being sequenced. - */ - maybe_sequence (); - } - - if ( - property == ContentProperty::POSITION || - property == ContentProperty::LENGTH || - property == ContentProperty::TRIM_START || - property == ContentProperty::TRIM_END) { - - ContentList old = _content; - sort (_content.begin(), _content.end(), ContentSorter ()); - if (_content != old) { - OrderChanged (); + auto film = weak_film.lock (); + DCPOMATIC_ASSERT (film); + + if (type == ChangeType::DONE) { + if ( + property == ContentProperty::TRIM_START || + property == ContentProperty::TRIM_END || + property == ContentProperty::LENGTH || + property == VideoContentProperty::FRAME_TYPE + ) { + /* Don't respond to position changes here, as: + - sequencing after earlier/later changes is handled by move_earlier/move_later + - any other position changes will be timeline drags which should not result in content + being sequenced. + */ + maybe_sequence (film); + } + + if ( + property == ContentProperty::POSITION || + property == ContentProperty::LENGTH || + property == ContentProperty::TRIM_START || + property == ContentProperty::TRIM_END) { + + bool changed = false; + + { + boost::mutex::scoped_lock lm (_mutex); + ContentList old = _content; + sort (_content.begin(), _content.end(), ContentSorter ()); + changed = _content != old; + } + + if (changed) { + OrderChange (); + } + + /* The length might have changed, and that's good enough for this signal */ + LengthChange (); } } - ContentChanged (content, property, frequent); + ContentChange (type, content, property, frequent); } + void -Playlist::maybe_sequence () +Playlist::maybe_sequence (shared_ptr film) { if (!_sequence || _sequencing) { return; @@ -100,6 +130,8 @@ Playlist::maybe_sequence () _sequencing = true; + auto cont = content (); + /* Keep track of the content that we've set the position of so that we don't do it twice. */ @@ -109,33 +141,32 @@ Playlist::maybe_sequence () DCPTime next_left; DCPTime next_right; - BOOST_FOREACH (shared_ptr i, _content) { + for (auto i: cont) { if (!i->video) { continue; } - if (i->video->video_frame_type() == VIDEO_FRAME_TYPE_3D_RIGHT) { - i->set_position (next_right); - next_right = i->end(); + if (i->video->frame_type() == VideoFrameType::THREE_D_RIGHT) { + i->set_position (film, next_right); + next_right = i->end(film); } else { - i->set_position (next_left); - next_left = i->end(); + i->set_position (film, next_left); + next_left = i->end(film); } placed.push_back (i); } - /* Subtitles */ + /* Captions */ DCPTime next; - BOOST_FOREACH (shared_ptr i, _content) { - shared_ptr sc = dynamic_pointer_cast (i); - if (!sc || !sc->has_subtitles() || find (placed.begin(), placed.end(), i) != placed.end()) { + for (auto i: cont) { + if (i->text.empty() || find (placed.begin(), placed.end(), i) != placed.end()) { continue; } - sc->set_position (next); - next = sc->end(); + i->set_position (film, next); + next = i->end(film); } @@ -144,93 +175,185 @@ Playlist::maybe_sequence () _sequencing = false; } + string Playlist::video_identifier () const { string t; - BOOST_FOREACH (shared_ptr i, _content) { - shared_ptr vc = dynamic_pointer_cast (i); - shared_ptr sc = dynamic_pointer_cast (i); - if (vc) { - t += vc->identifier (); - } else if (sc && sc->burn_subtitles ()) { - t += sc->identifier (); + for (auto i: content()) { + bool burn = false; + for (auto j: i->text) { + if (j->burn()) { + burn = true; + } + } + if (i->video || burn) { + t += i->identifier (); } } - MD5Digester digester; + Digester digester; digester.add (t.c_str(), t.length()); return digester.get (); } -/** @param node node */ + +/** @param film Film that this Playlist is for. + * @param node <Playlist> node. + * @param version Metadata version number. + * @param notes Output notes about that happened. + */ void Playlist::set_from_xml (shared_ptr film, cxml::ConstNodePtr node, int version, list& notes) { - BOOST_FOREACH (cxml::NodePtr i, node->node_children ("Content")) { - _content.push_back (content_factory (film, i, version, notes)); + boost::mutex::scoped_lock lm (_mutex); + + for (auto i: node->node_children ("Content")) { + auto content = content_factory (i, version, notes); + + /* See if this content should be nudged to start on a video frame */ + auto const old_pos = content->position(); + content->set_position(film, old_pos); + if (old_pos != content->position()) { + string note = _("Your project contains video content that was not aligned to a frame boundary."); + note += " "; + if (old_pos < content->position()) { + note += String::compose( + _("The file %1 has been moved %2 milliseconds later."), + content->path_summary(), DCPTime(content->position() - old_pos).seconds() * 1000 + ); + } else { + note += String::compose( + _("The file %1 has been moved %2 milliseconds earlier."), + content->path_summary(), DCPTime(content->position() - old_pos).seconds() * 1000 + ); + } + notes.push_back (note); + } + + /* ...or have a start trim which is an integer number of frames */ + auto const old_trim = content->trim_start(); + content->set_trim_start(old_trim); + if (old_trim != content->trim_start()) { + string note = _("Your project contains video content whose trim was not aligned to a frame boundary."); + note += " "; + if (old_trim < content->trim_start()) { + note += String::compose( + _("The file %1 has been trimmed by %2 milliseconds more."), + content->path_summary(), ContentTime(content->trim_start() - old_trim).seconds() * 1000 + ); + } else { + note += String::compose( + _("The file %1 has been trimmed by %2 milliseconds less."), + content->path_summary(), ContentTime(old_trim - content->trim_start()).seconds() * 1000 + ); + } + notes.push_back (note); + } + + _content.push_back (content); } /* This shouldn't be necessary but better safe than sorry (there could be old files) */ sort (_content.begin(), _content.end(), ContentSorter ()); - reconnect (); + reconnect (film); } -/** @param node node */ + +/** @param node <Playlist> node. + * @param with_content_paths true to include <Path> nodes in <Content> nodes, false to omit them. + */ void -Playlist::as_xml (xmlpp::Node* node) +Playlist::as_xml (xmlpp::Node* node, bool with_content_paths) { - BOOST_FOREACH (shared_ptr i, _content) { - i->as_xml (node->add_child ("Content")); + for (auto i: content()) { + i->as_xml (node->add_child ("Content"), with_content_paths); } } + void -Playlist::add (shared_ptr c) +Playlist::add (shared_ptr film, shared_ptr c) { - _content.push_back (c); - sort (_content.begin(), _content.end(), ContentSorter ()); - reconnect (); - Changed (); + Change (ChangeType::PENDING); + + { + boost::mutex::scoped_lock lm (_mutex); + _content.push_back (c); + sort (_content.begin(), _content.end(), ContentSorter ()); + reconnect (film); + } + + Change (ChangeType::DONE); + + LengthChange (); } + void Playlist::remove (shared_ptr c) { - ContentList::iterator i = _content.begin (); - while (i != _content.end() && *i != c) { - ++i; + Change (ChangeType::PENDING); + + bool cancelled = false; + + { + boost::mutex::scoped_lock lm (_mutex); + + auto i = _content.begin (); + while (i != _content.end() && *i != c) { + ++i; + } + + if (i != _content.end()) { + _content.erase (i); + } else { + cancelled = true; + } } - if (i != _content.end ()) { - _content.erase (i); - Changed (); + if (cancelled) { + Change (ChangeType::CANCELLED); + } else { + Change (ChangeType::DONE); } /* This won't change order, so it does not need a sort */ + + LengthChange (); } + void Playlist::remove (ContentList c) { - BOOST_FOREACH (shared_ptr i, c) { - ContentList::iterator j = _content.begin (); - while (j != _content.end() && *j != i) { - ++j; - } + Change (ChangeType::PENDING); + + { + boost::mutex::scoped_lock lm (_mutex); + + for (auto i: c) { + auto j = _content.begin (); + while (j != _content.end() && *j != i) { + ++j; + } - if (j != _content.end ()) { - _content.erase (j); + if (j != _content.end ()) { + _content.erase (j); + } } } + Change (ChangeType::DONE); + /* This won't change order, so it does not need a sort */ - Changed (); + LengthChange (); } + class FrameRateCandidate { public: @@ -243,41 +366,43 @@ public: int dcp; }; + +/** @return the best frame rate from Config::_allowed_dcp_frame_rates for the content in this list */ int -Playlist::best_dcp_frame_rate () const +Playlist::best_video_frame_rate () const { - list const allowed_dcp_frame_rates = Config::instance()->allowed_dcp_frame_rates (); + auto const allowed_dcp_frame_rates = Config::instance()->allowed_dcp_frame_rates (); /* Work out what rates we could manage, including those achieved by using skip / repeat */ list candidates; /* Start with the ones without skip / repeat so they will get matched in preference to skipped/repeated ones */ - for (list::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) { - candidates.push_back (FrameRateCandidate (*i, *i)); + for (auto i: allowed_dcp_frame_rates) { + candidates.push_back (FrameRateCandidate(i, i)); } /* Then the skip/repeat ones */ - for (list::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) { - candidates.push_back (FrameRateCandidate (float (*i) / 2, *i)); - candidates.push_back (FrameRateCandidate (float (*i) * 2, *i)); + for (auto i: allowed_dcp_frame_rates) { + candidates.push_back (FrameRateCandidate (float(i) / 2, i)); + candidates.push_back (FrameRateCandidate (float(i) * 2, i)); } /* Pick the best one */ float error = std::numeric_limits::max (); optional best; - list::iterator i = candidates.begin(); + auto i = candidates.begin(); while (i != candidates.end()) { float this_error = 0; - BOOST_FOREACH (shared_ptr j, _content) { - if (!j->video || !j->video->has_own_video_frame_rate()) { + for (auto j: content()) { + if (!j->video || !j->video_frame_rate()) { continue; } /* Best error for this content; we could use the content as-is or double its rate */ float best_error = min ( - float (fabs (i->source - j->video->video_frame_rate ())), - float (fabs (i->source - j->video->video_frame_rate () * 2)) + float (fabs (i->source - j->video_frame_rate().get())), + float (fabs (i->source - j->video_frame_rate().get() * 2)) ); /* Use the largest difference between DCP and source as the "error" */ @@ -299,78 +424,95 @@ Playlist::best_dcp_frame_rate () const return best->dcp; } + /** @return length of the playlist from time 0 to the last thing on the playlist */ DCPTime -Playlist::length () const +Playlist::length (shared_ptr film) const { DCPTime len; - BOOST_FOREACH (shared_ptr i, _content) { - len = max (len, i->end()); + for (auto i: content()) { + len = max (len, i->end(film)); } return len; } + /** @return position of the first thing on the playlist, if it's not empty */ optional Playlist::start () const { - if (_content.empty ()) { - return optional (); + auto cont = content (); + if (cont.empty()) { + return {}; } - DCPTime start = DCPTime::max (); - BOOST_FOREACH (shared_ptr i, _content) { + auto start = DCPTime::max (); + for (auto i: cont) { start = min (start, i->position ()); } return start; } + +/** Must be called with a lock held on _mutex */ void -Playlist::reconnect () +Playlist::disconnect () { - for (list::iterator i = _content_connections.begin(); i != _content_connections.end(); ++i) { - i->disconnect (); + for (auto& i: _content_connections) { + i.disconnect (); } _content_connections.clear (); +} - BOOST_FOREACH (shared_ptr i, _content) { - _content_connections.push_back (i->Changed.connect (bind (&Playlist::content_changed, this, _1, _2, _3))); + +/** Must be called with a lock held on _mutex */ +void +Playlist::reconnect (shared_ptr film) +{ + disconnect (); + + for (auto i: _content) { + _content_connections.push_back (i->Change.connect(boost::bind(&Playlist::content_change, this, film, _1, _2, _3, _4))); } } + DCPTime -Playlist::video_end () const +Playlist::video_end (shared_ptr film) const { DCPTime end; - BOOST_FOREACH (shared_ptr i, _content) { - if (dynamic_pointer_cast (i)) { - end = max (end, i->end ()); + for (auto i: content()) { + if (i->video) { + end = max (end, i->end(film)); } } return end; } + DCPTime -Playlist::subtitle_end () const +Playlist::text_end (shared_ptr film) const { DCPTime end; - BOOST_FOREACH (shared_ptr i, _content) { - if (dynamic_pointer_cast (i)) { - end = max (end, i->end ()); + for (auto i: content()) { + if (!i->text.empty ()) { + end = max (end, i->end(film)); } } return end; } + FrameRateChange Playlist::active_frame_rate_change (DCPTime t, int dcp_video_frame_rate) const { - for (ContentList::const_reverse_iterator i = _content.rbegin(); i != _content.rend(); ++i) { + auto cont = content (); + for (ContentList::const_reverse_iterator i = cont.rbegin(); i != cont.rend(); ++i) { if (!(*i)->video) { continue; } @@ -379,19 +521,27 @@ Playlist::active_frame_rate_change (DCPTime t, int dcp_video_frame_rate) const /* This is the first piece of content (going backwards...) that starts before t, so it's the active one. */ - return FrameRateChange ((*i)->video->video_frame_rate(), dcp_video_frame_rate); + if ((*i)->video_frame_rate ()) { + /* This content specified a rate, so use it */ + return FrameRateChange ((*i)->video_frame_rate().get(), dcp_video_frame_rate); + } else { + /* No specified rate so just use the DCP one */ + return FrameRateChange (dcp_video_frame_rate, dcp_video_frame_rate); + } } } return FrameRateChange (dcp_video_frame_rate, dcp_video_frame_rate); } + void Playlist::set_sequence (bool s) { _sequence = s; } + bool ContentSorter::operator() (shared_ptr a, shared_ptr b) { @@ -410,99 +560,113 @@ ContentSorter::operator() (shared_ptr a, shared_ptr b) return a->digest() < b->digest(); } + /** @return content in ascending order of position */ ContentList Playlist::content () const { + boost::mutex::scoped_lock lm (_mutex); return _content; } + void -Playlist::repeat (ContentList c, int n) +Playlist::repeat (shared_ptr film, ContentList c, int n) { - pair range (DCPTime::max (), DCPTime ()); - BOOST_FOREACH (shared_ptr i, c) { + pair range (DCPTime::max(), DCPTime()); + for (auto i: c) { range.first = min (range.first, i->position ()); range.second = max (range.second, i->position ()); - range.first = min (range.first, i->end ()); - range.second = max (range.second, i->end ()); + range.first = min (range.first, i->end(film)); + range.second = max (range.second, i->end(film)); } - DCPTime pos = range.second; - for (int i = 0; i < n; ++i) { - BOOST_FOREACH (shared_ptr j, c) { - shared_ptr copy = j->clone (); - copy->set_position (pos + copy->position() - range.first); - _content.push_back (copy); + Change (ChangeType::PENDING); + + { + boost::mutex::scoped_lock lm (_mutex); + + DCPTime pos = range.second; + for (int i = 0; i < n; ++i) { + for (auto j: c) { + auto copy = j->clone (); + copy->set_position (film, pos + copy->position() - range.first); + _content.push_back (copy); + } + pos += range.second - range.first; } - pos += range.second - range.first; - } - sort (_content.begin(), _content.end(), ContentSorter ()); + sort (_content.begin(), _content.end(), ContentSorter ()); + reconnect (film); + } - reconnect (); - Changed (); + Change (ChangeType::DONE); } + void -Playlist::move_earlier (shared_ptr c) +Playlist::move_earlier (shared_ptr film, shared_ptr c) { - ContentList::iterator previous = _content.end (); - ContentList::iterator i = _content.begin(); - while (i != _content.end() && *i != c) { + auto cont = content (); + auto previous = cont.end(); + auto i = cont.begin(); + while (i != cont.end() && *i != c) { previous = i; ++i; } - DCPOMATIC_ASSERT (i != _content.end ()); - if (previous == _content.end ()) { + DCPOMATIC_ASSERT (i != cont.end()); + if (previous == cont.end()) { return; } - shared_ptr previous_c = *previous; + auto previous_c = *previous; - DCPTime const p = previous_c->position (); - previous_c->set_position (p + c->length_after_trim ()); - c->set_position (p); + auto const p = previous_c->position (); + previous_c->set_position (film, p + c->length_after_trim(film)); + c->set_position (film, p); } + void -Playlist::move_later (shared_ptr c) +Playlist::move_later (shared_ptr film, shared_ptr c) { - ContentList::iterator i = _content.begin(); - while (i != _content.end() && *i != c) { + auto cont = content (); + auto i = cont.begin(); + while (i != cont.end() && *i != c) { ++i; } - DCPOMATIC_ASSERT (i != _content.end ()); + DCPOMATIC_ASSERT (i != cont.end()); ContentList::iterator next = i; ++next; - if (next == _content.end ()) { + if (next == cont.end()) { return; } - shared_ptr next_c = *next; + auto next_c = *next; - next_c->set_position (c->position ()); - c->set_position (c->position() + next_c->length_after_trim ()); + next_c->set_position (film, c->position()); + c->set_position (film, c->position() + next_c->length_after_trim(film)); } + int64_t -Playlist::required_disk_space (int j2k_bandwidth, int audio_channels, int audio_frame_rate) const +Playlist::required_disk_space (shared_ptr film, int j2k_bandwidth, int audio_channels, int audio_frame_rate) const { - int64_t video = uint64_t (j2k_bandwidth / 8) * length().seconds (); - int64_t audio = uint64_t (audio_channels * audio_frame_rate * 3) * length().seconds (); + int64_t video = uint64_t (j2k_bandwidth / 8) * length(film).seconds(); + int64_t audio = uint64_t (audio_channels * audio_frame_rate * 3) * length(film).seconds(); - BOOST_FOREACH (shared_ptr i, _content) { - shared_ptr d = dynamic_pointer_cast (i); + for (auto i: content()) { + auto d = dynamic_pointer_cast (i); if (d) { if (d->reference_video()) { - video -= uint64_t (j2k_bandwidth / 8) * d->length_after_trim().seconds(); + video -= uint64_t (j2k_bandwidth / 8) * d->length_after_trim(film).seconds(); } if (d->reference_audio()) { - audio -= uint64_t (audio_channels * audio_frame_rate * 3) * d->length_after_trim().seconds(); + audio -= uint64_t (audio_channels * audio_frame_rate * 3) * d->length_after_trim(film).seconds(); } } } @@ -510,3 +674,53 @@ Playlist::required_disk_space (int j2k_bandwidth, int audio_channels, int audio_ /* Add on 64k for bits and pieces (metadata, subs etc) */ return video + audio + 65536; } + + +string +Playlist::content_summary (shared_ptr film, DCPTimePeriod period) const +{ + string best_summary; + int best_score = -1; + for (auto i: content()) { + int score = 0; + auto const o = DCPTimePeriod(i->position(), i->end(film)).overlap (period); + if (o) { + score += 100 * o.get().duration().get() / period.duration().get(); + } + + if (i->video) { + score += 100; + } + + if (score > best_score) { + best_summary = i->path(0).leaf().string(); + best_score = score; + } + } + + return best_summary; +} + + +pair +Playlist::speed_up_range (int dcp_video_frame_rate) const +{ + pair range (DBL_MAX, -DBL_MAX); + + for (auto i: content()) { + if (!i->video) { + continue; + } + if (i->video_frame_rate()) { + FrameRateChange const frc (i->video_frame_rate().get(), dcp_video_frame_rate); + range.first = min (range.first, frc.speed_up); + range.second = max (range.second, frc.speed_up); + } else { + FrameRateChange const frc (dcp_video_frame_rate, dcp_video_frame_rate); + range.first = min (range.first, frc.speed_up); + range.second = max (range.second, frc.speed_up); + } + } + + return range; +}