Basic and rather clumsy option to respect KDM validity windows.
[dcpomatic.git] / src / lib / dcp_content.cc
index d4891ad457849a4db38b2a94a7540abe23b9ce03..3498cc96119940bbd2a25a4546c0c1fc0bc56662 100644 (file)
@@ -58,9 +58,10 @@ int const DCPContentProperty::NEEDS_ASSETS       = 600;
 int const DCPContentProperty::NEEDS_KDM          = 601;
 int const DCPContentProperty::REFERENCE_VIDEO    = 602;
 int const DCPContentProperty::REFERENCE_AUDIO    = 603;
-int const DCPContentProperty::REFERENCE_SUBTITLE = 604;
+int const DCPContentProperty::REFERENCE_TEXT     = 604;
 int const DCPContentProperty::NAME               = 605;
-int const DCPContentProperty::HAS_SUBTITLES      = 606;
+int const DCPContentProperty::TEXTS              = 606;
+int const DCPContentProperty::CPL                = 607;
 
 DCPContent::DCPContent (shared_ptr<const Film> film, boost::filesystem::path p)
        : Content (film)
@@ -69,11 +70,14 @@ DCPContent::DCPContent (shared_ptr<const Film> film, boost::filesystem::path p)
        , _kdm_valid (false)
        , _reference_video (false)
        , _reference_audio (false)
-       , _reference_subtitle (false)
        , _three_d (false)
 {
        read_directory (p);
        set_default_colour_conversion ();
+
+       for (int i = 0; i < TEXT_COUNT; ++i) {
+               _reference_text[i] = false;
+       }
 }
 
 DCPContent::DCPContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version)
@@ -81,7 +85,11 @@ DCPContent::DCPContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, in
 {
        video = VideoContent::from_xml (this, node, version);
        audio = AudioContent::from_xml (this, node, version);
-       subtitle = TextContent::from_xml (this, node, version);
+       text = TextContent::from_xml (this, node, version);
+
+       for (int i = 0; i < TEXT_COUNT; ++i) {
+               _reference_text[i] = false;
+       }
 
        if (video && audio) {
                audio->set_stream (
@@ -107,7 +115,13 @@ DCPContent::DCPContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, in
        _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);
-       _reference_subtitle = node->optional_bool_child ("ReferenceSubtitle").get_value_or (false);
+       if (version >= 37) {
+               _reference_text[TEXT_OPEN_SUBTITLE] = node->optional_bool_child("ReferenceOpenSubtitle").get_value_or(false);
+               _reference_text[TEXT_CLOSED_CAPTION] = node->optional_bool_child("ReferenceClosedCaption").get_value_or(false);
+       } else {
+               _reference_text[TEXT_OPEN_SUBTITLE] = node->optional_bool_child("ReferenceSubtitle").get_value_or(false);
+               _reference_text[TEXT_CLOSED_CAPTION] = false;
+       }
        if (node->optional_string_child("Standard")) {
                string const s = node->optional_string_child("Standard").get();
                if (s == "Interop") {
@@ -130,7 +144,7 @@ DCPContent::read_directory (boost::filesystem::path p)
 {
        for (boost::filesystem::directory_iterator i(p); i != boost::filesystem::directory_iterator(); ++i) {
                if (boost::filesystem::is_regular_file (i->path())) {
-                       _paths.push_back (i->path());
+                       add_path (i->path());
                } else if (boost::filesystem::is_directory (i->path ())) {
                        read_directory (i->path());
                }
@@ -143,7 +157,13 @@ DCPContent::examine (shared_ptr<Job> job)
        bool const needed_assets = needs_assets ();
        bool const needed_kdm = needs_kdm ();
        string const old_name = name ();
-       bool had_subtitles = static_cast<bool> (subtitle);
+       int const old_texts = text.size ();
+
+       ChangeSignaller<Content> cc_texts (this, DCPContentProperty::TEXTS);
+       ChangeSignaller<Content> cc_assets (this, DCPContentProperty::NEEDS_ASSETS);
+       ChangeSignaller<Content> cc_kdm (this, DCPContentProperty::NEEDS_KDM);
+       ChangeSignaller<Content> cc_name (this, DCPContentProperty::NAME);
+       ChangeSignaller<Content> cc_streams (this, AudioContentProperty::STREAMS);
 
        if (job) {
                job->set_progress_unknown ();
@@ -162,6 +182,7 @@ DCPContent::examine (shared_ptr<Job> job)
        }
 
        if (examiner->has_audio()) {
+               ChangeSignaller<Content> cc (this, AudioContentProperty::STREAMS);
                {
                        boost::mutex::scoped_lock lm (_mutex);
                        audio.reset (new AudioContent (this));
@@ -171,19 +192,18 @@ DCPContent::examine (shared_ptr<Job> job)
                AudioMapping m = as->mapping ();
                film()->make_audio_mapping_default (m);
                as->set_mapping (m);
-               signal_changed (AudioContentProperty::STREAMS);
        }
 
-       bool has_subtitles = false;
+       int texts = 0;
        {
                boost::mutex::scoped_lock lm (_mutex);
                _name = examiner->name ();
-               if (examiner->has_subtitles ()) {
-                       subtitle.reset (new TextContent (this));
-               } else {
-                       subtitle.reset ();
+               for (int i = 0; i < TEXT_COUNT; ++i) {
+                       if (examiner->has_text(static_cast<TextType>(i))) {
+                               text.push_back (shared_ptr<TextContent>(new TextContent(this, static_cast<TextType>(i), static_cast<TextType>(i))));
+                       }
                }
-               has_subtitles = static_cast<bool> (subtitle);
+               texts = text.size ();
                _encrypted = examiner->encrypted ();
                _needs_assets = examiner->needs_assets ();
                _kdm_valid = examiner->kdm_valid ();
@@ -193,24 +213,22 @@ DCPContent::examine (shared_ptr<Job> job)
                _reel_lengths = examiner->reel_lengths ();
        }
 
-       if (had_subtitles != has_subtitles) {
-               signal_changed (DCPContentProperty::HAS_SUBTITLES);
+       if (old_texts == texts) {
+               cc_texts.abort ();
        }
 
-       if (needed_assets != needs_assets ()) {
-               signal_changed (DCPContentProperty::NEEDS_ASSETS);
+       if (needed_assets == needs_assets()) {
+               cc_assets.abort ();
        }
 
-       if (needed_kdm != needs_kdm ()) {
-               signal_changed (DCPContentProperty::NEEDS_KDM);
+       if (needed_kdm == needs_kdm()) {
+               cc_kdm.abort ();
        }
 
-       if (old_name != name ()) {
-               signal_changed (DCPContentProperty::NAME);
+       if (old_name == name()) {
+               cc_name.abort ();
        }
 
-       signal_changed (AudioContentProperty::STREAMS);
-
        if (video) {
                video->set_frame_type (_three_d ? VIDEO_FRAME_TYPE_3D : VIDEO_FRAME_TYPE_2D);
        }
@@ -254,8 +272,8 @@ DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
                audio->stream()->mapping().as_xml (node->add_child("AudioMapping"));
        }
 
-       if (subtitle) {
-               subtitle->as_xml (node);
+       BOOST_FOREACH (shared_ptr<TextContent> i, text) {
+               i->as_xml (node);
        }
 
        boost::mutex::scoped_lock lm (_mutex);
@@ -268,7 +286,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("ReferenceSubtitle")->add_child_text (_reference_subtitle ? "1" : "0");
+       node->add_child("ReferenceOpenSubtitle")->add_child_text(_reference_text[TEXT_OPEN_SUBTITLE] ? "1" : "0");
+       node->add_child("ReferenceClosedCaption")->add_child_text(_reference_text[TEXT_CLOSED_CAPTION] ? "1" : "0");
        if (_standard) {
                switch (_standard.get ()) {
                case dcp::INTEROP:
@@ -309,11 +328,14 @@ DCPContent::identifier () const
                s += video->identifier() + "_";
        }
 
-       if (subtitle) {
-               s += subtitle->identifier () + " ";
+       BOOST_FOREACH (shared_ptr<TextContent> i, text) {
+               s += i->identifier () + " ";
        }
 
-       s += string (_reference_video ? "1" : "0") + string (_reference_subtitle ? "1" : "0");
+       s += string (_reference_video ? "1" : "0");
+       for (int i = 0; i < TEXT_COUNT; ++i) {
+               s += string (_reference_text[i] ? "1" : "0");
+       }
        return s;
 }
 
@@ -379,34 +401,34 @@ DCPContent::set_default_colour_conversion ()
 void
 DCPContent::set_reference_video (bool r)
 {
+       ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_VIDEO);
+
        {
                boost::mutex::scoped_lock lm (_mutex);
                _reference_video = r;
        }
-
-       signal_changed (DCPContentProperty::REFERENCE_VIDEO);
 }
 
 void
 DCPContent::set_reference_audio (bool r)
 {
+       ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_AUDIO);
+
        {
                boost::mutex::scoped_lock lm (_mutex);
                _reference_audio = r;
        }
-
-       signal_changed (DCPContentProperty::REFERENCE_AUDIO);
 }
 
 void
-DCPContent::set_reference_subtitle (bool r)
+DCPContent::set_reference_text (TextType type, bool r)
 {
+       ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_TEXT);
+
        {
                boost::mutex::scoped_lock lm (_mutex);
-               _reference_subtitle = r;
+               _reference_text[type] = r;
        }
-
-       signal_changed (DCPContentProperty::REFERENCE_SUBTITLE);
 }
 
 list<DCPTimePeriod>
@@ -459,7 +481,7 @@ DCPContent::reel_split_points () const
 }
 
 bool
-DCPContent::can_reference (function<shared_ptr<ContentPart> (shared_ptr<const Content>)> part, string overlapping, string& why_not) const
+DCPContent::can_reference (function<bool (shared_ptr<const Content>)> part, string overlapping, string& why_not) const
 {
        /* We must be using the same standard as the film */
        if (_standard) {
@@ -514,6 +536,12 @@ DCPContent::can_reference (function<shared_ptr<ContentPart> (shared_ptr<const Co
        return true;
 }
 
+static
+bool check_video (shared_ptr<const Content> c)
+{
+       return static_cast<bool>(c->video);
+}
+
 bool
 DCPContent::can_reference_video (string& why_not) const
 {
@@ -529,7 +557,13 @@ DCPContent::can_reference_video (string& why_not) const
        }
 
        /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
-       return can_reference (bind (&Content::video, _1), _("it overlaps other video content; remove the other content."), why_not);
+       return can_reference (bind (&check_video, _1), _("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);
 }
 
 bool
@@ -558,11 +592,17 @@ DCPContent::can_reference_audio (string& why_not) const
         }
 
        /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
-        return can_reference (bind (&Content::audio, _1), _("it overlaps other audio content; remove the other content."), why_not);
+       return can_reference (bind (&check_audio, _1), _("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_subtitle (string& why_not) const
+DCPContent::can_reference_text (TextType type, string& why_not) const
 {
        shared_ptr<DCPDecoder> decoder;
        try {
@@ -576,15 +616,20 @@ DCPContent::can_reference_subtitle (string& why_not) const
        }
 
         BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
-                if (!i->main_subtitle()) {
+                if (type == TEXT_OPEN_SUBTITLE && !i->main_subtitle()) {
                        /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
-                        why_not = _("it does not have subtitles in all its reels.");
+                        why_not = _("it does not have open subtitles in all its reels.");
                         return false;
                 }
+               if (type == TEXT_CLOSED_CAPTION && 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;
+               }
         }
 
        /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
-       return can_reference (bind (&Content::subtitle, _1), _("it overlaps other subtitle content; remove the other content."), why_not);
+       return can_reference (bind (&check_text, _1), _("it overlaps other text content; remove the other content."), why_not);
 }
 
 void
@@ -597,12 +642,29 @@ DCPContent::take_settings_from (shared_ptr<const Content> c)
 
        _reference_video = dc->_reference_video;
        _reference_audio = dc->_reference_audio;
-       _reference_subtitle = dc->_reference_subtitle;
+       for (int i = 0; i < TEXT_COUNT; ++i) {
+               _reference_text[i] = dc->_reference_text[i];
+       }
 }
 
 void
 DCPContent::set_cpl (string id)
 {
-       boost::mutex::scoped_lock lm (_mutex);
-       _cpl = id;
+       ChangeSignaller<Content> 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();
 }