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