2 Copyright (C) 2014-2020 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 #include "atmos_content.h"
22 #include "dcp_content.h"
23 #include "video_content.h"
24 #include "audio_content.h"
25 #include "dcp_examiner.h"
30 #include "compose.hpp"
31 #include "dcp_decoder.h"
33 #include "dcpomatic_log.h"
34 #include "text_content.h"
36 #include <dcp/raw_convert.h>
37 #include <dcp/exceptions.h>
38 #include <dcp/reel_picture_asset.h>
40 #include <libxml++/libxml++.h>
41 #include <boost/foreach.hpp>
54 using boost::shared_ptr;
55 using boost::scoped_ptr;
56 using boost::optional;
57 using boost::function;
58 using boost::dynamic_pointer_cast;
59 using dcp::raw_convert;
60 using namespace dcpomatic;
62 int const DCPContentProperty::NEEDS_ASSETS = 600;
63 int const DCPContentProperty::NEEDS_KDM = 601;
64 int const DCPContentProperty::REFERENCE_VIDEO = 602;
65 int const DCPContentProperty::REFERENCE_AUDIO = 603;
66 int const DCPContentProperty::REFERENCE_TEXT = 604;
67 int const DCPContentProperty::NAME = 605;
68 int const DCPContentProperty::TEXTS = 606;
69 int const DCPContentProperty::CPL = 607;
71 DCPContent::DCPContent (boost::filesystem::path p)
73 , _needs_assets (false)
75 , _reference_video (false)
76 , _reference_audio (false)
79 LOG_GENERAL ("Creating DCP content from %1", p.string());
82 set_default_colour_conversion ();
84 for (int i = 0; i < TEXT_COUNT; ++i) {
85 _reference_text[i] = false;
89 DCPContent::DCPContent (cxml::ConstNodePtr node, int version)
92 video = VideoContent::from_xml (this, node, version);
93 audio = AudioContent::from_xml (this, node, version);
94 text = TextContent::from_xml (this, node, version);
95 atmos = AtmosContent::from_xml (this, node);
97 for (int i = 0; i < TEXT_COUNT; ++i) {
98 _reference_text[i] = false;
101 if (video && audio) {
105 node->number_child<int> ("AudioFrameRate"),
106 /* AudioLength was not present in some old metadata versions */
107 node->optional_number_child<Frame>("AudioLength").get_value_or (
108 video->length() * node->number_child<int>("AudioFrameRate") / video_frame_rate().get()
110 AudioMapping (node->node_child ("AudioMapping"), version)
116 _name = node->string_child ("Name");
117 _encrypted = node->bool_child ("Encrypted");
118 _needs_assets = node->optional_bool_child("NeedsAssets").get_value_or (false);
119 if (node->optional_node_child ("KDM")) {
120 _kdm = dcp::EncryptedKDM (node->string_child ("KDM"));
122 _kdm_valid = node->bool_child ("KDMValid");
123 _reference_video = node->optional_bool_child ("ReferenceVideo").get_value_or (false);
124 _reference_audio = node->optional_bool_child ("ReferenceAudio").get_value_or (false);
126 _reference_text[TEXT_OPEN_SUBTITLE] = node->optional_bool_child("ReferenceOpenSubtitle").get_value_or(false);
127 _reference_text[TEXT_CLOSED_CAPTION] = node->optional_bool_child("ReferenceClosedCaption").get_value_or(false);
129 _reference_text[TEXT_OPEN_SUBTITLE] = node->optional_bool_child("ReferenceSubtitle").get_value_or(false);
130 _reference_text[TEXT_CLOSED_CAPTION] = false;
132 if (node->optional_string_child("Standard")) {
133 string const s = node->optional_string_child("Standard").get();
134 if (s == "Interop") {
135 _standard = dcp::INTEROP;
136 } else if (s == "SMPTE") {
137 _standard = dcp::SMPTE;
139 DCPOMATIC_ASSERT (false);
142 _three_d = node->optional_bool_child("ThreeD").get_value_or (false);
144 optional<string> ck = node->optional_string_child("ContentKind");
146 _content_kind = dcp::content_kind_from_string (*ck);
148 _cpl = node->optional_string_child("CPL");
149 BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("ReelLength")) {
150 _reel_lengths.push_back (raw_convert<int64_t> (i->content ()));
153 BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("Marker")) {
154 _markers[dcp::marker_from_string(i->string_attribute("type"))] = ContentTime(raw_convert<int64_t>(i->content()));
157 BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("Rating")) {
158 _ratings.push_back (dcp::Rating(i));
161 BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("ContentVersion")) {
162 _content_versions.push_back (i->content());
167 DCPContent::read_directory (boost::filesystem::path p)
169 read_sub_directory (p);
171 bool have_assetmap = false;
172 BOOST_FOREACH (boost::filesystem::path i, paths()) {
173 if (i.filename() == "ASSETMAP" || i.filename() == "ASSETMAP.xml") {
174 have_assetmap = true;
178 if (!have_assetmap) {
179 throw DCPError ("No ASSETMAP or ASSETMAP.xml file found: is this a DCP?");
184 DCPContent::read_sub_directory (boost::filesystem::path p)
186 LOG_GENERAL ("DCPContent::read_sub_directory reads %1", p.string());
187 for (boost::filesystem::directory_iterator i(p); i != boost::filesystem::directory_iterator(); ++i) {
188 if (boost::filesystem::is_regular_file (i->path())) {
189 LOG_GENERAL ("Inside there's regular file %1", i->path().string());
190 add_path (i->path());
191 } else if (boost::filesystem::is_directory (i->path ())) {
192 LOG_GENERAL ("Inside there's directory %1", i->path().string());
193 read_sub_directory (i->path());
198 /** @param film Film, or 0 */
200 DCPContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
202 bool const needed_assets = needs_assets ();
203 bool const needed_kdm = needs_kdm ();
204 string const old_name = name ();
206 ChangeSignaller<Content> cc_texts (this, DCPContentProperty::TEXTS);
207 ChangeSignaller<Content> cc_assets (this, DCPContentProperty::NEEDS_ASSETS);
208 ChangeSignaller<Content> cc_kdm (this, DCPContentProperty::NEEDS_KDM);
209 ChangeSignaller<Content> cc_name (this, DCPContentProperty::NAME);
212 job->set_progress_unknown ();
214 Content::examine (film, job);
216 shared_ptr<DCPExaminer> examiner (new DCPExaminer(shared_from_this(), film ? film->tolerant() : true));
218 if (examiner->has_video()) {
220 boost::mutex::scoped_lock lm (_mutex);
221 video.reset (new VideoContent (this));
223 video->take_from_examiner (examiner);
224 set_default_colour_conversion ();
227 if (examiner->has_audio()) {
229 boost::mutex::scoped_lock lm (_mutex);
230 audio.reset (new AudioContent (this));
232 AudioStreamPtr as (new AudioStream (examiner->audio_frame_rate(), examiner->audio_length(), examiner->audio_channels()));
233 audio->set_stream (as);
234 AudioMapping m = as->mapping ();
235 m.make_default (film ? film->audio_processor() : 0);
239 if (examiner->has_atmos()) {
241 boost::mutex::scoped_lock lm (_mutex);
242 atmos.reset (new AtmosContent(this));
244 /* Setting length will cause calculations to be made based on edit rate, so that must
245 * be set up first otherwise hard-to-spot exceptions will be thrown.
247 atmos->set_edit_rate (examiner->atmos_edit_rate());
248 atmos->set_length (examiner->atmos_length());
251 list<shared_ptr<TextContent> > new_text;
252 for (int i = 0; i < TEXT_COUNT; ++i) {
253 for (int j = 0; j < examiner->text_count(static_cast<TextType>(i)); ++j) {
254 shared_ptr<TextContent> c(new TextContent(this, static_cast<TextType>(i), static_cast<TextType>(i)));
255 if (i == TEXT_CLOSED_CAPTION) {
256 c->set_dcp_track (examiner->dcp_text_track(j));
258 new_text.push_back (c);
263 boost::mutex::scoped_lock lm (_mutex);
265 _name = examiner->name ();
266 _encrypted = examiner->encrypted ();
267 _needs_assets = examiner->needs_assets ();
268 _kdm_valid = examiner->kdm_valid ();
269 _standard = examiner->standard ();
270 _three_d = examiner->three_d ();
271 _content_kind = examiner->content_kind ();
272 _cpl = examiner->cpl ();
273 _reel_lengths = examiner->reel_lengths ();
274 map<dcp::Marker, dcp::Time> markers = examiner->markers();
275 for (map<dcp::Marker, dcp::Time>::const_iterator i = markers.begin(); i != markers.end(); ++i) {
276 _markers[i->first] = ContentTime(i->second.as_editable_units(DCPTime::HZ));
278 _ratings = examiner->ratings ();
279 _content_versions = examiner->content_versions ();
282 if (needed_assets == needs_assets()) {
286 if (needed_kdm == needs_kdm()) {
290 if (old_name == name()) {
295 video->set_frame_type (_three_d ? VIDEO_FRAME_TYPE_3D : VIDEO_FRAME_TYPE_2D);
300 DCPContent::summary () const
302 boost::mutex::scoped_lock lm (_mutex);
303 return String::compose (_("%1 [DCP]"), _name);
307 DCPContent::technical_summary () const
309 string s = Content::technical_summary() + " - ";
311 s += video->technical_summary() + " - ";
314 s += audio->technical_summary() + " - ";
320 DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
322 node->add_child("Type")->add_child_text ("DCP");
324 Content::as_xml (node, with_paths);
327 video->as_xml (node);
331 audio->as_xml (node);
332 node->add_child("AudioFrameRate")->add_child_text (raw_convert<string> (audio->stream()->frame_rate()));
333 node->add_child("AudioLength")->add_child_text (raw_convert<string> (audio->stream()->length()));
334 audio->stream()->mapping().as_xml (node->add_child("AudioMapping"));
337 BOOST_FOREACH (shared_ptr<TextContent> i, text) {
342 atmos->as_xml (node);
345 boost::mutex::scoped_lock lm (_mutex);
346 node->add_child("Name")->add_child_text (_name);
347 node->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
348 node->add_child("NeedsAssets")->add_child_text (_needs_assets ? "1" : "0");
350 node->add_child("KDM")->add_child_text (_kdm->as_xml ());
352 node->add_child("KDMValid")->add_child_text (_kdm_valid ? "1" : "0");
353 node->add_child("ReferenceVideo")->add_child_text (_reference_video ? "1" : "0");
354 node->add_child("ReferenceAudio")->add_child_text (_reference_audio ? "1" : "0");
355 node->add_child("ReferenceOpenSubtitle")->add_child_text(_reference_text[TEXT_OPEN_SUBTITLE] ? "1" : "0");
356 node->add_child("ReferenceClosedCaption")->add_child_text(_reference_text[TEXT_CLOSED_CAPTION] ? "1" : "0");
358 switch (_standard.get ()) {
360 node->add_child("Standard")->add_child_text ("Interop");
363 node->add_child("Standard")->add_child_text ("SMPTE");
366 DCPOMATIC_ASSERT (false);
369 node->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
371 node->add_child("ContentKind")->add_child_text(dcp::content_kind_to_string(*_content_kind));
374 node->add_child("CPL")->add_child_text (_cpl.get ());
376 BOOST_FOREACH (int64_t i, _reel_lengths) {
377 node->add_child("ReelLength")->add_child_text (raw_convert<string> (i));
380 for (map<dcp::Marker, ContentTime>::const_iterator i = _markers.begin(); i != _markers.end(); ++i) {
381 xmlpp::Element* marker = node->add_child("Marker");
382 marker->set_attribute("type", dcp::marker_to_string(i->first));
383 marker->add_child_text(raw_convert<string>(i->second.get()));
386 BOOST_FOREACH (dcp::Rating i, _ratings) {
387 xmlpp::Element* rating = node->add_child("Rating");
391 BOOST_FOREACH (string i, _content_versions) {
392 node->add_child("ContentVersion")->add_child_text(i);
397 DCPContent::full_length (shared_ptr<const Film> film) const
402 FrameRateChange const frc (film, shared_from_this());
403 return DCPTime::from_frames (llrint(video->length() * frc.factor()), film->video_frame_rate());
407 DCPContent::approximate_length () const
412 return DCPTime::from_frames (video->length(), 24);
416 DCPContent::identifier () const
418 string s = Content::identifier() + "_";
421 s += video->identifier() + "_";
424 BOOST_FOREACH (shared_ptr<TextContent> i, text) {
425 s += i->identifier () + " ";
428 s += string (_reference_video ? "1" : "0");
429 for (int i = 0; i < TEXT_COUNT; ++i) {
430 s += string (_reference_text[i] ? "1" : "0");
436 DCPContent::add_kdm (dcp::EncryptedKDM k)
442 DCPContent::add_ov (boost::filesystem::path ov)
448 DCPContent::can_be_played () const
450 return !needs_kdm() && !needs_assets();
454 DCPContent::needs_kdm () const
456 boost::mutex::scoped_lock lm (_mutex);
457 return _encrypted && !_kdm_valid;
461 DCPContent::needs_assets () const
463 boost::mutex::scoped_lock lm (_mutex);
464 return _needs_assets;
467 vector<boost::filesystem::path>
468 DCPContent::directories () const
470 return dcp::DCP::directories_from_files (paths());
474 DCPContent::add_properties (shared_ptr<const Film> film, list<UserProperty>& p) const
476 Content::add_properties (film, p);
478 video->add_properties (p);
481 audio->add_properties (film, p);
486 DCPContent::set_default_colour_conversion ()
488 /* Default to no colour conversion for DCPs */
490 video->unset_colour_conversion ();
495 DCPContent::set_reference_video (bool r)
497 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_VIDEO);
500 boost::mutex::scoped_lock lm (_mutex);
501 _reference_video = r;
506 DCPContent::set_reference_audio (bool r)
508 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_AUDIO);
511 boost::mutex::scoped_lock lm (_mutex);
512 _reference_audio = r;
517 DCPContent::set_reference_text (TextType type, bool r)
519 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_TEXT);
522 boost::mutex::scoped_lock lm (_mutex);
523 _reference_text[type] = r;
528 DCPContent::reels (shared_ptr<const Film> film) const
530 list<int64_t> reel_lengths = _reel_lengths;
531 if (reel_lengths.empty ()) {
532 /* Old metadata with no reel lengths; get them here instead */
534 scoped_ptr<DCPExaminer> examiner (new DCPExaminer(shared_from_this(), film->tolerant()));
535 reel_lengths = examiner->reel_lengths ();
537 /* Could not examine the DCP; guess reels */
538 reel_lengths.push_back (length_after_trim(film).frames_round(film->video_frame_rate()));
542 list<DCPTimePeriod> p;
544 /* This content's frame rate must be the same as the output DCP rate, so we can
545 convert `directly' from ContentTime to DCPTime.
548 /* The starting point of this content on the timeline */
549 DCPTime pos = position() - DCPTime (trim_start().get());
551 BOOST_FOREACH (int64_t i, reel_lengths) {
552 /* This reel runs from `pos' to `to' */
553 DCPTime const to = pos + DCPTime::from_frames (i, film->video_frame_rate());
554 if (to > position()) {
555 p.push_back (DCPTimePeriod (max(position(), pos), min(end(film), to)));
556 if (to > end(film)) {
567 DCPContent::reel_split_points (shared_ptr<const Film> film) const
570 BOOST_FOREACH (DCPTimePeriod i, reels(film)) {
571 s.push_back (i.from);
577 DCPContent::can_reference (shared_ptr<const Film> film, function<bool (shared_ptr<const Content>)> part, string overlapping, string& why_not) const
579 /* We must be using the same standard as the film */
581 if (_standard.get() == dcp::INTEROP && !film->interop()) {
582 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
583 why_not = _("it is Interop and the film is set to SMPTE.");
585 } else if (_standard.get() == dcp::SMPTE && film->interop()) {
586 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
587 why_not = _("it is SMPTE and the film is set to Interop.");
592 /* And the same frame rate */
593 if (!video_frame_rate() || (lrint(video_frame_rate().get()) != film->video_frame_rate())) {
594 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
595 why_not = _("it has a different frame rate to the film.");
599 list<DCPTimePeriod> const fr = film->reels ();
601 list<DCPTimePeriod> reel_list;
603 reel_list = reels (film);
604 } catch (dcp::ReadError &) {
605 /* We couldn't read the DCP; it's probably missing */
607 } catch (dcp::KDMDecryptionError &) {
608 /* We have an incorrect KDM */
612 /* fr must contain reels(). It can also contain other reels, but it must at
613 least contain reels().
615 BOOST_FOREACH (DCPTimePeriod i, reel_list) {
616 if (find (fr.begin(), fr.end(), i) == fr.end ()) {
617 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
618 why_not = _("its reel lengths differ from those in the film; set the reel mode to 'split by video content'.");
623 ContentList a = overlaps (film, film->content(), part, position(), end(film));
624 if (a.size() != 1 || a.front().get() != this) {
625 why_not = overlapping;
633 bool check_video (shared_ptr<const Content> c)
635 return static_cast<bool>(c->video) && c->video->use();
639 DCPContent::can_reference_video (shared_ptr<const Film> film, string& why_not) const
642 why_not = _("There is no video in this DCP");
646 if (film->resolution() != resolution()) {
647 if (resolution() == RESOLUTION_4K) {
648 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
649 why_not = _("it is 4K and the film is 2K.");
651 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
652 why_not = _("it is 2K and the film is 4K.");
655 } else if (film->frame_size() != video->size()) {
656 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
657 why_not = _("its video frame size differs from the film's.");
661 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
662 return can_reference (film, bind (&check_video, _1), _("it overlaps other video content; remove the other content."), why_not);
666 bool check_audio (shared_ptr<const Content> c)
668 return static_cast<bool>(c->audio) && !c->audio->mapping().mapped_output_channels().empty();
672 DCPContent::can_reference_audio (shared_ptr<const Film> film, string& why_not) const
674 shared_ptr<DCPDecoder> decoder;
676 decoder.reset (new DCPDecoder (film, shared_from_this(), false, film->tolerant(), shared_ptr<DCPDecoder>()));
677 } catch (dcp::ReadError &) {
678 /* We couldn't read the DCP, so it's probably missing */
680 } catch (DCPError &) {
681 /* We couldn't read the DCP, so it's probably missing */
683 } catch (dcp::KDMDecryptionError &) {
684 /* We have an incorrect KDM */
688 BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
689 if (!i->main_sound()) {
690 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
691 why_not = _("it does not have sound in all its reels.");
696 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
697 return can_reference (film, bind (&check_audio, _1), _("it overlaps other audio content; remove the other content."), why_not);
701 bool check_text (shared_ptr<const Content> c)
703 return !c->text.empty();
707 DCPContent::can_reference_text (shared_ptr<const Film> film, TextType type, string& why_not) const
709 shared_ptr<DCPDecoder> decoder;
711 decoder.reset (new DCPDecoder (film, shared_from_this(), false, film->tolerant(), shared_ptr<DCPDecoder>()));
712 } catch (dcp::ReadError &) {
713 /* We couldn't read the DCP, so it's probably missing */
715 } catch (dcp::KDMDecryptionError &) {
716 /* We have an incorrect KDM */
720 BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
721 if (type == TEXT_OPEN_SUBTITLE && !i->main_subtitle()) {
722 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
723 why_not = _("it does not have open subtitles in all its reels.");
726 if (type == TEXT_CLOSED_CAPTION && i->closed_captions().empty()) {
727 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
728 why_not = _("it does not have closed captions in all its reels.");
733 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
734 return can_reference (film, bind (&check_text, _1), _("it overlaps other text content; remove the other content."), why_not);
738 DCPContent::take_settings_from (shared_ptr<const Content> c)
740 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (c);
745 _reference_video = dc->_reference_video;
746 _reference_audio = dc->_reference_audio;
747 for (int i = 0; i < TEXT_COUNT; ++i) {
748 _reference_text[i] = dc->_reference_text[i];
753 DCPContent::set_cpl (string id)
755 ChangeSignaller<Content> cc (this, DCPContentProperty::CPL);
758 boost::mutex::scoped_lock lm (_mutex);
764 DCPContent::kdm_timing_window_valid () const
771 return _kdm->not_valid_before() < now && now < _kdm->not_valid_after();
776 DCPContent::resolution () const
778 if (video->size().width > 2048 || video->size().height > 1080) {
779 return RESOLUTION_4K;
782 return RESOLUTION_2K;