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
 199 void
 200 Content::signal_change (ChangeType c, int p)
 201 {
 202         try {
 203                 if (c == CHANGE_TYPE_PENDING || c == CHANGE_TYPE_CANCELLED) {
 204                         Change (c, shared_from_this(), p, _change_signals_frequent);
 205                 } else {
 206                         emit (boost::bind (boost::ref(Change), c, shared_from_this(), p, _change_signals_frequent));
 207                 }
 208         } catch (boost::bad_weak_ptr) {
 209                 /* This must be during construction; never mind */
 210         }
 211 }
 212
 213 void
 214 Content::set_position (DCPTime p)
 215 {
 216         /* video and audio content can modify its position */
 217
 218         if (video) {
 219                 video->modify_position (p);
 220         }
 221
 222         if (audio) {
 223                 audio->modify_position (p);
 224         }
 225
 226         ChangeSignaller<Content> cc (this, ContentProperty::POSITION);
 227
 228         {
 229                 boost::mutex::scoped_lock lm (_mutex);
 230                 if (p == _position) {
 231                         cc.abort ();
 232                         return;
 233                 }
 234
 235                 _position = p;
 236         }
 237 }
 238
 239 void
 240 Content::set_trim_start (ContentTime t)
 241 {
 242         /* video and audio content can modify its start trim */
 243
 244         if (video) {
 245                 video->modify_trim_start (t);
 246         }
 247
 248         if (audio) {
 249                 audio->modify_trim_start (t);
 250         }
 251
 252         ChangeSignaller<Content> cc (this, ContentProperty::TRIM_START);
 253
 254         {
 255                 boost::mutex::scoped_lock lm (_mutex);
 256                 _trim_start = t;
 257         }
 258 }
 259
 260 void
 261 Content::set_trim_end (ContentTime t)
 262 {
 263         ChangeSignaller<Content> cc (this, ContentProperty::TRIM_END);
 264
 265         {
 266                 boost::mutex::scoped_lock lm (_mutex);
 267                 _trim_end = t;
 268         }
 269 }
 270
 271
 272 shared_ptr<Content>
 273 Content::clone () const
 274 {
 275         shared_ptr<const Film> film = _film.lock ();
 276         if (!film) {
 277                 return shared_ptr<Content> ();
 278         }
 279
 280         /* This is a bit naughty, but I can't think of a compelling reason not to do it ... */
 281         xmlpp::Document doc;
 282         xmlpp::Node* node = doc.create_root_node ("Content");
 283         as_xml (node, true);
 284
 285         /* notes is unused here (we assume) */
 286         list<string> notes;
 287         return content_factory (film, cxml::NodePtr (new cxml::Node (node)), Film::current_state_version, notes);
 288 }
 289
 290 string
 291 Content::technical_summary () const
 292 {
 293         return String::compose ("%1 %2 %3", path_summary(), digest(), position().seconds());
 294 }
 295
 296 DCPTime
 297 Content::length_after_trim () const
 298 {
 299         return max (DCPTime (), full_length() - DCPTime (trim_start() + trim_end(), film()->active_frame_rate_change (position ())));
 300 }
 301
 302 /** @return string which changes when something about this content changes which affects
 303  *  the appearance of its video.
 304  */
 305 string
 306 Content::identifier () const
 307 {
 308         char buffer[256];
 309         snprintf (
 310                 buffer, sizeof(buffer), "%s_%" PRId64 "_%" PRId64 "_%" PRId64,
 311                 Content::digest().c_str(), position().get(), trim_start().get(), trim_end().get()
 312                 );
 313         return buffer;
 314 }
 315
 316 bool
 317 Content::paths_valid () const
 318 {
 319         BOOST_FOREACH (boost::filesystem::path i, _paths) {
 320                 if (!boost::filesystem::exists (i)) {
 321                         return false;
 322                 }
 323         }
 324
 325         return true;
 326 }
 327
 328 void
 329 Content::set_paths (vector<boost::filesystem::path> paths)
 330 {
 331         ChangeSignaller<Content> cc (this, ContentProperty::PATH);
 332
 333         {
 334                 boost::mutex::scoped_lock lm (_mutex);
 335                 _paths = paths;
 336                 _last_write_times.clear ();
 337                 BOOST_FOREACH (boost::filesystem::path i, _paths) {
 338                         _last_write_times.push_back (boost::filesystem::last_write_time(i));
 339                 }
 340         }
 341 }
 342
 343 string
 344 Content::path_summary () const
 345 {
 346         /* XXX: should handle multiple paths more gracefully */
 347
 348         DCPOMATIC_ASSERT (number_of_paths ());
 349
 350         string s = path(0).filename().string ();
 351         if (number_of_paths() > 1) {
 352                 s += " ...";
 353         }
 354
 355         return s;
 356 }
 357
 358 /** @return a list of properties that might be interesting to the user */
 359 list<UserProperty>
 360 Content::user_properties () const
 361 {
 362         list<UserProperty> p;
 363         add_properties (p);
 364         return p;
 365 }
 366
 367 shared_ptr<const Film>
 368 Content::film () const
 369 {
 370         shared_ptr<const Film> film = _film.lock ();
 371         DCPOMATIC_ASSERT (film);
 372         return film;
 373 }
 374
 375 /** @return DCP times of points within this content where a reel split could occur */
 376 list<DCPTime>
 377 Content::reel_split_points () const
 378 {
 379         list<DCPTime> t;
 380         /* This is only called for video content and such content has its position forced
 381            to start on a frame boundary.
 382         */
 383         t.push_back (position());
 384         return t;
 385 }
 386
 387 void
 388 Content::set_video_frame_rate (double r)
 389 {
 390         ChangeSignaller<Content> cc (this, ContentProperty::VIDEO_FRAME_RATE);
 391
 392         {
 393                 boost::mutex::scoped_lock lm (_mutex);
 394                 _video_frame_rate = r;
 395         }
 396
 397         /* Make sure trim is still on a frame boundary */
 398         if (video) {
 399                 set_trim_start (trim_start());
 400         }
 401 }
 402
 403 void
 404 Content::unset_video_frame_rate ()
 405 {
 406         ChangeSignaller<Content> cc (this, ContentProperty::VIDEO_FRAME_RATE);
 407
 408         {
 409                 boost::mutex::scoped_lock lm (_mutex);
 410                 _video_frame_rate = optional<double>();
 411         }
 412 }
 413
 414 double
 415 Content::active_video_frame_rate () const
 416 {
 417         {
 418                 boost::mutex::scoped_lock lm (_mutex);
 419                 if (_video_frame_rate) {
 420                         return _video_frame_rate.get ();
 421                 }
 422         }
 423
 424         /* No frame rate specified, so assume this content has been
 425            prepared for any concurrent video content or perhaps
 426            just the DCP rate.
 427         */
 428         shared_ptr<const Film> film = _film.lock ();
 429         DCPOMATIC_ASSERT (film);
 430         return film->active_frame_rate_change(position()).source;
 431 }
 432
 433 void
 434 Content::add_properties (list<UserProperty>& p) const
 435 {
 436         p.push_back (UserProperty (UserProperty::GENERAL, _("Filename"), path(0).string ()));
 437
 438         if (_video_frame_rate) {
 439                 if (video) {
 440                         p.push_back (
 441                                 UserProperty (
 442                                         UserProperty::VIDEO,
 443                                         _("Frame rate"),
 444                                         locale_convert<string> (_video_frame_rate.get(), 5),
 445                                         _("frames per second")
 446                                         )
 447                                 );
 448                 } else {
 449                         p.push_back (
 450                                 UserProperty (
 451                                         UserProperty::GENERAL,
 452                                         _("Prepared for video frame rate"),
 453                                         locale_convert<string> (_video_frame_rate.get(), 5),
 454                                         _("frames per second")
 455                                         )
 456                                 );
 457                 }
 458         }
 459 }
 460
 461 /** Take settings from the given content if it is of the correct type */
 462 void
 463 Content::take_settings_from (shared_ptr<const Content> c)
 464 {
 465         if (video && c->video) {
 466                 video->take_settings_from (c->video);
 467         }
 468         if (audio && c->audio) {
 469                 audio->take_settings_from (c->audio);
 470         }
 471
 472         list<shared_ptr<TextContent> >::iterator i = text.begin ();
 473         list<shared_ptr<TextContent> >::const_iterator j = c->text.begin ();
 474         while (i != text.end() && j != c->text.end()) {
 475                 (*i)->take_settings_from (*j);
 476                 ++i;
 477                 ++j;
 478         }
 479 }
 480
 481 shared_ptr<TextContent>
 482 Content::only_text () const
 483 {
 484         DCPOMATIC_ASSERT (text.size() < 2);
 485         if (text.empty ()) {
 486                 return shared_ptr<TextContent> ();
 487         }
 488         return text.front ();
 489 }
 490
 491 shared_ptr<TextContent>
 492 Content::text_of_original_type (TextType type) const
 493 {
 494         BOOST_FOREACH (shared_ptr<TextContent> i, text) {
 495                 if (i->original_type() == type) {
 496                         return i;
 497                 }
 498         }
 499
 500         return shared_ptr<TextContent> ();
 501 }
 502
 503 void
 504 Content::add_path (boost::filesystem::path p)
 505 {
 506         boost::mutex::scoped_lock lm (_mutex);
 507         _paths.push_back (p);
 508         _last_write_times.push_back (boost::filesystem::last_write_time(p));
 509 }