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