2 Copyright (C) 2014-2020 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 "atmos_content.h"
22 #include "dcp_content.h"
23 #include "video_content.h"
24 #include "audio_content.h"
25 #include "dcp_examiner.h"
30 #include "compose.hpp"
31 #include "dcp_decoder.h"
33 #include "dcpomatic_log.h"
34 #include "text_content.h"
36 #include <dcp/raw_convert.h>
37 #include <dcp/exceptions.h>
38 #include <dcp/reel_picture_asset.h>
40 #include <libxml++/libxml++.h>
41 #include <boost/foreach.hpp>
54 using boost::shared_ptr;
55 using boost::scoped_ptr;
56 using boost::optional;
57 using boost::function;
58 using boost::dynamic_pointer_cast;
59 #if BOOST_VERSION >= 106100
60 using namespace boost::placeholders;
62 using dcp::raw_convert;
63 using namespace dcpomatic;
65 int const DCPContentProperty::NEEDS_ASSETS = 600;
66 int const DCPContentProperty::NEEDS_KDM = 601;
67 int const DCPContentProperty::REFERENCE_VIDEO = 602;
68 int const DCPContentProperty::REFERENCE_AUDIO = 603;
69 int const DCPContentProperty::REFERENCE_TEXT = 604;
70 int const DCPContentProperty::NAME = 605;
71 int const DCPContentProperty::TEXTS = 606;
72 int const DCPContentProperty::CPL = 607;
74 DCPContent::DCPContent (boost::filesystem::path p)
76 , _needs_assets (false)
78 , _reference_video (false)
79 , _reference_audio (false)
82 LOG_GENERAL ("Creating DCP content from %1", p.string());
85 set_default_colour_conversion ();
87 for (int i = 0; i < TEXT_COUNT; ++i) {
88 _reference_text[i] = false;
92 DCPContent::DCPContent (cxml::ConstNodePtr node, int version)
95 video = VideoContent::from_xml (this, node, version);
96 audio = AudioContent::from_xml (this, node, version);
97 text = TextContent::from_xml (this, node, version);
98 atmos = AtmosContent::from_xml (this, node);
100 for (int i = 0; i < TEXT_COUNT; ++i) {
101 _reference_text[i] = false;
104 if (video && audio) {
108 node->number_child<int> ("AudioFrameRate"),
109 /* AudioLength was not present in some old metadata versions */
110 node->optional_number_child<Frame>("AudioLength").get_value_or (
111 video->length() * node->number_child<int>("AudioFrameRate") / video_frame_rate().get()
113 AudioMapping (node->node_child ("AudioMapping"), version)
119 _name = node->string_child ("Name");
120 _encrypted = node->bool_child ("Encrypted");
121 _needs_assets = node->optional_bool_child("NeedsAssets").get_value_or (false);
122 if (node->optional_node_child ("KDM")) {
123 _kdm = dcp::EncryptedKDM (node->string_child ("KDM"));
125 _kdm_valid = node->bool_child ("KDMValid");
126 _reference_video = node->optional_bool_child ("ReferenceVideo").get_value_or (false);
127 _reference_audio = node->optional_bool_child ("ReferenceAudio").get_value_or (false);
129 _reference_text[TEXT_OPEN_SUBTITLE] = node->optional_bool_child("ReferenceOpenSubtitle").get_value_or(false);
130 _reference_text[TEXT_CLOSED_CAPTION] = node->optional_bool_child("ReferenceClosedCaption").get_value_or(false);
132 _reference_text[TEXT_OPEN_SUBTITLE] = node->optional_bool_child("ReferenceSubtitle").get_value_or(false);
133 _reference_text[TEXT_CLOSED_CAPTION] = false;
135 if (node->optional_string_child("Standard")) {
136 string const s = node->optional_string_child("Standard").get();
137 if (s == "Interop") {
138 _standard = dcp::INTEROP;
139 } else if (s == "SMPTE") {
140 _standard = dcp::SMPTE;
142 DCPOMATIC_ASSERT (false);
145 _three_d = node->optional_bool_child("ThreeD").get_value_or (false);
147 optional<string> ck = node->optional_string_child("ContentKind");
149 _content_kind = dcp::content_kind_from_string (*ck);
151 _cpl = node->optional_string_child("CPL");
152 BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("ReelLength")) {
153 _reel_lengths.push_back (raw_convert<int64_t> (i->content ()));
156 BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("Marker")) {
157 _markers[dcp::marker_from_string(i->string_attribute("type"))] = ContentTime(raw_convert<int64_t>(i->content()));
160 BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("Rating")) {
161 _ratings.push_back (dcp::Rating(i));
164 BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("ContentVersion")) {
165 _content_versions.push_back (i->content());
170 DCPContent::read_directory (boost::filesystem::path p)
172 using namespace boost::filesystem;
174 bool have_assetmap = false;
175 bool have_metadata = false;
177 for (directory_iterator i(p); i != directory_iterator(); ++i) {
178 if (i->path().filename() == "ASSETMAP" || i->path().filename() == "ASSETMAP.xml") {
179 have_assetmap = true;
180 } else if (i->path().filename() == "metadata.xml") {
181 have_metadata = true;
185 if (!have_assetmap) {
186 if (!have_metadata) {
187 throw DCPError ("No ASSETMAP or ASSETMAP.xml file found: is this a DCP?");
190 "This looks like a DCP-o-matic project folder, which cannot be added to a different project. "
191 "Choose the DCP directory inside the DCP-o-matic project folder if that's what you want to import."
196 read_sub_directory (p);
200 DCPContent::read_sub_directory (boost::filesystem::path p)
202 LOG_GENERAL ("DCPContent::read_sub_directory reads %1", p.string());
203 for (boost::filesystem::directory_iterator i(p); i != boost::filesystem::directory_iterator(); ++i) {
204 if (boost::filesystem::is_regular_file (i->path())) {
205 LOG_GENERAL ("Inside there's regular file %1", i->path().string());
206 add_path (i->path());
207 } else if (boost::filesystem::is_directory (i->path ())) {
208 LOG_GENERAL ("Inside there's directory %1", i->path().string());
209 read_sub_directory (i->path());
214 /** @param film Film, or 0 */
216 DCPContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
218 bool const needed_assets = needs_assets ();
219 bool const needed_kdm = needs_kdm ();
220 string const old_name = name ();
222 ChangeSignaller<Content> cc_texts (this, DCPContentProperty::TEXTS);
223 ChangeSignaller<Content> cc_assets (this, DCPContentProperty::NEEDS_ASSETS);
224 ChangeSignaller<Content> cc_kdm (this, DCPContentProperty::NEEDS_KDM);
225 ChangeSignaller<Content> cc_name (this, DCPContentProperty::NAME);
228 job->set_progress_unknown ();
230 Content::examine (film, job);
232 shared_ptr<DCPExaminer> examiner (new DCPExaminer(shared_from_this(), film ? film->tolerant() : true));
234 if (examiner->has_video()) {
236 boost::mutex::scoped_lock lm (_mutex);
237 video.reset (new VideoContent (this));
239 video->take_from_examiner (examiner);
240 set_default_colour_conversion ();
243 if (examiner->has_audio()) {
245 boost::mutex::scoped_lock lm (_mutex);
246 audio.reset (new AudioContent (this));
248 AudioStreamPtr as (new AudioStream (examiner->audio_frame_rate(), examiner->audio_length(), examiner->audio_channels()));
249 audio->set_stream (as);
250 AudioMapping m = as->mapping ();
251 m.make_default (film ? film->audio_processor() : 0);
255 if (examiner->has_atmos()) {
257 boost::mutex::scoped_lock lm (_mutex);
258 atmos.reset (new AtmosContent(this));
260 /* Setting length will cause calculations to be made based on edit rate, so that must
261 * be set up first otherwise hard-to-spot exceptions will be thrown.
263 atmos->set_edit_rate (examiner->atmos_edit_rate());
264 atmos->set_length (examiner->atmos_length());
267 list<shared_ptr<TextContent> > new_text;
268 for (int i = 0; i < TEXT_COUNT; ++i) {
269 for (int j = 0; j < examiner->text_count(static_cast<TextType>(i)); ++j) {
270 shared_ptr<TextContent> c(new TextContent(this, static_cast<TextType>(i), static_cast<TextType>(i)));
271 if (i == TEXT_CLOSED_CAPTION) {
272 c->set_dcp_track (examiner->dcp_text_track(j));
274 new_text.push_back (c);
279 boost::mutex::scoped_lock lm (_mutex);
281 _name = examiner->name ();
282 _encrypted = examiner->encrypted ();
283 _needs_assets = examiner->needs_assets ();
284 _kdm_valid = examiner->kdm_valid ();
285 _standard = examiner->standard ();
286 _three_d = examiner->three_d ();
287 _content_kind = examiner->content_kind ();
288 _cpl = examiner->cpl ();
289 _reel_lengths = examiner->reel_lengths ();
290 map<dcp::Marker, dcp::Time> markers = examiner->markers();
291 for (map<dcp::Marker, dcp::Time>::const_iterator i = markers.begin(); i != markers.end(); ++i) {
292 _markers[i->first] = ContentTime(i->second.as_editable_units(DCPTime::HZ));
294 _ratings = examiner->ratings ();
295 _content_versions = examiner->content_versions ();
298 if (needed_assets == needs_assets()) {
302 if (needed_kdm == needs_kdm()) {
306 if (old_name == name()) {
311 video->set_frame_type (_three_d ? VIDEO_FRAME_TYPE_3D : VIDEO_FRAME_TYPE_2D);
316 DCPContent::summary () const
318 boost::mutex::scoped_lock lm (_mutex);
319 return String::compose (_("%1 [DCP]"), _name);
323 DCPContent::technical_summary () const
325 string s = Content::technical_summary() + " - ";
327 s += video->technical_summary() + " - ";
330 s += audio->technical_summary() + " - ";
336 DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
338 node->add_child("Type")->add_child_text ("DCP");
340 Content::as_xml (node, with_paths);
343 video->as_xml (node);
347 audio->as_xml (node);
348 node->add_child("AudioFrameRate")->add_child_text (raw_convert<string> (audio->stream()->frame_rate()));
349 node->add_child("AudioLength")->add_child_text (raw_convert<string> (audio->stream()->length()));
350 audio->stream()->mapping().as_xml (node->add_child("AudioMapping"));
353 BOOST_FOREACH (shared_ptr<TextContent> i, text) {
358 atmos->as_xml (node);
361 boost::mutex::scoped_lock lm (_mutex);
362 node->add_child("Name")->add_child_text (_name);
363 node->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
364 node->add_child("NeedsAssets")->add_child_text (_needs_assets ? "1" : "0");
366 node->add_child("KDM")->add_child_text (_kdm->as_xml ());
368 node->add_child("KDMValid")->add_child_text (_kdm_valid ? "1" : "0");
369 node->add_child("ReferenceVideo")->add_child_text (_reference_video ? "1" : "0");
370 node->add_child("ReferenceAudio")->add_child_text (_reference_audio ? "1" : "0");
371 node->add_child("ReferenceOpenSubtitle")->add_child_text(_reference_text[TEXT_OPEN_SUBTITLE] ? "1" : "0");
372 node->add_child("ReferenceClosedCaption")->add_child_text(_reference_text[TEXT_CLOSED_CAPTION] ? "1" : "0");
374 switch (_standard.get ()) {
376 node->add_child("Standard")->add_child_text ("Interop");
379 node->add_child("Standard")->add_child_text ("SMPTE");
382 DCPOMATIC_ASSERT (false);
385 node->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
387 node->add_child("ContentKind")->add_child_text(dcp::content_kind_to_string(*_content_kind));
390 node->add_child("CPL")->add_child_text (_cpl.get ());
392 BOOST_FOREACH (int64_t i, _reel_lengths) {
393 node->add_child("ReelLength")->add_child_text (raw_convert<string> (i));
396 for (map<dcp::Marker, ContentTime>::const_iterator i = _markers.begin(); i != _markers.end(); ++i) {
397 xmlpp::Element* marker = node->add_child("Marker");
398 marker->set_attribute("type", dcp::marker_to_string(i->first));
399 marker->add_child_text(raw_convert<string>(i->second.get()));
402 BOOST_FOREACH (dcp::Rating i, _ratings) {
403 xmlpp::Element* rating = node->add_child("Rating");
407 BOOST_FOREACH (string i, _content_versions) {
408 node->add_child("ContentVersion")->add_child_text(i);
413 DCPContent::full_length (shared_ptr<const Film> film) const
418 FrameRateChange const frc (film, shared_from_this());
419 return DCPTime::from_frames (llrint(video->length() * frc.factor()), film->video_frame_rate());
423 DCPContent::approximate_length () const
428 return DCPTime::from_frames (video->length(), 24);
432 DCPContent::identifier () const
434 string s = Content::identifier() + "_";
437 s += video->identifier() + "_";
440 BOOST_FOREACH (shared_ptr<TextContent> i, text) {
441 s += i->identifier () + " ";
444 s += string (_reference_video ? "1" : "0");
445 for (int i = 0; i < TEXT_COUNT; ++i) {
446 s += string (_reference_text[i] ? "1" : "0");
452 DCPContent::add_kdm (dcp::EncryptedKDM k)
458 DCPContent::add_ov (boost::filesystem::path ov)
464 DCPContent::can_be_played () const
466 return !needs_kdm() && !needs_assets();
470 DCPContent::needs_kdm () const
472 boost::mutex::scoped_lock lm (_mutex);
473 return _encrypted && !_kdm_valid;
477 DCPContent::needs_assets () const
479 boost::mutex::scoped_lock lm (_mutex);
480 return _needs_assets;
483 vector<boost::filesystem::path>
484 DCPContent::directories () const
486 return dcp::DCP::directories_from_files (paths());
490 DCPContent::add_properties (shared_ptr<const Film> film, list<UserProperty>& p) const
492 Content::add_properties (film, p);
494 video->add_properties (p);
497 audio->add_properties (film, p);
502 DCPContent::set_default_colour_conversion ()
504 /* Default to no colour conversion for DCPs */
506 video->unset_colour_conversion ();
511 DCPContent::set_reference_video (bool r)
513 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_VIDEO);
516 boost::mutex::scoped_lock lm (_mutex);
517 _reference_video = r;
522 DCPContent::set_reference_audio (bool r)
524 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_AUDIO);
527 boost::mutex::scoped_lock lm (_mutex);
528 _reference_audio = r;
533 DCPContent::set_reference_text (TextType type, bool r)
535 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_TEXT);
538 boost::mutex::scoped_lock lm (_mutex);
539 _reference_text[type] = r;
544 DCPContent::reels (shared_ptr<const Film> film) const
546 list<int64_t> reel_lengths = _reel_lengths;
547 if (reel_lengths.empty ()) {
548 /* Old metadata with no reel lengths; get them here instead */
550 scoped_ptr<DCPExaminer> examiner (new DCPExaminer(shared_from_this(), film->tolerant()));
551 reel_lengths = examiner->reel_lengths ();
553 /* Could not examine the DCP; guess reels */
554 reel_lengths.push_back (length_after_trim(film).frames_round(film->video_frame_rate()));
558 list<DCPTimePeriod> p;
560 /* This content's frame rate must be the same as the output DCP rate, so we can
561 convert `directly' from ContentTime to DCPTime.
564 /* The starting point of this content on the timeline */
565 DCPTime pos = position() - DCPTime (trim_start().get());
567 BOOST_FOREACH (int64_t i, reel_lengths) {
568 /* This reel runs from `pos' to `to' */
569 DCPTime const to = pos + DCPTime::from_frames (i, film->video_frame_rate());
570 if (to > position()) {
571 p.push_back (DCPTimePeriod (max(position(), pos), min(end(film), to)));
572 if (to > end(film)) {
583 DCPContent::reel_split_points (shared_ptr<const Film> film) const
586 BOOST_FOREACH (DCPTimePeriod i, reels(film)) {
587 s.push_back (i.from);
593 DCPContent::can_reference (shared_ptr<const Film> film, function<bool (shared_ptr<const Content>)> part, string overlapping, string& why_not) const
595 /* We must be using the same standard as the film */
597 if (_standard.get() == dcp::INTEROP && !film->interop()) {
598 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
599 why_not = _("it is Interop and the film is set to SMPTE.");
601 } else if (_standard.get() == dcp::SMPTE && film->interop()) {
602 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
603 why_not = _("it is SMPTE and the film is set to Interop.");
608 /* And the same frame rate */
609 if (!video_frame_rate() || (lrint(video_frame_rate().get()) != film->video_frame_rate())) {
610 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
611 why_not = _("it has a different frame rate to the film.");
615 list<DCPTimePeriod> const fr = film->reels ();
617 list<DCPTimePeriod> reel_list;
619 reel_list = reels (film);
620 } catch (dcp::ReadError &) {
621 /* We couldn't read the DCP; it's probably missing */
623 } catch (dcp::KDMDecryptionError &) {
624 /* We have an incorrect KDM */
628 /* fr must contain reels(). It can also contain other reels, but it must at
629 least contain reels().
631 BOOST_FOREACH (DCPTimePeriod i, reel_list) {
632 if (find (fr.begin(), fr.end(), i) == fr.end ()) {
633 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
634 why_not = _("its reel lengths differ from those in the film; set the reel mode to 'split by video content'.");
639 ContentList a = overlaps (film, film->content(), part, position(), end(film));
640 if (a.size() != 1 || a.front().get() != this) {
641 why_not = overlapping;
649 bool check_video (shared_ptr<const Content> c)
651 return static_cast<bool>(c->video) && c->video->use();
655 DCPContent::can_reference_video (shared_ptr<const Film> film, string& why_not) const
658 why_not = _("There is no video in this DCP");
662 if (film->resolution() != resolution()) {
663 if (resolution() == RESOLUTION_4K) {
664 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
665 why_not = _("it is 4K and the film is 2K.");
667 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
668 why_not = _("it is 2K and the film is 4K.");
671 } else if (film->frame_size() != video->size()) {
672 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
673 why_not = _("its video frame size differs from the film's.");
677 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
678 return can_reference (film, bind (&check_video, _1), _("it overlaps other video content; remove the other content."), why_not);
682 bool check_audio (shared_ptr<const Content> c)
684 return static_cast<bool>(c->audio) && !c->audio->mapping().mapped_output_channels().empty();
688 DCPContent::can_reference_audio (shared_ptr<const Film> film, string& why_not) const
690 shared_ptr<DCPDecoder> decoder;
692 decoder.reset (new DCPDecoder (film, shared_from_this(), false, film->tolerant(), shared_ptr<DCPDecoder>()));
693 } catch (dcp::ReadError &) {
694 /* We couldn't read the DCP, so it's probably missing */
696 } catch (DCPError &) {
697 /* We couldn't read the DCP, so it's probably missing */
699 } catch (dcp::KDMDecryptionError &) {
700 /* We have an incorrect KDM */
704 BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
705 if (!i->main_sound()) {
706 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
707 why_not = _("it does not have sound in all its reels.");
712 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
713 return can_reference (film, bind (&check_audio, _1), _("it overlaps other audio content; remove the other content."), why_not);
717 bool check_text (shared_ptr<const Content> c)
719 return !c->text.empty();
723 DCPContent::can_reference_text (shared_ptr<const Film> film, TextType type, string& why_not) const
725 shared_ptr<DCPDecoder> decoder;
727 decoder.reset (new DCPDecoder (film, shared_from_this(), false, film->tolerant(), shared_ptr<DCPDecoder>()));
728 } catch (dcp::ReadError &) {
729 /* We couldn't read the DCP, so it's probably missing */
731 } catch (dcp::KDMDecryptionError &) {
732 /* We have an incorrect KDM */
736 BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
737 if (type == TEXT_OPEN_SUBTITLE && !i->main_subtitle()) {
738 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
739 why_not = _("it does not have open subtitles in all its reels.");
742 if (type == TEXT_CLOSED_CAPTION && i->closed_captions().empty()) {
743 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
744 why_not = _("it does not have closed captions in all its reels.");
749 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
750 return can_reference (film, bind (&check_text, _1), _("it overlaps other text content; remove the other content."), why_not);
754 DCPContent::take_settings_from (shared_ptr<const Content> c)
756 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (c);
761 _reference_video = dc->_reference_video;
762 _reference_audio = dc->_reference_audio;
763 for (int i = 0; i < TEXT_COUNT; ++i) {
764 _reference_text[i] = dc->_reference_text[i];
769 DCPContent::set_cpl (string id)
771 ChangeSignaller<Content> cc (this, DCPContentProperty::CPL);
774 boost::mutex::scoped_lock lm (_mutex);
780 DCPContent::kdm_timing_window_valid () const
787 return _kdm->not_valid_before() < now && now < _kdm->not_valid_after();
792 DCPContent::resolution () const
794 if (video->size().width > 2048 || video->size().height > 1080) {
795 return RESOLUTION_4K;
798 return RESOLUTION_2K;