Tweak logging format.
[dcpomatic.git] / src / lib / content.cc
index 16069b7a7967b52a1200c40d241e2a6e91ff20eb..af85e0ff08d17fcbf7fd4111ce27988d9fe405dd 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 <boost/thread/mutex.hpp>
-#include <libxml++/libxml++.h>
-#include <libcxml/cxml.h>
+/** @file  src/lib/content.cc
+ *  @brief Content class.
+ */
+
 #include "content.h"
 #include "util.h"
 #include "content_factory.h"
-#include "ui_signaller.h"
+#include "exceptions.h"
+#include "film.h"
+#include "safe_stringstream.h"
+#include "job.h"
+#include "compose.hpp"
+#include "raw_convert.h"
+#include <libcxml/cxml.h>
+#include <libxml++/libxml++.h>
+#include <boost/thread/mutex.hpp>
+#include <iostream>
+
+#include "i18n.h"
 
 using std::string;
-using std::stringstream;
-using std::set;
+using std::list;
 using std::cout;
+using std::vector;
+using std::max;
+using std::pair;
 using boost::shared_ptr;
-using boost::lexical_cast;
 
 int const ContentProperty::PATH = 400;
 int const ContentProperty::POSITION = 401;
@@ -38,8 +51,8 @@ int const ContentProperty::LENGTH = 402;
 int const ContentProperty::TRIM_START = 403;
 int const ContentProperty::TRIM_END = 404;
 
-Content::Content (shared_ptr<const Film> f)
-       : _film (f)
+Content::Content (shared_ptr<const Film> film)
+       : _film (film)
        , _position (0)
        , _trim_start (0)
        , _trim_end (0)
@@ -48,8 +61,8 @@ Content::Content (shared_ptr<const Film> f)
 
 }
 
-Content::Content (shared_ptr<const Film> fTime p)
-       : _film (f)
+Content::Content (shared_ptr<const Film> film, DCPTime p)
+       : _film (film)
        , _position (p)
        , _trim_start (0)
        , _trim_end (0)
@@ -58,8 +71,8 @@ Content::Content (shared_ptr<const Film> f, Time p)
 
 }
 
-Content::Content (shared_ptr<const Film> f, boost::filesystem::path p)
-       : _film (f)
+Content::Content (shared_ptr<const Film> film, boost::filesystem::path p)
+       : _film (film)
        , _position (0)
        , _trim_start (0)
        , _trim_end (0)
@@ -68,42 +81,72 @@ Content::Content (shared_ptr<const Film> f, boost::filesystem::path p)
        _paths.push_back (p);
 }
 
-Content::Content (shared_ptr<const Film> f, shared_ptr<const cxml::Node> node)
-       : _film (f)
+Content::Content (shared_ptr<const Film> film, cxml::ConstNodePtr node)
+       : _film (film)
        , _change_signals_frequent (false)
 {
-       _paths.push_back (node->string_child ("Path"));
-       _digest = node->string_child ("Digest");
-       _position = node->number_child<Time> ("Position");
-       _trim_start = node->number_child<Time> ("TrimStart");
-       _trim_end = node->number_child<Time> ("TrimEnd");
+       list<cxml::NodePtr> path_children = node->node_children ("Path");
+       for (list<cxml::NodePtr>::const_iterator i = path_children.begin(); i != path_children.end(); ++i) {
+               _paths.push_back ((*i)->content ());
+       }
+       _digest = node->optional_string_child ("Digest").get_value_or ("X");
+       _position = DCPTime (node->number_child<DCPTime::Type> ("Position"));
+       _trim_start = ContentTime (node->number_child<ContentTime::Type> ("TrimStart"));
+       _trim_end = ContentTime (node->number_child<ContentTime::Type> ("TrimEnd"));
+}
+
+Content::Content (shared_ptr<const Film> film, vector<shared_ptr<Content> > c)
+       : _film (film)
+       , _position (c.front()->position ())
+       , _trim_start (c.front()->trim_start ())
+       , _trim_end (c.back()->trim_end ())
+       , _change_signals_frequent (false)
+{
+       for (size_t i = 0; i < c.size(); ++i) {
+               if (i > 0 && c[i]->trim_start() > ContentTime ()) {
+                       throw JoinError (_("Only the first piece of content to be joined can have a start trim."));
+               }
+
+               if (i < (c.size() - 1) && c[i]->trim_end () > ContentTime ()) {
+                       throw JoinError (_("Only the last piece of content to be joined can have an end trim."));
+               }
+
+               for (size_t j = 0; j < c[i]->number_of_paths(); ++j) {
+                       _paths.push_back (c[i]->path (j));
+               }
+       }
 }
 
 void
 Content::as_xml (xmlpp::Node* node) const
 {
        boost::mutex::scoped_lock lm (_mutex);
-       
-       node->add_child("Path")->add_child_text (_paths.front().string());
+
+       for (vector<boost::filesystem::path>::const_iterator i = _paths.begin(); i != _paths.end(); ++i) {
+               node->add_child("Path")->add_child_text (i->string ());
+       }
        node->add_child("Digest")->add_child_text (_digest);
-       node->add_child("Position")->add_child_text (lexical_cast<string> (_position));
-       node->add_child("TrimStart")->add_child_text (lexical_cast<string> (_trim_start));
-       node->add_child("TrimEnd")->add_child_text (lexical_cast<string> (_trim_end));
+       node->add_child("Position")->add_child_text (raw_convert<string> (_position.get ()));
+       node->add_child("TrimStart")->add_child_text (raw_convert<string> (_trim_start.get ()));
+       node->add_child("TrimEnd")->add_child_text (raw_convert<string> (_trim_end.get ()));
 }
 
 void
 Content::examine (shared_ptr<Job> job)
 {
+       if (job) {
+               job->sub (_("Computing digest"));
+       }
+
        boost::mutex::scoped_lock lm (_mutex);
-       boost::filesystem::path p = _paths.front ();
+       vector<boost::filesystem::path> p = _paths;
        lm.unlock ();
-       
-       string d;
-       if (boost::filesystem::is_regular_file (p)) {
-               d = md5_digest (p);
-       } else {
-               d = md5_digest_directory (p, job);
-       }
+
+       /* Some content files are very big, so we use a poor man's
+          digest here: a MD5 of the first and last 1e6 bytes with the
+          size of the first file tacked on the end as a string.
+       */
+       string const d = md5_digest_head_tail (p, 1000000) + raw_convert<string> (boost::filesystem::file_size (p.front ()));
 
        lm.lock ();
        _digest = d;
@@ -112,16 +155,18 @@ Content::examine (shared_ptr<Job> job)
 void
 Content::signal_changed (int p)
 {
-       if (ui_signaller) {
-               ui_signaller->emit (boost::bind (boost::ref (Changed), shared_from_this (), p, _change_signals_frequent));
-       }
+       emit (boost::bind (boost::ref (Changed), shared_from_this (), p, _change_signals_frequent));
 }
 
 void
-Content::set_position (Time p)
+Content::set_position (DCPTime p)
 {
        {
                boost::mutex::scoped_lock lm (_mutex);
+               if (p == _position) {
+                       return;
+               }
+
                _position = p;
        }
 
@@ -129,7 +174,7 @@ Content::set_position (Time p)
 }
 
 void
-Content::set_trim_start (Time t)
+Content::set_trim_start (ContentTime t)
 {
        {
                boost::mutex::scoped_lock lm (_mutex);
@@ -140,7 +185,7 @@ Content::set_trim_start (Time t)
 }
 
 void
-Content::set_trim_end (Time t)
+Content::set_trim_end (ContentTime t)
 {
        {
                boost::mutex::scoped_lock lm (_mutex);
@@ -158,55 +203,55 @@ Content::clone () const
        if (!film) {
                return shared_ptr<Content> ();
        }
-       
+
        /* This is a bit naughty, but I can't think of a compelling reason not to do it ... */
        xmlpp::Document doc;
        xmlpp::Node* node = doc.create_root_node ("Content");
        as_xml (node);
-       return content_factory (film, cxml::NodePtr(new cxml::Node (node)));
+
+       /* notes is unused here (we assume) */
+       list<string> notes;
+       return content_factory (film, cxml::NodePtr (new cxml::Node (node)), Film::current_state_version, notes);
 }
 
 string
 Content::technical_summary () const
 {
-       return String::compose ("%1 %2 %3", path_summary(), digest(), position());
+       return String::compose ("%1 %2 %3", path_summary(), digest(), position().seconds());
 }
 
-Time
+DCPTime
 Content::length_after_trim () const
 {
-       return full_length() - trim_start() - trim_end();
+       return max (DCPTime (), full_length() - DCPTime (trim_start() + trim_end(), film()->active_frame_rate_change (position ())));
 }
 
-/** @param t A time relative to the start of this content (not the position).
- *  @return true if this time is trimmed by our trim settings.
- */
-bool
-Content::trimmed (Time t) const
-{
-       return (t < trim_start() || t > (full_length() - trim_end ()));
-}
-
-/** @return string which includes everything about how this content affects
- *  its playlist.
+/** @return string which changes when something about this content changes which affects
+ *  the appearance of its video.
  */
 string
 Content::identifier () const
 {
-       stringstream s;
-       
+       SafeStringStream s;
+
        s << Content::digest()
-         << "_" << position()
-         << "_" << trim_start()
-         << "_" << trim_end();
+         << "_" << position().get()
+         << "_" << trim_start().get()
+         << "_" << trim_end().get();
 
        return s.str ();
 }
 
 bool
-Content::path_valid () const
+Content::paths_valid () const
 {
-       return boost::filesystem::exists (_paths.front ());
+       for (vector<boost::filesystem::path>::const_iterator i = _paths.begin(); i != _paths.end(); ++i) {
+               if (!boost::filesystem::exists (*i)) {
+                       return false;
+               }
+       }
+
+       return true;
 }
 
 void
@@ -222,6 +267,8 @@ Content::path_summary () const
 {
        /* XXX: should handle multiple paths more gracefully */
 
+       DCPOMATIC_ASSERT (number_of_paths ());
+
        string s = path(0).filename().string ();
        if (number_of_paths() > 1) {
                s += " ...";
@@ -229,3 +276,22 @@ Content::path_summary () const
 
        return s;
 }
+
+/** @return a list of properties that might be interesting to the user; first string is the property name,
+ *  second is the value.
+ */
+list<pair<string, string> >
+Content::properties () const
+{
+       list<pair<string, string> > p;
+       add_properties (p);
+       return p;
+}
+
+shared_ptr<const Film>
+Content::film () const
+{
+       shared_ptr<const Film> film = _film.lock ();
+       DCPOMATIC_ASSERT (film);
+       return film;
+}