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