src/lib/content.cc

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