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(...) dcpomatic_log->log(String::compose(__VA_ARGS__), LogEntry::TYPE_GENERAL);
69 DCPContent::DCPContent (boost::filesystem::path p)
71 , _needs_assets (false)
73 , _reference_video (false)
74 , _reference_audio (false)
77 LOG_GENERAL ("Creating DCP content from %1", p.string());
80 set_default_colour_conversion ();
82 for (int i = 0; i < TEXT_COUNT; ++i) {
83 _reference_text[i] = false;
87 DCPContent::DCPContent (cxml::ConstNodePtr node, int version)
90 video = VideoContent::from_xml (this, node, version);
91 audio = AudioContent::from_xml (this, node, version);
92 text = TextContent::from_xml (this, node, version);
94 for (int i = 0; i < TEXT_COUNT; ++i) {
95 _reference_text[i] = false;
102 node->number_child<int> ("AudioFrameRate"),
103 /* AudioLength was not present in some old metadata versions */
104 node->optional_number_child<Frame>("AudioLength").get_value_or (
105 video->length() * node->number_child<int>("AudioFrameRate") / video_frame_rate().get()
107 AudioMapping (node->node_child ("AudioMapping"), version)
113 _name = node->string_child ("Name");
114 _encrypted = node->bool_child ("Encrypted");
115 _needs_assets = node->optional_bool_child("NeedsAssets").get_value_or (false);
116 if (node->optional_node_child ("KDM")) {
117 _kdm = dcp::EncryptedKDM (node->string_child ("KDM"));
119 _kdm_valid = node->bool_child ("KDMValid");
120 _reference_video = node->optional_bool_child ("ReferenceVideo").get_value_or (false);
121 _reference_audio = node->optional_bool_child ("ReferenceAudio").get_value_or (false);
123 _reference_text[TEXT_OPEN_SUBTITLE] = node->optional_bool_child("ReferenceOpenSubtitle").get_value_or(false);
124 _reference_text[TEXT_CLOSED_CAPTION] = node->optional_bool_child("ReferenceClosedCaption").get_value_or(false);
126 _reference_text[TEXT_OPEN_SUBTITLE] = node->optional_bool_child("ReferenceSubtitle").get_value_or(false);
127 _reference_text[TEXT_CLOSED_CAPTION] = false;
129 if (node->optional_string_child("Standard")) {
130 string const s = node->optional_string_child("Standard").get();
131 if (s == "Interop") {
132 _standard = dcp::INTEROP;
133 } else if (s == "SMPTE") {
134 _standard = dcp::SMPTE;
136 DCPOMATIC_ASSERT (false);
139 _three_d = node->optional_bool_child("ThreeD").get_value_or (false);
141 optional<string> ck = node->optional_string_child("ContentKind");
143 _content_kind = dcp::content_kind_from_string (*ck);
145 _cpl = node->optional_string_child("CPL");
146 BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("ReelLength")) {
147 _reel_lengths.push_back (raw_convert<int64_t> (i->content ()));
152 DCPContent::read_directory (boost::filesystem::path p)
154 LOG_GENERAL ("DCPContent::read_directory reads %1", p.string());
155 for (boost::filesystem::directory_iterator i(p); i != boost::filesystem::directory_iterator(); ++i) {
156 if (boost::filesystem::is_regular_file (i->path())) {
157 LOG_GENERAL ("Inside there's regular file %1", i->path().string());
158 add_path (i->path());
159 } else if (boost::filesystem::is_directory (i->path ())) {
160 LOG_GENERAL ("Inside there's directory %1", i->path().string());
161 read_directory (i->path());
165 bool have_assetmap = false;
166 BOOST_FOREACH (boost::filesystem::path i, paths()) {
167 if (i.filename() == "ASSETMAP" || i.filename() == "ASSETMAP.xml") {
168 have_assetmap = true;
172 if (!have_assetmap) {
173 throw DCPError ("No ASSETMAP or ASSETMAP.xml file found: is this a DCP?");
178 DCPContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
180 bool const needed_assets = needs_assets ();
181 bool const needed_kdm = needs_kdm ();
182 string const old_name = name ();
183 int const old_texts = text.size ();
185 ChangeSignaller<Content> cc_texts (this, DCPContentProperty::TEXTS);
186 ChangeSignaller<Content> cc_assets (this, DCPContentProperty::NEEDS_ASSETS);
187 ChangeSignaller<Content> cc_kdm (this, DCPContentProperty::NEEDS_KDM);
188 ChangeSignaller<Content> cc_name (this, DCPContentProperty::NAME);
189 ChangeSignaller<Content> cc_streams (this, AudioContentProperty::STREAMS);
192 job->set_progress_unknown ();
194 Content::examine (film, job);
196 shared_ptr<DCPExaminer> examiner (new DCPExaminer (shared_from_this ()));
198 if (examiner->has_video()) {
200 boost::mutex::scoped_lock lm (_mutex);
201 video.reset (new VideoContent (this));
203 video->take_from_examiner (examiner);
204 set_default_colour_conversion ();
207 if (examiner->has_audio()) {
208 ChangeSignaller<Content> cc (this, AudioContentProperty::STREAMS);
210 boost::mutex::scoped_lock lm (_mutex);
211 audio.reset (new AudioContent (this));
213 AudioStreamPtr as (new AudioStream (examiner->audio_frame_rate(), examiner->audio_length(), examiner->audio_channels()));
214 audio->set_stream (as);
215 AudioMapping m = as->mapping ();
216 film->make_audio_mapping_default (m);
222 boost::mutex::scoped_lock lm (_mutex);
223 _name = examiner->name ();
224 for (int i = 0; i < TEXT_COUNT; ++i) {
225 if (examiner->has_text(static_cast<TextType>(i))) {
226 text.push_back (shared_ptr<TextContent>(new TextContent(this, static_cast<TextType>(i), static_cast<TextType>(i))));
229 texts = text.size ();
230 _encrypted = examiner->encrypted ();
231 _needs_assets = examiner->needs_assets ();
232 _kdm_valid = examiner->kdm_valid ();
233 _standard = examiner->standard ();
234 _three_d = examiner->three_d ();
235 _content_kind = examiner->content_kind ();
236 _cpl = examiner->cpl ();
237 _reel_lengths = examiner->reel_lengths ();
240 if (old_texts == texts) {
244 if (needed_assets == needs_assets()) {
248 if (needed_kdm == needs_kdm()) {
252 if (old_name == name()) {
257 video->set_frame_type (_three_d ? VIDEO_FRAME_TYPE_3D : VIDEO_FRAME_TYPE_2D);
262 DCPContent::summary () const
264 boost::mutex::scoped_lock lm (_mutex);
265 return String::compose (_("%1 [DCP]"), _name);
269 DCPContent::technical_summary () const
271 string s = Content::technical_summary() + " - ";
273 s += video->technical_summary() + " - ";
276 s += audio->technical_summary() + " - ";
282 DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
284 node->add_child("Type")->add_child_text ("DCP");
286 Content::as_xml (node, with_paths);
289 video->as_xml (node);
293 audio->as_xml (node);
294 node->add_child("AudioFrameRate")->add_child_text (raw_convert<string> (audio->stream()->frame_rate()));
295 node->add_child("AudioLength")->add_child_text (raw_convert<string> (audio->stream()->length()));
296 audio->stream()->mapping().as_xml (node->add_child("AudioMapping"));
299 BOOST_FOREACH (shared_ptr<TextContent> i, text) {
303 boost::mutex::scoped_lock lm (_mutex);
304 node->add_child("Name")->add_child_text (_name);
305 node->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
306 node->add_child("NeedsAssets")->add_child_text (_needs_assets ? "1" : "0");
308 node->add_child("KDM")->add_child_text (_kdm->as_xml ());
310 node->add_child("KDMValid")->add_child_text (_kdm_valid ? "1" : "0");
311 node->add_child("ReferenceVideo")->add_child_text (_reference_video ? "1" : "0");
312 node->add_child("ReferenceAudio")->add_child_text (_reference_audio ? "1" : "0");
313 node->add_child("ReferenceOpenSubtitle")->add_child_text(_reference_text[TEXT_OPEN_SUBTITLE] ? "1" : "0");
314 node->add_child("ReferenceClosedCaption")->add_child_text(_reference_text[TEXT_CLOSED_CAPTION] ? "1" : "0");
316 switch (_standard.get ()) {
318 node->add_child("Standard")->add_child_text ("Interop");
321 node->add_child("Standard")->add_child_text ("SMPTE");
324 DCPOMATIC_ASSERT (false);
327 node->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
329 node->add_child("ContentKind")->add_child_text(dcp::content_kind_to_string(*_content_kind));
332 node->add_child("CPL")->add_child_text (_cpl.get ());
334 BOOST_FOREACH (int64_t i, _reel_lengths) {
335 node->add_child("ReelLength")->add_child_text (raw_convert<string> (i));
340 DCPContent::full_length (shared_ptr<const Film> film) const
345 FrameRateChange const frc (active_video_frame_rate(film), film->video_frame_rate());
346 return DCPTime::from_frames (llrint(video->length() * frc.factor()), film->video_frame_rate());
350 DCPContent::identifier () const
352 string s = Content::identifier() + "_";
355 s += video->identifier() + "_";
358 BOOST_FOREACH (shared_ptr<TextContent> i, text) {
359 s += i->identifier () + " ";
362 s += string (_reference_video ? "1" : "0");
363 for (int i = 0; i < TEXT_COUNT; ++i) {
364 s += string (_reference_text[i] ? "1" : "0");
370 DCPContent::add_kdm (dcp::EncryptedKDM k)
376 DCPContent::add_ov (boost::filesystem::path ov)
382 DCPContent::can_be_played () const
384 return !needs_kdm() && !needs_assets();
388 DCPContent::needs_kdm () const
390 boost::mutex::scoped_lock lm (_mutex);
391 return _encrypted && !_kdm_valid;
395 DCPContent::needs_assets () const
397 boost::mutex::scoped_lock lm (_mutex);
398 return _needs_assets;
401 vector<boost::filesystem::path>
402 DCPContent::directories () const
404 return dcp::DCP::directories_from_files (paths());
408 DCPContent::add_properties (shared_ptr<const Film> film, list<UserProperty>& p) const
410 Content::add_properties (p);
412 video->add_properties (p);
415 audio->add_properties (film, p);
420 DCPContent::set_default_colour_conversion ()
422 /* Default to no colour conversion for DCPs */
424 video->unset_colour_conversion ();
429 DCPContent::set_reference_video (bool r)
431 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_VIDEO);
434 boost::mutex::scoped_lock lm (_mutex);
435 _reference_video = r;
440 DCPContent::set_reference_audio (bool r)
442 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_AUDIO);
445 boost::mutex::scoped_lock lm (_mutex);
446 _reference_audio = r;
451 DCPContent::set_reference_text (TextType type, bool r)
453 ChangeSignaller<Content> cc (this, DCPContentProperty::REFERENCE_TEXT);
456 boost::mutex::scoped_lock lm (_mutex);
457 _reference_text[type] = r;
462 DCPContent::reels (shared_ptr<const Film> film) const
464 list<int64_t> reel_lengths = _reel_lengths;
465 if (reel_lengths.empty ()) {
466 /* Old metadata with no reel lengths; get them here instead */
468 scoped_ptr<DCPExaminer> examiner (new DCPExaminer (shared_from_this()));
469 reel_lengths = examiner->reel_lengths ();
471 /* Could not examine the DCP; guess reels */
472 reel_lengths.push_back (length_after_trim(film).frames_round(film->video_frame_rate()));
476 list<DCPTimePeriod> p;
478 /* This content's frame rate must be the same as the output DCP rate, so we can
479 convert `directly' from ContentTime to DCPTime.
482 /* The starting point of this content on the timeline */
483 DCPTime pos = position() - DCPTime (trim_start().get());
485 BOOST_FOREACH (int64_t i, reel_lengths) {
486 /* This reel runs from `pos' to `to' */
487 DCPTime const to = pos + DCPTime::from_frames (i, film->video_frame_rate());
488 if (to > position()) {
489 p.push_back (DCPTimePeriod (max(position(), pos), min(end(film), to)));
490 if (to > end(film)) {
501 DCPContent::reel_split_points (shared_ptr<const Film> film) const
504 BOOST_FOREACH (DCPTimePeriod i, reels(film)) {
505 s.push_back (i.from);
511 DCPContent::can_reference (shared_ptr<const Film> film, function<bool (shared_ptr<const Content>)> part, string overlapping, string& why_not) const
513 /* We must be using the same standard as the film */
515 if (_standard.get() == dcp::INTEROP && !film->interop()) {
516 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
517 why_not = _("it is Interop and the film is set to SMPTE.");
519 } else if (_standard.get() == dcp::SMPTE && film->interop()) {
520 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
521 why_not = _("it is SMPTE and the film is set to Interop.");
526 /* And the same frame rate */
527 if (!video_frame_rate() || (lrint(video_frame_rate().get()) != film->video_frame_rate())) {
528 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
529 why_not = _("it has a different frame rate to the film.");
533 list<DCPTimePeriod> const fr = film->reels ();
535 list<DCPTimePeriod> reel_list;
537 reel_list = reels (film);
538 } catch (dcp::DCPReadError) {
539 /* We couldn't read the DCP; it's probably missing */
541 } catch (dcp::KDMDecryptionError) {
542 /* We have an incorrect KDM */
546 /* fr must contain reels(). It can also contain other reels, but it must at
547 least contain reels().
549 BOOST_FOREACH (DCPTimePeriod i, reel_list) {
550 if (find (fr.begin(), fr.end(), i) == fr.end ()) {
551 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
552 why_not = _("its reel lengths differ from those in the film; set the reel mode to 'split by video content'.");
557 ContentList a = overlaps (film, film->content(), part, position(), end(film));
558 if (a.size() != 1 || a.front().get() != this) {
559 why_not = overlapping;
567 bool check_video (shared_ptr<const Content> c)
569 return static_cast<bool>(c->video);
573 DCPContent::can_reference_video (shared_ptr<const Film> film, string& why_not) const
576 why_not = _("There is no video in this DCP");
580 Resolution video_res = RESOLUTION_2K;
581 if (video->size().width > 2048 || video->size().height > 1080) {
582 video_res = RESOLUTION_4K;
585 if (film->resolution() != video_res) {
586 if (video_res == RESOLUTION_4K) {
587 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
588 why_not = _("it is 4K and the film is 2K.");
590 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
591 why_not = _("it is 2K and the film is 4K.");
594 } else if (film->frame_size() != video->size()) {
595 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
596 why_not = _("its video frame size differs from the film's.");
600 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
601 return can_reference (film, bind (&check_video, _1), _("it overlaps other video content; remove the other content."), why_not);
605 bool check_audio (shared_ptr<const Content> c)
607 return static_cast<bool>(c->audio);
611 DCPContent::can_reference_audio (shared_ptr<const Film> film, string& why_not) const
613 shared_ptr<DCPDecoder> decoder;
615 decoder.reset (new DCPDecoder (film, shared_from_this(), false));
616 } catch (dcp::DCPReadError) {
617 /* We couldn't read the DCP, so it's probably missing */
620 /* We couldn't read the DCP, so it's probably missing */
622 } catch (dcp::KDMDecryptionError) {
623 /* We have an incorrect KDM */
627 BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
628 if (!i->main_sound()) {
629 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
630 why_not = _("it does not have sound in all its reels.");
635 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
636 return can_reference (film, bind (&check_audio, _1), _("it overlaps other audio content; remove the other content."), why_not);
640 bool check_text (shared_ptr<const Content> c)
642 return !c->text.empty();
646 DCPContent::can_reference_text (shared_ptr<const Film> film, TextType type, string& why_not) const
648 shared_ptr<DCPDecoder> decoder;
650 decoder.reset (new DCPDecoder (film, shared_from_this(), false));
651 } catch (dcp::DCPReadError) {
653 /* We couldn't read the DCP, so it's probably missing */
655 } catch (dcp::KDMDecryptionError) {
656 /* We have an incorrect KDM */
660 BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
661 if (type == TEXT_OPEN_SUBTITLE && !i->main_subtitle()) {
662 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
663 why_not = _("it does not have open subtitles in all its reels.");
666 if (type == TEXT_CLOSED_CAPTION && i->closed_captions().empty()) {
667 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
668 why_not = _("it does not have closed captions in all its reels.");
673 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
674 return can_reference (film, bind (&check_text, _1), _("it overlaps other text content; remove the other content."), why_not);
678 DCPContent::take_settings_from (shared_ptr<const Content> c)
680 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (c);
685 _reference_video = dc->_reference_video;
686 _reference_audio = dc->_reference_audio;
687 for (int i = 0; i < TEXT_COUNT; ++i) {
688 _reference_text[i] = dc->_reference_text[i];
693 DCPContent::set_cpl (string id)
695 ChangeSignaller<Content> cc (this, DCPContentProperty::CPL);
698 boost::mutex::scoped_lock lm (_mutex);
704 DCPContent::kdm_timing_window_valid () const
711 return _kdm->not_valid_before() < now && now < _kdm->not_valid_after();