src/lib/film.cc

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