src/lib/content.cc

   1 /*
   2     Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file  src/lib/content.cc
  21  *  @brief Content class.
  22  */
  23
  24 #include "content.h"
  25 #include "util.h"
  26 #include "content_factory.h"
  27 #include "ui_signaller.h"
  28 #include "exceptions.h"
  29 #include "film.h"
  30 #include "safe_stringstream.h"
  31 #include "job.h"
  32 #include <libcxml/cxml.h>
  33 #include <dcp/raw_convert.h>
  34 #include <libxml++/libxml++.h>
  35 #include <boost/thread/mutex.hpp>
  36
  37 #include "i18n.h"
  38
  39 using std::string;
  40 using std::set;
  41 using std::list;
  42 using std::cout;
  43 using std::vector;
  44 using std::max;
  45 using boost::shared_ptr;
  46 using dcp::raw_convert;
  47
  48 int const ContentProperty::PATH = 400;
  49 int const ContentProperty::POSITION = 401;
  50 int const ContentProperty::LENGTH = 402;
  51 int const ContentProperty::TRIM_START = 403;
  52 int const ContentProperty::TRIM_END = 404;
  53
  54 Content::Content (shared_ptr<const Film> f)
  55         : _film (f)
  56         , _position (0)
  57         , _trim_start (0)
  58         , _trim_end (0)
  59         , _change_signals_frequent (false)
  60 {
  61
  62 }
  63
  64 Content::Content (shared_ptr<const Film> f, DCPTime p)
  65         : _film (f)
  66         , _position (p)
  67         , _trim_start (0)
  68         , _trim_end (0)
  69         , _change_signals_frequent (false)
  70 {
  71
  72 }
  73
  74 Content::Content (shared_ptr<const Film> f, boost::filesystem::path p)
  75         : _film (f)
  76         , _position (0)
  77         , _trim_start (0)
  78         , _trim_end (0)
  79         , _change_signals_frequent (false)
  80 {
  81         _paths.push_back (p);
  82 }
  83
  84 Content::Content (shared_ptr<const Film> f, cxml::ConstNodePtr node)
  85         : _film (f)
  86         , _change_signals_frequent (false)
  87 {
  88         list<cxml::NodePtr> path_children = node->node_children ("Path");
  89         for (list<cxml::NodePtr>::const_iterator i = path_children.begin(); i != path_children.end(); ++i) {
  90                 _paths.push_back ((*i)->content ());
  91         }
  92         _digest = node->optional_string_child ("Digest");
  93         _position = DCPTime (node->number_child<double> ("Position"));
  94         _trim_start = DCPTime (node->number_child<double> ("TrimStart"));
  95         _trim_end = DCPTime (node->number_child<double> ("TrimEnd"));
  96 }
  97
  98 Content::Content (shared_ptr<const Film> f, vector<shared_ptr<Content> > c)
  99         : _film (f)
 100         , _position (c.front()->position ())
 101         , _trim_start (c.front()->trim_start ())
 102         , _trim_end (c.back()->trim_end ())
 103         , _change_signals_frequent (false)
 104 {
 105         for (size_t i = 0; i < c.size(); ++i) {
 106                 if (i > 0 && c[i]->trim_start() > DCPTime()) {
 107                         throw JoinError (_("Only the first piece of content to be joined can have a start trim."));
 108                 }
 109
 110                 if (i < (c.size() - 1) && c[i]->trim_end () > DCPTime()) {
 111                         throw JoinError (_("Only the last piece of content to be joined can have an end trim."));
 112                 }
 113
 114                 for (size_t j = 0; j < c[i]->number_of_paths(); ++j) {
 115                         _paths.push_back (c[i]->path (j));
 116                 }
 117         }
 118 }
 119
 120 void
 121 Content::as_xml (xmlpp::Node* node) const
 122 {
 123         boost::mutex::scoped_lock lm (_mutex);
 124
 125         for (vector<boost::filesystem::path>::const_iterator i = _paths.begin(); i != _paths.end(); ++i) {
 126                 node->add_child("Path")->add_child_text (i->string ());
 127         }
 128         if (_digest) {
 129                 node->add_child("Digest")->add_child_text (_digest.get ());
 130         }
 131         node->add_child("Position")->add_child_text (raw_convert<string> (_position.get ()));
 132         node->add_child("TrimStart")->add_child_text (raw_convert<string> (_trim_start.get ()));
 133         node->add_child("TrimEnd")->add_child_text (raw_convert<string> (_trim_end.get ()));
 134 }
 135
 136 void
 137 Content::examine (shared_ptr<Job> job, bool calculate_digest)
 138 {
 139         if (!calculate_digest) {
 140                 return;
 141         }
 142
 143         job->sub (_("Computing digest"));
 144
 145         boost::mutex::scoped_lock lm (_mutex);
 146         vector<boost::filesystem::path> p = _paths;
 147         lm.unlock ();
 148
 149         string const d = md5_digest (p, job);
 150
 151         lm.lock ();
 152         _digest = d;
 153 }
 154
 155 void
 156 Content::signal_changed (int p)
 157 {
 158         if (ui_signaller) {
 159                 ui_signaller->emit (boost::bind (boost::ref (Changed), shared_from_this (), p, _change_signals_frequent));
 160         }
 161 }
 162
 163 void
 164 Content::set_position (DCPTime p)
 165 {
 166         {
 167                 boost::mutex::scoped_lock lm (_mutex);
 168                 if (p == _position) {
 169                         return;
 170                 }
 171
 172                 _position = p;
 173         }
 174
 175         signal_changed (ContentProperty::POSITION);
 176 }
 177
 178 void
 179 Content::set_trim_start (DCPTime t)
 180 {
 181         {
 182                 boost::mutex::scoped_lock lm (_mutex);
 183                 _trim_start = t;
 184         }
 185
 186         signal_changed (ContentProperty::TRIM_START);
 187 }
 188
 189 void
 190 Content::set_trim_end (DCPTime t)
 191 {
 192         {
 193                 boost::mutex::scoped_lock lm (_mutex);
 194                 _trim_end = t;
 195         }
 196
 197         signal_changed (ContentProperty::TRIM_END);
 198 }
 199
 200
 201 shared_ptr<Content>
 202 Content::clone () const
 203 {
 204         shared_ptr<const Film> film = _film.lock ();
 205         if (!film) {
 206                 return shared_ptr<Content> ();
 207         }
 208
 209         /* This is a bit naughty, but I can't think of a compelling reason not to do it ... */
 210         xmlpp::Document doc;
 211         xmlpp::Node* node = doc.create_root_node ("Content");
 212         as_xml (node);
 213
 214         /* notes is unused here (we assume) */
 215         list<string> notes;
 216         return content_factory (film, cxml::NodePtr (new cxml::Node (node)), Film::current_state_version, notes);
 217 }
 218
 219 string
 220 Content::technical_summary () const
 221 {
 222         return String::compose ("%1 %2 %3", path_summary(), digest(), position().seconds());
 223 }
 224
 225 DCPTime
 226 Content::length_after_trim () const
 227 {
 228         return max (DCPTime (), full_length() - trim_start() - trim_end());
 229 }
 230
 231 /** @return string which includes everything about how this content affects
 232  *  its playlist.
 233  */
 234 string
 235 Content::identifier () const
 236 {
 237         SafeStringStream s;
 238
 239         s << Content::digest()
 240           << "_" << position().get()
 241           << "_" << trim_start().get()
 242           << "_" << trim_end().get();
 243
 244         return s.str ();
 245 }
 246
 247 bool
 248 Content::paths_valid () const
 249 {
 250         for (vector<boost::filesystem::path>::const_iterator i = _paths.begin(); i != _paths.end(); ++i) {
 251                 if (!boost::filesystem::exists (*i)) {
 252                         return false;
 253                 }
 254         }
 255
 256         return true;
 257 }
 258
 259 void
 260 Content::set_path (boost::filesystem::path path)
 261 {
 262         _paths.clear ();
 263         _paths.push_back (path);
 264         signal_changed (ContentProperty::PATH);
 265 }
 266
 267 string
 268 Content::path_summary () const
 269 {
 270         /* XXX: should handle multiple paths more gracefully */
 271
 272         assert (number_of_paths ());
 273
 274         string s = path(0).filename().string ();
 275         if (number_of_paths() > 1) {
 276                 s += " ...";
 277         }
 278
 279         return s;
 280 }