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.
26 #include "change_signaller.h"
28 #include "content_factory.h"
29 #include "video_content.h"
30 #include "audio_content.h"
31 #include "text_content.h"
32 #include "exceptions.h"
35 #include "compose.hpp"
36 #include <dcp/locale_convert.h>
37 #include <dcp/raw_convert.h>
38 #include <libcxml/cxml.h>
39 #include <libxml++/libxml++.h>
40 #include <boost/thread/mutex.hpp>
51 using boost::shared_ptr;
52 using boost::optional;
53 using dcp::raw_convert;
54 using dcp::locale_convert;
56 int const ContentProperty::PATH = 400;
57 int const ContentProperty::POSITION = 401;
58 int const ContentProperty::LENGTH = 402;
59 int const ContentProperty::TRIM_START = 403;
60 int const ContentProperty::TRIM_END = 404;
61 int const ContentProperty::VIDEO_FRAME_RATE = 405;
63 Content::Content (shared_ptr<const Film> film)
68 , _change_signals_frequent (false)
73 Content::Content (shared_ptr<const Film> film, DCPTime p)
78 , _change_signals_frequent (false)
83 Content::Content (shared_ptr<const Film> film, boost::filesystem::path p)
88 , _change_signals_frequent (false)
93 Content::Content (shared_ptr<const Film> film, cxml::ConstNodePtr node)
95 , _change_signals_frequent (false)
97 list<cxml::NodePtr> path_children = node->node_children ("Path");
98 BOOST_FOREACH (cxml::NodePtr i, path_children) {
99 _paths.push_back (i->content());
100 optional<time_t> const mod = i->optional_number_child<time_t>("mtime");
102 _last_write_times.push_back (*mod);
103 } else if (boost::filesystem::exists(i->content())) {
104 _last_write_times.push_back (boost::filesystem::last_write_time(i->content()));
106 _last_write_times.push_back (0);
109 _digest = node->optional_string_child ("Digest").get_value_or ("X");
110 _position = DCPTime (node->number_child<DCPTime::Type> ("Position"));
111 _trim_start = ContentTime (node->number_child<ContentTime::Type> ("TrimStart"));
112 _trim_end = ContentTime (node->number_child<ContentTime::Type> ("TrimEnd"));
113 _video_frame_rate = node->optional_number_child<double> ("VideoFrameRate");
116 Content::Content (shared_ptr<const Film> film, vector<shared_ptr<Content> > c)
118 , _position (c.front()->position ())
119 , _trim_start (c.front()->trim_start ())
120 , _trim_end (c.back()->trim_end ())
121 , _video_frame_rate (c.front()->video_frame_rate())
122 , _change_signals_frequent (false)
124 for (size_t i = 0; i < c.size(); ++i) {
125 if (i > 0 && c[i]->trim_start() > ContentTime ()) {
126 throw JoinError (_("Only the first piece of content to be joined can have a start trim."));
129 if (i < (c.size() - 1) && c[i]->trim_end () > ContentTime ()) {
130 throw JoinError (_("Only the last piece of content to be joined can have an end trim."));
134 (_video_frame_rate && !c[i]->_video_frame_rate) ||
135 (!_video_frame_rate && c[i]->_video_frame_rate)
137 throw JoinError (_("Content to be joined must have the same video frame rate"));
140 if (_video_frame_rate && fabs (_video_frame_rate.get() - c[i]->_video_frame_rate.get()) > VIDEO_FRAME_RATE_EPSILON) {
141 throw JoinError (_("Content to be joined must have the same video frame rate"));
144 for (size_t j = 0; j < c[i]->number_of_paths(); ++j) {
145 _paths.push_back (c[i]->path(j));
146 _last_write_times.push_back (c[i]->_last_write_times[j]);
152 Content::as_xml (xmlpp::Node* node, bool with_paths) const
154 boost::mutex::scoped_lock lm (_mutex);
157 for (size_t i = 0; i < _paths.size(); ++i) {
158 xmlpp::Element* p = node->add_child("Path");
159 p->add_child_text (_paths[i].string());
160 p->set_attribute ("mtime", raw_convert<string>(_last_write_times[i]));
163 node->add_child("Digest")->add_child_text (_digest);
164 node->add_child("Position")->add_child_text (raw_convert<string> (_position.get ()));
165 node->add_child("TrimStart")->add_child_text (raw_convert<string> (_trim_start.get ()));
166 node->add_child("TrimEnd")->add_child_text (raw_convert<string> (_trim_end.get ()));
167 if (_video_frame_rate) {
168 node->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate.get()));
173 Content::examine (shared_ptr<Job> job)
176 job->sub (_("Computing digest"));
179 boost::mutex::scoped_lock lm (_mutex);
180 vector<boost::filesystem::path> p = _paths;
183 /* Some content files are very big, so we use a poor man's
184 digest here: a digest of the first and last 1e6 bytes with the
185 size of the first file tacked on the end as a string.
187 string const d = digest_head_tail (p, 1000000) + raw_convert<string> (boost::filesystem::file_size (p.front ()));
194 Content::signal_change (ChangeType c, int p)
197 if (c == CHANGE_TYPE_PENDING || c == CHANGE_TYPE_CANCELLED) {
198 Change (c, shared_from_this(), p, _change_signals_frequent);
200 emit (boost::bind (boost::ref(Change), c, shared_from_this(), p, _change_signals_frequent));
202 } catch (boost::bad_weak_ptr) {
203 /* This must be during construction; never mind */
208 Content::set_position (DCPTime p)
210 /* video and audio content can modify its position */
213 video->modify_position (p);
217 audio->modify_position (p);
220 ChangeSignaller<Content> cc (this, ContentProperty::POSITION);
223 boost::mutex::scoped_lock lm (_mutex);
224 if (p == _position) {
234 Content::set_trim_start (ContentTime t)
236 /* video and audio content can modify its start trim */
239 video->modify_trim_start (t);
243 audio->modify_trim_start (t);
246 ChangeSignaller<Content> cc (this, ContentProperty::TRIM_START);
249 boost::mutex::scoped_lock lm (_mutex);
255 Content::set_trim_end (ContentTime t)
257 ChangeSignaller<Content> cc (this, ContentProperty::TRIM_END);
260 boost::mutex::scoped_lock lm (_mutex);
267 Content::clone () const
269 shared_ptr<const Film> film = _film.lock ();
271 return shared_ptr<Content> ();
274 /* This is a bit naughty, but I can't think of a compelling reason not to do it ... */
276 xmlpp::Node* node = doc.create_root_node ("Content");
279 /* notes is unused here (we assume) */
281 return content_factory (film, cxml::NodePtr (new cxml::Node (node)), Film::current_state_version, notes);
285 Content::technical_summary () const
287 return String::compose ("%1 %2 %3", path_summary(), digest(), position().seconds());
291 Content::length_after_trim () const
293 return max (DCPTime (), full_length() - DCPTime (trim_start() + trim_end(), film()->active_frame_rate_change (position ())));
296 /** @return string which changes when something about this content changes which affects
297 * the appearance of its video.
300 Content::identifier () const
304 buffer, sizeof(buffer), "%s_%" PRId64 "_%" PRId64 "_%" PRId64,
305 Content::digest().c_str(), position().get(), trim_start().get(), trim_end().get()
311 Content::paths_valid () const
313 BOOST_FOREACH (boost::filesystem::path i, _paths) {
314 if (!boost::filesystem::exists (i)) {
323 Content::set_paths (vector<boost::filesystem::path> paths)
325 ChangeSignaller<Content> cc (this, ContentProperty::PATH);
328 boost::mutex::scoped_lock lm (_mutex);
330 _last_write_times.clear ();
331 BOOST_FOREACH (boost::filesystem::path i, _paths) {
332 _last_write_times.push_back (boost::filesystem::last_write_time(i));
338 Content::path_summary () const
340 /* XXX: should handle multiple paths more gracefully */
342 DCPOMATIC_ASSERT (number_of_paths ());
344 string s = path(0).filename().string ();
345 if (number_of_paths() > 1) {
352 /** @return a list of properties that might be interesting to the user */
354 Content::user_properties () const
356 list<UserProperty> p;
361 shared_ptr<const Film>
362 Content::film () const
364 shared_ptr<const Film> film = _film.lock ();
365 DCPOMATIC_ASSERT (film);
369 /** @return DCP times of points within this content where a reel split could occur */
371 Content::reel_split_points () const
374 /* This is only called for video content and such content has its position forced
375 to start on a frame boundary.
377 t.push_back (position());
382 Content::set_video_frame_rate (double r)
384 ChangeSignaller<Content> cc (this, ContentProperty::VIDEO_FRAME_RATE);
387 boost::mutex::scoped_lock lm (_mutex);
388 _video_frame_rate = r;
391 /* Make sure trim is still on a frame boundary */
393 set_trim_start (trim_start());
398 Content::unset_video_frame_rate ()
400 ChangeSignaller<Content> cc (this, ContentProperty::VIDEO_FRAME_RATE);
403 boost::mutex::scoped_lock lm (_mutex);
404 _video_frame_rate = optional<double>();
409 Content::active_video_frame_rate () const
412 boost::mutex::scoped_lock lm (_mutex);
413 if (_video_frame_rate) {
414 return _video_frame_rate.get ();
418 /* No frame rate specified, so assume this content has been
419 prepared for any concurrent video content or perhaps
422 shared_ptr<const Film> film = _film.lock ();
423 DCPOMATIC_ASSERT (film);
424 return film->active_frame_rate_change(position()).source;
428 Content::add_properties (list<UserProperty>& p) const
430 p.push_back (UserProperty (UserProperty::GENERAL, _("Filename"), path(0).string ()));
432 if (_video_frame_rate) {
438 locale_convert<string> (_video_frame_rate.get(), 5),
439 _("frames per second")
445 UserProperty::GENERAL,
446 _("Prepared for video frame rate"),
447 locale_convert<string> (_video_frame_rate.get(), 5),
448 _("frames per second")
455 /** Take settings from the given content if it is of the correct type */
457 Content::take_settings_from (shared_ptr<const Content> c)
459 if (video && c->video) {
460 video->take_settings_from (c->video);
462 if (audio && c->audio) {
463 audio->take_settings_from (c->audio);
466 list<shared_ptr<TextContent> >::iterator i = text.begin ();
467 list<shared_ptr<TextContent> >::const_iterator j = c->text.begin ();
468 while (i != text.end() && j != c->text.end()) {
469 (*i)->take_settings_from (*j);
475 shared_ptr<TextContent>
476 Content::only_text () const
478 DCPOMATIC_ASSERT (text.size() < 2);
480 return shared_ptr<TextContent> ();
482 return text.front ();
485 shared_ptr<TextContent>
486 Content::text_of_original_type (TextType type) const
488 BOOST_FOREACH (shared_ptr<TextContent> i, text) {
489 if (i->original_type() == type) {
494 return shared_ptr<TextContent> ();
498 Content::add_path (boost::filesystem::path p)
500 boost::mutex::scoped_lock lm (_mutex);
501 _paths.push_back (p);
502 _last_write_times.push_back (boost::filesystem::last_write_time(p));