src/lib/content.cc

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