Rename SafeStringStream -> locked_stringstream. Bump deps for removal of stringstream.
[dcpomatic.git] / src / lib / playlist.cc
index 22412da4a3640b5313cd6d75cdb25422a4ee08f6..739c5a20b3d0317f506786ce8dbc4fd544a91bab 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 "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 "image_decoder.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>
+#include <boost/foreach.hpp>
+#include <iostream>
 
 #include "i18n.h"
 
@@ -47,8 +51,8 @@ using boost::weak_ptr;
 using boost::dynamic_pointer_cast;
 
 Playlist::Playlist ()
-       : _sequence_video (true)
-       , _sequencing_video (false)
+       : _sequence (true)
+       , _sequencing (false)
 {
 
 }
@@ -62,58 +66,95 @@ Playlist::~Playlist ()
 void
 Playlist::content_changed (weak_ptr<Content> content, int property, bool frequent)
 {
-       if (property == ContentProperty::LENGTH || property == VideoContentProperty::VIDEO_FRAME_TYPE) {
-               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 ();
+       }
+
+       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;
+
+       _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;
-       for (ContentList::iterator i = _content.begin(); i != _content.end(); ++i) {
-               shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (*i);
-               if (!vc) {
+       BOOST_FOREACH (shared_ptr<Content> i, _content) {
+               if (!i->video) {
                        continue;
                }
-               
-               if (vc->video_frame_type() == VIDEO_FRAME_TYPE_3D_RIGHT) {
-                       vc->set_position (next_right);
-                       next_right = vc->end() + DCPTime::delta ();
+
+               if (i->video->frame_type() == VIDEO_FRAME_TYPE_3D_RIGHT) {
+                       i->set_position (next_right);
+                       next_right = i->end();
                } else {
-                       vc->set_position (next_left);
-                       next_left = vc->end() + DCPTime::delta ();
+                       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_position (next);
+               next = i->end();
        }
 
+
        /* This won't change order, so it does not need a sort */
-       
-       _sequencing_video = false;
+
+       _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 ();
                }
        }
 
-       MD5Digester digester;
+       Digester digester;
        digester.add (t.c_str(), t.length());
        return digester.get ();
 }
@@ -122,11 +163,11 @@ Playlist::video_identifier () const
 void
 Playlist::set_from_xml (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version, list<string>& notes)
 {
-       list<cxml::NodePtr> c = node->node_children ("Content");
-       for (list<cxml::NodePtr>::iterator i = c.begin(); i != c.end(); ++i) {
-               _content.push_back (content_factory (film, *i, version, notes));
+       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 ();
@@ -136,8 +177,8 @@ Playlist::set_from_xml (shared_ptr<const Film> film, cxml::ConstNodePtr node, in
 void
 Playlist::as_xml (xmlpp::Node* node)
 {
-       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"));
        }
 }
 
@@ -157,7 +198,7 @@ Playlist::remove (shared_ptr<Content> c)
        while (i != _content.end() && *i != c) {
                ++i;
        }
-       
+
        if (i != _content.end ()) {
                _content.erase (i);
                Changed ();
@@ -169,19 +210,19 @@ Playlist::remove (shared_ptr<Content> c)
 void
 Playlist::remove (ContentList c)
 {
-       for (ContentList::iterator i = c.begin(); i != c.end(); ++i) {
+       BOOST_FOREACH (shared_ptr<Content> i, c) {
                ContentList::iterator j = _content.begin ();
-               while (j != _content.end() && *j != *i) {
+               while (j != _content.end() && *j != i) {
                        ++j;
                }
-       
+
                if (j != _content.end ()) {
                        _content.erase (j);
                }
        }
 
        /* This won't change order, so it does not need a sort */
-       
+
        Changed ();
 }
 
@@ -198,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 */
@@ -223,14 +264,19 @@ Playlist::best_dcp_frame_rate () const
        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;
                        }
 
+                       /* 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, float (fabs (i->source - vc->video_frame_rate ())));
+                       this_error = max (this_error, best_error);
                }
 
                if (this_error < error) {
@@ -244,21 +290,38 @@ Playlist::best_dcp_frame_rate () const
        if (!best) {
                return 24;
        }
-       
+
        return best->dcp;
 }
 
+/** @return length of the playlist from time 0 to the last thing on the playlist */
 DCPTime
 Playlist::length () const
 {
        DCPTime len;
-       for (ContentList::const_iterator i = _content.begin(); i != _content.end(); ++i) {
-               len = max (len, (*i)->end() + DCPTime::delta ());
+       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 ()
 {
@@ -267,9 +330,9 @@ 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, _3)));
+
+       BOOST_FOREACH (shared_ptr<Content> i, _content) {
+               _content_connections.push_back (i->Changed.connect (bind (&Playlist::content_changed, this, _1, _2, _3)));
        }
 }
 
@@ -277,9 +340,22 @@ DCPTime
 Playlist::video_end () const
 {
        DCPTime end;
-       for (ContentList::const_iterator i = _content.begin(); i != _content.end(); ++i) {
-               if (dynamic_pointer_cast<const VideoContent> (*i)) {
-                       end = max (end, (*i)->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 ());
                }
        }
 
@@ -289,14 +365,22 @@ Playlist::video_end () const
 FrameRateChange
 Playlist::active_frame_rate_change (DCPTime t, int dcp_video_frame_rate) const
 {
-       for (ContentList::const_iterator i = _content.begin(); i != _content.end(); ++i) {
-               shared_ptr<const VideoContent> vc = dynamic_pointer_cast<const VideoContent> (*i);
-               if (!vc) {
+       for (ContentList::const_reverse_iterator i = _content.rbegin(); i != _content.rend(); ++i) {
+               if (!(*i)->video) {
                        continue;
                }
 
-               if (vc->position() >= t && t < vc->end()) {
-                       return FrameRateChange (vc->video_frame_rate(), dcp_video_frame_rate);
+               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);
+                       }
                }
        }
 
@@ -304,18 +388,30 @@ Playlist::active_frame_rate_change (DCPTime t, int dcp_video_frame_rate) const
 }
 
 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->position() < b->position();
+       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 an undefined order */
+/** @return content in ascending order of position */
 ContentList
 Playlist::content () const
 {
@@ -326,17 +422,17 @@ void
 Playlist::repeat (ContentList c, int n)
 {
        pair<DCPTime, DCPTime> range (DCPTime::max (), DCPTime ());
-       for (ContentList::iterator i = c.begin(); i != c.end(); ++i) {
-               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 ());
+       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) {
-               for (ContentList::iterator i = c.begin(); i != c.end(); ++i) {
-                       shared_ptr<Content> copy = (*i)->clone ();
+               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);
                }
@@ -344,7 +440,7 @@ Playlist::repeat (ContentList c, int n)
        }
 
        sort (_content.begin(), _content.end(), ContentSorter ());
-       
+
        reconnect ();
        Changed ();
 }
@@ -352,8 +448,6 @@ Playlist::repeat (ContentList c, int n)
 void
 Playlist::move_earlier (shared_ptr<Content> c)
 {
-       sort (_content.begin(), _content.end(), ContentSorter ());
-       
        ContentList::iterator previous = _content.end ();
        ContentList::iterator i = _content.begin();
        while (i != _content.end() && *i != c) {
@@ -361,29 +455,27 @@ Playlist::move_earlier (shared_ptr<Content> c)
                ++i;
        }
 
-       assert (i != _content.end ());
+       DCPOMATIC_ASSERT (i != _content.end ());
        if (previous == _content.end ()) {
                return;
        }
 
-       
-       DCPTime const p = (*previous)->position ();
-       (*previous)->set_position (p + c->length_after_trim ());
+       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);
-       sort (_content.begin(), _content.end(), ContentSorter ());
 }
 
 void
 Playlist::move_later (shared_ptr<Content> c)
 {
-       sort (_content.begin(), _content.end(), ContentSorter ());
-       
        ContentList::iterator i = _content.begin();
        while (i != _content.end() && *i != c) {
                ++i;
        }
 
-       assert (i != _content.end ());
+       DCPOMATIC_ASSERT (i != _content.end ());
 
        ContentList::iterator next = i;
        ++next;
@@ -392,7 +484,30 @@ Playlist::move_later (shared_ptr<Content> c)
                return;
        }
 
-       (*next)->set_position (c->position ());
-       c->set_position (c->position() + c->length_after_trim ());
-       sort (_content.begin(), _content.end(), ContentSorter ());
+       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;
 }