2 Copyright (C) 2014-2022 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/>.
22 #include "atmos_content.h"
23 #include "audio_content.h"
24 #include "compose.hpp"
26 #include "dcp_content.h"
27 #include "dcp_decoder.h"
28 #include "dcp_examiner.h"
29 #include "dcpomatic_log.h"
34 #include "text_content.h"
35 #include "video_content.h"
37 #include <dcp/raw_convert.h>
38 #include <dcp/exceptions.h>
39 #include <dcp/reel_closed_caption_asset.h>
40 #include <dcp/reel_picture_asset.h>
41 #include <dcp/reel_subtitle_asset.h>
43 #include <libxml++/libxml++.h>
51 using std::dynamic_pointer_cast;
54 using std::make_shared;
55 using std::shared_ptr;
58 using boost::optional;
59 using boost::scoped_ptr;
60 #if BOOST_VERSION >= 106100
61 using namespace boost::placeholders;
63 using dcp::raw_convert;
64 using namespace dcpomatic;
67 int const DCPContentProperty::NEEDS_ASSETS = 600;
68 int const DCPContentProperty::NEEDS_KDM = 601;
69 int const DCPContentProperty::REFERENCE_VIDEO = 602;
70 int const DCPContentProperty::REFERENCE_AUDIO = 603;
71 int const DCPContentProperty::REFERENCE_TEXT = 604;
72 int const DCPContentProperty::NAME = 605;
73 int const DCPContentProperty::TEXTS = 606;
74 int const DCPContentProperty::CPL = 607;
77 DCPContent::DCPContent (boost::filesystem::path p)
79 , _needs_assets (false)
81 , _reference_video (false)
82 , _reference_audio (false)
85 LOG_GENERAL ("Creating DCP content from %1", p.string());
88 set_default_colour_conversion ();
90 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
91 _reference_text[i] = false;
95 DCPContent::DCPContent (cxml::ConstNodePtr node, int version)
98 video = VideoContent::from_xml (this, node, version, VideoRange::FULL);
99 audio = AudioContent::from_xml (this, node, version);
101 text = TextContent::from_xml (this, node, version, notes);
102 atmos = AtmosContent::from_xml (this, node);
104 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
105 _reference_text[i] = false;
108 if (video && audio) {
110 make_shared<AudioStream> (
111 node->number_child<int> ("AudioFrameRate"),
112 /* AudioLength was not present in some old metadata versions */
113 node->optional_number_child<Frame>("AudioLength").get_value_or (
114 video->length() * node->number_child<int>("AudioFrameRate") / video_frame_rate().get()
116 AudioMapping (node->node_child ("AudioMapping"), version)
121 _name = node->string_child ("Name");
122 _encrypted = node->bool_child ("Encrypted");
123 _needs_assets = node->optional_bool_child("NeedsAssets").get_value_or (false);
124 if (node->optional_node_child ("KDM")) {
125 _kdm = dcp::EncryptedKDM (node->string_child ("KDM"));
127 _kdm_valid = node->bool_child ("KDMValid");
128 _reference_video = node->optional_bool_child ("ReferenceVideo").get_value_or (false);
129 _reference_audio = node->optional_bool_child ("ReferenceAudio").get_value_or (false);
131 _reference_text[static_cast<int>(TextType::OPEN_SUBTITLE)] = node->optional_bool_child("ReferenceOpenSubtitle").get_value_or(false);
132 _reference_text[static_cast<int>(TextType::CLOSED_CAPTION)] = node->optional_bool_child("ReferenceClosedCaption").get_value_or(false);
134 _reference_text[static_cast<int>(TextType::OPEN_SUBTITLE)] = node->optional_bool_child("ReferenceSubtitle").get_value_or(false);
135 _reference_text[static_cast<int>(TextType::CLOSED_CAPTION)] = false;
137 if (node->optional_string_child("Standard")) {
138 auto const s = node->optional_string_child("Standard").get();
139 if (s == "Interop") {
140 _standard = dcp::Standard::INTEROP;
141 } else if (s == "SMPTE") {
142 _standard = dcp::Standard::SMPTE;
144 DCPOMATIC_ASSERT (false);
147 _three_d = node->optional_bool_child("ThreeD").get_value_or (false);
149 auto ck = node->optional_string_child("ContentKind");
151 _content_kind = dcp::content_kind_from_string (*ck);
153 _cpl = node->optional_string_child("CPL");
154 for (auto i: node->node_children("ReelLength")) {
155 _reel_lengths.push_back (raw_convert<int64_t> (i->content ()));
158 for (auto i: node->node_children("Marker")) {
159 _markers[dcp::marker_from_string(i->string_attribute("type"))] = ContentTime(raw_convert<int64_t>(i->content()));
162 for (auto i: node->node_children("Rating")) {
163 _ratings.push_back (dcp::Rating(i));
166 for (auto i: node->node_children("ContentVersion")) {
167 _content_versions.push_back (i->content());
172 DCPContent::read_directory (boost::filesystem::path p)
174 using namespace boost::filesystem;
176 bool have_assetmap = false;
177 bool have_metadata = false;
179 for (auto i: directory_iterator(p)) {
180 if (i.path().filename() == "ASSETMAP" || i.path().filename() == "ASSETMAP.xml") {
181 have_assetmap = true;
182 } else if (i.path().filename() == "metadata.xml") {
183 have_metadata = true;
187 if (!have_assetmap) {
188 if (!have_metadata) {
189 throw DCPError ("No ASSETMAP or ASSETMAP.xml file found: is this a DCP?");
191 throw ProjectFolderError ();
195 read_sub_directory (p);
199 DCPContent::read_sub_directory (boost::filesystem::path p)
201 LOG_GENERAL ("DCPContent::read_sub_directory reads %1", p.string());
202 for (auto i: boost::filesystem::directory_iterator(p)) {
203 if (boost::filesystem::is_regular_file(i.path())) {
204 LOG_GENERAL ("Inside there's regular file %1", i.path().string());
206 } else if (boost::filesystem::is_directory(i.path()) && i.path().filename() != ".AppleDouble") {
207 LOG_GENERAL ("Inside there's directory %1", i.path().string());
208 read_sub_directory (i.path());
213 /** @param film Film, or 0 */
215 DCPContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
217 bool const needed_assets = needs_assets ();
218 bool const needed_kdm = needs_kdm ();
219 string const old_name = name ();
221 ContentChangeSignaller cc_texts (this, DCPContentProperty::TEXTS);
222 ContentChangeSignaller cc_assets (this, DCPContentProperty::NEEDS_ASSETS);
223 ContentChangeSignaller cc_kdm (this, DCPContentProperty::NEEDS_KDM);
224 ContentChangeSignaller cc_name (this, DCPContentProperty::NAME);
227 job->set_progress_unknown ();
229 Content::examine (film, job);
231 auto examiner = make_shared<DCPExaminer>(shared_from_this(), film ? film->tolerant() : true);
233 if (examiner->has_video()) {
235 boost::mutex::scoped_lock lm (_mutex);
236 video = make_shared<VideoContent>(this);
238 video->take_from_examiner (examiner);
239 set_default_colour_conversion ();
242 if (examiner->has_audio()) {
244 boost::mutex::scoped_lock lm (_mutex);
245 audio = make_shared<AudioContent>(this);
247 auto as = make_shared<AudioStream>(examiner->audio_frame_rate(), examiner->audio_length(), examiner->audio_channels());
248 audio->set_stream (as);
249 auto m = as->mapping ();
250 m.make_default (film ? film->audio_processor() : 0);
254 if (examiner->has_atmos()) {
256 boost::mutex::scoped_lock lm (_mutex);
257 atmos = make_shared<AtmosContent>(this);
259 /* Setting length will cause calculations to be made based on edit rate, so that must
260 * be set up first otherwise hard-to-spot exceptions will be thrown.
262 atmos->set_edit_rate (examiner->atmos_edit_rate());
263 atmos->set_length (examiner->atmos_length());
266 list<shared_ptr<TextContent>> new_text;
268 for (int i = 0; i < examiner->text_count(TextType::OPEN_SUBTITLE); ++i) {
269 auto c = make_shared<TextContent>(this, TextType::OPEN_SUBTITLE, TextType::OPEN_SUBTITLE);
270 c->set_language (examiner->open_subtitle_language());
271 new_text.push_back (c);
274 for (int i = 0; i < examiner->text_count(TextType::CLOSED_CAPTION); ++i) {
275 auto c = make_shared<TextContent>(this, TextType::CLOSED_CAPTION, TextType::CLOSED_CAPTION);
276 c->set_dcp_track (examiner->dcp_text_track(i));
277 new_text.push_back (c);
281 boost::mutex::scoped_lock lm (_mutex);
283 _name = examiner->name ();
284 _encrypted = examiner->encrypted ();
285 _needs_assets = examiner->needs_assets ();
286 _kdm_valid = examiner->kdm_valid ();
287 _standard = examiner->standard ();
288 _three_d = examiner->three_d ();
289 _content_kind = examiner->content_kind ();
290 _cpl = examiner->cpl ();
291 _reel_lengths = examiner->reel_lengths ();
292 for (auto const& i: examiner->markers()) {
293 _markers[i.first] = ContentTime(i.second.as_editable_units_ceil(DCPTime::HZ));
295 _ratings = examiner->ratings ();
296 _content_versions = examiner->content_versions ();
299 if (needed_assets == needs_assets()) {
303 if (needed_kdm == needs_kdm()) {
307 if (old_name == name()) {
312 video->set_frame_type (_three_d ? VideoFrameType::THREE_D : VideoFrameType::TWO_D);
317 DCPContent::summary () const
319 boost::mutex::scoped_lock lm (_mutex);
320 return String::compose (_("%1 [DCP]"), _name);
324 DCPContent::technical_summary () const
326 string s = Content::technical_summary() + " - ";
328 s += video->technical_summary() + " - ";
331 s += audio->technical_summary() + " - ";
337 DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
339 node->add_child("Type")->add_child_text ("DCP");
341 Content::as_xml (node, with_paths);
344 video->as_xml (node);
348 audio->as_xml (node);
349 node->add_child("AudioFrameRate")->add_child_text (raw_convert<string> (audio->stream()->frame_rate()));
350 node->add_child("AudioLength")->add_child_text (raw_convert<string> (audio->stream()->length()));
351 audio->stream()->mapping().as_xml (node->add_child("AudioMapping"));
359 atmos->as_xml (node);
362 boost::mutex::scoped_lock lm (_mutex);
363 node->add_child("Name")->add_child_text (_name);
364 node->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
365 node->add_child("NeedsAssets")->add_child_text (_needs_assets ? "1" : "0");
367 node->add_child("KDM")->add_child_text (_kdm->as_xml ());
369 node->add_child("KDMValid")->add_child_text (_kdm_valid ? "1" : "0");
370 node->add_child("ReferenceVideo")->add_child_text (_reference_video ? "1" : "0");
371 node->add_child("ReferenceAudio")->add_child_text (_reference_audio ? "1" : "0");
372 node->add_child("ReferenceOpenSubtitle")->add_child_text(_reference_text[static_cast<int>(TextType::OPEN_SUBTITLE)] ? "1" : "0");
373 node->add_child("ReferenceClosedCaption")->add_child_text(_reference_text[static_cast<int>(TextType::CLOSED_CAPTION)] ? "1" : "0");
375 switch (_standard.get ()) {
376 case dcp::Standard::INTEROP:
377 node->add_child("Standard")->add_child_text ("Interop");
379 case dcp::Standard::SMPTE:
380 node->add_child("Standard")->add_child_text ("SMPTE");
383 DCPOMATIC_ASSERT (false);
386 node->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
388 node->add_child("ContentKind")->add_child_text(dcp::content_kind_to_string(*_content_kind));
391 node->add_child("CPL")->add_child_text (_cpl.get ());
393 for (auto i: _reel_lengths) {
394 node->add_child("ReelLength")->add_child_text (raw_convert<string> (i));
397 for (auto const& i: _markers) {
398 auto marker = node->add_child("Marker");
399 marker->set_attribute("type", dcp::marker_to_string(i.first));
400 marker->add_child_text(raw_convert<string>(i.second.get()));
403 for (auto i: _ratings) {
404 auto rating = node->add_child("Rating");
408 for (auto i: _content_versions) {
409 node->add_child("ContentVersion")->add_child_text(i);
414 DCPContent::full_length (shared_ptr<const Film> film) const
419 FrameRateChange const frc (film, shared_from_this());
420 return DCPTime::from_frames (llrint(video->length() * frc.factor()), film->video_frame_rate());
424 DCPContent::approximate_length () const
429 return DCPTime::from_frames (video->length(), 24);
433 DCPContent::identifier () const
435 string s = Content::identifier() + "_";
438 s += video->identifier() + "_";
442 s += i->identifier () + " ";
445 s += string (_reference_video ? "1" : "0");
446 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
447 s += string (_reference_text[i] ? "1" : "0");
453 DCPContent::add_kdm (dcp::EncryptedKDM k)
459 DCPContent::add_ov (boost::filesystem::path ov)
465 DCPContent::can_be_played () const
467 return !needs_kdm() && !needs_assets();
471 DCPContent::needs_kdm () const
473 boost::mutex::scoped_lock lm (_mutex);
474 return _encrypted && !_kdm_valid;
478 DCPContent::needs_assets () const
480 boost::mutex::scoped_lock lm (_mutex);
481 return _needs_assets;
484 vector<boost::filesystem::path>
485 DCPContent::directories () const
487 return dcp::DCP::directories_from_files (paths());
491 DCPContent::add_properties (shared_ptr<const Film> film, list<UserProperty>& p) const
493 Content::add_properties (film, p);
495 video->add_properties (p);
498 audio->add_properties (film, p);
503 DCPContent::set_default_colour_conversion ()
505 /* Default to no colour conversion for DCPs */
507 video->unset_colour_conversion ();
512 DCPContent::set_reference_video (bool r)
514 ContentChangeSignaller cc (this, DCPContentProperty::REFERENCE_VIDEO);
517 boost::mutex::scoped_lock lm (_mutex);
518 _reference_video = r;
523 DCPContent::set_reference_audio (bool r)
525 ContentChangeSignaller cc (this, DCPContentProperty::REFERENCE_AUDIO);
528 boost::mutex::scoped_lock lm (_mutex);
529 _reference_audio = r;
534 DCPContent::set_reference_text (TextType type, bool r)
536 ContentChangeSignaller cc (this, DCPContentProperty::REFERENCE_TEXT);
539 boost::mutex::scoped_lock lm (_mutex);
540 _reference_text[static_cast<int>(type)] = r;
545 DCPContent::reels (shared_ptr<const Film> film) const
547 auto reel_lengths = _reel_lengths;
548 if (reel_lengths.empty()) {
549 /* Old metadata with no reel lengths; get them here instead */
551 scoped_ptr<DCPExaminer> examiner (new DCPExaminer(shared_from_this(), film->tolerant()));
552 reel_lengths = examiner->reel_lengths ();
554 /* Could not examine the DCP; guess reels */
555 reel_lengths.push_back (length_after_trim(film).frames_round(film->video_frame_rate()));
559 list<DCPTimePeriod> p;
561 /* This content's frame rate must be the same as the output DCP rate, so we can
562 convert `directly' from ContentTime to DCPTime.
565 /* The starting point of this content on the timeline */
566 auto pos = position() - DCPTime (trim_start().get());
568 for (auto i: reel_lengths) {
569 /* This reel runs from `pos' to `to' */
570 DCPTime const to = pos + DCPTime::from_frames (i, film->video_frame_rate());
571 if (to > position()) {
572 p.push_back (DCPTimePeriod(max(position(), pos), min(end(film), to)));
573 if (to > end(film)) {
584 DCPContent::reel_split_points (shared_ptr<const Film> film) const
587 for (auto i: reels(film)) {
588 s.push_back (i.from);
594 DCPContent::can_reference (shared_ptr<const Film> film, function<bool (shared_ptr<const Content>)> part, string overlapping, string& why_not) const
596 /* We must be using the same standard as the film */
598 if (_standard.get() == dcp::Standard::INTEROP && !film->interop()) {
599 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
600 why_not = _("it is Interop and the film is set to SMPTE.");
602 } else if (_standard.get() == dcp::Standard::SMPTE && film->interop()) {
603 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
604 why_not = _("it is SMPTE and the film is set to Interop.");
609 /* And the same frame rate */
610 if (!video_frame_rate() || (lrint(video_frame_rate().get()) != film->video_frame_rate())) {
611 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
612 why_not = _("it has a different frame rate to the film.");
616 auto const fr = film->reels ();
618 list<DCPTimePeriod> reel_list;
620 reel_list = reels (film);
621 } catch (dcp::ReadError &) {
622 /* We couldn't read the DCP; it's probably missing */
624 } catch (dcp::KDMDecryptionError &) {
625 /* We have an incorrect KDM */
629 /* fr must contain reels(). It can also contain other reels, but it must at
630 least contain reels().
632 for (auto i: reel_list) {
633 if (find (fr.begin(), fr.end(), i) == fr.end ()) {
634 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
635 why_not = _("its reel lengths differ from those in the film; set the reel mode to 'split by video content'.");
640 auto a = overlaps (film, film->content(), part, position(), end(film));
641 if (a.size() != 1 || a.front().get() != this) {
642 why_not = overlapping;
650 bool check_video (shared_ptr<const Content> c)
652 return static_cast<bool>(c->video) && c->video->use();
656 DCPContent::can_reference_video (shared_ptr<const Film> film, string& why_not) const
659 why_not = _("There is no video in this DCP");
663 if (film->resolution() != resolution()) {
664 if (resolution() == Resolution::FOUR_K) {
665 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
666 why_not = _("it is 4K and the film is 2K.");
668 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
669 why_not = _("it is 2K and the film is 4K.");
672 } else if (film->frame_size() != video->size()) {
673 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
674 why_not = _("its video frame size differs from the film's.");
678 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
679 return can_reference (film, bind (&check_video, _1), _("it overlaps other video content; remove the other content."), why_not);
683 bool check_audio (shared_ptr<const Content> c)
685 return static_cast<bool>(c->audio) && !c->audio->mapping().mapped_output_channels().empty();
689 DCPContent::can_reference_audio (shared_ptr<const Film> film, string& why_not) const
691 shared_ptr<DCPDecoder> decoder;
693 decoder = make_shared<DCPDecoder>(film, shared_from_this(), false, film->tolerant(), shared_ptr<DCPDecoder>());
694 } catch (dcp::ReadError &) {
695 /* We couldn't read the DCP, so it's probably missing */
697 } catch (DCPError &) {
698 /* We couldn't read the DCP, so it's probably missing */
700 } catch (dcp::KDMDecryptionError &) {
701 /* We have an incorrect KDM */
705 for (auto i: decoder->reels()) {
706 if (!i->main_sound()) {
707 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
708 why_not = _("it does not have sound in all its reels.");
713 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
714 return can_reference (film, bind (&check_audio, _1), _("it overlaps other audio content; remove the other content."), why_not);
718 bool check_text (shared_ptr<const Content> c)
720 return !c->text.empty();
724 DCPContent::can_reference_text (shared_ptr<const Film> film, TextType type, string& why_not) const
726 shared_ptr<DCPDecoder> decoder;
728 decoder = make_shared<DCPDecoder>(film, shared_from_this(), false, film->tolerant(), shared_ptr<DCPDecoder>());
729 } catch (dcp::ReadError &) {
730 /* We couldn't read the DCP, so it's probably missing */
732 } catch (dcp::KDMDecryptionError &) {
733 /* We have an incorrect KDM */
737 for (auto i: decoder->reels()) {
738 if (type == TextType::OPEN_SUBTITLE) {
739 if (!i->main_subtitle()) {
740 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
741 why_not = _("it does not have open subtitles in all its reels.");
743 } else if (i->main_subtitle()->entry_point().get_value_or(0) != 0) {
744 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
745 why_not = _("one of its subtitle reels has a non-zero entry point so it must be re-written.");
749 if (type == TextType::CLOSED_CAPTION) {
750 if (i->closed_captions().empty()) {
751 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
752 why_not = _("it does not have closed captions in all its reels.");
755 for (auto j: i->closed_captions()) {
756 if (j->entry_point().get_value_or(0) != 0) {
757 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
758 why_not = _("one of its closed caption has a non-zero entry point so it must be re-written.");
765 if (trim_start() != dcpomatic::ContentTime()) {
766 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
767 why_not = _("it has a start trim so its subtitles or closed captions must be re-written.");
771 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
772 return can_reference (film, bind (&check_text, _1), _("it overlaps other text content; remove the other content."), why_not);
776 DCPContent::take_settings_from (shared_ptr<const Content> c)
778 auto dc = dynamic_pointer_cast<const DCPContent>(c);
783 _reference_video = dc->_reference_video;
784 _reference_audio = dc->_reference_audio;
785 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
786 _reference_text[i] = dc->_reference_text[i];
791 DCPContent::set_cpl (string id)
793 ContentChangeSignaller cc (this, DCPContentProperty::CPL);
796 boost::mutex::scoped_lock lm (_mutex);
802 DCPContent::kdm_timing_window_valid () const
809 return _kdm->not_valid_before() < now && now < _kdm->not_valid_after();
814 DCPContent::resolution () const
816 if (video->size().width > 2048 || video->size().height > 1080) {
817 return Resolution::FOUR_K;
820 return Resolution::TWO_K;