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 "text_content.h"
34 #include <dcp/raw_convert.h>
35 #include <dcp/exceptions.h>
36 #include <dcp/reel_picture_asset.h>
38 #include <libxml++/libxml++.h>
39 #include <boost/foreach.hpp>
51 using boost::shared_ptr;
52 using boost::scoped_ptr;
53 using boost::optional;
54 using boost::function;
55 using boost::dynamic_pointer_cast;
56 using dcp::raw_convert;
58 int const DCPContentProperty::NEEDS_ASSETS = 600;
59 int const DCPContentProperty::NEEDS_KDM = 601;
60 int const DCPContentProperty::REFERENCE_VIDEO = 602;
61 int const DCPContentProperty::REFERENCE_AUDIO = 603;
62 int const DCPContentProperty::REFERENCE_TEXT = 604;
63 int const DCPContentProperty::NAME = 605;
64 int const DCPContentProperty::TEXTS = 606;
65 int const DCPContentProperty::CPL = 607;
67 #define LOG_GENERAL(...) this->film()->log()->log(String::compose(__VA_ARGS__), LogEntry::TYPE_GENERAL);
69 DCPContent::DCPContent (shared_ptr<const Film> film, 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 (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version)
89 : Content (film, node)
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 ()));
153 DCPContent::read_directory (boost::filesystem::path p)
155 LOG_GENERAL ("DCPContent::read_directory reads %1", p.string());
156 for (boost::filesystem::directory_iterator i(p); i != boost::filesystem::directory_iterator(); ++i) {
157 if (boost::filesystem::is_regular_file (i->path())) {
158 LOG_GENERAL ("Inside there's regular file %1", i->path().string());
159 add_path (i->path());
160 } else if (boost::filesystem::is_directory (i->path ())) {
161 LOG_GENERAL ("Inside there's directory %1", i->path().string());
162 read_directory (i->path());
168 DCPContent::examine (shared_ptr<Job> job)
170 bool const needed_assets = needs_assets ();
171 bool const needed_kdm = needs_kdm ();
172 string const old_name = name ();
173 int const old_texts = text.size ();
175 ChangeSignaller<Content> cc_texts (this, DCPContentProperty::TEXTS);
176 ChangeSignaller<Content> cc_assets (this, DCPContentProperty::NEEDS_ASSETS);
177 ChangeSignaller<Content> cc_kdm (this, DCPContentProperty::NEEDS_KDM);
178 ChangeSignaller<Content> cc_name (this, DCPContentProperty::NAME);
179 ChangeSignaller<Content> cc_streams (this, AudioContentProperty::STREAMS);
182 job->set_progress_unknown ();
184 Content::examine (job);
186 shared_ptr<DCPExaminer> examiner (new DCPExaminer (shared_from_this ()));
188 if (examiner->has_video()) {
190 boost::mutex::scoped_lock lm (_mutex);
191 video.reset (new VideoContent (this));
193 video->take_from_examiner (examiner);
194 set_default_colour_conversion ();
197 if (examiner->has_audio()) {
198 ChangeSignaller<Content> cc (this, AudioContentProperty::STREAMS);
200 boost::mutex::scoped_lock lm (_mutex);
201 audio.reset (new AudioContent (this));
203 AudioStreamPtr as (new AudioStream (examiner->audio_frame_rate(), examiner->audio_length(), examiner->audio_channels()));
204 audio->set_stream (as);
205 AudioMapping m = as->mapping ();
206 film()->make_audio_mapping_default (m);
212 boost::mutex::scoped_lock lm (_mutex);
213 _name = examiner->name ();
214 for (int i = 0; i < TEXT_COUNT; ++i) {
215 if (examiner->has_text(static_cast<TextType>(i))) {
216 text.push_back (shared_ptr<TextContent>(new TextContent(this, static_cast<TextType>(i), static_cast<TextType>(i))));
219 texts = text.size ();
220 _encrypted = examiner->encrypted ();
221 _needs_assets = examiner->needs_assets ();
222 _kdm_valid = examiner->kdm_valid ();
223 _standard = examiner->standard ();
224 _three_d = examiner->three_d ();
225 _content_kind = examiner->content_kind ();
226 _cpl = examiner->cpl ();
227 _reel_lengths = examiner->reel_lengths ();
230 if (old_texts == texts) {
234 if (needed_assets == needs_assets()) {
238 if (needed_kdm == needs_kdm()) {
242 if (old_name == name()) {
247 video->set_frame_type (_three_d ? VIDEO_FRAME_TYPE_3D : VIDEO_FRAME_TYPE_2D);
252 DCPContent::summary () const
254 boost::mutex::scoped_lock lm (_mutex);
255 return String::compose (_("%1 [DCP]"), _name);
259 DCPContent::technical_summary () const
261 string s = Content::technical_summary() + " - ";
263 s += video->technical_summary() + " - ";
266 s += audio->technical_summary() + " - ";
272 DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
274 node->add_child("Type")->add_child_text ("DCP");
276 Content::as_xml (node, with_paths);
279 video->as_xml (node);
283 audio->as_xml (node);
284 node->add_child("AudioFrameRate")->add_child_text (raw_convert<string> (audio->stream()->frame_rate()));
285 node->add_child("AudioLength")->add_child_text (raw_convert<string> (audio->stream()->length()));
286 audio->stream()->mapping().as_xml (node->add_child("AudioMapping"));
289 BOOST_FOREACH (shared_ptr<TextContent> i, text) {
293 boost::mutex::scoped_lock lm (_mutex);
294 node->add_child("Name")->add_child_text (_name);
295 node->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
296 node->add_child("NeedsAssets")->add_child_text (_needs_assets ? "1" : "0");
298 node->add_child("KDM")->add_child_text (_kdm->as_xml ());
300 node->add_child("KDMValid")->add_child_text (_kdm_valid ? "1" : "0");
301 node->add_child("ReferenceVideo")->add_child_text (_reference_video ? "1" : "0");
302 node->add_child("ReferenceAudio")->add_child_text (_reference_audio ? "1" : "0");
303 node->add_child("ReferenceOpenSubtitle")->add_child_text(_reference_text[TEXT_OPEN_SUBTITLE] ? "1" : "0");
304 node->add_child("ReferenceClosedCaption")->add_child_text(_reference_text[TEXT_CLOSED_CAPTION] ? "1" : "0");
306 switch (_standard.get ()) {
308 node->add_child("Standard")->add_child_text ("Interop");
311 node->add_child("Standard")->add_child_text ("SMPTE");
314 DCPOMATIC_ASSERT (false);
317 node->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
319 node->add_child("ContentKind")->add_child_text(dcp::content_kind_to_string(*_content_kind));
322 node->add_child("CPL")->add_child_text (_cpl.get ());
324 BOOST_FOREACH (int64_t i, _reel_lengths) {
325 node->add_child("ReelLength")->add_child_text (raw_convert<string> (i));
330 DCPContent::full_length () const
335 FrameRateChange const frc (active_video_frame_rate (), film()->video_frame_rate ());
336 return DCPTime::from_frames (llrint (video->length () * frc.factor ()), film()->video_frame_rate ());
340 DCPContent::identifier () const
342 string s = Content::identifier() + "_";
345 s += video->identifier() + "_";
348 BOOST_FOREACH (shared_ptr<TextContent> i, text) {
349 s += i->identifier () + " ";
352 s += string (_reference_video ? "1" : "0");
353 for (int i = 0; i < TEXT_COUNT; ++i) {
354 s += string (_reference_text[i] ? "1" : "0");
360 DCPContent::add_kdm (dcp::EncryptedKDM k)
366 DCPContent::add_ov (boost::filesystem::path ov)
372 DCPContent::can_be_played () const
374 return !needs_kdm() && !needs_assets();
378 DCPContent::needs_kdm () const
380 boost::mutex::scoped_lock lm (_mutex);
381 return _encrypted && !_kdm_valid;
385 DCPContent::needs_assets () const
387 boost::mutex::scoped_lock lm (_mutex);
388 return _needs_assets;
391 vector<boost::filesystem::path>
392 DCPContent::directories () const
394 return dcp::DCP::directories_from_files (paths());
398 DCPContent::add_properties (list<UserProperty>& p) const
400 Content::add_properties (p);
402 video->add_properties (p);
405 audio->add_properties (p);
410 DCPContent::set_default_colour_conversion ()
412 /* Default to no colour conversion for DCPs */
414 video->unset_colour_conversion ();
419 DCPContent::set_reference_video (bool r)
421 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_VIDEO);
424 boost::mutex::scoped_lock lm (_mutex);
425 _reference_video = r;
430 DCPContent::set_reference_audio (bool r)
432 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_AUDIO);
435 boost::mutex::scoped_lock lm (_mutex);
436 _reference_audio = r;
441 DCPContent::set_reference_text (TextType type, bool r)
443 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_TEXT);
446 boost::mutex::scoped_lock lm (_mutex);
447 _reference_text[type] = r;
452 DCPContent::reels () const
454 list<int64_t> reel_lengths = _reel_lengths;
455 if (reel_lengths.empty ()) {
456 /* Old metadata with no reel lengths; get them here instead */
458 scoped_ptr<DCPExaminer> examiner (new DCPExaminer (shared_from_this()));
459 reel_lengths = examiner->reel_lengths ();
461 /* Could not examine the DCP; guess reels */
462 reel_lengths.push_back (length_after_trim().frames_round (film()->video_frame_rate ()));
466 list<DCPTimePeriod> p;
468 /* This content's frame rate must be the same as the output DCP rate, so we can
469 convert `directly' from ContentTime to DCPTime.
472 /* The starting point of this content on the timeline */
473 DCPTime pos = position() - DCPTime (trim_start().get());
475 BOOST_FOREACH (int64_t i, reel_lengths) {
476 /* This reel runs from `pos' to `to' */
477 DCPTime const to = pos + DCPTime::from_frames (i, film()->video_frame_rate());
478 if (to > position()) {
479 p.push_back (DCPTimePeriod (max(position(), pos), min(end(), to)));
491 DCPContent::reel_split_points () const
494 BOOST_FOREACH (DCPTimePeriod i, reels()) {
495 s.push_back (i.from);
501 DCPContent::can_reference (function<bool (shared_ptr<const Content>)> part, string overlapping, string& why_not) const
503 /* We must be using the same standard as the film */
505 if (_standard.get() == dcp::INTEROP && !film()->interop()) {
506 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
507 why_not = _("it is Interop and the film is set to SMPTE.");
509 } else if (_standard.get() == dcp::SMPTE && film()->interop()) {
510 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
511 why_not = _("it is SMPTE and the film is set to Interop.");
516 /* And the same frame rate */
517 if (!video_frame_rate() || (lrint(video_frame_rate().get()) != film()->video_frame_rate())) {
518 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
519 why_not = _("it has a different frame rate to the film.");
523 list<DCPTimePeriod> const fr = film()->reels ();
525 list<DCPTimePeriod> reel_list;
527 reel_list = reels ();
528 } catch (dcp::DCPReadError) {
529 /* We couldn't read the DCP; it's probably missing */
531 } catch (dcp::KDMDecryptionError) {
532 /* We have an incorrect KDM */
536 /* fr must contain reels(). It can also contain other reels, but it must at
537 least contain reels().
539 BOOST_FOREACH (DCPTimePeriod i, reel_list) {
540 if (find (fr.begin(), fr.end(), i) == fr.end ()) {
541 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
542 why_not = _("its reel lengths differ from those in the film; set the reel mode to 'split by video content'.");
547 ContentList a = overlaps (film()->content(), part, position(), end());
548 if (a.size() != 1 || a.front().get() != this) {
549 why_not = overlapping;
557 bool check_video (shared_ptr<const Content> c)
559 return static_cast<bool>(c->video);
563 DCPContent::can_reference_video (string& why_not) const
566 why_not = _("There is no video in this DCP");
570 Resolution video_res = RESOLUTION_2K;
571 if (video->size().width > 2048 || video->size().height > 1080) {
572 video_res = RESOLUTION_4K;
575 if (film()->resolution() != video_res) {
576 if (video_res == RESOLUTION_4K) {
577 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
578 why_not = _("it is 4K and the film is 2K.");
580 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
581 why_not = _("it is 2K and the film is 4K.");
584 } else if (film()->frame_size() != video->size()) {
585 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
586 why_not = _("its video frame size differs from the film's.");
590 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
591 return can_reference (bind (&check_video, _1), _("it overlaps other video content; remove the other content."), why_not);
595 bool check_audio (shared_ptr<const Content> c)
597 return static_cast<bool>(c->audio);
601 DCPContent::can_reference_audio (string& why_not) const
603 shared_ptr<DCPDecoder> decoder;
605 decoder.reset (new DCPDecoder (shared_from_this(), film()->log(), false));
606 } catch (dcp::DCPReadError) {
607 /* We couldn't read the DCP, so it's probably missing */
610 /* We couldn't read the DCP, so it's probably missing */
612 } catch (dcp::KDMDecryptionError) {
613 /* We have an incorrect KDM */
617 BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
618 if (!i->main_sound()) {
619 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
620 why_not = _("it does not have sound in all its reels.");
625 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
626 return can_reference (bind (&check_audio, _1), _("it overlaps other audio content; remove the other content."), why_not);
630 bool check_text (shared_ptr<const Content> c)
632 return !c->text.empty();
636 DCPContent::can_reference_text (TextType type, string& why_not) const
638 shared_ptr<DCPDecoder> decoder;
640 decoder.reset (new DCPDecoder (shared_from_this(), film()->log(), false));
641 } catch (dcp::DCPReadError) {
642 /* We couldn't read the DCP, so it's probably missing */
644 } catch (dcp::KDMDecryptionError) {
645 /* We have an incorrect KDM */
649 BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
650 if (type == TEXT_OPEN_SUBTITLE && !i->main_subtitle()) {
651 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
652 why_not = _("it does not have open subtitles in all its reels.");
655 if (type == TEXT_CLOSED_CAPTION && i->closed_captions().empty()) {
656 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
657 why_not = _("it does not have closed captions in all its reels.");
662 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
663 return can_reference (bind (&check_text, _1), _("it overlaps other text content; remove the other content."), why_not);
667 DCPContent::take_settings_from (shared_ptr<const Content> c)
669 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (c);
674 _reference_video = dc->_reference_video;
675 _reference_audio = dc->_reference_audio;
676 for (int i = 0; i < TEXT_COUNT; ++i) {
677 _reference_text[i] = dc->_reference_text[i];
682 DCPContent::set_cpl (string id)
684 ChangeSignaller<Content> cc (this, DCPContentProperty::CPL);
687 boost::mutex::scoped_lock lm (_mutex);
693 DCPContent::kdm_timing_window_valid () const
700 return _kdm->not_valid_before() < now && now < _kdm->not_valid_after();