2 Copyright (C) 2014-2018 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>
52 using boost::shared_ptr;
53 using boost::scoped_ptr;
54 using boost::optional;
55 using boost::function;
56 using boost::dynamic_pointer_cast;
57 using dcp::raw_convert;
59 int const DCPContentProperty::NEEDS_ASSETS = 600;
60 int const DCPContentProperty::NEEDS_KDM = 601;
61 int const DCPContentProperty::REFERENCE_VIDEO = 602;
62 int const DCPContentProperty::REFERENCE_AUDIO = 603;
63 int const DCPContentProperty::REFERENCE_TEXT = 604;
64 int const DCPContentProperty::NAME = 605;
65 int const DCPContentProperty::TEXTS = 606;
66 int const DCPContentProperty::CPL = 607;
68 DCPContent::DCPContent (boost::filesystem::path p)
70 , _needs_assets (false)
72 , _reference_video (false)
73 , _reference_audio (false)
76 LOG_GENERAL ("Creating DCP content from %1", p.string());
79 set_default_colour_conversion ();
81 for (int i = 0; i < TEXT_COUNT; ++i) {
82 _reference_text[i] = false;
86 DCPContent::DCPContent (cxml::ConstNodePtr node, int version)
89 video = VideoContent::from_xml (this, node, version);
90 audio = AudioContent::from_xml (this, node, version);
91 text = TextContent::from_xml (this, node, version);
93 for (int i = 0; i < TEXT_COUNT; ++i) {
94 _reference_text[i] = false;
101 node->number_child<int> ("AudioFrameRate"),
102 /* AudioLength was not present in some old metadata versions */
103 node->optional_number_child<Frame>("AudioLength").get_value_or (
104 video->length() * node->number_child<int>("AudioFrameRate") / video_frame_rate().get()
106 AudioMapping (node->node_child ("AudioMapping"), version)
112 _name = node->string_child ("Name");
113 _encrypted = node->bool_child ("Encrypted");
114 _needs_assets = node->optional_bool_child("NeedsAssets").get_value_or (false);
115 if (node->optional_node_child ("KDM")) {
116 _kdm = dcp::EncryptedKDM (node->string_child ("KDM"));
118 _kdm_valid = node->bool_child ("KDMValid");
119 _reference_video = node->optional_bool_child ("ReferenceVideo").get_value_or (false);
120 _reference_audio = node->optional_bool_child ("ReferenceAudio").get_value_or (false);
122 _reference_text[TEXT_OPEN_SUBTITLE] = node->optional_bool_child("ReferenceOpenSubtitle").get_value_or(false);
123 _reference_text[TEXT_CLOSED_CAPTION] = node->optional_bool_child("ReferenceClosedCaption").get_value_or(false);
125 _reference_text[TEXT_OPEN_SUBTITLE] = node->optional_bool_child("ReferenceSubtitle").get_value_or(false);
126 _reference_text[TEXT_CLOSED_CAPTION] = false;
128 if (node->optional_string_child("Standard")) {
129 string const s = node->optional_string_child("Standard").get();
130 if (s == "Interop") {
131 _standard = dcp::INTEROP;
132 } else if (s == "SMPTE") {
133 _standard = dcp::SMPTE;
135 DCPOMATIC_ASSERT (false);
138 _three_d = node->optional_bool_child("ThreeD").get_value_or (false);
140 optional<string> ck = node->optional_string_child("ContentKind");
142 _content_kind = dcp::content_kind_from_string (*ck);
144 _cpl = node->optional_string_child("CPL");
145 BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("ReelLength")) {
146 _reel_lengths.push_back (raw_convert<int64_t> (i->content ()));
151 DCPContent::read_directory (boost::filesystem::path p)
153 read_sub_directory (p);
155 bool have_assetmap = false;
156 BOOST_FOREACH (boost::filesystem::path i, paths()) {
157 if (i.filename() == "ASSETMAP" || i.filename() == "ASSETMAP.xml") {
158 have_assetmap = true;
162 if (!have_assetmap) {
163 throw DCPError ("No ASSETMAP or ASSETMAP.xml file found: is this a DCP?");
168 DCPContent::read_sub_directory (boost::filesystem::path p)
170 LOG_GENERAL ("DCPContent::read_sub_directory reads %1", p.string());
171 for (boost::filesystem::directory_iterator i(p); i != boost::filesystem::directory_iterator(); ++i) {
172 if (boost::filesystem::is_regular_file (i->path())) {
173 LOG_GENERAL ("Inside there's regular file %1", i->path().string());
174 add_path (i->path());
175 } else if (boost::filesystem::is_directory (i->path ())) {
176 LOG_GENERAL ("Inside there's directory %1", i->path().string());
177 read_sub_directory (i->path());
183 DCPContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
185 bool const needed_assets = needs_assets ();
186 bool const needed_kdm = needs_kdm ();
187 string const old_name = name ();
188 int const old_texts = text.size ();
190 ChangeSignaller<Content> cc_texts (this, DCPContentProperty::TEXTS);
191 ChangeSignaller<Content> cc_assets (this, DCPContentProperty::NEEDS_ASSETS);
192 ChangeSignaller<Content> cc_kdm (this, DCPContentProperty::NEEDS_KDM);
193 ChangeSignaller<Content> cc_name (this, DCPContentProperty::NAME);
196 job->set_progress_unknown ();
198 Content::examine (film, job);
200 shared_ptr<DCPExaminer> examiner (new DCPExaminer (shared_from_this ()));
202 if (examiner->has_video()) {
204 boost::mutex::scoped_lock lm (_mutex);
205 video.reset (new VideoContent (this));
207 video->take_from_examiner (examiner);
208 set_default_colour_conversion ();
211 if (examiner->has_audio()) {
213 boost::mutex::scoped_lock lm (_mutex);
214 audio.reset (new AudioContent (this));
216 AudioStreamPtr as (new AudioStream (examiner->audio_frame_rate(), examiner->audio_length(), examiner->audio_channels()));
217 audio->set_stream (as);
218 AudioMapping m = as->mapping ();
219 m.make_default (film ? film->audio_processor() : 0);
225 boost::mutex::scoped_lock lm (_mutex);
226 _name = examiner->name ();
227 for (int i = 0; i < TEXT_COUNT; ++i) {
228 for (int j = 0; j < examiner->text_count(static_cast<TextType>(i)); ++j) {
229 shared_ptr<TextContent> c(new TextContent(this, static_cast<TextType>(i), static_cast<TextType>(i)));
230 if (i == TEXT_CLOSED_CAPTION) {
231 c->set_dcp_track (examiner->dcp_text_track(j));
236 texts = text.size ();
237 _encrypted = examiner->encrypted ();
238 _needs_assets = examiner->needs_assets ();
239 _kdm_valid = examiner->kdm_valid ();
240 _standard = examiner->standard ();
241 _three_d = examiner->three_d ();
242 _content_kind = examiner->content_kind ();
243 _cpl = examiner->cpl ();
244 _reel_lengths = examiner->reel_lengths ();
247 if (old_texts == texts) {
251 if (needed_assets == needs_assets()) {
255 if (needed_kdm == needs_kdm()) {
259 if (old_name == name()) {
264 video->set_frame_type (_three_d ? VIDEO_FRAME_TYPE_3D : VIDEO_FRAME_TYPE_2D);
269 DCPContent::summary () const
271 boost::mutex::scoped_lock lm (_mutex);
272 return String::compose (_("%1 [DCP]"), _name);
276 DCPContent::technical_summary () const
278 string s = Content::technical_summary() + " - ";
280 s += video->technical_summary() + " - ";
283 s += audio->technical_summary() + " - ";
289 DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
291 node->add_child("Type")->add_child_text ("DCP");
293 Content::as_xml (node, with_paths);
296 video->as_xml (node);
300 audio->as_xml (node);
301 node->add_child("AudioFrameRate")->add_child_text (raw_convert<string> (audio->stream()->frame_rate()));
302 node->add_child("AudioLength")->add_child_text (raw_convert<string> (audio->stream()->length()));
303 audio->stream()->mapping().as_xml (node->add_child("AudioMapping"));
306 BOOST_FOREACH (shared_ptr<TextContent> i, text) {
310 boost::mutex::scoped_lock lm (_mutex);
311 node->add_child("Name")->add_child_text (_name);
312 node->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
313 node->add_child("NeedsAssets")->add_child_text (_needs_assets ? "1" : "0");
315 node->add_child("KDM")->add_child_text (_kdm->as_xml ());
317 node->add_child("KDMValid")->add_child_text (_kdm_valid ? "1" : "0");
318 node->add_child("ReferenceVideo")->add_child_text (_reference_video ? "1" : "0");
319 node->add_child("ReferenceAudio")->add_child_text (_reference_audio ? "1" : "0");
320 node->add_child("ReferenceOpenSubtitle")->add_child_text(_reference_text[TEXT_OPEN_SUBTITLE] ? "1" : "0");
321 node->add_child("ReferenceClosedCaption")->add_child_text(_reference_text[TEXT_CLOSED_CAPTION] ? "1" : "0");
323 switch (_standard.get ()) {
325 node->add_child("Standard")->add_child_text ("Interop");
328 node->add_child("Standard")->add_child_text ("SMPTE");
331 DCPOMATIC_ASSERT (false);
334 node->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
336 node->add_child("ContentKind")->add_child_text(dcp::content_kind_to_string(*_content_kind));
339 node->add_child("CPL")->add_child_text (_cpl.get ());
341 BOOST_FOREACH (int64_t i, _reel_lengths) {
342 node->add_child("ReelLength")->add_child_text (raw_convert<string> (i));
347 DCPContent::full_length (shared_ptr<const Film> film) const
352 FrameRateChange const frc (film, shared_from_this());
353 return DCPTime::from_frames (llrint(video->length() * frc.factor()), film->video_frame_rate());
357 DCPContent::approximate_length () const
362 return DCPTime::from_frames (video->length(), 24);
366 DCPContent::identifier () const
368 string s = Content::identifier() + "_";
371 s += video->identifier() + "_";
374 BOOST_FOREACH (shared_ptr<TextContent> i, text) {
375 s += i->identifier () + " ";
378 s += string (_reference_video ? "1" : "0");
379 for (int i = 0; i < TEXT_COUNT; ++i) {
380 s += string (_reference_text[i] ? "1" : "0");
386 DCPContent::add_kdm (dcp::EncryptedKDM k)
392 DCPContent::add_ov (boost::filesystem::path ov)
398 DCPContent::can_be_played () const
400 return !needs_kdm() && !needs_assets();
404 DCPContent::needs_kdm () const
406 boost::mutex::scoped_lock lm (_mutex);
407 return _encrypted && !_kdm_valid;
411 DCPContent::needs_assets () const
413 boost::mutex::scoped_lock lm (_mutex);
414 return _needs_assets;
417 vector<boost::filesystem::path>
418 DCPContent::directories () const
420 return dcp::DCP::directories_from_files (paths());
424 DCPContent::add_properties (shared_ptr<const Film> film, list<UserProperty>& p) const
426 Content::add_properties (film, p);
428 video->add_properties (p);
431 audio->add_properties (film, p);
436 DCPContent::set_default_colour_conversion ()
438 /* Default to no colour conversion for DCPs */
440 video->unset_colour_conversion ();
445 DCPContent::set_reference_video (bool r)
447 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_VIDEO);
450 boost::mutex::scoped_lock lm (_mutex);
451 _reference_video = r;
456 DCPContent::set_reference_audio (bool r)
458 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_AUDIO);
461 boost::mutex::scoped_lock lm (_mutex);
462 _reference_audio = r;
467 DCPContent::set_reference_text (TextType type, bool r)
469 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_TEXT);
472 boost::mutex::scoped_lock lm (_mutex);
473 _reference_text[type] = r;
478 DCPContent::reels (shared_ptr<const Film> film) const
480 list<int64_t> reel_lengths = _reel_lengths;
481 if (reel_lengths.empty ()) {
482 /* Old metadata with no reel lengths; get them here instead */
484 scoped_ptr<DCPExaminer> examiner (new DCPExaminer (shared_from_this()));
485 reel_lengths = examiner->reel_lengths ();
487 /* Could not examine the DCP; guess reels */
488 reel_lengths.push_back (length_after_trim(film).frames_round(film->video_frame_rate()));
492 list<DCPTimePeriod> p;
494 /* This content's frame rate must be the same as the output DCP rate, so we can
495 convert `directly' from ContentTime to DCPTime.
498 /* The starting point of this content on the timeline */
499 DCPTime pos = position() - DCPTime (trim_start().get());
501 BOOST_FOREACH (int64_t i, reel_lengths) {
502 /* This reel runs from `pos' to `to' */
503 DCPTime const to = pos + DCPTime::from_frames (i, film->video_frame_rate());
504 if (to > position()) {
505 p.push_back (DCPTimePeriod (max(position(), pos), min(end(film), to)));
506 if (to > end(film)) {
517 DCPContent::reel_split_points (shared_ptr<const Film> film) const
520 BOOST_FOREACH (DCPTimePeriod i, reels(film)) {
521 s.push_back (i.from);
527 DCPContent::can_reference (shared_ptr<const Film> film, function<bool (shared_ptr<const Content>)> part, string overlapping, string& why_not) const
529 /* We must be using the same standard as the film */
531 if (_standard.get() == dcp::INTEROP && !film->interop()) {
532 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
533 why_not = _("it is Interop and the film is set to SMPTE.");
535 } else if (_standard.get() == dcp::SMPTE && film->interop()) {
536 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
537 why_not = _("it is SMPTE and the film is set to Interop.");
542 /* And the same frame rate */
543 if (!video_frame_rate() || (lrint(video_frame_rate().get()) != film->video_frame_rate())) {
544 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
545 why_not = _("it has a different frame rate to the film.");
549 list<DCPTimePeriod> const fr = film->reels ();
551 list<DCPTimePeriod> reel_list;
553 reel_list = reels (film);
554 } catch (dcp::DCPReadError &) {
555 /* We couldn't read the DCP; it's probably missing */
557 } catch (dcp::KDMDecryptionError &) {
558 /* We have an incorrect KDM */
562 /* fr must contain reels(). It can also contain other reels, but it must at
563 least contain reels().
565 BOOST_FOREACH (DCPTimePeriod i, reel_list) {
566 if (find (fr.begin(), fr.end(), i) == fr.end ()) {
567 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
568 why_not = _("its reel lengths differ from those in the film; set the reel mode to 'split by video content'.");
573 ContentList a = overlaps (film, film->content(), part, position(), end(film));
574 if (a.size() != 1 || a.front().get() != this) {
575 why_not = overlapping;
583 bool check_video (shared_ptr<const Content> c)
585 return static_cast<bool>(c->video);
589 DCPContent::can_reference_video (shared_ptr<const Film> film, string& why_not) const
592 why_not = _("There is no video in this DCP");
596 Resolution video_res = RESOLUTION_2K;
597 if (video->size().width > 2048 || video->size().height > 1080) {
598 video_res = RESOLUTION_4K;
601 if (film->resolution() != video_res) {
602 if (video_res == RESOLUTION_4K) {
603 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
604 why_not = _("it is 4K and the film is 2K.");
606 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
607 why_not = _("it is 2K and the film is 4K.");
610 } else if (film->frame_size() != video->size()) {
611 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
612 why_not = _("its video frame size differs from the film's.");
616 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
617 return can_reference (film, bind (&check_video, _1), _("it overlaps other video content; remove the other content."), why_not);
621 bool check_audio (shared_ptr<const Content> c)
623 return static_cast<bool>(c->audio);
627 DCPContent::can_reference_audio (shared_ptr<const Film> film, string& why_not) const
629 shared_ptr<DCPDecoder> decoder;
631 decoder.reset (new DCPDecoder (film, shared_from_this(), false));
632 } catch (dcp::DCPReadError &) {
633 /* We couldn't read the DCP, so it's probably missing */
635 } catch (DCPError &) {
636 /* We couldn't read the DCP, so it's probably missing */
638 } catch (dcp::KDMDecryptionError &) {
639 /* We have an incorrect KDM */
643 BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
644 if (!i->main_sound()) {
645 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
646 why_not = _("it does not have sound in all its reels.");
651 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
652 return can_reference (film, bind (&check_audio, _1), _("it overlaps other audio content; remove the other content."), why_not);
656 bool check_text (shared_ptr<const Content> c)
658 return !c->text.empty();
662 DCPContent::can_reference_text (shared_ptr<const Film> film, TextType type, string& why_not) const
664 shared_ptr<DCPDecoder> decoder;
666 decoder.reset (new DCPDecoder (film, shared_from_this(), false));
667 } catch (dcp::DCPReadError &) {
668 /* We couldn't read the DCP, so it's probably missing */
670 } catch (dcp::KDMDecryptionError &) {
671 /* We have an incorrect KDM */
675 BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
676 if (type == TEXT_OPEN_SUBTITLE && !i->main_subtitle()) {
677 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
678 why_not = _("it does not have open subtitles in all its reels.");
681 if (type == TEXT_CLOSED_CAPTION && i->closed_captions().empty()) {
682 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
683 why_not = _("it does not have closed captions in all its reels.");
688 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
689 return can_reference (film, bind (&check_text, _1), _("it overlaps other text content; remove the other content."), why_not);
693 DCPContent::take_settings_from (shared_ptr<const Content> c)
695 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (c);
700 _reference_video = dc->_reference_video;
701 _reference_audio = dc->_reference_audio;
702 for (int i = 0; i < TEXT_COUNT; ++i) {
703 _reference_text[i] = dc->_reference_text[i];
708 DCPContent::set_cpl (string id)
710 ChangeSignaller<Content> cc (this, DCPContentProperty::CPL);
713 boost::mutex::scoped_lock lm (_mutex);
719 DCPContent::kdm_timing_window_valid () const
726 return _kdm->not_valid_before() < now && now < _kdm->not_valid_after();