src/lib/film.cc

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