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