2 Copyright (C) 2014-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 #include "dcp_content.h"
22 #include "video_content.h"
23 #include "audio_content.h"
24 #include "dcp_examiner.h"
29 #include "compose.hpp"
30 #include "dcp_decoder.h"
32 #include "dcpomatic_log.h"
33 #include "text_content.h"
35 #include <dcp/raw_convert.h>
36 #include <dcp/exceptions.h>
37 #include <dcp/reel_picture_asset.h>
39 #include <libxml++/libxml++.h>
40 #include <boost/foreach.hpp>
52 using boost::shared_ptr;
53 using boost::scoped_ptr;
54 using boost::optional;
55 using boost::function;
56 using boost::dynamic_pointer_cast;
57 using dcp::raw_convert;
58 using namespace dcpomatic;
60 int const DCPContentProperty::NEEDS_ASSETS = 600;
61 int const DCPContentProperty::NEEDS_KDM = 601;
62 int const DCPContentProperty::REFERENCE_VIDEO = 602;
63 int const DCPContentProperty::REFERENCE_AUDIO = 603;
64 int const DCPContentProperty::REFERENCE_TEXT = 604;
65 int const DCPContentProperty::NAME = 605;
66 int const DCPContentProperty::TEXTS = 606;
67 int const DCPContentProperty::CPL = 607;
69 DCPContent::DCPContent (boost::filesystem::path p)
71 , _needs_assets (false)
73 , _reference_video (false)
74 , _reference_audio (false)
77 LOG_GENERAL ("Creating DCP content from %1", p.string());
80 set_default_colour_conversion ();
82 for (int i = 0; i < TEXT_COUNT; ++i) {
83 _reference_text[i] = false;
87 DCPContent::DCPContent (cxml::ConstNodePtr node, int version)
90 video = VideoContent::from_xml (this, node, version);
91 audio = AudioContent::from_xml (this, node, version);
92 text = TextContent::from_xml (this, node, version);
94 for (int i = 0; i < TEXT_COUNT; ++i) {
95 _reference_text[i] = false;
102 node->number_child<int> ("AudioFrameRate"),
103 /* AudioLength was not present in some old metadata versions */
104 node->optional_number_child<Frame>("AudioLength").get_value_or (
105 video->length() * node->number_child<int>("AudioFrameRate") / video_frame_rate().get()
107 AudioMapping (node->node_child ("AudioMapping"), version)
113 _name = node->string_child ("Name");
114 _encrypted = node->bool_child ("Encrypted");
115 _needs_assets = node->optional_bool_child("NeedsAssets").get_value_or (false);
116 if (node->optional_node_child ("KDM")) {
117 _kdm = dcp::EncryptedKDM (node->string_child ("KDM"));
119 _kdm_valid = node->bool_child ("KDMValid");
120 _reference_video = node->optional_bool_child ("ReferenceVideo").get_value_or (false);
121 _reference_audio = node->optional_bool_child ("ReferenceAudio").get_value_or (false);
123 _reference_text[TEXT_OPEN_SUBTITLE] = node->optional_bool_child("ReferenceOpenSubtitle").get_value_or(false);
124 _reference_text[TEXT_CLOSED_CAPTION] = node->optional_bool_child("ReferenceClosedCaption").get_value_or(false);
126 _reference_text[TEXT_OPEN_SUBTITLE] = node->optional_bool_child("ReferenceSubtitle").get_value_or(false);
127 _reference_text[TEXT_CLOSED_CAPTION] = false;
129 if (node->optional_string_child("Standard")) {
130 string const s = node->optional_string_child("Standard").get();
131 if (s == "Interop") {
132 _standard = dcp::INTEROP;
133 } else if (s == "SMPTE") {
134 _standard = dcp::SMPTE;
136 DCPOMATIC_ASSERT (false);
139 _three_d = node->optional_bool_child("ThreeD").get_value_or (false);
141 optional<string> ck = node->optional_string_child("ContentKind");
143 _content_kind = dcp::content_kind_from_string (*ck);
145 _cpl = node->optional_string_child("CPL");
146 BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("ReelLength")) {
147 _reel_lengths.push_back (raw_convert<int64_t> (i->content ()));
152 DCPContent::read_directory (boost::filesystem::path p)
154 read_sub_directory (p);
156 bool have_assetmap = false;
157 BOOST_FOREACH (boost::filesystem::path i, paths()) {
158 if (i.filename() == "ASSETMAP" || i.filename() == "ASSETMAP.xml") {
159 have_assetmap = true;
163 if (!have_assetmap) {
164 throw DCPError ("No ASSETMAP or ASSETMAP.xml file found: is this a DCP?");
169 DCPContent::read_sub_directory (boost::filesystem::path p)
171 LOG_GENERAL ("DCPContent::read_sub_directory reads %1", p.string());
172 for (boost::filesystem::directory_iterator i(p); i != boost::filesystem::directory_iterator(); ++i) {
173 if (boost::filesystem::is_regular_file (i->path())) {
174 LOG_GENERAL ("Inside there's regular file %1", i->path().string());
175 add_path (i->path());
176 } else if (boost::filesystem::is_directory (i->path ())) {
177 LOG_GENERAL ("Inside there's directory %1", i->path().string());
178 read_sub_directory (i->path());
184 DCPContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
186 bool const needed_assets = needs_assets ();
187 bool const needed_kdm = needs_kdm ();
188 string const old_name = name ();
189 int const old_texts = text.size ();
191 ChangeSignaller<Content> cc_texts (this, DCPContentProperty::TEXTS);
192 ChangeSignaller<Content> cc_assets (this, DCPContentProperty::NEEDS_ASSETS);
193 ChangeSignaller<Content> cc_kdm (this, DCPContentProperty::NEEDS_KDM);
194 ChangeSignaller<Content> cc_name (this, DCPContentProperty::NAME);
197 job->set_progress_unknown ();
199 Content::examine (film, job);
201 shared_ptr<DCPExaminer> examiner (new DCPExaminer(shared_from_this(), film->tolerant()));
203 if (examiner->has_video()) {
205 boost::mutex::scoped_lock lm (_mutex);
206 video.reset (new VideoContent (this));
208 video->take_from_examiner (examiner);
209 set_default_colour_conversion ();
212 if (examiner->has_audio()) {
214 boost::mutex::scoped_lock lm (_mutex);
215 audio.reset (new AudioContent (this));
217 AudioStreamPtr as (new AudioStream (examiner->audio_frame_rate(), examiner->audio_length(), examiner->audio_channels()));
218 audio->set_stream (as);
219 AudioMapping m = as->mapping ();
220 m.make_default (film ? film->audio_processor() : 0);
226 boost::mutex::scoped_lock lm (_mutex);
227 _name = examiner->name ();
228 for (int i = 0; i < TEXT_COUNT; ++i) {
229 for (int j = 0; j < examiner->text_count(static_cast<TextType>(i)); ++j) {
230 text.push_back (shared_ptr<TextContent>(new TextContent(this, static_cast<TextType>(i), static_cast<TextType>(i))));
233 texts = text.size ();
234 _encrypted = examiner->encrypted ();
235 _needs_assets = examiner->needs_assets ();
236 _kdm_valid = examiner->kdm_valid ();
237 _standard = examiner->standard ();
238 _three_d = examiner->three_d ();
239 _content_kind = examiner->content_kind ();
240 _cpl = examiner->cpl ();
241 _reel_lengths = examiner->reel_lengths ();
244 if (old_texts == texts) {
248 if (needed_assets == needs_assets()) {
252 if (needed_kdm == needs_kdm()) {
256 if (old_name == name()) {
261 video->set_frame_type (_three_d ? VIDEO_FRAME_TYPE_3D : VIDEO_FRAME_TYPE_2D);
266 DCPContent::summary () const
268 boost::mutex::scoped_lock lm (_mutex);
269 return String::compose (_("%1 [DCP]"), _name);
273 DCPContent::technical_summary () const
275 string s = Content::technical_summary() + " - ";
277 s += video->technical_summary() + " - ";
280 s += audio->technical_summary() + " - ";
286 DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
288 node->add_child("Type")->add_child_text ("DCP");
290 Content::as_xml (node, with_paths);
293 video->as_xml (node);
297 audio->as_xml (node);
298 node->add_child("AudioFrameRate")->add_child_text (raw_convert<string> (audio->stream()->frame_rate()));
299 node->add_child("AudioLength")->add_child_text (raw_convert<string> (audio->stream()->length()));
300 audio->stream()->mapping().as_xml (node->add_child("AudioMapping"));
303 BOOST_FOREACH (shared_ptr<TextContent> i, text) {
307 boost::mutex::scoped_lock lm (_mutex);
308 node->add_child("Name")->add_child_text (_name);
309 node->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
310 node->add_child("NeedsAssets")->add_child_text (_needs_assets ? "1" : "0");
312 node->add_child("KDM")->add_child_text (_kdm->as_xml ());
314 node->add_child("KDMValid")->add_child_text (_kdm_valid ? "1" : "0");
315 node->add_child("ReferenceVideo")->add_child_text (_reference_video ? "1" : "0");
316 node->add_child("ReferenceAudio")->add_child_text (_reference_audio ? "1" : "0");
317 node->add_child("ReferenceOpenSubtitle")->add_child_text(_reference_text[TEXT_OPEN_SUBTITLE] ? "1" : "0");
318 node->add_child("ReferenceClosedCaption")->add_child_text(_reference_text[TEXT_CLOSED_CAPTION] ? "1" : "0");
320 switch (_standard.get ()) {
322 node->add_child("Standard")->add_child_text ("Interop");
325 node->add_child("Standard")->add_child_text ("SMPTE");
328 DCPOMATIC_ASSERT (false);
331 node->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
333 node->add_child("ContentKind")->add_child_text(dcp::content_kind_to_string(*_content_kind));
336 node->add_child("CPL")->add_child_text (_cpl.get ());
338 BOOST_FOREACH (int64_t i, _reel_lengths) {
339 node->add_child("ReelLength")->add_child_text (raw_convert<string> (i));
344 DCPContent::full_length (shared_ptr<const Film> film) const
349 FrameRateChange const frc (film, shared_from_this());
350 return DCPTime::from_frames (llrint(video->length() * frc.factor()), film->video_frame_rate());
354 DCPContent::approximate_length () const
359 return DCPTime::from_frames (video->length(), 24);
363 DCPContent::identifier () const
365 string s = Content::identifier() + "_";
368 s += video->identifier() + "_";
371 BOOST_FOREACH (shared_ptr<TextContent> i, text) {
372 s += i->identifier () + " ";
375 s += string (_reference_video ? "1" : "0");
376 for (int i = 0; i < TEXT_COUNT; ++i) {
377 s += string (_reference_text[i] ? "1" : "0");
383 DCPContent::add_kdm (dcp::EncryptedKDM k)
389 DCPContent::add_ov (boost::filesystem::path ov)
395 DCPContent::can_be_played () const
397 return !needs_kdm() && !needs_assets();
401 DCPContent::needs_kdm () const
403 boost::mutex::scoped_lock lm (_mutex);
404 return _encrypted && !_kdm_valid;
408 DCPContent::needs_assets () const
410 boost::mutex::scoped_lock lm (_mutex);
411 return _needs_assets;
414 vector<boost::filesystem::path>
415 DCPContent::directories () const
417 return dcp::DCP::directories_from_files (paths());
421 DCPContent::add_properties (shared_ptr<const Film> film, list<UserProperty>& p) const
423 Content::add_properties (film, p);
425 video->add_properties (p);
428 audio->add_properties (film, p);
433 DCPContent::set_default_colour_conversion ()
435 /* Default to no colour conversion for DCPs */
437 video->unset_colour_conversion ();
442 DCPContent::set_reference_video (bool r)
444 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_VIDEO);
447 boost::mutex::scoped_lock lm (_mutex);
448 _reference_video = r;
453 DCPContent::set_reference_audio (bool r)
455 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_AUDIO);
458 boost::mutex::scoped_lock lm (_mutex);
459 _reference_audio = r;
464 DCPContent::set_reference_text (TextType type, bool r)
466 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_TEXT);
469 boost::mutex::scoped_lock lm (_mutex);
470 _reference_text[type] = r;
475 DCPContent::reels (shared_ptr<const Film> film) const
477 list<int64_t> reel_lengths = _reel_lengths;
478 if (reel_lengths.empty ()) {
479 /* Old metadata with no reel lengths; get them here instead */
481 scoped_ptr<DCPExaminer> examiner (new DCPExaminer(shared_from_this(), film->tolerant()));
482 reel_lengths = examiner->reel_lengths ();
484 /* Could not examine the DCP; guess reels */
485 reel_lengths.push_back (length_after_trim(film).frames_round(film->video_frame_rate()));
489 list<DCPTimePeriod> p;
491 /* This content's frame rate must be the same as the output DCP rate, so we can
492 convert `directly' from ContentTime to DCPTime.
495 /* The starting point of this content on the timeline */
496 DCPTime pos = position() - DCPTime (trim_start().get());
498 BOOST_FOREACH (int64_t i, reel_lengths) {
499 /* This reel runs from `pos' to `to' */
500 DCPTime const to = pos + DCPTime::from_frames (i, film->video_frame_rate());
501 if (to > position()) {
502 p.push_back (DCPTimePeriod (max(position(), pos), min(end(film), to)));
503 if (to > end(film)) {
514 DCPContent::reel_split_points (shared_ptr<const Film> film) const
517 BOOST_FOREACH (DCPTimePeriod i, reels(film)) {
518 s.push_back (i.from);
524 DCPContent::can_reference (shared_ptr<const Film> film, function<bool (shared_ptr<const Content>)> part, string overlapping, string& why_not) const
526 /* We must be using the same standard as the film */
528 if (_standard.get() == dcp::INTEROP && !film->interop()) {
529 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
530 why_not = _("it is Interop and the film is set to SMPTE.");
532 } else if (_standard.get() == dcp::SMPTE && film->interop()) {
533 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
534 why_not = _("it is SMPTE and the film is set to Interop.");
539 /* And the same frame rate */
540 if (!video_frame_rate() || (lrint(video_frame_rate().get()) != film->video_frame_rate())) {
541 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
542 why_not = _("it has a different frame rate to the film.");
546 list<DCPTimePeriod> const fr = film->reels ();
548 list<DCPTimePeriod> reel_list;
550 reel_list = reels (film);
551 } catch (dcp::DCPReadError &) {
552 /* We couldn't read the DCP; it's probably missing */
554 } catch (dcp::KDMDecryptionError &) {
555 /* We have an incorrect KDM */
559 /* fr must contain reels(). It can also contain other reels, but it must at
560 least contain reels().
562 BOOST_FOREACH (DCPTimePeriod i, reel_list) {
563 if (find (fr.begin(), fr.end(), i) == fr.end ()) {
564 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
565 why_not = _("its reel lengths differ from those in the film; set the reel mode to 'split by video content'.");
570 ContentList a = overlaps (film, film->content(), part, position(), end(film));
571 if (a.size() != 1 || a.front().get() != this) {
572 why_not = overlapping;
580 bool check_video (shared_ptr<const Content> c)
582 return static_cast<bool>(c->video);
586 DCPContent::can_reference_video (shared_ptr<const Film> film, string& why_not) const
589 why_not = _("There is no video in this DCP");
593 Resolution video_res = RESOLUTION_2K;
594 if (video->size().width > 2048 || video->size().height > 1080) {
595 video_res = RESOLUTION_4K;
598 if (film->resolution() != video_res) {
599 if (video_res == RESOLUTION_4K) {
600 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
601 why_not = _("it is 4K and the film is 2K.");
603 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
604 why_not = _("it is 2K and the film is 4K.");
607 } else if (film->frame_size() != video->size()) {
608 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
609 why_not = _("its video frame size differs from the film's.");
613 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
614 return can_reference (film, bind (&check_video, _1), _("it overlaps other video content; remove the other content."), why_not);
618 bool check_audio (shared_ptr<const Content> c)
620 return static_cast<bool>(c->audio);
624 DCPContent::can_reference_audio (shared_ptr<const Film> film, string& why_not) const
626 shared_ptr<DCPDecoder> decoder;
628 decoder.reset (new DCPDecoder (film, shared_from_this(), false, film->tolerant(), shared_ptr<DCPDecoder>()));
629 } catch (dcp::DCPReadError &) {
630 /* We couldn't read the DCP, so it's probably missing */
632 } catch (DCPError &) {
633 /* We couldn't read the DCP, so it's probably missing */
635 } catch (dcp::KDMDecryptionError &) {
636 /* We have an incorrect KDM */
640 BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
641 if (!i->main_sound()) {
642 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
643 why_not = _("it does not have sound in all its reels.");
648 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
649 return can_reference (film, bind (&check_audio, _1), _("it overlaps other audio content; remove the other content."), why_not);
653 bool check_text (shared_ptr<const Content> c)
655 return !c->text.empty();
659 DCPContent::can_reference_text (shared_ptr<const Film> film, TextType type, string& why_not) const
661 shared_ptr<DCPDecoder> decoder;
663 decoder.reset (new DCPDecoder (film, shared_from_this(), false, film->tolerant(), shared_ptr<DCPDecoder>()));
664 } catch (dcp::DCPReadError &) {
665 /* We couldn't read the DCP, so it's probably missing */
667 } catch (dcp::KDMDecryptionError &) {
668 /* We have an incorrect KDM */
672 BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
673 if (type == TEXT_OPEN_SUBTITLE && !i->main_subtitle()) {
674 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
675 why_not = _("it does not have open subtitles in all its reels.");
678 if (type == TEXT_CLOSED_CAPTION && i->closed_captions().empty()) {
679 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
680 why_not = _("it does not have closed captions in all its reels.");
685 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
686 return can_reference (film, bind (&check_text, _1), _("it overlaps other text content; remove the other content."), why_not);
690 DCPContent::take_settings_from (shared_ptr<const Content> c)
692 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (c);
697 _reference_video = dc->_reference_video;
698 _reference_audio = dc->_reference_audio;
699 for (int i = 0; i < TEXT_COUNT; ++i) {
700 _reference_text[i] = dc->_reference_text[i];
705 DCPContent::set_cpl (string id)
707 ChangeSignaller<Content> cc (this, DCPContentProperty::CPL);
710 boost::mutex::scoped_lock lm (_mutex);
716 DCPContent::kdm_timing_window_valid () const
723 return _kdm->not_valid_before() < now && now < _kdm->not_valid_after();