/* Copyright (C) 2014-2023 Carl Hetherington This file is part of DCP-o-matic. DCP-o-matic is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. DCP-o-matic is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with DCP-o-matic. If not, see . */ #include "atmos_content.h" #include "audio_content.h" #include "config.h" #include "dcp_content.h" #include "dcp_decoder.h" #include "dcp_examiner.h" #include "dcpomatic_log.h" #include "film.h" #include "job.h" #include "log.h" #include "overlaps.h" #include "text_content.h" #include "video_content.h" #include #include #include #include #include #include #include #include #include #include #include #include "i18n.h" using std::cout; using std::dynamic_pointer_cast; using std::exception; using std::function; using std::list; using std::make_shared; using std::shared_ptr; using std::string; using std::vector; using boost::optional; using boost::scoped_ptr; #if BOOST_VERSION >= 106100 using namespace boost::placeholders; #endif using dcp::raw_convert; using namespace dcpomatic; DCPContent::DCPContent(boost::filesystem::path p) : _picture_encrypted(false) , _sound_encrypted(false) , _text_encrypted(false) , _needs_assets(false) , _kdm_valid(false) , _reference_video(false) , _reference_audio(false) , _three_d(false) { LOG_GENERAL("Creating DCP content from {}", p.string()); read_directory(p); set_default_colour_conversion(); } DCPContent::DCPContent(cxml::ConstNodePtr node, boost::optional film_directory, int version) : Content(node, film_directory) { video = VideoContent::from_xml(this, node, version, VideoRange::FULL); audio = AudioContent::from_xml(this, node, version); list notes; text = TextContent::from_xml(this, node, version, notes); atmos = AtmosContent::from_xml(this, node); if (video && audio) { audio->set_stream( make_shared( node->number_child("AudioFrameRate"), /* AudioLength was not present in some old metadata versions */ node->optional_number_child("AudioLength").get_value_or( video->length() * node->number_child("AudioFrameRate") / video_frame_rate().get() ), AudioMapping(node->node_child("AudioMapping"), version), 24 ) ); } _name = node->string_child("Name"); auto encrypted = node->optional_bool_child("Encrypted").get_value_or(false); _picture_encrypted = node->optional_bool_child("PictureEncrypted").get_value_or(encrypted); _sound_encrypted = node->optional_bool_child("SoundEncrypted").get_value_or(encrypted); _text_encrypted = node->optional_bool_child("TextEncrypted").get_value_or(encrypted); _needs_assets = node->optional_bool_child("NeedsAssets").get_value_or(false); if (node->optional_node_child("KDM")) { _kdm = dcp::EncryptedKDM(node->string_child("KDM")); } _kdm_valid = node->bool_child("KDMValid"); _reference_video = node->optional_bool_child("ReferenceVideo").get_value_or(false); _reference_audio = node->optional_bool_child("ReferenceAudio").get_value_or(false); if (version >= 37) { _reference_text[TextType::OPEN_SUBTITLE] = node->optional_bool_child("ReferenceOpenSubtitle").get_value_or(false); _reference_text[TextType::CLOSED_CAPTION] = node->optional_bool_child("ReferenceClosedCaption").get_value_or(false); } else { _reference_text[TextType::OPEN_SUBTITLE] = node->optional_bool_child("ReferenceSubtitle").get_value_or(false); _reference_text[TextType::CLOSED_CAPTION] = false; } if (node->optional_string_child("Standard")) { auto const s = node->optional_string_child("Standard").get(); if (s == "Interop") { _standard = dcp::Standard::INTEROP; } else if (s == "SMPTE") { _standard = dcp::Standard::SMPTE; } else { DCPOMATIC_ASSERT(false); } } if (auto encoding = node->optional_string_child("VideoEncoding")) { _video_encoding = string_to_video_encoding(*encoding); } _three_d = node->optional_bool_child("ThreeD").get_value_or(false); auto ck = node->optional_string_child("ContentKind"); if (ck) { _content_kind = dcp::ContentKind::from_name(*ck); } _cpl = node->optional_string_child("CPL"); for (auto i: node->node_children("ReelLength")) { _reel_lengths.push_back(raw_convert(i->content())); } for (auto i: node->node_children("Marker")) { _markers[dcp::marker_from_string(i->string_attribute("type"))] = ContentTime(raw_convert(i->content())); } for (auto i: node->node_children("Rating")) { _ratings.push_back(dcp::Rating(i)); } for (auto i: node->node_children("ContentVersion")) { _content_versions.push_back(i->content()); } _active_audio_channels = node->optional_number_child("ActiveAudioChannels"); if (auto lang = node->optional_string_child("AudioLanguage")) { _audio_language = dcp::LanguageTag(*lang); } for (auto non_zero: node->node_children("HasNonZeroEntryPoint")) { try { auto type = string_to_text_type(non_zero->string_attribute("type")); _has_non_zero_entry_point[type] = non_zero->content() == "1"; } catch (MetadataError&) {} } } void DCPContent::read_directory(boost::filesystem::path p) { using namespace boost::filesystem; bool have_assetmap = false; bool have_metadata = false; for (auto i: directory_iterator(p)) { if (i.path().filename() == "ASSETMAP" || i.path().filename() == "ASSETMAP.xml") { have_assetmap = true; } else if (i.path().filename() == "metadata.xml") { have_metadata = true; } } if (!have_assetmap) { if (!have_metadata) { throw DCPError(_("No ASSETMAP or ASSETMAP.xml file found: is this a DCP?")); } else { throw ProjectFolderError(); } } read_sub_directory(p); } void DCPContent::read_sub_directory(boost::filesystem::path p) { using namespace boost::filesystem; LOG_GENERAL("DCPContent::read_sub_directory reads {}", p.string()); try { for (auto i: directory_iterator(p)) { if (is_regular_file(i.path())) { LOG_GENERAL("Inside there's regular file {}", i.path().string()); add_path(i.path()); } else if (is_directory(i.path()) && i.path().filename() != ".AppleDouble") { LOG_GENERAL("Inside there's directory {}", i.path().string()); read_sub_directory(i.path()); } else { LOG_GENERAL("Ignoring {} from inside: status is {}", i.path().string(), static_cast(status(i.path()).type())); } } } catch (exception& e) { LOG_GENERAL("Failed to iterate over {}: {}", p.string(), e.what()); } } /** @param film Film, or 0 */ void DCPContent::examine(shared_ptr film, shared_ptr job, bool tolerant) { bool const needed_assets = needs_assets(); bool const needed_kdm = needs_kdm(); string const old_name = name(); ContentChangeSignalDespatcher::instance()->suspend(); dcp::ScopeGuard sg = []() { ContentChangeSignalDespatcher::instance()->resume(); }; ContentChangeSignaller cc_texts(this, DCPContentProperty::TEXTS); ContentChangeSignaller cc_assets(this, DCPContentProperty::NEEDS_ASSETS); ContentChangeSignaller cc_kdm(this, DCPContentProperty::NEEDS_KDM); ContentChangeSignaller cc_name(this, DCPContentProperty::NAME); if (job) { job->set_progress_unknown(); } Content::examine(film, job, tolerant); auto examiner = make_shared(shared_from_this(), tolerant); if (examiner->has_video()) { { boost::mutex::scoped_lock lm(_mutex); video = make_shared(this); } video->take_from_examiner(film, examiner); set_default_colour_conversion(); } if (examiner->has_audio()) { { boost::mutex::scoped_lock lm(_mutex); audio = make_shared(this); } auto as = make_shared(examiner->audio_frame_rate(), examiner->audio_length(), examiner->audio_channels(), 24); audio->set_stream(as); auto m = as->mapping(); m.make_default(film ? film->audio_processor() : 0); as->set_mapping(m); _active_audio_channels = examiner->active_audio_channels(); _audio_language = examiner->audio_language(); } if (examiner->has_atmos()) { { boost::mutex::scoped_lock lm(_mutex); atmos = make_shared(this); } /* Setting length will cause calculations to be made based on edit rate, so that must * be set up first otherwise hard-to-spot exceptions will be thrown. */ atmos->set_edit_rate(examiner->atmos_edit_rate()); atmos->set_length(examiner->atmos_length()); } vector> new_text; for (int i = 0; i < examiner->text_count(TextType::OPEN_SUBTITLE); ++i) { auto c = make_shared(this, TextType::OPEN_SUBTITLE, TextType::OPEN_SUBTITLE); c->set_language(examiner->open_subtitle_language()); examiner->add_fonts(c); new_text.push_back(c); } for (int i = 0; i < examiner->text_count(TextType::OPEN_CAPTION); ++i) { auto c = make_shared(this, TextType::OPEN_CAPTION, TextType::OPEN_CAPTION); c->set_language(examiner->open_caption_language()); examiner->add_fonts(c); new_text.push_back(c); } for (int i = 0; i < examiner->text_count(TextType::CLOSED_SUBTITLE); ++i) { auto c = make_shared(this, TextType::CLOSED_SUBTITLE, TextType::CLOSED_SUBTITLE); c->set_dcp_track(examiner->dcp_subtitle_track(i)); examiner->add_fonts(c); new_text.push_back(c); } for (int i = 0; i < examiner->text_count(TextType::CLOSED_CAPTION); ++i) { auto c = make_shared(this, TextType::CLOSED_CAPTION, TextType::CLOSED_CAPTION); c->set_dcp_track(examiner->dcp_caption_track(i)); examiner->add_fonts(c); new_text.push_back(c); } { boost::mutex::scoped_lock lm(_mutex); text = new_text; _name = examiner->name(); _picture_encrypted = examiner->picture_encrypted(); _sound_encrypted = examiner->sound_encrypted(); _text_encrypted = examiner->text_encrypted(); _needs_assets = examiner->needs_assets(); _kdm_valid = examiner->kdm_valid(); _standard = examiner->standard(); _video_encoding = examiner->video_encoding(); _three_d = examiner->three_d(); _content_kind = examiner->content_kind(); _cpl = examiner->cpl(); _reel_lengths = examiner->reel_lengths(); _markers = examiner->markers(); _ratings = examiner->ratings(); _content_versions = examiner->content_versions(); _has_non_zero_entry_point = examiner->has_non_zero_entry_point(); } if (needed_assets == needs_assets()) { cc_assets.abort(); } if (needed_kdm == needs_kdm()) { cc_kdm.abort(); } if (old_name == name()) { cc_name.abort(); } if (video) { video->set_frame_type(_three_d ? VideoFrameType::THREE_D : VideoFrameType::TWO_D); } } string DCPContent::summary() const { boost::mutex::scoped_lock lm(_mutex); return fmt::format(_("{} [DCP]"), _name); } string DCPContent::technical_summary() const { string s = Content::technical_summary() + " - "; if (video) { s += video->technical_summary() + " - "; } if (audio) { s += audio->technical_summary() + " - "; } return s; } void DCPContent::as_xml(xmlpp::Element* element, bool with_paths, PathBehaviour path_behaviour, optional film_directory) const { cxml::add_text_child(element, "Type", "DCP"); Content::as_xml(element, with_paths, path_behaviour, film_directory); if (video) { video->as_xml(element); } if (audio) { audio->as_xml(element); cxml::add_text_child(element, "AudioFrameRate", fmt::to_string(audio->stream()->frame_rate())); cxml::add_text_child(element, "AudioLength", fmt::to_string(audio->stream()->length())); audio->stream()->mapping().as_xml(cxml::add_child(element, "AudioMapping")); } for (auto i: text) { i->as_xml(element); } if (atmos) { atmos->as_xml(element); } boost::mutex::scoped_lock lm(_mutex); cxml::add_text_child(element, "Name", _name); cxml::add_text_child(element, "Encrypted", (_picture_encrypted || _sound_encrypted || _text_encrypted) ? "1" : "0"); cxml::add_text_child(element, "PictureEncrypted", _picture_encrypted ? "1" : "0"); cxml::add_text_child(element, "SoundEncrypted", _sound_encrypted ? "1" : "0"); cxml::add_text_child(element, "TextEncrypted", _text_encrypted ? "1" : "0"); cxml::add_text_child(element, "NeedsAssets", _needs_assets ? "1" : "0"); if (_kdm) { cxml::add_text_child(element, "KDM", _kdm->as_xml()); } cxml::add_text_child(element, "KDMValid", _kdm_valid ? "1" : "0"); cxml::add_text_child(element, "ReferenceVideo", _reference_video ? "1" : "0"); cxml::add_text_child(element, "ReferenceAudio", _reference_audio ? "1" : "0"); cxml::add_text_child(element, "ReferenceOpenSubtitle", _reference_text[TextType::OPEN_SUBTITLE] ? "1" : "0"); cxml::add_text_child(element, "ReferenceClosedCaption", _reference_text[TextType::CLOSED_CAPTION] ? "1" : "0"); if (_standard) { switch (_standard.get()) { case dcp::Standard::INTEROP: cxml::add_text_child(element, "Standard", "Interop"); break; case dcp::Standard::SMPTE: cxml::add_text_child(element, "Standard", "SMPTE"); break; default: DCPOMATIC_ASSERT(false); } } if (_video_encoding) { cxml::add_text_child(element, "VideoEncoding", video_encoding_to_string(*_video_encoding)); } cxml::add_text_child(element, "ThreeD", _three_d ? "1" : "0"); if (_content_kind) { cxml::add_text_child(element, "ContentKind", _content_kind->name()); } if (_cpl) { cxml::add_text_child(element, "CPL", _cpl.get()); } for (auto i: _reel_lengths) { cxml::add_text_child(element, "ReelLength", fmt::to_string(i)); } for (auto const& i: _markers) { auto marker = cxml::add_child(element, "Marker"); marker->set_attribute("type", dcp::marker_to_string(i.first)); marker->add_child_text(fmt::to_string(i.second.get())); } for (auto i: _ratings) { auto rating = cxml::add_child(element, "Rating"); i.as_xml(rating); } for (auto i: _content_versions) { cxml::add_text_child(element, "ContentVersion", i); } if (_active_audio_channels) { cxml::add_text_child(element, "ActiveAudioChannels", fmt::to_string(*_active_audio_channels)); } if (_audio_language) { cxml::add_text_child(element, "AudioLanguage", _audio_language->as_string()); } for (auto i = 0; i < static_cast(TextType::COUNT); ++i) { if (_has_non_zero_entry_point[i]) { auto has = cxml::add_child(element, "HasNonZeroEntryPoint"); has->add_child_text("1"); has->set_attribute("type", text_type_to_string(static_cast(i))); } } } DCPTime DCPContent::full_length(shared_ptr film) const { if (!video) { return {}; } FrameRateChange const frc(film, shared_from_this()); return DCPTime::from_frames(llrint(video->length() * frc.factor()), film->video_frame_rate()); } DCPTime DCPContent::approximate_length() const { if (!video) { return {}; } return DCPTime::from_frames(video->length(), 24); } string DCPContent::identifier() const { string s = Content::identifier() + "_"; if (video) { s += video->identifier() + "_"; } for (auto i: text) { s += i->identifier() + " "; } boost::mutex::scoped_lock lm(_mutex); s += string(_reference_video ? "1" : "0"); for (auto text: _reference_text) { s += string(text ? "1" : "0"); } return s; } void DCPContent::add_kdm(dcp::EncryptedKDM k) { _kdm = k; } void DCPContent::add_ov(boost::filesystem::path ov) { read_directory(ov); } bool DCPContent::can_be_played() const { return !needs_kdm() && !needs_assets(); } bool DCPContent::needs_kdm() const { boost::mutex::scoped_lock lm(_mutex); return (_picture_encrypted || _sound_encrypted || _text_encrypted) && !_kdm_valid; } bool DCPContent::needs_assets() const { boost::mutex::scoped_lock lm(_mutex); return _needs_assets; } vector DCPContent::directories() const { return dcp::DCP::directories_from_files(paths()); } void DCPContent::add_properties(shared_ptr film, list& p) const { Content::add_properties(film, p); if (video) { video->add_properties(p); } if (audio) { audio->add_properties(film, p); } } void DCPContent::set_default_colour_conversion() { /* Default to no colour conversion for DCPs */ if (video) { video->unset_colour_conversion(); } } void DCPContent::set_reference_video(bool r) { ContentChangeSignaller cc(this, DCPContentProperty::REFERENCE_VIDEO); { boost::mutex::scoped_lock lm(_mutex); _reference_video = r; } } void DCPContent::set_reference_audio(bool r) { ContentChangeSignaller cc(this, DCPContentProperty::REFERENCE_AUDIO); { boost::mutex::scoped_lock lm(_mutex); _reference_audio = r; } } void DCPContent::set_reference_text(TextType type, bool r) { ContentChangeSignaller cc(this, DCPContentProperty::REFERENCE_TEXT); { boost::mutex::scoped_lock lm(_mutex); _reference_text[type] = r; } } list DCPContent::reels(shared_ptr film) const { auto reel_lengths = _reel_lengths; if (reel_lengths.empty()) { /* Old metadata with no reel lengths; get them here instead */ try { DCPExaminer examiner(shared_from_this(), true); reel_lengths = examiner.reel_lengths(); } catch (...) { /* Could not examine the DCP; guess reels */ reel_lengths.push_back(length_after_trim(film).frames_round(film->video_frame_rate())); } } list p; /* This content's frame rate must be the same as the output DCP rate, so we can convert `directly' from ContentTime to DCPTime. */ /* The starting point of this content on the timeline */ auto pos = position() - DCPTime(trim_start().get()); for (auto i: reel_lengths) { /* This reel runs from `pos' to `to' */ DCPTime const to = pos + DCPTime::from_frames(i, film->video_frame_rate()); if (to > position()) { p.push_back(DCPTimePeriod(max(position(), pos), min(end(film), to))); if (to > end(film)) { break; } } pos = to; } return p; } list DCPContent::reel_split_points(shared_ptr film) const { list s; for (auto i: reels(film)) { s.push_back(i.from); } return s; } bool DCPContent::can_reference_anything(shared_ptr film, string& why_not) const { /* We must be using the same standard as the film */ if (_standard) { if (_standard.get() == dcp::Standard::INTEROP && !film->interop()) { /// TRANSLATORS: this string will follow "Cannot reference this DCP: " why_not = _("it is Interop and the film is set to SMPTE."); return false; } else if (_standard.get() == dcp::Standard::SMPTE && film->interop()) { /// TRANSLATORS: this string will follow "Cannot reference this DCP: " why_not = _("it is SMPTE and the film is set to Interop."); return false; } } /* And the same frame rate */ if (!video_frame_rate() || (lrint(video_frame_rate().get()) != film->video_frame_rate())) { /// TRANSLATORS: this string will follow "Cannot reference this DCP: " why_not = _("it has a different frame rate to the film."); return false; } auto const fr = film->reels(); list reel_list; try { reel_list = reels(film); } catch (dcp::ReadError &) { /* We couldn't read the DCP; it's probably missing */ return false; } catch (dcp::KDMDecryptionError &) { /* We have an incorrect KDM */ return false; } /* fr must contain reels(). It can also contain other reels, but it must at least contain reels(). */ for (auto i: reel_list) { if (find(fr.begin(), fr.end(), i) == fr.end()) { /// TRANSLATORS: this string will follow "Cannot reference this DCP: " why_not = _("its reel lengths differ from those in the film; set the reel mode to 'split by video content'."); return false; } } return true; } bool DCPContent::overlaps(shared_ptr film, function)> part) const { auto const a = dcpomatic::overlaps(film, film->content(), part, position(), end(film)); return a.size() != 1 || a.front().get() != this; } bool DCPContent::can_reference_video(shared_ptr film, string& why_not) const { if (!video) { why_not = _("There is no video in this DCP"); return false; } if (film->resolution() != resolution()) { if (resolution() == Resolution::FOUR_K) { /// TRANSLATORS: this string will follow "Cannot reference this DCP: " why_not = _("it is 4K and the film is 2K."); } else { /// TRANSLATORS: this string will follow "Cannot reference this DCP: " why_not = _("it is 2K and the film is 4K."); } return false; } else if (film->frame_size() != video->size()) { /// TRANSLATORS: this string will follow "Cannot reference this DCP: " why_not = _("its video frame size differs from the film's."); return false; } auto part = [](shared_ptr c) { return static_cast(c->video) && c->video->use(); }; if (overlaps(film, part)) { /// TRANSLATORS: this string will follow "Cannot reference this DCP: " why_not = _("it overlaps other video content."); return false; } return can_reference_anything(film, why_not); } bool DCPContent::can_reference_audio(shared_ptr film, string& why_not) const { if (audio && audio->stream()) { auto const channels = audio->stream()->channels(); if (channels != film->audio_channels()) { why_not = fmt::format(_("it has a different number of audio channels than the project; set the project to have {} channels."), channels); return false; } } auto part = [](shared_ptr c) { return c->has_mapped_audio(); }; if (overlaps(film, part)) { /// TRANSLATORS: this string will follow "Cannot reference this DCP: " why_not = _("it overlaps other audio content."); return false; } return can_reference_anything(film, why_not); } bool DCPContent::can_reference_text(shared_ptr film, TextType type, string& why_not) const { if (_has_non_zero_entry_point[TextType::OPEN_SUBTITLE]) { /// TRANSLATORS: this string will follow "Cannot reference this DCP: " why_not = _("one of its subtitle reels has a non-zero entry point so it must be re-written."); return false; } if (_has_non_zero_entry_point[TextType::CLOSED_CAPTION]) { /// TRANSLATORS: this string will follow "Cannot reference this DCP: " why_not = _("one of its closed caption has a non-zero entry point so it must be re-written."); return false; } if (trim_start() != dcpomatic::ContentTime()) { /// TRANSLATORS: this string will follow "Cannot reference this DCP: " why_not = _("it has a start trim so its subtitles or closed captions must be re-written."); return false; } auto part = [type](shared_ptr c) { return std::find_if(c->text.begin(), c->text.end(), [type](shared_ptr t) { return t->type() == type; }) != c->text.end(); }; if (overlaps(film, part)) { /// TRANSLATORS: this string will follow "Cannot reference this DCP: " why_not = _("it overlaps other text content."); return false; } return can_reference_anything(film, why_not); } void DCPContent::take_settings_from(shared_ptr c) { auto dc = dynamic_pointer_cast(c); if (!dc) { return; } if (this == dc.get()) { return; } boost::mutex::scoped_lock lm(_mutex); boost::mutex::scoped_lock lm2(dc->_mutex); _reference_video = dc->_reference_video; _reference_audio = dc->_reference_audio; _reference_text = dc->_reference_text; } void DCPContent::set_cpl(string id) { ContentChangeSignaller cc(this, DCPContentProperty::CPL); { boost::mutex::scoped_lock lm(_mutex); _cpl = id; } } bool DCPContent::kdm_timing_window_valid() const { if (!_kdm) { return true; } dcp::LocalTime now; return _kdm->not_valid_before() < now && now < _kdm->not_valid_after(); } Resolution DCPContent::resolution() const { if (video->size() && (video->size()->width > 2048 || video->size()->height > 1080)) { return Resolution::FOUR_K; } return Resolution::TWO_K; } void DCPContent::check_font_ids() { if (text.empty()) { return; } /* This might be called on a TextContent that already has some fonts * (e.g. if run from a build with a LastWrittenBy containing only a git * hash, or from a version between 2.16.15 and 2.17.17) so we'll get an * error if we don't clear them out first. */ text[0]->clear_fonts(); DCPExaminer examiner(shared_from_this(), true); examiner.add_fonts(text[0]); } int DCPContent::active_audio_channels() const { return _active_audio_channels.get_value_or( (audio && audio->stream()) ? audio->stream()->channels() : 0 ); } bool DCPContent::reference_anything() const { if (reference_video() || reference_audio()) { return true; } boost::mutex::scoped_lock lm(_mutex); return find(_reference_text.begin(), _reference_text.end(), true) != _reference_text.end(); } boost::filesystem::path DCPContent::path_for_display() const { return path(0).parent_path(); }