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