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