Merge branch 'master' of ssh://git.carlh.net/home/carl/git/dcpomatic
[dcpomatic.git] / src / lib / playlist.cc
index 9df7857b5cda85297ee00cbda307b9c7ef66d4b0..e4fc0f0723df7e100229dd1765d8ee831ba4c7da 100644 (file)
@@ -1,36 +1,36 @@
 /*
-    Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2018 Carl Hetherington <cth@carlh.net>
 
-    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 <http://www.gnu.org/licenses/>.
 
 */
 
 #include "playlist.h"
-#include "sndfile_content.h"
-#include "sndfile_decoder.h"
 #include "video_content.h"
-#include "subtitle_content.h"
+#include "text_content.h"
 #include "ffmpeg_decoder.h"
 #include "ffmpeg_content.h"
 #include "image_decoder.h"
+#include "audio_content.h"
 #include "content_factory.h"
 #include "dcp_content.h"
 #include "job.h"
 #include "config.h"
 #include "util.h"
-#include "md5_digester.h"
+#include "digester.h"
 #include <libcxml/cxml.h>
 #include <libxml++/libxml++.h>
 #include <boost/shared_ptr.hpp>
@@ -65,31 +65,38 @@ Playlist::~Playlist ()
 }
 
 void
-Playlist::content_changed (weak_ptr<Content> content, int property, bool frequent)
+Playlist::content_change (ChangeType type, weak_ptr<Content> 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 ();
+       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 ();
+               }
+
+               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 ();
+                       }
                }
        }
 
-       ContentChanged (content, property, frequent);
+       ContentChange (type, content, property, frequent);
 }
 
 void
@@ -115,7 +122,7 @@ Playlist::maybe_sequence ()
                        continue;
                }
 
-               if (i->video->video_frame_type() == VIDEO_FRAME_TYPE_3D_RIGHT) {
+               if (i->video->frame_type() == VIDEO_FRAME_TYPE_3D_RIGHT) {
                        i->set_position (next_right);
                        next_right = i->end();
                } else {
@@ -126,11 +133,11 @@ Playlist::maybe_sequence ()
                placed.push_back (i);
        }
 
-       /* Subtitles */
+       /* Captions */
 
        DCPTime next;
        BOOST_FOREACH (shared_ptr<Content> i, _content) {
-               if (!i->subtitle || !i->subtitle->has_subtitles() || find (placed.begin(), placed.end(), i) != placed.end()) {
+               if (i->text.empty() || find (placed.begin(), placed.end(), i) != placed.end()) {
                        continue;
                }
 
@@ -150,21 +157,27 @@ Playlist::video_identifier () const
        string t;
 
        BOOST_FOREACH (shared_ptr<const Content> i, _content) {
-               shared_ptr<const VideoContent> vc = dynamic_pointer_cast<const VideoContent> (i);
-               shared_ptr<const SubtitleContent> sc = dynamic_pointer_cast<const SubtitleContent> (i);
-               if (vc) {
-                       t += vc->identifier ();
-               } else if (sc && sc->burn_subtitles ()) {
-                       t += sc->identifier ();
+               bool burn = false;
+               BOOST_FOREACH (shared_ptr<TextContent> 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 <Playlist> node */
+/** @param film Film that this Playlist is for.
+ *  @param node &lt;Playlist&gt; node.
+ *  @param version Metadata version number.
+ *  @param notes Output notes about that happened.
+ */
 void
 Playlist::set_from_xml (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version, list<string>& notes)
 {
@@ -178,27 +191,32 @@ Playlist::set_from_xml (shared_ptr<const Film> film, cxml::ConstNodePtr node, in
        reconnect ();
 }
 
-/** @param node <Playlist> node */
+/** @param node &lt;Playlist&gt; node.
+ *  @param with_content_paths true to include &lt;Path&gt; nodes in &lt;Content&gt; 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<Content> i, _content) {
-               i->as_xml (node->add_child ("Content"));
+               i->as_xml (node->add_child ("Content"), with_content_paths);
        }
 }
 
 void
 Playlist::add (shared_ptr<Content> c)
 {
+       Change (CHANGE_TYPE_PENDING);
        _content.push_back (c);
        sort (_content.begin(), _content.end(), ContentSorter ());
        reconnect ();
-       Changed ();
+       Change (CHANGE_TYPE_DONE);
 }
 
 void
 Playlist::remove (shared_ptr<Content> c)
 {
+       Change (CHANGE_TYPE_PENDING);
+
        ContentList::iterator i = _content.begin ();
        while (i != _content.end() && *i != c) {
                ++i;
@@ -206,7 +224,9 @@ Playlist::remove (shared_ptr<Content> c)
 
        if (i != _content.end ()) {
                _content.erase (i);
-               Changed ();
+               Change (CHANGE_TYPE_DONE);
+       } else {
+               Change (CHANGE_TYPE_CANCELLED);
        }
 
        /* This won't change order, so it does not need a sort */
@@ -215,6 +235,8 @@ Playlist::remove (shared_ptr<Content> c)
 void
 Playlist::remove (ContentList c)
 {
+       Change (CHANGE_TYPE_PENDING);
+
        BOOST_FOREACH (shared_ptr<Content> i, c) {
                ContentList::iterator j = _content.begin ();
                while (j != _content.end() && *j != i) {
@@ -228,7 +250,7 @@ Playlist::remove (ContentList c)
 
        /* This won't change order, so it does not need a sort */
 
-       Changed ();
+       Change (CHANGE_TYPE_DONE);
 }
 
 class FrameRateCandidate
@@ -244,7 +266,7 @@ public:
 };
 
 int
-Playlist::best_dcp_frame_rate () const
+Playlist::best_video_frame_rate () const
 {
        list<int> const allowed_dcp_frame_rates = Config::instance()->allowed_dcp_frame_rates ();
 
@@ -270,14 +292,14 @@ Playlist::best_dcp_frame_rate () const
 
                float this_error = 0;
                BOOST_FOREACH (shared_ptr<Content> j, _content) {
-                       if (!j->video || !j->video->has_own_video_frame_rate()) {
+                       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" */
@@ -337,7 +359,7 @@ Playlist::reconnect ()
        _content_connections.clear ();
 
        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, _1, _2, _3, _4)));
        }
 }
 
@@ -346,7 +368,7 @@ Playlist::video_end () const
 {
        DCPTime end;
        BOOST_FOREACH (shared_ptr<Content> i, _content) {
-               if (dynamic_pointer_cast<const VideoContent> (i)) {
+               if (i->video) {
                        end = max (end, i->end ());
                }
        }
@@ -355,11 +377,11 @@ Playlist::video_end () const
 }
 
 DCPTime
-Playlist::subtitle_end () const
+Playlist::text_end () const
 {
        DCPTime end;
        BOOST_FOREACH (shared_ptr<Content> i, _content) {
-               if (dynamic_pointer_cast<const SubtitleContent> (i)) {
+               if (!i->text.empty ()) {
                        end = max (end, i->end ());
                }
        }
@@ -379,7 +401,13 @@ 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);
+                       }
                }
        }
 
@@ -428,6 +456,8 @@ Playlist::repeat (ContentList c, int n)
                range.second = max (range.second, i->end ());
        }
 
+       Change (CHANGE_TYPE_PENDING);
+
        DCPTime pos = range.second;
        for (int i = 0; i < n; ++i) {
                BOOST_FOREACH (shared_ptr<Content> j, c) {
@@ -441,7 +471,7 @@ Playlist::repeat (ContentList c, int n)
        sort (_content.begin(), _content.end(), ContentSorter ());
 
        reconnect ();
-       Changed ();
+       Change (CHANGE_TYPE_DONE);
 }
 
 void
@@ -510,3 +540,51 @@ 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 (DCPTimePeriod period) const
+{
+       string best_summary;
+       int best_score = -1;
+       BOOST_FOREACH (shared_ptr<Content> i, _content) {
+               int score = 0;
+               optional<DCPTimePeriod> const o = DCPTimePeriod(i->position(), i->end()).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<double, double>
+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) {
+               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;
+}