Remove all use of add_child() from xmlpp.
[dcpomatic.git] / src / lib / dcp_content.cc
index cdf104f0377ba3b2aee4d714effb0b2f2f1b7e24..e9afa04cc1cdf9136d87d5c66455422d20652438 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2014-2022 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2023 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -40,6 +40,7 @@
 #include <dcp/reel_picture_asset.h>
 #include <dcp/reel_subtitle_asset.h>
 #include <dcp/reel.h>
+#include <dcp/scope_guard.h>
 #include <libxml++/libxml++.h>
 #include <iterator>
 #include <iostream>
@@ -49,6 +50,7 @@
 
 using std::cout;
 using std::dynamic_pointer_cast;
+using std::exception;
 using std::function;
 using std::list;
 using std::make_shared;
@@ -159,6 +161,15 @@ DCPContent::DCPContent (cxml::ConstNodePtr node, int version)
        for (auto i: node->node_children("ContentVersion")) {
                _content_versions.push_back (i->content());
        }
+
+       _active_audio_channels = node->optional_number_child<int>("ActiveAudioChannels");
+
+       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
@@ -191,17 +202,23 @@ DCPContent::read_directory (boost::filesystem::path p)
 void
 DCPContent::read_sub_directory (boost::filesystem::path p)
 {
+       using namespace boost::filesystem;
+
        LOG_GENERAL ("DCPContent::read_sub_directory reads %1", p.string());
-       for (auto i: boost::filesystem::directory_iterator(p)) {
-               if (boost::filesystem::is_regular_file(i.path())) {
-                       LOG_GENERAL ("Inside there's regular file %1", i.path().string());
-                       add_path (i.path());
-               } else if (boost::filesystem::is_directory(i.path()) && i.path().filename() != ".AppleDouble") {
-                       LOG_GENERAL ("Inside there's directory %1", i.path().string());
-                       read_sub_directory (i.path());
-               } else {
-                       LOG_GENERAL("Ignoring %1 from inside: status is %2", i.path().string(), static_cast<int>(boost::filesystem::status(i.path()).type()));
+       try {
+               for (auto i: directory_iterator(p)) {
+                       if (is_regular_file(i.path())) {
+                               LOG_GENERAL ("Inside there's regular file %1", i.path().string());
+                               add_path (i.path());
+                       } else if (is_directory(i.path()) && i.path().filename() != ".AppleDouble") {
+                               LOG_GENERAL ("Inside there's directory %1", i.path().string());
+                               read_sub_directory (i.path());
+                       } else {
+                               LOG_GENERAL("Ignoring %1 from inside: status is %2", i.path().string(), static_cast<int>(status(i.path()).type()));
+                       }
                }
+       } catch (exception& e) {
+               LOG_GENERAL("Failed to iterate over %1: %2", p.string(), e.what());
        }
 }
 
@@ -213,6 +230,11 @@ DCPContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
        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);
@@ -244,6 +266,8 @@ DCPContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
                auto m = as->mapping ();
                m.make_default (film ? film->audio_processor() : 0);
                as->set_mapping (m);
+
+               _active_audio_channels = examiner->active_audio_channels();
        }
 
        if (examiner->has_atmos()) {
@@ -258,18 +282,19 @@ DCPContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
                atmos->set_length (examiner->atmos_length());
        }
 
-       list<shared_ptr<TextContent>> new_text;
+       vector<shared_ptr<TextContent>> new_text;
 
        for (int i = 0; i < examiner->text_count(TextType::OPEN_SUBTITLE); ++i) {
                auto c = make_shared<TextContent>(this, TextType::OPEN_SUBTITLE, TextType::OPEN_SUBTITLE);
                c->set_language (examiner->open_subtitle_language());
-               add_fonts_from_examiner(c, examiner->fonts());
+               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<TextContent>(this, TextType::CLOSED_CAPTION, TextType::CLOSED_CAPTION);
                c->set_dcp_track (examiner->dcp_text_track(i));
+               examiner->add_fonts(c);
                new_text.push_back (c);
        }
 
@@ -290,6 +315,7 @@ DCPContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
                }
                _ratings = examiner->ratings ();
                _content_versions = examiner->content_versions ();
+               _has_non_zero_entry_point = examiner->has_non_zero_entry_point();
        }
 
        if (needed_assets == needs_assets()) {
@@ -329,83 +355,98 @@ DCPContent::technical_summary () const
        return s;
 }
 
+
 void
-DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
+DCPContent::as_xml(xmlpp::Element* element, bool with_paths) const
 {
-       node->add_child("Type")->add_child_text ("DCP");
+       cxml::add_text_child(element, "Type", "DCP");
 
-       Content::as_xml (node, with_paths);
+       Content::as_xml(element, with_paths);
 
        if (video) {
-               video->as_xml (node);
+               video->as_xml(element);
        }
 
        if (audio) {
-               audio->as_xml (node);
-               node->add_child("AudioFrameRate")->add_child_text (raw_convert<string> (audio->stream()->frame_rate()));
-               node->add_child("AudioLength")->add_child_text (raw_convert<string> (audio->stream()->length()));
-               audio->stream()->mapping().as_xml (node->add_child("AudioMapping"));
+               audio->as_xml(element);
+               cxml::add_text_child(element, "AudioFrameRate", raw_convert<string>(audio->stream()->frame_rate()));
+               cxml::add_text_child(element, "AudioLength", raw_convert<string>(audio->stream()->length()));
+               audio->stream()->mapping().as_xml(cxml::add_child(element, "AudioMapping"));
        }
 
        for (auto i: text) {
-               i->as_xml (node);
+               i->as_xml(element);
        }
 
        if (atmos) {
-               atmos->as_xml (node);
+               atmos->as_xml(element);
        }
 
        boost::mutex::scoped_lock lm (_mutex);
-       node->add_child("Name")->add_child_text (_name);
-       node->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
-       node->add_child("NeedsAssets")->add_child_text (_needs_assets ? "1" : "0");
+
+       cxml::add_text_child(element, "Name", _name);
+       cxml::add_text_child(element, "Encrypted", _encrypted ? "1" : "0");
+       cxml::add_text_child(element, "NeedsAssets", _needs_assets ? "1" : "0");
        if (_kdm) {
-               node->add_child("KDM")->add_child_text (_kdm->as_xml ());
+               cxml::add_text_child(element, "KDM", _kdm->as_xml());
        }
-       node->add_child("KDMValid")->add_child_text (_kdm_valid ? "1" : "0");
-       node->add_child("ReferenceVideo")->add_child_text (_reference_video ? "1" : "0");
-       node->add_child("ReferenceAudio")->add_child_text (_reference_audio ? "1" : "0");
-       node->add_child("ReferenceOpenSubtitle")->add_child_text(_reference_text[TextType::OPEN_SUBTITLE] ? "1" : "0");
-       node->add_child("ReferenceClosedCaption")->add_child_text(_reference_text[TextType::CLOSED_CAPTION] ? "1" : "0");
+       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:
-                       node->add_child("Standard")->add_child_text ("Interop");
+                       cxml::add_text_child(element, "Standard", "Interop");
                        break;
                case dcp::Standard::SMPTE:
-                       node->add_child("Standard")->add_child_text ("SMPTE");
+                       cxml::add_text_child(element, "Standard", "SMPTE");
                        break;
                default:
                        DCPOMATIC_ASSERT (false);
                }
        }
-       node->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
+       cxml::add_text_child(element, "ThreeD", _three_d ? "1" : "0");
        if (_content_kind) {
-               node->add_child("ContentKind")->add_child_text(_content_kind->name());
+               cxml::add_text_child(element, "ContentKind", _content_kind->name());
        }
        if (_cpl) {
-               node->add_child("CPL")->add_child_text (_cpl.get ());
+               cxml::add_text_child(element, "CPL", _cpl.get());
        }
        for (auto i: _reel_lengths) {
-               node->add_child("ReelLength")->add_child_text (raw_convert<string> (i));
+               cxml::add_text_child(element, "ReelLength", raw_convert<string>(i));
        }
 
        for (auto const& i: _markers) {
-               auto marker = node->add_child("Marker");
+               auto marker = cxml::add_child(element, "Marker");
                marker->set_attribute("type", dcp::marker_to_string(i.first));
                marker->add_child_text(raw_convert<string>(i.second.get()));
        }
 
        for (auto i: _ratings) {
-               auto rating = node->add_child("Rating");
+               auto rating = cxml::add_child(element, "Rating");
                i.as_xml (rating);
        }
 
        for (auto i: _content_versions) {
-               node->add_child("ContentVersion")->add_child_text(i);
+               cxml::add_text_child(element, "ContentVersion", i);
+       }
+
+       if (_active_audio_channels) {
+               cxml::add_text_child(element, "ActiveAudioChannels", raw_convert<string>(*_active_audio_channels));
+       }
+
+       for (auto i = 0; i < static_cast<int>(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<TextType>(i)));
+               }
        }
 }
 
+
 DCPTime
 DCPContent::full_length (shared_ptr<const Film> film) const
 {
@@ -438,6 +479,8 @@ DCPContent::identifier () const
                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");
@@ -587,7 +630,7 @@ DCPContent::reel_split_points (shared_ptr<const Film> film) const
 }
 
 bool
-DCPContent::can_reference (shared_ptr<const Film> film, function<bool (shared_ptr<const Content>)> part, string overlapping, string& why_not) const
+DCPContent::can_reference_anything(shared_ptr<const Film> film, string& why_not) const
 {
        /* We must be using the same standard as the film */
        if (_standard) {
@@ -633,21 +676,17 @@ DCPContent::can_reference (shared_ptr<const Film> film, function<bool (shared_pt
                }
        }
 
-       auto a = overlaps (film, film->content(), part, position(), end(film));
-       if (a.size() != 1 || a.front().get() != this) {
-               why_not = overlapping;
-               return false;
-       }
-
        return true;
 }
 
-static
-bool check_video (shared_ptr<const Content> c)
+bool
+DCPContent::overlaps(shared_ptr<const Film> film, function<bool (shared_ptr<const Content>)> part) const
 {
-       return static_cast<bool>(c->video) && c->video->use();
+       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<const Film> film, string& why_not) const
 {
@@ -671,91 +710,58 @@ DCPContent::can_reference_video (shared_ptr<const Film> film, string& why_not) c
                return false;
        }
 
-       /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
-       return can_reference (film, bind (&check_video, _1), _("it overlaps other video content; remove the other content."), why_not);
-}
+       auto part = [](shared_ptr<const Content> c) {
+               return static_cast<bool>(c->video) && c->video->use();
+       };
 
-static
-bool check_audio (shared_ptr<const Content> c)
-{
-       return static_cast<bool>(c->audio) && !c->audio->mapping().mapped_output_channels().empty();
+       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<const Film> film, string& why_not) const
 {
-       shared_ptr<DCPDecoder> decoder;
-       try {
-               decoder = make_shared<DCPDecoder>(film, shared_from_this(), false, film->tolerant(), shared_ptr<DCPDecoder>());
-       } catch (dcp::ReadError &) {
-               /* We couldn't read the DCP, so it's probably missing */
-               return false;
-       } catch (DCPError &) {
-               /* We couldn't read the DCP, so it's probably missing */
-               return false;
-       } catch (dcp::KDMDecryptionError &) {
-               /* We have an incorrect KDM */
-               return false;
+       if (audio && audio->stream()) {
+               auto const channels = audio->stream()->channels();
+               if (channels != film->audio_channels()) {
+                       why_not = String::compose(_("it has a different number of audio channels than the project; set the project to have %1 channels."), channels);
+                       return false;
+               }
        }
 
-        for (auto i: decoder->reels()) {
-                if (!i->main_sound()) {
-                       /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
-                        why_not = _("it does not have sound in all its reels.");
-                        return false;
-                }
-        }
+       auto part = [](shared_ptr<const Content> c) {
+               return static_cast<bool>(c->audio) && !c->audio->mapping().mapped_output_channels().empty();
+       };
 
-       /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
-       return can_reference (film, bind (&check_audio, _1), _("it overlaps other audio content; remove the other content."), why_not);
-}
+       if (overlaps(film, part)) {
+               /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
+               why_not = _("it overlaps other audio content.");
+               return false;
+       }
 
-static
-bool check_text (shared_ptr<const Content> c)
-{
-       return !c->text.empty();
+       return can_reference_anything(film, why_not);
 }
 
+
 bool
 DCPContent::can_reference_text (shared_ptr<const Film> film, TextType type, string& why_not) const
 {
-       shared_ptr<DCPDecoder> decoder;
-       try {
-               decoder = make_shared<DCPDecoder>(film, shared_from_this(), false, film->tolerant(), shared_ptr<DCPDecoder>());
-       } catch (dcp::ReadError &) {
-               /* We couldn't read the DCP, so it's probably missing */
-               return false;
-       } catch (dcp::KDMDecryptionError &) {
-               /* We have an incorrect KDM */
+       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;
        }
 
-        for (auto i: decoder->reels()) {
-                if (type == TextType::OPEN_SUBTITLE) {
-                       if (!i->main_subtitle()) {
-                               /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
-                               why_not = _("it does not have open subtitles in all its reels.");
-                               return false;
-                       } else if (i->main_subtitle()->entry_point().get_value_or(0) != 0) {
-                               /// 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 (type == TextType::CLOSED_CAPTION) {
-                       if (i->closed_captions().empty()) {
-                               /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
-                               why_not = _("it does not have closed captions in all its reels.");
-                               return false;
-                       }
-                       for (auto j: i->closed_captions()) {
-                               if (j->entry_point().get_value_or(0) != 0) {
-                                       /// 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 (_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()) {
@@ -764,8 +770,17 @@ DCPContent::can_reference_text (shared_ptr<const Film> film, TextType type, stri
                return false;
        }
 
-       /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
-       return can_reference (film, bind (&check_text, _1), _("it overlaps other text content; remove the other content."), why_not);
+       auto part = [type](shared_ptr<const Content> c) {
+               return std::find_if(c->text.begin(), c->text.end(), [type](shared_ptr<const TextContent> 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
@@ -776,6 +791,13 @@ DCPContent::take_settings_from (shared_ptr<const Content> c)
                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;
@@ -807,7 +829,7 @@ DCPContent::kdm_timing_window_valid () const
 Resolution
 DCPContent::resolution () const
 {
-       if (video->size().width > 2048 || video->size().height > 1080) {
+       if (video->size() && (video->size()->width > 2048 || video->size()->height > 1080)) {
                return Resolution::FOUR_K;
        }
 
@@ -815,32 +837,6 @@ DCPContent::resolution () const
 }
 
 
-void
-add_fonts_from_examiner(shared_ptr<TextContent> text, vector<vector<shared_ptr<Font>>> const & all_fonts)
-{
-       int reel_number = 0;
-       for (auto reel_fonts: all_fonts) {
-               for (auto font: reel_fonts) {
-                       /* Each reel could have its own font with the same ID, so we disambiguate them here
-                        * by prepending the reel number.  We do the same disambiguation when emitting the
-                        * subtitles in the DCP decoder.
-                        */
-                       font->set_id(id_for_font_in_reel(font->id(), reel_number));
-                       text->add_font(font);
-               }
-               ++reel_number;
-       }
-
-}
-
-
-string
-id_for_font_in_reel(string id, int reel)
-{
-       return String::compose("%1_%2", reel, id);
-}
-
-
 void
 DCPContent::check_font_ids()
 {
@@ -849,6 +845,15 @@ DCPContent::check_font_ids()
        }
 
        DCPExaminer examiner(shared_from_this(), true);
-       add_fonts_from_examiner(text.front(), examiner.fonts());
+       examiner.add_fonts(text.front());
+}
+
+
+int
+DCPContent::active_audio_channels() const
+{
+       return _active_audio_channels.get_value_or(
+               (audio && audio->stream()) ? audio->stream()->channels() : 0
+               );
 }