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