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);
194 ChangeSignaller<Content> cc_streams (this, AudioContentProperty::STREAMS);
197 job->set_progress_unknown ();
199 Content::examine (film, job);
201 shared_ptr<DCPExaminer> examiner (new DCPExaminer (shared_from_this ()));
203 if (examiner->has_video()) {
205 boost::mutex::scoped_lock lm (_mutex);
206 video.reset (new VideoContent (this));
208 video->take_from_examiner (examiner);
209 set_default_colour_conversion ();
212 if (examiner->has_audio()) {
213 ChangeSignaller<Content> cc (this, AudioContentProperty::STREAMS);
215 boost::mutex::scoped_lock lm (_mutex);
216 audio.reset (new AudioContent (this));
218 AudioStreamPtr as (new AudioStream (examiner->audio_frame_rate(), examiner->audio_length(), examiner->audio_channels()));
219 audio->set_stream (as);
220 AudioMapping m = as->mapping ();
221 m.make_default (film ? film->audio_processor() : 0);
227 boost::mutex::scoped_lock lm (_mutex);
228 _name = examiner->name ();
229 for (int i = 0; i < TEXT_COUNT; ++i) {
230 if (examiner->has_text(static_cast<TextType>(i))) {
231 text.push_back (shared_ptr<TextContent>(new TextContent(this, static_cast<TextType>(i), static_cast<TextType>(i))));
234 texts = text.size ();
235 _encrypted = examiner->encrypted ();
236 _needs_assets = examiner->needs_assets ();
237 _kdm_valid = examiner->kdm_valid ();
238 _standard = examiner->standard ();
239 _three_d = examiner->three_d ();
240 _content_kind = examiner->content_kind ();
241 _cpl = examiner->cpl ();
242 _reel_lengths = examiner->reel_lengths ();
245 if (old_texts == texts) {
249 if (needed_assets == needs_assets()) {
253 if (needed_kdm == needs_kdm()) {
257 if (old_name == name()) {
262 video->set_frame_type (_three_d ? VIDEO_FRAME_TYPE_3D : VIDEO_FRAME_TYPE_2D);
267 DCPContent::summary () const
269 boost::mutex::scoped_lock lm (_mutex);
270 return String::compose (_("%1 [DCP]"), _name);
274 DCPContent::technical_summary () const
276 string s = Content::technical_summary() + " - ";
278 s += video->technical_summary() + " - ";
281 s += audio->technical_summary() + " - ";
287 DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
289 node->add_child("Type")->add_child_text ("DCP");
291 Content::as_xml (node, with_paths);
294 video->as_xml (node);
298 audio->as_xml (node);
299 node->add_child("AudioFrameRate")->add_child_text (raw_convert<string> (audio->stream()->frame_rate()));
300 node->add_child("AudioLength")->add_child_text (raw_convert<string> (audio->stream()->length()));
301 audio->stream()->mapping().as_xml (node->add_child("AudioMapping"));
304 BOOST_FOREACH (shared_ptr<TextContent> i, text) {
308 boost::mutex::scoped_lock lm (_mutex);
309 node->add_child("Name")->add_child_text (_name);
310 node->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
311 node->add_child("NeedsAssets")->add_child_text (_needs_assets ? "1" : "0");
313 node->add_child("KDM")->add_child_text (_kdm->as_xml ());
315 node->add_child("KDMValid")->add_child_text (_kdm_valid ? "1" : "0");
316 node->add_child("ReferenceVideo")->add_child_text (_reference_video ? "1" : "0");
317 node->add_child("ReferenceAudio")->add_child_text (_reference_audio ? "1" : "0");
318 node->add_child("ReferenceOpenSubtitle")->add_child_text(_reference_text[TEXT_OPEN_SUBTITLE] ? "1" : "0");
319 node->add_child("ReferenceClosedCaption")->add_child_text(_reference_text[TEXT_CLOSED_CAPTION] ? "1" : "0");
321 switch (_standard.get ()) {
323 node->add_child("Standard")->add_child_text ("Interop");
326 node->add_child("Standard")->add_child_text ("SMPTE");
329 DCPOMATIC_ASSERT (false);
332 node->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
334 node->add_child("ContentKind")->add_child_text(dcp::content_kind_to_string(*_content_kind));
337 node->add_child("CPL")->add_child_text (_cpl.get ());
339 BOOST_FOREACH (int64_t i, _reel_lengths) {
340 node->add_child("ReelLength")->add_child_text (raw_convert<string> (i));
345 DCPContent::full_length (shared_ptr<const Film> film) const
350 FrameRateChange const frc (film, shared_from_this());
351 return DCPTime::from_frames (llrint(video->length() * frc.factor()), film->video_frame_rate());
355 DCPContent::approximate_length () const
360 return DCPTime::from_frames (video->length(), 24);
364 DCPContent::identifier () const
366 string s = Content::identifier() + "_";
369 s += video->identifier() + "_";
372 BOOST_FOREACH (shared_ptr<TextContent> i, text) {
373 s += i->identifier () + " ";
376 s += string (_reference_video ? "1" : "0");
377 for (int i = 0; i < TEXT_COUNT; ++i) {
378 s += string (_reference_text[i] ? "1" : "0");
384 DCPContent::add_kdm (dcp::EncryptedKDM k)
390 DCPContent::add_ov (boost::filesystem::path ov)
396 DCPContent::can_be_played () const
398 return !needs_kdm() && !needs_assets();
402 DCPContent::needs_kdm () const
404 boost::mutex::scoped_lock lm (_mutex);
405 return _encrypted && !_kdm_valid;
409 DCPContent::needs_assets () const
411 boost::mutex::scoped_lock lm (_mutex);
412 return _needs_assets;
415 vector<boost::filesystem::path>
416 DCPContent::directories () const
418 return dcp::DCP::directories_from_files (paths());
422 DCPContent::add_properties (shared_ptr<const Film> film, list<UserProperty>& p) const
424 Content::add_properties (p);
426 video->add_properties (p);
429 audio->add_properties (film, p);
434 DCPContent::set_default_colour_conversion ()
436 /* Default to no colour conversion for DCPs */
438 video->unset_colour_conversion ();
443 DCPContent::set_reference_video (bool r)
445 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_VIDEO);
448 boost::mutex::scoped_lock lm (_mutex);
449 _reference_video = r;
454 DCPContent::set_reference_audio (bool r)
456 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_AUDIO);
459 boost::mutex::scoped_lock lm (_mutex);
460 _reference_audio = r;
465 DCPContent::set_reference_text (TextType type, bool r)
467 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_TEXT);
470 boost::mutex::scoped_lock lm (_mutex);
471 _reference_text[type] = r;
476 DCPContent::reels (shared_ptr<const Film> film) const
478 list<int64_t> reel_lengths = _reel_lengths;
479 if (reel_lengths.empty ()) {
480 /* Old metadata with no reel lengths; get them here instead */
482 scoped_ptr<DCPExaminer> examiner (new DCPExaminer (shared_from_this()));
483 reel_lengths = examiner->reel_lengths ();
485 /* Could not examine the DCP; guess reels */
486 reel_lengths.push_back (length_after_trim(film).frames_round(film->video_frame_rate()));
490 list<DCPTimePeriod> p;
492 /* This content's frame rate must be the same as the output DCP rate, so we can
493 convert `directly' from ContentTime to DCPTime.
496 /* The starting point of this content on the timeline */
497 DCPTime pos = position() - DCPTime (trim_start().get());
499 BOOST_FOREACH (int64_t i, reel_lengths) {
500 /* This reel runs from `pos' to `to' */
501 DCPTime const to = pos + DCPTime::from_frames (i, film->video_frame_rate());
502 if (to > position()) {
503 p.push_back (DCPTimePeriod (max(position(), pos), min(end(film), to)));
504 if (to > end(film)) {
515 DCPContent::reel_split_points (shared_ptr<const Film> film) const
518 BOOST_FOREACH (DCPTimePeriod i, reels(film)) {
519 s.push_back (i.from);
525 DCPContent::can_reference (shared_ptr<const Film> film, function<bool (shared_ptr<const Content>)> part, string overlapping, string& why_not) const
527 /* We must be using the same standard as the film */
529 if (_standard.get() == dcp::INTEROP && !film->interop()) {
530 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
531 why_not = _("it is Interop and the film is set to SMPTE.");
533 } else if (_standard.get() == dcp::SMPTE && film->interop()) {
534 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
535 why_not = _("it is SMPTE and the film is set to Interop.");
540 /* And the same frame rate */
541 if (!video_frame_rate() || (lrint(video_frame_rate().get()) != film->video_frame_rate())) {
542 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
543 why_not = _("it has a different frame rate to the film.");
547 list<DCPTimePeriod> const fr = film->reels ();
549 list<DCPTimePeriod> reel_list;
551 reel_list = reels (film);
552 } catch (dcp::DCPReadError) {
553 /* We couldn't read the DCP; it's probably missing */
555 } catch (dcp::KDMDecryptionError) {
556 /* We have an incorrect KDM */
560 /* fr must contain reels(). It can also contain other reels, but it must at
561 least contain reels().
563 BOOST_FOREACH (DCPTimePeriod i, reel_list) {
564 if (find (fr.begin(), fr.end(), i) == fr.end ()) {
565 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
566 why_not = _("its reel lengths differ from those in the film; set the reel mode to 'split by video content'.");
571 ContentList a = overlaps (film, film->content(), part, position(), end(film));
572 if (a.size() != 1 || a.front().get() != this) {
573 why_not = overlapping;
581 bool check_video (shared_ptr<const Content> c)
583 return static_cast<bool>(c->video);
587 DCPContent::can_reference_video (shared_ptr<const Film> film, string& why_not) const
590 why_not = _("There is no video in this DCP");
594 Resolution video_res = RESOLUTION_2K;
595 if (video->size().width > 2048 || video->size().height > 1080) {
596 video_res = RESOLUTION_4K;
599 if (film->resolution() != video_res) {
600 if (video_res == RESOLUTION_4K) {
601 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
602 why_not = _("it is 4K and the film is 2K.");
604 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
605 why_not = _("it is 2K and the film is 4K.");
608 } else if (film->frame_size() != video->size()) {
609 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
610 why_not = _("its video frame size differs from the film's.");
614 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
615 return can_reference (film, bind (&check_video, _1), _("it overlaps other video content; remove the other content."), why_not);
619 bool check_audio (shared_ptr<const Content> c)
621 return static_cast<bool>(c->audio);
625 DCPContent::can_reference_audio (shared_ptr<const Film> film, string& why_not) const
627 shared_ptr<DCPDecoder> decoder;
629 decoder.reset (new DCPDecoder (film, shared_from_this(), false));
630 } catch (dcp::DCPReadError) {
631 /* We couldn't read the DCP, so it's probably missing */
634 /* We couldn't read the DCP, so it's probably missing */
636 } catch (dcp::KDMDecryptionError) {
637 /* We have an incorrect KDM */
641 BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
642 if (!i->main_sound()) {
643 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
644 why_not = _("it does not have sound in all its reels.");
649 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
650 return can_reference (film, bind (&check_audio, _1), _("it overlaps other audio content; remove the other content."), why_not);
654 bool check_text (shared_ptr<const Content> c)
656 return !c->text.empty();
660 DCPContent::can_reference_text (shared_ptr<const Film> film, TextType type, string& why_not) const
662 shared_ptr<DCPDecoder> decoder;
664 decoder.reset (new DCPDecoder (film, shared_from_this(), false));
665 } catch (dcp::DCPReadError) {
667 /* We couldn't read the DCP, so it's probably missing */
669 } catch (dcp::KDMDecryptionError) {
670 /* We have an incorrect KDM */
674 BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
675 if (type == TEXT_OPEN_SUBTITLE && !i->main_subtitle()) {
676 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
677 why_not = _("it does not have open subtitles in all its reels.");
680 if (type == TEXT_CLOSED_CAPTION && i->closed_captions().empty()) {
681 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
682 why_not = _("it does not have closed captions in all its reels.");
687 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
688 return can_reference (film, bind (&check_text, _1), _("it overlaps other text content; remove the other content."), why_not);
692 DCPContent::take_settings_from (shared_ptr<const Content> c)
694 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (c);
699 _reference_video = dc->_reference_video;
700 _reference_audio = dc->_reference_audio;
701 for (int i = 0; i < TEXT_COUNT; ++i) {
702 _reference_text[i] = dc->_reference_text[i];
707 DCPContent::set_cpl (string id)
709 ChangeSignaller<Content> cc (this, DCPContentProperty::CPL);
712 boost::mutex::scoped_lock lm (_mutex);
718 DCPContent::kdm_timing_window_valid () const
725 return _kdm->not_valid_before() < now && now < _kdm->not_valid_after();