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_closed_caption_asset.h>
39 #include <dcp/reel_picture_asset.h>
40 #include <dcp/reel_subtitle_asset.h>
42 #include <libxml++/libxml++.h>
51 using std::make_shared;
54 using std::shared_ptr;
57 using boost::scoped_ptr;
58 using boost::optional;
59 using boost::function;
60 using std::dynamic_pointer_cast;
61 #if BOOST_VERSION >= 106100
62 using namespace boost::placeholders;
64 using dcp::raw_convert;
65 using namespace dcpomatic;
67 int const DCPContentProperty::NEEDS_ASSETS = 600;
68 int const DCPContentProperty::NEEDS_KDM = 601;
69 int const DCPContentProperty::REFERENCE_VIDEO = 602;
70 int const DCPContentProperty::REFERENCE_AUDIO = 603;
71 int const DCPContentProperty::REFERENCE_TEXT = 604;
72 int const DCPContentProperty::NAME = 605;
73 int const DCPContentProperty::TEXTS = 606;
74 int const DCPContentProperty::CPL = 607;
76 DCPContent::DCPContent (boost::filesystem::path p)
78 , _needs_assets (false)
80 , _reference_video (false)
81 , _reference_audio (false)
84 LOG_GENERAL ("Creating DCP content from %1", p.string());
87 set_default_colour_conversion ();
89 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
90 _reference_text[i] = false;
94 DCPContent::DCPContent (cxml::ConstNodePtr node, int version)
97 video = VideoContent::from_xml (this, node, version);
98 audio = AudioContent::from_xml (this, node, version);
99 text = TextContent::from_xml (this, node, version);
100 atmos = AtmosContent::from_xml (this, node);
102 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
103 _reference_text[i] = false;
106 if (video && audio) {
108 make_shared<AudioStream> (
109 node->number_child<int> ("AudioFrameRate"),
110 /* AudioLength was not present in some old metadata versions */
111 node->optional_number_child<Frame>("AudioLength").get_value_or (
112 video->length() * node->number_child<int>("AudioFrameRate") / video_frame_rate().get()
114 AudioMapping (node->node_child ("AudioMapping"), version)
119 _name = node->string_child ("Name");
120 _encrypted = node->bool_child ("Encrypted");
121 _needs_assets = node->optional_bool_child("NeedsAssets").get_value_or (false);
122 if (node->optional_node_child ("KDM")) {
123 _kdm = dcp::EncryptedKDM (node->string_child ("KDM"));
125 _kdm_valid = node->bool_child ("KDMValid");
126 _reference_video = node->optional_bool_child ("ReferenceVideo").get_value_or (false);
127 _reference_audio = node->optional_bool_child ("ReferenceAudio").get_value_or (false);
129 _reference_text[static_cast<int>(TextType::OPEN_SUBTITLE)] = node->optional_bool_child("ReferenceOpenSubtitle").get_value_or(false);
130 _reference_text[static_cast<int>(TextType::CLOSED_CAPTION)] = node->optional_bool_child("ReferenceClosedCaption").get_value_or(false);
132 _reference_text[static_cast<int>(TextType::OPEN_SUBTITLE)] = node->optional_bool_child("ReferenceSubtitle").get_value_or(false);
133 _reference_text[static_cast<int>(TextType::CLOSED_CAPTION)] = false;
135 if (node->optional_string_child("Standard")) {
136 auto const s = node->optional_string_child("Standard").get();
137 if (s == "Interop") {
138 _standard = dcp::Standard::INTEROP;
139 } else if (s == "SMPTE") {
140 _standard = dcp::Standard::SMPTE;
142 DCPOMATIC_ASSERT (false);
145 _three_d = node->optional_bool_child("ThreeD").get_value_or (false);
147 auto ck = node->optional_string_child("ContentKind");
149 _content_kind = dcp::content_kind_from_string (*ck);
151 _cpl = node->optional_string_child("CPL");
152 for (auto i: node->node_children("ReelLength")) {
153 _reel_lengths.push_back (raw_convert<int64_t> (i->content ()));
156 for (auto i: node->node_children("Marker")) {
157 _markers[dcp::marker_from_string(i->string_attribute("type"))] = ContentTime(raw_convert<int64_t>(i->content()));
160 for (auto i: node->node_children("Rating")) {
161 _ratings.push_back (dcp::Rating(i));
164 for (auto i: node->node_children("ContentVersion")) {
165 _content_versions.push_back (i->content());
170 DCPContent::read_directory (boost::filesystem::path p)
172 using namespace boost::filesystem;
174 bool have_assetmap = false;
175 bool have_metadata = false;
177 for (directory_iterator i(p); i != directory_iterator(); ++i) {
178 if (i->path().filename() == "ASSETMAP" || i->path().filename() == "ASSETMAP.xml") {
179 have_assetmap = true;
180 } else if (i->path().filename() == "metadata.xml") {
181 have_metadata = true;
185 if (!have_assetmap) {
186 if (!have_metadata) {
187 throw DCPError ("No ASSETMAP or ASSETMAP.xml file found: is this a DCP?");
190 "This looks like a DCP-o-matic project folder, which cannot be added to a different project. "
191 "Choose the DCP directory inside the DCP-o-matic project folder if that's what you want to import."
196 read_sub_directory (p);
200 DCPContent::read_sub_directory (boost::filesystem::path p)
202 LOG_GENERAL ("DCPContent::read_sub_directory reads %1", p.string());
203 for (auto i: boost::filesystem::directory_iterator(p)) {
204 if (boost::filesystem::is_regular_file(i.path())) {
205 LOG_GENERAL ("Inside there's regular file %1", i.path().string());
207 } else if (boost::filesystem::is_directory (i.path())) {
208 LOG_GENERAL ("Inside there's directory %1", i.path().string());
209 read_sub_directory (i.path());
214 /** @param film Film, or 0 */
216 DCPContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
218 bool const needed_assets = needs_assets ();
219 bool const needed_kdm = needs_kdm ();
220 string const old_name = name ();
222 ContentChangeSignaller cc_texts (this, DCPContentProperty::TEXTS);
223 ContentChangeSignaller cc_assets (this, DCPContentProperty::NEEDS_ASSETS);
224 ContentChangeSignaller cc_kdm (this, DCPContentProperty::NEEDS_KDM);
225 ContentChangeSignaller cc_name (this, DCPContentProperty::NAME);
228 job->set_progress_unknown ();
230 Content::examine (film, job);
232 auto examiner = make_shared<DCPExaminer>(shared_from_this(), film ? film->tolerant() : true);
234 if (examiner->has_video()) {
236 boost::mutex::scoped_lock lm (_mutex);
237 video = make_shared<VideoContent>(this);
239 video->take_from_examiner (examiner);
240 set_default_colour_conversion ();
243 if (examiner->has_audio()) {
245 boost::mutex::scoped_lock lm (_mutex);
246 audio = make_shared<AudioContent>(this);
248 auto as = make_shared<AudioStream>(examiner->audio_frame_rate(), examiner->audio_length(), examiner->audio_channels());
249 audio->set_stream (as);
250 auto m = as->mapping ();
251 m.make_default (film ? film->audio_processor() : 0);
255 if (examiner->has_atmos()) {
257 boost::mutex::scoped_lock lm (_mutex);
258 atmos = make_shared<AtmosContent>(this);
260 /* Setting length will cause calculations to be made based on edit rate, so that must
261 * be set up first otherwise hard-to-spot exceptions will be thrown.
263 atmos->set_edit_rate (examiner->atmos_edit_rate());
264 atmos->set_length (examiner->atmos_length());
267 list<shared_ptr<TextContent> > new_text;
268 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
269 for (int j = 0; j < examiner->text_count(static_cast<TextType>(i)); ++j) {
270 auto c = make_shared<TextContent>(this, static_cast<TextType>(i), static_cast<TextType>(i));
271 if (i == static_cast<int>(TextType::CLOSED_CAPTION)) {
272 c->set_dcp_track (examiner->dcp_text_track(j));
274 new_text.push_back (c);
279 boost::mutex::scoped_lock lm (_mutex);
281 _name = examiner->name ();
282 _encrypted = examiner->encrypted ();
283 _needs_assets = examiner->needs_assets ();
284 _kdm_valid = examiner->kdm_valid ();
285 _standard = examiner->standard ();
286 _three_d = examiner->three_d ();
287 _content_kind = examiner->content_kind ();
288 _cpl = examiner->cpl ();
289 _reel_lengths = examiner->reel_lengths ();
290 for (auto const& i: examiner->markers()) {
291 _markers[i.first] = ContentTime(i.second.as_editable_units(DCPTime::HZ));
293 _ratings = examiner->ratings ();
294 _content_versions = examiner->content_versions ();
297 if (needed_assets == needs_assets()) {
301 if (needed_kdm == needs_kdm()) {
305 if (old_name == name()) {
310 video->set_frame_type (_three_d ? VideoFrameType::THREE_D : VideoFrameType::TWO_D);
315 DCPContent::summary () const
317 boost::mutex::scoped_lock lm (_mutex);
318 return String::compose (_("%1 [DCP]"), _name);
322 DCPContent::technical_summary () const
324 string s = Content::technical_summary() + " - ";
326 s += video->technical_summary() + " - ";
329 s += audio->technical_summary() + " - ";
335 DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
337 node->add_child("Type")->add_child_text ("DCP");
339 Content::as_xml (node, with_paths);
342 video->as_xml (node);
346 audio->as_xml (node);
347 node->add_child("AudioFrameRate")->add_child_text (raw_convert<string> (audio->stream()->frame_rate()));
348 node->add_child("AudioLength")->add_child_text (raw_convert<string> (audio->stream()->length()));
349 audio->stream()->mapping().as_xml (node->add_child("AudioMapping"));
357 atmos->as_xml (node);
360 boost::mutex::scoped_lock lm (_mutex);
361 node->add_child("Name")->add_child_text (_name);
362 node->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
363 node->add_child("NeedsAssets")->add_child_text (_needs_assets ? "1" : "0");
365 node->add_child("KDM")->add_child_text (_kdm->as_xml ());
367 node->add_child("KDMValid")->add_child_text (_kdm_valid ? "1" : "0");
368 node->add_child("ReferenceVideo")->add_child_text (_reference_video ? "1" : "0");
369 node->add_child("ReferenceAudio")->add_child_text (_reference_audio ? "1" : "0");
370 node->add_child("ReferenceOpenSubtitle")->add_child_text(_reference_text[static_cast<int>(TextType::OPEN_SUBTITLE)] ? "1" : "0");
371 node->add_child("ReferenceClosedCaption")->add_child_text(_reference_text[static_cast<int>(TextType::CLOSED_CAPTION)] ? "1" : "0");
373 switch (_standard.get ()) {
374 case dcp::Standard::INTEROP:
375 node->add_child("Standard")->add_child_text ("Interop");
377 case dcp::Standard::SMPTE:
378 node->add_child("Standard")->add_child_text ("SMPTE");
381 DCPOMATIC_ASSERT (false);
384 node->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
386 node->add_child("ContentKind")->add_child_text(dcp::content_kind_to_string(*_content_kind));
389 node->add_child("CPL")->add_child_text (_cpl.get ());
391 for (auto i: _reel_lengths) {
392 node->add_child("ReelLength")->add_child_text (raw_convert<string> (i));
395 for (auto const& i: _markers) {
396 auto marker = node->add_child("Marker");
397 marker->set_attribute("type", dcp::marker_to_string(i.first));
398 marker->add_child_text(raw_convert<string>(i.second.get()));
401 for (auto i: _ratings) {
402 auto rating = node->add_child("Rating");
406 for (auto i: _content_versions) {
407 node->add_child("ContentVersion")->add_child_text(i);
412 DCPContent::full_length (shared_ptr<const Film> film) const
417 FrameRateChange const frc (film, shared_from_this());
418 return DCPTime::from_frames (llrint(video->length() * frc.factor()), film->video_frame_rate());
422 DCPContent::approximate_length () const
427 return DCPTime::from_frames (video->length(), 24);
431 DCPContent::identifier () const
433 string s = Content::identifier() + "_";
436 s += video->identifier() + "_";
440 s += i->identifier () + " ";
443 s += string (_reference_video ? "1" : "0");
444 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
445 s += string (_reference_text[i] ? "1" : "0");
451 DCPContent::add_kdm (dcp::EncryptedKDM k)
457 DCPContent::add_ov (boost::filesystem::path ov)
463 DCPContent::can_be_played () const
465 return !needs_kdm() && !needs_assets();
469 DCPContent::needs_kdm () const
471 boost::mutex::scoped_lock lm (_mutex);
472 return _encrypted && !_kdm_valid;
476 DCPContent::needs_assets () const
478 boost::mutex::scoped_lock lm (_mutex);
479 return _needs_assets;
482 vector<boost::filesystem::path>
483 DCPContent::directories () const
485 return dcp::DCP::directories_from_files (paths());
489 DCPContent::add_properties (shared_ptr<const Film> film, list<UserProperty>& p) const
491 Content::add_properties (film, p);
493 video->add_properties (p);
496 audio->add_properties (film, p);
501 DCPContent::set_default_colour_conversion ()
503 /* Default to no colour conversion for DCPs */
505 video->unset_colour_conversion ();
510 DCPContent::set_reference_video (bool r)
512 ContentChangeSignaller cc (this, DCPContentProperty::REFERENCE_VIDEO);
515 boost::mutex::scoped_lock lm (_mutex);
516 _reference_video = r;
521 DCPContent::set_reference_audio (bool r)
523 ContentChangeSignaller cc (this, DCPContentProperty::REFERENCE_AUDIO);
526 boost::mutex::scoped_lock lm (_mutex);
527 _reference_audio = r;
532 DCPContent::set_reference_text (TextType type, bool r)
534 ContentChangeSignaller cc (this, DCPContentProperty::REFERENCE_TEXT);
537 boost::mutex::scoped_lock lm (_mutex);
538 _reference_text[static_cast<int>(type)] = r;
543 DCPContent::reels (shared_ptr<const Film> film) const
545 auto reel_lengths = _reel_lengths;
546 if (reel_lengths.empty()) {
547 /* Old metadata with no reel lengths; get them here instead */
549 scoped_ptr<DCPExaminer> examiner (new DCPExaminer(shared_from_this(), film->tolerant()));
550 reel_lengths = examiner->reel_lengths ();
552 /* Could not examine the DCP; guess reels */
553 reel_lengths.push_back (length_after_trim(film).frames_round(film->video_frame_rate()));
557 list<DCPTimePeriod> p;
559 /* This content's frame rate must be the same as the output DCP rate, so we can
560 convert `directly' from ContentTime to DCPTime.
563 /* The starting point of this content on the timeline */
564 auto pos = position() - DCPTime (trim_start().get());
566 for (auto i: reel_lengths) {
567 /* This reel runs from `pos' to `to' */
568 DCPTime const to = pos + DCPTime::from_frames (i, film->video_frame_rate());
569 if (to > position()) {
570 p.push_back (DCPTimePeriod(max(position(), pos), min(end(film), to)));
571 if (to > end(film)) {
582 DCPContent::reel_split_points (shared_ptr<const Film> film) const
585 for (auto i: reels(film)) {
586 s.push_back (i.from);
592 DCPContent::can_reference (shared_ptr<const Film> film, function<bool (shared_ptr<const Content>)> part, string overlapping, string& why_not) const
594 /* We must be using the same standard as the film */
596 if (_standard.get() == dcp::Standard::INTEROP && !film->interop()) {
597 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
598 why_not = _("it is Interop and the film is set to SMPTE.");
600 } else if (_standard.get() == dcp::Standard::SMPTE && film->interop()) {
601 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
602 why_not = _("it is SMPTE and the film is set to Interop.");
607 /* And the same frame rate */
608 if (!video_frame_rate() || (lrint(video_frame_rate().get()) != film->video_frame_rate())) {
609 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
610 why_not = _("it has a different frame rate to the film.");
614 auto const fr = film->reels ();
616 list<DCPTimePeriod> reel_list;
618 reel_list = reels (film);
619 } catch (dcp::ReadError &) {
620 /* We couldn't read the DCP; it's probably missing */
622 } catch (dcp::KDMDecryptionError &) {
623 /* We have an incorrect KDM */
627 /* fr must contain reels(). It can also contain other reels, but it must at
628 least contain reels().
630 for (auto i: reel_list) {
631 if (find (fr.begin(), fr.end(), i) == fr.end ()) {
632 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
633 why_not = _("its reel lengths differ from those in the film; set the reel mode to 'split by video content'.");
638 auto a = overlaps (film, film->content(), part, position(), end(film));
639 if (a.size() != 1 || a.front().get() != this) {
640 why_not = overlapping;
648 bool check_video (shared_ptr<const Content> c)
650 return static_cast<bool>(c->video) && c->video->use();
654 DCPContent::can_reference_video (shared_ptr<const Film> film, string& why_not) const
657 why_not = _("There is no video in this DCP");
661 if (film->resolution() != resolution()) {
662 if (resolution() == Resolution::FOUR_K) {
663 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
664 why_not = _("it is 4K and the film is 2K.");
666 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
667 why_not = _("it is 2K and the film is 4K.");
670 } else if (film->frame_size() != video->size()) {
671 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
672 why_not = _("its video frame size differs from the film's.");
676 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
677 return can_reference (film, bind (&check_video, _1), _("it overlaps other video content; remove the other content."), why_not);
681 bool check_audio (shared_ptr<const Content> c)
683 return static_cast<bool>(c->audio) && !c->audio->mapping().mapped_output_channels().empty();
687 DCPContent::can_reference_audio (shared_ptr<const Film> film, string& why_not) const
689 shared_ptr<DCPDecoder> decoder;
691 decoder.reset (new DCPDecoder (film, shared_from_this(), false, film->tolerant(), shared_ptr<DCPDecoder>()));
692 } catch (dcp::ReadError &) {
693 /* We couldn't read the DCP, so it's probably missing */
695 } catch (DCPError &) {
696 /* We couldn't read the DCP, so it's probably missing */
698 } catch (dcp::KDMDecryptionError &) {
699 /* We have an incorrect KDM */
703 for (auto i: decoder->reels()) {
704 if (!i->main_sound()) {
705 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
706 why_not = _("it does not have sound in all its reels.");
711 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
712 return can_reference (film, bind (&check_audio, _1), _("it overlaps other audio content; remove the other content."), why_not);
716 bool check_text (shared_ptr<const Content> c)
718 return !c->text.empty();
722 DCPContent::can_reference_text (shared_ptr<const Film> film, TextType type, string& why_not) const
724 shared_ptr<DCPDecoder> decoder;
726 decoder.reset (new DCPDecoder (film, shared_from_this(), false, film->tolerant(), shared_ptr<DCPDecoder>()));
727 } catch (dcp::ReadError &) {
728 /* We couldn't read the DCP, so it's probably missing */
730 } catch (dcp::KDMDecryptionError &) {
731 /* We have an incorrect KDM */
735 for (auto i: decoder->reels()) {
736 if (type == TextType::OPEN_SUBTITLE) {
737 if (!i->main_subtitle()) {
738 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
739 why_not = _("it does not have open subtitles in all its reels.");
741 } else if (i->main_subtitle()->entry_point().get_value_or(0) != 0) {
742 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
743 why_not = _("one if its subtitle reels has a non-zero entry point so it must be re-written.");
747 if (type == TextType::CLOSED_CAPTION) {
748 if (i->closed_captions().empty()) {
749 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
750 why_not = _("it does not have closed captions in all its reels.");
753 for (auto j: i->closed_captions()) {
754 if (j->entry_point().get_value_or(0) != 0) {
755 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
756 why_not = _("one if its closed caption has a non-zero entry point so it must be re-written.");
763 if (trim_start() != dcpomatic::ContentTime()) {
764 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
765 why_not = _("it has a start trim so its subtitles or closed captions must be re-written.");
769 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
770 return can_reference (film, bind (&check_text, _1), _("it overlaps other text content; remove the other content."), why_not);
774 DCPContent::take_settings_from (shared_ptr<const Content> c)
776 auto dc = dynamic_pointer_cast<const DCPContent>(c);
781 _reference_video = dc->_reference_video;
782 _reference_audio = dc->_reference_audio;
783 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
784 _reference_text[i] = dc->_reference_text[i];
789 DCPContent::set_cpl (string id)
791 ContentChangeSignaller cc (this, DCPContentProperty::CPL);
794 boost::mutex::scoped_lock lm (_mutex);
800 DCPContent::kdm_timing_window_valid () const
807 return _kdm->not_valid_before() < now && now < _kdm->not_valid_after();
812 DCPContent::resolution () const
814 if (video->size().width > 2048 || video->size().height > 1080) {
815 return Resolution::FOUR_K;
818 return Resolution::TWO_K;