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"
30 #include "safe_stringstream.h"
32 #include "compose.hpp"
33 #include "raw_convert.h"
34 #include <libcxml/cxml.h>
35 #include <libxml++/libxml++.h>
36 #include <boost/thread/mutex.hpp>
47 using boost::shared_ptr;
49 int const ContentProperty::PATH = 400;
50 int const ContentProperty::POSITION = 401;
51 int const ContentProperty::LENGTH = 402;
52 int const ContentProperty::TRIM_START = 403;
53 int const ContentProperty::TRIM_END = 404;
54 int const ContentProperty::VIDEO_FRAME_RATE = 405;
56 Content::Content (shared_ptr<const Film> film)
61 , _change_signals_frequent (false)
66 Content::Content (shared_ptr<const Film> film, DCPTime p)
71 , _change_signals_frequent (false)
76 Content::Content (shared_ptr<const Film> film, boost::filesystem::path p)
81 , _change_signals_frequent (false)
86 Content::Content (shared_ptr<const Film> film, cxml::ConstNodePtr node)
88 , _change_signals_frequent (false)
90 list<cxml::NodePtr> path_children = node->node_children ("Path");
91 for (list<cxml::NodePtr>::const_iterator i = path_children.begin(); i != path_children.end(); ++i) {
92 _paths.push_back ((*i)->content ());
94 _digest = node->optional_string_child ("Digest").get_value_or ("X");
95 _position = DCPTime (node->number_child<DCPTime::Type> ("Position"));
96 _trim_start = ContentTime (node->number_child<ContentTime::Type> ("TrimStart"));
97 _trim_end = ContentTime (node->number_child<ContentTime::Type> ("TrimEnd"));
98 _video_frame_rate = node->optional_number_child<double> ("VideoFrameRate");
101 Content::Content (shared_ptr<const Film> film, vector<shared_ptr<Content> > c)
103 , _position (c.front()->position ())
104 , _trim_start (c.front()->trim_start ())
105 , _trim_end (c.back()->trim_end ())
106 , _video_frame_rate (c.front()->video_frame_rate())
107 , _change_signals_frequent (false)
109 for (size_t i = 0; i < c.size(); ++i) {
110 if (i > 0 && c[i]->trim_start() > ContentTime ()) {
111 throw JoinError (_("Only the first piece of content to be joined can have a start trim."));
114 if (i < (c.size() - 1) && c[i]->trim_end () > ContentTime ()) {
115 throw JoinError (_("Only the last piece of content to be joined can have an end trim."));
119 (_video_frame_rate && !c[i]->_video_frame_rate) ||
120 (!_video_frame_rate && c[i]->_video_frame_rate)
122 throw JoinError (_("Content to be joined must have the same video frame rate"));
125 if (_video_frame_rate && fabs (_video_frame_rate.get() - c[i]->_video_frame_rate.get()) > VIDEO_FRAME_RATE_EPSILON) {
126 throw JoinError (_("Content to be joined must have the same video frame rate"));
129 for (size_t j = 0; j < c[i]->number_of_paths(); ++j) {
130 _paths.push_back (c[i]->path (j));
136 Content::as_xml (xmlpp::Node* node) const
138 boost::mutex::scoped_lock lm (_mutex);
140 for (vector<boost::filesystem::path>::const_iterator i = _paths.begin(); i != _paths.end(); ++i) {
141 node->add_child("Path")->add_child_text (i->string ());
143 node->add_child("Digest")->add_child_text (_digest);
144 node->add_child("Position")->add_child_text (raw_convert<string> (_position.get ()));
145 node->add_child("TrimStart")->add_child_text (raw_convert<string> (_trim_start.get ()));
146 node->add_child("TrimEnd")->add_child_text (raw_convert<string> (_trim_end.get ()));
147 if (_video_frame_rate) {
148 node->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate.get()));
153 Content::examine (shared_ptr<Job> job)
156 job->sub (_("Computing digest"));
159 boost::mutex::scoped_lock lm (_mutex);
160 vector<boost::filesystem::path> p = _paths;
163 /* Some content files are very big, so we use a poor man's
164 digest here: a MD5 of the first and last 1e6 bytes with the
165 size of the first file tacked on the end as a string.
167 string const d = md5_digest_head_tail (p, 1000000) + raw_convert<string> (boost::filesystem::file_size (p.front ()));
174 Content::signal_changed (int p)
177 emit (boost::bind (boost::ref (Changed), shared_from_this (), p, _change_signals_frequent));
178 } catch (boost::bad_weak_ptr) {
179 /* This must be during construction; never mind */
184 Content::set_position (DCPTime p)
187 boost::mutex::scoped_lock lm (_mutex);
188 if (p == _position) {
195 signal_changed (ContentProperty::POSITION);
199 Content::set_trim_start (ContentTime t)
202 boost::mutex::scoped_lock lm (_mutex);
206 signal_changed (ContentProperty::TRIM_START);
210 Content::set_trim_end (ContentTime t)
213 boost::mutex::scoped_lock lm (_mutex);
217 signal_changed (ContentProperty::TRIM_END);
222 Content::clone () const
224 shared_ptr<const Film> film = _film.lock ();
226 return shared_ptr<Content> ();
229 /* This is a bit naughty, but I can't think of a compelling reason not to do it ... */
231 xmlpp::Node* node = doc.create_root_node ("Content");
234 /* notes is unused here (we assume) */
236 return content_factory (film, cxml::NodePtr (new cxml::Node (node)), Film::current_state_version, notes);
240 Content::technical_summary () const
242 return String::compose ("%1 %2 %3", path_summary(), digest(), position().seconds());
246 Content::length_after_trim () const
248 return max (DCPTime (), full_length() - DCPTime (trim_start() + trim_end(), film()->active_frame_rate_change (position ())));
251 /** @return string which changes when something about this content changes which affects
252 * the appearance of its video.
255 Content::identifier () const
259 s << Content::digest()
260 << "_" << position().get()
261 << "_" << trim_start().get()
262 << "_" << trim_end().get();
268 Content::paths_valid () const
270 for (vector<boost::filesystem::path>::const_iterator i = _paths.begin(); i != _paths.end(); ++i) {
271 if (!boost::filesystem::exists (*i)) {
280 Content::set_path (boost::filesystem::path path)
283 _paths.push_back (path);
284 signal_changed (ContentProperty::PATH);
288 Content::path_summary () const
290 /* XXX: should handle multiple paths more gracefully */
292 DCPOMATIC_ASSERT (number_of_paths ());
294 string s = path(0).filename().string ();
295 if (number_of_paths() > 1) {
302 /** @return a list of properties that might be interesting to the user */
304 Content::user_properties () const
306 list<UserProperty> p;
311 shared_ptr<const Film>
312 Content::film () const
314 shared_ptr<const Film> film = _film.lock ();
315 DCPOMATIC_ASSERT (film);
319 /** @return DCP times of points within this content where a reel split could occur */
321 Content::reel_split_points () const
324 /* XXX: this is questionable; perhaps the position itself should be forced to be on a frame boundary */
325 t.push_back (position().round_up (film()->video_frame_rate()));
330 Content::set_video_frame_rate (double r)
333 boost::mutex::scoped_lock lm (_mutex);
334 _video_frame_rate = r;
337 signal_changed (ContentProperty::VIDEO_FRAME_RATE);
341 Content::active_video_frame_rate () const
344 boost::mutex::scoped_lock lm (_mutex);
345 if (_video_frame_rate) {
346 return _video_frame_rate.get ();
350 /* No frame rate specified, so assume this content has been
351 prepared for any concurrent video content or perhaps
354 shared_ptr<const Film> film = _film.lock ();
355 DCPOMATIC_ASSERT (film);
356 return film->active_frame_rate_change(position()).source;
360 Content::add_properties (list<UserProperty>& p) const
362 p.push_back (UserProperty (_("General"), _("Filename"), path(0).string ()));
364 if (_video_frame_rate) {
365 p.push_back (UserProperty (_("General"), _("Video frame rate"), raw_convert<string> (_video_frame_rate.get(), 5), _("frames per second")));