X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fdcp_content.cc;h=e56ad9e21f7e7ccaa086ed646a962a38548e475f;hb=cbd4450197a083bf58bda510e626f73ba583cb66;hp=a5b5f37e13f967a9c4845d707000f19049c140cb;hpb=12efbd5938f08eb445b43f539fa4f27aa5caccfb;p=dcpomatic.git diff --git a/src/lib/dcp_content.cc b/src/lib/dcp_content.cc index a5b5f37e1..e56ad9e21 100644 --- a/src/lib/dcp_content.cc +++ b/src/lib/dcp_content.cc @@ -1,77 +1,151 @@ /* - Copyright (C) 2014 Carl Hetherington + Copyright (C) 2014-2018 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of DCP-o-matic. + + DCP-o-matic is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - This program is distributed in the hope that it will be useful, + DCP-o-matic is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + along with DCP-o-matic. If not, see . */ -#include -#include #include "dcp_content.h" +#include "video_content.h" +#include "audio_content.h" #include "dcp_examiner.h" #include "job.h" #include "film.h" #include "config.h" +#include "overlaps.h" #include "compose.hpp" +#include "dcp_decoder.h" +#include "caption_content.h" +#include +#include +#include +#include +#include +#include +#include +#include +#include #include "i18n.h" using std::string; using std::cout; +using std::distance; +using std::pair; +using std::vector; +using std::list; 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::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 f, boost::filesystem::path p) - : Content (f) - , VideoContent (f) - , SingleStreamAudioContent (f) - , SubtitleContent (f) - , _has_subtitles (false) +DCPContent::DCPContent (shared_ptr film, boost::filesystem::path p) + : Content (film) , _encrypted (false) - , _directory (p) + , _needs_assets (false) , _kdm_valid (false) + , _reference_video (false) + , _reference_audio (false) + , _three_d (false) { read_directory (p); + set_default_colour_conversion (); + + for (int i = 0; i < CAPTION_COUNT; ++i) { + _reference_caption[i] = false; + } } -DCPContent::DCPContent (shared_ptr f, cxml::ConstNodePtr node, int version) - : Content (f, node) - , VideoContent (f, node, version) - , SingleStreamAudioContent (f, node, version) - , SubtitleContent (f, node, version) +DCPContent::DCPContent (shared_ptr film, cxml::ConstNodePtr node, int version) + : Content (film, node) { + video = VideoContent::from_xml (this, node, version); + audio = AudioContent::from_xml (this, node, version); + caption = CaptionContent::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 ("AudioFrameRate"), + /* AudioLength was not present in some old metadata versions */ + node->optional_number_child("AudioLength").get_value_or ( + video->length() * node->number_child("AudioFrameRate") / video_frame_rate().get() + ), + AudioMapping (node->node_child ("AudioMapping"), version) + ) + ) + ); + } + _name = node->string_child ("Name"); - _has_subtitles = node->bool_child ("HasSubtitles"); - _directory = node->string_child ("Directory"); _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")); } _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); + 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") { + _standard = dcp::INTEROP; + } else if (s == "SMPTE") { + _standard = dcp::SMPTE; + } else { + DCPOMATIC_ASSERT (false); + } + } + _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 (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()); } } } @@ -79,23 +153,77 @@ DCPContent::read_directory (boost::filesystem::path p) void DCPContent::examine (shared_ptr job) { - bool const could_be_played = can_be_played (); - - job->set_progress_unknown (); + bool const needed_assets = needs_assets (); + bool const needed_kdm = needs_kdm (); + string const old_name = name (); + int const old_captions = caption.size (); + + if (job) { + job->set_progress_unknown (); + } Content::examine (job); - + shared_ptr examiner (new DCPExaminer (shared_from_this ())); - take_from_video_examiner (examiner); - take_from_audio_examiner (examiner); - boost::mutex::scoped_lock lm (_mutex); - _name = examiner->name (); - _has_subtitles = examiner->has_subtitles (); - _encrypted = examiner->encrypted (); - _kdm_valid = examiner->kdm_valid (); + 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 (could_be_played != can_be_played ()) { - signal_changed (DCPContentProperty::CAN_BE_PLAYED); + 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); + } + + int captions = 0; + { + boost::mutex::scoped_lock lm (_mutex); + _name = examiner->name (); + for (int i = 0; i < examiner->captions(); ++i) { + caption.push_back (shared_ptr (new CaptionContent (this))); + } + 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 (needed_assets != needs_assets ()) { + signal_changed (DCPContentProperty::NEEDS_ASSETS); + } + + 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); } } @@ -109,44 +237,99 @@ DCPContent::summary () const string DCPContent::technical_summary () const { - return Content::technical_summary() + " - " - + VideoContent::technical_summary() + " - " - + AudioContent::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); - VideoContent::as_xml (node); - SingleStreamAudioContent::as_xml (node); - SubtitleContent::as_xml (node); + Content::as_xml (node, with_paths); + + if (video) { + video->as_xml (node); + } + + if (audio) { + audio->as_xml (node); + node->add_child("AudioFrameRate")->add_child_text (raw_convert (audio->stream()->frame_rate())); + node->add_child("AudioLength")->add_child_text (raw_convert (audio->stream()->length())); + audio->stream()->mapping().as_xml (node->add_child("AudioMapping")); + } + + BOOST_FOREACH (shared_ptr i, caption) { + i->as_xml (node); + } boost::mutex::scoped_lock lm (_mutex); node->add_child("Name")->add_child_text (_name); - node->add_child("HasSubtitles")->add_child_text (_has_subtitles ? "1" : "0"); node->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0"); - node->add_child("Directory")->add_child_text (_directory.string ()); + node->add_child("NeedsAssets")->add_child_text (_needs_assets ? "1" : "0"); if (_kdm) { node->add_child("KDM")->add_child_text (_kdm->as_xml ()); } 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("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: + node->add_child("Standard")->add_child_text ("Interop"); + break; + case dcp::SMPTE: + node->add_child("Standard")->add_child_text ("SMPTE"); + break; + default: + DCPOMATIC_ASSERT (false); + } + } + 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 (i)); + } } DCPTime DCPContent::full_length () const { - shared_ptr film = _film.lock (); - assert (film); - return DCPTime (video_length (), FrameRateChange (video_frame_rate (), film->video_frame_rate ())); + 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 ()); } string DCPContent::identifier () const { - return SubtitleContent::identifier (); + string s = Content::identifier() + "_"; + + if (video) { + s += video->identifier() + "_"; + } + + BOOST_FOREACH (shared_ptr i, caption) { + s += i->identifier () + " "; + } + + s += string (_reference_video ? "1" : "0"); + for (int i = 0; i < CAPTION_COUNT; ++i) { + s += string (_reference_caption[i] ? "1" : "0"); + } + return s; } void @@ -155,8 +338,310 @@ 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 !_encrypted || _kdm_valid; + return !needs_kdm() && !needs_assets(); +} + +bool +DCPContent::needs_kdm () const +{ + boost::mutex::scoped_lock lm (_mutex); + return _encrypted && !_kdm_valid; +} + +bool +DCPContent::needs_assets () const +{ + boost::mutex::scoped_lock lm (_mutex); + return _needs_assets; +} + +vector +DCPContent::directories () const +{ + return dcp::DCP::directories_from_files (paths()); +} + +void +DCPContent::add_properties (list& p) const +{ + Content::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 */ + if (video) { + video->unset_colour_conversion (); + } +} + +void +DCPContent::set_reference_video (bool r) +{ + { + boost::mutex::scoped_lock lm (_mutex); + _reference_video = r; + } + + signal_changed (DCPContentProperty::REFERENCE_VIDEO); +} + +void +DCPContent::set_reference_audio (bool r) +{ + { + boost::mutex::scoped_lock lm (_mutex); + _reference_audio = r; + } + + signal_changed (DCPContentProperty::REFERENCE_AUDIO); +} + +void +DCPContent::set_reference_caption (CaptionType type, bool r) +{ + { + boost::mutex::scoped_lock lm (_mutex); + _reference_caption[type] = r; + } + + signal_changed (DCPContentProperty::REFERENCE_CAPTION); +} + +list +DCPContent::reels () const +{ + list reel_lengths = _reel_lengths; + if (reel_lengths.empty ()) { + /* Old metadata with no reel lengths; get them here instead */ + try { + scoped_ptr 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 ())); + } + } + + list 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; +} + +list +DCPContent::reel_split_points () const +{ + list s; + BOOST_FOREACH (DCPTimePeriod i, reels()) { + s.push_back (i.from); + } + return s; +} + +bool +DCPContent::can_reference (function)> 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()) { + /// 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()) { + /// 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 const fr = film()->reels (); + + list 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, 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'."); + return false; + } + } + + ContentList a = overlaps (film()->content(), part, position(), end()); + if (a.size() != 1 || a.front().get() != this) { + why_not = overlapping; + return false; + } + + return true; +} + +static +bool check_video (shared_ptr c) +{ + return static_cast(c->video); +} + +bool +DCPContent::can_reference_video (string& why_not) const +{ + 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 c) +{ + return static_cast(c->audio); +} + +bool +DCPContent::can_reference_audio (string& why_not) const +{ + shared_ptr 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 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."); + return false; + } + } + + /// 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 c) +{ + return !c->caption.empty(); +} +bool +DCPContent::can_reference_caption (CaptionType type, string& why_not) const +{ + shared_ptr 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 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; + } + } + + /// 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 c) +{ + shared_ptr dc = dynamic_pointer_cast (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; }