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