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 "locale_convert.h"
  31 #include "job.h"
  32 #include "compose.hpp"
  33 #include <dcp/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 using dcp::raw_convert;
  49
  50 int const ContentProperty::PATH = 400;
  51 int const ContentProperty::POSITION = 401;
  52 int const ContentProperty::LENGTH = 402;
  53 int const ContentProperty::TRIM_START = 403;
  54 int const ContentProperty::TRIM_END = 404;
  55 int const ContentProperty::VIDEO_FRAME_RATE = 405;
  56
  57 Content::Content (shared_ptr<const Film> film)
  58         : _film (film)
  59         , _position (0)
  60         , _trim_start (0)
  61         , _trim_end (0)
  62         , _change_signals_frequent (false)
  63 {
  64
  65 }
  66
  67 Content::Content (shared_ptr<const Film> film, DCPTime p)
  68         : _film (film)
  69         , _position (p)
  70         , _trim_start (0)
  71         , _trim_end (0)
  72         , _change_signals_frequent (false)
  73 {
  74
  75 }
  76
  77 Content::Content (shared_ptr<const Film> film, boost::filesystem::path p)
  78         : _film (film)
  79         , _position (0)
  80         , _trim_start (0)
  81         , _trim_end (0)
  82         , _change_signals_frequent (false)
  83 {
  84         _paths.push_back (p);
  85 }
  86
  87 Content::Content (shared_ptr<const Film> film, cxml::ConstNodePtr node)
  88         : _film (film)
  89         , _change_signals_frequent (false)
  90 {
  91         list<cxml::NodePtr> path_children = node->node_children ("Path");
  92         for (list<cxml::NodePtr>::const_iterator i = path_children.begin(); i != path_children.end(); ++i) {
  93                 _paths.push_back ((*i)->content ());
  94         }
  95         _digest = node->optional_string_child ("Digest").get_value_or ("X");
  96         _position = DCPTime (node->number_child<DCPTime::Type> ("Position"));
  97         _trim_start = ContentTime (node->number_child<ContentTime::Type> ("TrimStart"));
  98         _trim_end = ContentTime (node->number_child<ContentTime::Type> ("TrimEnd"));
  99         _video_frame_rate = node->optional_number_child<double> ("VideoFrameRate");
 100 }
 101
 102 Content::Content (shared_ptr<const Film> film, vector<shared_ptr<Content> > c)
 103         : _film (film)
 104         , _position (c.front()->position ())
 105         , _trim_start (c.front()->trim_start ())
 106         , _trim_end (c.back()->trim_end ())
 107         , _video_frame_rate (c.front()->video_frame_rate())
 108         , _change_signals_frequent (false)
 109 {
 110         for (size_t i = 0; i < c.size(); ++i) {
 111                 if (i > 0 && c[i]->trim_start() > ContentTime ()) {
 112                         throw JoinError (_("Only the first piece of content to be joined can have a start trim."));
 113                 }
 114
 115                 if (i < (c.size() - 1) && c[i]->trim_end () > ContentTime ()) {
 116                         throw JoinError (_("Only the last piece of content to be joined can have an end trim."));
 117                 }
 118
 119                 if (
 120                         (_video_frame_rate && !c[i]->_video_frame_rate) ||
 121                         (!_video_frame_rate && c[i]->_video_frame_rate)
 122                         ) {
 123                         throw JoinError (_("Content to be joined must have the same video frame rate"));
 124                 }
 125
 126                 if (_video_frame_rate && fabs (_video_frame_rate.get() - c[i]->_video_frame_rate.get()) > VIDEO_FRAME_RATE_EPSILON) {
 127                         throw JoinError (_("Content to be joined must have the same video frame rate"));
 128                 }
 129
 130                 for (size_t j = 0; j < c[i]->number_of_paths(); ++j) {
 131                         _paths.push_back (c[i]->path (j));
 132                 }
 133         }
 134 }
 135
 136 void
 137 Content::as_xml (xmlpp::Node* node) const
 138 {
 139         boost::mutex::scoped_lock lm (_mutex);
 140
 141         for (vector<boost::filesystem::path>::const_iterator i = _paths.begin(); i != _paths.end(); ++i) {
 142                 node->add_child("Path")->add_child_text (i->string ());
 143         }
 144         node->add_child("Digest")->add_child_text (_digest);
 145         node->add_child("Position")->add_child_text (raw_convert<string> (_position.get ()));
 146         node->add_child("TrimStart")->add_child_text (raw_convert<string> (_trim_start.get ()));
 147         node->add_child("TrimEnd")->add_child_text (raw_convert<string> (_trim_end.get ()));
 148         if (_video_frame_rate) {
 149                 node->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate.get()));
 150         }
 151 }
 152
 153 void
 154 Content::examine (shared_ptr<Job> job)
 155 {
 156         if (job) {
 157                 job->sub (_("Computing digest"));
 158         }
 159
 160         boost::mutex::scoped_lock lm (_mutex);
 161         vector<boost::filesystem::path> p = _paths;
 162         lm.unlock ();
 163
 164         /* Some content files are very big, so we use a poor man's
 165            digest here: a digest of the first and last 1e6 bytes with the
 166            size of the first file tacked on the end as a string.
 167         */
 168         string const d = digest_head_tail (p, 1000000) + raw_convert<string> (boost::filesystem::file_size (p.front ()));
 169
 170         lm.lock ();
 171         _digest = d;
 172 }
 173
 174 void
 175 Content::signal_changed (int p)
 176 {
 177         try {
 178                 emit (boost::bind (boost::ref (Changed), shared_from_this (), p, _change_signals_frequent));
 179         } catch (boost::bad_weak_ptr) {
 180                 /* This must be during construction; never mind */
 181         }
 182 }
 183
 184 void
 185 Content::set_position (DCPTime p)
 186 {
 187         {
 188                 boost::mutex::scoped_lock lm (_mutex);
 189                 if (p == _position) {
 190                         return;
 191                 }
 192
 193                 _position = p;
 194         }
 195
 196         signal_changed (ContentProperty::POSITION);
 197 }
 198
 199 void
 200 Content::set_trim_start (ContentTime t)
 201 {
 202         {
 203                 boost::mutex::scoped_lock lm (_mutex);
 204                 _trim_start = t;
 205         }
 206
 207         signal_changed (ContentProperty::TRIM_START);
 208 }
 209
 210 void
 211 Content::set_trim_end (ContentTime t)
 212 {
 213         {
 214                 boost::mutex::scoped_lock lm (_mutex);
 215                 _trim_end = t;
 216         }
 217
 218         signal_changed (ContentProperty::TRIM_END);
 219 }
 220
 221
 222 shared_ptr<Content>
 223 Content::clone () const
 224 {
 225         shared_ptr<const Film> film = _film.lock ();
 226         if (!film) {
 227                 return shared_ptr<Content> ();
 228         }
 229
 230         /* This is a bit naughty, but I can't think of a compelling reason not to do it ... */
 231         xmlpp::Document doc;
 232         xmlpp::Node* node = doc.create_root_node ("Content");
 233         as_xml (node);
 234
 235         /* notes is unused here (we assume) */
 236         list<string> notes;
 237         return content_factory (film, cxml::NodePtr (new cxml::Node (node)), Film::current_state_version, notes);
 238 }
 239
 240 string
 241 Content::technical_summary () const
 242 {
 243         return String::compose ("%1 %2 %3", path_summary(), digest(), position().seconds());
 244 }
 245
 246 DCPTime
 247 Content::length_after_trim () const
 248 {
 249         return max (DCPTime (), full_length() - DCPTime (trim_start() + trim_end(), film()->active_frame_rate_change (position ())));
 250 }
 251
 252 /** @return string which changes when something about this content changes which affects
 253  *  the appearance of its video.
 254  */
 255 string
 256 Content::identifier () const
 257 {
 258         char buffer[256];
 259         snprintf (
 260                 buffer, sizeof(buffer), "%s_%" PRId64 "_%" PRId64 "_%" PRId64,
 261                 Content::digest().c_str(), position().get(), trim_start().get(), trim_end().get()
 262                 );
 263         return buffer;
 264 }
 265
 266 bool
 267 Content::paths_valid () const
 268 {
 269         for (vector<boost::filesystem::path>::const_iterator i = _paths.begin(); i != _paths.end(); ++i) {
 270                 if (!boost::filesystem::exists (*i)) {
 271                         return false;
 272                 }
 273         }
 274
 275         return true;
 276 }
 277
 278 void
 279 Content::set_path (boost::filesystem::path path)
 280 {
 281         _paths.clear ();
 282         _paths.push_back (path);
 283         signal_changed (ContentProperty::PATH);
 284 }
 285
 286 string
 287 Content::path_summary () const
 288 {
 289         /* XXX: should handle multiple paths more gracefully */
 290
 291         DCPOMATIC_ASSERT (number_of_paths ());
 292
 293         string s = path(0).filename().string ();
 294         if (number_of_paths() > 1) {
 295                 s += " ...";
 296         }
 297
 298         return s;
 299 }
 300
 301 /** @return a list of properties that might be interesting to the user */
 302 list<UserProperty>
 303 Content::user_properties () const
 304 {
 305         list<UserProperty> p;
 306         add_properties (p);
 307         return p;
 308 }
 309
 310 shared_ptr<const Film>
 311 Content::film () const
 312 {
 313         shared_ptr<const Film> film = _film.lock ();
 314         DCPOMATIC_ASSERT (film);
 315         return film;
 316 }
 317
 318 /** @return DCP times of points within this content where a reel split could occur */
 319 list<DCPTime>
 320 Content::reel_split_points () const
 321 {
 322         list<DCPTime> t;
 323         /* XXX: this is questionable; perhaps the position itself should be forced to be on a frame boundary */
 324         t.push_back (position().round_up (film()->video_frame_rate()));
 325         return t;
 326 }
 327
 328 void
 329 Content::set_video_frame_rate (double r)
 330 {
 331         {
 332                 boost::mutex::scoped_lock lm (_mutex);
 333                 _video_frame_rate = r;
 334         }
 335
 336         signal_changed (ContentProperty::VIDEO_FRAME_RATE);
 337 }
 338
 339 double
 340 Content::active_video_frame_rate () const
 341 {
 342         {
 343                 boost::mutex::scoped_lock lm (_mutex);
 344                 if (_video_frame_rate) {
 345                         return _video_frame_rate.get ();
 346                 }
 347         }
 348
 349         /* No frame rate specified, so assume this content has been
 350            prepared for any concurrent video content or perhaps
 351            just the DCP rate.
 352         */
 353         shared_ptr<const Film> film = _film.lock ();
 354         DCPOMATIC_ASSERT (film);
 355         return film->active_frame_rate_change(position()).source;
 356 }
 357
 358 void
 359 Content::add_properties (list<UserProperty>& p) const
 360 {
 361         p.push_back (UserProperty (UserProperty::GENERAL, _("Filename"), path(0).string ()));
 362
 363         if (_video_frame_rate) {
 364                 if (video) {
 365                         p.push_back (
 366                                 UserProperty (
 367                                         UserProperty::VIDEO,
 368                                         _("Frame rate"),
 369                                         locale_convert<string> (_video_frame_rate.get(), 5),
 370                                         _("frames per second")
 371                                         )
 372                                 );
 373                 } else {
 374                         p.push_back (
 375                                 UserProperty (
 376                                         UserProperty::GENERAL,
 377                                         _("Prepared for video frame rate"),
 378                                         locale_convert<string> (_video_frame_rate.get(), 5),
 379                                         _("frames per second")
 380                                         )
 381                                 );
 382                 }
 383         }
 384 }