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