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