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                         _luminance = dcp::Luminance(*mastered_luminance, dcp::Luminance::Unit::FOOT_LAMBERT);
 757                 }
 758                 _studio = isdcf->optional_string_child("Studio");
 759                 _facility = isdcf->optional_string_child("Facility");
 760                 _temp_version = isdcf->optional_bool_child("TempVersion").get_value_or("false");
 761                 _pre_release = isdcf->optional_bool_child("PreRelease").get_value_or("false");
 762                 _red_band = isdcf->optional_bool_child("RedBand").get_value_or("false");
 763                 _two_d_version_of_three_d = isdcf->optional_bool_child("TwoDVersionOfThreeD").get_value_or("false");
 764                 _chain = isdcf->optional_string_child("Chain");
 765         }
 766
 767         list<string> notes;
 768         _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
 769
 770         /* Write backtraces to this film's directory, until another film is loaded */
 771         if (_directory) {
 772                 set_backtrace_file (file ("backtrace.txt"));
 773         }
 774
 775         _dirty = false;
 776         return notes;
 777 }
 778
 779 /** Given a directory name, return its full path within the Film's directory.
 780  *  @param d directory name within the Film's directory.
 781  *  @param create true to create the directory (and its parents) if they do not exist.
 782  */
 783 boost::filesystem::path
 784 Film::dir (boost::filesystem::path d, bool create) const
 785 {
 786         DCPOMATIC_ASSERT (_directory);
 787
 788         boost::filesystem::path p;
 789         p /= _directory.get();
 790         p /= d;
 791
 792         if (create) {
 793                 boost::filesystem::create_directories (p);
 794         }
 795
 796         return p;
 797 }
 798
 799 /** Given a file or directory name, return its full path within the Film's directory.
 800  *  Any required parent directories will be created.
 801  */
 802 boost::filesystem::path
 803 Film::file (boost::filesystem::path f) const
 804 {
 805         DCPOMATIC_ASSERT (_directory);
 806
 807         boost::filesystem::path p;
 808         p /= _directory.get();
 809         p /= f;
 810
 811         boost::filesystem::create_directories (p.parent_path ());
 812
 813         return p;
 814 }
 815
 816 list<int>
 817 Film::mapped_audio_channels () const
 818 {
 819         list<int> mapped;
 820
 821         if (audio_processor ()) {
 822                 /* Processors are mapped 1:1 to DCP outputs so we can work out mappings from there */
 823                 for (int i = 0; i < audio_processor()->out_channels(); ++i) {
 824                         mapped.push_back (i);
 825                 }
 826         } else {
 827                 for (auto i: content()) {
 828                         if (i->audio) {
 829                                 auto c = i->audio->mapping().mapped_output_channels();
 830                                 copy (c.begin(), c.end(), back_inserter(mapped));
 831                         }
 832                 }
 833
 834                 mapped.sort ();
 835                 mapped.unique ();
 836         }
 837
 838         return mapped;
 839 }
 840
 841
 842 pair<optional<dcp::LanguageTag>, vector<dcp::LanguageTag>>
 843 Film::subtitle_languages () const
 844 {
 845         pair<optional<dcp::LanguageTag>, vector<dcp::LanguageTag>> result;
 846         for (auto i: content()) {
 847                 for (auto j: i->text) {
 848                         if (j->use() && j->type() == TextType::OPEN_SUBTITLE && j->language()) {
 849                                 if (j->language_is_additional()) {
 850                                         result.second.push_back (j->language().get());
 851                                 } else {
 852                                         result.first = j->language().get();
 853                                 }
 854                         }
 855                 }
 856                 if (i->video && i->video->burnt_subtitle_language()) {
 857                         result.first = i->video->burnt_subtitle_language();
 858                 }
 859         }
 860
 861         std::sort (result.second.begin(), result.second.end());
 862         auto last = std::unique (result.second.begin(), result.second.end());
 863         result.second.erase (last, result.second.end());
 864         return result;
 865 }
 866
 867
 868 /** @return a ISDCF-compliant name for a DCP of this film */
 869 string
 870 Film::isdcf_name (bool if_created_now) const
 871 {
 872         string d;
 873
 874         auto raw_name = name ();
 875
 876         /* Split the raw name up into words */
 877         vector<string> words;
 878         split (words, raw_name, is_any_of (" _-"));
 879
 880         string fixed_name;
 881
 882         /* Add each word to fixed_name */
 883         for (auto i: words) {
 884                 string w = i;
 885
 886                 /* First letter is always capitalised */
 887                 w[0] = toupper (w[0]);
 888
 889                 /* Count caps in w */
 890                 size_t caps = 0;
 891                 for (size_t j = 0; j < w.size(); ++j) {
 892                         if (isupper (w[j])) {
 893                                 ++caps;
 894                         }
 895                 }
 896
 897                 /* If w is all caps make the rest of it lower case, otherwise
 898                    leave it alone.
 899                 */
 900                 if (caps == w.size ()) {
 901                         for (size_t j = 1; j < w.size(); ++j) {
 902                                 w[j] = tolower (w[j]);
 903                         }
 904                 }
 905
 906                 for (size_t j = 0; j < w.size(); ++j) {
 907                         fixed_name += w[j];
 908                 }
 909         }
 910
 911         if (fixed_name.length() > 14) {
 912                 fixed_name = fixed_name.substr (0, 14);
 913         }
 914
 915         d += fixed_name;
 916
 917         if (dcp_content_type()) {
 918                 d += "_" + dcp_content_type()->isdcf_name();
 919                 string version = "1";
 920                 if (_interop) {
 921                         if (!_content_versions.empty()) {
 922                                 auto cv = _content_versions[0];
 923                                 if (!cv.empty() && std::all_of(cv.begin(), cv.end(), isdigit)) {
 924                                         version = cv;
 925                                 }
 926                         }
 927                 } else {
 928                         version = dcp::raw_convert<string>(_version_number);
 929                 }
 930                 d += "-" + version;
 931         }
 932
 933         if (_temp_version) {
 934                 d += "-Temp";
 935         }
 936
 937         if (_pre_release) {
 938                 d += "-Pre";
 939         }
 940
 941         if (_red_band) {
 942                 d += "-RedBand";
 943         }
 944
 945         if (_chain && !_chain->empty()) {
 946                 d += "-" + *_chain;
 947         }
 948
 949         if (three_d ()) {
 950                 d += "-3D";
 951         }
 952
 953         if (_two_d_version_of_three_d) {
 954                 d += "-2D";
 955         }
 956
 957         if (_luminance) {
 958                 auto fl = _luminance->value_in_foot_lamberts();
 959                 char buffer[64];
 960                 snprintf (buffer, sizeof(buffer), "%.1f", fl);
 961                 d += String::compose("-%1fl", buffer);
 962         }
 963
 964         if (video_frame_rate() != 24) {
 965                 d += "-" + raw_convert<string>(video_frame_rate());
 966         }
 967
 968         if (container()) {
 969                 d += "_" + container()->isdcf_name();
 970         }
 971
 972         /* XXX: this uses the first bit of content only */
 973
 974         /* Interior aspect ratio.  The standard says we don't do this for trailers, for some strange reason */
 975         if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::ContentKind::TRAILER) {
 976                 auto cl = content();
 977                 auto first_video = std::find_if(cl.begin(), cl.end(), [](shared_ptr<Content> c) { return static_cast<bool>(c->video); });
 978                 if (first_video != cl.end()) {
 979                         auto first_ratio = lrintf((*first_video)->video->scaled_size(frame_size()).ratio() * 100);
 980                         auto container_ratio = lrintf(container()->ratio() * 100);
 981                         if (first_ratio != container_ratio) {
 982                                 d += "-" + dcp::raw_convert<string>(first_ratio);
 983                         }
 984                 }
 985         }
 986
 987         auto audio_language = (_audio_language && _audio_language->language()) ? _audio_language->language()->subtag() : "XX";
 988
 989         d += "_" + to_upper (audio_language);
 990
 991         /* I'm not clear on the precise details of the convention for CCAP labelling;
 992            for now I'm just appending -CCAP if we have any closed captions.
 993         */
 994
 995         auto burnt_in = true;
 996         auto ccap = false;
 997         for (auto i: content()) {
 998                 for (auto j: i->text) {
 999                         if (j->type() == TextType::OPEN_SUBTITLE && j->use() && !j->burn()) {
1000                                 burnt_in = false;
1001                         } else if (j->type() == TextType::CLOSED_CAPTION && j->use()) {
1002                                 ccap = true;
1003                         }
1004                 }
1005         }
1006
1007         auto sub_langs = subtitle_languages();
1008         if (sub_langs.first && sub_langs.first->language()) {
1009                 auto lang = sub_langs.first->language()->subtag();
1010                 if (burnt_in) {
1011                         transform (lang.begin(), lang.end(), lang.begin(), ::tolower);
1012                 } else {
1013                         lang = to_upper (lang);
1014                 }
1015
1016                 d += "-" + lang;
1017                 if (ccap) {
1018                         d += "-CCAP";
1019                 }
1020         } else {
1021                 /* No subtitles */
1022                 d += "-XX";
1023         }
1024
1025         if (_release_territory) {
1026                 auto territory = _release_territory->subtag();
1027                 d += "_" + to_upper (territory);
1028                 if (_ratings.empty ()) {
1029                         d += "-NR";
1030                 } else {
1031                         d += "-" + _ratings[0].label;
1032                 }
1033         }
1034
1035         /* Count mapped audio channels */
1036
1037         auto mapped = mapped_audio_channels ();
1038
1039         auto ch = audio_channel_types (mapped, audio_channels());
1040         if (!ch.first && !ch.second) {
1041                 d += "_MOS";
1042         } else if (ch.first) {
1043                 d += String::compose("_%1%2", ch.first, ch.second);
1044         }
1045
1046         if (audio_channels() > static_cast<int>(dcp::Channel::HI) && find(mapped.begin(), mapped.end(), static_cast<int>(dcp::Channel::HI)) != mapped.end()) {
1047                 d += "-HI";
1048         }
1049         if (audio_channels() > static_cast<int>(dcp::Channel::VI) && find(mapped.begin(), mapped.end(), static_cast<int>(dcp::Channel::VI)) != mapped.end()) {
1050                 d += "-VI";
1051         }
1052
1053         d += "_" + resolution_to_string (_resolution);
1054
1055         if (_studio && _studio->length() >= 2) {
1056                 d += "_" + to_upper (_studio->substr(0, 4));
1057         }
1058
1059         if (if_created_now) {
1060                 d += "_" + boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
1061         } else {
1062                 d += "_" + boost::gregorian::to_iso_string (_isdcf_date);
1063         }
1064
1065         if (_facility && _facility->length() >= 3) {
1066                 d += "_" + to_upper(_facility->substr(0, 3));
1067         }
1068
1069         if (_interop) {
1070                 d += "_IOP";
1071         } else {
1072                 d += "_SMPTE";
1073         }
1074
1075         if (three_d ()) {
1076                 d += "-3D";
1077         }
1078
1079         auto vf = false;
1080         for (auto i: content()) {
1081                 auto dc = dynamic_pointer_cast<const DCPContent>(i);
1082                 if (!dc) {
1083                         continue;
1084                 }
1085
1086                 bool any_text = false;
1087                 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
1088                         if (dc->reference_text(static_cast<TextType>(i))) {
1089                                 any_text = true;
1090                         }
1091                 }
1092                 if (dc->reference_video() || dc->reference_audio() || any_text) {
1093                         vf = true;
1094                 }
1095         }
1096
1097         if (vf) {
1098                 d += "_VF";
1099         } else {
1100                 d += "_OV";
1101         }
1102
1103         return d;
1104 }
1105
1106 /** @return name to give the DCP */
1107 string
1108 Film::dcp_name (bool if_created_now) const
1109 {
1110         string unfiltered;
1111         if (use_isdcf_name()) {
1112                 return careful_string_filter (isdcf_name (if_created_now));
1113         }
1114
1115         return careful_string_filter (name ());
1116 }
1117
1118 void
1119 Film::set_directory (boost::filesystem::path d)
1120 {
1121         _directory = d;
1122         _dirty = true;
1123 }
1124
1125 void
1126 Film::set_name (string n)
1127 {
1128         FilmChangeSignaller ch (this, Property::NAME);
1129         _name = n;
1130 }
1131
1132 void
1133 Film::set_use_isdcf_name (bool u)
1134 {
1135         FilmChangeSignaller ch (this, Property::USE_ISDCF_NAME);
1136         _use_isdcf_name = u;
1137 }
1138
1139 void
1140 Film::set_dcp_content_type (DCPContentType const * t)
1141 {
1142         FilmChangeSignaller ch (this, Property::DCP_CONTENT_TYPE);
1143         _dcp_content_type = t;
1144 }
1145
1146
1147 /** @param explicit_user true if this is being set because of
1148  *  a direct user request, false if it is being done because
1149  *  DCP-o-matic is guessing the best container to use.
1150  */
1151 void
1152 Film::set_container (Ratio const * c, bool explicit_user)
1153 {
1154         FilmChangeSignaller ch (this, Property::CONTAINER);
1155         _container = c;
1156
1157         if (explicit_user) {
1158                 _user_explicit_container = true;
1159         }
1160 }
1161
1162
1163 /** @param explicit_user true if this is being set because of
1164  *  a direct user request, false if it is being done because
1165  *  DCP-o-matic is guessing the best resolution to use.
1166  */
1167 void
1168 Film::set_resolution (Resolution r, bool explicit_user)
1169 {
1170         FilmChangeSignaller ch (this, Property::RESOLUTION);
1171         _resolution = r;
1172
1173         if (explicit_user) {
1174                 _user_explicit_resolution = true;
1175         }
1176 }
1177
1178
1179 void
1180 Film::set_j2k_bandwidth (int b)
1181 {
1182         FilmChangeSignaller ch (this, Property::J2K_BANDWIDTH);
1183         _j2k_bandwidth = b;
1184 }
1185
1186 /** @param f New frame rate.
1187  *  @param user_explicit true if this comes from a direct user instruction, false if it is from
1188  *  DCP-o-matic being helpful.
1189  */
1190 void
1191 Film::set_video_frame_rate (int f, bool user_explicit)
1192 {
1193         FilmChangeSignaller ch (this, Property::VIDEO_FRAME_RATE);
1194         _video_frame_rate = f;
1195         if (user_explicit) {
1196                 _user_explicit_video_frame_rate = true;
1197         }
1198 }
1199
1200 void
1201 Film::set_audio_channels (int c)
1202 {
1203         FilmChangeSignaller ch (this, Property::AUDIO_CHANNELS);
1204         _audio_channels = c;
1205 }
1206
1207 void
1208 Film::set_three_d (bool t)
1209 {
1210         FilmChangeSignaller ch (this, Property::THREE_D);
1211         _three_d = t;
1212
1213         if (_three_d && _two_d_version_of_three_d) {
1214                 set_two_d_version_of_three_d (false);
1215         }
1216 }
1217
1218 void
1219 Film::set_interop (bool i)
1220 {
1221         FilmChangeSignaller ch (this, Property::INTEROP);
1222         _interop = i;
1223 }
1224
1225 void
1226 Film::set_audio_processor (AudioProcessor const * processor)
1227 {
1228         FilmChangeSignaller ch1 (this, Property::AUDIO_PROCESSOR);
1229         FilmChangeSignaller ch2 (this, Property::AUDIO_CHANNELS);
1230         _audio_processor = processor;
1231 }
1232
1233 void
1234 Film::set_reel_type (ReelType t)
1235 {
1236         FilmChangeSignaller ch (this, Property::REEL_TYPE);
1237         _reel_type = t;
1238 }
1239
1240 /** @param r Desired reel length in bytes */
1241 void
1242 Film::set_reel_length (int64_t r)
1243 {
1244         FilmChangeSignaller ch (this, Property::REEL_LENGTH);
1245         _reel_length = r;
1246 }
1247
1248 void
1249 Film::set_reencode_j2k (bool r)
1250 {
1251         FilmChangeSignaller ch (this, Property::REENCODE_J2K);
1252         _reencode_j2k = r;
1253 }
1254
1255 void
1256 Film::signal_change (ChangeType type, int p)
1257 {
1258         signal_change (type, static_cast<Property>(p));
1259 }
1260
1261 void
1262 Film::signal_change (ChangeType type, Property p)
1263 {
1264         if (type == ChangeType::DONE) {
1265                 _dirty = true;
1266
1267                 if (p == Property::CONTENT) {
1268                         if (!_user_explicit_video_frame_rate) {
1269                                 set_video_frame_rate (best_video_frame_rate());
1270                         }
1271                 }
1272
1273                 emit (boost::bind (boost::ref (Change), type, p));
1274
1275                 if (p == Property::VIDEO_FRAME_RATE || p == Property::SEQUENCE) {
1276                         /* We want to call Playlist::maybe_sequence but this must happen after the
1277                            main signal emission (since the butler will see that emission and un-suspend itself).
1278                         */
1279                         emit (boost::bind(&Playlist::maybe_sequence, _playlist.get(), shared_from_this()));
1280                 }
1281         } else {
1282                 Change (type, p);
1283         }
1284 }
1285
1286 void
1287 Film::set_isdcf_date_today ()
1288 {
1289         _isdcf_date = boost::gregorian::day_clock::local_day ();
1290 }
1291
1292 boost::filesystem::path
1293 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
1294 {
1295         boost::filesystem::path p;
1296         p /= "j2c";
1297         p /= video_identifier ();
1298
1299         char buffer[256];
1300         snprintf(buffer, sizeof(buffer), "%08d_%08" PRId64, reel, frame);
1301         string s (buffer);
1302
1303         if (eyes == Eyes::LEFT) {
1304                 s += ".L";
1305         } else if (eyes == Eyes::RIGHT) {
1306                 s += ".R";
1307         }
1308
1309         s += ".j2c";
1310
1311         if (tmp) {
1312                 s += ".tmp";
1313         }
1314
1315         p /= s;
1316         return file (p);
1317 }
1318
1319 static
1320 bool
1321 cpl_summary_compare (CPLSummary const & a, CPLSummary const & b)
1322 {
1323         return a.last_write_time > b.last_write_time;
1324 }
1325
1326 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs.
1327  *  The list will be returned in reverse order of timestamp (i.e. most recent first).
1328  */
1329 vector<CPLSummary>
1330 Film::cpls () const
1331 {
1332         if (!directory ()) {
1333                 return vector<CPLSummary> ();
1334         }
1335
1336         vector<CPLSummary> out;
1337
1338         auto const dir = directory().get();
1339         for (auto i: boost::filesystem::directory_iterator(dir)) {
1340                 if (
1341                         boost::filesystem::is_directory (i) &&
1342                         i.path().leaf() != "j2c" && i.path().leaf() != "video" && i.path().leaf() != "info" && i.path().leaf() != "analysis"
1343                         ) {
1344
1345                         try {
1346                                 out.push_back (CPLSummary(i));
1347                         } catch (...) {
1348
1349                         }
1350                 }
1351         }
1352
1353         sort (out.begin(), out.end(), cpl_summary_compare);
1354
1355         return out;
1356 }
1357
1358 void
1359 Film::set_encrypted (bool e)
1360 {
1361         FilmChangeSignaller ch (this, Property::ENCRYPTED);
1362         _encrypted = e;
1363 }
1364
1365 ContentList
1366 Film::content () const
1367 {
1368         return _playlist->content ();
1369 }
1370
1371 /** @param content Content to add.
1372  *  @param disable_audio_analysis true to never do automatic audio analysis, even if it is enabled in configuration.
1373  */
1374 void
1375 Film::examine_and_add_content (shared_ptr<Content> content, bool disable_audio_analysis)
1376 {
1377         if (dynamic_pointer_cast<FFmpegContent> (content) && _directory) {
1378                 run_ffprobe (content->path(0), file("ffprobe.log"));
1379         }
1380
1381         auto j = make_shared<ExamineContentJob>(shared_from_this(), content);
1382
1383         _job_connections.push_back (
1384                 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job>(j), weak_ptr<Content>(content), disable_audio_analysis))
1385                 );
1386
1387         JobManager::instance()->add (j);
1388 }
1389
1390 void
1391 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c, bool disable_audio_analysis)
1392 {
1393         auto job = j.lock ();
1394         if (!job || !job->finished_ok ()) {
1395                 return;
1396         }
1397
1398         auto content = c.lock ();
1399         if (!content) {
1400                 return;
1401         }
1402
1403         add_content (content);
1404
1405         if (Config::instance()->automatic_audio_analysis() && content->audio && !disable_audio_analysis) {
1406                 auto playlist = make_shared<Playlist>();
1407                 playlist->add (shared_from_this(), content);
1408                 boost::signals2::connection c;
1409                 JobManager::instance()->analyse_audio (
1410                         shared_from_this(), playlist, false, c, bind (&Film::audio_analysis_finished, this)
1411                         );
1412                 _audio_analysis_connections.push_back (c);
1413         }
1414 }
1415
1416 void
1417 Film::add_content (shared_ptr<Content> c)
1418 {
1419         /* Add {video,subtitle} content after any existing {video,subtitle} content */
1420         if (c->video) {
1421                 c->set_position (shared_from_this(), _playlist->video_end(shared_from_this()));
1422         } else if (!c->text.empty()) {
1423                 c->set_position (shared_from_this(), _playlist->text_end(shared_from_this()));
1424         }
1425
1426         if (_template_film) {
1427                 /* Take settings from the first piece of content of c's type in _template */
1428                 for (auto i: _template_film->content()) {
1429                         c->take_settings_from (i);
1430                 }
1431         }
1432
1433         _playlist->add (shared_from_this(), c);
1434
1435         maybe_set_container_and_resolution ();
1436         if (c->atmos) {
1437                 set_audio_channels (14);
1438                 set_interop (false);
1439         }
1440 }
1441
1442
1443 void
1444 Film::maybe_set_container_and_resolution ()
1445 {
1446         /* Get the only piece of video content, if there is only one */
1447         shared_ptr<VideoContent> video;
1448         for (auto i: _playlist->content()) {
1449                 if (i->video) {
1450                         if (!video) {
1451                                 video = i->video;
1452                         } else {
1453                                 video.reset ();
1454                         }
1455                 }
1456         }
1457
1458         if (video) {
1459                 /* This is the only piece of video content in this Film.  Use it to make a guess for
1460                  * DCP container size and resolution, unless the user has already explicitly set these
1461                  * things.
1462                  */
1463                 if (!_user_explicit_container) {
1464                         if (video->size().ratio() > 2.3) {
1465                                 set_container (Ratio::from_id("239"), false);
1466                         } else {
1467                                 set_container (Ratio::from_id("185"), false);
1468                         }
1469                 }
1470
1471                 if (!_user_explicit_resolution) {
1472                         if (video->size_after_crop().width > 2048 || video->size_after_crop().height > 1080) {
1473                                 set_resolution (Resolution::FOUR_K, false);
1474                         } else {
1475                                 set_resolution (Resolution::TWO_K, false);
1476                         }
1477                 }
1478         }
1479 }
1480
1481 void
1482 Film::remove_content (shared_ptr<Content> c)
1483 {
1484         _playlist->remove (c);
1485         maybe_set_container_and_resolution ();
1486 }
1487
1488 void
1489 Film::move_content_earlier (shared_ptr<Content> c)
1490 {
1491         _playlist->move_earlier (shared_from_this(), c);
1492 }
1493
1494 void
1495 Film::move_content_later (shared_ptr<Content> c)
1496 {
1497         _playlist->move_later (shared_from_this(), c);
1498 }
1499
1500 /** @return length of the film from time 0 to the last thing on the playlist,
1501  *  with a minimum length of 1 second.
1502  */
1503 DCPTime
1504 Film::length () const
1505 {
1506         return max(DCPTime::from_seconds(1), _playlist->length(shared_from_this()).ceil(video_frame_rate()));
1507 }
1508
1509 int
1510 Film::best_video_frame_rate () const
1511 {
1512         /* Don't default to anything above 30fps (make the user select that explicitly) */
1513         auto best = _playlist->best_video_frame_rate ();
1514         if (best > 30) {
1515                 best /= 2;
1516         }
1517         return best;
1518 }
1519
1520 FrameRateChange
1521 Film::active_frame_rate_change (DCPTime t) const
1522 {
1523         return _playlist->active_frame_rate_change (t, video_frame_rate ());
1524 }
1525
1526 void
1527 Film::playlist_content_change (ChangeType type, weak_ptr<Content> c, int p, bool frequent)
1528 {
1529         if (p == ContentProperty::VIDEO_FRAME_RATE) {
1530                 signal_change (type, Property::CONTENT);
1531         } else if (p == AudioContentProperty::STREAMS) {
1532                 signal_change (type, Property::NAME);
1533         }
1534
1535         if (type == ChangeType::DONE) {
1536                 emit (boost::bind (boost::ref (ContentChange), type, c, p, frequent));
1537                 if (!frequent) {
1538                         check_settings_consistency ();
1539                 }
1540         } else {
1541                 ContentChange (type, c, p, frequent);
1542         }
1543
1544         _dirty = true;
1545 }
1546
1547 void
1548 Film::playlist_length_change ()
1549 {
1550         LengthChange ();
1551 }
1552
1553 void
1554 Film::playlist_change (ChangeType type)
1555 {
1556         signal_change (type, Property::CONTENT);
1557         signal_change (type, Property::NAME);
1558
1559         if (type == ChangeType::DONE) {
1560                 check_settings_consistency ();
1561         }
1562
1563         _dirty = true;
1564 }
1565
1566 /** Check for (and if necessary fix) impossible settings combinations, like
1567  *  video set to being referenced when it can't be.
1568  */
1569 void
1570 Film::check_settings_consistency ()
1571 {
1572         optional<int> atmos_rate;
1573         for (auto i: content()) {
1574
1575                 if (i->atmos) {
1576                         int rate = lrintf (i->atmos->edit_rate().as_float());
1577                         if (atmos_rate && *atmos_rate != rate) {
1578                                 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."));
1579                         } else if (!atmos_rate && rate != video_frame_rate()) {
1580                                 atmos_rate = rate;
1581                                 set_video_frame_rate (rate, false);
1582                                 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."));
1583                         }
1584                 }
1585         }
1586
1587         bool change_made = false;
1588         for (auto i: content()) {
1589                 auto d = dynamic_pointer_cast<DCPContent>(i);
1590                 if (!d) {
1591                         continue;
1592                 }
1593
1594                 string why_not;
1595                 if (d->reference_video() && !d->can_reference_video(shared_from_this(), why_not)) {
1596                         d->set_reference_video(false);
1597                         change_made = true;
1598                 }
1599                 if (d->reference_audio() && !d->can_reference_audio(shared_from_this(), why_not)) {
1600                         d->set_reference_audio(false);
1601                         change_made = true;
1602                 }
1603                 if (d->reference_text(TextType::OPEN_SUBTITLE) && !d->can_reference_text(shared_from_this(), TextType::OPEN_SUBTITLE, why_not)) {
1604                         d->set_reference_text(TextType::OPEN_SUBTITLE, false);
1605                         change_made = true;
1606                 }
1607                 if (d->reference_text(TextType::CLOSED_CAPTION) && !d->can_reference_text(shared_from_this(), TextType::CLOSED_CAPTION, why_not)) {
1608                         d->set_reference_text(TextType::CLOSED_CAPTION, false);
1609                         change_made = true;
1610                 }
1611         }
1612
1613         if (change_made) {
1614                 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."));
1615         }
1616 }
1617
1618 void
1619 Film::playlist_order_changed ()
1620 {
1621         /* XXX: missing PENDING */
1622         signal_change (ChangeType::DONE, Property::CONTENT_ORDER);
1623 }
1624
1625 int
1626 Film::audio_frame_rate () const
1627 {
1628         /* It seems that nobody makes 96kHz DCPs at the moment, so let's avoid them.
1629            See #1436.
1630         */
1631         return 48000;
1632 }
1633
1634 void
1635 Film::set_sequence (bool s)
1636 {
1637         if (s == _sequence) {
1638                 return;
1639         }
1640
1641         FilmChangeSignaller cc (this, Property::SEQUENCE);
1642         _sequence = s;
1643         _playlist->set_sequence (s);
1644 }
1645
1646 /** @return Size of the largest possible image in whatever resolution we are using */
1647 dcp::Size
1648 Film::full_frame () const
1649 {
1650         switch (_resolution) {
1651         case Resolution::TWO_K:
1652                 return dcp::Size (2048, 1080);
1653         case Resolution::FOUR_K:
1654                 return dcp::Size (4096, 2160);
1655         }
1656
1657         DCPOMATIC_ASSERT (false);
1658         return dcp::Size ();
1659 }
1660
1661 /** @return Size of the frame */
1662 dcp::Size
1663 Film::frame_size () const
1664 {
1665         return fit_ratio_within (container()->ratio(), full_frame ());
1666 }
1667
1668
1669 /** @return Area of Film::frame_size() that contains picture rather than pillar/letterboxing */
1670 dcp::Size
1671 Film::active_area () const
1672 {
1673         auto const frame = frame_size ();
1674         dcp::Size active;
1675
1676         for (auto i: content()) {
1677                 if (i->video) {
1678                         dcp::Size s = i->video->scaled_size (frame);
1679                         active.width = max(active.width, s.width);
1680                         active.height = max(active.height, s.height);
1681                 }
1682         }
1683
1684         return active;
1685 }
1686
1687
1688 /** @param recipient KDM recipient certificate.
1689  *  @param trusted_devices Certificate thumbprints of other trusted devices (can be empty).
1690  *  @param cpl_file CPL filename.
1691  *  @param from KDM from time expressed as a local time with an offset from UTC.
1692  *  @param until KDM to time expressed as a local time with an offset from UTC.
1693  *  @param formulation KDM formulation to use.
1694  *  @param disable_forensic_marking_picture true to disable forensic marking of picture.
1695  *  @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio.  If set to 0,
1696  *  disable all forensic marking; if set above 0, disable forensic marking above that channel.
1697  */
1698 dcp::EncryptedKDM
1699 Film::make_kdm (
1700         dcp::Certificate recipient,
1701         vector<string> trusted_devices,
1702         boost::filesystem::path cpl_file,
1703         dcp::LocalTime from,
1704         dcp::LocalTime until,
1705         dcp::Formulation formulation,
1706         bool disable_forensic_marking_picture,
1707         optional<int> disable_forensic_marking_audio
1708         ) const
1709 {
1710         if (!_encrypted) {
1711                 throw runtime_error (_("Cannot make a KDM as this project is not encrypted."));
1712         }
1713
1714         auto cpl = make_shared<dcp::CPL>(cpl_file);
1715         auto signer = Config::instance()->signer_chain();
1716         if (!signer->valid ()) {
1717                 throw InvalidSignerError ();
1718         }
1719
1720         /* Find keys that have been added to imported, encrypted DCP content */
1721         list<dcp::DecryptedKDMKey> imported_keys;
1722         for (auto i: content()) {
1723                 auto d = dynamic_pointer_cast<DCPContent> (i);
1724                 if (d && d->kdm()) {
1725                         dcp::DecryptedKDM kdm (d->kdm().get(), Config::instance()->decryption_chain()->key().get());
1726                         auto keys = kdm.keys ();
1727                         copy (keys.begin(), keys.end(), back_inserter (imported_keys));
1728                 }
1729         }
1730
1731         map<shared_ptr<const dcp::ReelFileAsset>, dcp::Key> keys;
1732
1733         for (auto i: cpl->reel_file_assets()) {
1734                 if (!i->encrypted()) {
1735                         continue;
1736                 }
1737
1738                 /* Get any imported key for this ID */
1739                 bool done = false;
1740                 for (auto j: imported_keys) {
1741                         if (j.id() == i->key_id().get()) {
1742                                 LOG_GENERAL ("Using imported key for %1", i->key_id().get());
1743                                 keys[i] = j.key();
1744                                 done = true;
1745                         }
1746                 }
1747
1748                 if (!done) {
1749                         /* No imported key; it must be an asset that we encrypted */
1750                         LOG_GENERAL ("Using our own key for %1", i->key_id().get());
1751                         keys[i] = key();
1752                 }
1753         }
1754
1755         return dcp::DecryptedKDM (
1756                 cpl->id(), keys, from, until, cpl->content_title_text(), cpl->content_title_text(), dcp::LocalTime().as_string()
1757                 ).encrypt (signer, recipient, trusted_devices, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio);
1758 }
1759
1760
1761 /** @return The approximate disk space required to encode a DCP of this film with the
1762  *  current settings, in bytes.
1763  */
1764 uint64_t
1765 Film::required_disk_space () const
1766 {
1767         return _playlist->required_disk_space (shared_from_this(), j2k_bandwidth(), audio_channels(), audio_frame_rate());
1768 }
1769
1770 /** This method checks the disk that the Film is on and tries to decide whether or not
1771  *  there will be enough space to make a DCP for it.  If so, true is returned; if not,
1772  *  false is returned and required and available are filled in with the amount of disk space
1773  *  required and available respectively (in GB).
1774  *
1775  *  Note: the decision made by this method isn't, of course, 100% reliable.
1776  */
1777 bool
1778 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1779 {
1780         /* Create a test file and see if we can hard-link it */
1781         boost::filesystem::path test = internal_video_asset_dir() / "test";
1782         boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1783         can_hard_link = true;
1784         auto f = fopen_boost (test, "w");
1785         if (f) {
1786                 fclose (f);
1787                 boost::system::error_code ec;
1788                 boost::filesystem::create_hard_link (test, test2, ec);
1789                 if (ec) {
1790                         can_hard_link = false;
1791                 }
1792                 boost::filesystem::remove (test);
1793                 boost::filesystem::remove (test2);
1794         }
1795
1796         auto s = boost::filesystem::space (internal_video_asset_dir ());
1797         required = double (required_disk_space ()) / 1073741824.0f;
1798         if (!can_hard_link) {
1799                 required *= 2;
1800         }
1801         available = double (s.available) / 1073741824.0f;
1802         return (available - required) > 1;
1803 }
1804
1805 /** @return The names of the channels that audio contents' outputs are passed into;
1806  *  this is either the DCP or a AudioProcessor.
1807  */
1808 vector<NamedChannel>
1809 Film::audio_output_names () const
1810 {
1811         if (audio_processor ()) {
1812                 return audio_processor()->input_names ();
1813         }
1814
1815         DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1816
1817         vector<NamedChannel> n;
1818
1819         for (int i = 0; i < audio_channels(); ++i) {
1820                 if (i != 8 && i != 9 && i != 15) {
1821                         n.push_back (NamedChannel(short_audio_channel_name(i), i));
1822                 }
1823         }
1824
1825         return n;
1826 }
1827
1828 void
1829 Film::repeat_content (ContentList c, int n)
1830 {
1831         _playlist->repeat (shared_from_this(), c, n);
1832 }
1833
1834 void
1835 Film::remove_content (ContentList c)
1836 {
1837         _playlist->remove (c);
1838 }
1839
1840 void
1841 Film::audio_analysis_finished ()
1842 {
1843         /* XXX */
1844 }
1845
1846 list<DCPTimePeriod>
1847 Film::reels () const
1848 {
1849         list<DCPTimePeriod> p;
1850         auto const len = length();
1851
1852         switch (reel_type ()) {
1853         case ReelType::SINGLE:
1854                 p.push_back (DCPTimePeriod (DCPTime (), len));
1855                 break;
1856         case ReelType::BY_VIDEO_CONTENT:
1857         {
1858                 /* Collect all reel boundaries */
1859                 list<DCPTime> split_points;
1860                 split_points.push_back (DCPTime());
1861                 split_points.push_back (len);
1862                 for (auto c: content()) {
1863                         if (c->video) {
1864                                 for (auto t: c->reel_split_points(shared_from_this())) {
1865                                         split_points.push_back (t);
1866                                 }
1867                                 split_points.push_back (c->end(shared_from_this()));
1868                         }
1869                 }
1870
1871                 split_points.sort ();
1872                 split_points.unique ();
1873
1874                 /* Make them into periods, coalescing any that are less than 1 second long */
1875                 optional<DCPTime> last;
1876                 for (auto t: split_points) {
1877                         if (last && (t - *last) >= DCPTime::from_seconds(1)) {
1878                                 /* Period from *last to t is long enough; use it and start a new one */
1879                                 p.push_back (DCPTimePeriod(*last, t));
1880                                 last = t;
1881                         } else if (!last) {
1882                                 /* That was the first time, so start a new period */
1883                                 last = t;
1884                         }
1885                 }
1886
1887                 if (!p.empty()) {
1888                         p.back().to = split_points.back();
1889                 }
1890                 break;
1891         }
1892         case ReelType::BY_LENGTH:
1893         {
1894                 DCPTime current;
1895                 /* Integer-divide reel length by the size of one frame to give the number of frames per reel,
1896                  * making sure we don't go less than 1s long.
1897                  */
1898                 Frame const reel_in_frames = max(_reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8), static_cast<Frame>(video_frame_rate()));
1899                 while (current < len) {
1900                         DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1901                         p.push_back (DCPTimePeriod (current, end));
1902                         current = end;
1903                 }
1904                 break;
1905         }
1906         }
1907
1908         return p;
1909 }
1910
1911 /** @param period A period within the DCP
1912  *  @return Name of the content which most contributes to the given period.
1913  */
1914 string
1915 Film::content_summary (DCPTimePeriod period) const
1916 {
1917         return _playlist->content_summary (shared_from_this(), period);
1918 }
1919
1920 void
1921 Film::use_template (string name)
1922 {
1923         _template_film.reset (new Film (optional<boost::filesystem::path>()));
1924         _template_film->read_metadata (Config::instance()->template_read_path(name));
1925         _use_isdcf_name = _template_film->_use_isdcf_name;
1926         _dcp_content_type = _template_film->_dcp_content_type;
1927         _container = _template_film->_container;
1928         _resolution = _template_film->_resolution;
1929         _j2k_bandwidth = _template_film->_j2k_bandwidth;
1930         _video_frame_rate = _template_film->_video_frame_rate;
1931         _encrypted = _template_film->_encrypted;
1932         _audio_channels = _template_film->_audio_channels;
1933         _sequence = _template_film->_sequence;
1934         _three_d = _template_film->_three_d;
1935         _interop = _template_film->_interop;
1936         _audio_processor = _template_film->_audio_processor;
1937         _reel_type = _template_film->_reel_type;
1938         _reel_length = _template_film->_reel_length;
1939 }
1940
1941 pair<double, double>
1942 Film::speed_up_range (int dcp_frame_rate) const
1943 {
1944         return _playlist->speed_up_range (dcp_frame_rate);
1945 }
1946
1947 void
1948 Film::copy_from (shared_ptr<const Film> film)
1949 {
1950         read_metadata (film->file (metadata_file));
1951 }
1952
1953 bool
1954 Film::references_dcp_video () const
1955 {
1956         for (auto i: _playlist->content()) {
1957                 auto d = dynamic_pointer_cast<DCPContent>(i);
1958                 if (d && d->reference_video()) {
1959                         return true;
1960                 }
1961         }
1962
1963         return false;
1964 }
1965
1966 bool
1967 Film::references_dcp_audio () const
1968 {
1969         for (auto i: _playlist->content()) {
1970                 auto d = dynamic_pointer_cast<DCPContent>(i);
1971                 if (d && d->reference_audio()) {
1972                         return true;
1973                 }
1974         }
1975
1976         return false;
1977 }
1978
1979
1980 bool
1981 Film::contains_atmos_content () const
1982 {
1983         for (auto i: _playlist->content()) {
1984                 if (i->atmos) {
1985                         return true;
1986                 }
1987         }
1988
1989         return false;
1990 }
1991
1992
1993 list<DCPTextTrack>
1994 Film::closed_caption_tracks () const
1995 {
1996         list<DCPTextTrack> tt;
1997         for (auto i: content()) {
1998                 for (auto j: i->text) {
1999                         /* XXX: Empty DCPTextTrack ends up being a magic value here - the "unknown" or "not specified" track */
2000                         auto dtt = j->dcp_track().get_value_or(DCPTextTrack());
2001                         if (j->type() == TextType::CLOSED_CAPTION && find(tt.begin(), tt.end(), dtt) == tt.end()) {
2002                                 tt.push_back (dtt);
2003                         }
2004                 }
2005         }
2006
2007         return tt;
2008 }
2009
2010 void
2011 Film::set_marker (dcp::Marker type, DCPTime time)
2012 {
2013         FilmChangeSignaller ch (this, Property::MARKERS);
2014         _markers[type] = time;
2015 }
2016
2017
2018 void
2019 Film::unset_marker (dcp::Marker type)
2020 {
2021         FilmChangeSignaller ch (this, Property::MARKERS);
2022         _markers.erase (type);
2023 }
2024
2025
2026 void
2027 Film::clear_markers ()
2028 {
2029         FilmChangeSignaller ch (this, Property::MARKERS);
2030         _markers.clear ();
2031 }
2032
2033
2034 void
2035 Film::set_ratings (vector<dcp::Rating> r)
2036 {
2037         FilmChangeSignaller ch (this, Property::RATINGS);
2038         _ratings = r;
2039 }
2040
2041 void
2042 Film::set_content_versions (vector<string> v)
2043 {
2044         FilmChangeSignaller ch (this, Property::CONTENT_VERSIONS);
2045         _content_versions = v;
2046 }
2047
2048
2049 void
2050 Film::set_name_language (dcp::LanguageTag lang)
2051 {
2052         FilmChangeSignaller ch (this, Property::NAME_LANGUAGE);
2053         _name_language = lang;
2054 }
2055
2056
2057 void
2058 Film::set_release_territory (optional<dcp::LanguageTag::RegionSubtag> region)
2059 {
2060         FilmChangeSignaller ch (this, Property::RELEASE_TERRITORY);
2061         _release_territory = region;
2062 }
2063
2064
2065 void
2066 Film::set_status (dcp::Status s)
2067 {
2068         FilmChangeSignaller ch (this, Property::STATUS);
2069         _status = s;
2070 }
2071
2072
2073 void
2074 Film::set_version_number (int v)
2075 {
2076         FilmChangeSignaller ch (this, Property::VERSION_NUMBER);
2077         _version_number = v;
2078 }
2079
2080
2081 void
2082 Film::set_chain (optional<string> c)
2083 {
2084         FilmChangeSignaller ch (this, Property::CHAIN);
2085         _chain = c;
2086 }
2087
2088
2089 void
2090 Film::set_distributor (optional<string> d)
2091 {
2092         FilmChangeSignaller ch (this, Property::DISTRIBUTOR);
2093         _distributor = d;
2094 }
2095
2096
2097 void
2098 Film::set_luminance (optional<dcp::Luminance> l)
2099 {
2100         FilmChangeSignaller ch (this, Property::LUMINANCE);
2101         _luminance = l;
2102 }
2103
2104
2105 void
2106 Film::set_facility (optional<string> f)
2107 {
2108         FilmChangeSignaller ch (this, Property::FACILITY);
2109         _facility = f;
2110 }
2111
2112
2113 void
2114 Film::set_studio (optional<string> s)
2115 {
2116         FilmChangeSignaller ch (this, Property::STUDIO);
2117         _studio = s;
2118 }
2119
2120
2121 optional<DCPTime>
2122 Film::marker (dcp::Marker type) const
2123 {
2124         auto i = _markers.find (type);
2125         if (i == _markers.end()) {
2126                 return {};
2127         }
2128         return i->second;
2129 }
2130
2131 shared_ptr<InfoFileHandle>
2132 Film::info_file_handle (DCPTimePeriod period, bool read) const
2133 {
2134         return std::make_shared<InfoFileHandle>(_info_file_mutex, info_file(period), read);
2135 }
2136
2137 InfoFileHandle::InfoFileHandle (boost::mutex& mutex, boost::filesystem::path file, bool read)
2138         : _lock (mutex)
2139         , _file (file)
2140 {
2141         if (read) {
2142                 _handle = fopen_boost (file, "rb");
2143                 if (!_handle) {
2144                         throw OpenFileError (file, errno, OpenFileError::READ);
2145                 }
2146         } else {
2147                 auto const exists = boost::filesystem::exists (file);
2148                 if (exists) {
2149                         _handle = fopen_boost (file, "r+b");
2150                 } else {
2151                         _handle = fopen_boost (file, "wb");
2152                 }
2153
2154                 if (!_handle) {
2155                         throw OpenFileError (file, errno, exists ? OpenFileError::READ_WRITE : OpenFileError::WRITE);
2156                 }
2157         }
2158 }
2159
2160 InfoFileHandle::~InfoFileHandle ()
2161 {
2162         fclose (_handle);
2163 }
2164
2165
2166 /** Add FFOC and LFOC markers to a list if they are not already there */
2167 void
2168 Film::add_ffoc_lfoc (Markers& markers) const
2169 {
2170         if (markers.find(dcp::Marker::FFOC) == markers.end()) {
2171                 markers[dcp::Marker::FFOC] = dcpomatic::DCPTime::from_frames(1, video_frame_rate());
2172         }
2173
2174         if (markers.find(dcp::Marker::LFOC) == markers.end()) {
2175                 markers[dcp::Marker::LFOC] = length() - DCPTime::from_frames(1, video_frame_rate());
2176         }
2177 }
2178
2179
2180 void
2181 Film::set_temp_version (bool t)
2182 {
2183         FilmChangeSignaller ch (this, Property::TEMP_VERSION);
2184         _temp_version = t;
2185 }
2186
2187
2188 void
2189 Film::set_pre_release (bool p)
2190 {
2191         FilmChangeSignaller ch (this, Property::PRE_RELEASE);
2192         _pre_release = p;
2193 }
2194
2195
2196 void
2197 Film::set_red_band (bool r)
2198 {
2199         FilmChangeSignaller ch (this, Property::RED_BAND);
2200         _red_band = r;
2201 }
2202
2203
2204 void
2205 Film::set_two_d_version_of_three_d (bool t)
2206 {
2207         FilmChangeSignaller ch (this, Property::TWO_D_VERSION_OF_THREE_D);
2208         _two_d_version_of_three_d = t;
2209 }
2210
2211
2212 void
2213 Film::set_audio_language (optional<dcp::LanguageTag> language)
2214 {
2215         FilmChangeSignaller ch (this, Property::AUDIO_LANGUAGE);
2216         _audio_language = language;
2217 }
2218
2219
2220 bool
2221 Film::has_sign_language_video_channel () const
2222 {
2223         return _audio_channels >= static_cast<int>(dcp::Channel::SIGN_LANGUAGE);
2224 }
2225
2226
2227 void
2228 Film::set_sign_language_video_language (optional<dcp::LanguageTag> lang)
2229 {
2230         FilmChangeSignaller ch (this, Property::SIGN_LANGUAGE_VIDEO_LANGUAGE);
2231         _sign_language_video_language = lang;
2232 }
2233