2 Copyright (C) 2014-2023 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 "scope_guard.h"
35 #include "text_content.h"
36 #include "video_content.h"
38 #include <dcp/raw_convert.h>
39 #include <dcp/exceptions.h>
40 #include <dcp/reel_closed_caption_asset.h>
41 #include <dcp/reel_picture_asset.h>
42 #include <dcp/reel_subtitle_asset.h>
44 #include <libxml++/libxml++.h>
52 using std::dynamic_pointer_cast;
55 using std::make_shared;
56 using std::shared_ptr;
59 using boost::optional;
60 using boost::scoped_ptr;
61 #if BOOST_VERSION >= 106100
62 using namespace boost::placeholders;
64 using dcp::raw_convert;
65 using namespace dcpomatic;
68 int const DCPContentProperty::NEEDS_ASSETS = 600;
69 int const DCPContentProperty::NEEDS_KDM = 601;
70 int const DCPContentProperty::REFERENCE_VIDEO = 602;
71 int const DCPContentProperty::REFERENCE_AUDIO = 603;
72 int const DCPContentProperty::REFERENCE_TEXT = 604;
73 int const DCPContentProperty::NAME = 605;
74 int const DCPContentProperty::TEXTS = 606;
75 int const DCPContentProperty::CPL = 607;
78 DCPContent::DCPContent (boost::filesystem::path p)
80 , _needs_assets (false)
82 , _reference_video (false)
83 , _reference_audio (false)
86 LOG_GENERAL ("Creating DCP content from %1", p.string());
89 set_default_colour_conversion ();
92 DCPContent::DCPContent (cxml::ConstNodePtr node, int version)
95 video = VideoContent::from_xml (this, node, version, VideoRange::FULL);
96 audio = AudioContent::from_xml (this, node, version);
98 text = TextContent::from_xml (this, node, version, notes);
99 atmos = AtmosContent::from_xml (this, node);
101 if (video && audio) {
103 make_shared<AudioStream> (
104 node->number_child<int> ("AudioFrameRate"),
105 /* AudioLength was not present in some old metadata versions */
106 node->optional_number_child<Frame>("AudioLength").get_value_or (
107 video->length() * node->number_child<int>("AudioFrameRate") / video_frame_rate().get()
109 AudioMapping(node->node_child("AudioMapping"), version),
115 _name = node->string_child ("Name");
116 _encrypted = node->bool_child ("Encrypted");
117 _needs_assets = node->optional_bool_child("NeedsAssets").get_value_or (false);
118 if (node->optional_node_child ("KDM")) {
119 _kdm = dcp::EncryptedKDM (node->string_child ("KDM"));
121 _kdm_valid = node->bool_child ("KDMValid");
122 _reference_video = node->optional_bool_child ("ReferenceVideo").get_value_or (false);
123 _reference_audio = node->optional_bool_child ("ReferenceAudio").get_value_or (false);
125 _reference_text[TextType::OPEN_SUBTITLE] = node->optional_bool_child("ReferenceOpenSubtitle").get_value_or(false);
126 _reference_text[TextType::CLOSED_CAPTION] = node->optional_bool_child("ReferenceClosedCaption").get_value_or(false);
128 _reference_text[TextType::OPEN_SUBTITLE] = node->optional_bool_child("ReferenceSubtitle").get_value_or(false);
129 _reference_text[TextType::CLOSED_CAPTION] = false;
131 if (node->optional_string_child("Standard")) {
132 auto const s = node->optional_string_child("Standard").get();
133 if (s == "Interop") {
134 _standard = dcp::Standard::INTEROP;
135 } else if (s == "SMPTE") {
136 _standard = dcp::Standard::SMPTE;
138 DCPOMATIC_ASSERT (false);
141 _three_d = node->optional_bool_child("ThreeD").get_value_or (false);
143 auto ck = node->optional_string_child("ContentKind");
145 _content_kind = dcp::ContentKind::from_name(*ck);
147 _cpl = node->optional_string_child("CPL");
148 for (auto i: node->node_children("ReelLength")) {
149 _reel_lengths.push_back (raw_convert<int64_t> (i->content ()));
152 for (auto i: node->node_children("Marker")) {
153 _markers[dcp::marker_from_string(i->string_attribute("type"))] = ContentTime(raw_convert<int64_t>(i->content()));
156 for (auto i: node->node_children("Rating")) {
157 _ratings.push_back (dcp::Rating(i));
160 for (auto i: node->node_children("ContentVersion")) {
161 _content_versions.push_back (i->content());
166 DCPContent::read_directory (boost::filesystem::path p)
168 using namespace boost::filesystem;
170 bool have_assetmap = false;
171 bool have_metadata = false;
173 for (auto i: directory_iterator(p)) {
174 if (i.path().filename() == "ASSETMAP" || i.path().filename() == "ASSETMAP.xml") {
175 have_assetmap = true;
176 } else if (i.path().filename() == "metadata.xml") {
177 have_metadata = true;
181 if (!have_assetmap) {
182 if (!have_metadata) {
183 throw DCPError ("No ASSETMAP or ASSETMAP.xml file found: is this a DCP?");
185 throw ProjectFolderError ();
189 read_sub_directory (p);
193 DCPContent::read_sub_directory (boost::filesystem::path p)
195 using namespace boost::filesystem;
197 LOG_GENERAL ("DCPContent::read_sub_directory reads %1", p.string());
198 for (auto i: directory_iterator(p)) {
199 if (is_regular_file(i.path())) {
200 LOG_GENERAL ("Inside there's regular file %1", i.path().string());
202 } else if (is_directory(i.path()) && i.path().filename() != ".AppleDouble") {
203 LOG_GENERAL ("Inside there's directory %1", i.path().string());
204 read_sub_directory (i.path());
206 LOG_GENERAL("Ignoring %1 from inside: status is %2", i.path().string(), static_cast<int>(status(i.path()).type()));
211 /** @param film Film, or 0 */
213 DCPContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
215 bool const needed_assets = needs_assets ();
216 bool const needed_kdm = needs_kdm ();
217 string const old_name = name ();
219 ContentChangeSignalDespatcher::instance()->suspend();
220 ScopeGuard sg = []() {
221 ContentChangeSignalDespatcher::instance()->resume();
224 ContentChangeSignaller cc_texts (this, DCPContentProperty::TEXTS);
225 ContentChangeSignaller cc_assets (this, DCPContentProperty::NEEDS_ASSETS);
226 ContentChangeSignaller cc_kdm (this, DCPContentProperty::NEEDS_KDM);
227 ContentChangeSignaller cc_name (this, DCPContentProperty::NAME);
230 job->set_progress_unknown ();
232 Content::examine (film, job);
234 auto examiner = make_shared<DCPExaminer>(shared_from_this(), film ? film->tolerant() : true);
236 if (examiner->has_video()) {
238 boost::mutex::scoped_lock lm (_mutex);
239 video = make_shared<VideoContent>(this);
241 video->take_from_examiner(film, examiner);
242 set_default_colour_conversion ();
245 if (examiner->has_audio()) {
247 boost::mutex::scoped_lock lm (_mutex);
248 audio = make_shared<AudioContent>(this);
250 auto as = make_shared<AudioStream>(examiner->audio_frame_rate(), examiner->audio_length(), examiner->audio_channels(), 24);
251 audio->set_stream (as);
252 auto m = as->mapping ();
253 m.make_default (film ? film->audio_processor() : 0);
257 if (examiner->has_atmos()) {
259 boost::mutex::scoped_lock lm (_mutex);
260 atmos = make_shared<AtmosContent>(this);
262 /* Setting length will cause calculations to be made based on edit rate, so that must
263 * be set up first otherwise hard-to-spot exceptions will be thrown.
265 atmos->set_edit_rate (examiner->atmos_edit_rate());
266 atmos->set_length (examiner->atmos_length());
269 vector<shared_ptr<TextContent>> new_text;
271 for (int i = 0; i < examiner->text_count(TextType::OPEN_SUBTITLE); ++i) {
272 auto c = make_shared<TextContent>(this, TextType::OPEN_SUBTITLE, TextType::OPEN_SUBTITLE);
273 c->set_language (examiner->open_subtitle_language());
274 add_fonts_from_examiner(c, examiner->fonts());
275 new_text.push_back (c);
278 for (int i = 0; i < examiner->text_count(TextType::CLOSED_CAPTION); ++i) {
279 auto c = make_shared<TextContent>(this, TextType::CLOSED_CAPTION, TextType::CLOSED_CAPTION);
280 c->set_dcp_track (examiner->dcp_text_track(i));
281 add_fonts_from_examiner(c, examiner->fonts());
282 new_text.push_back (c);
286 boost::mutex::scoped_lock lm (_mutex);
288 _name = examiner->name ();
289 _encrypted = examiner->encrypted ();
290 _needs_assets = examiner->needs_assets ();
291 _kdm_valid = examiner->kdm_valid ();
292 _standard = examiner->standard ();
293 _three_d = examiner->three_d ();
294 _content_kind = examiner->content_kind ();
295 _cpl = examiner->cpl ();
296 _reel_lengths = examiner->reel_lengths ();
297 for (auto const& i: examiner->markers()) {
298 _markers[i.first] = ContentTime(i.second.as_editable_units_ceil(DCPTime::HZ));
300 _ratings = examiner->ratings ();
301 _content_versions = examiner->content_versions ();
304 if (needed_assets == needs_assets()) {
308 if (needed_kdm == needs_kdm()) {
312 if (old_name == name()) {
317 video->set_frame_type (_three_d ? VideoFrameType::THREE_D : VideoFrameType::TWO_D);
322 DCPContent::summary () const
324 boost::mutex::scoped_lock lm (_mutex);
325 return String::compose (_("%1 [DCP]"), _name);
329 DCPContent::technical_summary () const
331 string s = Content::technical_summary() + " - ";
333 s += video->technical_summary() + " - ";
336 s += audio->technical_summary() + " - ";
342 DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
344 node->add_child("Type")->add_child_text ("DCP");
346 Content::as_xml (node, with_paths);
349 video->as_xml (node);
353 audio->as_xml (node);
354 node->add_child("AudioFrameRate")->add_child_text (raw_convert<string> (audio->stream()->frame_rate()));
355 node->add_child("AudioLength")->add_child_text (raw_convert<string> (audio->stream()->length()));
356 audio->stream()->mapping().as_xml (node->add_child("AudioMapping"));
364 atmos->as_xml (node);
367 boost::mutex::scoped_lock lm (_mutex);
368 node->add_child("Name")->add_child_text (_name);
369 node->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
370 node->add_child("NeedsAssets")->add_child_text (_needs_assets ? "1" : "0");
372 node->add_child("KDM")->add_child_text (_kdm->as_xml ());
374 node->add_child("KDMValid")->add_child_text (_kdm_valid ? "1" : "0");
375 node->add_child("ReferenceVideo")->add_child_text (_reference_video ? "1" : "0");
376 node->add_child("ReferenceAudio")->add_child_text (_reference_audio ? "1" : "0");
377 node->add_child("ReferenceOpenSubtitle")->add_child_text(_reference_text[TextType::OPEN_SUBTITLE] ? "1" : "0");
378 node->add_child("ReferenceClosedCaption")->add_child_text(_reference_text[TextType::CLOSED_CAPTION] ? "1" : "0");
380 switch (_standard.get ()) {
381 case dcp::Standard::INTEROP:
382 node->add_child("Standard")->add_child_text ("Interop");
384 case dcp::Standard::SMPTE:
385 node->add_child("Standard")->add_child_text ("SMPTE");
388 DCPOMATIC_ASSERT (false);
391 node->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
393 node->add_child("ContentKind")->add_child_text(_content_kind->name());
396 node->add_child("CPL")->add_child_text (_cpl.get ());
398 for (auto i: _reel_lengths) {
399 node->add_child("ReelLength")->add_child_text (raw_convert<string> (i));
402 for (auto const& i: _markers) {
403 auto marker = node->add_child("Marker");
404 marker->set_attribute("type", dcp::marker_to_string(i.first));
405 marker->add_child_text(raw_convert<string>(i.second.get()));
408 for (auto i: _ratings) {
409 auto rating = node->add_child("Rating");
413 for (auto i: _content_versions) {
414 node->add_child("ContentVersion")->add_child_text(i);
419 DCPContent::full_length (shared_ptr<const Film> film) const
424 FrameRateChange const frc (film, shared_from_this());
425 return DCPTime::from_frames (llrint(video->length() * frc.factor()), film->video_frame_rate());
429 DCPContent::approximate_length () const
434 return DCPTime::from_frames (video->length(), 24);
438 DCPContent::identifier () const
440 string s = Content::identifier() + "_";
443 s += video->identifier() + "_";
447 s += i->identifier () + " ";
450 s += string (_reference_video ? "1" : "0");
451 for (auto text: _reference_text) {
452 s += string(text ? "1" : "0");
458 DCPContent::add_kdm (dcp::EncryptedKDM k)
464 DCPContent::add_ov (boost::filesystem::path ov)
470 DCPContent::can_be_played () const
472 return !needs_kdm() && !needs_assets();
476 DCPContent::needs_kdm () const
478 boost::mutex::scoped_lock lm (_mutex);
479 return _encrypted && !_kdm_valid;
483 DCPContent::needs_assets () const
485 boost::mutex::scoped_lock lm (_mutex);
486 return _needs_assets;
489 vector<boost::filesystem::path>
490 DCPContent::directories () const
492 return dcp::DCP::directories_from_files (paths());
496 DCPContent::add_properties (shared_ptr<const Film> film, list<UserProperty>& p) const
498 Content::add_properties (film, p);
500 video->add_properties (p);
503 audio->add_properties (film, p);
508 DCPContent::set_default_colour_conversion ()
510 /* Default to no colour conversion for DCPs */
512 video->unset_colour_conversion ();
517 DCPContent::set_reference_video (bool r)
519 ContentChangeSignaller cc (this, DCPContentProperty::REFERENCE_VIDEO);
522 boost::mutex::scoped_lock lm (_mutex);
523 _reference_video = r;
528 DCPContent::set_reference_audio (bool r)
530 ContentChangeSignaller cc (this, DCPContentProperty::REFERENCE_AUDIO);
533 boost::mutex::scoped_lock lm (_mutex);
534 _reference_audio = r;
539 DCPContent::set_reference_text (TextType type, bool r)
541 ContentChangeSignaller cc (this, DCPContentProperty::REFERENCE_TEXT);
544 boost::mutex::scoped_lock lm (_mutex);
545 _reference_text[type] = r;
550 DCPContent::reels (shared_ptr<const Film> film) const
552 auto reel_lengths = _reel_lengths;
553 if (reel_lengths.empty()) {
554 /* Old metadata with no reel lengths; get them here instead */
556 scoped_ptr<DCPExaminer> examiner (new DCPExaminer(shared_from_this(), film->tolerant()));
557 reel_lengths = examiner->reel_lengths ();
559 /* Could not examine the DCP; guess reels */
560 reel_lengths.push_back (length_after_trim(film).frames_round(film->video_frame_rate()));
564 list<DCPTimePeriod> p;
566 /* This content's frame rate must be the same as the output DCP rate, so we can
567 convert `directly' from ContentTime to DCPTime.
570 /* The starting point of this content on the timeline */
571 auto pos = position() - DCPTime (trim_start().get());
573 for (auto i: reel_lengths) {
574 /* This reel runs from `pos' to `to' */
575 DCPTime const to = pos + DCPTime::from_frames (i, film->video_frame_rate());
576 if (to > position()) {
577 p.push_back (DCPTimePeriod(max(position(), pos), min(end(film), to)));
578 if (to > end(film)) {
589 DCPContent::reel_split_points (shared_ptr<const Film> film) const
592 for (auto i: reels(film)) {
593 s.push_back (i.from);
599 DCPContent::can_reference (shared_ptr<const Film> film, function<bool (shared_ptr<const Content>)> part, string overlapping, string& why_not) const
601 /* We must be using the same standard as the film */
603 if (_standard.get() == dcp::Standard::INTEROP && !film->interop()) {
604 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
605 why_not = _("it is Interop and the film is set to SMPTE.");
607 } else if (_standard.get() == dcp::Standard::SMPTE && film->interop()) {
608 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
609 why_not = _("it is SMPTE and the film is set to Interop.");
614 /* And the same frame rate */
615 if (!video_frame_rate() || (lrint(video_frame_rate().get()) != film->video_frame_rate())) {
616 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
617 why_not = _("it has a different frame rate to the film.");
621 auto const fr = film->reels ();
623 list<DCPTimePeriod> reel_list;
625 reel_list = reels (film);
626 } catch (dcp::ReadError &) {
627 /* We couldn't read the DCP; it's probably missing */
629 } catch (dcp::KDMDecryptionError &) {
630 /* We have an incorrect KDM */
634 /* fr must contain reels(). It can also contain other reels, but it must at
635 least contain reels().
637 for (auto i: reel_list) {
638 if (find (fr.begin(), fr.end(), i) == fr.end ()) {
639 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
640 why_not = _("its reel lengths differ from those in the film; set the reel mode to 'split by video content'.");
645 auto a = overlaps (film, film->content(), part, position(), end(film));
646 if (a.size() != 1 || a.front().get() != this) {
647 why_not = overlapping;
655 bool check_video (shared_ptr<const Content> c)
657 return static_cast<bool>(c->video) && c->video->use();
661 DCPContent::can_reference_video (shared_ptr<const Film> film, string& why_not) const
664 why_not = _("There is no video in this DCP");
668 if (film->resolution() != resolution()) {
669 if (resolution() == Resolution::FOUR_K) {
670 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
671 why_not = _("it is 4K and the film is 2K.");
673 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
674 why_not = _("it is 2K and the film is 4K.");
677 } else if (film->frame_size() != video->size()) {
678 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
679 why_not = _("its video frame size differs from the film's.");
683 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
684 return can_reference (film, bind (&check_video, _1), _("it overlaps other video content; remove the other content."), why_not);
688 bool check_audio (shared_ptr<const Content> c)
690 return static_cast<bool>(c->audio) && !c->audio->mapping().mapped_output_channels().empty();
694 DCPContent::can_reference_audio (shared_ptr<const Film> film, string& why_not) const
696 shared_ptr<DCPDecoder> decoder;
698 decoder = make_shared<DCPDecoder>(film, shared_from_this(), false, film->tolerant(), shared_ptr<DCPDecoder>());
699 } catch (dcp::ReadError &) {
700 /* We couldn't read the DCP, so it's probably missing */
702 } catch (DCPError &) {
703 /* We couldn't read the DCP, so it's probably missing */
705 } catch (dcp::KDMDecryptionError &) {
706 /* We have an incorrect KDM */
710 for (auto i: decoder->reels()) {
711 if (!i->main_sound()) {
712 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
713 why_not = _("it does not have sound in all its reels.");
718 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
719 return can_reference (film, bind (&check_audio, _1), _("it overlaps other audio content; remove the other content."), why_not);
723 bool check_text (shared_ptr<const Content> c)
725 return !c->text.empty();
729 DCPContent::can_reference_text (shared_ptr<const Film> film, TextType type, string& why_not) const
731 shared_ptr<DCPDecoder> decoder;
733 decoder = make_shared<DCPDecoder>(film, shared_from_this(), false, film->tolerant(), shared_ptr<DCPDecoder>());
734 } catch (dcp::ReadError &) {
735 /* We couldn't read the DCP, so it's probably missing */
737 } catch (dcp::KDMDecryptionError &) {
738 /* We have an incorrect KDM */
742 for (auto i: decoder->reels()) {
743 if (type == TextType::OPEN_SUBTITLE) {
744 if (!i->main_subtitle()) {
745 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
746 why_not = _("it does not have open subtitles in all its reels.");
748 } else if (i->main_subtitle()->entry_point().get_value_or(0) != 0) {
749 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
750 why_not = _("one of its subtitle reels has a non-zero entry point so it must be re-written.");
754 if (type == TextType::CLOSED_CAPTION) {
755 if (i->closed_captions().empty()) {
756 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
757 why_not = _("it does not have closed captions in all its reels.");
760 for (auto j: i->closed_captions()) {
761 if (j->entry_point().get_value_or(0) != 0) {
762 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
763 why_not = _("one of its closed caption has a non-zero entry point so it must be re-written.");
770 if (trim_start() != dcpomatic::ContentTime()) {
771 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
772 why_not = _("it has a start trim so its subtitles or closed captions must be re-written.");
776 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
777 return can_reference (film, bind (&check_text, _1), _("it overlaps other text content; remove the other content."), why_not);
781 DCPContent::take_settings_from (shared_ptr<const Content> c)
783 auto dc = dynamic_pointer_cast<const DCPContent>(c);
788 _reference_video = dc->_reference_video;
789 _reference_audio = dc->_reference_audio;
790 _reference_text = dc->_reference_text;
794 DCPContent::set_cpl (string id)
796 ContentChangeSignaller cc (this, DCPContentProperty::CPL);
799 boost::mutex::scoped_lock lm (_mutex);
805 DCPContent::kdm_timing_window_valid () const
812 return _kdm->not_valid_before() < now && now < _kdm->not_valid_after();
817 DCPContent::resolution () const
819 if (video->size().width > 2048 || video->size().height > 1080) {
820 return Resolution::FOUR_K;
823 return Resolution::TWO_K;
828 add_fonts_from_examiner(shared_ptr<TextContent> text, vector<vector<shared_ptr<Font>>> const & all_fonts)
831 for (auto reel_fonts: all_fonts) {
832 for (auto font: reel_fonts) {
833 /* Each reel could have its own font with the same ID, so we disambiguate them here
834 * by prepending the reel number. We do the same disambiguation when emitting the
835 * subtitles in the DCP decoder.
837 auto font_copy = make_shared<dcpomatic::Font>(*font);
838 font_copy->set_id(id_for_font_in_reel(font->id(), reel_number));
839 text->add_font(font_copy);
848 id_for_font_in_reel(string id, int reel)
850 return String::compose("%1_%2", reel, id);
855 DCPContent::check_font_ids()
861 DCPExaminer examiner(shared_from_this(), true);
862 add_fonts_from_examiner(text.front(), examiner.fonts());