src/lib/content.cc

   1 /*
   2     Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file  src/lib/content.cc
  21  *  @brief Content class.
  22  */
  23
  24 #include "content.h"
  25 #include "util.h"
  26 #include "content_factory.h"
  27 #include "exceptions.h"
  28 #include "film.h"
  29 #include "safe_stringstream.h"
  30 #include "job.h"
  31 #include "compose.hpp"
  32 #include "raw_convert.h"
  33 #include <libcxml/cxml.h>
  34 #include <libxml++/libxml++.h>
  35 #include <boost/thread/mutex.hpp>
  36 #include <iostream>
  37
  38 #include "i18n.h"
  39
  40 using std::string;
  41 using std::list;
  42 using std::cout;
  43 using std::vector;
  44 using std::max;
  45 using std::pair;
  46 using boost::shared_ptr;
  47
  48 int const ContentProperty::PATH = 400;
  49 int const ContentProperty::POSITION = 401;
  50 int const ContentProperty::LENGTH = 402;
  51 int const ContentProperty::TRIM_START = 403;
  52 int const ContentProperty::TRIM_END = 404;
  53
  54 Content::Content (shared_ptr<const Film> film)
  55         : _film (film)
  56         , _position (0)
  57         , _trim_start (0)
  58         , _trim_end (0)
  59         , _change_signals_frequent (false)
  60 {
  61
  62 }
  63
  64 Content::Content (shared_ptr<const Film> film, DCPTime p)
  65         : _film (film)
  66         , _position (p)
  67         , _trim_start (0)
  68         , _trim_end (0)
  69         , _change_signals_frequent (false)
  70 {
  71
  72 }
  73
  74 Content::Content (shared_ptr<const Film> film, boost::filesystem::path p)
  75         : _film (film)
  76         , _position (0)
  77         , _trim_start (0)
  78         , _trim_end (0)
  79         , _change_signals_frequent (false)
  80 {
  81         _paths.push_back (p);
  82 }
  83
  84 Content::Content (shared_ptr<const Film> film, cxml::ConstNodePtr node)
  85         : _film (film)
  86         , _change_signals_frequent (false)
  87 {
  88         list<cxml::NodePtr> path_children = node->node_children ("Path");
  89         for (list<cxml::NodePtr>::const_iterator i = path_children.begin(); i != path_children.end(); ++i) {
  90                 _paths.push_back ((*i)->content ());
  91         }
  92         _digest = node->optional_string_child ("Digest").get_value_or ("X");
  93         _position = DCPTime (node->number_child<DCPTime::Type> ("Position"));
  94         _trim_start = ContentTime (node->number_child<ContentTime::Type> ("TrimStart"));
  95         _trim_end = ContentTime (node->number_child<ContentTime::Type> ("TrimEnd"));
  96 }
  97
  98 Content::Content (shared_ptr<const Film> film, vector<shared_ptr<Content> > c)
  99         : _film (film)
 100         , _position (c.front()->position ())
 101         , _trim_start (c.front()->trim_start ())
 102         , _trim_end (c.back()->trim_end ())
 103         , _change_signals_frequent (false)
 104 {
 105         for (size_t i = 0; i < c.size(); ++i) {
 106                 if (i > 0 && c[i]->trim_start() > ContentTime ()) {
 107                         throw JoinError (_("Only the first piece of content to be joined can have a start trim."));
 108                 }
 109
 110                 if (i < (c.size() - 1) && c[i]->trim_end () > ContentTime ()) {
 111                         throw JoinError (_("Only the last piece of content to be joined can have an end trim."));
 112                 }
 113
 114                 for (size_t j = 0; j < c[i]->number_of_paths(); ++j) {
 115                         _paths.push_back (c[i]->path (j));
 116                 }
 117         }
 118 }
 119
 120 void
 121 Content::as_xml (xmlpp::Node* node) const
 122 {
 123         boost::mutex::scoped_lock lm (_mutex);
 124
 125         for (vector<boost::filesystem::path>::const_iterator i = _paths.begin(); i != _paths.end(); ++i) {
 126                 node->add_child("Path")->add_child_text (i->string ());
 127         }
 128         node->add_child("Digest")->add_child_text (_digest);
 129         node->add_child("Position")->add_child_text (raw_convert<string> (_position.get ()));
 130         node->add_child("TrimStart")->add_child_text (raw_convert<string> (_trim_start.get ()));
 131         node->add_child("TrimEnd")->add_child_text (raw_convert<string> (_trim_end.get ()));
 132 }
 133
 134 void
 135 Content::examine (shared_ptr<Job> job)
 136 {
 137         if (job) {
 138                 job->sub (_("Computing digest"));
 139         }
 140
 141         boost::mutex::scoped_lock lm (_mutex);
 142         vector<boost::filesystem::path> p = _paths;
 143         lm.unlock ();
 144
 145         /* Some content files are very big, so we use a poor man's
 146            digest here: a MD5 of the first and last 1e6 bytes with the
 147            size of the first file tacked on the end as a string.
 148         */
 149         string const d = md5_digest_head_tail (p, 1000000) + raw_convert<string> (boost::filesystem::file_size (p.front ()));
 150
 151         lm.lock ();
 152         _digest = d;
 153 }
 154
 155 void
 156 Content::signal_changed (int p)
 157 {
 158         changed (p);
 159         emit (boost::bind (boost::ref (Changed), shared_from_this (), p, _change_signals_frequent));
 160 }
 161
 162 void
 163 Content::set_position (DCPTime p)
 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         {
 181                 boost::mutex::scoped_lock lm (_mutex);
 182                 _trim_start = t;
 183         }
 184
 185         signal_changed (ContentProperty::TRIM_START);
 186 }
 187
 188 void
 189 Content::set_trim_end (ContentTime t)
 190 {
 191         {
 192                 boost::mutex::scoped_lock lm (_mutex);
 193                 _trim_end = t;
 194         }
 195
 196         signal_changed (ContentProperty::TRIM_END);
 197 }
 198
 199
 200 shared_ptr<Content>
 201 Content::clone () const
 202 {
 203         shared_ptr<const Film> film = _film.lock ();
 204         if (!film) {
 205                 return shared_ptr<Content> ();
 206         }
 207
 208         /* This is a bit naughty, but I can't think of a compelling reason not to do it ... */
 209         xmlpp::Document doc;
 210         xmlpp::Node* node = doc.create_root_node ("Content");
 211         as_xml (node);
 212
 213         /* notes is unused here (we assume) */
 214         list<string> notes;
 215         return content_factory (film, cxml::NodePtr (new cxml::Node (node)), Film::current_state_version, notes);
 216 }
 217
 218 string
 219 Content::technical_summary () const
 220 {
 221         return String::compose ("%1 %2 %3", path_summary(), digest(), position().seconds());
 222 }
 223
 224 DCPTime
 225 Content::length_after_trim () const
 226 {
 227         return max (DCPTime (), full_length() - DCPTime (trim_start() + trim_end(), film()->active_frame_rate_change (position ())));
 228 }
 229
 230 /** @return string which changes when something about this content changes which affects
 231  *  the appearance of its video.
 232  */
 233 string
 234 Content::identifier () const
 235 {
 236         SafeStringStream s;
 237
 238         s << Content::digest()
 239           << "_" << position().get()
 240           << "_" << trim_start().get()
 241           << "_" << trim_end().get();
 242
 243         return s.str ();
 244 }
 245
 246 bool
 247 Content::paths_valid () const
 248 {
 249         for (vector<boost::filesystem::path>::const_iterator i = _paths.begin(); i != _paths.end(); ++i) {
 250                 if (!boost::filesystem::exists (*i)) {
 251                         return false;
 252                 }
 253         }
 254
 255         return true;
 256 }
 257
 258 void
 259 Content::set_path (boost::filesystem::path path)
 260 {
 261         _paths.clear ();
 262         _paths.push_back (path);
 263         signal_changed (ContentProperty::PATH);
 264 }
 265
 266 string
 267 Content::path_summary () const
 268 {
 269         /* XXX: should handle multiple paths more gracefully */
 270
 271         DCPOMATIC_ASSERT (number_of_paths ());
 272
 273         string s = path(0).filename().string ();
 274         if (number_of_paths() > 1) {
 275                 s += " ...";
 276         }
 277
 278         return s;
 279 }
 280
 281 /** @return a list of properties that might be interesting to the user */
 282 list<UserProperty>
 283 Content::user_properties () const
 284 {
 285         list<UserProperty> p;
 286         add_properties (p);
 287         return p;
 288 }
 289
 290 shared_ptr<const Film>
 291 Content::film () const
 292 {
 293         shared_ptr<const Film> film = _film.lock ();
 294         DCPOMATIC_ASSERT (film);
 295         return film;
 296 }
 297
 298 /** @return DCP times of points within this content where a reel split could occur */
 299 list<DCPTime>
 300 Content::reel_split_points () const
 301 {
 302         list<DCPTime> t;
 303         /* XXX: this is questionable; perhaps the position itself should be forced to be on a frame boundary */
 304         t.push_back (position().round_up (film()->video_frame_rate()));
 305         return t;
 306 }