2 Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 /** @file src/lib/content.cc
21 * @brief Content class.
24 #include <boost/thread/mutex.hpp>
25 #include <libxml++/libxml++.h>
26 #include <libcxml/cxml.h>
27 #include <dcp/raw_convert.h>
30 #include "content_factory.h"
31 #include "ui_signaller.h"
32 #include "exceptions.h"
34 #include "safe_stringstream.h"
45 using boost::shared_ptr;
46 using dcp::raw_convert;
48 int const ContentProperty::PATH = 400;
49 int const ContentProperty::POSITION = 401;
50 int const ContentProperty::LENGTH = 402;
51 int const ContentProperty::TRIM_START = 403;
52 int const ContentProperty::TRIM_END = 404;
54 Content::Content (shared_ptr<const Film> f)
59 , _change_signals_frequent (false)
64 Content::Content (shared_ptr<const Film> f, DCPTime p)
69 , _change_signals_frequent (false)
74 Content::Content (shared_ptr<const Film> f, boost::filesystem::path p)
79 , _change_signals_frequent (false)
84 Content::Content (shared_ptr<const Film> f, cxml::ConstNodePtr node)
86 , _change_signals_frequent (false)
88 list<cxml::NodePtr> path_children = node->node_children ("Path");
89 for (list<cxml::NodePtr>::const_iterator i = path_children.begin(); i != path_children.end(); ++i) {
90 _paths.push_back ((*i)->content ());
92 _digest = node->optional_string_child ("Digest");
93 _position = DCPTime (node->number_child<double> ("Position"));
94 _trim_start = DCPTime (node->number_child<double> ("TrimStart"));
95 _trim_end = DCPTime (node->number_child<double> ("TrimEnd"));
98 Content::Content (shared_ptr<const Film> f, vector<shared_ptr<Content> > c)
100 , _position (c.front()->position ())
101 , _trim_start (c.front()->trim_start ())
102 , _trim_end (c.back()->trim_end ())
103 , _change_signals_frequent (false)
105 for (size_t i = 0; i < c.size(); ++i) {
106 if (i > 0 && c[i]->trim_start() > DCPTime()) {
107 throw JoinError (_("Only the first piece of content to be joined can have a start trim."));
110 if (i < (c.size() - 1) && c[i]->trim_end () > DCPTime()) {
111 throw JoinError (_("Only the last piece of content to be joined can have an end trim."));
114 for (size_t j = 0; j < c[i]->number_of_paths(); ++j) {
115 _paths.push_back (c[i]->path (j));
121 Content::as_xml (xmlpp::Node* node) const
123 boost::mutex::scoped_lock lm (_mutex);
125 for (vector<boost::filesystem::path>::const_iterator i = _paths.begin(); i != _paths.end(); ++i) {
126 node->add_child("Path")->add_child_text (i->string ());
129 node->add_child("Digest")->add_child_text (_digest.get ());
131 node->add_child("Position")->add_child_text (raw_convert<string> (_position.get ()));
132 node->add_child("TrimStart")->add_child_text (raw_convert<string> (_trim_start.get ()));
133 node->add_child("TrimEnd")->add_child_text (raw_convert<string> (_trim_end.get ()));
137 Content::examine (shared_ptr<Job> job, bool calculate_digest)
139 if (!calculate_digest) {
143 job->sub (_("Computing digest"));
145 boost::mutex::scoped_lock lm (_mutex);
146 vector<boost::filesystem::path> p = _paths;
149 string const d = md5_digest (p, job);
156 Content::signal_changed (int p)
159 ui_signaller->emit (boost::bind (boost::ref (Changed), shared_from_this (), p, _change_signals_frequent));
164 Content::set_position (DCPTime p)
167 boost::mutex::scoped_lock lm (_mutex);
168 if (p == _position) {
175 signal_changed (ContentProperty::POSITION);
179 Content::set_trim_start (DCPTime t)
182 boost::mutex::scoped_lock lm (_mutex);
186 signal_changed (ContentProperty::TRIM_START);
190 Content::set_trim_end (DCPTime t)
193 boost::mutex::scoped_lock lm (_mutex);
197 signal_changed (ContentProperty::TRIM_END);
202 Content::clone () const
204 shared_ptr<const Film> film = _film.lock ();
206 return shared_ptr<Content> ();
209 /* This is a bit naughty, but I can't think of a compelling reason not to do it ... */
211 xmlpp::Node* node = doc.create_root_node ("Content");
214 /* notes is unused here (we assume) */
216 return content_factory (film, cxml::NodePtr (new cxml::Node (node)), Film::current_state_version, notes);
220 Content::technical_summary () const
222 return String::compose ("%1 %2 %3", path_summary(), digest(), position().seconds());
226 Content::length_after_trim () const
228 return max (DCPTime (), full_length() - trim_start() - trim_end());
231 /** @return string which includes everything about how this content affects
235 Content::identifier () const
239 s << Content::digest()
240 << "_" << position().get()
241 << "_" << trim_start().get()
242 << "_" << trim_end().get();
248 Content::paths_valid () const
250 for (vector<boost::filesystem::path>::const_iterator i = _paths.begin(); i != _paths.end(); ++i) {
251 if (!boost::filesystem::exists (*i)) {
260 Content::set_path (boost::filesystem::path path)
263 _paths.push_back (path);
264 signal_changed (ContentProperty::PATH);
268 Content::path_summary () const
270 /* XXX: should handle multiple paths more gracefully */
272 assert (number_of_paths ());
274 string s = path(0).filename().string ();
275 if (number_of_paths() > 1) {