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 "caption_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");
108 Content::as_xml (xmlpp::Node* node, bool with_paths) const
110 boost::mutex::scoped_lock lm (_mutex);
113 for (vector<boost::filesystem::path>::const_iterator i = _paths.begin(); i != _paths.end(); ++i) {
114 node->add_child("Path")->add_child_text (i->string ());
117 node->add_child("Digest")->add_child_text (_digest);
118 node->add_child("Position")->add_child_text (raw_convert<string> (_position.get ()));
119 node->add_child("TrimStart")->add_child_text (raw_convert<string> (_trim_start.get ()));
120 node->add_child("TrimEnd")->add_child_text (raw_convert<string> (_trim_end.get ()));
121 if (_video_frame_rate) {
122 node->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate.get()));
127 Content::examine (shared_ptr<Job> job)
130 job->sub (_("Computing digest"));
133 boost::mutex::scoped_lock lm (_mutex);
134 vector<boost::filesystem::path> p = _paths;
137 /* Some content files are very big, so we use a poor man's
138 digest here: a digest of the first and last 1e6 bytes with the
139 size of the first file tacked on the end as a string.
141 string const d = digest_head_tail (p, 1000000) + raw_convert<string> (boost::filesystem::file_size (p.front ()));
148 Content::signal_changed (int p)
151 emit (boost::bind (boost::ref (Changed), shared_from_this (), p, _change_signals_frequent));
152 } catch (boost::bad_weak_ptr) {
153 /* This must be during construction; never mind */
158 Content::set_position (DCPTime p)
160 /* video content can modify its position */
162 video->modify_position (p);
166 boost::mutex::scoped_lock lm (_mutex);
167 if (p == _position) {
174 signal_changed (ContentProperty::POSITION);
178 Content::set_trim_start (ContentTime t)
180 /* video content can modify its start trim */
182 video->modify_trim_start (t);
186 boost::mutex::scoped_lock lm (_mutex);
190 signal_changed (ContentProperty::TRIM_START);
194 Content::set_trim_end (ContentTime t)
197 boost::mutex::scoped_lock lm (_mutex);
201 signal_changed (ContentProperty::TRIM_END);
206 Content::clone () const
208 shared_ptr<const Film> film = _film.lock ();
210 return shared_ptr<Content> ();
213 /* This is a bit naughty, but I can't think of a compelling reason not to do it ... */
215 xmlpp::Node* node = doc.create_root_node ("Content");
218 /* notes is unused here (we assume) */
220 return content_factory (film, cxml::NodePtr (new cxml::Node (node)), Film::current_state_version, notes);
224 Content::technical_summary () const
226 return String::compose ("%1 %2 %3", path_summary(), digest(), position().seconds());
230 Content::length_after_trim () const
232 return max (DCPTime (), full_length() - DCPTime (trim_start() + trim_end(), film()->active_frame_rate_change (position ())));
235 /** @return string which changes when something about this content changes which affects
236 * the appearance of its video.
239 Content::identifier () const
243 buffer, sizeof(buffer), "%s_%" PRId64 "_%" PRId64 "_%" PRId64,
244 Content::digest().c_str(), position().get(), trim_start().get(), trim_end().get()
250 Content::paths_valid () const
252 for (vector<boost::filesystem::path>::const_iterator i = _paths.begin(); i != _paths.end(); ++i) {
253 if (!boost::filesystem::exists (*i)) {
262 Content::set_path (boost::filesystem::path path)
265 _paths.push_back (path);
266 signal_changed (ContentProperty::PATH);
270 Content::set_paths (vector<boost::filesystem::path> paths)
273 signal_changed (ContentProperty::PATH);
277 Content::path_summary () const
279 /* XXX: should handle multiple paths more gracefully */
281 DCPOMATIC_ASSERT (number_of_paths ());
283 string s = path(0).filename().string ();
284 if (number_of_paths() > 1) {
291 /** @return a list of properties that might be interesting to the user */
293 Content::user_properties () const
295 list<UserProperty> p;
300 shared_ptr<const Film>
301 Content::film () const
303 shared_ptr<const Film> film = _film.lock ();
304 DCPOMATIC_ASSERT (film);
308 /** @return DCP times of points within this content where a reel split could occur */
310 Content::reel_split_points () const
313 /* This is only called for video content and such content has its position forced
314 to start on a frame boundary.
316 t.push_back (position());
321 Content::set_video_frame_rate (double r)
324 boost::mutex::scoped_lock lm (_mutex);
325 _video_frame_rate = r;
328 signal_changed (ContentProperty::VIDEO_FRAME_RATE);
330 /* Make sure things are still on frame boundaries */
332 set_position (position());
333 set_trim_start (trim_start());
338 Content::unset_video_frame_rate ()
341 boost::mutex::scoped_lock lm (_mutex);
342 _video_frame_rate = optional<double>();
345 signal_changed (ContentProperty::VIDEO_FRAME_RATE);
349 Content::active_video_frame_rate () const
352 boost::mutex::scoped_lock lm (_mutex);
353 if (_video_frame_rate) {
354 return _video_frame_rate.get ();
358 /* No frame rate specified, so assume this content has been
359 prepared for any concurrent video content or perhaps
362 shared_ptr<const Film> film = _film.lock ();
363 DCPOMATIC_ASSERT (film);
364 return film->active_frame_rate_change(position()).source;
368 Content::add_properties (list<UserProperty>& p) const
370 p.push_back (UserProperty (UserProperty::GENERAL, _("Filename"), path(0).string ()));
372 if (_video_frame_rate) {
378 locale_convert<string> (_video_frame_rate.get(), 5),
379 _("frames per second")
385 UserProperty::GENERAL,
386 _("Prepared for video frame rate"),
387 locale_convert<string> (_video_frame_rate.get(), 5),
388 _("frames per second")
395 /** Take settings from the given content if it is of the correct type */
397 Content::take_settings_from (shared_ptr<const Content> c)
399 if (video && c->video) {
400 video->take_settings_from (c->video);
402 if (audio && c->audio) {
403 audio->take_settings_from (c->audio);
405 if (caption && c->caption) {
406 caption->take_settings_from (c->caption);