Better error message when loading a DCP with no ASSETMAP{,.xml}
[dcpomatic.git] / src / lib / dcp_content.cc
index 414a2225605ea599b2e11072c20b409c23680666..cc636b0bfb0d5bd40965935aa31296ad114cdcc7 100644 (file)
@@ -28,7 +28,8 @@
 #include "overlaps.h"
 #include "compose.hpp"
 #include "dcp_decoder.h"
-#include "caption_content.h"
+#include "log.h"
+#include "text_content.h"
 #include <dcp/dcp.h>
 #include <dcp/raw_convert.h>
 #include <dcp/exceptions.h>
@@ -58,9 +59,12 @@ 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_CAPTION  = 604;
+int const DCPContentProperty::REFERENCE_TEXT     = 604;
 int const DCPContentProperty::NAME               = 605;
-int const DCPContentProperty::CAPTIONS           = 606;
+int const DCPContentProperty::TEXTS              = 606;
+int const DCPContentProperty::CPL                = 607;
+
+#define LOG_GENERAL(...) this->film()->log()->log(String::compose(__VA_ARGS__), LogEntry::TYPE_GENERAL);
 
 DCPContent::DCPContent (shared_ptr<const Film> film, boost::filesystem::path p)
        : Content (film)
@@ -71,11 +75,13 @@ DCPContent::DCPContent (shared_ptr<const Film> film, boost::filesystem::path p)
        , _reference_audio (false)
        , _three_d (false)
 {
+       LOG_GENERAL ("Creating DCP content from %1", p.string());
+
        read_directory (p);
        set_default_colour_conversion ();
 
-       for (int i = 0; i < CAPTION_COUNT; ++i) {
-               _reference_caption[i] = false;
+       for (int i = 0; i < TEXT_COUNT; ++i) {
+               _reference_text[i] = false;
        }
 }
 
@@ -84,10 +90,10 @@ 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);
-       caption = CaptionContent::from_xml (this, node, version);
+       text = TextContent::from_xml (this, node, version);
 
-       for (int i = 0; i < CAPTION_COUNT; ++i) {
-               _reference_caption[i] = false;
+       for (int i = 0; i < TEXT_COUNT; ++i) {
+               _reference_text[i] = false;
        }
 
        if (video && audio) {
@@ -115,11 +121,11 @@ DCPContent::DCPContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, in
        _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_caption[CAPTION_OPEN] = node->optional_bool_child("ReferenceOpenCaption").get_value_or(false);
-               _reference_caption[CAPTION_CLOSED] = node->optional_bool_child("ReferenceClosedCaption").get_value_or(false);
+               _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_caption[CAPTION_OPEN] = node->optional_bool_child("ReferenceSubtitle").get_value_or(false);
-               _reference_caption[CAPTION_CLOSED] = false;
+               _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();
@@ -132,6 +138,11 @@ DCPContent::DCPContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, in
                }
        }
        _three_d = node->optional_bool_child("ThreeD").get_value_or (false);
+
+       optional<string> ck = node->optional_string_child("ContentKind");
+       if (ck) {
+               _content_kind = dcp::content_kind_from_string (*ck);
+       }
        _cpl = node->optional_string_child("CPL");
        BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("ReelLength")) {
                _reel_lengths.push_back (raw_convert<int64_t> (i->content ()));
@@ -141,13 +152,27 @@ DCPContent::DCPContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, in
 void
 DCPContent::read_directory (boost::filesystem::path p)
 {
+       LOG_GENERAL ("DCPContent::read_directory reads %1", p.string());
        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());
+                       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_directory (i->path());
                }
        }
+
+       bool have_assetmap = false;
+       BOOST_FOREACH (boost::filesystem::path i, paths()) {
+               if (i.filename() == "ASSETMAP" || i.filename() == "ASSETMAP.xml") {
+                       have_assetmap = true;
+               }
+       }
+
+       if (!have_assetmap) {
+               throw DCPError ("No ASSETMAP or ASSETMAP.xml file found: is this a DCP?");
+       }
 }
 
 void
@@ -156,7 +181,13 @@ DCPContent::examine (shared_ptr<Job> job)
        bool const needed_assets = needs_assets ();
        bool const needed_kdm = needs_kdm ();
        string const old_name = name ();
-       int const old_captions = caption.size ();
+       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 ();
@@ -175,6 +206,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));
@@ -184,46 +216,44 @@ DCPContent::examine (shared_ptr<Job> job)
                AudioMapping m = as->mapping ();
                film()->make_audio_mapping_default (m);
                as->set_mapping (m);
-               signal_changed (AudioContentProperty::STREAMS);
        }
 
-       int captions = 0;
+       int texts = 0;
        {
                boost::mutex::scoped_lock lm (_mutex);
                _name = examiner->name ();
-               for (int i = 0; i < CAPTION_COUNT; ++i) {
-                       if (examiner->has_caption(static_cast<CaptionType>(i))) {
-                               caption.push_back (shared_ptr<CaptionContent>(new CaptionContent(this, static_cast<CaptionType>(i))));
+               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))));
                        }
                }
-               captions = caption.size ();
+               texts = text.size ();
                _encrypted = examiner->encrypted ();
                _needs_assets = examiner->needs_assets ();
                _kdm_valid = examiner->kdm_valid ();
                _standard = examiner->standard ();
                _three_d = examiner->three_d ();
+               _content_kind = examiner->content_kind ();
                _cpl = examiner->cpl ();
                _reel_lengths = examiner->reel_lengths ();
        }
 
-       if (old_captions != captions) {
-               signal_changed (DCPContentProperty::CAPTIONS);
+       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);
        }
@@ -267,7 +297,7 @@ DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
                audio->stream()->mapping().as_xml (node->add_child("AudioMapping"));
        }
 
-       BOOST_FOREACH (shared_ptr<CaptionContent> i, caption) {
+       BOOST_FOREACH (shared_ptr<TextContent> i, text) {
                i->as_xml (node);
        }
 
@@ -281,8 +311,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("ReferenceOpenCaption")->add_child_text(_reference_caption[CAPTION_OPEN] ? "1" : "0");
-       node->add_child("ReferenceClosedCaption")->add_child_text(_reference_caption[CAPTION_CLOSED] ? "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:
@@ -296,6 +326,9 @@ 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));
+       }
        if (_cpl) {
                node->add_child("CPL")->add_child_text (_cpl.get ());
        }
@@ -323,13 +356,13 @@ DCPContent::identifier () const
                s += video->identifier() + "_";
        }
 
-       BOOST_FOREACH (shared_ptr<CaptionContent> i, caption) {
+       BOOST_FOREACH (shared_ptr<TextContent> i, text) {
                s += i->identifier () + " ";
        }
 
        s += string (_reference_video ? "1" : "0");
-       for (int i = 0; i < CAPTION_COUNT; ++i) {
-               s += string (_reference_caption[i] ? "1" : "0");
+       for (int i = 0; i < TEXT_COUNT; ++i) {
+               s += string (_reference_text[i] ? "1" : "0");
        }
        return s;
 }
@@ -396,34 +429,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_caption (CaptionType type, bool r)
+DCPContent::set_reference_text (TextType type, bool r)
 {
+       ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_TEXT);
+
        {
                boost::mutex::scoped_lock lm (_mutex);
-               _reference_caption[type] = r;
+               _reference_text[type] = r;
        }
-
-       signal_changed (DCPContentProperty::REFERENCE_CAPTION);
 }
 
 list<DCPTimePeriod>
@@ -545,7 +578,21 @@ DCPContent::can_reference_video (string& why_not) const
                return false;
        }
 
-       if (film()->frame_size() != video->size()) {
+       Resolution video_res = RESOLUTION_2K;
+       if (video->size().width > 2048 || video->size().height > 1080) {
+               video_res = RESOLUTION_4K;
+       }
+
+       if (film()->resolution() != video_res) {
+               if (video_res == RESOLUTION_4K) {
+                       /// 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;
@@ -591,12 +638,13 @@ DCPContent::can_reference_audio (string& why_not) const
 }
 
 static
-bool check_caption (shared_ptr<const Content> c)
+bool check_text (shared_ptr<const Content> c)
 {
-       return !c->caption.empty();
+       return !c->text.empty();
 }
+
 bool
-DCPContent::can_reference_caption (CaptionType type, string& why_not) const
+DCPContent::can_reference_text (TextType type, string& why_not) const
 {
        shared_ptr<DCPDecoder> decoder;
        try {
@@ -610,12 +658,12 @@ DCPContent::can_reference_caption (CaptionType type, string& why_not) const
        }
 
         BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
-                if (type == CAPTION_OPEN && !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 == CAPTION_CLOSED && !i->closed_caption()) {
+               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;
@@ -623,7 +671,7 @@ DCPContent::can_reference_caption (CaptionType type, string& why_not) const
         }
 
        /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
-       return can_reference (bind (&check_caption, _1), _("it overlaps other caption 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
@@ -636,14 +684,29 @@ DCPContent::take_settings_from (shared_ptr<const Content> c)
 
        _reference_video = dc->_reference_video;
        _reference_audio = dc->_reference_audio;
-       for (int i = 0; i < CAPTION_COUNT; ++i) {
-               _reference_caption[i] = dc->_reference_caption[i];
+       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();
 }