Store reel lengths in DCPContent to speed up e.g. timeline with many DCPs.
[dcpomatic.git] / src / lib / dcp_content.cc
index d866a6b86c69f03a9593d04b94d8ec1b2a5bca1c..2eead3ee00d38be0212c411a7c695bfab771a0a5 100644 (file)
@@ -51,16 +51,20 @@ using boost::shared_ptr;
 using boost::scoped_ptr;
 using boost::optional;
 using boost::function;
+using boost::dynamic_pointer_cast;
 using dcp::raw_convert;
 
-int const DCPContentProperty::CAN_BE_PLAYED      = 600;
-int const DCPContentProperty::REFERENCE_VIDEO    = 601;
-int const DCPContentProperty::REFERENCE_AUDIO    = 602;
-int const DCPContentProperty::REFERENCE_SUBTITLE = 603;
+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::NAME               = 605;
 
 DCPContent::DCPContent (shared_ptr<const Film> film, boost::filesystem::path p)
        : Content (film)
        , _encrypted (false)
+       , _needs_assets (false)
        , _kdm_valid (false)
        , _reference_video (false)
        , _reference_audio (false)
@@ -95,8 +99,8 @@ DCPContent::DCPContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, in
                );
 
        _name = node->string_child ("Name");
-
        _encrypted = node->bool_child ("Encrypted");
+       _needs_assets = node->optional_bool_child("NeedsAssets").get_value_or (false);
        if (node->optional_node_child ("KDM")) {
                _kdm = dcp::EncryptedKDM (node->string_child ("KDM"));
        }
@@ -115,6 +119,10 @@ DCPContent::DCPContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, in
                }
        }
        _three_d = node->optional_bool_child("ThreeD").get_value_or (false);
+       _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 ()));
+       }
 }
 
 void
@@ -132,7 +140,9 @@ DCPContent::read_directory (boost::filesystem::path p)
 void
 DCPContent::examine (shared_ptr<Job> job)
 {
-       bool const could_be_played = can_be_played ();
+       bool const needed_assets = needs_assets ();
+       bool const needed_kdm = needs_kdm ();
+       string const old_name = name ();
 
        job->set_progress_unknown ();
        Content::examine (job);
@@ -160,13 +170,24 @@ DCPContent::examine (shared_ptr<Job> job)
                        subtitle.reset (new SubtitleContent (this));
                }
                _encrypted = examiner->encrypted ();
+               _needs_assets = examiner->needs_assets ();
                _kdm_valid = examiner->kdm_valid ();
                _standard = examiner->standard ();
                _three_d = examiner->three_d ();
+               _cpl = examiner->cpl ();
+               _reel_lengths = examiner->reel_lengths ();
+       }
+
+       if (needed_assets != needs_assets ()) {
+               signal_changed (DCPContentProperty::NEEDS_ASSETS);
        }
 
-       if (could_be_played != can_be_played ()) {
-               signal_changed (DCPContentProperty::CAN_BE_PLAYED);
+       if (needed_kdm != needs_kdm ()) {
+               signal_changed (DCPContentProperty::NEEDS_KDM);
+       }
+
+       if (old_name != name ()) {
+               signal_changed (DCPContentProperty::NAME);
        }
 
        video->set_frame_type (_three_d ? VIDEO_FRAME_TYPE_3D : VIDEO_FRAME_TYPE_2D);
@@ -188,11 +209,11 @@ DCPContent::technical_summary () const
 }
 
 void
-DCPContent::as_xml (xmlpp::Node* node) const
+DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
 {
        node->add_child("Type")->add_child_text ("DCP");
 
-       Content::as_xml (node);
+       Content::as_xml (node, with_paths);
 
        if (video) {
                video->as_xml (node);
@@ -212,6 +233,7 @@ DCPContent::as_xml (xmlpp::Node* node) const
        boost::mutex::scoped_lock lm (_mutex);
        node->add_child("Name")->add_child_text (_name);
        node->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
+       node->add_child("NeedsAssets")->add_child_text (_needs_assets ? "1" : "0");
        if (_kdm) {
                node->add_child("KDM")->add_child_text (_kdm->as_xml ());
        }
@@ -232,6 +254,12 @@ DCPContent::as_xml (xmlpp::Node* node) const
                }
        }
        node->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
+       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));
+       }
 }
 
 DCPTime
@@ -259,27 +287,36 @@ DCPContent::add_kdm (dcp::EncryptedKDM k)
        _kdm = k;
 }
 
+void
+DCPContent::add_ov (boost::filesystem::path ov)
+{
+       read_directory (ov);
+}
+
 bool
 DCPContent::can_be_played () const
+{
+       return !needs_kdm() && !needs_assets();
+}
+
+bool
+DCPContent::needs_kdm () const
 {
        boost::mutex::scoped_lock lm (_mutex);
-       return !_encrypted || _kdm_valid;
+       return _encrypted && !_kdm_valid;
 }
 
-boost::filesystem::path
-DCPContent::directory () const
+bool
+DCPContent::needs_assets () const
 {
-       optional<size_t> smallest;
-       boost::filesystem::path dir;
-       for (size_t i = 0; i < number_of_paths(); ++i) {
-               boost::filesystem::path const p = path (i).parent_path ();
-               size_t const d = distance (p.begin(), p.end());
-               if (!smallest || d < smallest.get ()) {
-                       dir = p;
-               }
-       }
+       boost::mutex::scoped_lock lm (_mutex);
+       return _needs_assets;
+}
 
-       return dir;
+vector<boost::filesystem::path>
+DCPContent::directories () const
+{
+       return dcp::DCP::directories_from_files (paths ());
 }
 
 void
@@ -333,22 +370,37 @@ DCPContent::set_reference_subtitle (bool r)
 list<DCPTimePeriod>
 DCPContent::reels () const
 {
-       list<DCPTimePeriod> p;
-       scoped_ptr<DCPDecoder> decoder;
-       try {
-               decoder.reset (new DCPDecoder (shared_from_this(), film()->log()));
-       } catch (...) {
-               /* Could not load the DCP; guess reels */
-               list<DCPTimePeriod> p;
-               p.push_back (DCPTimePeriod (position(), end()));
-               return p;
+       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()));
+                       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 ()));
+               }
        }
 
-       DCPTime from = position ();
-       BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
-               DCPTime const to = from + DCPTime::from_frames (i->main_picture()->duration(), film()->video_frame_rate());
-               p.push_back (DCPTimePeriod (from, to));
-               from = to;
+       list<DCPTimePeriod> p;
+
+       /* This content's frame rate must be the same as the output DCP rate, so we can
+          convert `directly' from ContentTime to DCPTime.
+       */
+
+       /* The starting point of this content on the timeline */
+       DCPTime pos = position() - DCPTime (trim_start().get());
+
+       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());
+               if (to > position()) {
+                       p.push_back (DCPTimePeriod (max(position(), pos), min(end(), to)));
+                       if (to > end()) {
+                               break;
+                       }
+               }
+               pos = to;
        }
 
        return p;
@@ -378,13 +430,28 @@ DCPContent::can_reference (function<shared_ptr<ContentPart> (shared_ptr<const Co
                }
        }
 
+       /* And the same frame rate */
+       if (!video_frame_rate() || (lrint(video_frame_rate().get()) != film()->video_frame_rate())) {
+               why_not.push_back (_("The film has a different frame rate to this DCP."));
+               return false;
+       }
+
        list<DCPTimePeriod> const fr = film()->reels ();
+
+       list<DCPTimePeriod> reel_list;
+       try {
+               reel_list = reels ();
+       } catch (dcp::DCPReadError) {
+               /* We couldn't read the DCP; it's probably missing */
+               return false;
+       }
+
        /* fr must contain reels().  It can also contain other reels, but it must at
           least contain reels().
        */
-       BOOST_FOREACH (DCPTimePeriod i, reels()) {
+       BOOST_FOREACH (DCPTimePeriod i, reel_list) {
                if (find (fr.begin(), fr.end(), i) == fr.end ()) {
-                       why_not.push_back (_("Reel lengths in the film differ from those in the DCP; set the reel mode to 'split by video content'."));
+                       why_not.push_back (_("The reel lengths in the film differ from those in the DCP; set the reel mode to 'split by video content'."));
                        return false;
                }
        }
@@ -401,28 +468,47 @@ DCPContent::can_reference (function<shared_ptr<ContentPart> (shared_ptr<const Co
 bool
 DCPContent::can_reference_video (list<string>& why_not) const
 {
+       if (film()->frame_size() != video->size()) {
+               why_not.push_back (_("The video frame size in the film differs from that in the DCP."));
+               return false;
+       }
+
        return can_reference (bind (&Content::video, _1), _("There is other video content overlapping this DCP; remove it."), why_not);
 }
 
 bool
 DCPContent::can_reference_audio (list<string>& why_not) const
 {
-        DCPDecoder decoder (shared_from_this(), film()->log());
-        BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder.reels()) {
+       shared_ptr<DCPDecoder> decoder;
+       try {
+               decoder.reset (new DCPDecoder (shared_from_this(), film()->log()));
+       } catch (dcp::DCPReadError) {
+               /* We couldn't read the DCP, so it's probably missing */
+               return false;
+       }
+
+        BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
                 if (!i->main_sound()) {
                         why_not.push_back (_("The DCP does not have sound in all reels."));
                         return false;
                 }
         }
 
-        return can_reference (bind (&Content::audio, _1),   _("There is other audio content overlapping this DCP; remove it."), why_not);
+        return can_reference (bind (&Content::audio, _1), _("There is other audio content overlapping this DCP; remove it."), why_not);
 }
 
 bool
 DCPContent::can_reference_subtitle (list<string>& why_not) const
 {
-        DCPDecoder decoder (shared_from_this(), film()->log());
-        BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder.reels()) {
+       shared_ptr<DCPDecoder> decoder;
+       try {
+               decoder.reset (new DCPDecoder (shared_from_this(), film()->log()));
+       } catch (dcp::DCPReadError) {
+               /* We couldn't read the DCP, so it's probably missing */
+               return false;
+       }
+
+        BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
                 if (!i->main_subtitle()) {
                         why_not.push_back (_("The DCP does not have subtitles in all reels."));
                         return false;
@@ -431,3 +517,21 @@ DCPContent::can_reference_subtitle (list<string>& why_not) const
 
         return can_reference (bind (&Content::subtitle, _1), _("There is other subtitle content overlapping this DCP; remove it."), why_not);
 }
+
+void
+DCPContent::use_template (shared_ptr<const Content> c)
+{
+       shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (c);
+       DCPOMATIC_ASSERT (dc);
+
+       _reference_video = dc->_reference_video;
+       _reference_audio = dc->_reference_audio;
+       _reference_subtitle = dc->_reference_subtitle;
+}
+
+void
+DCPContent::set_cpl (string id)
+{
+       boost::mutex::scoped_lock lm (_mutex);
+       _cpl = id;
+}