src/lib/content.cc

   1 /*
   2     Copyright (C) 2013-2018 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 "change_signaller.h"
  27 #include "util.h"
  28 #include "content_factory.h"
  29 #include "video_content.h"
  30 #include "audio_content.h"
  31 #include "text_content.h"
  32 #include "exceptions.h"
  33 #include "film.h"
  34 #include "job.h"
  35 #include "compose.hpp"
  36 #include <dcp/locale_convert.h>
  37 #include <dcp/raw_convert.h>
  38 #include <libcxml/cxml.h>
  39 #include <libxml++/libxml++.h>
  40 #include <boost/thread/mutex.hpp>
  41 #include <iostream>
  42
  43 #include "i18n.h"
  44
  45 using std::string;
  46 using std::list;
  47 using std::cout;
  48 using std::vector;
  49 using std::max;
  50 using std::pair;
  51 using boost::shared_ptr;
  52 using boost::optional;
  53 using dcp::raw_convert;
  54 using dcp::locale_convert;
  55
  56 int const ContentProperty::PATH = 400;
  57 int const ContentProperty::POSITION = 401;
  58 int const ContentProperty::LENGTH = 402;
  59 int const ContentProperty::TRIM_START = 403;
  60 int const ContentProperty::TRIM_END = 404;
  61 int const ContentProperty::VIDEO_FRAME_RATE = 405;
  62
  63 Content::Content (shared_ptr<const Film> film)
  64         : _film (film)
  65         , _position (0)
  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, DCPTime p)
  74         : _film (film)
  75         , _position (p)
  76         , _trim_start (0)
  77         , _trim_end (0)
  78         , _change_signals_frequent (false)
  79 {
  80
  81 }
  82
  83 Content::Content (shared_ptr<const Film> film, boost::filesystem::path p)
  84         : _film (film)
  85         , _position (0)
  86         , _trim_start (0)
  87         , _trim_end (0)
  88         , _change_signals_frequent (false)
  89 {
  90         add_path (p);
  91 }
  92
  93 Content::Content (shared_ptr<const Film> film, cxml::ConstNodePtr node)
  94         : _film (film)
  95         , _change_signals_frequent (false)
  96 {
  97         list<cxml::NodePtr> path_children = node->node_children ("Path");
  98         BOOST_FOREACH (cxml::NodePtr i, path_children) {
  99                 _paths.push_back (i->content());
 100                 optional<time_t> const mod = i->optional_number_attribute<time_t>("mtime");
 101                 if (mod) {
 102                         _last_write_times.push_back (*mod);
 103                 } else if (boost::filesystem::exists(i->content())) {
 104                         _last_write_times.push_back (boost::filesystem::last_write_time(i->content()));
 105                 } else {
 106                         _last_write_times.push_back (0);
 107                 }
 108         }
 109         _digest = node->optional_string_child ("Digest").get_value_or ("X");
 110         _position = DCPTime (node->number_child<DCPTime::Type> ("Position"));
 111         _trim_start = ContentTime (node->number_child<ContentTime::Type> ("TrimStart"));
 112         _trim_end = ContentTime (node->number_child<ContentTime::Type> ("TrimEnd"));
 113         _video_frame_rate = node->optional_number_child<double> ("VideoFrameRate");
 114 }
 115
 116 Content::Content (shared_ptr<const Film> film, vector<shared_ptr<Content> > c)
 117         : _film (film)
 118         , _position (c.front()->position ())
 119         , _trim_start (c.front()->trim_start ())
 120         , _trim_end (c.back()->trim_end ())
 121         , _video_frame_rate (c.front()->video_frame_rate())
 122         , _change_signals_frequent (false)
 123 {
 124         for (size_t i = 0; i < c.size(); ++i) {
 125                 if (i > 0 && c[i]->trim_start() > ContentTime ()) {
 126                         throw JoinError (_("Only the first piece of content to be joined can have a start trim."));
 127                 }
 128
 129                 if (i < (c.size() - 1) && c[i]->trim_end () > ContentTime ()) {
 130                         throw JoinError (_("Only the last piece of content to be joined can have an end trim."));
 131                 }
 132
 133                 if (
 134                         (_video_frame_rate && !c[i]->_video_frame_rate) ||
 135                         (!_video_frame_rate && c[i]->_video_frame_rate)
 136                         ) {
 137                         throw JoinError (_("Content to be joined must have the same video frame rate"));
 138                 }
 139
 140                 if (_video_frame_rate && fabs (_video_frame_rate.get() - c[i]->_video_frame_rate.get()) > VIDEO_FRAME_RATE_EPSILON) {
 141                         throw JoinError (_("Content to be joined must have the same video frame rate"));
 142                 }
 143
 144                 for (size_t j = 0; j < c[i]->number_of_paths(); ++j) {
 145                         _paths.push_back (c[i]->path(j));
 146                         _last_write_times.push_back (c[i]->_last_write_times[j]);
 147                 }
 148         }
 149 }
 150
 151 void
 152 Content::as_xml (xmlpp::Node* node, bool with_paths) const
 153 {
 154         boost::mutex::scoped_lock lm (_mutex);
 155
 156         if (with_paths) {
 157                 for (size_t i = 0; i < _paths.size(); ++i) {
 158                         xmlpp::Element* p = node->add_child("Path");
 159                         p->add_child_text (_paths[i].string());
 160                         p->set_attribute ("mtime", raw_convert<string>(_last_write_times[i]));
 161                 }
 162         }
 163         node->add_child("Digest")->add_child_text (_digest);
 164         node->add_child("Position")->add_child_text (raw_convert<string> (_position.get ()));
 165         node->add_child("TrimStart")->add_child_text (raw_convert<string> (_trim_start.get ()));
 166         node->add_child("TrimEnd")->add_child_text (raw_convert<string> (_trim_end.get ()));
 167         if (_video_frame_rate) {
 168                 node->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate.get()));
 169         }
 170 }
 171
 172 string
 173 Content::calculate_digest () const
 174 {
 175         boost::mutex::scoped_lock lm (_mutex);
 176         vector<boost::filesystem::path> p = _paths;
 177         lm.unlock ();
 178
 179         /* Some content files are very big, so we use a poor man's
 180            digest here: a digest of the first and last 1e6 bytes with the
 181            size of the first file tacked on the end as a string.
 182         */
 183         return digest_head_tail(p, 1000000) + raw_convert<string>(boost::filesystem::file_size(p.front()));
 184 }
 185
 186 void
 187 Content::examine (shared_ptr<Job> job)
 188 {
 189         if (job) {
 190                 job->sub (_("Computing digest"));
 191         }
 192
 193         string const d = calculate_digest ();
 194
 195         boost::mutex::scoped_lock lm (_mutex);
 196         _digest = d;
 197
 198         _last_write_times.clear ();
 199         BOOST_FOREACH (boost::filesystem::path i, _paths) {
 200                 _last_write_times.push_back (boost::filesystem::last_write_time(i));
 201         }
 202 }
 203
 204 void
 205 Content::signal_change (ChangeType c, int p)
 206 {
 207         try {
 208                 if (c == CHANGE_TYPE_PENDING || c == CHANGE_TYPE_CANCELLED) {
 209                         Change (c, shared_from_this(), p, _change_signals_frequent);
 210                 } else {
 211                         emit (boost::bind (boost::ref(Change), c, shared_from_this(), p, _change_signals_frequent));
 212                 }
 213         } catch (boost::bad_weak_ptr) {
 214                 /* This must be during construction; never mind */
 215         }
 216 }
 217
 218 void
 219 Content::set_position (DCPTime p)
 220 {
 221         /* video and audio content can modify its position */
 222
 223         if (video) {
 224                 video->modify_position (p);
 225         }
 226
 227         if (audio) {
 228                 audio->modify_position (p);
 229         }
 230
 231         ChangeSignaller<Content> cc (this, ContentProperty::POSITION);
 232
 233         {
 234                 boost::mutex::scoped_lock lm (_mutex);
 235                 if (p == _position) {
 236                         cc.abort ();
 237                         return;
 238                 }
 239
 240                 _position = p;
 241         }
 242 }
 243
 244 void
 245 Content::set_trim_start (ContentTime t)
 246 {
 247         /* video and audio content can modify its start trim */
 248
 249         if (video) {
 250                 video->modify_trim_start (t);
 251         }
 252
 253         if (audio) {
 254                 audio->modify_trim_start (t);
 255         }
 256
 257         ChangeSignaller<Content> cc (this, ContentProperty::TRIM_START);
 258
 259         {
 260                 boost::mutex::scoped_lock lm (_mutex);
 261                 _trim_start = t;
 262         }
 263 }
 264
 265 void
 266 Content::set_trim_end (ContentTime t)
 267 {
 268         ChangeSignaller<Content> cc (this, ContentProperty::TRIM_END);
 269
 270         {
 271                 boost::mutex::scoped_lock lm (_mutex);
 272                 _trim_end = t;
 273         }
 274 }
 275
 276
 277 shared_ptr<Content>
 278 Content::clone () const
 279 {
 280         shared_ptr<const Film> film = _film.lock ();
 281         if (!film) {
 282                 return shared_ptr<Content> ();
 283         }
 284
 285         /* This is a bit naughty, but I can't think of a compelling reason not to do it ... */
 286         xmlpp::Document doc;
 287         xmlpp::Node* node = doc.create_root_node ("Content");
 288         as_xml (node, true);
 289
 290         /* notes is unused here (we assume) */
 291         list<string> notes;
 292         return content_factory (film, cxml::NodePtr (new cxml::Node (node)), Film::current_state_version, notes);
 293 }
 294
 295 string
 296 Content::technical_summary () const
 297 {
 298         return String::compose ("%1 %2 %3", path_summary(), digest(), position().seconds());
 299 }
 300
 301 DCPTime
 302 Content::length_after_trim () const
 303 {
 304         return max (DCPTime (), full_length() - DCPTime (trim_start() + trim_end(), film()->active_frame_rate_change (position ())));
 305 }
 306
 307 /** @return string which changes when something about this content changes which affects
 308  *  the appearance of its video.
 309  */
 310 string
 311 Content::identifier () const
 312 {
 313         char buffer[256];
 314         snprintf (
 315                 buffer, sizeof(buffer), "%s_%" PRId64 "_%" PRId64 "_%" PRId64,
 316                 Content::digest().c_str(), position().get(), trim_start().get(), trim_end().get()
 317                 );
 318         return buffer;
 319 }
 320
 321 bool
 322 Content::paths_valid () const
 323 {
 324         BOOST_FOREACH (boost::filesystem::path i, _paths) {
 325                 if (!boost::filesystem::exists (i)) {
 326                         return false;
 327                 }
 328         }
 329
 330         return true;
 331 }
 332
 333 void
 334 Content::set_paths (vector<boost::filesystem::path> paths)
 335 {
 336         ChangeSignaller<Content> cc (this, ContentProperty::PATH);
 337
 338         {
 339                 boost::mutex::scoped_lock lm (_mutex);
 340                 _paths = paths;
 341                 _last_write_times.clear ();
 342                 BOOST_FOREACH (boost::filesystem::path i, _paths) {
 343                         _last_write_times.push_back (boost::filesystem::last_write_time(i));
 344                 }
 345         }
 346 }
 347
 348 string
 349 Content::path_summary () const
 350 {
 351         /* XXX: should handle multiple paths more gracefully */
 352
 353         DCPOMATIC_ASSERT (number_of_paths ());
 354
 355         string s = path(0).filename().string ();
 356         if (number_of_paths() > 1) {
 357                 s += " ...";
 358         }
 359
 360         return s;
 361 }
 362
 363 /** @return a list of properties that might be interesting to the user */
 364 list<UserProperty>
 365 Content::user_properties () const
 366 {
 367         list<UserProperty> p;
 368         add_properties (p);
 369         return p;
 370 }
 371
 372 shared_ptr<const Film>
 373 Content::film () const
 374 {
 375         shared_ptr<const Film> film = _film.lock ();
 376         DCPOMATIC_ASSERT (film);
 377         return film;
 378 }
 379
 380 /** @return DCP times of points within this content where a reel split could occur */
 381 list<DCPTime>
 382 Content::reel_split_points () const
 383 {
 384         list<DCPTime> t;
 385         /* This is only called for video content and such content has its position forced
 386            to start on a frame boundary.
 387         */
 388         t.push_back (position());
 389         return t;
 390 }
 391
 392 void
 393 Content::set_video_frame_rate (double r)
 394 {
 395         ChangeSignaller<Content> cc (this, ContentProperty::VIDEO_FRAME_RATE);
 396
 397         {
 398                 boost::mutex::scoped_lock lm (_mutex);
 399                 _video_frame_rate = r;
 400         }
 401
 402         /* Make sure trim is still on a frame boundary */
 403         if (video) {
 404                 set_trim_start (trim_start());
 405         }
 406 }
 407
 408 void
 409 Content::unset_video_frame_rate ()
 410 {
 411         ChangeSignaller<Content> cc (this, ContentProperty::VIDEO_FRAME_RATE);
 412
 413         {
 414                 boost::mutex::scoped_lock lm (_mutex);
 415                 _video_frame_rate = optional<double>();
 416         }
 417 }
 418
 419 double
 420 Content::active_video_frame_rate () const
 421 {
 422         {
 423                 boost::mutex::scoped_lock lm (_mutex);
 424                 if (_video_frame_rate) {
 425                         return _video_frame_rate.get ();
 426                 }
 427         }
 428
 429         /* No frame rate specified, so assume this content has been
 430            prepared for any concurrent video content or perhaps
 431            just the DCP rate.
 432         */
 433         shared_ptr<const Film> film = _film.lock ();
 434         DCPOMATIC_ASSERT (film);
 435         return film->active_frame_rate_change(position()).source;
 436 }
 437
 438 void
 439 Content::add_properties (list<UserProperty>& p) const
 440 {
 441         p.push_back (UserProperty (UserProperty::GENERAL, _("Filename"), path(0).string ()));
 442
 443         if (_video_frame_rate) {
 444                 if (video) {
 445                         p.push_back (
 446                                 UserProperty (
 447                                         UserProperty::VIDEO,
 448                                         _("Frame rate"),
 449                                         locale_convert<string> (_video_frame_rate.get(), 5),
 450                                         _("frames per second")
 451                                         )
 452                                 );
 453                 } else {
 454                         p.push_back (
 455                                 UserProperty (
 456                                         UserProperty::GENERAL,
 457                                         _("Prepared for video frame rate"),
 458                                         locale_convert<string> (_video_frame_rate.get(), 5),
 459                                         _("frames per second")
 460                                         )
 461                                 );
 462                 }
 463         }
 464 }
 465
 466 /** Take settings from the given content if it is of the correct type */
 467 void
 468 Content::take_settings_from (shared_ptr<const Content> c)
 469 {
 470         if (video && c->video) {
 471                 video->take_settings_from (c->video);
 472         }
 473         if (audio && c->audio) {
 474                 audio->take_settings_from (c->audio);
 475         }
 476
 477         list<shared_ptr<TextContent> >::iterator i = text.begin ();
 478         list<shared_ptr<TextContent> >::const_iterator j = c->text.begin ();
 479         while (i != text.end() && j != c->text.end()) {
 480                 (*i)->take_settings_from (*j);
 481                 ++i;
 482                 ++j;
 483         }
 484 }
 485
 486 shared_ptr<TextContent>
 487 Content::only_text () const
 488 {
 489         DCPOMATIC_ASSERT (text.size() < 2);
 490         if (text.empty ()) {
 491                 return shared_ptr<TextContent> ();
 492         }
 493         return text.front ();
 494 }
 495
 496 shared_ptr<TextContent>
 497 Content::text_of_original_type (TextType type) const
 498 {
 499         BOOST_FOREACH (shared_ptr<TextContent> i, text) {
 500                 if (i->original_type() == type) {
 501                         return i;
 502                 }
 503         }
 504
 505         return shared_ptr<TextContent> ();
 506 }
 507
 508 void
 509 Content::add_path (boost::filesystem::path p)
 510 {
 511         boost::mutex::scoped_lock lm (_mutex);
 512         _paths.push_back (p);
 513         _last_write_times.push_back (boost::filesystem::last_write_time(p));
 514 }