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_changed (int p)
 183 {
 184         try {
 185                 emit (boost::bind (boost::ref(Changed), shared_from_this(), p, _change_signals_frequent));
 186         } catch (boost::bad_weak_ptr) {
 187                 /* This must be during construction; never mind */
 188         }
 189 }
 190
 191 void
 192 Content::set_position (DCPTime p)
 193 {
 194         /* video and audio content can modify its position */
 195
 196         if (video) {
 197                 video->modify_position (p);
 198         }
 199
 200         if (audio) {
 201                 audio->modify_position (p);
 202         }
 203
 204         ContentChange cc (this, ContentProperty::POSITION);
 205
 206         {
 207                 boost::mutex::scoped_lock lm (_mutex);
 208                 if (p == _position) {
 209                         cc.abort ();
 210                         return;
 211                 }
 212
 213                 _position = p;
 214         }
 215 }
 216
 217 void
 218 Content::set_trim_start (ContentTime t)
 219 {
 220         /* video and audio content can modify its start trim */
 221
 222         if (video) {
 223                 video->modify_trim_start (t);
 224         }
 225
 226         if (audio) {
 227                 audio->modify_trim_start (t);
 228         }
 229
 230         ContentChange cc (this, ContentProperty::TRIM_START);
 231
 232         {
 233                 boost::mutex::scoped_lock lm (_mutex);
 234                 _trim_start = t;
 235         }
 236 }
 237
 238 void
 239 Content::set_trim_end (ContentTime t)
 240 {
 241         ContentChange cc (this, ContentProperty::TRIM_END);
 242
 243         {
 244                 boost::mutex::scoped_lock lm (_mutex);
 245                 _trim_end = t;
 246         }
 247 }
 248
 249
 250 shared_ptr<Content>
 251 Content::clone () const
 252 {
 253         shared_ptr<const Film> film = _film.lock ();
 254         if (!film) {
 255                 return shared_ptr<Content> ();
 256         }
 257
 258         /* This is a bit naughty, but I can't think of a compelling reason not to do it ... */
 259         xmlpp::Document doc;
 260         xmlpp::Node* node = doc.create_root_node ("Content");
 261         as_xml (node, true);
 262
 263         /* notes is unused here (we assume) */
 264         list<string> notes;
 265         return content_factory (film, cxml::NodePtr (new cxml::Node (node)), Film::current_state_version, notes);
 266 }
 267
 268 string
 269 Content::technical_summary () const
 270 {
 271         return String::compose ("%1 %2 %3", path_summary(), digest(), position().seconds());
 272 }
 273
 274 DCPTime
 275 Content::length_after_trim () const
 276 {
 277         return max (DCPTime (), full_length() - DCPTime (trim_start() + trim_end(), film()->active_frame_rate_change (position ())));
 278 }
 279
 280 /** @return string which changes when something about this content changes which affects
 281  *  the appearance of its video.
 282  */
 283 string
 284 Content::identifier () const
 285 {
 286         char buffer[256];
 287         snprintf (
 288                 buffer, sizeof(buffer), "%s_%" PRId64 "_%" PRId64 "_%" PRId64,
 289                 Content::digest().c_str(), position().get(), trim_start().get(), trim_end().get()
 290                 );
 291         return buffer;
 292 }
 293
 294 bool
 295 Content::paths_valid () const
 296 {
 297         for (vector<boost::filesystem::path>::const_iterator i = _paths.begin(); i != _paths.end(); ++i) {
 298                 if (!boost::filesystem::exists (*i)) {
 299                         return false;
 300                 }
 301         }
 302
 303         return true;
 304 }
 305
 306 void
 307 Content::set_path (boost::filesystem::path path)
 308 {
 309         ContentChange cc (this, ContentProperty::PATH);
 310         _paths.clear ();
 311         _paths.push_back (path);
 312 }
 313
 314 void
 315 Content::set_paths (vector<boost::filesystem::path> paths)
 316 {
 317         ContentChange cc (this, ContentProperty::PATH);
 318         _paths = paths;
 319 }
 320
 321 string
 322 Content::path_summary () const
 323 {
 324         /* XXX: should handle multiple paths more gracefully */
 325
 326         DCPOMATIC_ASSERT (number_of_paths ());
 327
 328         string s = path(0).filename().string ();
 329         if (number_of_paths() > 1) {
 330                 s += " ...";
 331         }
 332
 333         return s;
 334 }
 335
 336 /** @return a list of properties that might be interesting to the user */
 337 list<UserProperty>
 338 Content::user_properties () const
 339 {
 340         list<UserProperty> p;
 341         add_properties (p);
 342         return p;
 343 }
 344
 345 shared_ptr<const Film>
 346 Content::film () const
 347 {
 348         shared_ptr<const Film> film = _film.lock ();
 349         DCPOMATIC_ASSERT (film);
 350         return film;
 351 }
 352
 353 /** @return DCP times of points within this content where a reel split could occur */
 354 list<DCPTime>
 355 Content::reel_split_points () const
 356 {
 357         list<DCPTime> t;
 358         /* This is only called for video content and such content has its position forced
 359            to start on a frame boundary.
 360         */
 361         t.push_back (position());
 362         return t;
 363 }
 364
 365 void
 366 Content::set_video_frame_rate (double r)
 367 {
 368         ContentChange cc (this, ContentProperty::VIDEO_FRAME_RATE);
 369
 370         {
 371                 boost::mutex::scoped_lock lm (_mutex);
 372                 _video_frame_rate = r;
 373         }
 374
 375         /* Make sure things are still on frame boundaries */
 376         if (video) {
 377                 set_position (position());
 378                 set_trim_start (trim_start());
 379         }
 380 }
 381
 382 void
 383 Content::unset_video_frame_rate ()
 384 {
 385         ContentChange 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 }