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