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