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