Allow films to be loaded when content is missing.
[dcpomatic.git] / src / lib / content.cc
1 /*
2     Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
3
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.
8
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.
13
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.
17
18 */
19
20 #include <boost/thread/mutex.hpp>
21 #include <libxml++/libxml++.h>
22 #include <libcxml/cxml.h>
23 #include "content.h"
24 #include "util.h"
25 #include "content_factory.h"
26 #include "ui_signaller.h"
27
28 using std::string;
29 using std::stringstream;
30 using std::set;
31 using boost::shared_ptr;
32 using boost::lexical_cast;
33
34 int const ContentProperty::PATH = 400;
35 int const ContentProperty::POSITION = 401;
36 int const ContentProperty::LENGTH = 402;
37 int const ContentProperty::TRIM_START = 403;
38 int const ContentProperty::TRIM_END = 404;
39
40 Content::Content (shared_ptr<const Film> f, Time p)
41         : _film (f)
42         , _position (p)
43         , _trim_start (0)
44         , _trim_end (0)
45         , _change_signals_frequent (false)
46 {
47
48 }
49
50 Content::Content (shared_ptr<const Film> f, boost::filesystem::path p)
51         : _film (f)
52         , _path (p)
53         , _position (0)
54         , _trim_start (0)
55         , _trim_end (0)
56         , _change_signals_frequent (false)
57 {
58
59 }
60
61 Content::Content (shared_ptr<const Film> f, shared_ptr<const cxml::Node> node)
62         : _film (f)
63         , _change_signals_frequent (false)
64 {
65         _path = node->string_child ("Path");
66         _digest = node->string_child ("Digest");
67         _position = node->number_child<Time> ("Position");
68         _trim_start = node->number_child<Time> ("TrimStart");
69         _trim_end = node->number_child<Time> ("TrimEnd");
70 }
71
72 void
73 Content::as_xml (xmlpp::Node* node) const
74 {
75         boost::mutex::scoped_lock lm (_mutex);
76         
77         node->add_child("Path")->add_child_text (_path.string());
78         node->add_child("Digest")->add_child_text (_digest);
79         node->add_child("Position")->add_child_text (lexical_cast<string> (_position));
80         node->add_child("TrimStart")->add_child_text (lexical_cast<string> (_trim_start));
81         node->add_child("TrimEnd")->add_child_text (lexical_cast<string> (_trim_end));
82 }
83
84 void
85 Content::examine (shared_ptr<Job> job)
86 {
87         boost::mutex::scoped_lock lm (_mutex);
88         boost::filesystem::path p = _path;
89         lm.unlock ();
90         
91         string d;
92         if (boost::filesystem::is_regular_file (p)) {
93                 d = md5_digest (p);
94         } else {
95                 d = md5_digest_directory (p, job);
96         }
97
98         lm.lock ();
99         _digest = d;
100 }
101
102 void
103 Content::signal_changed (int p)
104 {
105         if (ui_signaller) {
106                 ui_signaller->emit (boost::bind (boost::ref (Changed), shared_from_this (), p, _change_signals_frequent));
107         }
108 }
109
110 void
111 Content::set_position (Time p)
112 {
113         {
114                 boost::mutex::scoped_lock lm (_mutex);
115                 _position = p;
116         }
117
118         signal_changed (ContentProperty::POSITION);
119 }
120
121 void
122 Content::set_trim_start (Time t)
123 {
124         {
125                 boost::mutex::scoped_lock lm (_mutex);
126                 _trim_start = t;
127         }
128
129         signal_changed (ContentProperty::TRIM_START);
130 }
131
132 void
133 Content::set_trim_end (Time t)
134 {
135         {
136                 boost::mutex::scoped_lock lm (_mutex);
137                 _trim_end = t;
138         }
139
140         signal_changed (ContentProperty::TRIM_END);
141 }
142
143
144 shared_ptr<Content>
145 Content::clone () const
146 {
147         shared_ptr<const Film> film = _film.lock ();
148         if (!film) {
149                 return shared_ptr<Content> ();
150         }
151         
152         /* This is a bit naughty, but I can't think of a compelling reason not to do it ... */
153         xmlpp::Document doc;
154         xmlpp::Node* node = doc.create_root_node ("Content");
155         as_xml (node);
156         return content_factory (film, shared_ptr<cxml::Node> (new cxml::Node (node)));
157 }
158
159 string
160 Content::technical_summary () const
161 {
162         return String::compose ("%1 %2 %3", path(), digest(), position());
163 }
164
165 Time
166 Content::length_after_trim () const
167 {
168         return full_length() - trim_start() - trim_end();
169 }
170
171 /** @param t A time relative to the start of this content (not the position).
172  *  @return true if this time is trimmed by our trim settings.
173  */
174 bool
175 Content::trimmed (Time t) const
176 {
177         return (t < trim_start() || t > (full_length() - trim_end ()));
178 }
179
180 /** @return string which includes everything about how this content affects
181  *  its playlist.
182  */
183 string
184 Content::identifier () const
185 {
186         stringstream s;
187         
188         s << Content::digest()
189           << "_" << position()
190           << "_" << trim_start()
191           << "_" << trim_end();
192
193         return s.str ();
194 }
195
196 bool
197 Content::path_valid () const
198 {
199         return boost::filesystem::exists (_path);
200 }
201
202 void
203 Content::set_path (boost::filesystem::path path)
204 {
205         _path = path;
206         signal_changed (ContentProperty::PATH);
207 }
208
209