src/lib/film.cc

   1 /*
   2     Copyright (C) 2012-2021 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 /** @file  src/film.cc
  22  *  @brief A representation of some audio, video and subtitle content, and details of
  23  *  how they should be presented in a DCP.
  24  */
  25
  26 #include "atmos_content.h"
  27 #include "film.h"
  28 #include "job.h"
  29 #include "util.h"
  30 #include "job_manager.h"
  31 #include "dcp_encoder.h"
  32 #include "transcode_job.h"
  33 #include "upload_job.h"
  34 #include "null_log.h"
  35 #include "file_log.h"
  36 #include "dcpomatic_log.h"
  37 #include "exceptions.h"
  38 #include "examine_content_job.h"
  39 #include "config.h"
  40 #include "playlist.h"
  41 #include "dcp_content_type.h"
  42 #include "ratio.h"
  43 #include "cross.h"
  44 #include "environment_info.h"
  45 #include "audio_processor.h"
  46 #include "digester.h"
  47 #include "compose.hpp"
  48 #include "screen.h"
  49 #include "audio_content.h"
  50 #include "video_content.h"
  51 #include "text_content.h"
  52 #include "ffmpeg_content.h"
  53 #include "dcp_content.h"
  54 #include "kdm_with_metadata.h"
  55 #include "cinema.h"
  56 #include "change_signaller.h"
  57 #include "check_content_change_job.h"
  58 #include "ffmpeg_subtitle_stream.h"
  59 #include "font.h"
  60 #include <libcxml/cxml.h>
  61 #include <dcp/cpl.h>
  62 #include <dcp/certificate_chain.h>
  63 #include <dcp/util.h>
  64 #include <dcp/local_time.h>
  65 #include <dcp/decrypted_kdm.h>
  66 #include <dcp/raw_convert.h>
  67 #include <dcp/reel_file_asset.h>
  68 #include <dcp/reel_asset.h>
  69 #include <libxml++/libxml++.h>
  70 #include <boost/filesystem.hpp>
  71 #include <boost/algorithm/string.hpp>
  72 #include <boost/regex.hpp>
  73 #include <unistd.h>
  74 #include <stdexcept>
  75 #include <iostream>
  76 #include <algorithm>
  77 #include <cstdlib>
  78 #include <iomanip>
  79 #include <set>
  80
  81 #include "i18n.h"
  82
  83 using std::string;
  84 using std::pair;
  85 using std::vector;
  86 using std::setfill;
  87 using std::min;
  88 using std::max;
  89 using std::make_pair;
  90 using std::cout;
  91 using std::list;
  92 using std::set;
  93 using std::runtime_error;
  94 using std::copy;
  95 using std::back_inserter;
  96 using std::map;
  97 using std::exception;
  98 using std::find;
  99 using std::shared_ptr;
 100 using std::weak_ptr;
 101 using std::make_shared;
 102 using std::dynamic_pointer_cast;
 103 using boost::optional;
 104 using boost::is_any_of;
 105 #if BOOST_VERSION >= 106100
 106 using namespace boost::placeholders;
 107 #endif
 108 using dcp::raw_convert;
 109 using namespace dcpomatic;
 110
 111 string const Film::metadata_file = "metadata.xml";
 112
 113 /* 5 -> 6
 114  * AudioMapping XML changed.
 115  * 6 -> 7
 116  * Subtitle offset changed to subtitle y offset, and subtitle x offset added.
 117  * 7 -> 8
 118  * Use <Scale> tag in <VideoContent> rather than <Ratio>.
 119  * 8 -> 9
 120  * DCI -> ISDCF
 121  * 9 -> 10
 122  * Subtitle X and Y scale.
 123  *
 124  * Bumped to 32 for 2.0 branch; some times are expressed in Times rather
 125  * than frames now.
 126  *
 127  * 32 -> 33
 128  * Changed <Period> to <Subtitle> in FFmpegSubtitleStream
 129  * 33 -> 34
 130  * Content only contains audio/subtitle-related tags if those things
 131  * are present.
 132  * 34 -> 35
 133  * VideoFrameType in VideoContent is a string rather than an integer.
 134  * 35 -> 36
 135  * EffectColour rather than OutlineColour in Subtitle.
 136  * 36 -> 37
 137  * TextContent can be in a Caption tag, and some of the tag names
 138  * have had Subtitle prefixes or suffixes removed.
 139  * 37 -> 38
 140  * VideoContent scale expressed just as "guess" or "custom"
 141  */
 142 int const Film::current_state_version = 38;
 143
 144 /** Construct a Film object in a given directory.
 145  *
 146  *  @param dir Film directory.
 147  */
 148
 149 Film::Film (optional<boost::filesystem::path> dir)
 150         : _playlist (new Playlist)
 151         , _use_isdcf_name (true)
 152         , _dcp_content_type (Config::instance()->default_dcp_content_type ())
 153         , _container (Config::instance()->default_container ())
 154         , _resolution (Resolution::TWO_K)
 155         , _encrypted (false)
 156         , _context_id (dcp::make_uuid ())
 157         , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
 158         , _isdcf_metadata (Config::instance()->default_isdcf_metadata ())
 159         , _video_frame_rate (24)
 160         , _audio_channels (Config::instance()->default_dcp_audio_channels ())
 161         , _three_d (false)
 162         , _sequence (true)
 163         , _interop (Config::instance()->default_interop ())
 164         , _audio_processor (0)
 165         , _reel_type (ReelType::SINGLE)
 166         , _reel_length (2000000000)
 167         , _reencode_j2k (false)
 168         , _user_explicit_video_frame_rate (false)
 169         , _user_explicit_container (false)
 170         , _user_explicit_resolution (false)
 171         , _name_language (dcp::LanguageTag("en-US"))
 172         , _audio_language (dcp::LanguageTag("en-US"))
 173         , _version_number (1)
 174         , _status (dcp::Status::FINAL)
 175         , _luminance (dcp::Luminance(4.5, dcp::Luminance::Unit::FOOT_LAMBERT))
 176         , _state_version (current_state_version)
 177         , _dirty (false)
 178         , _tolerant (false)
 179 {
 180         set_isdcf_date_today ();
 181
 182         _playlist_change_connection = _playlist->Change.connect (bind (&Film::playlist_change, this, _1));
 183         _playlist_order_changed_connection = _playlist->OrderChange.connect (bind (&Film::playlist_order_changed, this));
 184         _playlist_content_change_connection = _playlist->ContentChange.connect (bind (&Film::playlist_content_change, this, _1, _2, _3, _4));
 185         _playlist_length_change_connection = _playlist->LengthChange.connect (bind(&Film::playlist_length_change, this));
 186
 187         if (dir) {
 188                 /* Make state.directory a complete path without ..s (where possible)
 189                    (Code swiped from Adam Bowen on stackoverflow)
 190                    XXX: couldn't/shouldn't this just be boost::filesystem::canonical?
 191                 */
 192
 193                 boost::filesystem::path p (boost::filesystem::system_complete (dir.get()));
 194                 boost::filesystem::path result;
 195                 for (auto i: p) {
 196                         if (i == "..") {
 197                                 boost::system::error_code ec;
 198                                 if (boost::filesystem::is_symlink(result, ec) || result.filename() == "..") {
 199                                         result /= i;
 200                                 } else {
 201                                         result = result.parent_path ();
 202                                 }
 203                         } else if (i != ".") {
 204                                 result /= i;
 205                         }
 206                 }
 207
 208                 set_directory (result.make_preferred ());
 209         }
 210
 211         if (_directory) {
 212                 _log = make_shared<FileLog>(file("log"));
 213         } else {
 214                 _log = make_shared<NullLog>();
 215         }
 216
 217         _playlist->set_sequence (_sequence);
 218 }
 219
 220 Film::~Film ()
 221 {
 222         for (auto& i: _job_connections) {
 223                 i.disconnect ();
 224         }
 225
 226         for (auto& i: _audio_analysis_connections) {
 227                 i.disconnect ();
 228         }
 229 }
 230
 231 string
 232 Film::video_identifier () const
 233 {
 234         DCPOMATIC_ASSERT (container ());
 235
 236         string s = container()->id()
 237                 + "_" + resolution_to_string (_resolution)
 238                 + "_" + _playlist->video_identifier()
 239                 + "_" + raw_convert<string>(_video_frame_rate)
 240                 + "_" + raw_convert<string>(j2k_bandwidth());
 241
 242         if (encrypted ()) {
 243                 /* This is insecure but hey, the key is in plaintext in metadata.xml */
 244                 s += "_E" + _key.hex();
 245         } else {
 246                 s += "_P";
 247         }
 248
 249         if (_interop) {
 250                 s += "_I";
 251         } else {
 252                 s += "_S";
 253         }
 254
 255         if (_three_d) {
 256                 s += "_3D";
 257         }
 258
 259         return s;
 260 }
 261
 262 /** @return The file to write video frame info to */
 263 boost::filesystem::path
 264 Film::info_file (DCPTimePeriod period) const
 265 {
 266         boost::filesystem::path p;
 267         p /= "info";
 268         p /= video_identifier () + "_" + raw_convert<string> (period.from.get()) + "_" + raw_convert<string> (period.to.get());
 269         return file (p);
 270 }
 271
 272 boost::filesystem::path
 273 Film::internal_video_asset_dir () const
 274 {
 275         return dir ("video");
 276 }
 277
 278 boost::filesystem::path
 279 Film::internal_video_asset_filename (DCPTimePeriod p) const
 280 {
 281         return video_identifier() + "_" + raw_convert<string> (p.from.get()) + "_" + raw_convert<string> (p.to.get()) + ".mxf";
 282 }
 283
 284 boost::filesystem::path
 285 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
 286 {
 287         auto p = dir ("analysis");
 288
 289         Digester digester;
 290         for (auto i: playlist->content ()) {
 291                 if (!i->audio) {
 292                         continue;
 293                 }
 294
 295                 digester.add (i->digest ());
 296                 digester.add (i->audio->mapping().digest ());
 297                 if (playlist->content().size() != 1) {
 298                         /* Analyses should be considered equal regardless of gain
 299                            if they were made from just one piece of content.  This
 300                            is because we can fake any gain change in a single-content
 301                            analysis at the plotting stage rather than having to
 302                            recompute it.
 303                         */
 304                         digester.add (i->audio->gain ());
 305                 }
 306         }
 307
 308         if (audio_processor ()) {
 309                 digester.add (audio_processor()->id ());
 310         }
 311
 312         digester.add (audio_channels());
 313
 314         p /= digester.get ();
 315         return p;
 316 }
 317
 318
 319 boost::filesystem::path
 320 Film::subtitle_analysis_path (shared_ptr<const Content> content) const
 321 {
 322         auto p = dir ("analysis");
 323
 324         Digester digester;
 325         digester.add (content->digest());
 326
 327         if (!content->text.empty()) {
 328                 auto tc = content->text.front();
 329                 digester.add (tc->x_scale());
 330                 digester.add (tc->y_scale());
 331                 for (auto i: tc->fonts()) {
 332                         digester.add (i->id());
 333                 }
 334                 if (tc->effect()) {
 335                         digester.add (tc->effect().get());
 336                 }
 337                 digester.add (tc->line_spacing());
 338                 digester.add (tc->outline_width());
 339         }
 340
 341         auto fc = dynamic_pointer_cast<const FFmpegContent>(content);
 342         if (fc) {
 343                 digester.add (fc->subtitle_stream()->identifier());
 344         }
 345
 346         p /= digester.get ();
 347         return p;
 348 }
 349
 350
 351 /** Add suitable Jobs to the JobManager to create a DCP for this Film.
 352  *  @param gui true if this is being called from a GUI tool.
 353  *  @param check true to check the content in the project for changes before making the DCP.
 354  */
 355 void
 356 Film::make_dcp (bool gui, bool check)
 357 {
 358         if (dcp_name().find ("/") != string::npos) {
 359                 throw BadSettingError (_("name"), _("Cannot contain slashes"));
 360         }
 361
 362         if (container() == nullptr) {
 363                 throw MissingSettingError (_("container"));
 364         }
 365
 366         if (content().empty()) {
 367                 throw runtime_error (_("You must add some content to the DCP before creating it"));
 368         }
 369
 370         if (length() == DCPTime()) {
 371                 throw runtime_error (_("The DCP is empty, perhaps because all the content has zero length."));
 372         }
 373
 374         if (dcp_content_type() == nullptr) {
 375                 throw MissingSettingError (_("content type"));
 376         }
 377
 378         if (name().empty()) {
 379                 set_name ("DCP");
 380         }
 381
 382         for (auto i: content ()) {
 383                 if (!i->paths_valid()) {
 384                         throw runtime_error (_("some of your content is missing"));
 385                 }
 386                 auto dcp = dynamic_pointer_cast<const DCPContent>(i);
 387                 if (dcp && dcp->needs_kdm()) {
 388                         throw runtime_error (_("Some of your content needs a KDM"));
 389                 }
 390                 if (dcp && dcp->needs_assets()) {
 391                         throw runtime_error (_("Some of your content needs an OV"));
 392                 }
 393         }
 394
 395         set_isdcf_date_today ();
 396
 397         for (auto i: environment_info ()) {
 398                 LOG_GENERAL_NC (i);
 399         }
 400
 401         for (auto i: content ()) {
 402                 LOG_GENERAL ("Content: %1", i->technical_summary());
 403         }
 404         LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
 405         if (Config::instance()->only_servers_encode ()) {
 406                 LOG_GENERAL_NC ("0 threads: ONLY SERVERS SET TO ENCODE");
 407         } else {
 408                 LOG_GENERAL ("%1 threads", Config::instance()->master_encoding_threads());
 409         }
 410         LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
 411
 412         auto tj = make_shared<TranscodeJob>(shared_from_this());
 413         tj->set_encoder (make_shared<DCPEncoder>(shared_from_this(), tj));
 414         if (check) {
 415                 auto cc = make_shared<CheckContentChangeJob>(shared_from_this(), tj, gui);
 416                 JobManager::instance()->add (cc);
 417         } else {
 418                 JobManager::instance()->add (tj);
 419         }
 420 }
 421
 422 /** Start a job to send our DCP to the configured TMS */
 423 void
 424 Film::send_dcp_to_tms ()
 425 {
 426         JobManager::instance()->add(make_shared<UploadJob>(shared_from_this()));
 427 }
 428
 429 shared_ptr<xmlpp::Document>
 430 Film::metadata (bool with_content_paths) const
 431 {
 432         auto doc = make_shared<xmlpp::Document>();
 433         auto root = doc->create_root_node ("Metadata");
 434
 435         root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
 436         root->add_child("Name")->add_child_text (_name);
 437         root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
 438
 439         if (_dcp_content_type) {
 440                 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
 441         }
 442
 443         if (_container) {
 444                 root->add_child("Container")->add_child_text (_container->id ());
 445         }
 446
 447         root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
 448         root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
 449         _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
 450         root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
 451         root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
 452         root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
 453         root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
 454         root->add_child("Sequence")->add_child_text (_sequence ? "1" : "0");
 455         root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
 456         root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
 457         root->add_child("Key")->add_child_text (_key.hex ());
 458         root->add_child("ContextID")->add_child_text (_context_id);
 459         if (_audio_processor) {
 460                 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
 461         }
 462         root->add_child("ReelType")->add_child_text (raw_convert<string> (static_cast<int> (_reel_type)));
 463         root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
 464         root->add_child("ReencodeJ2K")->add_child_text (_reencode_j2k ? "1" : "0");
 465         root->add_child("UserExplicitVideoFrameRate")->add_child_text(_user_explicit_video_frame_rate ? "1" : "0");
 466         for (map<dcp::Marker, DCPTime>::const_iterator i = _markers.begin(); i != _markers.end(); ++i) {
 467                 auto m = root->add_child("Marker");
 468                 m->set_attribute("Type", dcp::marker_to_string(i->first));
 469                 m->add_child_text(raw_convert<string>(i->second.get()));
 470         }
 471         for (auto i: _ratings) {
 472                 i.as_xml (root->add_child("Rating"));
 473         }
 474         for (auto i: _content_versions) {
 475                 root->add_child("ContentVersion")->add_child_text(i);
 476         }
 477         root->add_child("NameLanguage")->add_child_text(_name_language.to_string());
 478         root->add_child("AudioLanguage")->add_child_text(_audio_language.to_string());
 479         if (_release_territory) {
 480                 root->add_child("ReleaseTerritory")->add_child_text(_release_territory->subtag());
 481         }
 482         root->add_child("VersionNumber")->add_child_text(raw_convert<string>(_version_number));
 483         root->add_child("Status")->add_child_text(dcp::status_to_string(_status));
 484         if (_chain) {
 485                 root->add_child("Chain")->add_child_text(*_chain);
 486         }
 487         if (_distributor) {
 488                 root->add_child("Distributor")->add_child_text(*_distributor);
 489         }
 490         if (_facility) {
 491                 root->add_child("Facility")->add_child_text(*_facility);
 492         }
 493         if (_luminance) {
 494                 root->add_child("LuminanceValue")->add_child_text(raw_convert<string>(_luminance->value()));
 495                 root->add_child("LuminanceUnit")->add_child_text(dcp::Luminance::unit_to_string(_luminance->unit()));
 496         }
 497         root->add_child("UserExplicitContainer")->add_child_text(_user_explicit_container ? "1" : "0");
 498         root->add_child("UserExplicitResolution")->add_child_text(_user_explicit_resolution ? "1" : "0");
 499         for (auto i: _subtitle_languages) {
 500                 root->add_child("SubtitleLanguage")->add_child_text(i.to_string());
 501         }
 502         _playlist->as_xml (root->add_child ("Playlist"), with_content_paths);
 503
 504         return doc;
 505 }
 506
 507 void
 508 Film::write_metadata (boost::filesystem::path path) const
 509 {
 510         metadata()->write_to_file_formatted(path.string());
 511 }
 512
 513 /** Write state to our `metadata' file */
 514 void
 515 Film::write_metadata () const
 516 {
 517         DCPOMATIC_ASSERT (directory());
 518         boost::filesystem::create_directories (directory().get());
 519         metadata()->write_to_file_formatted(file(metadata_file).string());
 520         _dirty = false;
 521 }
 522
 523 /** Write a template from this film */
 524 void
 525 Film::write_template (boost::filesystem::path path) const
 526 {
 527         boost::filesystem::create_directories (path.parent_path());
 528         shared_ptr<xmlpp::Document> doc = metadata (false);
 529         metadata(false)->write_to_file_formatted(path.string());
 530 }
 531
 532 /** Read state from our metadata file.
 533  *  @return Notes about things that the user should know about, or empty.
 534  */
 535 list<string>
 536 Film::read_metadata (optional<boost::filesystem::path> path)
 537 {
 538         if (!path) {
 539                 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file (metadata_file))) {
 540                         throw runtime_error (_("This film was created with an older version of DCP-o-matic, and unfortunately it cannot be loaded into this version.  You will need to create a new Film, re-add your content and set it up again.  Sorry!"));
 541                 }
 542
 543                 path = file (metadata_file);
 544         }
 545
 546         if (!boost::filesystem::exists(*path)) {
 547                 throw FileNotFoundError(*path);
 548         }
 549
 550         cxml::Document f ("Metadata");
 551         f.read_file (path.get ());
 552
 553         _state_version = f.number_child<int> ("Version");
 554         if (_state_version > current_state_version) {
 555                 throw runtime_error (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version.  Sorry!"));
 556         } else if (_state_version < current_state_version) {
 557                 /* This is an older version; save a copy (if we haven't already) */
 558                 auto const older = path->parent_path() / String::compose("metadata.%1.xml", _state_version);
 559                 if (!boost::filesystem::is_regular_file(older)) {
 560                         try {
 561                                 boost::filesystem::copy_file(*path, older);
 562                         } catch (...) {
 563                                 /* Never mind; at least we tried */
 564                         }
 565                 }
 566         }
 567
 568         _name = f.string_child ("Name");
 569         if (_state_version >= 9) {
 570                 _use_isdcf_name = f.bool_child ("UseISDCFName");
 571                 _isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
 572                 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
 573         } else {
 574                 _use_isdcf_name = f.bool_child ("UseDCIName");
 575                 _isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
 576                 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
 577         }
 578
 579
 580         {
 581                 auto c = f.optional_string_child("DCPContentType");
 582                 if (c) {
 583                         _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
 584                 }
 585         }
 586
 587         {
 588                 auto c = f.optional_string_child("Container");
 589                 if (c) {
 590                         _container = Ratio::from_id (c.get ());
 591                 }
 592         }
 593
 594         _resolution = string_to_resolution (f.string_child ("Resolution"));
 595         _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
 596         _video_frame_rate = f.number_child<int> ("VideoFrameRate");
 597         _encrypted = f.bool_child ("Encrypted");
 598         _audio_channels = f.number_child<int> ("AudioChannels");
 599         /* We used to allow odd numbers (and zero) channels, but it's just not worth
 600            the pain.
 601         */
 602         if (_audio_channels == 0) {
 603                 _audio_channels = 2;
 604         } else if ((_audio_channels % 2) == 1) {
 605                 _audio_channels++;
 606         }
 607
 608         if (f.optional_bool_child("SequenceVideo")) {
 609                 _sequence = f.bool_child("SequenceVideo");
 610         } else {
 611                 _sequence = f.bool_child("Sequence");
 612         }
 613
 614         _three_d = f.bool_child ("ThreeD");
 615         _interop = f.bool_child ("Interop");
 616         _key = dcp::Key (f.string_child ("Key"));
 617         _context_id = f.optional_string_child("ContextID").get_value_or (dcp::make_uuid ());
 618
 619         if (f.optional_string_child ("AudioProcessor")) {
 620                 _audio_processor = AudioProcessor::from_id (f.string_child ("AudioProcessor"));
 621         } else {
 622                 _audio_processor = 0;
 623         }
 624
 625         if (_audio_processor && !Config::instance()->show_experimental_audio_processors()) {
 626                 auto ap = AudioProcessor::visible();
 627                 if (find(ap.begin(), ap.end(), _audio_processor) == ap.end()) {
 628                         Config::instance()->set_show_experimental_audio_processors(true);
 629                 }
 630         }
 631
 632         _reel_type = static_cast<ReelType> (f.optional_number_child<int>("ReelType").get_value_or (static_cast<int>(ReelType::SINGLE)));
 633         _reel_length = f.optional_number_child<int64_t>("ReelLength").get_value_or (2000000000);
 634         _reencode_j2k = f.optional_bool_child("ReencodeJ2K").get_value_or(false);
 635         _user_explicit_video_frame_rate = f.optional_bool_child("UserExplicitVideoFrameRate").get_value_or(false);
 636
 637         for (auto i: f.node_children("Marker")) {
 638                 _markers[dcp::marker_from_string(i->string_attribute("Type"))] = DCPTime(dcp::raw_convert<DCPTime::Type>(i->content()));
 639         }
 640
 641         for (auto i: f.node_children("Rating")) {
 642                 _ratings.push_back (dcp::Rating(i));
 643         }
 644
 645         for (auto i: f.node_children("ContentVersion")) {
 646                 _content_versions.push_back (i->content());
 647         }
 648
 649         auto name_language = f.optional_string_child("NameLanguage");
 650         if (name_language) {
 651                 _name_language = dcp::LanguageTag (*name_language);
 652         }
 653         auto audio_language = f.optional_string_child("AudioLanguage");
 654         if (audio_language) {
 655                 _audio_language = dcp::LanguageTag (*audio_language);
 656         }
 657         auto release_territory = f.optional_string_child("ReleaseTerritory");
 658         if (release_territory) {
 659                 _release_territory = dcp::LanguageTag::RegionSubtag (*release_territory);
 660         }
 661
 662         _version_number = f.optional_number_child<int>("VersionNumber").get_value_or(0);
 663
 664         auto status = f.optional_string_child("Status");
 665         if (status) {
 666                 _status = dcp::string_to_status (*status);
 667         }
 668
 669         _chain = f.optional_string_child("Chain");
 670         _distributor = f.optional_string_child("Distributor");
 671         _facility = f.optional_string_child("Facility");
 672
 673         auto value = f.optional_number_child<float>("LuminanceValue");
 674         auto unit = f.optional_string_child("LuminanceUnit");
 675         if (value && unit) {
 676                 _luminance = dcp::Luminance (*value, dcp::Luminance::string_to_unit(*unit));
 677         }
 678
 679         /* Disable guessing for files made in previous DCP-o-matic versions */
 680         _user_explicit_container = f.optional_bool_child("UserExplicitContainer").get_value_or(true);
 681         _user_explicit_resolution = f.optional_bool_child("UserExplicitResolution").get_value_or(true);
 682
 683         for (auto i: f.node_children("SubtitleLanguage")) {
 684                 _subtitle_languages.push_back (dcp::LanguageTag(i->content()));
 685         }
 686
 687         list<string> notes;
 688         _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
 689
 690         /* Write backtraces to this film's directory, until another film is loaded */
 691         if (_directory) {
 692                 set_backtrace_file (file ("backtrace.txt"));
 693         }
 694
 695         /* Around 2.15.108 we removed subtitle language state from the text content and the ISDCF
 696          * metadata and put it into the Film instead.  If we've loaded an old Film let's try and fish
 697          * out the settings from where they were so that they don't get lost.
 698          */
 699
 700         optional<dcp::LanguageTag> found_language;
 701
 702         for (auto i: f.node_child("Playlist")->node_children("Content")) {
 703                 auto text = i->optional_node_child("Text");
 704                 if (text && text->optional_string_child("Language") && !found_language) {
 705                         try {
 706                                 found_language = dcp::LanguageTag(text->string_child("Language"));
 707                         } catch (...) {}
 708                 }
 709         }
 710
 711         if (_state_version >= 9) {
 712                 auto isdcf_language = f.node_child("ISDCFMetadata")->optional_string_child("SubtitleLanguage");
 713                 if (isdcf_language && !found_language) {
 714                         try {
 715                                 found_language = dcp::LanguageTag(*isdcf_language);
 716                         } catch (...) {
 717                                 try {
 718                                         found_language = dcp::LanguageTag(boost::algorithm::to_lower_copy(*isdcf_language));
 719                                 } catch (...) {
 720
 721                                 }
 722                         }
 723                 }
 724         }
 725
 726         if (found_language) {
 727                 _subtitle_languages.push_back (*found_language);
 728         }
 729
 730         _dirty = false;
 731         return notes;
 732 }
 733
 734 /** Given a directory name, return its full path within the Film's directory.
 735  *  @param d directory name within the Film's directory.
 736  *  @param create true to create the directory (and its parents) if they do not exist.
 737  */
 738 boost::filesystem::path
 739 Film::dir (boost::filesystem::path d, bool create) const
 740 {
 741         DCPOMATIC_ASSERT (_directory);
 742
 743         boost::filesystem::path p;
 744         p /= _directory.get();
 745         p /= d;
 746
 747         if (create) {
 748                 boost::filesystem::create_directories (p);
 749         }
 750
 751         return p;
 752 }
 753
 754 /** Given a file or directory name, return its full path within the Film's directory.
 755  *  Any required parent directories will be created.
 756  */
 757 boost::filesystem::path
 758 Film::file (boost::filesystem::path f) const
 759 {
 760         DCPOMATIC_ASSERT (_directory);
 761
 762         boost::filesystem::path p;
 763         p /= _directory.get();
 764         p /= f;
 765
 766         boost::filesystem::create_directories (p.parent_path ());
 767
 768         return p;
 769 }
 770
 771 list<int>
 772 Film::mapped_audio_channels () const
 773 {
 774         list<int> mapped;
 775
 776         if (audio_processor ()) {
 777                 /* Processors are mapped 1:1 to DCP outputs so we can work out mappings from there */
 778                 for (int i = 0; i < audio_processor()->out_channels(); ++i) {
 779                         mapped.push_back (i);
 780                 }
 781         } else {
 782                 for (auto i: content()) {
 783                         if (i->audio) {
 784                                 auto c = i->audio->mapping().mapped_output_channels();
 785                                 copy (c.begin(), c.end(), back_inserter(mapped));
 786                         }
 787                 }
 788
 789                 mapped.sort ();
 790                 mapped.unique ();
 791         }
 792
 793         return mapped;
 794 }
 795
 796 /** @return a ISDCF-compliant name for a DCP of this film */
 797 string
 798 Film::isdcf_name (bool if_created_now) const
 799 {
 800         string d;
 801
 802         auto raw_name = name ();
 803
 804         /* Split the raw name up into words */
 805         vector<string> words;
 806         split (words, raw_name, is_any_of (" _-"));
 807
 808         string fixed_name;
 809
 810         /* Add each word to fixed_name */
 811         for (auto i: words) {
 812                 string w = i;
 813
 814                 /* First letter is always capitalised */
 815                 w[0] = toupper (w[0]);
 816
 817                 /* Count caps in w */
 818                 size_t caps = 0;
 819                 for (size_t j = 0; j < w.size(); ++j) {
 820                         if (isupper (w[j])) {
 821                                 ++caps;
 822                         }
 823                 }
 824
 825                 /* If w is all caps make the rest of it lower case, otherwise
 826                    leave it alone.
 827                 */
 828                 if (caps == w.size ()) {
 829                         for (size_t j = 1; j < w.size(); ++j) {
 830                                 w[j] = tolower (w[j]);
 831                         }
 832                 }
 833
 834                 for (size_t j = 0; j < w.size(); ++j) {
 835                         fixed_name += w[j];
 836                 }
 837         }
 838
 839         if (fixed_name.length() > 14) {
 840                 fixed_name = fixed_name.substr (0, 14);
 841         }
 842
 843         d += fixed_name;
 844
 845         if (dcp_content_type()) {
 846                 d += "_" + dcp_content_type()->isdcf_name();
 847                 d += "-" + raw_convert<string>(isdcf_metadata().content_version);
 848         }
 849
 850         auto const dm = isdcf_metadata ();
 851
 852         if (dm.temp_version) {
 853                 d += "-Temp";
 854         }
 855
 856         if (dm.pre_release) {
 857                 d += "-Pre";
 858         }
 859
 860         if (dm.red_band) {
 861                 d += "-RedBand";
 862         }
 863
 864         if (!dm.chain.empty ()) {
 865                 d += "-" + dm.chain;
 866         }
 867
 868         if (three_d ()) {
 869                 d += "-3D";
 870         }
 871
 872         if (dm.two_d_version_of_three_d) {
 873                 d += "-2D";
 874         }
 875
 876         if (!dm.mastered_luminance.empty ()) {
 877                 d += "-" + dm.mastered_luminance;
 878         }
 879
 880         if (video_frame_rate() != 24) {
 881                 d += "-" + raw_convert<string>(video_frame_rate());
 882         }
 883
 884         if (container()) {
 885                 d += "_" + container()->isdcf_name();
 886         }
 887
 888         /* XXX: this uses the first bit of content only */
 889
 890         /* Interior aspect ratio.  The standard says we don't do this for trailers, for some strange reason */
 891         if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::ContentKind::TRAILER) {
 892                 Ratio const* content_ratio = nullptr;
 893                 for (auto i: content ()) {
 894                         if (i->video) {
 895                                 /* Here's the first piece of video content */
 896                                 content_ratio = Ratio::nearest_from_ratio(i->video->scaled_size(frame_size()).ratio());
 897                                 break;
 898                         }
 899                 }
 900
 901                 if (content_ratio && content_ratio != container()) {
 902                         /* This needs to be the numeric version of the ratio, and ::id() is close enough */
 903                         d += "-" + content_ratio->id();
 904                 }
 905         }
 906
 907         auto const audio_language = dm.audio_language.empty() ? "XX" : dm.audio_language;
 908
 909         d += "_" + audio_language;
 910
 911         /* I'm not clear on the precise details of the convention for CCAP labelling;
 912            for now I'm just appending -CCAP if we have any closed captions.
 913         */
 914
 915         auto burnt_in = true;
 916         auto ccap = false;
 917         for (auto i: content()) {
 918                 for (auto j: i->text) {
 919                         if (j->type() == TextType::OPEN_SUBTITLE && j->use() && !j->burn()) {
 920                                 burnt_in = false;
 921                         } else if (j->type() == TextType::CLOSED_CAPTION && j->use()) {
 922                                 ccap = true;
 923                         }
 924                 }
 925         }
 926
 927         if (!_subtitle_languages.empty()) {
 928                 auto lang = _subtitle_languages.front().language().get_value_or("en").subtag();
 929                 if (burnt_in) {
 930                         transform (lang.begin(), lang.end(), lang.begin(), ::tolower);
 931                 } else {
 932                         transform (lang.begin(), lang.end(), lang.begin(), ::toupper);
 933                 }
 934
 935                 d += "-" + lang;
 936                 if (ccap) {
 937                         d += "-CCAP";
 938                 }
 939         } else {
 940                 /* No subtitles */
 941                 d += "-XX";
 942         }
 943
 944         if (!dm.territory.empty ()) {
 945                 d += "_" + dm.territory;
 946                 if (dm.rating.empty ()) {
 947                         d += "-NR";
 948                 } else {
 949                         d += "-" + dm.rating;
 950                 }
 951         }
 952
 953         /* Count mapped audio channels */
 954
 955         auto mapped = mapped_audio_channels ();
 956
 957         auto ch = audio_channel_types (mapped, audio_channels());
 958         if (!ch.first && !ch.second) {
 959                 d += "_MOS";
 960         } else if (ch.first) {
 961                 d += String::compose("_%1%2", ch.first, ch.second);
 962         }
 963
 964         if (audio_channels() > static_cast<int>(dcp::Channel::HI) && find(mapped.begin(), mapped.end(), static_cast<int>(dcp::Channel::HI)) != mapped.end()) {
 965                 d += "-HI";
 966         }
 967         if (audio_channels() > static_cast<int>(dcp::Channel::VI) && find(mapped.begin(), mapped.end(), static_cast<int>(dcp::Channel::VI)) != mapped.end()) {
 968                 d += "-VI";
 969         }
 970
 971         d += "_" + resolution_to_string (_resolution);
 972
 973         if (!dm.studio.empty ()) {
 974                 d += "_" + dm.studio;
 975         }
 976
 977         if (if_created_now) {
 978                 d += "_" + boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
 979         } else {
 980                 d += "_" + boost::gregorian::to_iso_string (_isdcf_date);
 981         }
 982
 983         if (!dm.facility.empty ()) {
 984                 d += "_" + dm.facility;
 985         }
 986
 987         if (_interop) {
 988                 d += "_IOP";
 989         } else {
 990                 d += "_SMPTE";
 991         }
 992
 993         if (three_d ()) {
 994                 d += "-3D";
 995         }
 996
 997         auto vf = false;
 998         for (auto i: content()) {
 999                 auto dc = dynamic_pointer_cast<const DCPContent>(i);
1000                 if (!dc) {
1001                         continue;
1002                 }
1003
1004                 bool any_text = false;
1005                 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1006                         if (dc->reference_text(static_cast<TextType>(i))) {
1007                                 any_text = true;
1008                         }
1009                 }
1010                 if (dc->reference_video() || dc->reference_audio() || any_text) {
1011                         vf = true;
1012                 }
1013         }
1014
1015         if (vf) {
1016                 d += "_VF";
1017         } else {
1018                 d += "_OV";
1019         }
1020
1021         return d;
1022 }
1023
1024 /** @return name to give the DCP */
1025 string
1026 Film::dcp_name (bool if_created_now) const
1027 {
1028         string unfiltered;
1029         if (use_isdcf_name()) {
1030                 return careful_string_filter (isdcf_name (if_created_now));
1031         }
1032
1033         return careful_string_filter (name ());
1034 }
1035
1036 void
1037 Film::set_directory (boost::filesystem::path d)
1038 {
1039         _directory = d;
1040         _dirty = true;
1041 }
1042
1043 void
1044 Film::set_name (string n)
1045 {
1046         FilmChangeSignaller ch (this, Property::NAME);
1047         _name = n;
1048 }
1049
1050 void
1051 Film::set_use_isdcf_name (bool u)
1052 {
1053         FilmChangeSignaller ch (this, Property::USE_ISDCF_NAME);
1054         _use_isdcf_name = u;
1055 }
1056
1057 void
1058 Film::set_dcp_content_type (DCPContentType const * t)
1059 {
1060         FilmChangeSignaller ch (this, Property::DCP_CONTENT_TYPE);
1061         _dcp_content_type = t;
1062 }
1063
1064
1065 /** @param explicit_user true if this is being set because of
1066  *  a direct user request, false if it is being done because
1067  *  DCP-o-matic is guessing the best container to use.
1068  */
1069 void
1070 Film::set_container (Ratio const * c, bool explicit_user)
1071 {
1072         FilmChangeSignaller ch (this, Property::CONTAINER);
1073         _container = c;
1074
1075         if (explicit_user) {
1076                 _user_explicit_container = true;
1077         }
1078 }
1079
1080
1081 /** @param explicit_user true if this is being set because of
1082  *  a direct user request, false if it is being done because
1083  *  DCP-o-matic is guessing the best resolution to use.
1084  */
1085 void
1086 Film::set_resolution (Resolution r, bool explicit_user)
1087 {
1088         FilmChangeSignaller ch (this, Property::RESOLUTION);
1089         _resolution = r;
1090
1091         if (explicit_user) {
1092                 _user_explicit_resolution = true;
1093         }
1094 }
1095
1096
1097 void
1098 Film::set_j2k_bandwidth (int b)
1099 {
1100         FilmChangeSignaller ch (this, Property::J2K_BANDWIDTH);
1101         _j2k_bandwidth = b;
1102 }
1103
1104 void
1105 Film::set_isdcf_metadata (ISDCFMetadata m)
1106 {
1107         FilmChangeSignaller ch (this, Property::ISDCF_METADATA);
1108         _isdcf_metadata = m;
1109 }
1110
1111 /** @param f New frame rate.
1112  *  @param user_explicit true if this comes from a direct user instruction, false if it is from
1113  *  DCP-o-matic being helpful.
1114  */
1115 void
1116 Film::set_video_frame_rate (int f, bool user_explicit)
1117 {
1118         FilmChangeSignaller ch (this, Property::VIDEO_FRAME_RATE);
1119         _video_frame_rate = f;
1120         if (user_explicit) {
1121                 _user_explicit_video_frame_rate = true;
1122         }
1123 }
1124
1125 void
1126 Film::set_audio_channels (int c)
1127 {
1128         FilmChangeSignaller ch (this, Property::AUDIO_CHANNELS);
1129         _audio_channels = c;
1130 }
1131
1132 void
1133 Film::set_three_d (bool t)
1134 {
1135         FilmChangeSignaller ch (this, Property::THREE_D);
1136         _three_d = t;
1137
1138         if (_three_d && _isdcf_metadata.two_d_version_of_three_d) {
1139                 FilmChangeSignaller ch (this, Property::ISDCF_METADATA);
1140                 _isdcf_metadata.two_d_version_of_three_d = false;
1141         }
1142 }
1143
1144 void
1145 Film::set_interop (bool i)
1146 {
1147         FilmChangeSignaller ch (this, Property::INTEROP);
1148         _interop = i;
1149 }
1150
1151 void
1152 Film::set_audio_processor (AudioProcessor const * processor)
1153 {
1154         FilmChangeSignaller ch1 (this, Property::AUDIO_PROCESSOR);
1155         FilmChangeSignaller ch2 (this, Property::AUDIO_CHANNELS);
1156         _audio_processor = processor;
1157 }
1158
1159 void
1160 Film::set_reel_type (ReelType t)
1161 {
1162         FilmChangeSignaller ch (this, Property::REEL_TYPE);
1163         _reel_type = t;
1164 }
1165
1166 /** @param r Desired reel length in bytes */
1167 void
1168 Film::set_reel_length (int64_t r)
1169 {
1170         FilmChangeSignaller ch (this, Property::REEL_LENGTH);
1171         _reel_length = r;
1172 }
1173
1174 void
1175 Film::set_reencode_j2k (bool r)
1176 {
1177         FilmChangeSignaller ch (this, Property::REENCODE_J2K);
1178         _reencode_j2k = r;
1179 }
1180
1181 void
1182 Film::signal_change (ChangeType type, int p)
1183 {
1184         signal_change (type, static_cast<Property>(p));
1185 }
1186
1187 void
1188 Film::signal_change (ChangeType type, Property p)
1189 {
1190         if (type == ChangeType::DONE) {
1191                 _dirty = true;
1192
1193                 if (p == Property::CONTENT) {
1194                         if (!_user_explicit_video_frame_rate) {
1195                                 set_video_frame_rate (best_video_frame_rate());
1196                         }
1197                 }
1198
1199                 emit (boost::bind (boost::ref (Change), type, p));
1200
1201                 if (p == Property::VIDEO_FRAME_RATE || p == Property::SEQUENCE) {
1202                         /* We want to call Playlist::maybe_sequence but this must happen after the
1203                            main signal emission (since the butler will see that emission and un-suspend itself).
1204                         */
1205                         emit (boost::bind(&Playlist::maybe_sequence, _playlist.get(), shared_from_this()));
1206                 }
1207         } else {
1208                 Change (type, p);
1209         }
1210 }
1211
1212 void
1213 Film::set_isdcf_date_today ()
1214 {
1215         _isdcf_date = boost::gregorian::day_clock::local_day ();
1216 }
1217
1218 boost::filesystem::path
1219 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
1220 {
1221         boost::filesystem::path p;
1222         p /= "j2c";
1223         p /= video_identifier ();
1224
1225         char buffer[256];
1226         snprintf(buffer, sizeof(buffer), "%08d_%08" PRId64, reel, frame);
1227         string s (buffer);
1228
1229         if (eyes == Eyes::LEFT) {
1230                 s += ".L";
1231         } else if (eyes == Eyes::RIGHT) {
1232                 s += ".R";
1233         }
1234
1235         s += ".j2c";
1236
1237         if (tmp) {
1238                 s += ".tmp";
1239         }
1240
1241         p /= s;
1242         return file (p);
1243 }
1244
1245 static
1246 bool
1247 cpl_summary_compare (CPLSummary const & a, CPLSummary const & b)
1248 {
1249         return a.last_write_time > b.last_write_time;
1250 }
1251
1252 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs.
1253  *  The list will be returned in reverse order of timestamp (i.e. most recent first).
1254  */
1255 vector<CPLSummary>
1256 Film::cpls () const
1257 {
1258         if (!directory ()) {
1259                 return vector<CPLSummary> ();
1260         }
1261
1262         vector<CPLSummary> out;
1263
1264         auto const dir = directory().get();
1265         for (auto i: boost::filesystem::directory_iterator(dir)) {
1266                 if (
1267                         boost::filesystem::is_directory (i) &&
1268                         i.path().leaf() != "j2c" && i.path().leaf() != "video" && i.path().leaf() != "info" && i.path().leaf() != "analysis"
1269                         ) {
1270
1271                         try {
1272                                 out.push_back (CPLSummary(i));
1273                         } catch (...) {
1274
1275                         }
1276                 }
1277         }
1278
1279         sort (out.begin(), out.end(), cpl_summary_compare);
1280
1281         return out;
1282 }
1283
1284 void
1285 Film::set_encrypted (bool e)
1286 {
1287         FilmChangeSignaller ch (this, Property::ENCRYPTED);
1288         _encrypted = e;
1289 }
1290
1291 ContentList
1292 Film::content () const
1293 {
1294         return _playlist->content ();
1295 }
1296
1297 /** @param content Content to add.
1298  *  @param disable_audio_analysis true to never do automatic audio analysis, even if it is enabled in configuration.
1299  */
1300 void
1301 Film::examine_and_add_content (shared_ptr<Content> content, bool disable_audio_analysis)
1302 {
1303         if (dynamic_pointer_cast<FFmpegContent> (content) && _directory) {
1304                 run_ffprobe (content->path(0), file("ffprobe.log"));
1305         }
1306
1307         auto j = make_shared<ExamineContentJob>(shared_from_this(), content);
1308
1309         _job_connections.push_back (
1310                 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job>(j), weak_ptr<Content>(content), disable_audio_analysis))
1311                 );
1312
1313         JobManager::instance()->add (j);
1314 }
1315
1316 void
1317 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c, bool disable_audio_analysis)
1318 {
1319         auto job = j.lock ();
1320         if (!job || !job->finished_ok ()) {
1321                 return;
1322         }
1323
1324         auto content = c.lock ();
1325         if (!content) {
1326                 return;
1327         }
1328
1329         add_content (content);
1330
1331         if (Config::instance()->automatic_audio_analysis() && content->audio && !disable_audio_analysis) {
1332                 auto playlist = make_shared<Playlist>();
1333                 playlist->add (shared_from_this(), content);
1334                 boost::signals2::connection c;
1335                 JobManager::instance()->analyse_audio (
1336                         shared_from_this(), playlist, false, c, bind (&Film::audio_analysis_finished, this)
1337                         );
1338                 _audio_analysis_connections.push_back (c);
1339         }
1340 }
1341
1342 void
1343 Film::add_content (shared_ptr<Content> c)
1344 {
1345         /* Add {video,subtitle} content after any existing {video,subtitle} content */
1346         if (c->video) {
1347                 c->set_position (shared_from_this(), _playlist->video_end(shared_from_this()));
1348         } else if (!c->text.empty()) {
1349                 c->set_position (shared_from_this(), _playlist->text_end(shared_from_this()));
1350         }
1351
1352         if (_template_film) {
1353                 /* Take settings from the first piece of content of c's type in _template */
1354                 for (auto i: _template_film->content()) {
1355                         c->take_settings_from (i);
1356                 }
1357         }
1358
1359         _playlist->add (shared_from_this(), c);
1360
1361         maybe_set_container_and_resolution ();
1362         if (c->atmos) {
1363                 set_audio_channels (14);
1364                 set_interop (false);
1365         }
1366 }
1367
1368
1369 void
1370 Film::maybe_set_container_and_resolution ()
1371 {
1372         /* Get the only piece of video content, if there is only one */
1373         shared_ptr<VideoContent> video;
1374         for (auto i: _playlist->content()) {
1375                 if (i->video) {
1376                         if (!video) {
1377                                 video = i->video;
1378                         } else {
1379                                 video.reset ();
1380                         }
1381                 }
1382         }
1383
1384         if (video) {
1385                 /* This is the only piece of video content in this Film.  Use it to make a guess for
1386                  * DCP container size and resolution, unless the user has already explicitly set these
1387                  * things.
1388                  */
1389                 if (!_user_explicit_container) {
1390                         if (video->size().ratio() > 2.3) {
1391                                 set_container (Ratio::from_id("239"), false);
1392                         } else {
1393                                 set_container (Ratio::from_id("185"), false);
1394                         }
1395                 }
1396
1397                 if (!_user_explicit_resolution) {
1398                         if (video->size_after_crop().width > 2048 || video->size_after_crop().height > 1080) {
1399                                 set_resolution (Resolution::FOUR_K, false);
1400                         } else {
1401                                 set_resolution (Resolution::TWO_K, false);
1402                         }
1403                 }
1404         }
1405 }
1406
1407 void
1408 Film::remove_content (shared_ptr<Content> c)
1409 {
1410         _playlist->remove (c);
1411         maybe_set_container_and_resolution ();
1412 }
1413
1414 void
1415 Film::move_content_earlier (shared_ptr<Content> c)
1416 {
1417         _playlist->move_earlier (shared_from_this(), c);
1418 }
1419
1420 void
1421 Film::move_content_later (shared_ptr<Content> c)
1422 {
1423         _playlist->move_later (shared_from_this(), c);
1424 }
1425
1426 /** @return length of the film from time 0 to the last thing on the playlist,
1427  *  with a minimum length of 1 second.
1428  */
1429 DCPTime
1430 Film::length () const
1431 {
1432         return max(DCPTime::from_seconds(1), _playlist->length(shared_from_this()).ceil(video_frame_rate()));
1433 }
1434
1435 int
1436 Film::best_video_frame_rate () const
1437 {
1438         /* Don't default to anything above 30fps (make the user select that explicitly) */
1439         auto best = _playlist->best_video_frame_rate ();
1440         if (best > 30) {
1441                 best /= 2;
1442         }
1443         return best;
1444 }
1445
1446 FrameRateChange
1447 Film::active_frame_rate_change (DCPTime t) const
1448 {
1449         return _playlist->active_frame_rate_change (t, video_frame_rate ());
1450 }
1451
1452 void
1453 Film::playlist_content_change (ChangeType type, weak_ptr<Content> c, int p, bool frequent)
1454 {
1455         if (p == ContentProperty::VIDEO_FRAME_RATE) {
1456                 signal_change (type, Property::CONTENT);
1457         } else if (p == AudioContentProperty::STREAMS) {
1458                 signal_change (type, Property::NAME);
1459         }
1460
1461         if (type == ChangeType::DONE) {
1462                 emit (boost::bind (boost::ref (ContentChange), type, c, p, frequent));
1463                 if (!frequent) {
1464                         check_settings_consistency ();
1465                 }
1466         } else {
1467                 ContentChange (type, c, p, frequent);
1468         }
1469
1470         _dirty = true;
1471 }
1472
1473 void
1474 Film::playlist_length_change ()
1475 {
1476         LengthChange ();
1477 }
1478
1479 void
1480 Film::playlist_change (ChangeType type)
1481 {
1482         signal_change (type, Property::CONTENT);
1483         signal_change (type, Property::NAME);
1484
1485         if (type == ChangeType::DONE) {
1486                 check_settings_consistency ();
1487         }
1488
1489         _dirty = true;
1490 }
1491
1492 /** Check for (and if necessary fix) impossible settings combinations, like
1493  *  video set to being referenced when it can't be.
1494  */
1495 void
1496 Film::check_settings_consistency ()
1497 {
1498         optional<int> atmos_rate;
1499         for (auto i: content()) {
1500
1501                 if (i->atmos) {
1502                         int rate = lrintf (i->atmos->edit_rate().as_float());
1503                         if (atmos_rate && *atmos_rate != rate) {
1504                                 Message (_("You have more than one piece of Atmos content, and they do not have the same frame rate.  You must remove some Atmos content."));
1505                         } else if (!atmos_rate && rate != video_frame_rate()) {
1506                                 atmos_rate = rate;
1507                                 set_video_frame_rate (rate, false);
1508                                 Message (_("DCP-o-matic had to change your settings so that the film's frame rate is the same as that of your Atmos content."));
1509                         }
1510                 }
1511         }
1512
1513         bool change_made = false;
1514         for (auto i: content()) {
1515                 auto d = dynamic_pointer_cast<DCPContent>(i);
1516                 if (!d) {
1517                         continue;
1518                 }
1519
1520                 string why_not;
1521                 if (d->reference_video() && !d->can_reference_video(shared_from_this(), why_not)) {
1522                         d->set_reference_video(false);
1523                         change_made = true;
1524                 }
1525                 if (d->reference_audio() && !d->can_reference_audio(shared_from_this(), why_not)) {
1526                         d->set_reference_audio(false);
1527                         change_made = true;
1528                 }
1529                 if (d->reference_text(TextType::OPEN_SUBTITLE) && !d->can_reference_text(shared_from_this(), TextType::OPEN_SUBTITLE, why_not)) {
1530                         d->set_reference_text(TextType::OPEN_SUBTITLE, false);
1531                         change_made = true;
1532                 }
1533                 if (d->reference_text(TextType::CLOSED_CAPTION) && !d->can_reference_text(shared_from_this(), TextType::CLOSED_CAPTION, why_not)) {
1534                         d->set_reference_text(TextType::CLOSED_CAPTION, false);
1535                         change_made = true;
1536                 }
1537         }
1538
1539         if (change_made) {
1540                 Message (_("DCP-o-matic had to change your settings for referring to DCPs as OV.  Please review those settings to make sure they are what you want."));
1541         }
1542 }
1543
1544 void
1545 Film::playlist_order_changed ()
1546 {
1547         /* XXX: missing PENDING */
1548         signal_change (ChangeType::DONE, Property::CONTENT_ORDER);
1549 }
1550
1551 int
1552 Film::audio_frame_rate () const
1553 {
1554         /* It seems that nobody makes 96kHz DCPs at the moment, so let's avoid them.
1555            See #1436.
1556         */
1557         return 48000;
1558 }
1559
1560 void
1561 Film::set_sequence (bool s)
1562 {
1563         if (s == _sequence) {
1564                 return;
1565         }
1566
1567         FilmChangeSignaller cc (this, Property::SEQUENCE);
1568         _sequence = s;
1569         _playlist->set_sequence (s);
1570 }
1571
1572 /** @return Size of the largest possible image in whatever resolution we are using */
1573 dcp::Size
1574 Film::full_frame () const
1575 {
1576         switch (_resolution) {
1577         case Resolution::TWO_K:
1578                 return dcp::Size (2048, 1080);
1579         case Resolution::FOUR_K:
1580                 return dcp::Size (4096, 2160);
1581         }
1582
1583         DCPOMATIC_ASSERT (false);
1584         return dcp::Size ();
1585 }
1586
1587 /** @return Size of the frame */
1588 dcp::Size
1589 Film::frame_size () const
1590 {
1591         return fit_ratio_within (container()->ratio(), full_frame ());
1592 }
1593
1594
1595 /** @return Area of Film::frame_size() that contains picture rather than pillar/letterboxing */
1596 dcp::Size
1597 Film::active_area () const
1598 {
1599         auto const frame = frame_size ();
1600         dcp::Size active;
1601
1602         for (auto i: content()) {
1603                 if (i->video) {
1604                         dcp::Size s = i->video->scaled_size (frame);
1605                         active.width = max(active.width, s.width);
1606                         active.height = max(active.height, s.height);
1607                 }
1608         }
1609
1610         return active;
1611 }
1612
1613
1614 /** @param recipient KDM recipient certificate.
1615  *  @param trusted_devices Certificate thumbprints of other trusted devices (can be empty).
1616  *  @param cpl_file CPL filename.
1617  *  @param from KDM from time expressed as a local time with an offset from UTC.
1618  *  @param until KDM to time expressed as a local time with an offset from UTC.
1619  *  @param formulation KDM formulation to use.
1620  *  @param disable_forensic_marking_picture true to disable forensic marking of picture.
1621  *  @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio.  If set to 0,
1622  *  disable all forensic marking; if set above 0, disable forensic marking above that channel.
1623  */
1624 dcp::EncryptedKDM
1625 Film::make_kdm (
1626         dcp::Certificate recipient,
1627         vector<string> trusted_devices,
1628         boost::filesystem::path cpl_file,
1629         dcp::LocalTime from,
1630         dcp::LocalTime until,
1631         dcp::Formulation formulation,
1632         bool disable_forensic_marking_picture,
1633         optional<int> disable_forensic_marking_audio
1634         ) const
1635 {
1636         if (!_encrypted) {
1637                 throw runtime_error (_("Cannot make a KDM as this project is not encrypted."));
1638         }
1639
1640         auto cpl = make_shared<dcp::CPL>(cpl_file);
1641         auto signer = Config::instance()->signer_chain();
1642         if (!signer->valid ()) {
1643                 throw InvalidSignerError ();
1644         }
1645
1646         /* Find keys that have been added to imported, encrypted DCP content */
1647         list<dcp::DecryptedKDMKey> imported_keys;
1648         for (auto i: content()) {
1649                 auto d = dynamic_pointer_cast<DCPContent> (i);
1650                 if (d && d->kdm()) {
1651                         dcp::DecryptedKDM kdm (d->kdm().get(), Config::instance()->decryption_chain()->key().get());
1652                         auto keys = kdm.keys ();
1653                         copy (keys.begin(), keys.end(), back_inserter (imported_keys));
1654                 }
1655         }
1656
1657         map<shared_ptr<const dcp::ReelFileAsset>, dcp::Key> keys;
1658
1659         for (auto i: cpl->reel_file_assets()) {
1660                 if (!i->key_id()) {
1661                         continue;
1662                 }
1663
1664                 /* Get any imported key for this ID */
1665                 bool done = false;
1666                 for (auto j: imported_keys) {
1667                         if (j.id() == i->key_id().get()) {
1668                                 LOG_GENERAL ("Using imported key for %1", i->key_id().get());
1669                                 keys[i] = j.key();
1670                                 done = true;
1671                         }
1672                 }
1673
1674                 if (!done) {
1675                         /* No imported key; it must be an asset that we encrypted */
1676                         LOG_GENERAL ("Using our own key for %1", i->key_id().get());
1677                         keys[i] = key();
1678                 }
1679         }
1680
1681         return dcp::DecryptedKDM (
1682                 cpl->id(), keys, from, until, cpl->content_title_text(), cpl->content_title_text(), dcp::LocalTime().as_string()
1683                 ).encrypt (signer, recipient, trusted_devices, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio);
1684 }
1685
1686
1687 /** @return The approximate disk space required to encode a DCP of this film with the
1688  *  current settings, in bytes.
1689  */
1690 uint64_t
1691 Film::required_disk_space () const
1692 {
1693         return _playlist->required_disk_space (shared_from_this(), j2k_bandwidth(), audio_channels(), audio_frame_rate());
1694 }
1695
1696 /** This method checks the disk that the Film is on and tries to decide whether or not
1697  *  there will be enough space to make a DCP for it.  If so, true is returned; if not,
1698  *  false is returned and required and available are filled in with the amount of disk space
1699  *  required and available respectively (in GB).
1700  *
1701  *  Note: the decision made by this method isn't, of course, 100% reliable.
1702  */
1703 bool
1704 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1705 {
1706         /* Create a test file and see if we can hard-link it */
1707         boost::filesystem::path test = internal_video_asset_dir() / "test";
1708         boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1709         can_hard_link = true;
1710         auto f = fopen_boost (test, "w");
1711         if (f) {
1712                 fclose (f);
1713                 boost::system::error_code ec;
1714                 boost::filesystem::create_hard_link (test, test2, ec);
1715                 if (ec) {
1716                         can_hard_link = false;
1717                 }
1718                 boost::filesystem::remove (test);
1719                 boost::filesystem::remove (test2);
1720         }
1721
1722         auto s = boost::filesystem::space (internal_video_asset_dir ());
1723         required = double (required_disk_space ()) / 1073741824.0f;
1724         if (!can_hard_link) {
1725                 required *= 2;
1726         }
1727         available = double (s.available) / 1073741824.0f;
1728         return (available - required) > 1;
1729 }
1730
1731 /** @return The names of the channels that audio contents' outputs are passed into;
1732  *  this is either the DCP or a AudioProcessor.
1733  */
1734 vector<NamedChannel>
1735 Film::audio_output_names () const
1736 {
1737         if (audio_processor ()) {
1738                 return audio_processor()->input_names ();
1739         }
1740
1741         DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1742
1743         vector<NamedChannel> n;
1744
1745         for (int i = 0; i < audio_channels(); ++i) {
1746                 if (i != 8 && i != 9 && i != 15) {
1747                         n.push_back (NamedChannel(short_audio_channel_name(i), i));
1748                 }
1749         }
1750
1751         return n;
1752 }
1753
1754 void
1755 Film::repeat_content (ContentList c, int n)
1756 {
1757         _playlist->repeat (shared_from_this(), c, n);
1758 }
1759
1760 void
1761 Film::remove_content (ContentList c)
1762 {
1763         _playlist->remove (c);
1764 }
1765
1766 void
1767 Film::audio_analysis_finished ()
1768 {
1769         /* XXX */
1770 }
1771
1772 list<DCPTimePeriod>
1773 Film::reels () const
1774 {
1775         list<DCPTimePeriod> p;
1776         auto const len = length();
1777
1778         switch (reel_type ()) {
1779         case ReelType::SINGLE:
1780                 p.push_back (DCPTimePeriod (DCPTime (), len));
1781                 break;
1782         case ReelType::BY_VIDEO_CONTENT:
1783         {
1784                 /* Collect all reel boundaries */
1785                 list<DCPTime> split_points;
1786                 split_points.push_back (DCPTime());
1787                 split_points.push_back (len);
1788                 for (auto c: content()) {
1789                         if (c->video) {
1790                                 for (auto t: c->reel_split_points(shared_from_this())) {
1791                                         split_points.push_back (t);
1792                                 }
1793                                 split_points.push_back (c->end(shared_from_this()));
1794                         }
1795                 }
1796
1797                 split_points.sort ();
1798                 split_points.unique ();
1799
1800                 /* Make them into periods, coalescing any that are less than 1 second long */
1801                 optional<DCPTime> last;
1802                 for (auto t: split_points) {
1803                         if (last && (t - *last) >= DCPTime::from_seconds(1)) {
1804                                 /* Period from *last to t is long enough; use it and start a new one */
1805                                 p.push_back (DCPTimePeriod(*last, t));
1806                                 last = t;
1807                         } else if (!last) {
1808                                 /* That was the first time, so start a new period */
1809                                 last = t;
1810                         }
1811                 }
1812
1813                 if (!p.empty()) {
1814                         p.back().to = split_points.back();
1815                 }
1816                 break;
1817         }
1818         case ReelType::BY_LENGTH:
1819         {
1820                 DCPTime current;
1821                 /* Integer-divide reel length by the size of one frame to give the number of frames per reel,
1822                  * making sure we don't go less than 1s long.
1823                  */
1824                 Frame const reel_in_frames = max(_reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8), static_cast<Frame>(video_frame_rate()));
1825                 while (current < len) {
1826                         DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1827                         p.push_back (DCPTimePeriod (current, end));
1828                         current = end;
1829                 }
1830                 break;
1831         }
1832         }
1833
1834         return p;
1835 }
1836
1837 /** @param period A period within the DCP
1838  *  @return Name of the content which most contributes to the given period.
1839  */
1840 string
1841 Film::content_summary (DCPTimePeriod period) const
1842 {
1843         return _playlist->content_summary (shared_from_this(), period);
1844 }
1845
1846 void
1847 Film::use_template (string name)
1848 {
1849         _template_film.reset (new Film (optional<boost::filesystem::path>()));
1850         _template_film->read_metadata (Config::instance()->template_path (name));
1851         _use_isdcf_name = _template_film->_use_isdcf_name;
1852         _dcp_content_type = _template_film->_dcp_content_type;
1853         _container = _template_film->_container;
1854         _resolution = _template_film->_resolution;
1855         _j2k_bandwidth = _template_film->_j2k_bandwidth;
1856         _video_frame_rate = _template_film->_video_frame_rate;
1857         _encrypted = _template_film->_encrypted;
1858         _audio_channels = _template_film->_audio_channels;
1859         _sequence = _template_film->_sequence;
1860         _three_d = _template_film->_three_d;
1861         _interop = _template_film->_interop;
1862         _audio_processor = _template_film->_audio_processor;
1863         _reel_type = _template_film->_reel_type;
1864         _reel_length = _template_film->_reel_length;
1865         _isdcf_metadata = _template_film->_isdcf_metadata;
1866 }
1867
1868 pair<double, double>
1869 Film::speed_up_range (int dcp_frame_rate) const
1870 {
1871         return _playlist->speed_up_range (dcp_frame_rate);
1872 }
1873
1874 void
1875 Film::copy_from (shared_ptr<const Film> film)
1876 {
1877         read_metadata (film->file (metadata_file));
1878 }
1879
1880 bool
1881 Film::references_dcp_video () const
1882 {
1883         for (auto i: _playlist->content()) {
1884                 auto d = dynamic_pointer_cast<DCPContent>(i);
1885                 if (d && d->reference_video()) {
1886                         return true;
1887                 }
1888         }
1889
1890         return false;
1891 }
1892
1893 bool
1894 Film::references_dcp_audio () const
1895 {
1896         for (auto i: _playlist->content()) {
1897                 auto d = dynamic_pointer_cast<DCPContent>(i);
1898                 if (d && d->reference_audio()) {
1899                         return true;
1900                 }
1901         }
1902
1903         return false;
1904 }
1905
1906
1907 bool
1908 Film::contains_atmos_content () const
1909 {
1910         for (auto i: _playlist->content()) {
1911                 if (i->atmos) {
1912                         return true;
1913                 }
1914         }
1915
1916         return false;
1917 }
1918
1919
1920 list<DCPTextTrack>
1921 Film::closed_caption_tracks () const
1922 {
1923         list<DCPTextTrack> tt;
1924         for (auto i: content()) {
1925                 for (auto j: i->text) {
1926                         /* XXX: Empty DCPTextTrack ends up being a magic value here - the "unknown" or "not specified" track */
1927                         auto dtt = j->dcp_track().get_value_or(DCPTextTrack());
1928                         if (j->type() == TextType::CLOSED_CAPTION && find(tt.begin(), tt.end(), dtt) == tt.end()) {
1929                                 tt.push_back (dtt);
1930                         }
1931                 }
1932         }
1933
1934         return tt;
1935 }
1936
1937 void
1938 Film::set_marker (dcp::Marker type, DCPTime time)
1939 {
1940         FilmChangeSignaller ch (this, Property::MARKERS);
1941         _markers[type] = time;
1942 }
1943
1944
1945 void
1946 Film::unset_marker (dcp::Marker type)
1947 {
1948         FilmChangeSignaller ch (this, Property::MARKERS);
1949         _markers.erase (type);
1950 }
1951
1952
1953 void
1954 Film::clear_markers ()
1955 {
1956         FilmChangeSignaller ch (this, Property::MARKERS);
1957         _markers.clear ();
1958 }
1959
1960
1961 void
1962 Film::set_ratings (vector<dcp::Rating> r)
1963 {
1964         FilmChangeSignaller ch (this, Property::RATINGS);
1965         _ratings = r;
1966 }
1967
1968 void
1969 Film::set_content_versions (vector<string> v)
1970 {
1971         FilmChangeSignaller ch (this, Property::CONTENT_VERSIONS);
1972         _content_versions = v;
1973 }
1974
1975
1976 void
1977 Film::set_name_language (dcp::LanguageTag lang)
1978 {
1979         FilmChangeSignaller ch (this, Property::NAME_LANGUAGE);
1980         _name_language = lang;
1981 }
1982
1983
1984 void
1985 Film::set_audio_language (dcp::LanguageTag lang)
1986 {
1987         FilmChangeSignaller ch (this, Property::AUDIO_LANGUAGE);
1988         _audio_language = lang;
1989 }
1990
1991
1992 void
1993 Film::set_release_territory (optional<dcp::LanguageTag::RegionSubtag> region)
1994 {
1995         FilmChangeSignaller ch (this, Property::RELEASE_TERRITORY);
1996         _release_territory = region;
1997 }
1998
1999
2000 void
2001 Film::set_status (dcp::Status s)
2002 {
2003         FilmChangeSignaller ch (this, Property::STATUS);
2004         _status = s;
2005 }
2006
2007
2008 void
2009 Film::set_version_number (int v)
2010 {
2011         FilmChangeSignaller ch (this, Property::VERSION_NUMBER);
2012         _version_number = v;
2013 }
2014
2015
2016 void
2017 Film::set_chain (optional<string> c)
2018 {
2019         FilmChangeSignaller ch (this, Property::CHAIN);
2020         _chain = c;
2021 }
2022
2023
2024 void
2025 Film::set_distributor (optional<string> d)
2026 {
2027         FilmChangeSignaller ch (this, Property::DISTRIBUTOR);
2028         _distributor = d;
2029 }
2030
2031
2032 void
2033 Film::set_luminance (optional<dcp::Luminance> l)
2034 {
2035         FilmChangeSignaller ch (this, Property::LUMINANCE);
2036         _luminance = l;
2037 }
2038
2039
2040 void
2041 Film::set_subtitle_language (dcp::LanguageTag language)
2042 {
2043         set_subtitle_languages ({language});
2044 }
2045
2046
2047 void
2048 Film::unset_subtitle_language ()
2049 {
2050         FilmChangeSignaller ch (this, Property::SUBTITLE_LANGUAGES);
2051         _subtitle_languages.clear();
2052 }
2053
2054
2055 void
2056 Film::set_subtitle_languages (vector<dcp::LanguageTag> languages)
2057 {
2058         FilmChangeSignaller ch (this, Property::SUBTITLE_LANGUAGES);
2059         _subtitle_languages = languages;
2060 }
2061
2062
2063 void
2064 Film::set_facility (optional<string> f)
2065 {
2066         FilmChangeSignaller ch (this, Property::FACILITY);
2067         _facility = f;
2068 }
2069
2070
2071 optional<DCPTime>
2072 Film::marker (dcp::Marker type) const
2073 {
2074         auto i = _markers.find (type);
2075         if (i == _markers.end()) {
2076                 return {};
2077         }
2078         return i->second;
2079 }
2080
2081 shared_ptr<InfoFileHandle>
2082 Film::info_file_handle (DCPTimePeriod period, bool read) const
2083 {
2084         return std::make_shared<InfoFileHandle>(_info_file_mutex, info_file(period), read);
2085 }
2086
2087 InfoFileHandle::InfoFileHandle (boost::mutex& mutex, boost::filesystem::path file, bool read)
2088         : _lock (mutex)
2089         , _file (file)
2090 {
2091         if (read) {
2092                 _handle = fopen_boost (file, "rb");
2093                 if (!_handle) {
2094                         throw OpenFileError (file, errno, OpenFileError::READ);
2095                 }
2096         } else {
2097                 auto const exists = boost::filesystem::exists (file);
2098                 if (exists) {
2099                         _handle = fopen_boost (file, "r+b");
2100                 } else {
2101                         _handle = fopen_boost (file, "wb");
2102                 }
2103
2104                 if (!_handle) {
2105                         throw OpenFileError (file, errno, exists ? OpenFileError::READ_WRITE : OpenFileError::WRITE);
2106                 }
2107         }
2108 }
2109
2110 InfoFileHandle::~InfoFileHandle ()
2111 {
2112         fclose (_handle);
2113 }
2114
2115
2116 /** Add FFOC and LFOC markers to a list if they are not already there */
2117 void
2118 Film::add_ffoc_lfoc (Markers& markers) const
2119 {
2120         if (markers.find(dcp::Marker::FFOC) == markers.end()) {
2121                 markers[dcp::Marker::FFOC] = dcpomatic::DCPTime::from_frames(1, video_frame_rate());
2122         }
2123
2124         if (markers.find(dcp::Marker::LFOC) == markers.end()) {
2125                 markers[dcp::Marker::LFOC] = length() - DCPTime::from_frames(1, video_frame_rate());
2126         }
2127 }