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