More automated renaming.
[dcpomatic.git] / src / lib / dcp_content.cc
index 03e6f1aaa5415e64f85cfdb5cbfc93eca72046bc..aaf8064f3cfd66b597194840c584890589b232b7 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2014-2016 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2018 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -28,7 +28,7 @@
 #include "overlaps.h"
 #include "compose.hpp"
 #include "dcp_decoder.h"
-#include "subtitle_content.h"
+#include "text_content.h"
 #include <dcp/dcp.h>
 #include <dcp/raw_convert.h>
 #include <dcp/exceptions.h>
@@ -51,12 +51,16 @@ 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_CAPTION  = 604;
+int const DCPContentProperty::NAME               = 605;
+int const DCPContentProperty::CAPTIONS           = 606;
 
 DCPContent::DCPContent (shared_ptr<const Film> film, boost::filesystem::path p)
        : Content (film)
@@ -65,14 +69,14 @@ DCPContent::DCPContent (shared_ptr<const Film> film, boost::filesystem::path p)
        , _kdm_valid (false)
        , _reference_video (false)
        , _reference_audio (false)
-       , _reference_subtitle (false)
        , _three_d (false)
 {
-       video.reset (new VideoContent (this));
-       audio.reset (new AudioContent (this));
-
        read_directory (p);
        set_default_colour_conversion ();
+
+       for (int i = 0; i < CAPTION_COUNT; ++i) {
+               _reference_caption[i] = false;
+       }
 }
 
 DCPContent::DCPContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version)
@@ -80,31 +84,43 @@ 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);
-       subtitle = SubtitleContent::from_xml (this, node, version);
-
-       audio->set_stream (
-               AudioStreamPtr (
-                       new AudioStream (
-                               node->number_child<int> ("AudioFrameRate"),
-                               /* AudioLength was not present in some old metadata versions */
-                               node->optional_number_child<Frame>("AudioLength").get_value_or (
-                                       video->length() * node->number_child<int>("AudioFrameRate") / video_frame_rate().get()
-                                       ),
-                               AudioMapping (node->node_child ("AudioMapping"), version)
+       caption = TextContent::from_xml (this, node, version);
+
+       for (int i = 0; i < CAPTION_COUNT; ++i) {
+               _reference_caption[i] = false;
+       }
+
+       if (video && audio) {
+               audio->set_stream (
+                       AudioStreamPtr (
+                               new AudioStream (
+                                       node->number_child<int> ("AudioFrameRate"),
+                                       /* AudioLength was not present in some old metadata versions */
+                                       node->optional_number_child<Frame>("AudioLength").get_value_or (
+                                               video->length() * node->number_child<int>("AudioFrameRate") / video_frame_rate().get()
+                                               ),
+                                       AudioMapping (node->node_child ("AudioMapping"), version)
+                                       )
                                )
-                       )
-               );
+                       );
+       }
 
        _name = node->string_child ("Name");
        _encrypted = node->bool_child ("Encrypted");
-       _needs_assets = node->bool_child ("NeedsAssets");
+       _needs_assets = node->optional_bool_child("NeedsAssets").get_value_or (false);
        if (node->optional_node_child ("KDM")) {
                _kdm = dcp::EncryptedKDM (node->string_child ("KDM"));
        }
        _kdm_valid = node->bool_child ("KDMValid");
        _reference_video = node->optional_bool_child ("ReferenceVideo").get_value_or (false);
        _reference_audio = node->optional_bool_child ("ReferenceAudio").get_value_or (false);
-       _reference_subtitle = node->optional_bool_child ("ReferenceSubtitle").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);
+       } else {
+               _reference_caption[CAPTION_OPEN] = node->optional_bool_child("ReferenceSubtitle").get_value_or(false);
+               _reference_caption[CAPTION_CLOSED] = false;
+       }
        if (node->optional_string_child("Standard")) {
                string const s = node->optional_string_child("Standard").get();
                if (s == "Interop") {
@@ -117,16 +133,19 @@ 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
 DCPContent::read_directory (boost::filesystem::path p)
 {
        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 ());
+               if (boost::filesystem::is_regular_file (i->path())) {
+                       _paths.push_back (i->path());
                } else if (boost::filesystem::is_directory (i->path ())) {
-                       read_directory (i->path ());
+                       read_directory (i->path());
                }
        }
 }
@@ -134,46 +153,80 @@ 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 ();
+       int const old_captions = caption.size ();
 
-       job->set_progress_unknown ();
+       if (job) {
+               job->set_progress_unknown ();
+       }
        Content::examine (job);
 
        shared_ptr<DCPExaminer> examiner (new DCPExaminer (shared_from_this ()));
-       video->take_from_examiner (examiner);
-       set_default_colour_conversion ();
 
-       {
-               boost::mutex::scoped_lock lm (_mutex);
+       if (examiner->has_video()) {
+               {
+                       boost::mutex::scoped_lock lm (_mutex);
+                       video.reset (new VideoContent (this));
+               }
+               video->take_from_examiner (examiner);
+               set_default_colour_conversion ();
+       }
 
+       if (examiner->has_audio()) {
+               {
+                       boost::mutex::scoped_lock lm (_mutex);
+                       audio.reset (new AudioContent (this));
+               }
                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);
                as->set_mapping (m);
+               signal_changed (AudioContentProperty::STREAMS);
        }
 
-       signal_changed (AudioContentProperty::STREAMS);
-
+       int captions = 0;
        {
                boost::mutex::scoped_lock lm (_mutex);
                _name = examiner->name ();
-               if (examiner->has_subtitles ()) {
-                       subtitle.reset (new SubtitleContent (this));
+               for (int i = 0; i < CAPTION_COUNT; ++i) {
+                       if (examiner->has_caption(static_cast<TextType>(i))) {
+                               caption.push_back (shared_ptr<TextContent>(new TextContent(this, static_cast<TextType>(i))));
+                       }
                }
+               captions = caption.size ();
                _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 (old_captions != captions) {
+               signal_changed (DCPContentProperty::CAPTIONS);
        }
 
-       if (could_be_played != can_be_played ()) {
-               signal_changed (DCPContentProperty::CAN_BE_PLAYED);
+       if (needed_assets != needs_assets ()) {
+               signal_changed (DCPContentProperty::NEEDS_ASSETS);
        }
 
-       video->set_frame_type (_three_d ? VIDEO_FRAME_TYPE_3D : VIDEO_FRAME_TYPE_2D);
+       if (needed_kdm != needs_kdm ()) {
+               signal_changed (DCPContentProperty::NEEDS_KDM);
+       }
+
+       if (old_name != name ()) {
+               signal_changed (DCPContentProperty::NAME);
+       }
+
+       signal_changed (AudioContentProperty::STREAMS);
+
+       if (video) {
+               video->set_frame_type (_three_d ? VIDEO_FRAME_TYPE_3D : VIDEO_FRAME_TYPE_2D);
+       }
 }
 
 string
@@ -186,17 +239,22 @@ DCPContent::summary () const
 string
 DCPContent::technical_summary () const
 {
-       return Content::technical_summary() + " - "
-               + video->technical_summary() + " - "
-               + audio->technical_summary() + " - ";
+       string s = Content::technical_summary() + " - ";
+       if (video) {
+               s += video->technical_summary() + " - ";
+       }
+       if (audio) {
+               s += audio->technical_summary() + " - ";
+       }
+       return s;
 }
 
 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);
@@ -209,8 +267,8 @@ DCPContent::as_xml (xmlpp::Node* node) const
                audio->stream()->mapping().as_xml (node->add_child("AudioMapping"));
        }
 
-       if (subtitle) {
-               subtitle->as_xml (node);
+       BOOST_FOREACH (shared_ptr<TextContent> i, caption) {
+               i->as_xml (node);
        }
 
        boost::mutex::scoped_lock lm (_mutex);
@@ -223,7 +281,8 @@ DCPContent::as_xml (xmlpp::Node* node) 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("ReferenceSubtitle")->add_child_text (_reference_subtitle ? "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");
        if (_standard) {
                switch (_standard.get ()) {
                case dcp::INTEROP:
@@ -240,11 +299,17 @@ DCPContent::as_xml (xmlpp::Node* node) const
        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
 DCPContent::full_length () 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 ());
 }
@@ -252,12 +317,20 @@ DCPContent::full_length () const
 string
 DCPContent::identifier () const
 {
-       string s = Content::identifier() + "_" + video->identifier() + "_";
-       if (subtitle) {
-               s += subtitle->identifier () + " ";
+       string s = Content::identifier() + "_";
+
+       if (video) {
+               s += video->identifier() + "_";
+       }
+
+       BOOST_FOREACH (shared_ptr<TextContent> i, caption) {
+               s += i->identifier () + " ";
        }
 
-       s += string (_reference_video ? "1" : "0") + string (_reference_subtitle ? "1" : "0");
+       s += string (_reference_video ? "1" : "0");
+       for (int i = 0; i < CAPTION_COUNT; ++i) {
+               s += string (_reference_caption[i] ? "1" : "0");
+       }
        return s;
 }
 
@@ -296,22 +369,28 @@ DCPContent::needs_assets () const
 vector<boost::filesystem::path>
 DCPContent::directories () const
 {
-       return dcp::DCP::directories_from_files (paths ());
+       return dcp::DCP::directories_from_files (paths());
 }
 
 void
 DCPContent::add_properties (list<UserProperty>& p) const
 {
        Content::add_properties (p);
-       video->add_properties (p);
-       audio->add_properties (p);
+       if (video) {
+               video->add_properties (p);
+       }
+       if (audio) {
+               audio->add_properties (p);
+       }
 }
 
 void
 DCPContent::set_default_colour_conversion ()
 {
        /* Default to no colour conversion for DCPs */
-       video->unset_colour_conversion ();
+       if (video) {
+               video->unset_colour_conversion ();
+       }
 }
 
 void
@@ -337,35 +416,50 @@ DCPContent::set_reference_audio (bool r)
 }
 
 void
-DCPContent::set_reference_subtitle (bool r)
+DCPContent::set_reference_caption (TextType type, bool r)
 {
        {
                boost::mutex::scoped_lock lm (_mutex);
-               _reference_subtitle = r;
+               _reference_caption[type] = r;
        }
 
-       signal_changed (DCPContentProperty::REFERENCE_SUBTITLE);
+       signal_changed (DCPContentProperty::REFERENCE_CAPTION);
 }
 
 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;
@@ -382,69 +476,174 @@ DCPContent::reel_split_points () const
 }
 
 bool
-DCPContent::can_reference (function<shared_ptr<ContentPart> (shared_ptr<const Content>)> part, string overlapping, list<string>& why_not) const
+DCPContent::can_reference (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()) {
-                       why_not.push_back (_("The film is set to SMPTE and this DCP is 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()) {
-                       why_not.push_back (_("The film is set to Interop and this DCP is SMPTE."));
+                       /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
+                       why_not = _("it is SMPTE and the film is set to Interop.");
                        return false;
                }
        }
 
+       /* And the same 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> reel_list;
+       try {
+               reel_list = reels ();
+       } catch (dcp::DCPReadError) {
+               /* We couldn't read the DCP; it's probably missing */
+               return false;
+       } catch (dcp::KDMDecryptionError) {
+               /* We have an incorrect KDM */
+               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 (_("The reel lengths in the film differ from those in the DCP; set the reel mode to 'split by video content'."));
+                       /// 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'.");
                        return false;
                }
        }
 
        ContentList a = overlaps (film()->content(), part, position(), end());
        if (a.size() != 1 || a.front().get() != this) {
-               why_not.push_back (overlapping);
+               why_not = overlapping;
                return false;
        }
 
        return true;
 }
 
+static
+bool check_video (shared_ptr<const Content> c)
+{
+       return static_cast<bool>(c->video);
+}
+
 bool
-DCPContent::can_reference_video (list<string>& why_not) const
+DCPContent::can_reference_video (string& why_not) const
 {
-       return can_reference (bind (&Content::video, _1), _("There is other video content overlapping this DCP; remove it."), why_not);
+       if (!video) {
+               why_not = _("There is no video in this DCP");
+               return false;
+       }
+
+       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);
+}
+
+static
+bool check_audio (shared_ptr<const Content> c)
+{
+       return static_cast<bool>(c->audio);
 }
 
 bool
-DCPContent::can_reference_audio (list<string>& why_not) const
+DCPContent::can_reference_audio (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(), false));
+       } catch (dcp::DCPReadError) {
+               /* We couldn't read the DCP, so it's probably missing */
+               return false;
+       } catch (DCPError) {
+               /* We couldn't read the DCP, so it's probably missing */
+               return false;
+       } catch (dcp::KDMDecryptionError) {
+               /* We have an incorrect KDM */
+               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."));
+                       /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
+                        why_not = _("it does not have sound in all its reels.");
                         return false;
                 }
         }
 
-        return can_reference (bind (&Content::audio, _1),   _("There is other audio content overlapping this DCP; remove it."), why_not);
+       /// 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);
 }
 
+static
+bool check_caption (shared_ptr<const Content> c)
+{
+       return !c->caption.empty();
+}
 bool
-DCPContent::can_reference_subtitle (list<string>& why_not) const
+DCPContent::can_reference_caption (TextType type, string& why_not) const
 {
-        DCPDecoder decoder (shared_from_this(), film()->log());
-        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."));
+       shared_ptr<DCPDecoder> decoder;
+       try {
+               decoder.reset (new DCPDecoder (shared_from_this(), film()->log(), false));
+       } catch (dcp::DCPReadError) {
+               /* We couldn't read the DCP, so it's probably missing */
+               return false;
+       } catch (dcp::KDMDecryptionError) {
+               /* We have an incorrect KDM */
+               return false;
+       }
+
+        BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
+                if (type == CAPTION_OPEN && !i->main_subtitle()) {
+                       /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
+                        why_not = _("it does not have subtitles in all its reels.");
                         return false;
                 }
+               if (type == CAPTION_CLOSED && !i->closed_caption()) {
+                       /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
+                        why_not = _("it does not have closed captions in all its reels.");
+                        return false;
+               }
         }
 
-        return can_reference (bind (&Content::subtitle, _1), _("There is other subtitle content overlapping this DCP; remove it."), why_not);
+       /// 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);
+}
+
+void
+DCPContent::take_settings_from (shared_ptr<const Content> c)
+{
+       shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (c);
+       if (!dc) {
+               return;
+       }
+
+       _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];
+       }
+}
+
+void
+DCPContent::set_cpl (string id)
+{
+       boost::mutex::scoped_lock lm (_mutex);
+       _cpl = id;
 }