2 Copyright (C) 2014-2016 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 #include "dcp_content.h"
21 #include "video_content.h"
22 #include "dcp_examiner.h"
27 #include "compose.hpp"
28 #include "dcp_decoder.h"
30 #include <dcp/exceptions.h>
31 #include <dcp/reel_picture_asset.h>
33 #include <libxml++/libxml++.h>
34 #include <boost/foreach.hpp>
45 using boost::shared_ptr;
46 using boost::scoped_ptr;
47 using boost::optional;
49 int const DCPContentProperty::CAN_BE_PLAYED = 600;
50 int const DCPContentProperty::REFERENCE_VIDEO = 601;
51 int const DCPContentProperty::REFERENCE_AUDIO = 602;
52 int const DCPContentProperty::REFERENCE_SUBTITLE = 603;
54 DCPContent::DCPContent (shared_ptr<const Film> film, boost::filesystem::path p)
56 , SingleStreamAudioContent (film)
57 , SubtitleContent (film)
58 , video (new VideoContent (film))
59 , _has_subtitles (false)
62 , _reference_video (false)
63 , _reference_audio (false)
64 , _reference_subtitle (false)
67 set_default_colour_conversion ();
70 DCPContent::DCPContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version)
71 : Content (film, node)
72 , SingleStreamAudioContent (film, node, version)
73 , SubtitleContent (film, node, version)
74 , video (new VideoContent (film, node, version))
76 _name = node->string_child ("Name");
77 _has_subtitles = node->bool_child ("HasSubtitles");
78 _encrypted = node->bool_child ("Encrypted");
79 if (node->optional_node_child ("KDM")) {
80 _kdm = dcp::EncryptedKDM (node->string_child ("KDM"));
82 _kdm_valid = node->bool_child ("KDMValid");
83 _reference_video = node->optional_bool_child ("ReferenceVideo").get_value_or (false);
84 _reference_audio = node->optional_bool_child ("ReferenceAudio").get_value_or (false);
85 _reference_subtitle = node->optional_bool_child ("ReferenceSubtitle").get_value_or (false);
89 DCPContent::read_directory (boost::filesystem::path p)
91 for (boost::filesystem::directory_iterator i(p); i != boost::filesystem::directory_iterator(); ++i) {
92 if (boost::filesystem::is_regular_file (i->path ())) {
93 _paths.push_back (i->path ());
94 } else if (boost::filesystem::is_directory (i->path ())) {
95 read_directory (i->path ());
101 DCPContent::examine (shared_ptr<Job> job)
103 bool const could_be_played = can_be_played ();
105 job->set_progress_unknown ();
106 Content::examine (job);
108 shared_ptr<DCPExaminer> examiner (new DCPExaminer (shared_from_this ()));
109 take_from_video_examiner (examiner);
110 set_default_colour_conversion ();
111 take_from_audio_examiner (examiner);
114 boost::mutex::scoped_lock lm (_mutex);
115 _name = examiner->name ();
116 _has_subtitles = examiner->has_subtitles ();
117 _encrypted = examiner->encrypted ();
118 _kdm_valid = examiner->kdm_valid ();
121 if (could_be_played != can_be_played ()) {
122 signal_changed (DCPContentProperty::CAN_BE_PLAYED);
127 DCPContent::summary () const
129 boost::mutex::scoped_lock lm (_mutex);
130 return String::compose (_("%1 [DCP]"), _name);
134 DCPContent::technical_summary () const
136 return Content::technical_summary() + " - "
137 + video->technical_summary() + " - "
138 + AudioContent::technical_summary() + " - ";
142 DCPContent::as_xml (xmlpp::Node* node) const
144 node->add_child("Type")->add_child_text ("DCP");
146 Content::as_xml (node);
147 video->as_xml (node);
148 SingleStreamAudioContent::as_xml (node);
149 SubtitleContent::as_xml (node);
151 boost::mutex::scoped_lock lm (_mutex);
152 node->add_child("Name")->add_child_text (_name);
153 node->add_child("HasSubtitles")->add_child_text (_has_subtitles ? "1" : "0");
154 node->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
156 node->add_child("KDM")->add_child_text (_kdm->as_xml ());
158 node->add_child("KDMValid")->add_child_text (_kdm_valid ? "1" : "0");
159 node->add_child("ReferenceVideo")->add_child_text (_reference_video ? "1" : "0");
160 node->add_child("ReferenceAudio")->add_child_text (_reference_audio ? "1" : "0");
161 node->add_child("ReferenceSubtitle")->add_child_text (_reference_subtitle ? "1" : "0");
165 DCPContent::full_length () const
167 FrameRateChange const frc (video_frame_rate (), film()->video_frame_rate ());
168 return DCPTime::from_frames (llrint (video_length () * frc.factor ()), film()->video_frame_rate ());
172 DCPContent::identifier () const
175 s << Content::identifier() << "_" << video->identifier() << "_" << SubtitleContent::identifier () << " "
176 << (_reference_video ? "1" : "0")
177 << (_reference_subtitle ? "1" : "0");
182 DCPContent::add_kdm (dcp::EncryptedKDM k)
188 DCPContent::can_be_played () const
190 boost::mutex::scoped_lock lm (_mutex);
191 return !_encrypted || _kdm_valid;
194 boost::filesystem::path
195 DCPContent::directory () const
197 optional<size_t> smallest;
198 boost::filesystem::path dir;
199 for (size_t i = 0; i < number_of_paths(); ++i) {
200 boost::filesystem::path const p = path (i).parent_path ();
201 size_t const d = distance (p.begin(), p.end());
202 if (!smallest || d < smallest.get ()) {
211 DCPContent::add_properties (list<UserProperty>& p) const
213 SingleStreamAudioContent::add_properties (p);
217 DCPContent::set_default_colour_conversion ()
219 /* Default to no colour conversion for DCPs */
220 unset_colour_conversion ();
224 DCPContent::set_reference_video (bool r)
227 boost::mutex::scoped_lock lm (_mutex);
228 _reference_video = r;
231 signal_changed (DCPContentProperty::REFERENCE_VIDEO);
235 DCPContent::set_reference_audio (bool r)
238 boost::mutex::scoped_lock lm (_mutex);
239 _reference_audio = r;
242 signal_changed (DCPContentProperty::REFERENCE_AUDIO);
246 DCPContent::set_reference_subtitle (bool r)
249 boost::mutex::scoped_lock lm (_mutex);
250 _reference_subtitle = r;
253 signal_changed (DCPContentProperty::REFERENCE_SUBTITLE);
257 DCPContent::reels () const
259 list<DCPTimePeriod> p;
260 scoped_ptr<DCPDecoder> decoder;
262 decoder.reset (new DCPDecoder (shared_from_this(), false));
264 /* Could not load the DCP; guess reels */
265 list<DCPTimePeriod> p;
266 p.push_back (DCPTimePeriod (position(), end()));
270 DCPTime from = position ();
271 BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
272 DCPTime const to = from + DCPTime::from_frames (i->main_picture()->duration(), film()->video_frame_rate());
273 p.push_back (DCPTimePeriod (from, to));
281 DCPContent::reel_split_points () const
284 BOOST_FOREACH (DCPTimePeriod i, reels()) {
285 s.push_back (i.from);
292 DCPContent::can_reference (string overlapping, list<string>& why_not) const
294 list<DCPTimePeriod> const fr = film()->reels ();
295 /* fr must contain reels(). It can also contain other reels, but it must at
296 least contain reels().
298 BOOST_FOREACH (DCPTimePeriod i, reels()) {
299 if (find (fr.begin(), fr.end(), i) == fr.end ()) {
300 why_not.push_back (_("Reel lengths in the project differ from those in the DCP; set the reel mode to 'split by video content'."));
305 list<shared_ptr<T> > a = overlaps<T> (film()->content(), position(), end());
306 if (a.size() != 1 || a.front().get() != this) {
307 why_not.push_back (overlapping);
315 DCPContent::can_reference_video (list<string>& why_not) const
317 return can_reference<VideoContent> (_("There is other video content overlapping this DCP; remove it."), why_not);
321 DCPContent::can_reference_audio (list<string>& why_not) const
323 DCPDecoder decoder (shared_from_this(), false);
324 BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder.reels()) {
325 if (!i->main_sound()) {
326 why_not.push_back (_("The DCP does not have sound in all reels."));
331 return can_reference<AudioContent> (_("There is other audio content overlapping this DCP; remove it."), why_not);
335 DCPContent::can_reference_subtitle (list<string>& why_not) const
337 DCPDecoder decoder (shared_from_this(), false);
338 BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder.reels()) {
339 if (!i->main_subtitle()) {
340 why_not.push_back (_("The DCP does not have subtitles in all reels."));
345 return can_reference<SubtitleContent> (_("There is other subtitle content overlapping this DCP; remove it."), why_not);