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