src/lib/dcp_content.cc

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