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