BOOST_FOREACH.
[dcpomatic.git] / src / lib / dcp_content.cc
index 4c4486a281e77c0be0656fa93cc2c5da80e32dd4..e43d88a3472b2050f139c784c742611ee94d7419 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"
 #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>
 #include <iterator>
 #include <iostream>
 
@@ -49,12 +51,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 +96,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;
@@ -142,26 +150,51 @@ DCPContent::DCPContent (cxml::ConstNodePtr node, int version)
                _content_kind = dcp::content_kind_from_string (*ck);
        }
        _cpl = node->optional_string_child("CPL");
-       BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("ReelLength")) {
+       for (auto i: node->node_children("ReelLength")) {
                _reel_lengths.push_back (raw_convert<int64_t> (i->content ()));
        }
+
+       for (auto i: node->node_children("Marker")) {
+               _markers[dcp::marker_from_string(i->string_attribute("type"))] = ContentTime(raw_convert<int64_t>(i->content()));
+       }
+
+       for (auto i: node->node_children("Rating")) {
+               _ratings.push_back (dcp::Rating(i));
+       }
+
+       for (auto i: node->node_children("ContentVersion")) {
+               _content_versions.push_back (i->content());
+       }
 }
 
 void
 DCPContent::read_directory (boost::filesystem::path p)
 {
-       read_sub_directory (p);
+       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
@@ -179,13 +212,13 @@ DCPContent::read_sub_directory (boost::filesystem::path p)
        }
 }
 
+/** @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);
@@ -197,7 +230,7 @@ DCPContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
        }
        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()) {
                {
@@ -220,16 +253,33 @@ DCPContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
                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 ();
@@ -238,10 +288,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,10 +351,14 @@ DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
                audio->stream()->mapping().as_xml (node->add_child("AudioMapping"));
        }
 
-       BOOST_FOREACH (shared_ptr<TextContent> i, text) {
+       for (auto i: text) {
                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");
@@ -334,9 +390,24 @@ DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
        if (_cpl) {
                node->add_child("CPL")->add_child_text (_cpl.get ());
        }
-       BOOST_FOREACH (int64_t i, _reel_lengths) {
+       for (auto 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()));
+       }
+
+       for (auto i: _ratings) {
+               xmlpp::Element* rating = node->add_child("Rating");
+               i.as_xml (rating);
+       }
+
+       for (auto i: _content_versions) {
+               node->add_child("ContentVersion")->add_child_text(i);
+       }
 }
 
 DCPTime
@@ -367,7 +438,7 @@ DCPContent::identifier () const
                s += video->identifier() + "_";
        }
 
-       BOOST_FOREACH (shared_ptr<TextContent> i, text) {
+       for (auto i: text) {
                s += i->identifier () + " ";
        }
 
@@ -477,7 +548,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 */
@@ -494,7 +565,7 @@ DCPContent::reels (shared_ptr<const Film> film) const
        /* The starting point of this content on the timeline */
        DCPTime pos = position() - DCPTime (trim_start().get());
 
-       BOOST_FOREACH (int64_t i, reel_lengths) {
+       for (auto i: reel_lengths) {
                /* This reel runs from `pos' to `to' */
                DCPTime const to = pos + DCPTime::from_frames (i, film->video_frame_rate());
                if (to > position()) {
@@ -513,7 +584,7 @@ list<DCPTime>
 DCPContent::reel_split_points (shared_ptr<const Film> film) const
 {
        list<DCPTime> s;
-       BOOST_FOREACH (DCPTimePeriod i, reels(film)) {
+       for (auto i: reels(film)) {
                s.push_back (i.from);
        }
        return s;
@@ -547,7 +618,7 @@ 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 &) {
@@ -558,7 +629,7 @@ DCPContent::can_reference (shared_ptr<const Film> film, function<bool (shared_pt
        /* fr must contain reels().  It can also contain other reels, but it must at
           least contain reels().
        */
-       BOOST_FOREACH (DCPTimePeriod i, reel_list) {
+       for (auto i: reel_list) {
                if (find (fr.begin(), fr.end(), i) == fr.end ()) {
                        /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
                        why_not = _("its reel lengths differ from those in the film; set the reel mode to 'split by video content'.");
@@ -578,7 +649,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
@@ -589,13 +660,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 {
@@ -616,7 +682,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
@@ -624,8 +690,8 @@ 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 &) {
@@ -636,7 +702,7 @@ DCPContent::can_reference_audio (shared_ptr<const Film> film, string& why_not) c
                return false;
        }
 
-        BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
+        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.");
@@ -659,8 +725,8 @@ 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 &) {
@@ -668,19 +734,40 @@ DCPContent::can_reference_text (shared_ptr<const Film> film, TextType type, stri
                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;
+        for (auto i: decoder->reels()) {
+                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;
+                       }
+                       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.");
+                                       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);
 }
@@ -721,3 +808,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;
+}
+