Use uchardet to guess encoding of subtitle files and reject non-UTF-8.
[dcpomatic.git] / src / lib / playlist.cc
index 9cc1789d135d5c38a66e416b4c90888421d7142e..7c8ca0530a8f357f911df8d5b96e0b502a1ca3a8 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 */
 
-#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 "ffmpeg_decoder.h"
 #include "ffmpeg_content.h"
-#include "imagemagick_decoder.h"
-#include "imagemagick_content.h"
+#include "image_decoder.h"
+#include "content_factory.h"
 #include "job.h"
 #include "config.h"
 #include "util.h"
+#include "md5_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 +43,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)
+       : _sequence_video (true)
        , _sequencing_video (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,93 +63,99 @@ 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 && _sequence_video && !_sequencing_video) {
-               _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)) {
-                               continue;
-                       }
+       /* 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.
+       */
+
+       if (property == ContentProperty::LENGTH || property == VideoContentProperty::VIDEO_FRAME_TYPE) {
+               maybe_sequence_video ();
+       }
+
+       ContentChanged (content, property, frequent);
+}
 
-                       (*i)->set_start (last);
-                       last = (*i)->end ();
+void
+Playlist::maybe_sequence_video ()
+{
+       if (!_sequence_video || _sequencing_video) {
+               return;
+       }
+
+       _sequencing_video = true;
+
+       DCPTime next_left;
+       DCPTime next_right;
+       BOOST_FOREACH (shared_ptr<Content> i, _content) {
+               shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (i);
+               if (!vc) {
+                       continue;
                }
 
-               _sequencing_video = false;
+               if (vc->video_frame_type() == VIDEO_FRAME_TYPE_3D_RIGHT) {
+                       vc->set_position (next_right);
+                       next_right = vc->end() + DCPTime::delta ();
+               } else {
+                       vc->set_position (next_left);
+                       next_left = vc->end() + DCPTime::delta ();
+               }
        }
-       
-       ContentChanged (c, p);
+
+       /* This won't change order, so it does not need a sort */
+
+       _sequencing_video = false;
 }
 
 string
-Playlist::video_digest () const
+Playlist::video_identifier () const
 {
        string t;
-       
-       for (ContentList::const_iterator i = _content.begin(); i != _content.end(); ++i) {
-               if (!dynamic_pointer_cast<const VideoContent> (*i)) {
-                       continue;
-               }
-               
-               t += (*i)->digest ();
-               shared_ptr<const FFmpegContent> fc = dynamic_pointer_cast<const FFmpegContent> (*i);
-               if (fc && fc->subtitle_stream()) {
-                       t += fc->subtitle_stream()->id;
+
+       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 ();
                }
        }
 
-       t += lexical_cast<string> (_loop);
-
-       return md5_digest (t.c_str(), t.length());
+       MD5Digester 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));
        }
 
+       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)
 {
-       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"));
        }
-
-       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 ();
 }
@@ -168,31 +167,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
@@ -226,20 +226,27 @@ 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 = std::numeric_limits<float>::max ();
-               for (ContentList::const_iterator j = _content.begin(); j != _content.end(); ++j) {
-                       shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (*j);
+               float this_error = 0;
+               BOOST_FOREACH (shared_ptr<Content> j, _content) {
+                       shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (j);
                        if (!vc) {
                                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 - vc->video_frame_rate ())),
+                               float (fabs (i->source - vc->video_frame_rate () * 2))
+                               );
+
+                       /* Use the largest difference between DCP and source as the "error" */
+                       this_error = max (this_error, best_error);
                }
 
                if (this_error < error) {
@@ -253,21 +260,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 ()
 {
@@ -276,25 +300,45 @@ 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 (dynamic_pointer_cast<const VideoContent> (i)) {
+                       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) {
+               shared_ptr<const VideoContent> vc = dynamic_pointer_cast<const VideoContent> (*i);
+               if (!vc) {
+                       continue;
+               }
+
+               if (vc->position() <= t) {
+                       /* This is the first piece of content (going backwards...) that starts before t,
+                          so it's the active one.
+                       */
+                       return FrameRateChange (vc->video_frame_rate(), dcp_video_frame_rate);
+               }
+       }
+
+       return FrameRateChange (dcp_video_frame_rate, dcp_video_frame_rate);
+}
+
 void
 Playlist::set_sequence_video (bool s)
 {
@@ -304,5 +348,87 @@ Playlist::set_sequence_video (bool s)
 bool
 ContentSorter::operator() (shared_ptr<Content> a, shared_ptr<Content> b)
 {
-       return a->start() < b->start();
+       return a->position() < b->position();
+}
+
+/** @return content in an undefined order */
+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)
+{
+       sort (_content.begin(), _content.end(), ContentSorter ());
+
+       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;
+       }
+
+
+       DCPTime const p = (*previous)->position ();
+       (*previous)->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;
+       }
+
+       DCPOMATIC_ASSERT (i != _content.end ());
+
+       ContentList::iterator next = i;
+       ++next;
+
+       if (next == _content.end ()) {
+               return;
+       }
+
+       (*next)->set_position (c->position ());
+       c->set_position (c->position() + (*next)->length_after_trim ());
+       sort (_content.begin(), _content.end(), ContentSorter ());
 }