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