src/lib/dcp_content.cc

   1 /*
   2     Copyright (C) 2014-2022 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   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.
  10
  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.
  15
  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/>.
  18
  19 */
  20
  21
  22 #include "atmos_content.h"
  23 #include "audio_content.h"
  24 #include "compose.hpp"
  25 #include "config.h"
  26 #include "dcp_content.h"
  27 #include "dcp_decoder.h"
  28 #include "dcp_examiner.h"
  29 #include "dcpomatic_log.h"
  30 #include "film.h"
  31 #include "job.h"
  32 #include "log.h"
  33 #include "overlaps.h"
  34 #include "text_content.h"
  35 #include "video_content.h"
  36 #include <dcp/dcp.h>
  37 #include <dcp/raw_convert.h>
  38 #include <dcp/exceptions.h>
  39 #include <dcp/reel_closed_caption_asset.h>
  40 #include <dcp/reel_picture_asset.h>
  41 #include <dcp/reel_subtitle_asset.h>
  42 #include <dcp/reel.h>
  43 #include <libxml++/libxml++.h>
  44 #include <iterator>
  45 #include <iostream>
  46
  47 #include "i18n.h"
  48
  49
  50 using std::cout;
  51 using std::dynamic_pointer_cast;
  52 using std::function;
  53 using std::list;
  54 using std::make_shared;
  55 using std::shared_ptr;
  56 using std::string;
  57 using std::vector;
  58 using boost::optional;
  59 using boost::scoped_ptr;
  60 #if BOOST_VERSION >= 106100
  61 using namespace boost::placeholders;
  62 #endif
  63 using dcp::raw_convert;
  64 using namespace dcpomatic;
  65
  66
  67 int const DCPContentProperty::NEEDS_ASSETS       = 600;
  68 int const DCPContentProperty::NEEDS_KDM          = 601;
  69 int const DCPContentProperty::REFERENCE_VIDEO    = 602;
  70 int const DCPContentProperty::REFERENCE_AUDIO    = 603;
  71 int const DCPContentProperty::REFERENCE_TEXT     = 604;
  72 int const DCPContentProperty::NAME               = 605;
  73 int const DCPContentProperty::TEXTS              = 606;
  74 int const DCPContentProperty::CPL                = 607;
  75
  76
  77 DCPContent::DCPContent (boost::filesystem::path p)
  78         : _encrypted (false)
  79         , _needs_assets (false)
  80         , _kdm_valid (false)
  81         , _reference_video (false)
  82         , _reference_audio (false)
  83         , _three_d (false)
  84 {
  85         LOG_GENERAL ("Creating DCP content from %1", p.string());
  86
  87         read_directory (p);
  88         set_default_colour_conversion ();
  89
  90         for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
  91                 _reference_text[i] = false;
  92         }
  93 }
  94
  95 DCPContent::DCPContent (cxml::ConstNodePtr node, int version)
  96         : Content (node)
  97 {
  98         video = VideoContent::from_xml (this, node, version, VideoRange::FULL);
  99         audio = AudioContent::from_xml (this, node, version);
 100         list<string> notes;
 101         text = TextContent::from_xml (this, node, version, notes);
 102         atmos = AtmosContent::from_xml (this, node);
 103
 104         for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
 105                 _reference_text[i] = false;
 106         }
 107
 108         if (video && audio) {
 109                 audio->set_stream (
 110                         make_shared<AudioStream> (
 111                                 node->number_child<int> ("AudioFrameRate"),
 112                                 /* AudioLength was not present in some old metadata versions */
 113                                 node->optional_number_child<Frame>("AudioLength").get_value_or (
 114                                         video->length() * node->number_child<int>("AudioFrameRate") / video_frame_rate().get()
 115                                         ),
 116                                 AudioMapping (node->node_child ("AudioMapping"), version)
 117                                 )
 118                         );
 119         }
 120
 121         _name = node->string_child ("Name");
 122         _encrypted = node->bool_child ("Encrypted");
 123         _needs_assets = node->optional_bool_child("NeedsAssets").get_value_or (false);
 124         if (node->optional_node_child ("KDM")) {
 125                 _kdm = dcp::EncryptedKDM (node->string_child ("KDM"));
 126         }
 127         _kdm_valid = node->bool_child ("KDMValid");
 128         _reference_video = node->optional_bool_child ("ReferenceVideo").get_value_or (false);
 129         _reference_audio = node->optional_bool_child ("ReferenceAudio").get_value_or (false);
 130         if (version >= 37) {
 131                 _reference_text[static_cast<int>(TextType::OPEN_SUBTITLE)] = node->optional_bool_child("ReferenceOpenSubtitle").get_value_or(false);
 132                 _reference_text[static_cast<int>(TextType::CLOSED_CAPTION)] = node->optional_bool_child("ReferenceClosedCaption").get_value_or(false);
 133         } else {
 134                 _reference_text[static_cast<int>(TextType::OPEN_SUBTITLE)] = node->optional_bool_child("ReferenceSubtitle").get_value_or(false);
 135                 _reference_text[static_cast<int>(TextType::CLOSED_CAPTION)] = false;
 136         }
 137         if (node->optional_string_child("Standard")) {
 138                 auto const s = node->optional_string_child("Standard").get();
 139                 if (s == "Interop") {
 140                         _standard = dcp::Standard::INTEROP;
 141                 } else if (s == "SMPTE") {
 142                         _standard = dcp::Standard::SMPTE;
 143                 } else {
 144                         DCPOMATIC_ASSERT (false);
 145                 }
 146         }
 147         _three_d = node->optional_bool_child("ThreeD").get_value_or (false);
 148
 149         auto ck = node->optional_string_child("ContentKind");
 150         if (ck) {
 151                 _content_kind = dcp::ContentKind::from_name(*ck);
 152         }
 153         _cpl = node->optional_string_child("CPL");
 154         for (auto i: node->node_children("ReelLength")) {
 155                 _reel_lengths.push_back (raw_convert<int64_t> (i->content ()));
 156         }
 157
 158         for (auto i: node->node_children("Marker")) {
 159                 _markers[dcp::marker_from_string(i->string_attribute("type"))] = ContentTime(raw_convert<int64_t>(i->content()));
 160         }
 161
 162         for (auto i: node->node_children("Rating")) {
 163                 _ratings.push_back (dcp::Rating(i));
 164         }
 165
 166         for (auto i: node->node_children("ContentVersion")) {
 167                 _content_versions.push_back (i->content());
 168         }
 169 }
 170
 171 void
 172 DCPContent::read_directory (boost::filesystem::path p)
 173 {
 174         using namespace boost::filesystem;
 175
 176         bool have_assetmap = false;
 177         bool have_metadata = false;
 178
 179         for (auto i: directory_iterator(p)) {
 180                 if (i.path().filename() == "ASSETMAP" || i.path().filename() == "ASSETMAP.xml") {
 181                         have_assetmap = true;
 182                 } else if (i.path().filename() == "metadata.xml") {
 183                         have_metadata = true;
 184                 }
 185         }
 186
 187         if (!have_assetmap) {
 188                 if (!have_metadata) {
 189                         throw DCPError ("No ASSETMAP or ASSETMAP.xml file found: is this a DCP?");
 190                 } else {
 191                         throw ProjectFolderError ();
 192                 }
 193         }
 194
 195         read_sub_directory (p);
 196 }
 197
 198 void
 199 DCPContent::read_sub_directory (boost::filesystem::path p)
 200 {
 201         LOG_GENERAL ("DCPContent::read_sub_directory reads %1", p.string());
 202         for (auto i: boost::filesystem::directory_iterator(p)) {
 203                 if (boost::filesystem::is_regular_file(i.path())) {
 204                         LOG_GENERAL ("Inside there's regular file %1", i.path().string());
 205                         add_path (i.path());
 206                 } else if (boost::filesystem::is_directory(i.path()) && i.path().filename() != ".AppleDouble") {
 207                         LOG_GENERAL ("Inside there's directory %1", i.path().string());
 208                         read_sub_directory (i.path());
 209                 } else {
 210                         LOG_GENERAL("Ignoring %1 from inside: status is %2", i.path().string(), static_cast<int>(boost::filesystem::status(i.path()).type()));
 211                 }
 212         }
 213 }
 214
 215 /** @param film Film, or 0 */
 216 void
 217 DCPContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
 218 {
 219         bool const needed_assets = needs_assets ();
 220         bool const needed_kdm = needs_kdm ();
 221         string const old_name = name ();
 222
 223         ContentChangeSignaller cc_texts (this, DCPContentProperty::TEXTS);
 224         ContentChangeSignaller cc_assets (this, DCPContentProperty::NEEDS_ASSETS);
 225         ContentChangeSignaller cc_kdm (this, DCPContentProperty::NEEDS_KDM);
 226         ContentChangeSignaller cc_name (this, DCPContentProperty::NAME);
 227
 228         if (job) {
 229                 job->set_progress_unknown ();
 230         }
 231         Content::examine (film, job);
 232
 233         auto examiner = make_shared<DCPExaminer>(shared_from_this(), film ? film->tolerant() : true);
 234
 235         if (examiner->has_video()) {
 236                 {
 237                         boost::mutex::scoped_lock lm (_mutex);
 238                         video = make_shared<VideoContent>(this);
 239                 }
 240                 video->take_from_examiner (examiner);
 241                 set_default_colour_conversion ();
 242         }
 243
 244         if (examiner->has_audio()) {
 245                 {
 246                         boost::mutex::scoped_lock lm (_mutex);
 247                         audio = make_shared<AudioContent>(this);
 248                 }
 249                 auto as = make_shared<AudioStream>(examiner->audio_frame_rate(), examiner->audio_length(), examiner->audio_channels());
 250                 audio->set_stream (as);
 251                 auto m = as->mapping ();
 252                 m.make_default (film ? film->audio_processor() : 0);
 253                 as->set_mapping (m);
 254         }
 255
 256         if (examiner->has_atmos()) {
 257                 {
 258                         boost::mutex::scoped_lock lm (_mutex);
 259                         atmos = make_shared<AtmosContent>(this);
 260                 }
 261                 /* Setting length will cause calculations to be made based on edit rate, so that must
 262                  * be set up first otherwise hard-to-spot exceptions will be thrown.
 263                  */
 264                 atmos->set_edit_rate (examiner->atmos_edit_rate());
 265                 atmos->set_length (examiner->atmos_length());
 266         }
 267
 268         list<shared_ptr<TextContent>> new_text;
 269
 270         for (int i = 0; i < examiner->text_count(TextType::OPEN_SUBTITLE); ++i) {
 271                 auto c = make_shared<TextContent>(this, TextType::OPEN_SUBTITLE, TextType::OPEN_SUBTITLE);
 272                 c->set_language (examiner->open_subtitle_language());
 273                 add_fonts_from_examiner(c, examiner->fonts());
 274                 new_text.push_back (c);
 275         }
 276
 277         for (int i = 0; i < examiner->text_count(TextType::CLOSED_CAPTION); ++i) {
 278                 auto c = make_shared<TextContent>(this, TextType::CLOSED_CAPTION, TextType::CLOSED_CAPTION);
 279                 c->set_dcp_track (examiner->dcp_text_track(i));
 280                 new_text.push_back (c);
 281         }
 282
 283         {
 284                 boost::mutex::scoped_lock lm (_mutex);
 285                 text = new_text;
 286                 _name = examiner->name ();
 287                 _encrypted = examiner->encrypted ();
 288                 _needs_assets = examiner->needs_assets ();
 289                 _kdm_valid = examiner->kdm_valid ();
 290                 _standard = examiner->standard ();
 291                 _three_d = examiner->three_d ();
 292                 _content_kind = examiner->content_kind ();
 293                 _cpl = examiner->cpl ();
 294                 _reel_lengths = examiner->reel_lengths ();
 295                 for (auto const& i: examiner->markers()) {
 296                         _markers[i.first] = ContentTime(i.second.as_editable_units_ceil(DCPTime::HZ));
 297                 }
 298                 _ratings = examiner->ratings ();
 299                 _content_versions = examiner->content_versions ();
 300         }
 301
 302         if (needed_assets == needs_assets()) {
 303                 cc_assets.abort ();
 304         }
 305
 306         if (needed_kdm == needs_kdm()) {
 307                 cc_kdm.abort ();
 308         }
 309
 310         if (old_name == name()) {
 311                 cc_name.abort ();
 312         }
 313
 314         if (video) {
 315                 video->set_frame_type (_three_d ? VideoFrameType::THREE_D : VideoFrameType::TWO_D);
 316         }
 317 }
 318
 319 string
 320 DCPContent::summary () const
 321 {
 322         boost::mutex::scoped_lock lm (_mutex);
 323         return String::compose (_("%1 [DCP]"), _name);
 324 }
 325
 326 string
 327 DCPContent::technical_summary () const
 328 {
 329         string s = Content::technical_summary() + " - ";
 330         if (video) {
 331                 s += video->technical_summary() + " - ";
 332         }
 333         if (audio) {
 334                 s += audio->technical_summary() + " - ";
 335         }
 336         return s;
 337 }
 338
 339 void
 340 DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
 341 {
 342         node->add_child("Type")->add_child_text ("DCP");
 343
 344         Content::as_xml (node, with_paths);
 345
 346         if (video) {
 347                 video->as_xml (node);
 348         }
 349
 350         if (audio) {
 351                 audio->as_xml (node);
 352                 node->add_child("AudioFrameRate")->add_child_text (raw_convert<string> (audio->stream()->frame_rate()));
 353                 node->add_child("AudioLength")->add_child_text (raw_convert<string> (audio->stream()->length()));
 354                 audio->stream()->mapping().as_xml (node->add_child("AudioMapping"));
 355         }
 356
 357         for (auto i: text) {
 358                 i->as_xml (node);
 359         }
 360
 361         if (atmos) {
 362                 atmos->as_xml (node);
 363         }
 364
 365         boost::mutex::scoped_lock lm (_mutex);
 366         node->add_child("Name")->add_child_text (_name);
 367         node->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
 368         node->add_child("NeedsAssets")->add_child_text (_needs_assets ? "1" : "0");
 369         if (_kdm) {
 370                 node->add_child("KDM")->add_child_text (_kdm->as_xml ());
 371         }
 372         node->add_child("KDMValid")->add_child_text (_kdm_valid ? "1" : "0");
 373         node->add_child("ReferenceVideo")->add_child_text (_reference_video ? "1" : "0");
 374         node->add_child("ReferenceAudio")->add_child_text (_reference_audio ? "1" : "0");
 375         node->add_child("ReferenceOpenSubtitle")->add_child_text(_reference_text[static_cast<int>(TextType::OPEN_SUBTITLE)] ? "1" : "0");
 376         node->add_child("ReferenceClosedCaption")->add_child_text(_reference_text[static_cast<int>(TextType::CLOSED_CAPTION)] ? "1" : "0");
 377         if (_standard) {
 378                 switch (_standard.get ()) {
 379                 case dcp::Standard::INTEROP:
 380                         node->add_child("Standard")->add_child_text ("Interop");
 381                         break;
 382                 case dcp::Standard::SMPTE:
 383                         node->add_child("Standard")->add_child_text ("SMPTE");
 384                         break;
 385                 default:
 386                         DCPOMATIC_ASSERT (false);
 387                 }
 388         }
 389         node->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
 390         if (_content_kind) {
 391                 node->add_child("ContentKind")->add_child_text(_content_kind->name());
 392         }
 393         if (_cpl) {
 394                 node->add_child("CPL")->add_child_text (_cpl.get ());
 395         }
 396         for (auto i: _reel_lengths) {
 397                 node->add_child("ReelLength")->add_child_text (raw_convert<string> (i));
 398         }
 399
 400         for (auto const& i: _markers) {
 401                 auto marker = node->add_child("Marker");
 402                 marker->set_attribute("type", dcp::marker_to_string(i.first));
 403                 marker->add_child_text(raw_convert<string>(i.second.get()));
 404         }
 405
 406         for (auto i: _ratings) {
 407                 auto rating = node->add_child("Rating");
 408                 i.as_xml (rating);
 409         }
 410
 411         for (auto i: _content_versions) {
 412                 node->add_child("ContentVersion")->add_child_text(i);
 413         }
 414 }
 415
 416 DCPTime
 417 DCPContent::full_length (shared_ptr<const Film> film) const
 418 {
 419         if (!video) {
 420                 return {};
 421         }
 422         FrameRateChange const frc (film, shared_from_this());
 423         return DCPTime::from_frames (llrint(video->length() * frc.factor()), film->video_frame_rate());
 424 }
 425
 426 DCPTime
 427 DCPContent::approximate_length () const
 428 {
 429         if (!video) {
 430                 return {};
 431         }
 432         return DCPTime::from_frames (video->length(), 24);
 433 }
 434
 435 string
 436 DCPContent::identifier () const
 437 {
 438         string s = Content::identifier() + "_";
 439
 440         if (video) {
 441                 s += video->identifier() + "_";
 442         }
 443
 444         for (auto i: text) {
 445                 s += i->identifier () + " ";
 446         }
 447
 448         s += string (_reference_video ? "1" : "0");
 449         for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
 450                 s += string (_reference_text[i] ? "1" : "0");
 451         }
 452         return s;
 453 }
 454
 455 void
 456 DCPContent::add_kdm (dcp::EncryptedKDM k)
 457 {
 458         _kdm = k;
 459 }
 460
 461 void
 462 DCPContent::add_ov (boost::filesystem::path ov)
 463 {
 464         read_directory (ov);
 465 }
 466
 467 bool
 468 DCPContent::can_be_played () const
 469 {
 470         return !needs_kdm() && !needs_assets();
 471 }
 472
 473 bool
 474 DCPContent::needs_kdm () const
 475 {
 476         boost::mutex::scoped_lock lm (_mutex);
 477         return _encrypted && !_kdm_valid;
 478 }
 479
 480 bool
 481 DCPContent::needs_assets () const
 482 {
 483         boost::mutex::scoped_lock lm (_mutex);
 484         return _needs_assets;
 485 }
 486
 487 vector<boost::filesystem::path>
 488 DCPContent::directories () const
 489 {
 490         return dcp::DCP::directories_from_files (paths());
 491 }
 492
 493 void
 494 DCPContent::add_properties (shared_ptr<const Film> film, list<UserProperty>& p) const
 495 {
 496         Content::add_properties (film, p);
 497         if (video) {
 498                 video->add_properties (p);
 499         }
 500         if (audio) {
 501                 audio->add_properties (film, p);
 502         }
 503 }
 504
 505 void
 506 DCPContent::set_default_colour_conversion ()
 507 {
 508         /* Default to no colour conversion for DCPs */
 509         if (video) {
 510                 video->unset_colour_conversion ();
 511         }
 512 }
 513
 514 void
 515 DCPContent::set_reference_video (bool r)
 516 {
 517         ContentChangeSignaller cc (this, DCPContentProperty::REFERENCE_VIDEO);
 518
 519         {
 520                 boost::mutex::scoped_lock lm (_mutex);
 521                 _reference_video = r;
 522         }
 523 }
 524
 525 void
 526 DCPContent::set_reference_audio (bool r)
 527 {
 528         ContentChangeSignaller cc (this, DCPContentProperty::REFERENCE_AUDIO);
 529
 530         {
 531                 boost::mutex::scoped_lock lm (_mutex);
 532                 _reference_audio = r;
 533         }
 534 }
 535
 536 void
 537 DCPContent::set_reference_text (TextType type, bool r)
 538 {
 539         ContentChangeSignaller cc (this, DCPContentProperty::REFERENCE_TEXT);
 540
 541         {
 542                 boost::mutex::scoped_lock lm (_mutex);
 543                 _reference_text[static_cast<int>(type)] = r;
 544         }
 545 }
 546
 547 list<DCPTimePeriod>
 548 DCPContent::reels (shared_ptr<const Film> film) const
 549 {
 550         auto reel_lengths = _reel_lengths;
 551         if (reel_lengths.empty()) {
 552                 /* Old metadata with no reel lengths; get them here instead */
 553                 try {
 554                         scoped_ptr<DCPExaminer> examiner (new DCPExaminer(shared_from_this(), film->tolerant()));
 555                         reel_lengths = examiner->reel_lengths ();
 556                 } catch (...) {
 557                         /* Could not examine the DCP; guess reels */
 558                         reel_lengths.push_back (length_after_trim(film).frames_round(film->video_frame_rate()));
 559                 }
 560         }
 561
 562         list<DCPTimePeriod> p;
 563
 564         /* This content's frame rate must be the same as the output DCP rate, so we can
 565            convert `directly' from ContentTime to DCPTime.
 566         */
 567
 568         /* The starting point of this content on the timeline */
 569         auto pos = position() - DCPTime (trim_start().get());
 570
 571         for (auto i: reel_lengths) {
 572                 /* This reel runs from `pos' to `to' */
 573                 DCPTime const to = pos + DCPTime::from_frames (i, film->video_frame_rate());
 574                 if (to > position()) {
 575                         p.push_back (DCPTimePeriod(max(position(), pos), min(end(film), to)));
 576                         if (to > end(film)) {
 577                                 break;
 578                         }
 579                 }
 580                 pos = to;
 581         }
 582
 583         return p;
 584 }
 585
 586 list<DCPTime>
 587 DCPContent::reel_split_points (shared_ptr<const Film> film) const
 588 {
 589         list<DCPTime> s;
 590         for (auto i: reels(film)) {
 591                 s.push_back (i.from);
 592         }
 593         return s;
 594 }
 595
 596 bool
 597 DCPContent::can_reference (shared_ptr<const Film> film, function<bool (shared_ptr<const Content>)> part, string overlapping, string& why_not) const
 598 {
 599         /* We must be using the same standard as the film */
 600         if (_standard) {
 601                 if (_standard.get() == dcp::Standard::INTEROP && !film->interop()) {
 602                         /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
 603                         why_not = _("it is Interop and the film is set to SMPTE.");
 604                         return false;
 605                 } else if (_standard.get() == dcp::Standard::SMPTE && film->interop()) {
 606                         /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
 607                         why_not = _("it is SMPTE and the film is set to Interop.");
 608                         return false;
 609                 }
 610         }
 611
 612         /* And the same frame rate */
 613         if (!video_frame_rate() || (lrint(video_frame_rate().get()) != film->video_frame_rate())) {
 614                 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
 615                 why_not = _("it has a different frame rate to the film.");
 616                 return false;
 617         }
 618
 619         auto const fr = film->reels ();
 620
 621         list<DCPTimePeriod> reel_list;
 622         try {
 623                 reel_list = reels (film);
 624         } catch (dcp::ReadError &) {
 625                 /* We couldn't read the DCP; it's probably missing */
 626                 return false;
 627         } catch (dcp::KDMDecryptionError &) {
 628                 /* We have an incorrect KDM */
 629                 return false;
 630         }
 631
 632         /* fr must contain reels().  It can also contain other reels, but it must at
 633            least contain reels().
 634         */
 635         for (auto i: reel_list) {
 636                 if (find (fr.begin(), fr.end(), i) == fr.end ()) {
 637                         /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
 638                         why_not = _("its reel lengths differ from those in the film; set the reel mode to 'split by video content'.");
 639                         return false;
 640                 }
 641         }
 642
 643         auto a = overlaps (film, film->content(), part, position(), end(film));
 644         if (a.size() != 1 || a.front().get() != this) {
 645                 why_not = overlapping;
 646                 return false;
 647         }
 648
 649         return true;
 650 }
 651
 652 static
 653 bool check_video (shared_ptr<const Content> c)
 654 {
 655         return static_cast<bool>(c->video) && c->video->use();
 656 }
 657
 658 bool
 659 DCPContent::can_reference_video (shared_ptr<const Film> film, string& why_not) const
 660 {
 661         if (!video) {
 662                 why_not = _("There is no video in this DCP");
 663                 return false;
 664         }
 665
 666         if (film->resolution() != resolution()) {
 667                 if (resolution() == Resolution::FOUR_K) {
 668                         /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
 669                         why_not = _("it is 4K and the film is 2K.");
 670                 } else {
 671                         /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
 672                         why_not = _("it is 2K and the film is 4K.");
 673                 }
 674                 return false;
 675         } else if (film->frame_size() != video->size()) {
 676                 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
 677                 why_not = _("its video frame size differs from the film's.");
 678                 return false;
 679         }
 680
 681         /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
 682         return can_reference (film, bind (&check_video, _1), _("it overlaps other video content; remove the other content."), why_not);
 683 }
 684
 685 static
 686 bool check_audio (shared_ptr<const Content> c)
 687 {
 688         return static_cast<bool>(c->audio) && !c->audio->mapping().mapped_output_channels().empty();
 689 }
 690
 691 bool
 692 DCPContent::can_reference_audio (shared_ptr<const Film> film, string& why_not) const
 693 {
 694         shared_ptr<DCPDecoder> decoder;
 695         try {
 696                 decoder = make_shared<DCPDecoder>(film, shared_from_this(), false, film->tolerant(), shared_ptr<DCPDecoder>());
 697         } catch (dcp::ReadError &) {
 698                 /* We couldn't read the DCP, so it's probably missing */
 699                 return false;
 700         } catch (DCPError &) {
 701                 /* We couldn't read the DCP, so it's probably missing */
 702                 return false;
 703         } catch (dcp::KDMDecryptionError &) {
 704                 /* We have an incorrect KDM */
 705                 return false;
 706         }
 707
 708         for (auto i: decoder->reels()) {
 709                 if (!i->main_sound()) {
 710                         /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
 711                         why_not = _("it does not have sound in all its reels.");
 712                         return false;
 713                 }
 714         }
 715
 716         /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
 717         return can_reference (film, bind (&check_audio, _1), _("it overlaps other audio content; remove the other content."), why_not);
 718 }
 719
 720 static
 721 bool check_text (shared_ptr<const Content> c)
 722 {
 723         return !c->text.empty();
 724 }
 725
 726 bool
 727 DCPContent::can_reference_text (shared_ptr<const Film> film, TextType type, string& why_not) const
 728 {
 729         shared_ptr<DCPDecoder> decoder;
 730         try {
 731                 decoder = make_shared<DCPDecoder>(film, shared_from_this(), false, film->tolerant(), shared_ptr<DCPDecoder>());
 732         } catch (dcp::ReadError &) {
 733                 /* We couldn't read the DCP, so it's probably missing */
 734                 return false;
 735         } catch (dcp::KDMDecryptionError &) {
 736                 /* We have an incorrect KDM */
 737                 return false;
 738         }
 739
 740         for (auto i: decoder->reels()) {
 741                 if (type == TextType::OPEN_SUBTITLE) {
 742                         if (!i->main_subtitle()) {
 743                                 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
 744                                 why_not = _("it does not have open subtitles in all its reels.");
 745                                 return false;
 746                         } else if (i->main_subtitle()->entry_point().get_value_or(0) != 0) {
 747                                 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
 748                                 why_not = _("one of its subtitle reels has a non-zero entry point so it must be re-written.");
 749                                 return false;
 750                         }
 751                 }
 752                 if (type == TextType::CLOSED_CAPTION) {
 753                         if (i->closed_captions().empty()) {
 754                                 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
 755                                 why_not = _("it does not have closed captions in all its reels.");
 756                                 return false;
 757                         }
 758                         for (auto j: i->closed_captions()) {
 759                                 if (j->entry_point().get_value_or(0) != 0) {
 760                                         /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
 761                                         why_not = _("one of its closed caption has a non-zero entry point so it must be re-written.");
 762                                         return false;
 763                                 }
 764                         }
 765                 }
 766         }
 767
 768         if (trim_start() != dcpomatic::ContentTime()) {
 769                 /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
 770                 why_not = _("it has a start trim so its subtitles or closed captions must be re-written.");
 771                 return false;
 772         }
 773
 774         /// TRANSLATORS: this string will follow "Cannot reference this DCP: "
 775         return can_reference (film, bind (&check_text, _1), _("it overlaps other text content; remove the other content."), why_not);
 776 }
 777
 778 void
 779 DCPContent::take_settings_from (shared_ptr<const Content> c)
 780 {
 781         auto dc = dynamic_pointer_cast<const DCPContent>(c);
 782         if (!dc) {
 783                 return;
 784         }
 785
 786         _reference_video = dc->_reference_video;
 787         _reference_audio = dc->_reference_audio;
 788         for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
 789                 _reference_text[i] = dc->_reference_text[i];
 790         }
 791 }
 792
 793 void
 794 DCPContent::set_cpl (string id)
 795 {
 796         ContentChangeSignaller cc (this, DCPContentProperty::CPL);
 797
 798         {
 799                 boost::mutex::scoped_lock lm (_mutex);
 800                 _cpl = id;
 801         }
 802 }
 803
 804 bool
 805 DCPContent::kdm_timing_window_valid () const
 806 {
 807         if (!_kdm) {
 808                 return true;
 809         }
 810
 811         dcp::LocalTime now;
 812         return _kdm->not_valid_before() < now && now < _kdm->not_valid_after();
 813 }
 814
 815
 816 Resolution
 817 DCPContent::resolution () const
 818 {
 819         if (video->size().width > 2048 || video->size().height > 1080) {
 820                 return Resolution::FOUR_K;
 821         }
 822
 823         return Resolution::TWO_K;
 824 }
 825
 826
 827 void
 828 add_fonts_from_examiner(shared_ptr<TextContent> text, vector<vector<shared_ptr<Font>>> const & all_fonts)
 829 {
 830         int reel_number = 0;
 831         for (auto reel_fonts: all_fonts) {
 832                 for (auto font: reel_fonts) {
 833                         /* Each reel could have its own font with the same ID, so we disambiguate them here
 834                          * by prepending the reel number.  We do the same disambiguation when emitting the
 835                          * subtitles in the DCP decoder.
 836                          */
 837                         font->set_id(id_for_font_in_reel(font->id(), reel_number));
 838                         text->add_font(font);
 839                 }
 840                 ++reel_number;
 841         }
 842
 843 }
 844
 845
 846 string
 847 id_for_font_in_reel(string id, int reel)
 848 {
 849         return String::compose("%1_%2", reel, id);
 850 }
 851
 852
 853 void
 854 DCPContent::check_font_ids()
 855 {
 856         if (text.empty()) {
 857                 return;
 858         }
 859
 860         DCPExaminer examiner(shared_from_this(), true);
 861         add_fonts_from_examiner(text.front(), examiner.fonts());
 862 }
 863