Supporters update.
[dcpomatic.git] / src / lib / dcp_content.cc
index f6a74501c7cae8b13102e0f9a586bd9bd08d90cf..bdd5e0e091c0aa6b523ec7c7400ec9449beef3a0 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2014-2020 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2023 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 
 */
 
+
 #include "atmos_content.h"
-#include "dcp_content.h"
-#include "video_content.h"
 #include "audio_content.h"
-#include "dcp_examiner.h"
-#include "job.h"
-#include "film.h"
-#include "config.h"
-#include "overlaps.h"
 #include "compose.hpp"
+#include "config.h"
+#include "dcp_content.h"
 #include "dcp_decoder.h"
-#include "log.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 <dcp/dcp.h>
 #include <dcp/raw_convert.h>
 #include <dcp/exceptions.h>
 #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>
 
 #include "i18n.h"
 
+
 using std::cout;
-using std::distance;
+using std::dynamic_pointer_cast;
+using std::exception;
+using std::function;
 using std::list;
 using std::make_shared;
-using std::map;
-using std::pair;
 using std::shared_ptr;
 using std::string;
 using std::vector;
-using boost::scoped_ptr;
 using boost::optional;
-using std::function;
-using std::dynamic_pointer_cast;
+using boost::scoped_ptr;
 #if BOOST_VERSION >= 106100
 using namespace boost::placeholders;
 #endif
 using dcp::raw_convert;
 using namespace dcpomatic;
 
+
 int const DCPContentProperty::NEEDS_ASSETS       = 600;
 int const DCPContentProperty::NEEDS_KDM          = 601;
 int const DCPContentProperty::REFERENCE_VIDEO    = 602;
@@ -73,6 +75,7 @@ int const DCPContentProperty::NAME               = 605;
 int const DCPContentProperty::TEXTS              = 606;
 int const DCPContentProperty::CPL                = 607;
 
+
 DCPContent::DCPContent (boost::filesystem::path p)
        : _encrypted (false)
        , _needs_assets (false)
@@ -85,24 +88,17 @@ DCPContent::DCPContent (boost::filesystem::path p)
 
        read_directory (p);
        set_default_colour_conversion ();
-
-       for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
-               _reference_text[i] = false;
-       }
 }
 
 DCPContent::DCPContent (cxml::ConstNodePtr node, int version)
        : Content (node)
 {
-       video = VideoContent::from_xml (this, node, version);
+       video = VideoContent::from_xml (this, node, version, VideoRange::FULL);
        audio = AudioContent::from_xml (this, node, version);
-       text = TextContent::from_xml (this, node, version);
+       list<string> notes;
+       text = TextContent::from_xml (this, node, version, notes);
        atmos = AtmosContent::from_xml (this, node);
 
-       for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
-               _reference_text[i] = false;
-       }
-
        if (video && audio) {
                audio->set_stream (
                        make_shared<AudioStream> (
@@ -111,7 +107,8 @@ DCPContent::DCPContent (cxml::ConstNodePtr node, int version)
                                node->optional_number_child<Frame>("AudioLength").get_value_or (
                                        video->length() * node->number_child<int>("AudioFrameRate") / video_frame_rate().get()
                                        ),
-                               AudioMapping (node->node_child ("AudioMapping"), version)
+                               AudioMapping(node->node_child("AudioMapping"), version),
+                               24
                                )
                        );
        }
@@ -126,11 +123,11 @@ DCPContent::DCPContent (cxml::ConstNodePtr node, int version)
        _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[static_cast<int>(TextType::OPEN_SUBTITLE)] = node->optional_bool_child("ReferenceOpenSubtitle").get_value_or(false);
-               _reference_text[static_cast<int>(TextType::CLOSED_CAPTION)] = node->optional_bool_child("ReferenceClosedCaption").get_value_or(false);
+               _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[static_cast<int>(TextType::OPEN_SUBTITLE)] = node->optional_bool_child("ReferenceSubtitle").get_value_or(false);
-               _reference_text[static_cast<int>(TextType::CLOSED_CAPTION)] = false;
+               _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();
@@ -146,7 +143,7 @@ DCPContent::DCPContent (cxml::ConstNodePtr node, int version)
 
        auto ck = node->optional_string_child("ContentKind");
        if (ck) {
-               _content_kind = dcp::content_kind_from_string (*ck);
+               _content_kind = dcp::ContentKind::from_name(*ck);
        }
        _cpl = node->optional_string_child("CPL");
        for (auto i: node->node_children("ReelLength")) {
@@ -164,6 +161,8 @@ 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");
 }
 
 void
@@ -174,10 +173,10 @@ DCPContent::read_directory (boost::filesystem::path p)
        bool have_assetmap = false;
        bool have_metadata = false;
 
-       for (directory_iterator i(p); i != directory_iterator(); ++i) {
-               if (i->path().filename() == "ASSETMAP" || i->path().filename() == "ASSETMAP.xml") {
+       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") {
+               } else if (i.path().filename() == "metadata.xml") {
                        have_metadata = true;
                }
        }
@@ -196,15 +195,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())) {
-                       LOG_GENERAL ("Inside there's directory %1", i.path().string());
-                       read_sub_directory (i.path());
+       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());
        }
 }
 
@@ -216,6 +223,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);
@@ -233,7 +245,7 @@ DCPContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
                        boost::mutex::scoped_lock lm (_mutex);
                        video = make_shared<VideoContent>(this);
                }
-               video->take_from_examiner (examiner);
+               video->take_from_examiner(film, examiner);
                set_default_colour_conversion ();
        }
 
@@ -242,12 +254,13 @@ DCPContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
                        boost::mutex::scoped_lock lm (_mutex);
                        audio = make_shared<AudioContent>(this);
                }
-               audio->set_language (examiner->audio_language());
-               auto as = make_shared<AudioStream>(examiner->audio_frame_rate(), examiner->audio_length(), examiner->audio_channels());
+               auto as = make_shared<AudioStream>(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();
        }
 
        if (examiner->has_atmos()) {
@@ -262,17 +275,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());
+               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);
        }
 
@@ -359,6 +374,7 @@ DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
        }
 
        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");
@@ -368,8 +384,8 @@ DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
        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[static_cast<int>(TextType::OPEN_SUBTITLE)] ? "1" : "0");
-       node->add_child("ReferenceClosedCaption")->add_child_text(_reference_text[static_cast<int>(TextType::CLOSED_CAPTION)] ? "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");
        if (_standard) {
                switch (_standard.get ()) {
                case dcp::Standard::INTEROP:
@@ -384,7 +400,7 @@ DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
        }
        node->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
        if (_content_kind) {
-               node->add_child("ContentKind")->add_child_text(dcp::content_kind_to_string(*_content_kind));
+               node->add_child("ContentKind")->add_child_text(_content_kind->name());
        }
        if (_cpl) {
                node->add_child("CPL")->add_child_text (_cpl.get ());
@@ -407,6 +423,10 @@ DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
        for (auto i: _content_versions) {
                node->add_child("ContentVersion")->add_child_text(i);
        }
+
+       if (_active_audio_channels) {
+               node->add_child("ActiveAudioChannels")->add_child_text(raw_convert<string>(*_active_audio_channels));
+       }
 }
 
 DCPTime
@@ -441,9 +461,11 @@ DCPContent::identifier () const
                s += i->identifier () + " ";
        }
 
+       boost::mutex::scoped_lock lm(_mutex);
+
        s += string (_reference_video ? "1" : "0");
-       for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
-               s += string (_reference_text[i] ? "1" : "0");
+       for (auto text: _reference_text) {
+               s += string(text ? "1" : "0");
        }
        return s;
 }
@@ -536,7 +558,7 @@ DCPContent::set_reference_text (TextType type, bool r)
 
        {
                boost::mutex::scoped_lock lm (_mutex);
-               _reference_text[static_cast<int>(type)] = r;
+               _reference_text[type] = r;
        }
 }
 
@@ -645,11 +667,6 @@ DCPContent::can_reference (shared_ptr<const Film> film, function<bool (shared_pt
        return true;
 }
 
-static
-bool check_video (shared_ptr<const Content> c)
-{
-       return static_cast<bool>(c->video) && c->video->use();
-}
 
 bool
 DCPContent::can_reference_video (shared_ptr<const Film> film, string& why_not) const
@@ -675,21 +692,23 @@ DCPContent::can_reference_video (shared_ptr<const Film> film, string& why_not) c
        }
 
        /// 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);
+       return can_reference(
+               film,
+               [](shared_ptr<const Content> c) {
+                       return static_cast<bool>(c->video) && c->video->use();
+               },
+               _("it overlaps other video content; remove the other content."),
+               why_not
+       );
 }
 
-static
-bool check_audio (shared_ptr<const Content> c)
-{
-       return static_cast<bool>(c->audio) && !c->audio->mapping().mapped_output_channels().empty();
-}
 
 bool
 DCPContent::can_reference_audio (shared_ptr<const Film> film, string& why_not) const
 {
        shared_ptr<DCPDecoder> decoder;
        try {
-               decoder.reset (new DCPDecoder (film, shared_from_this(), false, film->tolerant(), shared_ptr<DCPDecoder>()));
+               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;
@@ -701,33 +720,37 @@ DCPContent::can_reference_audio (shared_ptr<const Film> film, string& why_not) c
                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;
-                }
-        }
+       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;
+               }
+       }
 
        /// 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);
+       return can_reference(
+               film, [](shared_ptr<const Content> c) {
+                       return static_cast<bool>(c->audio) && !c->audio->mapping().mapped_output_channels().empty();
+               },
+               _("it overlaps other audio content; remove the other content."),
+               why_not
+       );
 }
 
-static
-bool check_text (shared_ptr<const Content> c)
-{
-       return !c->text.empty();
-}
 
 bool
 DCPContent::can_reference_text (shared_ptr<const Film> film, TextType type, string& why_not) const
 {
        shared_ptr<DCPDecoder> decoder;
        try {
-               decoder.reset (new DCPDecoder (film, shared_from_this(), false, film->tolerant(), shared_ptr<DCPDecoder>()));
+               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;
@@ -735,26 +758,17 @@ DCPContent::can_reference_text (shared_ptr<const Film> film, TextType type, stri
 
         for (auto i: decoder->reels()) {
                 if (type == TextType::OPEN_SUBTITLE) {
-                       if (!i->main_subtitle()) {
+                       if (i->main_subtitle() && i->main_subtitle()->entry_point().get_value_or(0) != 0) {
                                /// 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 if its subtitle reels has a non-zero entry point so it must be re-written.");
+                               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 if its closed caption has a non-zero entry point so it must be re-written.");
+                                       why_not = _("one of its closed caption has a non-zero entry point so it must be re-written.");
                                        return false;
                                }
                        }
@@ -768,7 +782,14 @@ DCPContent::can_reference_text (shared_ptr<const Film> film, TextType type, stri
        }
 
        /// 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);
+       return can_reference(
+               film,
+               [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();
+               },
+               _("they overlap other text content; remove the other content."),
+               why_not
+       );
 }
 
 void
@@ -779,11 +800,16 @@ 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;
-       for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
-               _reference_text[i] = dc->_reference_text[i];
-       }
+       _reference_text = dc->_reference_text;
 }
 
 void
@@ -812,10 +838,31 @@ 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;
        }
 
        return Resolution::TWO_K;
 }
 
+
+void
+DCPContent::check_font_ids()
+{
+       if (text.empty()) {
+               return;
+       }
+
+       DCPExaminer examiner(shared_from_this(), true);
+       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
+               );
+}
+