Basic template support (#485).
[dcpomatic.git] / src / lib / playlist.cc
index aea6c5f413deaae0f6c95e2a702a596f6e7010ae..a30dde633cde3120bc29cdc2b762e3c723f802de 100644 (file)
@@ -1,36 +1,40 @@
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2016 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 <libcxml/cxml.h>
-#include <boost/shared_ptr.hpp>
-#include <boost/lexical_cast.hpp>
 #include "playlist.h"
-#include "sndfile_content.h"
-#include "sndfile_decoder.h"
 #include "video_content.h"
+#include "subtitle_content.h"
 #include "ffmpeg_decoder.h"
 #include "ffmpeg_content.h"
-#include "imagemagick_decoder.h"
-#include "imagemagick_content.h"
+#include "image_decoder.h"
+#include "content_factory.h"
+#include "dcp_content.h"
 #include "job.h"
 #include "config.h"
 #include "util.h"
+#include "digester.h"
+#include <libcxml/cxml.h>
+#include <libxml++/libxml++.h>
+#include <boost/shared_ptr.hpp>
+#include <boost/foreach.hpp>
+#include <iostream>
 
 #include "i18n.h"
 
@@ -40,29 +44,19 @@ using std::vector;
 using std::min;
 using std::max;
 using std::string;
-using std::stringstream;
+using std::pair;
 using boost::optional;
 using boost::shared_ptr;
 using boost::weak_ptr;
 using boost::dynamic_pointer_cast;
-using boost::lexical_cast;
 
 Playlist::Playlist ()
-       : _loop (1)
-       , _sequence_video (true)
-       , _sequencing_video (false)
+       : _sequence (true)
+       , _sequencing (false)
 {
 
 }
 
-Playlist::Playlist (shared_ptr<const Playlist> other)
-       : _loop (other->_loop)
-{
-       for (ContentList::const_iterator i = other->_content.begin(); i != other->_content.end(); ++i) {
-               _content.push_back ((*i)->clone ());
-       }
-}
-
 Playlist::~Playlist ()
 {
        _content.clear ();
@@ -70,98 +64,129 @@ Playlist::~Playlist ()
 }
 
 void
-Playlist::content_changed (weak_ptr<Content> c, int p)
+Playlist::content_changed (weak_ptr<Content> content, int property, bool frequent)
 {
-       if (p == ContentProperty::LENGTH) {
-               maybe_sequence_video ();
+       if (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 ();
        }
-       
-       ContentChanged (c, p);
+
+       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);
 }
 
 void
-Playlist::maybe_sequence_video ()
+Playlist::maybe_sequence ()
 {
-       if (!_sequence_video || _sequencing_video) {
+       if (!_sequence || _sequencing) {
                return;
        }
-       
-       _sequencing_video = true;
-       
-       ContentList cl = _content;
-       sort (cl.begin(), cl.end(), ContentSorter ());
-       Time last = 0;
-       for (ContentList::iterator i = cl.begin(); i != cl.end(); ++i) {
-               if (!dynamic_pointer_cast<VideoContent> (*i)) {
+
+       _sequencing = true;
+
+       /* Keep track of the content that we've set the position of so that we don't
+          do it twice.
+       */
+       ContentList placed;
+
+       /* Video */
+
+       DCPTime next_left;
+       DCPTime next_right;
+       BOOST_FOREACH (shared_ptr<Content> i, _content) {
+               if (!i->video) {
+                       continue;
+               }
+
+               if (i->video->frame_type() == VIDEO_FRAME_TYPE_3D_RIGHT) {
+                       i->set_position (next_right);
+                       next_right = i->end();
+               } else {
+                       i->set_position (next_left);
+                       next_left = i->end();
+               }
+
+               placed.push_back (i);
+       }
+
+       /* Subtitles */
+
+       DCPTime next;
+       BOOST_FOREACH (shared_ptr<Content> i, _content) {
+               if (!i->subtitle || find (placed.begin(), placed.end(), i) != placed.end()) {
                        continue;
                }
-               
-               (*i)->set_start (last);
-               last = (*i)->end ();
+
+               i->set_position (next);
+               next = i->end();
        }
-       
-       _sequencing_video = false;
+
+
+       /* This won't change order, so it does not need a sort */
+
+       _sequencing = false;
 }
 
 string
 Playlist::video_identifier () const
 {
        string t;
-       
-       for (ContentList::const_iterator i = _content.begin(); i != _content.end(); ++i) {
-               shared_ptr<const VideoContent> vc = dynamic_pointer_cast<const VideoContent> (*i);
-               if (vc) {
-                       t += vc->identifier ();
+
+       BOOST_FOREACH (shared_ptr<const Content> i, _content) {
+               if (i->video || (i->subtitle && i->subtitle->burn())) {
+                       t += i->identifier ();
                }
        }
 
-       t += lexical_cast<string> (_loop);
-
-       return md5_digest (t.c_str(), t.length());
+       Digester digester;
+       digester.add (t.c_str(), t.length());
+       return digester.get ();
 }
 
 /** @param node <Playlist> node */
 void
-Playlist::set_from_xml (shared_ptr<const Film> film, shared_ptr<const cxml::Node> node)
+Playlist::set_from_xml (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version, list<string>& notes)
 {
-       list<shared_ptr<cxml::Node> > c = node->node_children ("Content");
-       for (list<shared_ptr<cxml::Node> >::iterator i = c.begin(); i != c.end(); ++i) {
-               string const type = (*i)->string_child ("Type");
-
-               boost::shared_ptr<Content> content;
-
-               if (type == "FFmpeg") {
-                       content.reset (new FFmpegContent (film, *i));
-               } else if (type == "ImageMagick") {
-                       content.reset (new ImageMagickContent (film, *i));
-               } else if (type == "Sndfile") {
-                       content.reset (new SndfileContent (film, *i));
-               }
-
-               _content.push_back (content);
+       BOOST_FOREACH (cxml::NodePtr i, node->node_children ("Content")) {
+               _content.push_back (content_factory (film, i, version, notes));
        }
 
+       /* This shouldn't be necessary but better safe than sorry (there could be old files) */
+       sort (_content.begin(), _content.end(), ContentSorter ());
+
        reconnect ();
-       _loop = node->number_child<int> ("Loop");
-       _sequence_video = node->bool_child ("SequenceVideo");
 }
 
 /** @param node <Playlist> node */
 void
-Playlist::as_xml (xmlpp::Node* node)
+Playlist::as_xml (xmlpp::Node* node, bool with_content_paths)
 {
-       for (ContentList::iterator i = _content.begin(); i != _content.end(); ++i) {
-               (*i)->as_xml (node->add_child ("Content"));
+       BOOST_FOREACH (shared_ptr<Content> i, _content) {
+               i->as_xml (node->add_child ("Content"), with_content_paths);
        }
-
-       node->add_child("Loop")->add_child_text(lexical_cast<string> (_loop));
-       node->add_child("SequenceVideo")->add_child_text(_sequence_video ? "1" : "0");
 }
 
 void
 Playlist::add (shared_ptr<Content> c)
 {
        _content.push_back (c);
+       sort (_content.begin(), _content.end(), ContentSorter ());
        reconnect ();
        Changed ();
 }
@@ -173,31 +198,32 @@ Playlist::remove (shared_ptr<Content> c)
        while (i != _content.end() && *i != c) {
                ++i;
        }
-       
+
        if (i != _content.end ()) {
                _content.erase (i);
                Changed ();
        }
+
+       /* This won't change order, so it does not need a sort */
 }
 
 void
-Playlist::set_loop (int l)
+Playlist::remove (ContentList c)
 {
-       _loop = l;
-       Changed ();
-}
+       BOOST_FOREACH (shared_ptr<Content> i, c) {
+               ContentList::iterator j = _content.begin ();
+               while (j != _content.end() && *j != i) {
+                       ++j;
+               }
 
-bool
-Playlist::has_subtitles () const
-{
-       for (ContentList::const_iterator i = _content.begin(); i != _content.end(); ++i) {
-               shared_ptr<const FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (*i);
-               if (fc && !fc->subtitle_streams().empty()) {
-                       return true;
+               if (j != _content.end ()) {
+                       _content.erase (j);
                }
        }
 
-       return false;
+       /* This won't change order, so it does not need a sort */
+
+       Changed ();
 }
 
 class FrameRateCandidate
@@ -213,11 +239,11 @@ 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 ();
 
-       /* Work out what rates we could manage, including those achieved by using skip / repeat. */
+       /* Work out what rates we could manage, including those achieved by using skip / repeat */
        list<FrameRateCandidate> candidates;
 
        /* Start with the ones without skip / repeat so they will get matched in preference to skipped/repeated ones */
@@ -231,20 +257,26 @@ Playlist::best_dcp_frame_rate () const
                candidates.push_back (FrameRateCandidate (float (*i) * 2, *i));
        }
 
-       /* Pick the best one, bailing early if we hit an exact match */
+       /* Pick the best one */
        float error = std::numeric_limits<float>::max ();
        optional<FrameRateCandidate> best;
        list<FrameRateCandidate>::iterator i = candidates.begin();
        while (i != candidates.end()) {
 
                float this_error = 0;
-               for (ContentList::const_iterator j = _content.begin(); j != _content.end(); ++j) {
-                       shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (*j);
-                       if (!vc) {
+               BOOST_FOREACH (shared_ptr<Content> j, _content) {
+                       if (!j->video || !j->video_frame_rate()) {
                                continue;
                        }
 
-                       this_error += fabs (i->source - vc->video_frame_rate ());
+                       /* 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_frame_rate().get())),
+                               float (fabs (i->source - j->video_frame_rate().get() * 2))
+                               );
+
+                       /* Use the largest difference between DCP and source as the "error" */
+                       this_error = max (this_error, best_error);
                }
 
                if (this_error < error) {
@@ -258,21 +290,38 @@ Playlist::best_dcp_frame_rate () const
        if (!best) {
                return 24;
        }
-       
+
        return best->dcp;
 }
 
-Time
+/** @return length of the playlist from time 0 to the last thing on the playlist */
+DCPTime
 Playlist::length () const
 {
-       Time len = 0;
-       for (ContentList::const_iterator i = _content.begin(); i != _content.end(); ++i) {
-               len = max (len, (*i)->end ());
+       DCPTime len;
+       BOOST_FOREACH (shared_ptr<const Content> i, _content) {
+               len = max (len, i->end());
        }
 
        return len;
 }
 
+/** @return position of the first thing on the playlist, if it's not empty */
+optional<DCPTime>
+Playlist::start () const
+{
+       if (_content.empty ()) {
+               return optional<DCPTime> ();
+       }
+
+       DCPTime start = DCPTime::max ();
+       BOOST_FOREACH (shared_ptr<Content> i, _content) {
+               start = min (start, i->position ());
+       }
+
+       return start;
+}
+
 void
 Playlist::reconnect ()
 {
@@ -281,33 +330,209 @@ Playlist::reconnect ()
        }
 
        _content_connections.clear ();
-               
-       for (ContentList::iterator i = _content.begin(); i != _content.end(); ++i) {
-               _content_connections.push_back ((*i)->Changed.connect (bind (&Playlist::content_changed, this, _1, _2)));
+
+       BOOST_FOREACH (shared_ptr<Content> i, _content) {
+               _content_connections.push_back (i->Changed.connect (bind (&Playlist::content_changed, this, _1, _2, _3)));
        }
 }
 
-Time
+DCPTime
 Playlist::video_end () const
 {
-       Time end = 0;
-       for (ContentList::const_iterator i = _content.begin(); i != _content.end(); ++i) {
-               if (dynamic_pointer_cast<const VideoContent> (*i)) {
-                       end = max (end, (*i)->end ());
+       DCPTime end;
+       BOOST_FOREACH (shared_ptr<Content> i, _content) {
+               if (i->video) {
+                       end = max (end, i->end ());
                }
        }
 
        return end;
 }
 
+DCPTime
+Playlist::subtitle_end () const
+{
+       DCPTime end;
+       BOOST_FOREACH (shared_ptr<Content> i, _content) {
+               if (i->subtitle) {
+                       end = max (end, i->end ());
+               }
+       }
+
+       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) {
+               if (!(*i)->video) {
+                       continue;
+               }
+
+               if ((*i)->position() <= t) {
+                       /* This is the first piece of content (going backwards...) that starts before t,
+                          so it's the active one.
+                       */
+                       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_video (bool s)
+Playlist::set_sequence (bool s)
 {
-       _sequence_video = s;
+       _sequence = s;
 }
 
 bool
 ContentSorter::operator() (shared_ptr<Content> a, shared_ptr<Content> b)
 {
-       return a->start() < b->start();
+       if (a->position() != b->position()) {
+               return a->position() < b->position();
+       }
+
+       /* Put video before audio if they start at the same time */
+       if (a->video && !b->video) {
+               return true;
+       } else if (!a->video && b->video) {
+               return false;
+       }
+
+       /* Last resort */
+       return a->digest() < b->digest();
+}
+
+/** @return content in ascending order of position */
+ContentList
+Playlist::content () const
+{
+       return _content;
+}
+
+void
+Playlist::repeat (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 ());
+       }
+
+       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);
+               }
+               pos += range.second - range.first;
+       }
+
+       sort (_content.begin(), _content.end(), ContentSorter ());
+
+       reconnect ();
+       Changed ();
+}
+
+void
+Playlist::move_earlier (shared_ptr<Content> c)
+{
+       ContentList::iterator previous = _content.end ();
+       ContentList::iterator i = _content.begin();
+       while (i != _content.end() && *i != c) {
+               previous = i;
+               ++i;
+       }
+
+       DCPOMATIC_ASSERT (i != _content.end ());
+       if (previous == _content.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);
+}
+
+void
+Playlist::move_later (shared_ptr<Content> c)
+{
+       ContentList::iterator i = _content.begin();
+       while (i != _content.end() && *i != c) {
+               ++i;
+       }
+
+       DCPOMATIC_ASSERT (i != _content.end ());
+
+       ContentList::iterator next = i;
+       ++next;
+
+       if (next == _content.end ()) {
+               return;
+       }
+
+       shared_ptr<Content> next_c = *next;
+
+       next_c->set_position (c->position ());
+       c->set_position (c->position() + next_c->length_after_trim ());
+}
+
+int64_t
+Playlist::required_disk_space (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 ();
+
+       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();
+                       }
+                       if (d->reference_audio()) {
+                               audio -= uint64_t (audio_channels * audio_frame_rate * 3) * d->length_after_trim().seconds();
+                       }
+               }
+       }
+
+       /* 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;
 }