2 Copyright (C) 2013-2016 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 "video_content.h"
29 #include "audio_content.h"
30 #include "subtitle_content.h"
31 #include "exceptions.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>
50 using boost::shared_ptr;
51 using dcp::raw_convert;
52 using dcp::locale_convert;
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;
61 Content::Content (shared_ptr<const Film> film)
66 , _change_signals_frequent (false)
71 Content::Content (shared_ptr<const Film> film, DCPTime p)
76 , _change_signals_frequent (false)
81 Content::Content (shared_ptr<const Film> film, boost::filesystem::path p)
86 , _change_signals_frequent (false)
91 Content::Content (shared_ptr<const Film> film, cxml::ConstNodePtr node)
93 , _change_signals_frequent (false)
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 ());
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");
106 Content::Content (shared_ptr<const Film> film, vector<shared_ptr<Content> > c)
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)
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."));
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."));
124 (_video_frame_rate && !c[i]->_video_frame_rate) ||
125 (!_video_frame_rate && c[i]->_video_frame_rate)
127 throw JoinError (_("Content to be joined must have the same video frame rate"));
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"));
134 for (size_t j = 0; j < c[i]->number_of_paths(); ++j) {
135 _paths.push_back (c[i]->path (j));
141 Content::as_xml (xmlpp::Node* node, bool with_paths) const
143 boost::mutex::scoped_lock lm (_mutex);
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 ());
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()));
160 Content::examine (shared_ptr<Job> job)
163 job->sub (_("Computing digest"));
166 boost::mutex::scoped_lock lm (_mutex);
167 vector<boost::filesystem::path> p = _paths;
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.
174 string const d = digest_head_tail (p, 1000000) + raw_convert<string> (boost::filesystem::file_size (p.front ()));
181 Content::signal_changed (int p)
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 */
191 Content::set_position (DCPTime p)
194 boost::mutex::scoped_lock lm (_mutex);
195 if (p == _position) {
202 signal_changed (ContentProperty::POSITION);
206 Content::set_trim_start (ContentTime t)
209 boost::mutex::scoped_lock lm (_mutex);
213 signal_changed (ContentProperty::TRIM_START);
217 Content::set_trim_end (ContentTime t)
220 boost::mutex::scoped_lock lm (_mutex);
224 signal_changed (ContentProperty::TRIM_END);
229 Content::clone () const
231 shared_ptr<const Film> film = _film.lock ();
233 return shared_ptr<Content> ();
236 /* This is a bit naughty, but I can't think of a compelling reason not to do it ... */
238 xmlpp::Node* node = doc.create_root_node ("Content");
241 /* notes is unused here (we assume) */
243 return content_factory (film, cxml::NodePtr (new cxml::Node (node)), Film::current_state_version, notes);
247 Content::technical_summary () const
249 return String::compose ("%1 %2 %3", path_summary(), digest(), position().seconds());
253 Content::length_after_trim () const
255 return max (DCPTime (), full_length() - DCPTime (trim_start() + trim_end(), film()->active_frame_rate_change (position ())));
258 /** @return string which changes when something about this content changes which affects
259 * the appearance of its video.
262 Content::identifier () const
266 buffer, sizeof(buffer), "%s_%" PRId64 "_%" PRId64 "_%" PRId64,
267 Content::digest().c_str(), position().get(), trim_start().get(), trim_end().get()
273 Content::paths_valid () const
275 for (vector<boost::filesystem::path>::const_iterator i = _paths.begin(); i != _paths.end(); ++i) {
276 if (!boost::filesystem::exists (*i)) {
285 Content::set_path (boost::filesystem::path path)
288 _paths.push_back (path);
289 signal_changed (ContentProperty::PATH);
293 Content::path_summary () const
295 /* XXX: should handle multiple paths more gracefully */
297 DCPOMATIC_ASSERT (number_of_paths ());
299 string s = path(0).filename().string ();
300 if (number_of_paths() > 1) {
307 /** @return a list of properties that might be interesting to the user */
309 Content::user_properties () const
311 list<UserProperty> p;
316 shared_ptr<const Film>
317 Content::film () const
319 shared_ptr<const Film> film = _film.lock ();
320 DCPOMATIC_ASSERT (film);
324 /** @return DCP times of points within this content where a reel split could occur */
326 Content::reel_split_points () const
329 /* XXX: this is questionable; perhaps the position itself should be forced to be on a frame boundary */
330 t.push_back (position().ceil (film()->video_frame_rate()));
335 Content::set_video_frame_rate (double r)
338 boost::mutex::scoped_lock lm (_mutex);
339 _video_frame_rate = r;
342 signal_changed (ContentProperty::VIDEO_FRAME_RATE);
346 Content::active_video_frame_rate () const
349 boost::mutex::scoped_lock lm (_mutex);
350 if (_video_frame_rate) {
351 return _video_frame_rate.get ();
355 /* No frame rate specified, so assume this content has been
356 prepared for any concurrent video content or perhaps
359 shared_ptr<const Film> film = _film.lock ();
360 DCPOMATIC_ASSERT (film);
361 return film->active_frame_rate_change(position()).source;
365 Content::add_properties (list<UserProperty>& p) const
367 p.push_back (UserProperty (UserProperty::GENERAL, _("Filename"), path(0).string ()));
369 if (_video_frame_rate) {
375 locale_convert<string> (_video_frame_rate.get(), 5),
376 _("frames per second")
382 UserProperty::GENERAL,
383 _("Prepared for video frame rate"),
384 locale_convert<string> (_video_frame_rate.get(), 5),
385 _("frames per second")
393 Content::use_template (shared_ptr<const Content> c)
395 if (video && c->video) {
396 video->use_template (c->video);
398 if (audio && c->audio) {
399 audio->use_template (c->audio);
401 if (subtitle && c->subtitle) {
402 subtitle->use_template (c->subtitle);