src/lib/film.cc

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