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