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