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