src/lib/content.cc

   1 /*
   2     Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 /** @file  src/lib/content.cc
  22  *  @brief Content class.
  23  */
  24
  25 #include "content.h"
  26 #include "util.h"
  27 #include "content_factory.h"
  28 #include "exceptions.h"
  29 #include "film.h"
  30 #include "safe_stringstream.h"
  31 #include "job.h"
  32 #include "compose.hpp"
  33 #include "raw_convert.h"
  34 #include <libcxml/cxml.h>
  35 #include <libxml++/libxml++.h>
  36 #include <boost/thread/mutex.hpp>
  37 #include <iostream>
  38
  39 #include "i18n.h"
  40
  41 using std::string;
  42 using std::list;
  43 using std::cout;
  44 using std::vector;
  45 using std::max;
  46 using std::pair;
  47 using boost::shared_ptr;
  48
  49 int const ContentProperty::PATH = 400;
  50 int const ContentProperty::POSITION = 401;
  51 int const ContentProperty::LENGTH = 402;
  52 int const ContentProperty::TRIM_START = 403;
  53 int const ContentProperty::TRIM_END = 404;
  54 int const ContentProperty::VIDEO_FRAME_RATE = 405;
  55
  56 Content::Content (shared_ptr<const Film> film)
  57         : _film (film)
  58         , _position (0)
  59         , _trim_start (0)
  60         , _trim_end (0)
  61         , _change_signals_frequent (false)
  62 {
  63
  64 }
  65
  66 Content::Content (shared_ptr<const Film> film, DCPTime p)
  67         : _film (film)
  68         , _position (p)
  69         , _trim_start (0)
  70         , _trim_end (0)
  71         , _change_signals_frequent (false)
  72 {
  73
  74 }
  75
  76 Content::Content (shared_ptr<const Film> film, boost::filesystem::path p)
  77         : _film (film)
  78         , _position (0)
  79         , _trim_start (0)
  80         , _trim_end (0)
  81         , _change_signals_frequent (false)
  82 {
  83         _paths.push_back (p);
  84 }
  85
  86 Content::Content (shared_ptr<const Film> film, cxml::ConstNodePtr node)
  87         : _film (film)
  88         , _change_signals_frequent (false)
  89 {
  90         list<cxml::NodePtr> path_children = node->node_children ("Path");
  91         for (list<cxml::NodePtr>::const_iterator i = path_children.begin(); i != path_children.end(); ++i) {
  92                 _paths.push_back ((*i)->content ());
  93         }
  94         _digest = node->optional_string_child ("Digest").get_value_or ("X");
  95         _position = DCPTime (node->number_child<DCPTime::Type> ("Position"));
  96         _trim_start = ContentTime (node->number_child<ContentTime::Type> ("TrimStart"));
  97         _trim_end = ContentTime (node->number_child<ContentTime::Type> ("TrimEnd"));
  98 }
  99
 100 Content::Content (shared_ptr<const Film> film, vector<shared_ptr<Content> > c)
 101         : _film (film)
 102         , _position (c.front()->position ())
 103         , _trim_start (c.front()->trim_start ())
 104         , _trim_end (c.back()->trim_end ())
 105         , _change_signals_frequent (false)
 106 {
 107         for (size_t i = 0; i < c.size(); ++i) {
 108                 if (i > 0 && c[i]->trim_start() > ContentTime ()) {
 109                         throw JoinError (_("Only the first piece of content to be joined can have a start trim."));
 110                 }
 111
 112                 if (i < (c.size() - 1) && c[i]->trim_end () > ContentTime ()) {
 113                         throw JoinError (_("Only the last piece of content to be joined can have an end trim."));
 114                 }
 115
 116                 for (size_t j = 0; j < c[i]->number_of_paths(); ++j) {
 117                         _paths.push_back (c[i]->path (j));
 118                 }
 119         }
 120 }
 121
 122 void
 123 Content::as_xml (xmlpp::Node* node) const
 124 {
 125         boost::mutex::scoped_lock lm (_mutex);
 126
 127         for (vector<boost::filesystem::path>::const_iterator i = _paths.begin(); i != _paths.end(); ++i) {
 128                 node->add_child("Path")->add_child_text (i->string ());
 129         }
 130         node->add_child("Digest")->add_child_text (_digest);
 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)
 138 {
 139         if (job) {
 140                 job->sub (_("Computing digest"));
 141         }
 142
 143         boost::mutex::scoped_lock lm (_mutex);
 144         vector<boost::filesystem::path> p = _paths;
 145         lm.unlock ();
 146
 147         /* Some content files are very big, so we use a poor man's
 148            digest here: a MD5 of the first and last 1e6 bytes with the
 149            size of the first file tacked on the end as a string.
 150         */
 151         string const d = md5_digest_head_tail (p, 1000000) + raw_convert<string> (boost::filesystem::file_size (p.front ()));
 152
 153         lm.lock ();
 154         _digest = d;
 155 }
 156
 157 void
 158 Content::signal_changed (int p)
 159 {
 160         try {
 161                 emit (boost::bind (boost::ref (Changed), shared_from_this (), p, _change_signals_frequent));
 162         } catch (boost::bad_weak_ptr) {
 163                 /* This must be during construction; never mind */
 164         }
 165 }
 166
 167 void
 168 Content::set_position (DCPTime p)
 169 {
 170         {
 171                 boost::mutex::scoped_lock lm (_mutex);
 172                 if (p == _position) {
 173                         return;
 174                 }
 175
 176                 _position = p;
 177         }
 178
 179         signal_changed (ContentProperty::POSITION);
 180 }
 181
 182 void
 183 Content::set_trim_start (ContentTime t)
 184 {
 185         {
 186                 boost::mutex::scoped_lock lm (_mutex);
 187                 _trim_start = t;
 188         }
 189
 190         signal_changed (ContentProperty::TRIM_START);
 191 }
 192
 193 void
 194 Content::set_trim_end (ContentTime t)
 195 {
 196         {
 197                 boost::mutex::scoped_lock lm (_mutex);
 198                 _trim_end = t;
 199         }
 200
 201         signal_changed (ContentProperty::TRIM_END);
 202 }
 203
 204
 205 shared_ptr<Content>
 206 Content::clone () const
 207 {
 208         shared_ptr<const Film> film = _film.lock ();
 209         if (!film) {
 210                 return shared_ptr<Content> ();
 211         }
 212
 213         /* This is a bit naughty, but I can't think of a compelling reason not to do it ... */
 214         xmlpp::Document doc;
 215         xmlpp::Node* node = doc.create_root_node ("Content");
 216         as_xml (node);
 217
 218         /* notes is unused here (we assume) */
 219         list<string> notes;
 220         return content_factory (film, cxml::NodePtr (new cxml::Node (node)), Film::current_state_version, notes);
 221 }
 222
 223 string
 224 Content::technical_summary () const
 225 {
 226         return String::compose ("%1 %2 %3", path_summary(), digest(), position().seconds());
 227 }
 228
 229 DCPTime
 230 Content::length_after_trim () const
 231 {
 232         return max (DCPTime (), full_length() - DCPTime (trim_start() + trim_end(), film()->active_frame_rate_change (position ())));
 233 }
 234
 235 /** @return string which changes when something about this content changes which affects
 236  *  the appearance of its video.
 237  */
 238 string
 239 Content::identifier () const
 240 {
 241         SafeStringStream s;
 242
 243         s << Content::digest()
 244           << "_" << position().get()
 245           << "_" << trim_start().get()
 246           << "_" << trim_end().get();
 247
 248         return s.str ();
 249 }
 250
 251 bool
 252 Content::paths_valid () const
 253 {
 254         for (vector<boost::filesystem::path>::const_iterator i = _paths.begin(); i != _paths.end(); ++i) {
 255                 if (!boost::filesystem::exists (*i)) {
 256                         return false;
 257                 }
 258         }
 259
 260         return true;
 261 }
 262
 263 void
 264 Content::set_path (boost::filesystem::path path)
 265 {
 266         _paths.clear ();
 267         _paths.push_back (path);
 268         signal_changed (ContentProperty::PATH);
 269 }
 270
 271 string
 272 Content::path_summary () const
 273 {
 274         /* XXX: should handle multiple paths more gracefully */
 275
 276         DCPOMATIC_ASSERT (number_of_paths ());
 277
 278         string s = path(0).filename().string ();
 279         if (number_of_paths() > 1) {
 280                 s += " ...";
 281         }
 282
 283         return s;
 284 }
 285
 286 /** @return a list of properties that might be interesting to the user */
 287 list<UserProperty>
 288 Content::user_properties () const
 289 {
 290         list<UserProperty> p;
 291         add_properties (p);
 292         return p;
 293 }
 294
 295 shared_ptr<const Film>
 296 Content::film () const
 297 {
 298         shared_ptr<const Film> film = _film.lock ();
 299         DCPOMATIC_ASSERT (film);
 300         return film;
 301 }
 302
 303 /** @return DCP times of points within this content where a reel split could occur */
 304 list<DCPTime>
 305 Content::reel_split_points () const
 306 {
 307         list<DCPTime> t;
 308         /* XXX: this is questionable; perhaps the position itself should be forced to be on a frame boundary */
 309         t.push_back (position().round_up (film()->video_frame_rate()));
 310         return t;
 311 }
 312
 313 void
 314 Content::set_video_frame_rate (double r)
 315 {
 316         {
 317                 boost::mutex::scoped_lock lm (_mutex);
 318                 _video_frame_rate = r;
 319         }
 320
 321         signal_changed (ContentProperty::VIDEO_FRAME_RATE);
 322 }
 323
 324 double
 325 Content::active_video_frame_rate () const
 326 {
 327         {
 328                 boost::mutex::scoped_lock lm (_mutex);
 329                 if (_video_frame_rate) {
 330                         return _video_frame_rate.get ();
 331                 }
 332         }
 333
 334         /* No frame rate specified, so assume this content has been
 335            prepared for any concurrent video content or perhaps
 336            just the DCP rate.
 337         */
 338         shared_ptr<const Film> film = _film.lock ();
 339         DCPOMATIC_ASSERT (film);
 340         return film->active_frame_rate_change(position()).source;
 341 }