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