Fix enabled/disable overlapping video/audio with DCP content (part of #1355)
[dcpomatic.git] / src / lib / dcp_content.cc
index a2874a6044811a0524e3f8adf6fd080420443ca1..ca210b5587ce45cbdd4eee40037649843246f41a 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.
 
@@ -28,6 +28,8 @@
 #include "overlaps.h"
 #include "compose.hpp"
 #include "dcp_decoder.h"
+#include "log.h"
+#include "dcpomatic_log.h"
 #include "text_content.h"
 #include <dcp/dcp.h>
 #include <dcp/raw_convert.h>
@@ -47,12 +49,14 @@ using std::distance;
 using std::pair;
 using std::vector;
 using std::list;
+using std::map;
 using boost::shared_ptr;
 using boost::scoped_ptr;
 using boost::optional;
 using boost::function;
 using boost::dynamic_pointer_cast;
 using dcp::raw_convert;
+using namespace dcpomatic;
 
 int const DCPContentProperty::NEEDS_ASSETS       = 600;
 int const DCPContentProperty::NEEDS_KDM          = 601;
@@ -63,15 +67,16 @@ int const DCPContentProperty::NAME               = 605;
 int const DCPContentProperty::TEXTS              = 606;
 int const DCPContentProperty::CPL                = 607;
 
-DCPContent::DCPContent (shared_ptr<const Film> film, boost::filesystem::path p)
-       : Content (film)
-       , _encrypted (false)
+DCPContent::DCPContent (boost::filesystem::path p)
+       : _encrypted (false)
        , _needs_assets (false)
        , _kdm_valid (false)
        , _reference_video (false)
        , _reference_audio (false)
        , _three_d (false)
 {
+       LOG_GENERAL ("Creating DCP content from %1", p.string());
+
        read_directory (p);
        set_default_colour_conversion ();
 
@@ -80,8 +85,8 @@ DCPContent::DCPContent (shared_ptr<const Film> film, boost::filesystem::path p)
        }
 }
 
-DCPContent::DCPContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version)
-       : Content (film, node)
+DCPContent::DCPContent (cxml::ConstNodePtr node, int version)
+       : Content (node)
 {
        video = VideoContent::from_xml (this, node, version);
        audio = AudioContent::from_xml (this, node, version);
@@ -133,26 +138,62 @@ 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 ()));
        }
+
+       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));
+       }
+
+       _content_version = node->optional_string_child("ContentVersion").get_value_or("");
 }
 
 void
 DCPContent::read_directory (boost::filesystem::path p)
 {
+       read_sub_directory (p);
+
+       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
+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 ())) {
-                       read_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<Job> job)
+DCPContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
 {
        bool const needed_assets = needs_assets ();
        bool const needed_kdm = needs_kdm ();
@@ -163,14 +204,13 @@ DCPContent::examine (shared_ptr<Job> job)
        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 (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()) {
                {
@@ -182,7 +222,6 @@ 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));
@@ -190,7 +229,7 @@ DCPContent::examine (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 ();
-               film()->make_audio_mapping_default (m);
+               m.make_default (film ? film->audio_processor() : 0);
                as->set_mapping (m);
        }
 
@@ -199,7 +238,7 @@ DCPContent::examine (shared_ptr<Job> job)
                boost::mutex::scoped_lock lm (_mutex);
                _name = examiner->name ();
                for (int i = 0; i < TEXT_COUNT; ++i) {
-                       if (examiner->has_text(static_cast<TextType>(i))) {
+                       for (int j = 0; j < examiner->text_count(static_cast<TextType>(i)); ++j) {
                                text.push_back (shared_ptr<TextContent>(new TextContent(this, static_cast<TextType>(i), static_cast<TextType>(i))));
                        }
                }
@@ -209,8 +248,15 @@ DCPContent::examine (shared_ptr<Job> job)
                _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 ();
+               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_version = examiner->content_version ();
        }
 
        if (old_texts == texts) {
@@ -301,22 +347,47 @@ 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 ());
        }
        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);
+       }
+
+       node->add_child("ContentVersion")->add_child_text (_content_version);
 }
 
 DCPTime
-DCPContent::full_length () const
+DCPContent::full_length (shared_ptr<const Film> film) const
 {
        if (!video) {
                return DCPTime();
        }
-       FrameRateChange const frc (active_video_frame_rate (), film()->video_frame_rate ());
-       return DCPTime::from_frames (llrint (video->length () * frc.factor ()), film()->video_frame_rate ());
+       FrameRateChange const frc (film, shared_from_this());
+       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
@@ -378,14 +449,14 @@ DCPContent::directories () const
 }
 
 void
-DCPContent::add_properties (list<UserProperty>& p) const
+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);
        }
        if (audio) {
-               audio->add_properties (p);
+               audio->add_properties (film, p);
        }
 }
 
@@ -432,17 +503,17 @@ DCPContent::set_reference_text (TextType type, bool r)
 }
 
 list<DCPTimePeriod>
-DCPContent::reels () const
+DCPContent::reels (shared_ptr<const Film> film) const
 {
        list<int64_t> reel_lengths = _reel_lengths;
        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 */
-                       reel_lengths.push_back (length_after_trim().frames_round (film()->video_frame_rate ()));
+                       reel_lengths.push_back (length_after_trim(film).frames_round(film->video_frame_rate()));
                }
        }
 
@@ -457,10 +528,10 @@ DCPContent::reels () const
 
        BOOST_FOREACH (int64_t i, reel_lengths) {
                /* This reel runs from `pos' to `to' */
-               DCPTime const to = pos + DCPTime::from_frames (i, film()->video_frame_rate());
+               DCPTime const to = pos + DCPTime::from_frames (i, film->video_frame_rate());
                if (to > position()) {
-                       p.push_back (DCPTimePeriod (max(position(), pos), min(end(), to)));
-                       if (to > end()) {
+                       p.push_back (DCPTimePeriod (max(position(), pos), min(end(film), to)));
+                       if (to > end(film)) {
                                break;
                        }
                }
@@ -471,25 +542,25 @@ DCPContent::reels () const
 }
 
 list<DCPTime>
-DCPContent::reel_split_points () const
+DCPContent::reel_split_points (shared_ptr<const Film> film) const
 {
        list<DCPTime> s;
-       BOOST_FOREACH (DCPTimePeriod i, reels()) {
+       BOOST_FOREACH (DCPTimePeriod i, reels(film)) {
                s.push_back (i.from);
        }
        return s;
 }
 
 bool
-DCPContent::can_reference (function<bool (shared_ptr<const Content>)> part, string overlapping, string& why_not) const
+DCPContent::can_reference (shared_ptr<const Film> film, 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) {
-               if (_standard.get() == dcp::INTEROP && !film()->interop()) {
+               if (_standard.get() == dcp::INTEROP && !film->interop()) {
                        /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
                        why_not = _("it is Interop and the film is set to SMPTE.");
                        return false;
-               } else if (_standard.get() == dcp::SMPTE && film()->interop()) {
+               } else if (_standard.get() == dcp::SMPTE && film->interop()) {
                        /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
                        why_not = _("it is SMPTE and the film is set to Interop.");
                        return false;
@@ -497,21 +568,21 @@ DCPContent::can_reference (function<bool (shared_ptr<const Content>)> part, stri
        }
 
        /* And the same frame rate */
-       if (!video_frame_rate() || (lrint(video_frame_rate().get()) != film()->video_frame_rate())) {
+       if (!video_frame_rate() || (lrint(video_frame_rate().get()) != film->video_frame_rate())) {
                /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
                why_not = _("it has a different frame rate to the film.");
                return false;
        }
 
-       list<DCPTimePeriod> const fr = film()->reels ();
+       list<DCPTimePeriod> const fr = film->reels ();
 
        list<DCPTimePeriod> reel_list;
        try {
-               reel_list = reels ();
-       } catch (dcp::DCPReadError) {
+               reel_list = reels (film);
+       } 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;
        }
@@ -527,7 +598,7 @@ DCPContent::can_reference (function<bool (shared_ptr<const Content>)> part, stri
                }
        }
 
-       ContentList a = overlaps (film()->content(), part, position(), end());
+       ContentList a = overlaps (film, film->content(), part, position(), end(film));
        if (a.size() != 1 || a.front().get() != this) {
                why_not = overlapping;
                return false;
@@ -539,46 +610,55 @@ DCPContent::can_reference (function<bool (shared_ptr<const Content>)> part, stri
 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
-DCPContent::can_reference_video (string& why_not) const
+DCPContent::can_reference_video (shared_ptr<const Film> film, string& why_not) const
 {
        if (!video) {
                why_not = _("There is no video in this DCP");
                return false;
        }
 
-       if (film()->frame_size() != video->size()) {
+       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 {
+                       /// 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;
        }
 
        /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
-       return can_reference (bind (&check_video, _1), _("it overlaps other video content; remove the other content."), why_not);
+       return can_reference (film, 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);
+       return static_cast<bool>(c->audio) && !c->audio->mapping().mapped_output_channels().empty();
 }
 
 bool
-DCPContent::can_reference_audio (string& why_not) const
+DCPContent::can_reference_audio (shared_ptr<const Film> film, string& why_not) const
 {
        shared_ptr<DCPDecoder> decoder;
        try {
-               decoder.reset (new DCPDecoder (shared_from_this(), film()->log(), 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;
        }
@@ -592,7 +672,7 @@ DCPContent::can_reference_audio (string& why_not) const
         }
 
        /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
-       return can_reference (bind (&check_audio, _1), _("it overlaps other audio content; remove the other content."), why_not);
+       return can_reference (film, bind (&check_audio, _1), _("it overlaps other audio content; remove the other content."), why_not);
 }
 
 static
@@ -602,15 +682,15 @@ bool check_text (shared_ptr<const Content> c)
 }
 
 bool
-DCPContent::can_reference_text (TextType type, string& why_not) const
+DCPContent::can_reference_text (shared_ptr<const Film> film, TextType type, string& why_not) const
 {
        shared_ptr<DCPDecoder> decoder;
        try {
-               decoder.reset (new DCPDecoder (shared_from_this(), film()->log(), 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;
        }
@@ -629,7 +709,7 @@ DCPContent::can_reference_text (TextType type, string& why_not) const
         }
 
        /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
-       return can_reference (bind (&check_text, _1), _("it overlaps other text content; remove the other content."), why_not);
+       return can_reference (film, bind (&check_text, _1), _("it overlaps other text content; remove the other content."), why_not);
 }
 
 void
@@ -657,3 +737,26 @@ DCPContent::set_cpl (string id)
                _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();
+}
+
+
+Resolution
+DCPContent::resolution () const
+{
+       if (video->size().width > 2048 || video->size().height > 1080) {
+               return RESOLUTION_4K;
+       }
+
+       return RESOLUTION_2K;
+}
+