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