2 Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
21 /** @file src/lib/content.cc
22 * @brief Content class.
27 #include "content_factory.h"
28 #include "exceptions.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>
46 using boost::shared_ptr;
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 int const ContentProperty::VIDEO_FRAME_RATE = 405;
55 Content::Content (shared_ptr<const Film> film)
60 , _change_signals_frequent (false)
65 Content::Content (shared_ptr<const Film> film, DCPTime p)
70 , _change_signals_frequent (false)
75 Content::Content (shared_ptr<const Film> film, boost::filesystem::path p)
80 , _change_signals_frequent (false)
85 Content::Content (shared_ptr<const Film> film, cxml::ConstNodePtr node)
87 , _change_signals_frequent (false)
89 list<cxml::NodePtr> path_children = node->node_children ("Path");
90 for (list<cxml::NodePtr>::const_iterator i = path_children.begin(); i != path_children.end(); ++i) {
91 _paths.push_back ((*i)->content ());
93 _digest = node->optional_string_child ("Digest").get_value_or ("X");
94 _position = DCPTime (node->number_child<DCPTime::Type> ("Position"));
95 _trim_start = ContentTime (node->number_child<ContentTime::Type> ("TrimStart"));
96 _trim_end = ContentTime (node->number_child<ContentTime::Type> ("TrimEnd"));
97 _video_frame_rate = node->optional_number_child<double> ("VideoFrameRate");
100 Content::Content (shared_ptr<const Film> film, vector<shared_ptr<Content> > c)
102 , _position (c.front()->position ())
103 , _trim_start (c.front()->trim_start ())
104 , _trim_end (c.back()->trim_end ())
105 , _video_frame_rate (c.front()->video_frame_rate())
106 , _change_signals_frequent (false)
108 for (size_t i = 0; i < c.size(); ++i) {
109 if (i > 0 && c[i]->trim_start() > ContentTime ()) {
110 throw JoinError (_("Only the first piece of content to be joined can have a start trim."));
113 if (i < (c.size() - 1) && c[i]->trim_end () > ContentTime ()) {
114 throw JoinError (_("Only the last piece of content to be joined can have an end trim."));
118 (_video_frame_rate && !c[i]->_video_frame_rate) ||
119 (!_video_frame_rate && c[i]->_video_frame_rate)
121 throw JoinError (_("Content to be joined must have the same video frame rate"));
124 if (_video_frame_rate && fabs (_video_frame_rate.get() - c[i]->_video_frame_rate.get()) > VIDEO_FRAME_RATE_EPSILON) {
125 throw JoinError (_("Content to be joined must have the same video frame rate"));
128 for (size_t j = 0; j < c[i]->number_of_paths(); ++j) {
129 _paths.push_back (c[i]->path (j));
135 Content::as_xml (xmlpp::Node* node) const
137 boost::mutex::scoped_lock lm (_mutex);
139 for (vector<boost::filesystem::path>::const_iterator i = _paths.begin(); i != _paths.end(); ++i) {
140 node->add_child("Path")->add_child_text (i->string ());
142 node->add_child("Digest")->add_child_text (_digest);
143 node->add_child("Position")->add_child_text (raw_convert<string> (_position.get ()));
144 node->add_child("TrimStart")->add_child_text (raw_convert<string> (_trim_start.get ()));
145 node->add_child("TrimEnd")->add_child_text (raw_convert<string> (_trim_end.get ()));
146 if (_video_frame_rate) {
147 node->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate.get()));
152 Content::examine (shared_ptr<Job> job)
155 job->sub (_("Computing digest"));
158 boost::mutex::scoped_lock lm (_mutex);
159 vector<boost::filesystem::path> p = _paths;
162 /* Some content files are very big, so we use a poor man's
163 digest here: a digest of the first and last 1e6 bytes with the
164 size of the first file tacked on the end as a string.
166 string const d = digest_head_tail (p, 1000000) + raw_convert<string> (boost::filesystem::file_size (p.front ()));
173 Content::signal_changed (int p)
176 emit (boost::bind (boost::ref (Changed), shared_from_this (), p, _change_signals_frequent));
177 } catch (boost::bad_weak_ptr) {
178 /* This must be during construction; never mind */
183 Content::set_position (DCPTime p)
186 boost::mutex::scoped_lock lm (_mutex);
187 if (p == _position) {
194 signal_changed (ContentProperty::POSITION);
198 Content::set_trim_start (ContentTime t)
201 boost::mutex::scoped_lock lm (_mutex);
205 signal_changed (ContentProperty::TRIM_START);
209 Content::set_trim_end (ContentTime t)
212 boost::mutex::scoped_lock lm (_mutex);
216 signal_changed (ContentProperty::TRIM_END);
221 Content::clone () const
223 shared_ptr<const Film> film = _film.lock ();
225 return shared_ptr<Content> ();
228 /* This is a bit naughty, but I can't think of a compelling reason not to do it ... */
230 xmlpp::Node* node = doc.create_root_node ("Content");
233 /* notes is unused here (we assume) */
235 return content_factory (film, cxml::NodePtr (new cxml::Node (node)), Film::current_state_version, notes);
239 Content::technical_summary () const
241 return String::compose ("%1 %2 %3", path_summary(), digest(), position().seconds());
245 Content::length_after_trim () const
247 return max (DCPTime (), full_length() - DCPTime (trim_start() + trim_end(), film()->active_frame_rate_change (position ())));
250 /** @return string which changes when something about this content changes which affects
251 * the appearance of its video.
254 Content::identifier () const
258 buffer, sizeof(buffer), "%s_%" PRId64 "_%" PRId64 "_%" PRId64,
259 Content::digest().c_str(), position().get(), trim_start().get(), trim_end().get()
265 Content::paths_valid () const
267 for (vector<boost::filesystem::path>::const_iterator i = _paths.begin(); i != _paths.end(); ++i) {
268 if (!boost::filesystem::exists (*i)) {
277 Content::set_path (boost::filesystem::path path)
280 _paths.push_back (path);
281 signal_changed (ContentProperty::PATH);
285 Content::path_summary () const
287 /* XXX: should handle multiple paths more gracefully */
289 DCPOMATIC_ASSERT (number_of_paths ());
291 string s = path(0).filename().string ();
292 if (number_of_paths() > 1) {
299 /** @return a list of properties that might be interesting to the user */
301 Content::user_properties () const
303 list<UserProperty> p;
308 shared_ptr<const Film>
309 Content::film () const
311 shared_ptr<const Film> film = _film.lock ();
312 DCPOMATIC_ASSERT (film);
316 /** @return DCP times of points within this content where a reel split could occur */
318 Content::reel_split_points () const
321 /* XXX: this is questionable; perhaps the position itself should be forced to be on a frame boundary */
322 t.push_back (position().round_up (film()->video_frame_rate()));
327 Content::set_video_frame_rate (double r)
330 boost::mutex::scoped_lock lm (_mutex);
331 _video_frame_rate = r;
334 signal_changed (ContentProperty::VIDEO_FRAME_RATE);
338 Content::active_video_frame_rate () const
341 boost::mutex::scoped_lock lm (_mutex);
342 if (_video_frame_rate) {
343 return _video_frame_rate.get ();
347 /* No frame rate specified, so assume this content has been
348 prepared for any concurrent video content or perhaps
351 shared_ptr<const Film> film = _film.lock ();
352 DCPOMATIC_ASSERT (film);
353 return film->active_frame_rate_change(position()).source;
357 Content::add_properties (list<UserProperty>& p) const
359 p.push_back (UserProperty (UserProperty::GENERAL, _("Filename"), path(0).string ()));
361 if (_video_frame_rate) {
367 raw_convert<string> (_video_frame_rate.get(), 5),
368 _("frames per second")
374 UserProperty::GENERAL,
375 _("Prepared for video frame rate"),
376 raw_convert<string> (_video_frame_rate.get(), 5),
377 _("frames per second")