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 "dcp_content.h"
22 #include "video_content.h"
23 #include "audio_content.h"
24 #include "dcp_examiner.h"
29 #include "compose.hpp"
30 #include "dcp_decoder.h"
32 #include "dcpomatic_log.h"
33 #include "text_content.h"
35 #include <dcp/raw_convert.h>
36 #include <dcp/exceptions.h>
37 #include <dcp/reel_picture_asset.h>
39 #include <libxml++/libxml++.h>
40 #include <boost/foreach.hpp>
53 using boost::shared_ptr;
54 using boost::scoped_ptr;
55 using boost::optional;
56 using boost::function;
57 using boost::dynamic_pointer_cast;
58 using dcp::raw_convert;
59 using namespace dcpomatic;
61 int const DCPContentProperty::NEEDS_ASSETS = 600;
62 int const DCPContentProperty::NEEDS_KDM = 601;
63 int const DCPContentProperty::REFERENCE_VIDEO = 602;
64 int const DCPContentProperty::REFERENCE_AUDIO = 603;
65 int const DCPContentProperty::REFERENCE_TEXT = 604;
66 int const DCPContentProperty::NAME = 605;
67 int const DCPContentProperty::TEXTS = 606;
68 int const DCPContentProperty::CPL = 607;
70 DCPContent::DCPContent (boost::filesystem::path p)
72 , _needs_assets (false)
74 , _reference_video (false)
75 , _reference_audio (false)
78 LOG_GENERAL ("Creating DCP content from %1", p.string());
81 set_default_colour_conversion ();
83 for (int i = 0; i < TEXT_COUNT; ++i) {
84 _reference_text[i] = false;
88 DCPContent::DCPContent (cxml::ConstNodePtr node, int version)
91 video = VideoContent::from_xml (this, node, version);
92 audio = AudioContent::from_xml (this, node, version);
93 text = TextContent::from_xml (this, node, version);
95 for (int i = 0; i < TEXT_COUNT; ++i) {
96 _reference_text[i] = false;
103 node->number_child<int> ("AudioFrameRate"),
104 /* AudioLength was not present in some old metadata versions */
105 node->optional_number_child<Frame>("AudioLength").get_value_or (
106 video->length() * node->number_child<int>("AudioFrameRate") / video_frame_rate().get()
108 AudioMapping (node->node_child ("AudioMapping"), version)
114 _name = node->string_child ("Name");
115 _encrypted = node->bool_child ("Encrypted");
116 _needs_assets = node->optional_bool_child("NeedsAssets").get_value_or (false);
117 if (node->optional_node_child ("KDM")) {
118 _kdm = dcp::EncryptedKDM (node->string_child ("KDM"));
120 _kdm_valid = node->bool_child ("KDMValid");
121 _reference_video = node->optional_bool_child ("ReferenceVideo").get_value_or (false);
122 _reference_audio = node->optional_bool_child ("ReferenceAudio").get_value_or (false);
124 _reference_text[TEXT_OPEN_SUBTITLE] = node->optional_bool_child("ReferenceOpenSubtitle").get_value_or(false);
125 _reference_text[TEXT_CLOSED_CAPTION] = node->optional_bool_child("ReferenceClosedCaption").get_value_or(false);
127 _reference_text[TEXT_OPEN_SUBTITLE] = node->optional_bool_child("ReferenceSubtitle").get_value_or(false);
128 _reference_text[TEXT_CLOSED_CAPTION] = false;
130 if (node->optional_string_child("Standard")) {
131 string const s = node->optional_string_child("Standard").get();
132 if (s == "Interop") {
133 _standard = dcp::INTEROP;
134 } else if (s == "SMPTE") {
135 _standard = dcp::SMPTE;
137 DCPOMATIC_ASSERT (false);
140 _three_d = node->optional_bool_child("ThreeD").get_value_or (false);
142 optional<string> ck = node->optional_string_child("ContentKind");
144 _content_kind = dcp::content_kind_from_string (*ck);
146 _cpl = node->optional_string_child("CPL");
147 BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("ReelLength")) {
148 _reel_lengths.push_back (raw_convert<int64_t> (i->content ()));
151 BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("Marker")) {
152 _markers[dcp::marker_from_string(i->string_attribute("type"))] = ContentTime(raw_convert<int64_t>(i->content()));
155 BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("Rating")) {
156 _ratings.push_back (dcp::Rating(i));
159 _content_version = node->optional_string_child("ContentVersion").get_value_or("");
163 DCPContent::read_directory (boost::filesystem::path p)
165 read_sub_directory (p);
167 bool have_assetmap = false;
168 BOOST_FOREACH (boost::filesystem::path i, paths()) {
169 if (i.filename() == "ASSETMAP" || i.filename() == "ASSETMAP.xml") {
170 have_assetmap = true;
174 if (!have_assetmap) {
175 throw DCPError ("No ASSETMAP or ASSETMAP.xml file found: is this a DCP?");
180 DCPContent::read_sub_directory (boost::filesystem::path p)
182 LOG_GENERAL ("DCPContent::read_sub_directory reads %1", p.string());
183 for (boost::filesystem::directory_iterator i(p); i != boost::filesystem::directory_iterator(); ++i) {
184 if (boost::filesystem::is_regular_file (i->path())) {
185 LOG_GENERAL ("Inside there's regular file %1", i->path().string());
186 add_path (i->path());
187 } else if (boost::filesystem::is_directory (i->path ())) {
188 LOG_GENERAL ("Inside there's directory %1", i->path().string());
189 read_sub_directory (i->path());
194 /** @param film Film, or 0 */
196 DCPContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
198 bool const needed_assets = needs_assets ();
199 bool const needed_kdm = needs_kdm ();
200 string const old_name = name ();
201 int const old_texts = text.size ();
203 ChangeSignaller<Content> cc_texts (this, DCPContentProperty::TEXTS);
204 ChangeSignaller<Content> cc_assets (this, DCPContentProperty::NEEDS_ASSETS);
205 ChangeSignaller<Content> cc_kdm (this, DCPContentProperty::NEEDS_KDM);
206 ChangeSignaller<Content> cc_name (this, DCPContentProperty::NAME);
209 job->set_progress_unknown ();
211 Content::examine (film, job);
213 shared_ptr<DCPExaminer> examiner (new DCPExaminer(shared_from_this(), film ? film->tolerant() : true));
215 if (examiner->has_video()) {
217 boost::mutex::scoped_lock lm (_mutex);
218 video.reset (new VideoContent (this));
220 video->take_from_examiner (examiner);
221 set_default_colour_conversion ();
224 if (examiner->has_audio()) {
226 boost::mutex::scoped_lock lm (_mutex);
227 audio.reset (new AudioContent (this));
229 AudioStreamPtr as (new AudioStream (examiner->audio_frame_rate(), examiner->audio_length(), examiner->audio_channels()));
230 audio->set_stream (as);
231 AudioMapping m = as->mapping ();
232 m.make_default (film ? film->audio_processor() : 0);
238 boost::mutex::scoped_lock lm (_mutex);
239 _name = examiner->name ();
240 for (int i = 0; i < TEXT_COUNT; ++i) {
241 for (int j = 0; j < examiner->text_count(static_cast<TextType>(i)); ++j) {
242 text.push_back (shared_ptr<TextContent>(new TextContent(this, static_cast<TextType>(i), static_cast<TextType>(i))));
245 texts = text.size ();
246 _encrypted = examiner->encrypted ();
247 _needs_assets = examiner->needs_assets ();
248 _kdm_valid = examiner->kdm_valid ();
249 _standard = examiner->standard ();
250 _three_d = examiner->three_d ();
251 _content_kind = examiner->content_kind ();
252 _cpl = examiner->cpl ();
253 _reel_lengths = examiner->reel_lengths ();
254 map<dcp::Marker, dcp::Time> markers = examiner->markers();
255 for (map<dcp::Marker, dcp::Time>::const_iterator i = markers.begin(); i != markers.end(); ++i) {
256 _markers[i->first] = ContentTime(i->second.as_editable_units(DCPTime::HZ));
258 _ratings = examiner->ratings ();
259 _content_version = examiner->content_version ();
262 if (old_texts == texts) {
266 if (needed_assets == needs_assets()) {
270 if (needed_kdm == needs_kdm()) {
274 if (old_name == name()) {
279 video->set_frame_type (_three_d ? VIDEO_FRAME_TYPE_3D : VIDEO_FRAME_TYPE_2D);
284 DCPContent::summary () const
286 boost::mutex::scoped_lock lm (_mutex);
287 return String::compose (_("%1 [DCP]"), _name);
291 DCPContent::technical_summary () const
293 string s = Content::technical_summary() + " - ";
295 s += video->technical_summary() + " - ";
298 s += audio->technical_summary() + " - ";
304 DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
306 node->add_child("Type")->add_child_text ("DCP");
308 Content::as_xml (node, with_paths);
311 video->as_xml (node);
315 audio->as_xml (node);
316 node->add_child("AudioFrameRate")->add_child_text (raw_convert<string> (audio->stream()->frame_rate()));
317 node->add_child("AudioLength")->add_child_text (raw_convert<string> (audio->stream()->length()));
318 audio->stream()->mapping().as_xml (node->add_child("AudioMapping"));
321 BOOST_FOREACH (shared_ptr<TextContent> i, text) {
325 boost::mutex::scoped_lock lm (_mutex);
326 node->add_child("Name")->add_child_text (_name);
327 node->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
328 node->add_child("NeedsAssets")->add_child_text (_needs_assets ? "1" : "0");
330 node->add_child("KDM")->add_child_text (_kdm->as_xml ());
332 node->add_child("KDMValid")->add_child_text (_kdm_valid ? "1" : "0");
333 node->add_child("ReferenceVideo")->add_child_text (_reference_video ? "1" : "0");
334 node->add_child("ReferenceAudio")->add_child_text (_reference_audio ? "1" : "0");
335 node->add_child("ReferenceOpenSubtitle")->add_child_text(_reference_text[TEXT_OPEN_SUBTITLE] ? "1" : "0");
336 node->add_child("ReferenceClosedCaption")->add_child_text(_reference_text[TEXT_CLOSED_CAPTION] ? "1" : "0");
338 switch (_standard.get ()) {
340 node->add_child("Standard")->add_child_text ("Interop");
343 node->add_child("Standard")->add_child_text ("SMPTE");
346 DCPOMATIC_ASSERT (false);
349 node->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
351 node->add_child("ContentKind")->add_child_text(dcp::content_kind_to_string(*_content_kind));
354 node->add_child("CPL")->add_child_text (_cpl.get ());
356 BOOST_FOREACH (int64_t i, _reel_lengths) {
357 node->add_child("ReelLength")->add_child_text (raw_convert<string> (i));
360 for (map<dcp::Marker, ContentTime>::const_iterator i = _markers.begin(); i != _markers.end(); ++i) {
361 xmlpp::Element* marker = node->add_child("Marker");
362 marker->set_attribute("type", dcp::marker_to_string(i->first));
363 marker->add_child_text(raw_convert<string>(i->second.get()));
366 BOOST_FOREACH (dcp::Rating i, _ratings) {
367 xmlpp::Element* rating = node->add_child("Rating");
371 node->add_child("ContentVersion")->add_child_text (_content_version);
375 DCPContent::full_length (shared_ptr<const Film> film) const
380 FrameRateChange const frc (film, shared_from_this());
381 return DCPTime::from_frames (llrint(video->length() * frc.factor()), film->video_frame_rate());
385 DCPContent::approximate_length () const
390 return DCPTime::from_frames (video->length(), 24);
394 DCPContent::identifier () const
396 string s = Content::identifier() + "_";
399 s += video->identifier() + "_";
402 BOOST_FOREACH (shared_ptr<TextContent> i, text) {
403 s += i->identifier () + " ";
406 s += string (_reference_video ? "1" : "0");
407 for (int i = 0; i < TEXT_COUNT; ++i) {
408 s += string (_reference_text[i] ? "1" : "0");
414 DCPContent::add_kdm (dcp::EncryptedKDM k)
420 DCPContent::add_ov (boost::filesystem::path ov)
426 DCPContent::can_be_played () const
428 return !needs_kdm() && !needs_assets();
432 DCPContent::needs_kdm () const
434 boost::mutex::scoped_lock lm (_mutex);
435 return _encrypted && !_kdm_valid;
439 DCPContent::needs_assets () const
441 boost::mutex::scoped_lock lm (_mutex);
442 return _needs_assets;
445 vector<boost::filesystem::path>
446 DCPContent::directories () const
448 return dcp::DCP::directories_from_files (paths());
452 DCPContent::add_properties (shared_ptr<const Film> film, list<UserProperty>& p) const
454 Content::add_properties (film, p);
456 video->add_properties (p);
459 audio->add_properties (film, p);
464 DCPContent::set_default_colour_conversion ()
466 /* Default to no colour conversion for DCPs */
468 video->unset_colour_conversion ();
473 DCPContent::set_reference_video (bool r)
475 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_VIDEO);
478 boost::mutex::scoped_lock lm (_mutex);
479 _reference_video = r;
484 DCPContent::set_reference_audio (bool r)
486 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_AUDIO);
489 boost::mutex::scoped_lock lm (_mutex);
490 _reference_audio = r;
495 DCPContent::set_reference_text (TextType type, bool r)
497 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_TEXT);
500 boost::mutex::scoped_lock lm (_mutex);
501 _reference_text[type] = r;
506 DCPContent::reels (shared_ptr<const Film> film) const
508 list<int64_t> reel_lengths = _reel_lengths;
509 if (reel_lengths.empty ()) {
510 /* Old metadata with no reel lengths; get them here instead */
512 scoped_ptr<DCPExaminer> examiner (new DCPExaminer(shared_from_this(), film->tolerant()));
513 reel_lengths = examiner->reel_lengths ();
515 /* Could not examine the DCP; guess reels */
516 reel_lengths.push_back (length_after_trim(film).frames_round(film->video_frame_rate()));
520 list<DCPTimePeriod> p;
522 /* This content's frame rate must be the same as the output DCP rate, so we can
523 convert `directly' from ContentTime to DCPTime.
526 /* The starting point of this content on the timeline */
527 DCPTime pos = position() - DCPTime (trim_start().get());
529 BOOST_FOREACH (int64_t i, reel_lengths) {
530 /* This reel runs from `pos' to `to' */
531 DCPTime const to = pos + DCPTime::from_frames (i, film->video_frame_rate());
532 if (to > position()) {
533 p.push_back (DCPTimePeriod (max(position(), pos), min(end(film), to)));
534 if (to > end(film)) {
545 DCPContent::reel_split_points (shared_ptr<const Film> film) const
548 BOOST_FOREACH (DCPTimePeriod i, reels(film)) {
549 s.push_back (i.from);
555 DCPContent::can_reference (shared_ptr<const Film> film, function<bool (shared_ptr<const Content>)> part, string overlapping, string& why_not) const
557 /* We must be using the same standard as the film */
559 if (_standard.get() == dcp::INTEROP && !film->interop()) {
560 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
561 why_not = _("it is Interop and the film is set to SMPTE.");
563 } else if (_standard.get() == dcp::SMPTE && film->interop()) {
564 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
565 why_not = _("it is SMPTE and the film is set to Interop.");
570 /* And the same frame rate */
571 if (!video_frame_rate() || (lrint(video_frame_rate().get()) != film->video_frame_rate())) {
572 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
573 why_not = _("it has a different frame rate to the film.");
577 list<DCPTimePeriod> const fr = film->reels ();
579 list<DCPTimePeriod> reel_list;
581 reel_list = reels (film);
582 } catch (dcp::ReadError &) {
583 /* We couldn't read the DCP; it's probably missing */
585 } catch (dcp::KDMDecryptionError &) {
586 /* We have an incorrect KDM */
590 /* fr must contain reels(). It can also contain other reels, but it must at
591 least contain reels().
593 BOOST_FOREACH (DCPTimePeriod i, reel_list) {
594 if (find (fr.begin(), fr.end(), i) == fr.end ()) {
595 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
596 why_not = _("its reel lengths differ from those in the film; set the reel mode to 'split by video content'.");
601 ContentList a = overlaps (film, film->content(), part, position(), end(film));
602 if (a.size() != 1 || a.front().get() != this) {
603 why_not = overlapping;
611 bool check_video (shared_ptr<const Content> c)
613 return static_cast<bool>(c->video) && c->video->use();
617 DCPContent::can_reference_video (shared_ptr<const Film> film, string& why_not) const
620 why_not = _("There is no video in this DCP");
624 if (film->resolution() != resolution()) {
625 if (resolution() == RESOLUTION_4K) {
626 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
627 why_not = _("it is 4K and the film is 2K.");
629 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
630 why_not = _("it is 2K and the film is 4K.");
633 } else if (film->frame_size() != video->size()) {
634 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
635 why_not = _("its video frame size differs from the film's.");
639 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
640 return can_reference (film, bind (&check_video, _1), _("it overlaps other video content; remove the other content."), why_not);
644 bool check_audio (shared_ptr<const Content> c)
646 return static_cast<bool>(c->audio) && !c->audio->mapping().mapped_output_channels().empty();
650 DCPContent::can_reference_audio (shared_ptr<const Film> film, string& why_not) const
652 shared_ptr<DCPDecoder> decoder;
654 decoder.reset (new DCPDecoder (film, shared_from_this(), false, film->tolerant(), shared_ptr<DCPDecoder>()));
655 } catch (dcp::ReadError &) {
656 /* We couldn't read the DCP, so it's probably missing */
658 } catch (DCPError &) {
659 /* We couldn't read the DCP, so it's probably missing */
661 } catch (dcp::KDMDecryptionError &) {
662 /* We have an incorrect KDM */
666 BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
667 if (!i->main_sound()) {
668 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
669 why_not = _("it does not have sound in all its reels.");
674 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
675 return can_reference (film, bind (&check_audio, _1), _("it overlaps other audio content; remove the other content."), why_not);
679 bool check_text (shared_ptr<const Content> c)
681 return !c->text.empty();
685 DCPContent::can_reference_text (shared_ptr<const Film> film, TextType type, string& why_not) const
687 shared_ptr<DCPDecoder> decoder;
689 decoder.reset (new DCPDecoder (film, shared_from_this(), false, film->tolerant(), shared_ptr<DCPDecoder>()));
690 } catch (dcp::ReadError &) {
691 /* We couldn't read the DCP, so it's probably missing */
693 } catch (dcp::KDMDecryptionError &) {
694 /* We have an incorrect KDM */
698 BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
699 if (type == TEXT_OPEN_SUBTITLE && !i->main_subtitle()) {
700 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
701 why_not = _("it does not have open subtitles in all its reels.");
704 if (type == TEXT_CLOSED_CAPTION && i->closed_captions().empty()) {
705 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
706 why_not = _("it does not have closed captions in all its reels.");
711 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
712 return can_reference (film, bind (&check_text, _1), _("it overlaps other text content; remove the other content."), why_not);
716 DCPContent::take_settings_from (shared_ptr<const Content> c)
718 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (c);
723 _reference_video = dc->_reference_video;
724 _reference_audio = dc->_reference_audio;
725 for (int i = 0; i < TEXT_COUNT; ++i) {
726 _reference_text[i] = dc->_reference_text[i];
731 DCPContent::set_cpl (string id)
733 ChangeSignaller<Content> cc (this, DCPContentProperty::CPL);
736 boost::mutex::scoped_lock lm (_mutex);
742 DCPContent::kdm_timing_window_valid () const
749 return _kdm->not_valid_before() < now && now < _kdm->not_valid_after();
754 DCPContent::resolution () const
756 if (video->size().width > 2048 || video->size().height > 1080) {
757 return RESOLUTION_4K;
760 return RESOLUTION_2K;