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