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