2 Copyright (C) 2013-2018 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 "text_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 boost::optional;
52 using dcp::raw_convert;
53 using dcp::locale_convert;
55 int const ContentProperty::PATH = 400;
56 int const ContentProperty::POSITION = 401;
57 int const ContentProperty::LENGTH = 402;
58 int const ContentProperty::TRIM_START = 403;
59 int const ContentProperty::TRIM_END = 404;
60 int const ContentProperty::VIDEO_FRAME_RATE = 405;
62 Content::Content (shared_ptr<const Film> film)
67 , _change_signals_frequent (false)
72 Content::Content (shared_ptr<const Film> film, DCPTime p)
77 , _change_signals_frequent (false)
82 Content::Content (shared_ptr<const Film> film, boost::filesystem::path p)
87 , _change_signals_frequent (false)
92 Content::Content (shared_ptr<const Film> film, cxml::ConstNodePtr node)
94 , _change_signals_frequent (false)
96 list<cxml::NodePtr> path_children = node->node_children ("Path");
97 for (list<cxml::NodePtr>::const_iterator i = path_children.begin(); i != path_children.end(); ++i) {
98 _paths.push_back ((*i)->content ());
100 _digest = node->optional_string_child ("Digest").get_value_or ("X");
101 _position = DCPTime (node->number_child<DCPTime::Type> ("Position"));
102 _trim_start = ContentTime (node->number_child<ContentTime::Type> ("TrimStart"));
103 _trim_end = ContentTime (node->number_child<ContentTime::Type> ("TrimEnd"));
104 _video_frame_rate = node->optional_number_child<double> ("VideoFrameRate");
107 Content::Content (shared_ptr<const Film> film, vector<shared_ptr<Content> > c)
109 , _position (c.front()->position ())
110 , _trim_start (c.front()->trim_start ())
111 , _trim_end (c.back()->trim_end ())
112 , _video_frame_rate (c.front()->video_frame_rate())
113 , _change_signals_frequent (false)
115 for (size_t i = 0; i < c.size(); ++i) {
116 if (i > 0 && c[i]->trim_start() > ContentTime ()) {
117 throw JoinError (_("Only the first piece of content to be joined can have a start trim."));
120 if (i < (c.size() - 1) && c[i]->trim_end () > ContentTime ()) {
121 throw JoinError (_("Only the last piece of content to be joined can have an end trim."));
125 (_video_frame_rate && !c[i]->_video_frame_rate) ||
126 (!_video_frame_rate && c[i]->_video_frame_rate)
128 throw JoinError (_("Content to be joined must have the same video frame rate"));
131 if (_video_frame_rate && fabs (_video_frame_rate.get() - c[i]->_video_frame_rate.get()) > VIDEO_FRAME_RATE_EPSILON) {
132 throw JoinError (_("Content to be joined must have the same video frame rate"));
135 for (size_t j = 0; j < c[i]->number_of_paths(); ++j) {
136 _paths.push_back (c[i]->path (j));
142 Content::as_xml (xmlpp::Node* node, bool with_paths) const
144 boost::mutex::scoped_lock lm (_mutex);
147 for (vector<boost::filesystem::path>::const_iterator i = _paths.begin(); i != _paths.end(); ++i) {
148 node->add_child("Path")->add_child_text (i->string ());
151 node->add_child("Digest")->add_child_text (_digest);
152 node->add_child("Position")->add_child_text (raw_convert<string> (_position.get ()));
153 node->add_child("TrimStart")->add_child_text (raw_convert<string> (_trim_start.get ()));
154 node->add_child("TrimEnd")->add_child_text (raw_convert<string> (_trim_end.get ()));
155 if (_video_frame_rate) {
156 node->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate.get()));
161 Content::examine (shared_ptr<Job> job)
164 job->sub (_("Computing digest"));
167 boost::mutex::scoped_lock lm (_mutex);
168 vector<boost::filesystem::path> p = _paths;
171 /* Some content files are very big, so we use a poor man's
172 digest here: a digest of the first and last 1e6 bytes with the
173 size of the first file tacked on the end as a string.
175 string const d = digest_head_tail (p, 1000000) + raw_convert<string> (boost::filesystem::file_size (p.front ()));
182 Content::signal_changed (int p)
185 emit (boost::bind (boost::ref (Changed), shared_from_this (), p, _change_signals_frequent));
186 } catch (boost::bad_weak_ptr) {
187 /* This must be during construction; never mind */
192 Content::set_position (DCPTime p)
194 /* video and audio content can modify its position */
197 video->modify_position (p);
201 audio->modify_position (p);
205 boost::mutex::scoped_lock lm (_mutex);
206 if (p == _position) {
213 signal_changed (ContentProperty::POSITION);
217 Content::set_trim_start (ContentTime t)
219 /* video and audio content can modify its start trim */
222 video->modify_trim_start (t);
226 audio->modify_trim_start (t);
230 boost::mutex::scoped_lock lm (_mutex);
234 signal_changed (ContentProperty::TRIM_START);
238 Content::set_trim_end (ContentTime t)
241 boost::mutex::scoped_lock lm (_mutex);
245 signal_changed (ContentProperty::TRIM_END);
250 Content::clone () const
252 shared_ptr<const Film> film = _film.lock ();
254 return shared_ptr<Content> ();
257 /* This is a bit naughty, but I can't think of a compelling reason not to do it ... */
259 xmlpp::Node* node = doc.create_root_node ("Content");
262 /* notes is unused here (we assume) */
264 return content_factory (film, cxml::NodePtr (new cxml::Node (node)), Film::current_state_version, notes);
268 Content::technical_summary () const
270 return String::compose ("%1 %2 %3", path_summary(), digest(), position().seconds());
274 Content::length_after_trim () const
276 return max (DCPTime (), full_length() - DCPTime (trim_start() + trim_end(), film()->active_frame_rate_change (position ())));
279 /** @return string which changes when something about this content changes which affects
280 * the appearance of its video.
283 Content::identifier () const
287 buffer, sizeof(buffer), "%s_%" PRId64 "_%" PRId64 "_%" PRId64,
288 Content::digest().c_str(), position().get(), trim_start().get(), trim_end().get()
294 Content::paths_valid () const
296 for (vector<boost::filesystem::path>::const_iterator i = _paths.begin(); i != _paths.end(); ++i) {
297 if (!boost::filesystem::exists (*i)) {
306 Content::set_path (boost::filesystem::path path)
309 _paths.push_back (path);
310 signal_changed (ContentProperty::PATH);
314 Content::set_paths (vector<boost::filesystem::path> paths)
317 signal_changed (ContentProperty::PATH);
321 Content::path_summary () const
323 /* XXX: should handle multiple paths more gracefully */
325 DCPOMATIC_ASSERT (number_of_paths ());
327 string s = path(0).filename().string ();
328 if (number_of_paths() > 1) {
335 /** @return a list of properties that might be interesting to the user */
337 Content::user_properties () const
339 list<UserProperty> p;
344 shared_ptr<const Film>
345 Content::film () const
347 shared_ptr<const Film> film = _film.lock ();
348 DCPOMATIC_ASSERT (film);
352 /** @return DCP times of points within this content where a reel split could occur */
354 Content::reel_split_points () const
357 /* This is only called for video content and such content has its position forced
358 to start on a frame boundary.
360 t.push_back (position());
365 Content::set_video_frame_rate (double r)
368 boost::mutex::scoped_lock lm (_mutex);
369 _video_frame_rate = r;
372 signal_changed (ContentProperty::VIDEO_FRAME_RATE);
374 /* Make sure things are still on frame boundaries */
376 set_position (position());
377 set_trim_start (trim_start());
382 Content::unset_video_frame_rate ()
385 boost::mutex::scoped_lock lm (_mutex);
386 _video_frame_rate = optional<double>();
389 signal_changed (ContentProperty::VIDEO_FRAME_RATE);
393 Content::active_video_frame_rate () const
396 boost::mutex::scoped_lock lm (_mutex);
397 if (_video_frame_rate) {
398 return _video_frame_rate.get ();
402 /* No frame rate specified, so assume this content has been
403 prepared for any concurrent video content or perhaps
406 shared_ptr<const Film> film = _film.lock ();
407 DCPOMATIC_ASSERT (film);
408 return film->active_frame_rate_change(position()).source;
412 Content::add_properties (list<UserProperty>& p) const
414 p.push_back (UserProperty (UserProperty::GENERAL, _("Filename"), path(0).string ()));
416 if (_video_frame_rate) {
422 locale_convert<string> (_video_frame_rate.get(), 5),
423 _("frames per second")
429 UserProperty::GENERAL,
430 _("Prepared for video frame rate"),
431 locale_convert<string> (_video_frame_rate.get(), 5),
432 _("frames per second")
439 /** Take settings from the given content if it is of the correct type */
441 Content::take_settings_from (shared_ptr<const Content> c)
443 if (video && c->video) {
444 video->take_settings_from (c->video);
446 if (audio && c->audio) {
447 audio->take_settings_from (c->audio);
450 list<shared_ptr<TextContent> >::iterator i = text.begin ();
451 list<shared_ptr<TextContent> >::const_iterator j = c->text.begin ();
452 while (i != text.end() && j != c->text.end()) {
453 (*i)->take_settings_from (*j);
459 shared_ptr<TextContent>
460 Content::only_text () const
462 DCPOMATIC_ASSERT (text.size() < 2);
464 return shared_ptr<TextContent> ();
466 return text.front ();
469 shared_ptr<TextContent>
470 Content::text_of_original_type (TextType type) const
472 BOOST_FOREACH (shared_ptr<TextContent> i, text) {
473 if (i->original_type() == type) {
478 return shared_ptr<TextContent> ();