src/lib/content.cc

   1 /*
   2     Copyright (C) 2013 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 #include <boost/thread/mutex.hpp>
  21 #include <libxml++/libxml++.h>
  22 #include <libcxml/cxml.h>
  23 #include "content.h"
  24 #include "util.h"
  25 #include "content_factory.h"
  26 #include "ui_signaller.h"
  27 #include "exceptions.h"
  28 #include "film.h"
  29
  30 #include "i18n.h"
  31
  32 using std::string;
  33 using std::stringstream;
  34 using std::set;
  35 using std::list;
  36 using std::cout;
  37 using std::vector;
  38 using boost::shared_ptr;
  39 using boost::lexical_cast;
  40
  41 int const ContentProperty::PATH = 400;
  42 int const ContentProperty::POSITION = 401;
  43 int const ContentProperty::LENGTH = 402;
  44 int const ContentProperty::TRIM_START = 403;
  45 int const ContentProperty::TRIM_END = 404;
  46
  47 Content::Content (shared_ptr<const Film> f)
  48         : _film (f)
  49         , _position (0)
  50         , _trim_start (0)
  51         , _trim_end (0)
  52         , _change_signals_frequent (false)
  53 {
  54
  55 }
  56
  57 Content::Content (shared_ptr<const Film> f, DCPTime p)
  58         : _film (f)
  59         , _position (p)
  60         , _trim_start (0)
  61         , _trim_end (0)
  62         , _change_signals_frequent (false)
  63 {
  64
  65 }
  66
  67 Content::Content (shared_ptr<const Film> f, boost::filesystem::path p)
  68         : _film (f)
  69         , _position (0)
  70         , _trim_start (0)
  71         , _trim_end (0)
  72         , _change_signals_frequent (false)
  73 {
  74         _paths.push_back (p);
  75 }
  76
  77 Content::Content (shared_ptr<const Film> f, shared_ptr<const cxml::Node> node)
  78         : _film (f)
  79         , _change_signals_frequent (false)
  80 {
  81         list<cxml::NodePtr> path_children = node->node_children ("Path");
  82         for (list<cxml::NodePtr>::const_iterator i = path_children.begin(); i != path_children.end(); ++i) {
  83                 _paths.push_back ((*i)->content ());
  84         }
  85         _digest = node->string_child ("Digest");
  86         _position = node->number_child<DCPTime> ("Position");
  87         _trim_start = node->number_child<DCPTime> ("TrimStart");
  88         _trim_end = node->number_child<DCPTime> ("TrimEnd");
  89 }
  90
  91 Content::Content (shared_ptr<const Film> f, vector<shared_ptr<Content> > c)
  92         : _film (f)
  93         , _position (c.front()->position ())
  94         , _trim_start (c.front()->trim_start ())
  95         , _trim_end (c.back()->trim_end ())
  96         , _change_signals_frequent (false)
  97 {
  98         for (size_t i = 0; i < c.size(); ++i) {
  99                 if (i > 0 && c[i]->trim_start ()) {
 100                         throw JoinError (_("Only the first piece of content to be joined can have a start trim."));
 101                 }
 102
 103                 if (i < (c.size() - 1) && c[i]->trim_end ()) {
 104                         throw JoinError (_("Only the last piece of content to be joined can have an end trim."));
 105                 }
 106
 107                 for (size_t j = 0; j < c[i]->number_of_paths(); ++j) {
 108                         _paths.push_back (c[i]->path (j));
 109                 }
 110         }
 111 }
 112
 113 void
 114 Content::as_xml (xmlpp::Node* node) const
 115 {
 116         boost::mutex::scoped_lock lm (_mutex);
 117
 118         for (vector<boost::filesystem::path>::const_iterator i = _paths.begin(); i != _paths.end(); ++i) {
 119                 node->add_child("Path")->add_child_text (i->string ());
 120         }
 121         node->add_child("Digest")->add_child_text (_digest);
 122         node->add_child("Position")->add_child_text (lexical_cast<string> (_position));
 123         node->add_child("TrimStart")->add_child_text (lexical_cast<string> (_trim_start));
 124         node->add_child("TrimEnd")->add_child_text (lexical_cast<string> (_trim_end));
 125 }
 126
 127 void
 128 Content::examine (shared_ptr<Job> job)
 129 {
 130         boost::mutex::scoped_lock lm (_mutex);
 131         vector<boost::filesystem::path> p = _paths;
 132         lm.unlock ();
 133
 134         string const d = md5_digest (p, job);
 135
 136         lm.lock ();
 137         _digest = d;
 138 }
 139
 140 void
 141 Content::signal_changed (int p)
 142 {
 143         if (ui_signaller) {
 144                 ui_signaller->emit (boost::bind (boost::ref (Changed), shared_from_this (), p, _change_signals_frequent));
 145         }
 146 }
 147
 148 void
 149 Content::set_position (DCPTime p)
 150 {
 151         {
 152                 boost::mutex::scoped_lock lm (_mutex);
 153                 _position = p;
 154         }
 155
 156         signal_changed (ContentProperty::POSITION);
 157 }
 158
 159 void
 160 Content::set_trim_start (DCPTime t)
 161 {
 162         {
 163                 boost::mutex::scoped_lock lm (_mutex);
 164                 _trim_start = t;
 165         }
 166
 167         signal_changed (ContentProperty::TRIM_START);
 168 }
 169
 170 void
 171 Content::set_trim_end (DCPTime t)
 172 {
 173         {
 174                 boost::mutex::scoped_lock lm (_mutex);
 175                 _trim_end = t;
 176         }
 177
 178         signal_changed (ContentProperty::TRIM_END);
 179 }
 180
 181
 182 shared_ptr<Content>
 183 Content::clone () const
 184 {
 185         shared_ptr<const Film> film = _film.lock ();
 186         if (!film) {
 187                 return shared_ptr<Content> ();
 188         }
 189
 190         /* This is a bit naughty, but I can't think of a compelling reason not to do it ... */
 191         xmlpp::Document doc;
 192         xmlpp::Node* node = doc.create_root_node ("Content");
 193         as_xml (node);
 194         return content_factory (film, cxml::NodePtr (new cxml::Node (node)), Film::state_version);
 195 }
 196
 197 string
 198 Content::technical_summary () const
 199 {
 200         return String::compose ("%1 %2 %3", path_summary(), digest(), position());
 201 }
 202
 203 DCPTime
 204 Content::length_after_trim () const
 205 {
 206         return full_length() - trim_start() - trim_end();
 207 }
 208
 209 /** @param t A time relative to the start of this content (not the position).
 210  *  @return true if this time is trimmed by our trim settings.
 211  */
 212 bool
 213 Content::trimmed (DCPTime t) const
 214 {
 215         return (t < trim_start() || t > (full_length() - trim_end ()));
 216 }
 217
 218 /** @return string which includes everything about how this content affects
 219  *  its playlist.
 220  */
 221 string
 222 Content::identifier () const
 223 {
 224         stringstream s;
 225
 226         s << Content::digest()
 227           << "_" << position()
 228           << "_" << trim_start()
 229           << "_" << trim_end();
 230
 231         return s.str ();
 232 }
 233
 234 bool
 235 Content::paths_valid () const
 236 {
 237         for (vector<boost::filesystem::path>::const_iterator i = _paths.begin(); i != _paths.end(); ++i) {
 238                 if (!boost::filesystem::exists (*i)) {
 239                         return false;
 240                 }
 241         }
 242
 243         return true;
 244 }
 245
 246 void
 247 Content::set_path (boost::filesystem::path path)
 248 {
 249         _paths.clear ();
 250         _paths.push_back (path);
 251         signal_changed (ContentProperty::PATH);
 252 }
 253
 254 string
 255 Content::path_summary () const
 256 {
 257         /* XXX: should handle multiple paths more gracefully */
 258
 259         assert (number_of_paths ());
 260
 261         string s = path(0).filename().string ();
 262         if (number_of_paths() > 1) {
 263                 s += " ...";
 264         }
 265
 266         return s;
 267 }