Extract common code out into kdm_for_screen()
[dcpomatic.git] / src / lib / playlist.cc
index 6c7fd7f4e3bf96ca34489b04a453535da3549961..48053bbf485aa893ddd903646ee911baaba05bdc 100644 (file)
@@ -20,7 +20,7 @@
 
 #include "playlist.h"
 #include "video_content.h"
-#include "caption_content.h"
+#include "text_content.h"
 #include "ffmpeg_decoder.h"
 #include "ffmpeg_content.h"
 #include "image_decoder.h"
@@ -31,6 +31,7 @@
 #include "config.h"
 #include "util.h"
 #include "digester.h"
+#include "compose.hpp"
 #include <libcxml/cxml.h>
 #include <libxml++/libxml++.h>
 #include <boost/shared_ptr.hpp>
@@ -50,6 +51,7 @@ using boost::optional;
 using boost::shared_ptr;
 using boost::weak_ptr;
 using boost::dynamic_pointer_cast;
+using namespace dcpomatic;
 
 Playlist::Playlist ()
        : _sequence (true)
@@ -60,45 +62,68 @@ Playlist::Playlist ()
 
 Playlist::~Playlist ()
 {
+       boost::mutex::scoped_lock lm (_mutex);
        _content.clear ();
-       reconnect ();
+       disconnect ();
 }
 
 void
-Playlist::content_changed (weak_ptr<Content> content, int property, bool frequent)
+Playlist::content_change (weak_ptr<const Film> weak_film, ChangeType type, weak_ptr<Content> content, int property, bool frequent)
 {
-       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 ();
-       }
-
-       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 ();
+       /* Make sure we only hear about atomic changes (e.g. a PENDING always with the DONE/CANCELLED)
+          Ignore any DONE/CANCELLED that arrives without a PENDING.
+       */
+       if (_checker.send (type, property)) {
+               return;
+       }
+
+       shared_ptr<const Film> film = weak_film.lock ();
+       DCPOMATIC_ASSERT (film);
+
+       if (type == CHANGE_TYPE_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<const Film> film)
 {
        if (!_sequence || _sequencing) {
                return;
@@ -106,6 +131,8 @@ Playlist::maybe_sequence ()
 
        _sequencing = true;
 
+       ContentList cont = content ();
+
        /* Keep track of the content that we've set the position of so that we don't
           do it twice.
        */
@@ -115,17 +142,17 @@ Playlist::maybe_sequence ()
 
        DCPTime next_left;
        DCPTime next_right;
-       BOOST_FOREACH (shared_ptr<Content> i, _content) {
+       BOOST_FOREACH (shared_ptr<Content> i, cont) {
                if (!i->video) {
                        continue;
                }
 
                if (i->video->frame_type() == VIDEO_FRAME_TYPE_3D_RIGHT) {
-                       i->set_position (next_right);
-                       next_right = i->end();
+                       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);
@@ -134,13 +161,13 @@ Playlist::maybe_sequence ()
        /* Captions */
 
        DCPTime next;
-       BOOST_FOREACH (shared_ptr<Content> i, _content) {
-               if (i->caption.empty() || find (placed.begin(), placed.end(), i) != placed.end()) {
+       BOOST_FOREACH (shared_ptr<Content> i, cont) {
+               if (i->text.empty() || find (placed.begin(), placed.end(), i) != placed.end()) {
                        continue;
                }
 
-               i->set_position (next);
-               next = i->end();
+               i->set_position (film, next);
+               next = i->end(film);
        }
 
 
@@ -154,9 +181,9 @@ Playlist::video_identifier () const
 {
        string t;
 
-       BOOST_FOREACH (shared_ptr<const Content> i, _content) {
+       BOOST_FOREACH (shared_ptr<const Content> i, content()) {
                bool burn = false;
-               BOOST_FOREACH (shared_ptr<CaptionContent> j, i->caption) {
+               BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
                        if (j->burn()) {
                                burn = true;
                        }
@@ -179,14 +206,58 @@ Playlist::video_identifier () const
 void
 Playlist::set_from_xml (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version, list<string>& notes)
 {
+       boost::mutex::scoped_lock lm (_mutex);
+
        BOOST_FOREACH (cxml::NodePtr i, node->node_children ("Content")) {
-               _content.push_back (content_factory (film, i, version, notes));
+               shared_ptr<Content> content = content_factory (i, version, notes);
+
+               /* See if this content should be nudged to start on a video frame */
+               DCPTime 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 */
+               ContentTime 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 &lt;Playlist&gt; node.
@@ -195,53 +266,86 @@ Playlist::set_from_xml (shared_ptr<const Film> film, cxml::ConstNodePtr node, in
 void
 Playlist::as_xml (xmlpp::Node* node, bool with_content_paths)
 {
-       BOOST_FOREACH (shared_ptr<Content> i, _content) {
+       BOOST_FOREACH (shared_ptr<Content> i, content()) {
                i->as_xml (node->add_child ("Content"), with_content_paths);
        }
 }
 
 void
-Playlist::add (shared_ptr<Content> c)
+Playlist::add (shared_ptr<const Film> film, shared_ptr<Content> c)
 {
-       _content.push_back (c);
-       sort (_content.begin(), _content.end(), ContentSorter ());
-       reconnect ();
-       Changed ();
+       Change (CHANGE_TYPE_PENDING);
+
+       {
+               boost::mutex::scoped_lock lm (_mutex);
+               _content.push_back (c);
+               sort (_content.begin(), _content.end(), ContentSorter ());
+               reconnect (film);
+       }
+
+       Change (CHANGE_TYPE_DONE);
+
+       LengthChange ();
 }
 
 void
 Playlist::remove (shared_ptr<Content> c)
 {
-       ContentList::iterator i = _content.begin ();
-       while (i != _content.end() && *i != c) {
-               ++i;
+       Change (CHANGE_TYPE_PENDING);
+
+       bool cancelled = false;
+
+       {
+               boost::mutex::scoped_lock lm (_mutex);
+
+               ContentList::iterator 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 (CHANGE_TYPE_CANCELLED);
+       } else {
+               Change (CHANGE_TYPE_DONE);
        }
 
        /* This won't change order, so it does not need a sort */
+
+       LengthChange ();
 }
 
 void
 Playlist::remove (ContentList c)
 {
-       BOOST_FOREACH (shared_ptr<Content> i, c) {
-               ContentList::iterator j = _content.begin ();
-               while (j != _content.end() && *j != i) {
-                       ++j;
-               }
+       Change (CHANGE_TYPE_PENDING);
+
+       {
+               boost::mutex::scoped_lock lm (_mutex);
+
+               BOOST_FOREACH (shared_ptr<Content> i, c) {
+                       ContentList::iterator 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 (CHANGE_TYPE_DONE);
+
        /* This won't change order, so it does not need a sort */
 
-       Changed ();
+       LengthChange ();
 }
 
 class FrameRateCandidate
@@ -256,6 +360,7 @@ public:
        int dcp;
 };
 
+/** @return the best frame rate from Config::_allowed_dcp_frame_rates for the content in this list */
 int
 Playlist::best_video_frame_rate () const
 {
@@ -265,14 +370,14 @@ Playlist::best_video_frame_rate () const
        list<FrameRateCandidate> candidates;
 
        /* Start with the ones without skip / repeat so they will get matched in preference to skipped/repeated ones */
-       for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
-               candidates.push_back (FrameRateCandidate (*i, *i));
+       BOOST_FOREACH (int i, allowed_dcp_frame_rates) {
+               candidates.push_back (FrameRateCandidate(i, i));
        }
 
        /* Then the skip/repeat ones */
-       for (list<int>::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));
+       BOOST_FOREACH (int 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 */
@@ -282,7 +387,7 @@ Playlist::best_video_frame_rate () const
        while (i != candidates.end()) {
 
                float this_error = 0;
-               BOOST_FOREACH (shared_ptr<Content> j, _content) {
+               BOOST_FOREACH (shared_ptr<Content> j, content()) {
                        if (!j->video || !j->video_frame_rate()) {
                                continue;
                        }
@@ -314,11 +419,11 @@ Playlist::best_video_frame_rate () const
 
 /** @return length of the playlist from time 0 to the last thing on the playlist */
 DCPTime
-Playlist::length () const
+Playlist::length (shared_ptr<const Film> film) const
 {
        DCPTime len;
-       BOOST_FOREACH (shared_ptr<const Content> i, _content) {
-               len = max (len, i->end());
+       BOOST_FOREACH (shared_ptr<const Content> i, content()) {
+               len = max (len, i->end(film));
        }
 
        return len;
@@ -328,39 +433,48 @@ Playlist::length () const
 optional<DCPTime>
 Playlist::start () const
 {
-       if (_content.empty ()) {
+       ContentList cont = content ();
+       if (cont.empty()) {
                return optional<DCPTime> ();
        }
 
        DCPTime start = DCPTime::max ();
-       BOOST_FOREACH (shared_ptr<Content> i, _content) {
+       BOOST_FOREACH (shared_ptr<Content> 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<boost::signals2::connection>::iterator i = _content_connections.begin(); i != _content_connections.end(); ++i) {
-               i->disconnect ();
+       BOOST_FOREACH (boost::signals2::connection& i, _content_connections) {
+               i.disconnect ();
        }
 
        _content_connections.clear ();
+}
+
+/** Must be called with a lock held on _mutex */
+void
+Playlist::reconnect (shared_ptr<const Film> film)
+{
+       disconnect ();
 
        BOOST_FOREACH (shared_ptr<Content> i, _content) {
-               _content_connections.push_back (i->Changed.connect (bind (&Playlist::content_changed, this, _1, _2, _3)));
+               _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<const Film> film) const
 {
        DCPTime end;
-       BOOST_FOREACH (shared_ptr<Content> i, _content) {
+       BOOST_FOREACH (shared_ptr<Content> i, content()) {
                if (i->video) {
-                       end = max (end, i->end ());
+                       end = max (end, i->end(film));
                }
        }
 
@@ -368,12 +482,12 @@ Playlist::video_end () const
 }
 
 DCPTime
-Playlist::caption_end () const
+Playlist::text_end (shared_ptr<const Film> film) const
 {
        DCPTime end;
-       BOOST_FOREACH (shared_ptr<Content> i, _content) {
-               if (!i->caption.empty ()) {
-                       end = max (end, i->end ());
+       BOOST_FOREACH (shared_ptr<Content> i, content()) {
+               if (!i->text.empty ()) {
+                       end = max (end, i->end(film));
                }
        }
 
@@ -383,7 +497,8 @@ Playlist::caption_end () const
 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) {
+       ContentList cont = content ();
+       for (ContentList::const_reverse_iterator i = cont.rbegin(); i != cont.rend(); ++i) {
                if (!(*i)->video) {
                        continue;
                }
@@ -433,95 +548,104 @@ ContentSorter::operator() (shared_ptr<Content> a, shared_ptr<Content> b)
 ContentList
 Playlist::content () const
 {
+       boost::mutex::scoped_lock lm (_mutex);
        return _content;
 }
 
 void
-Playlist::repeat (ContentList c, int n)
+Playlist::repeat (shared_ptr<const Film> film, ContentList c, int n)
 {
        pair<DCPTime, DCPTime> range (DCPTime::max (), DCPTime ());
        BOOST_FOREACH (shared_ptr<Content> 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<Content> j, c) {
-                       shared_ptr<Content> copy = j->clone ();
-                       copy->set_position (pos + copy->position() - range.first);
-                       _content.push_back (copy);
+       Change (CHANGE_TYPE_PENDING);
+
+       {
+               boost::mutex::scoped_lock lm (_mutex);
+
+               DCPTime pos = range.second;
+               for (int i = 0; i < n; ++i) {
+                       BOOST_FOREACH (shared_ptr<Content> j, c) {
+                               shared_ptr<Content> 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 (CHANGE_TYPE_DONE);
 }
 
 void
-Playlist::move_earlier (shared_ptr<Content> c)
+Playlist::move_earlier (shared_ptr<const Film> film, shared_ptr<Content> c)
 {
-       ContentList::iterator previous = _content.end ();
-       ContentList::iterator i = _content.begin();
-       while (i != _content.end() && *i != c) {
+       ContentList cont = content ();
+       ContentList::iterator previous = cont.end();
+       ContentList::iterator 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<Content> previous_c = *previous;
 
        DCPTime const p = previous_c->position ();
-       previous_c->set_position (p + c->length_after_trim ());
-       c->set_position (p);
+       previous_c->set_position (film, p + c->length_after_trim(film));
+       c->set_position (film, p);
 }
 
 void
-Playlist::move_later (shared_ptr<Content> c)
+Playlist::move_later (shared_ptr<const Film> film, shared_ptr<Content> c)
 {
-       ContentList::iterator i = _content.begin();
-       while (i != _content.end() && *i != c) {
+       ContentList cont = content ();
+       ContentList::iterator 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<Content> 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<const Film> 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<Content> i, _content) {
+       BOOST_FOREACH (shared_ptr<Content> i, content()) {
                shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (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();
                        }
                }
        }
@@ -531,13 +655,13 @@ Playlist::required_disk_space (int j2k_bandwidth, int audio_channels, int audio_
 }
 
 string
-Playlist::content_summary (DCPTimePeriod period) const
+Playlist::content_summary (shared_ptr<const Film> film, DCPTimePeriod period) const
 {
        string best_summary;
        int best_score = -1;
-       BOOST_FOREACH (shared_ptr<Content> i, _content) {
+       BOOST_FOREACH (shared_ptr<Content> i, content()) {
                int score = 0;
-               optional<DCPTimePeriod> const o = DCPTimePeriod(i->position(), i->end()).overlap (period);
+               optional<DCPTimePeriod> const o = DCPTimePeriod(i->position(), i->end(film)).overlap (period);
                if (o) {
                        score += 100 * o.get().duration().get() / period.duration().get();
                }
@@ -560,7 +684,7 @@ Playlist::speed_up_range (int dcp_video_frame_rate) const
 {
        pair<double, double> range (DBL_MAX, -DBL_MAX);
 
-       BOOST_FOREACH (shared_ptr<Content> i, _content) {
+       BOOST_FOREACH (shared_ptr<Content> i, content()) {
                if (!i->video) {
                        continue;
                }