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 using namespace boost::filesystem;
155 bool have_assetmap = false;
156 bool have_metadata = false;
158 for (directory_iterator i(p); i != directory_iterator(); ++i) {
159 if (i->path().filename() == "ASSETMAP" || i->path().filename() == "ASSETMAP.xml") {
160 have_assetmap = true;
161 } else if (i->path().filename() == "metadata.xml") {
162 have_metadata = true;
166 if (!have_assetmap) {
167 if (!have_metadata) {
168 throw DCPError ("No ASSETMAP or ASSETMAP.xml file found: is this a DCP?");
171 "This looks like a DCP-o-matic project folder, which cannot be added to a different project. "
172 "Choose the DCP directory inside the DCP-o-matic project folder if that's what you want to import."
177 read_sub_directory (p);
181 DCPContent::read_sub_directory (boost::filesystem::path p)
183 LOG_GENERAL ("DCPContent::read_sub_directory reads %1", p.string());
184 for (boost::filesystem::directory_iterator i(p); i != boost::filesystem::directory_iterator(); ++i) {
185 if (boost::filesystem::is_regular_file (i->path())) {
186 LOG_GENERAL ("Inside there's regular file %1", i->path().string());
187 add_path (i->path());
188 } else if (boost::filesystem::is_directory (i->path ())) {
189 LOG_GENERAL ("Inside there's directory %1", i->path().string());
190 read_sub_directory (i->path());
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 ()));
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 shared_ptr<TextContent> c(new TextContent(this, static_cast<TextType>(i), static_cast<TextType>(i)));
243 if (i == TEXT_CLOSED_CAPTION) {
244 c->set_dcp_track (examiner->dcp_text_track(j));
249 texts = text.size ();
250 _encrypted = examiner->encrypted ();
251 _needs_assets = examiner->needs_assets ();
252 _kdm_valid = examiner->kdm_valid ();
253 _standard = examiner->standard ();
254 _three_d = examiner->three_d ();
255 _content_kind = examiner->content_kind ();
256 _cpl = examiner->cpl ();
257 _reel_lengths = examiner->reel_lengths ();
260 if (old_texts == texts) {
264 if (needed_assets == needs_assets()) {
268 if (needed_kdm == needs_kdm()) {
272 if (old_name == name()) {
277 video->set_frame_type (_three_d ? VIDEO_FRAME_TYPE_3D : VIDEO_FRAME_TYPE_2D);
282 DCPContent::summary () const
284 boost::mutex::scoped_lock lm (_mutex);
285 return String::compose (_("%1 [DCP]"), _name);
289 DCPContent::technical_summary () const
291 string s = Content::technical_summary() + " - ";
293 s += video->technical_summary() + " - ";
296 s += audio->technical_summary() + " - ";
302 DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
304 node->add_child("Type")->add_child_text ("DCP");
306 Content::as_xml (node, with_paths);
309 video->as_xml (node);
313 audio->as_xml (node);
314 node->add_child("AudioFrameRate")->add_child_text (raw_convert<string> (audio->stream()->frame_rate()));
315 node->add_child("AudioLength")->add_child_text (raw_convert<string> (audio->stream()->length()));
316 audio->stream()->mapping().as_xml (node->add_child("AudioMapping"));
319 BOOST_FOREACH (shared_ptr<TextContent> i, text) {
323 boost::mutex::scoped_lock lm (_mutex);
324 node->add_child("Name")->add_child_text (_name);
325 node->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
326 node->add_child("NeedsAssets")->add_child_text (_needs_assets ? "1" : "0");
328 node->add_child("KDM")->add_child_text (_kdm->as_xml ());
330 node->add_child("KDMValid")->add_child_text (_kdm_valid ? "1" : "0");
331 node->add_child("ReferenceVideo")->add_child_text (_reference_video ? "1" : "0");
332 node->add_child("ReferenceAudio")->add_child_text (_reference_audio ? "1" : "0");
333 node->add_child("ReferenceOpenSubtitle")->add_child_text(_reference_text[TEXT_OPEN_SUBTITLE] ? "1" : "0");
334 node->add_child("ReferenceClosedCaption")->add_child_text(_reference_text[TEXT_CLOSED_CAPTION] ? "1" : "0");
336 switch (_standard.get ()) {
338 node->add_child("Standard")->add_child_text ("Interop");
341 node->add_child("Standard")->add_child_text ("SMPTE");
344 DCPOMATIC_ASSERT (false);
347 node->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
349 node->add_child("ContentKind")->add_child_text(dcp::content_kind_to_string(*_content_kind));
352 node->add_child("CPL")->add_child_text (_cpl.get ());
354 BOOST_FOREACH (int64_t i, _reel_lengths) {
355 node->add_child("ReelLength")->add_child_text (raw_convert<string> (i));
360 DCPContent::full_length (shared_ptr<const Film> film) const
365 FrameRateChange const frc (film, shared_from_this());
366 return DCPTime::from_frames (llrint(video->length() * frc.factor()), film->video_frame_rate());
370 DCPContent::approximate_length () const
375 return DCPTime::from_frames (video->length(), 24);
379 DCPContent::identifier () const
381 string s = Content::identifier() + "_";
384 s += video->identifier() + "_";
387 BOOST_FOREACH (shared_ptr<TextContent> i, text) {
388 s += i->identifier () + " ";
391 s += string (_reference_video ? "1" : "0");
392 for (int i = 0; i < TEXT_COUNT; ++i) {
393 s += string (_reference_text[i] ? "1" : "0");
399 DCPContent::add_kdm (dcp::EncryptedKDM k)
405 DCPContent::add_ov (boost::filesystem::path ov)
411 DCPContent::can_be_played () const
413 return !needs_kdm() && !needs_assets();
417 DCPContent::needs_kdm () const
419 boost::mutex::scoped_lock lm (_mutex);
420 return _encrypted && !_kdm_valid;
424 DCPContent::needs_assets () const
426 boost::mutex::scoped_lock lm (_mutex);
427 return _needs_assets;
430 vector<boost::filesystem::path>
431 DCPContent::directories () const
433 return dcp::DCP::directories_from_files (paths());
437 DCPContent::add_properties (shared_ptr<const Film> film, list<UserProperty>& p) const
439 Content::add_properties (film, p);
441 video->add_properties (p);
444 audio->add_properties (film, p);
449 DCPContent::set_default_colour_conversion ()
451 /* Default to no colour conversion for DCPs */
453 video->unset_colour_conversion ();
458 DCPContent::set_reference_video (bool r)
460 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_VIDEO);
463 boost::mutex::scoped_lock lm (_mutex);
464 _reference_video = r;
469 DCPContent::set_reference_audio (bool r)
471 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_AUDIO);
474 boost::mutex::scoped_lock lm (_mutex);
475 _reference_audio = r;
480 DCPContent::set_reference_text (TextType type, bool r)
482 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_TEXT);
485 boost::mutex::scoped_lock lm (_mutex);
486 _reference_text[type] = r;
491 DCPContent::reels (shared_ptr<const Film> film) const
493 list<int64_t> reel_lengths = _reel_lengths;
494 if (reel_lengths.empty ()) {
495 /* Old metadata with no reel lengths; get them here instead */
497 scoped_ptr<DCPExaminer> examiner (new DCPExaminer (shared_from_this()));
498 reel_lengths = examiner->reel_lengths ();
500 /* Could not examine the DCP; guess reels */
501 reel_lengths.push_back (length_after_trim(film).frames_round(film->video_frame_rate()));
505 list<DCPTimePeriod> p;
507 /* This content's frame rate must be the same as the output DCP rate, so we can
508 convert `directly' from ContentTime to DCPTime.
511 /* The starting point of this content on the timeline */
512 DCPTime pos = position() - DCPTime (trim_start().get());
514 BOOST_FOREACH (int64_t i, reel_lengths) {
515 /* This reel runs from `pos' to `to' */
516 DCPTime const to = pos + DCPTime::from_frames (i, film->video_frame_rate());
517 if (to > position()) {
518 p.push_back (DCPTimePeriod (max(position(), pos), min(end(film), to)));
519 if (to > end(film)) {
530 DCPContent::reel_split_points (shared_ptr<const Film> film) const
533 BOOST_FOREACH (DCPTimePeriod i, reels(film)) {
534 s.push_back (i.from);
540 DCPContent::can_reference (shared_ptr<const Film> film, function<bool (shared_ptr<const Content>)> part, string overlapping, string& why_not) const
542 /* We must be using the same standard as the film */
544 if (_standard.get() == dcp::INTEROP && !film->interop()) {
545 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
546 why_not = _("it is Interop and the film is set to SMPTE.");
548 } else if (_standard.get() == dcp::SMPTE && film->interop()) {
549 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
550 why_not = _("it is SMPTE and the film is set to Interop.");
555 /* And the same frame rate */
556 if (!video_frame_rate() || (lrint(video_frame_rate().get()) != film->video_frame_rate())) {
557 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
558 why_not = _("it has a different frame rate to the film.");
562 list<DCPTimePeriod> const fr = film->reels ();
564 list<DCPTimePeriod> reel_list;
566 reel_list = reels (film);
567 } catch (dcp::DCPReadError &) {
568 /* We couldn't read the DCP; it's probably missing */
570 } catch (dcp::KDMDecryptionError &) {
571 /* We have an incorrect KDM */
575 /* fr must contain reels(). It can also contain other reels, but it must at
576 least contain reels().
578 BOOST_FOREACH (DCPTimePeriod i, reel_list) {
579 if (find (fr.begin(), fr.end(), i) == fr.end ()) {
580 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
581 why_not = _("its reel lengths differ from those in the film; set the reel mode to 'split by video content'.");
586 ContentList a = overlaps (film, film->content(), part, position(), end(film));
587 if (a.size() != 1 || a.front().get() != this) {
588 why_not = overlapping;
596 bool check_video (shared_ptr<const Content> c)
598 return static_cast<bool>(c->video);
602 DCPContent::can_reference_video (shared_ptr<const Film> film, string& why_not) const
605 why_not = _("There is no video in this DCP");
609 Resolution video_res = RESOLUTION_2K;
610 if (video->size().width > 2048 || video->size().height > 1080) {
611 video_res = RESOLUTION_4K;
614 if (film->resolution() != video_res) {
615 if (video_res == RESOLUTION_4K) {
616 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
617 why_not = _("it is 4K and the film is 2K.");
619 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
620 why_not = _("it is 2K and the film is 4K.");
623 } else if (film->frame_size() != video->size()) {
624 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
625 why_not = _("its video frame size differs from the film's.");
629 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
630 return can_reference (film, bind (&check_video, _1), _("it overlaps other video content; remove the other content."), why_not);
634 bool check_audio (shared_ptr<const Content> c)
636 return static_cast<bool>(c->audio);
640 DCPContent::can_reference_audio (shared_ptr<const Film> film, string& why_not) const
642 shared_ptr<DCPDecoder> decoder;
644 decoder.reset (new DCPDecoder (film, shared_from_this(), false));
645 } catch (dcp::DCPReadError &) {
646 /* We couldn't read the DCP, so it's probably missing */
648 } catch (DCPError &) {
649 /* We couldn't read the DCP, so it's probably missing */
651 } catch (dcp::KDMDecryptionError &) {
652 /* We have an incorrect KDM */
656 BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
657 if (!i->main_sound()) {
658 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
659 why_not = _("it does not have sound in all its reels.");
664 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
665 return can_reference (film, bind (&check_audio, _1), _("it overlaps other audio content; remove the other content."), why_not);
669 bool check_text (shared_ptr<const Content> c)
671 return !c->text.empty();
675 DCPContent::can_reference_text (shared_ptr<const Film> film, TextType type, string& why_not) const
677 shared_ptr<DCPDecoder> decoder;
679 decoder.reset (new DCPDecoder (film, shared_from_this(), false));
680 } catch (dcp::DCPReadError &) {
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 (type == TEXT_OPEN_SUBTITLE && !i->main_subtitle()) {
690 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
691 why_not = _("it does not have open subtitles in all its reels.");
694 if (type == TEXT_CLOSED_CAPTION && i->closed_captions().empty()) {
695 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
696 why_not = _("it does not have closed captions in all its reels.");
701 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
702 return can_reference (film, bind (&check_text, _1), _("it overlaps other text content; remove the other content."), why_not);
706 DCPContent::take_settings_from (shared_ptr<const Content> c)
708 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (c);
713 _reference_video = dc->_reference_video;
714 _reference_audio = dc->_reference_audio;
715 for (int i = 0; i < TEXT_COUNT; ++i) {
716 _reference_text[i] = dc->_reference_text[i];
721 DCPContent::set_cpl (string id)
723 ChangeSignaller<Content> cc (this, DCPContentProperty::CPL);
726 boost::mutex::scoped_lock lm (_mutex);
732 DCPContent::kdm_timing_window_valid () const
739 return _kdm->not_valid_before() < now && now < _kdm->not_valid_after();