std::shared_ptr
[dcpomatic.git] / src / lib / dcp_content.cc
index c89eadc3c97d89a49f6b133ea28462b3777c16e1..d4bd58e584099c9d937f5209e97639dbeb2a0f85 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2014-2018 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2020 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -18,6 +18,7 @@
 
 */
 
+#include "atmos_content.h"
 #include "dcp_content.h"
 #include "video_content.h"
 #include "audio_content.h"
@@ -34,7 +35,9 @@
 #include <dcp/dcp.h>
 #include <dcp/raw_convert.h>
 #include <dcp/exceptions.h>
+#include <dcp/reel_closed_caption_asset.h>
 #include <dcp/reel_picture_asset.h>
+#include <dcp/reel_subtitle_asset.h>
 #include <dcp/reel.h>
 #include <libxml++/libxml++.h>
 #include <boost/foreach.hpp>
@@ -49,12 +52,17 @@ using std::distance;
 using std::pair;
 using std::vector;
 using std::list;
-using boost::shared_ptr;
+using std::map;
+using std::shared_ptr;
 using boost::scoped_ptr;
 using boost::optional;
 using boost::function;
-using boost::dynamic_pointer_cast;
+using std::dynamic_pointer_cast;
+#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;
@@ -89,6 +97,7 @@ DCPContent::DCPContent (cxml::ConstNodePtr node, int version)
        video = VideoContent::from_xml (this, node, version);
        audio = AudioContent::from_xml (this, node, version);
        text = TextContent::from_xml (this, node, version);
+       atmos = AtmosContent::from_xml (this, node);
 
        for (int i = 0; i < TEXT_COUNT; ++i) {
                _reference_text[i] = false;
@@ -145,54 +154,84 @@ DCPContent::DCPContent (cxml::ConstNodePtr node, int version)
        BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("ReelLength")) {
                _reel_lengths.push_back (raw_convert<int64_t> (i->content ()));
        }
+
+       BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("Marker")) {
+               _markers[dcp::marker_from_string(i->string_attribute("type"))] = ContentTime(raw_convert<int64_t>(i->content()));
+       }
+
+       BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("Rating")) {
+               _ratings.push_back (dcp::Rating(i));
+       }
+
+       BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("ContentVersion")) {
+               _content_versions.push_back (i->content());
+       }
 }
 
 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())) {
-                       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());
-               }
-       }
+       using namespace boost::filesystem;
 
        bool have_assetmap = false;
-       BOOST_FOREACH (boost::filesystem::path i, paths()) {
-               if (i.filename() == "ASSETMAP" || i.filename() == "ASSETMAP.xml") {
+       bool have_metadata = false;
+
+       for (directory_iterator i(p); i != directory_iterator(); ++i) {
+               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) {
-               throw DCPError ("No ASSETMAP or ASSETMAP.xml file found: is this a DCP?");
+               if (!have_metadata) {
+                       throw DCPError ("No ASSETMAP or ASSETMAP.xml file found: is this a DCP?");
+               } else {
+                       throw DCPError (
+                               "This looks like a DCP-o-matic project folder, which cannot be added to a different project.  "
+                               "Choose the DCP directory inside the DCP-o-matic project folder if that's what you want to import."
+                               );
+               }
+       }
+
+       read_sub_directory (p);
+}
+
+void
+DCPContent::read_sub_directory (boost::filesystem::path p)
+{
+       LOG_GENERAL ("DCPContent::read_sub_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())) {
+                       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());
+               }
        }
 }
 
+/** @param film Film, or 0 */
 void
 DCPContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
 {
        bool const needed_assets = needs_assets ();
        bool const needed_kdm = needs_kdm ();
        string const old_name = name ();
-       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 ();
        }
        Content::examine (film, job);
 
-       shared_ptr<DCPExaminer> examiner (new DCPExaminer (shared_from_this ()));
+       shared_ptr<DCPExaminer> examiner (new DCPExaminer(shared_from_this(), film ? film->tolerant() : true));
 
        if (examiner->has_video()) {
                {
@@ -204,7 +243,6 @@ DCPContent::examine (shared_ptr<const Film> film, 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));
@@ -212,20 +250,37 @@ DCPContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
                AudioStreamPtr as (new AudioStream (examiner->audio_frame_rate(), examiner->audio_length(), examiner->audio_channels()));
                audio->set_stream (as);
                AudioMapping m = as->mapping ();
-               m.make_default (film->audio_processor());
+               m.make_default (film ? film->audio_processor() : 0);
                as->set_mapping (m);
        }
 
-       int texts = 0;
+       if (examiner->has_atmos()) {
+               {
+                       boost::mutex::scoped_lock lm (_mutex);
+                       atmos.reset (new AtmosContent(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());
+       }
+
+       list<shared_ptr<TextContent> > new_text;
+       for (int i = 0; i < TEXT_COUNT; ++i) {
+               for (int j = 0; j < examiner->text_count(static_cast<TextType>(i)); ++j) {
+                       shared_ptr<TextContent> c(new TextContent(this, static_cast<TextType>(i), static_cast<TextType>(i)));
+                       if (i == TEXT_CLOSED_CAPTION) {
+                               c->set_dcp_track (examiner->dcp_text_track(j));
+                       }
+                       new_text.push_back (c);
+               }
+       }
+
        {
                boost::mutex::scoped_lock lm (_mutex);
+               text = new_text;
                _name = examiner->name ();
-               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))));
-                       }
-               }
-               texts = text.size ();
                _encrypted = examiner->encrypted ();
                _needs_assets = examiner->needs_assets ();
                _kdm_valid = examiner->kdm_valid ();
@@ -234,10 +289,12 @@ DCPContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
                _content_kind = examiner->content_kind ();
                _cpl = examiner->cpl ();
                _reel_lengths = examiner->reel_lengths ();
-       }
-
-       if (old_texts == texts) {
-               cc_texts.abort ();
+               map<dcp::Marker, dcp::Time> markers = examiner->markers();
+               for (map<dcp::Marker, dcp::Time>::const_iterator i = markers.begin(); i != markers.end(); ++i) {
+                       _markers[i->first] = ContentTime(i->second.as_editable_units(DCPTime::HZ));
+               }
+               _ratings = examiner->ratings ();
+               _content_versions = examiner->content_versions ();
        }
 
        if (needed_assets == needs_assets()) {
@@ -299,6 +356,10 @@ DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
                i->as_xml (node);
        }
 
+       if (atmos) {
+               atmos->as_xml (node);
+       }
+
        boost::mutex::scoped_lock lm (_mutex);
        node->add_child("Name")->add_child_text (_name);
        node->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
@@ -333,6 +394,21 @@ DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
        BOOST_FOREACH (int64_t i, _reel_lengths) {
                node->add_child("ReelLength")->add_child_text (raw_convert<string> (i));
        }
+
+       for (map<dcp::Marker, ContentTime>::const_iterator i = _markers.begin(); i != _markers.end(); ++i) {
+               xmlpp::Element* marker = node->add_child("Marker");
+               marker->set_attribute("type", dcp::marker_to_string(i->first));
+               marker->add_child_text(raw_convert<string>(i->second.get()));
+       }
+
+       BOOST_FOREACH (dcp::Rating i, _ratings) {
+               xmlpp::Element* rating = node->add_child("Rating");
+               i.as_xml (rating);
+       }
+
+       BOOST_FOREACH (string i, _content_versions) {
+               node->add_child("ContentVersion")->add_child_text(i);
+       }
 }
 
 DCPTime
@@ -345,6 +421,15 @@ DCPContent::full_length (shared_ptr<const Film> film) const
        return DCPTime::from_frames (llrint(video->length() * frc.factor()), film->video_frame_rate());
 }
 
+DCPTime
+DCPContent::approximate_length () const
+{
+       if (!video) {
+               return DCPTime();
+       }
+       return DCPTime::from_frames (video->length(), 24);
+}
+
 string
 DCPContent::identifier () const
 {
@@ -406,7 +491,7 @@ DCPContent::directories () const
 void
 DCPContent::add_properties (shared_ptr<const Film> film, list<UserProperty>& p) const
 {
-       Content::add_properties (p);
+       Content::add_properties (film, p);
        if (video) {
                video->add_properties (p);
        }
@@ -464,7 +549,7 @@ DCPContent::reels (shared_ptr<const Film> film) const
        if (reel_lengths.empty ()) {
                /* Old metadata with no reel lengths; get them here instead */
                try {
-                       scoped_ptr<DCPExaminer> examiner (new DCPExaminer (shared_from_this()));
+                       scoped_ptr<DCPExaminer> examiner (new DCPExaminer(shared_from_this(), film->tolerant()));
                        reel_lengths = examiner->reel_lengths ();
                } catch (...) {
                        /* Could not examine the DCP; guess reels */
@@ -534,10 +619,10 @@ DCPContent::can_reference (shared_ptr<const Film> film, function<bool (shared_pt
        list<DCPTimePeriod> reel_list;
        try {
                reel_list = reels (film);
-       } catch (dcp::DCPReadError) {
+       } catch (dcp::ReadError &) {
                /* We couldn't read the DCP; it's probably missing */
                return false;
-       } catch (dcp::KDMDecryptionError) {
+       } catch (dcp::KDMDecryptionError &) {
                /* We have an incorrect KDM */
                return false;
        }
@@ -565,7 +650,7 @@ DCPContent::can_reference (shared_ptr<const Film> film, function<bool (shared_pt
 static
 bool check_video (shared_ptr<const Content> c)
 {
-       return static_cast<bool>(c->video);
+       return static_cast<bool>(c->video) && c->video->use();
 }
 
 bool
@@ -576,13 +661,8 @@ DCPContent::can_reference_video (shared_ptr<const Film> film, string& why_not) c
                return false;
        }
 
-       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) {
+       if (film->resolution() != resolution()) {
+               if (resolution() == RESOLUTION_4K) {
                        /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
                        why_not = _("it is 4K and the film is 2K.");
                } else {
@@ -603,7 +683,7 @@ DCPContent::can_reference_video (shared_ptr<const Film> film, string& why_not) c
 static
 bool check_audio (shared_ptr<const Content> c)
 {
-       return static_cast<bool>(c->audio);
+       return static_cast<bool>(c->audio) && !c->audio->mapping().mapped_output_channels().empty();
 }
 
 bool
@@ -611,14 +691,14 @@ DCPContent::can_reference_audio (shared_ptr<const Film> film, string& why_not) c
 {
        shared_ptr<DCPDecoder> decoder;
        try {
-               decoder.reset (new DCPDecoder (film, shared_from_this(), false));
-       } catch (dcp::DCPReadError) {
+               decoder.reset (new 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) {
+       } catch (DCPError &) {
                /* We couldn't read the DCP, so it's probably missing */
                return false;
-       } catch (dcp::KDMDecryptionError) {
+       } catch (dcp::KDMDecryptionError &) {
                /* We have an incorrect KDM */
                return false;
        }
@@ -646,29 +726,49 @@ DCPContent::can_reference_text (shared_ptr<const Film> film, TextType type, stri
 {
        shared_ptr<DCPDecoder> decoder;
        try {
-               decoder.reset (new DCPDecoder (film, shared_from_this(), false));
-       } catch (dcp::DCPReadError) {
-
+               decoder.reset (new 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) {
+       } catch (dcp::KDMDecryptionError &) {
                /* We have an incorrect KDM */
                return false;
        }
 
         BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
-                if (type == TEXT_OPEN_SUBTITLE && !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;
+                if (type == TEXT_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 if its subtitle reels has a non-zero entry point so it must be re-written.");
+                               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;
+               if (type == TEXT_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;
+                       }
+                       BOOST_FOREACH (shared_ptr<dcp::ReelClosedCaptionAsset> 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.");
+                                       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;
+       }
+
        /// 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);
 }
@@ -709,3 +809,15 @@ DCPContent::kdm_timing_window_valid () const
        dcp::LocalTime now;
        return _kdm->not_valid_before() < now && now < _kdm->not_valid_after();
 }
+
+
+Resolution
+DCPContent::resolution () const
+{
+       if (video->size().width > 2048 || video->size().height > 1080) {
+               return RESOLUTION_4K;
+       }
+
+       return RESOLUTION_2K;
+}
+