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 ();
91 DCPContent::DCPContent (cxml::ConstNodePtr node, int version)
94 video = VideoContent::from_xml (this, node, version, VideoRange::FULL);
95 audio = AudioContent::from_xml (this, node, version);
97 text = TextContent::from_xml (this, node, version, notes);
98 atmos = AtmosContent::from_xml (this, node);
100 if (video && audio) {
102 make_shared<AudioStream> (
103 node->number_child<int> ("AudioFrameRate"),
104 /* AudioLength was not present in some old metadata versions */
105 node->optional_number_child<Frame>("AudioLength").get_value_or (
106 video->length() * node->number_child<int>("AudioFrameRate") / video_frame_rate().get()
108 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[TextType::OPEN_SUBTITLE] = node->optional_bool_child("ReferenceOpenSubtitle").get_value_or(false);
124 _reference_text[TextType::CLOSED_CAPTION] = node->optional_bool_child("ReferenceClosedCaption").get_value_or(false);
126 _reference_text[TextType::OPEN_SUBTITLE] = node->optional_bool_child("ReferenceSubtitle").get_value_or(false);
127 _reference_text[TextType::CLOSED_CAPTION] = false;
129 if (node->optional_string_child("Standard")) {
130 auto const s = node->optional_string_child("Standard").get();
131 if (s == "Interop") {
132 _standard = dcp::Standard::INTEROP;
133 } else if (s == "SMPTE") {
134 _standard = dcp::Standard::SMPTE;
136 DCPOMATIC_ASSERT (false);
139 _three_d = node->optional_bool_child("ThreeD").get_value_or (false);
141 auto ck = node->optional_string_child("ContentKind");
143 _content_kind = dcp::ContentKind::from_name(*ck);
145 _cpl = node->optional_string_child("CPL");
146 for (auto i: node->node_children("ReelLength")) {
147 _reel_lengths.push_back (raw_convert<int64_t> (i->content ()));
150 for (auto i: node->node_children("Marker")) {
151 _markers[dcp::marker_from_string(i->string_attribute("type"))] = ContentTime(raw_convert<int64_t>(i->content()));
154 for (auto i: node->node_children("Rating")) {
155 _ratings.push_back (dcp::Rating(i));
158 for (auto i: node->node_children("ContentVersion")) {
159 _content_versions.push_back (i->content());
164 DCPContent::read_directory (boost::filesystem::path p)
166 using namespace boost::filesystem;
168 bool have_assetmap = false;
169 bool have_metadata = false;
171 for (auto i: directory_iterator(p)) {
172 if (i.path().filename() == "ASSETMAP" || i.path().filename() == "ASSETMAP.xml") {
173 have_assetmap = true;
174 } else if (i.path().filename() == "metadata.xml") {
175 have_metadata = true;
179 if (!have_assetmap) {
180 if (!have_metadata) {
181 throw DCPError ("No ASSETMAP or ASSETMAP.xml file found: is this a DCP?");
183 throw ProjectFolderError ();
187 read_sub_directory (p);
191 DCPContent::read_sub_directory (boost::filesystem::path p)
193 LOG_GENERAL ("DCPContent::read_sub_directory reads %1", p.string());
194 for (auto i: boost::filesystem::directory_iterator(p)) {
195 if (boost::filesystem::is_regular_file(i.path())) {
196 LOG_GENERAL ("Inside there's regular file %1", i.path().string());
198 } else if (boost::filesystem::is_directory(i.path()) && i.path().filename() != ".AppleDouble") {
199 LOG_GENERAL ("Inside there's directory %1", i.path().string());
200 read_sub_directory (i.path());
202 LOG_GENERAL("Ignoring %1 from inside: status is %2", i.path().string(), static_cast<int>(boost::filesystem::status(i.path()).type()));
207 /** @param film Film, or 0 */
209 DCPContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
211 bool const needed_assets = needs_assets ();
212 bool const needed_kdm = needs_kdm ();
213 string const old_name = name ();
215 ContentChangeSignaller cc_texts (this, DCPContentProperty::TEXTS);
216 ContentChangeSignaller cc_assets (this, DCPContentProperty::NEEDS_ASSETS);
217 ContentChangeSignaller cc_kdm (this, DCPContentProperty::NEEDS_KDM);
218 ContentChangeSignaller cc_name (this, DCPContentProperty::NAME);
221 job->set_progress_unknown ();
223 Content::examine (film, job);
225 auto examiner = make_shared<DCPExaminer>(shared_from_this(), film ? film->tolerant() : true);
227 if (examiner->has_video()) {
229 boost::mutex::scoped_lock lm (_mutex);
230 video = make_shared<VideoContent>(this);
232 video->take_from_examiner(film, examiner);
233 set_default_colour_conversion ();
236 if (examiner->has_audio()) {
238 boost::mutex::scoped_lock lm (_mutex);
239 audio = make_shared<AudioContent>(this);
241 auto as = make_shared<AudioStream>(examiner->audio_frame_rate(), examiner->audio_length(), examiner->audio_channels());
242 audio->set_stream (as);
243 auto m = as->mapping ();
244 m.make_default (film ? film->audio_processor() : 0);
248 if (examiner->has_atmos()) {
250 boost::mutex::scoped_lock lm (_mutex);
251 atmos = make_shared<AtmosContent>(this);
253 /* Setting length will cause calculations to be made based on edit rate, so that must
254 * be set up first otherwise hard-to-spot exceptions will be thrown.
256 atmos->set_edit_rate (examiner->atmos_edit_rate());
257 atmos->set_length (examiner->atmos_length());
260 list<shared_ptr<TextContent>> new_text;
262 for (int i = 0; i < examiner->text_count(TextType::OPEN_SUBTITLE); ++i) {
263 auto c = make_shared<TextContent>(this, TextType::OPEN_SUBTITLE, TextType::OPEN_SUBTITLE);
264 c->set_language (examiner->open_subtitle_language());
265 add_fonts_from_examiner(c, examiner->fonts());
266 new_text.push_back (c);
269 for (int i = 0; i < examiner->text_count(TextType::CLOSED_CAPTION); ++i) {
270 auto c = make_shared<TextContent>(this, TextType::CLOSED_CAPTION, TextType::CLOSED_CAPTION);
271 c->set_dcp_track (examiner->dcp_text_track(i));
272 new_text.push_back (c);
276 boost::mutex::scoped_lock lm (_mutex);
278 _name = examiner->name ();
279 _encrypted = examiner->encrypted ();
280 _needs_assets = examiner->needs_assets ();
281 _kdm_valid = examiner->kdm_valid ();
282 _standard = examiner->standard ();
283 _three_d = examiner->three_d ();
284 _content_kind = examiner->content_kind ();
285 _cpl = examiner->cpl ();
286 _reel_lengths = examiner->reel_lengths ();
287 for (auto const& i: examiner->markers()) {
288 _markers[i.first] = ContentTime(i.second.as_editable_units_ceil(DCPTime::HZ));
290 _ratings = examiner->ratings ();
291 _content_versions = examiner->content_versions ();
294 if (needed_assets == needs_assets()) {
298 if (needed_kdm == needs_kdm()) {
302 if (old_name == name()) {
307 video->set_frame_type (_three_d ? VideoFrameType::THREE_D : VideoFrameType::TWO_D);
312 DCPContent::summary () const
314 boost::mutex::scoped_lock lm (_mutex);
315 return String::compose (_("%1 [DCP]"), _name);
319 DCPContent::technical_summary () const
321 string s = Content::technical_summary() + " - ";
323 s += video->technical_summary() + " - ";
326 s += audio->technical_summary() + " - ";
332 DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
334 node->add_child("Type")->add_child_text ("DCP");
336 Content::as_xml (node, with_paths);
339 video->as_xml (node);
343 audio->as_xml (node);
344 node->add_child("AudioFrameRate")->add_child_text (raw_convert<string> (audio->stream()->frame_rate()));
345 node->add_child("AudioLength")->add_child_text (raw_convert<string> (audio->stream()->length()));
346 audio->stream()->mapping().as_xml (node->add_child("AudioMapping"));
354 atmos->as_xml (node);
357 boost::mutex::scoped_lock lm (_mutex);
358 node->add_child("Name")->add_child_text (_name);
359 node->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
360 node->add_child("NeedsAssets")->add_child_text (_needs_assets ? "1" : "0");
362 node->add_child("KDM")->add_child_text (_kdm->as_xml ());
364 node->add_child("KDMValid")->add_child_text (_kdm_valid ? "1" : "0");
365 node->add_child("ReferenceVideo")->add_child_text (_reference_video ? "1" : "0");
366 node->add_child("ReferenceAudio")->add_child_text (_reference_audio ? "1" : "0");
367 node->add_child("ReferenceOpenSubtitle")->add_child_text(_reference_text[TextType::OPEN_SUBTITLE] ? "1" : "0");
368 node->add_child("ReferenceClosedCaption")->add_child_text(_reference_text[TextType::CLOSED_CAPTION] ? "1" : "0");
370 switch (_standard.get ()) {
371 case dcp::Standard::INTEROP:
372 node->add_child("Standard")->add_child_text ("Interop");
374 case dcp::Standard::SMPTE:
375 node->add_child("Standard")->add_child_text ("SMPTE");
378 DCPOMATIC_ASSERT (false);
381 node->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
383 node->add_child("ContentKind")->add_child_text(_content_kind->name());
386 node->add_child("CPL")->add_child_text (_cpl.get ());
388 for (auto i: _reel_lengths) {
389 node->add_child("ReelLength")->add_child_text (raw_convert<string> (i));
392 for (auto const& i: _markers) {
393 auto marker = node->add_child("Marker");
394 marker->set_attribute("type", dcp::marker_to_string(i.first));
395 marker->add_child_text(raw_convert<string>(i.second.get()));
398 for (auto i: _ratings) {
399 auto rating = node->add_child("Rating");
403 for (auto i: _content_versions) {
404 node->add_child("ContentVersion")->add_child_text(i);
409 DCPContent::full_length (shared_ptr<const Film> film) const
414 FrameRateChange const frc (film, shared_from_this());
415 return DCPTime::from_frames (llrint(video->length() * frc.factor()), film->video_frame_rate());
419 DCPContent::approximate_length () const
424 return DCPTime::from_frames (video->length(), 24);
428 DCPContent::identifier () const
430 string s = Content::identifier() + "_";
433 s += video->identifier() + "_";
437 s += i->identifier () + " ";
440 s += string (_reference_video ? "1" : "0");
441 for (auto text: _reference_text) {
442 s += string(text ? "1" : "0");
448 DCPContent::add_kdm (dcp::EncryptedKDM k)
454 DCPContent::add_ov (boost::filesystem::path ov)
460 DCPContent::can_be_played () const
462 return !needs_kdm() && !needs_assets();
466 DCPContent::needs_kdm () const
468 boost::mutex::scoped_lock lm (_mutex);
469 return _encrypted && !_kdm_valid;
473 DCPContent::needs_assets () const
475 boost::mutex::scoped_lock lm (_mutex);
476 return _needs_assets;
479 vector<boost::filesystem::path>
480 DCPContent::directories () const
482 return dcp::DCP::directories_from_files (paths());
486 DCPContent::add_properties (shared_ptr<const Film> film, list<UserProperty>& p) const
488 Content::add_properties (film, p);
490 video->add_properties (p);
493 audio->add_properties (film, p);
498 DCPContent::set_default_colour_conversion ()
500 /* Default to no colour conversion for DCPs */
502 video->unset_colour_conversion ();
507 DCPContent::set_reference_video (bool r)
509 ContentChangeSignaller cc (this, DCPContentProperty::REFERENCE_VIDEO);
512 boost::mutex::scoped_lock lm (_mutex);
513 _reference_video = r;
518 DCPContent::set_reference_audio (bool r)
520 ContentChangeSignaller cc (this, DCPContentProperty::REFERENCE_AUDIO);
523 boost::mutex::scoped_lock lm (_mutex);
524 _reference_audio = r;
529 DCPContent::set_reference_text (TextType type, bool r)
531 ContentChangeSignaller cc (this, DCPContentProperty::REFERENCE_TEXT);
534 boost::mutex::scoped_lock lm (_mutex);
535 _reference_text[type] = r;
540 DCPContent::reels (shared_ptr<const Film> film) const
542 auto reel_lengths = _reel_lengths;
543 if (reel_lengths.empty()) {
544 /* Old metadata with no reel lengths; get them here instead */
546 scoped_ptr<DCPExaminer> examiner (new DCPExaminer(shared_from_this(), film->tolerant()));
547 reel_lengths = examiner->reel_lengths ();
549 /* Could not examine the DCP; guess reels */
550 reel_lengths.push_back (length_after_trim(film).frames_round(film->video_frame_rate()));
554 list<DCPTimePeriod> p;
556 /* This content's frame rate must be the same as the output DCP rate, so we can
557 convert `directly' from ContentTime to DCPTime.
560 /* The starting point of this content on the timeline */
561 auto pos = position() - DCPTime (trim_start().get());
563 for (auto i: reel_lengths) {
564 /* This reel runs from `pos' to `to' */
565 DCPTime const to = pos + DCPTime::from_frames (i, film->video_frame_rate());
566 if (to > position()) {
567 p.push_back (DCPTimePeriod(max(position(), pos), min(end(film), to)));
568 if (to > end(film)) {
579 DCPContent::reel_split_points (shared_ptr<const Film> film) const
582 for (auto i: reels(film)) {
583 s.push_back (i.from);
589 DCPContent::can_reference (shared_ptr<const Film> film, function<bool (shared_ptr<const Content>)> part, string overlapping, string& why_not) const
591 /* We must be using the same standard as the film */
593 if (_standard.get() == dcp::Standard::INTEROP && !film->interop()) {
594 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
595 why_not = _("it is Interop and the film is set to SMPTE.");
597 } else if (_standard.get() == dcp::Standard::SMPTE && film->interop()) {
598 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
599 why_not = _("it is SMPTE and the film is set to Interop.");
604 /* And the same frame rate */
605 if (!video_frame_rate() || (lrint(video_frame_rate().get()) != film->video_frame_rate())) {
606 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
607 why_not = _("it has a different frame rate to the film.");
611 auto const fr = film->reels ();
613 list<DCPTimePeriod> reel_list;
615 reel_list = reels (film);
616 } catch (dcp::ReadError &) {
617 /* We couldn't read the DCP; it's probably missing */
619 } catch (dcp::KDMDecryptionError &) {
620 /* We have an incorrect KDM */
624 /* fr must contain reels(). It can also contain other reels, but it must at
625 least contain reels().
627 for (auto i: reel_list) {
628 if (find (fr.begin(), fr.end(), i) == fr.end ()) {
629 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
630 why_not = _("its reel lengths differ from those in the film; set the reel mode to 'split by video content'.");
635 auto a = overlaps (film, film->content(), part, position(), end(film));
636 if (a.size() != 1 || a.front().get() != this) {
637 why_not = overlapping;
645 bool check_video (shared_ptr<const Content> c)
647 return static_cast<bool>(c->video) && c->video->use();
651 DCPContent::can_reference_video (shared_ptr<const Film> film, string& why_not) const
654 why_not = _("There is no video in this DCP");
658 if (film->resolution() != resolution()) {
659 if (resolution() == Resolution::FOUR_K) {
660 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
661 why_not = _("it is 4K and the film is 2K.");
663 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
664 why_not = _("it is 2K and the film is 4K.");
667 } else if (film->frame_size() != video->size()) {
668 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
669 why_not = _("its video frame size differs from the film's.");
673 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
674 return can_reference (film, bind (&check_video, _1), _("it overlaps other video content; remove the other content."), why_not);
678 bool check_audio (shared_ptr<const Content> c)
680 return static_cast<bool>(c->audio) && !c->audio->mapping().mapped_output_channels().empty();
684 DCPContent::can_reference_audio (shared_ptr<const Film> film, string& why_not) const
686 shared_ptr<DCPDecoder> decoder;
688 decoder = make_shared<DCPDecoder>(film, shared_from_this(), false, film->tolerant(), shared_ptr<DCPDecoder>());
689 } catch (dcp::ReadError &) {
690 /* We couldn't read the DCP, so it's probably missing */
692 } catch (DCPError &) {
693 /* We couldn't read the DCP, so it's probably missing */
695 } catch (dcp::KDMDecryptionError &) {
696 /* We have an incorrect KDM */
700 for (auto i: decoder->reels()) {
701 if (!i->main_sound()) {
702 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
703 why_not = _("it does not have sound in all its reels.");
708 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
709 return can_reference (film, bind (&check_audio, _1), _("it overlaps other audio content; remove the other content."), why_not);
713 bool check_text (shared_ptr<const Content> c)
715 return !c->text.empty();
719 DCPContent::can_reference_text (shared_ptr<const Film> film, TextType type, string& why_not) const
721 shared_ptr<DCPDecoder> decoder;
723 decoder = make_shared<DCPDecoder>(film, shared_from_this(), false, film->tolerant(), shared_ptr<DCPDecoder>());
724 } catch (dcp::ReadError &) {
725 /* We couldn't read the DCP, so it's probably missing */
727 } catch (dcp::KDMDecryptionError &) {
728 /* We have an incorrect KDM */
732 for (auto i: decoder->reels()) {
733 if (type == TextType::OPEN_SUBTITLE) {
734 if (!i->main_subtitle()) {
735 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
736 why_not = _("it does not have open subtitles in all its reels.");
738 } else if (i->main_subtitle()->entry_point().get_value_or(0) != 0) {
739 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
740 why_not = _("one of its subtitle reels has a non-zero entry point so it must be re-written.");
744 if (type == TextType::CLOSED_CAPTION) {
745 if (i->closed_captions().empty()) {
746 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
747 why_not = _("it does not have closed captions in all its reels.");
750 for (auto j: i->closed_captions()) {
751 if (j->entry_point().get_value_or(0) != 0) {
752 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
753 why_not = _("one of its closed caption has a non-zero entry point so it must be re-written.");
760 if (trim_start() != dcpomatic::ContentTime()) {
761 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
762 why_not = _("it has a start trim so its subtitles or closed captions must be re-written.");
766 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
767 return can_reference (film, bind (&check_text, _1), _("it overlaps other text content; remove the other content."), why_not);
771 DCPContent::take_settings_from (shared_ptr<const Content> c)
773 auto dc = dynamic_pointer_cast<const DCPContent>(c);
778 _reference_video = dc->_reference_video;
779 _reference_audio = dc->_reference_audio;
780 _reference_text = dc->_reference_text;
784 DCPContent::set_cpl (string id)
786 ContentChangeSignaller cc (this, DCPContentProperty::CPL);
789 boost::mutex::scoped_lock lm (_mutex);
795 DCPContent::kdm_timing_window_valid () const
802 return _kdm->not_valid_before() < now && now < _kdm->not_valid_after();
807 DCPContent::resolution () const
809 if (video->size().width > 2048 || video->size().height > 1080) {
810 return Resolution::FOUR_K;
813 return Resolution::TWO_K;
818 add_fonts_from_examiner(shared_ptr<TextContent> text, vector<vector<shared_ptr<Font>>> const & all_fonts)
821 for (auto reel_fonts: all_fonts) {
822 for (auto font: reel_fonts) {
823 /* Each reel could have its own font with the same ID, so we disambiguate them here
824 * by prepending the reel number. We do the same disambiguation when emitting the
825 * subtitles in the DCP decoder.
827 font->set_id(id_for_font_in_reel(font->id(), reel_number));
828 text->add_font(font);
837 id_for_font_in_reel(string id, int reel)
839 return String::compose("%1_%2", reel, id);
844 DCPContent::check_font_ids()
850 DCPExaminer examiner(shared_from_this(), true);
851 add_fonts_from_examiner(text.front(), examiner.fonts());