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 pair<optional<dcp::LanguageTag>, vector<dcp::LanguageTag>>
 756 Film::subtitle_languages () const
 757 {
 758         pair<optional<dcp::LanguageTag>, vector<dcp::LanguageTag>> result;
 759         for (auto i: content()) {
 760                 for (auto j: i->text) {
 761                         if (j->use() && j->type() == TextType::OPEN_SUBTITLE && j->language()) {
 762                                 if (j->language_is_additional()) {
 763                                         result.second.push_back (j->language().get());
 764                                 } else {
 765                                         result.first = j->language().get();
 766                                 }
 767                         }
 768                 }
 769         }
 770
 771         std::sort (result.second.begin(), result.second.end());
 772         auto last = std::unique (result.second.begin(), result.second.end());
 773         result.second.erase (last, result.second.end());
 774         return result;
 775 }
 776
 777
 778 /** @return a ISDCF-compliant name for a DCP of this film */
 779 string
 780 Film::isdcf_name (bool if_created_now) const
 781 {
 782         string d;
 783
 784         auto raw_name = name ();
 785
 786         /* Split the raw name up into words */
 787         vector<string> words;
 788         split (words, raw_name, is_any_of (" _-"));
 789
 790         string fixed_name;
 791
 792         /* Add each word to fixed_name */
 793         for (auto i: words) {
 794                 string w = i;
 795
 796                 /* First letter is always capitalised */
 797                 w[0] = toupper (w[0]);
 798
 799                 /* Count caps in w */
 800                 size_t caps = 0;
 801                 for (size_t j = 0; j < w.size(); ++j) {
 802                         if (isupper (w[j])) {
 803                                 ++caps;
 804                         }
 805                 }
 806
 807                 /* If w is all caps make the rest of it lower case, otherwise
 808                    leave it alone.
 809                 */
 810                 if (caps == w.size ()) {
 811                         for (size_t j = 1; j < w.size(); ++j) {
 812                                 w[j] = tolower (w[j]);
 813                         }
 814                 }
 815
 816                 for (size_t j = 0; j < w.size(); ++j) {
 817                         fixed_name += w[j];
 818                 }
 819         }
 820
 821         if (fixed_name.length() > 14) {
 822                 fixed_name = fixed_name.substr (0, 14);
 823         }
 824
 825         d += fixed_name;
 826
 827         if (dcp_content_type()) {
 828                 d += "_" + dcp_content_type()->isdcf_name();
 829                 d += "-" + raw_convert<string>(isdcf_metadata().content_version);
 830         }
 831
 832         auto const dm = isdcf_metadata ();
 833
 834         if (dm.temp_version) {
 835                 d += "-Temp";
 836         }
 837
 838         if (dm.pre_release) {
 839                 d += "-Pre";
 840         }
 841
 842         if (dm.red_band) {
 843                 d += "-RedBand";
 844         }
 845
 846         if (!dm.chain.empty ()) {
 847                 d += "-" + dm.chain;
 848         }
 849
 850         if (three_d ()) {
 851                 d += "-3D";
 852         }
 853
 854         if (dm.two_d_version_of_three_d) {
 855                 d += "-2D";
 856         }
 857
 858         if (!dm.mastered_luminance.empty ()) {
 859                 d += "-" + dm.mastered_luminance;
 860         }
 861
 862         if (video_frame_rate() != 24) {
 863                 d += "-" + raw_convert<string>(video_frame_rate());
 864         }
 865
 866         if (container()) {
 867                 d += "_" + container()->isdcf_name();
 868         }
 869
 870         /* XXX: this uses the first bit of content only */
 871
 872         /* Interior aspect ratio.  The standard says we don't do this for trailers, for some strange reason */
 873         if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::ContentKind::TRAILER) {
 874                 Ratio const* content_ratio = nullptr;
 875                 for (auto i: content ()) {
 876                         if (i->video) {
 877                                 /* Here's the first piece of video content */
 878                                 content_ratio = Ratio::nearest_from_ratio(i->video->scaled_size(frame_size()).ratio());
 879                                 break;
 880                         }
 881                 }
 882
 883                 if (content_ratio && content_ratio != container()) {
 884                         /* This needs to be the numeric version of the ratio, and ::id() is close enough */
 885                         d += "-" + content_ratio->id();
 886                 }
 887         }
 888
 889         auto const audio_language = dm.audio_language.empty() ? "XX" : dm.audio_language;
 890
 891         d += "_" + audio_language;
 892
 893         /* I'm not clear on the precise details of the convention for CCAP labelling;
 894            for now I'm just appending -CCAP if we have any closed captions.
 895         */
 896
 897         auto burnt_in = true;
 898         auto ccap = false;
 899         for (auto i: content()) {
 900                 for (auto j: i->text) {
 901                         if (j->type() == TextType::OPEN_SUBTITLE && j->use() && !j->burn()) {
 902                                 burnt_in = false;
 903                         } else if (j->type() == TextType::CLOSED_CAPTION && j->use()) {
 904                                 ccap = true;
 905                         }
 906                 }
 907         }
 908
 909         auto sublangs = subtitle_languages();
 910         if (sublangs.first && sublangs.first->language()) {
 911                 auto lang = sublangs.first->language()->subtag();
 912                 if (burnt_in) {
 913                         transform (lang.begin(), lang.end(), lang.begin(), ::tolower);
 914                 } else {
 915                         transform (lang.begin(), lang.end(), lang.begin(), ::toupper);
 916                 }
 917
 918                 d += "-" + lang;
 919                 if (ccap) {
 920                         d += "-CCAP";
 921                 }
 922         } else {
 923                 /* No subtitles */
 924                 d += "-XX";
 925         }
 926
 927         if (!dm.territory.empty ()) {
 928                 d += "_" + dm.territory;
 929                 if (dm.rating.empty ()) {
 930                         d += "-NR";
 931                 } else {
 932                         d += "-" + dm.rating;
 933                 }
 934         }
 935
 936         /* Count mapped audio channels */
 937
 938         auto mapped = mapped_audio_channels ();
 939
 940         auto ch = audio_channel_types (mapped, audio_channels());
 941         if (!ch.first && !ch.second) {
 942                 d += "_MOS";
 943         } else if (ch.first) {
 944                 d += String::compose("_%1%2", ch.first, ch.second);
 945         }
 946
 947         if (audio_channels() > static_cast<int>(dcp::Channel::HI) && find(mapped.begin(), mapped.end(), static_cast<int>(dcp::Channel::HI)) != mapped.end()) {
 948                 d += "-HI";
 949         }
 950         if (audio_channels() > static_cast<int>(dcp::Channel::VI) && find(mapped.begin(), mapped.end(), static_cast<int>(dcp::Channel::VI)) != mapped.end()) {
 951                 d += "-VI";
 952         }
 953
 954         d += "_" + resolution_to_string (_resolution);
 955
 956         if (!dm.studio.empty ()) {
 957                 d += "_" + dm.studio;
 958         }
 959
 960         if (if_created_now) {
 961                 d += "_" + boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
 962         } else {
 963                 d += "_" + boost::gregorian::to_iso_string (_isdcf_date);
 964         }
 965
 966         if (!dm.facility.empty ()) {
 967                 d += "_" + dm.facility;
 968         }
 969
 970         if (_interop) {
 971                 d += "_IOP";
 972         } else {
 973                 d += "_SMPTE";
 974         }
 975
 976         if (three_d ()) {
 977                 d += "-3D";
 978         }
 979
 980         auto vf = false;
 981         for (auto i: content()) {
 982                 auto dc = dynamic_pointer_cast<const DCPContent>(i);
 983                 if (!dc) {
 984                         continue;
 985                 }
 986
 987                 bool any_text = false;
 988                 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
 989                         if (dc->reference_text(static_cast<TextType>(i))) {
 990                                 any_text = true;
 991                         }
 992                 }
 993                 if (dc->reference_video() || dc->reference_audio() || any_text) {
 994                         vf = true;
 995                 }
 996         }
 997
 998         if (vf) {
 999                 d += "_VF";
1000         } else {
1001                 d += "_OV";
1002         }
1003
1004         return d;
1005 }
1006
1007 /** @return name to give the DCP */
1008 string
1009 Film::dcp_name (bool if_created_now) const
1010 {
1011         string unfiltered;
1012         if (use_isdcf_name()) {
1013                 return careful_string_filter (isdcf_name (if_created_now));
1014         }
1015
1016         return careful_string_filter (name ());
1017 }
1018
1019 void
1020 Film::set_directory (boost::filesystem::path d)
1021 {
1022         _directory = d;
1023         _dirty = true;
1024 }
1025
1026 void
1027 Film::set_name (string n)
1028 {
1029         FilmChangeSignaller ch (this, Property::NAME);
1030         _name = n;
1031 }
1032
1033 void
1034 Film::set_use_isdcf_name (bool u)
1035 {
1036         FilmChangeSignaller ch (this, Property::USE_ISDCF_NAME);
1037         _use_isdcf_name = u;
1038 }
1039
1040 void
1041 Film::set_dcp_content_type (DCPContentType const * t)
1042 {
1043         FilmChangeSignaller ch (this, Property::DCP_CONTENT_TYPE);
1044         _dcp_content_type = t;
1045 }
1046
1047
1048 /** @param explicit_user true if this is being set because of
1049  *  a direct user request, false if it is being done because
1050  *  DCP-o-matic is guessing the best container to use.
1051  */
1052 void
1053 Film::set_container (Ratio const * c, bool explicit_user)
1054 {
1055         FilmChangeSignaller ch (this, Property::CONTAINER);
1056         _container = c;
1057
1058         if (explicit_user) {
1059                 _user_explicit_container = true;
1060         }
1061 }
1062
1063
1064 /** @param explicit_user true if this is being set because of
1065  *  a direct user request, false if it is being done because
1066  *  DCP-o-matic is guessing the best resolution to use.
1067  */
1068 void
1069 Film::set_resolution (Resolution r, bool explicit_user)
1070 {
1071         FilmChangeSignaller ch (this, Property::RESOLUTION);
1072         _resolution = r;
1073
1074         if (explicit_user) {
1075                 _user_explicit_resolution = true;
1076         }
1077 }
1078
1079
1080 void
1081 Film::set_j2k_bandwidth (int b)
1082 {
1083         FilmChangeSignaller ch (this, Property::J2K_BANDWIDTH);
1084         _j2k_bandwidth = b;
1085 }
1086
1087 void
1088 Film::set_isdcf_metadata (ISDCFMetadata m)
1089 {
1090         FilmChangeSignaller ch (this, Property::ISDCF_METADATA);
1091         _isdcf_metadata = m;
1092 }
1093
1094 /** @param f New frame rate.
1095  *  @param user_explicit true if this comes from a direct user instruction, false if it is from
1096  *  DCP-o-matic being helpful.
1097  */
1098 void
1099 Film::set_video_frame_rate (int f, bool user_explicit)
1100 {
1101         FilmChangeSignaller ch (this, Property::VIDEO_FRAME_RATE);
1102         _video_frame_rate = f;
1103         if (user_explicit) {
1104                 _user_explicit_video_frame_rate = true;
1105         }
1106 }
1107
1108 void
1109 Film::set_audio_channels (int c)
1110 {
1111         FilmChangeSignaller ch (this, Property::AUDIO_CHANNELS);
1112         _audio_channels = c;
1113 }
1114
1115 void
1116 Film::set_three_d (bool t)
1117 {
1118         FilmChangeSignaller ch (this, Property::THREE_D);
1119         _three_d = t;
1120
1121         if (_three_d && _isdcf_metadata.two_d_version_of_three_d) {
1122                 FilmChangeSignaller ch (this, Property::ISDCF_METADATA);
1123                 _isdcf_metadata.two_d_version_of_three_d = false;
1124         }
1125 }
1126
1127 void
1128 Film::set_interop (bool i)
1129 {
1130         FilmChangeSignaller ch (this, Property::INTEROP);
1131         _interop = i;
1132 }
1133
1134 void
1135 Film::set_audio_processor (AudioProcessor const * processor)
1136 {
1137         FilmChangeSignaller ch1 (this, Property::AUDIO_PROCESSOR);
1138         FilmChangeSignaller ch2 (this, Property::AUDIO_CHANNELS);
1139         _audio_processor = processor;
1140 }
1141
1142 void
1143 Film::set_reel_type (ReelType t)
1144 {
1145         FilmChangeSignaller ch (this, Property::REEL_TYPE);
1146         _reel_type = t;
1147 }
1148
1149 /** @param r Desired reel length in bytes */
1150 void
1151 Film::set_reel_length (int64_t r)
1152 {
1153         FilmChangeSignaller ch (this, Property::REEL_LENGTH);
1154         _reel_length = r;
1155 }
1156
1157 void
1158 Film::set_reencode_j2k (bool r)
1159 {
1160         FilmChangeSignaller ch (this, Property::REENCODE_J2K);
1161         _reencode_j2k = r;
1162 }
1163
1164 void
1165 Film::signal_change (ChangeType type, int p)
1166 {
1167         signal_change (type, static_cast<Property>(p));
1168 }
1169
1170 void
1171 Film::signal_change (ChangeType type, Property p)
1172 {
1173         if (type == ChangeType::DONE) {
1174                 _dirty = true;
1175
1176                 if (p == Property::CONTENT) {
1177                         if (!_user_explicit_video_frame_rate) {
1178                                 set_video_frame_rate (best_video_frame_rate());
1179                         }
1180                 }
1181
1182                 emit (boost::bind (boost::ref (Change), type, p));
1183
1184                 if (p == Property::VIDEO_FRAME_RATE || p == Property::SEQUENCE) {
1185                         /* We want to call Playlist::maybe_sequence but this must happen after the
1186                            main signal emission (since the butler will see that emission and un-suspend itself).
1187                         */
1188                         emit (boost::bind(&Playlist::maybe_sequence, _playlist.get(), shared_from_this()));
1189                 }
1190         } else {
1191                 Change (type, p);
1192         }
1193 }
1194
1195 void
1196 Film::set_isdcf_date_today ()
1197 {
1198         _isdcf_date = boost::gregorian::day_clock::local_day ();
1199 }
1200
1201 boost::filesystem::path
1202 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
1203 {
1204         boost::filesystem::path p;
1205         p /= "j2c";
1206         p /= video_identifier ();
1207
1208         char buffer[256];
1209         snprintf(buffer, sizeof(buffer), "%08d_%08" PRId64, reel, frame);
1210         string s (buffer);
1211
1212         if (eyes == Eyes::LEFT) {
1213                 s += ".L";
1214         } else if (eyes == Eyes::RIGHT) {
1215                 s += ".R";
1216         }
1217
1218         s += ".j2c";
1219
1220         if (tmp) {
1221                 s += ".tmp";
1222         }
1223
1224         p /= s;
1225         return file (p);
1226 }
1227
1228 static
1229 bool
1230 cpl_summary_compare (CPLSummary const & a, CPLSummary const & b)
1231 {
1232         return a.last_write_time > b.last_write_time;
1233 }
1234
1235 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs.
1236  *  The list will be returned in reverse order of timestamp (i.e. most recent first).
1237  */
1238 vector<CPLSummary>
1239 Film::cpls () const
1240 {
1241         if (!directory ()) {
1242                 return vector<CPLSummary> ();
1243         }
1244
1245         vector<CPLSummary> out;
1246
1247         auto const dir = directory().get();
1248         for (auto i: boost::filesystem::directory_iterator(dir)) {
1249                 if (
1250                         boost::filesystem::is_directory (i) &&
1251                         i.path().leaf() != "j2c" && i.path().leaf() != "video" && i.path().leaf() != "info" && i.path().leaf() != "analysis"
1252                         ) {
1253
1254                         try {
1255                                 out.push_back (CPLSummary(i));
1256                         } catch (...) {
1257
1258                         }
1259                 }
1260         }
1261
1262         sort (out.begin(), out.end(), cpl_summary_compare);
1263
1264         return out;
1265 }
1266
1267 void
1268 Film::set_encrypted (bool e)
1269 {
1270         FilmChangeSignaller ch (this, Property::ENCRYPTED);
1271         _encrypted = e;
1272 }
1273
1274 ContentList
1275 Film::content () const
1276 {
1277         return _playlist->content ();
1278 }
1279
1280 /** @param content Content to add.
1281  *  @param disable_audio_analysis true to never do automatic audio analysis, even if it is enabled in configuration.
1282  */
1283 void
1284 Film::examine_and_add_content (shared_ptr<Content> content, bool disable_audio_analysis)
1285 {
1286         if (dynamic_pointer_cast<FFmpegContent> (content) && _directory) {
1287                 run_ffprobe (content->path(0), file("ffprobe.log"));
1288         }
1289
1290         auto j = make_shared<ExamineContentJob>(shared_from_this(), content);
1291
1292         _job_connections.push_back (
1293                 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job>(j), weak_ptr<Content>(content), disable_audio_analysis))
1294                 );
1295
1296         JobManager::instance()->add (j);
1297 }
1298
1299 void
1300 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c, bool disable_audio_analysis)
1301 {
1302         auto job = j.lock ();
1303         if (!job || !job->finished_ok ()) {
1304                 return;
1305         }
1306
1307         auto content = c.lock ();
1308         if (!content) {
1309                 return;
1310         }
1311
1312         add_content (content);
1313
1314         if (Config::instance()->automatic_audio_analysis() && content->audio && !disable_audio_analysis) {
1315                 auto playlist = make_shared<Playlist>();
1316                 playlist->add (shared_from_this(), content);
1317                 boost::signals2::connection c;
1318                 JobManager::instance()->analyse_audio (
1319                         shared_from_this(), playlist, false, c, bind (&Film::audio_analysis_finished, this)
1320                         );
1321                 _audio_analysis_connections.push_back (c);
1322         }
1323 }
1324
1325 void
1326 Film::add_content (shared_ptr<Content> c)
1327 {
1328         /* Add {video,subtitle} content after any existing {video,subtitle} content */
1329         if (c->video) {
1330                 c->set_position (shared_from_this(), _playlist->video_end(shared_from_this()));
1331         } else if (!c->text.empty()) {
1332                 c->set_position (shared_from_this(), _playlist->text_end(shared_from_this()));
1333         }
1334
1335         if (_template_film) {
1336                 /* Take settings from the first piece of content of c's type in _template */
1337                 for (auto i: _template_film->content()) {
1338                         c->take_settings_from (i);
1339                 }
1340         }
1341
1342         _playlist->add (shared_from_this(), c);
1343
1344         maybe_set_container_and_resolution ();
1345         if (c->atmos) {
1346                 set_audio_channels (14);
1347                 set_interop (false);
1348         }
1349 }
1350
1351
1352 void
1353 Film::maybe_set_container_and_resolution ()
1354 {
1355         /* Get the only piece of video content, if there is only one */
1356         shared_ptr<VideoContent> video;
1357         for (auto i: _playlist->content()) {
1358                 if (i->video) {
1359                         if (!video) {
1360                                 video = i->video;
1361                         } else {
1362                                 video.reset ();
1363                         }
1364                 }
1365         }
1366
1367         if (video) {
1368                 /* This is the only piece of video content in this Film.  Use it to make a guess for
1369                  * DCP container size and resolution, unless the user has already explicitly set these
1370                  * things.
1371                  */
1372                 if (!_user_explicit_container) {
1373                         if (video->size().ratio() > 2.3) {
1374                                 set_container (Ratio::from_id("239"), false);
1375                         } else {
1376                                 set_container (Ratio::from_id("185"), false);
1377                         }
1378                 }
1379
1380                 if (!_user_explicit_resolution) {
1381                         if (video->size_after_crop().width > 2048 || video->size_after_crop().height > 1080) {
1382                                 set_resolution (Resolution::FOUR_K, false);
1383                         } else {
1384                                 set_resolution (Resolution::TWO_K, false);
1385                         }
1386                 }
1387         }
1388 }
1389
1390 void
1391 Film::remove_content (shared_ptr<Content> c)
1392 {
1393         _playlist->remove (c);
1394         maybe_set_container_and_resolution ();
1395 }
1396
1397 void
1398 Film::move_content_earlier (shared_ptr<Content> c)
1399 {
1400         _playlist->move_earlier (shared_from_this(), c);
1401 }
1402
1403 void
1404 Film::move_content_later (shared_ptr<Content> c)
1405 {
1406         _playlist->move_later (shared_from_this(), c);
1407 }
1408
1409 /** @return length of the film from time 0 to the last thing on the playlist,
1410  *  with a minimum length of 1 second.
1411  */
1412 DCPTime
1413 Film::length () const
1414 {
1415         return max(DCPTime::from_seconds(1), _playlist->length(shared_from_this()).ceil(video_frame_rate()));
1416 }
1417
1418 int
1419 Film::best_video_frame_rate () const
1420 {
1421         /* Don't default to anything above 30fps (make the user select that explicitly) */
1422         auto best = _playlist->best_video_frame_rate ();
1423         if (best > 30) {
1424                 best /= 2;
1425         }
1426         return best;
1427 }
1428
1429 FrameRateChange
1430 Film::active_frame_rate_change (DCPTime t) const
1431 {
1432         return _playlist->active_frame_rate_change (t, video_frame_rate ());
1433 }
1434
1435 void
1436 Film::playlist_content_change (ChangeType type, weak_ptr<Content> c, int p, bool frequent)
1437 {
1438         if (p == ContentProperty::VIDEO_FRAME_RATE) {
1439                 signal_change (type, Property::CONTENT);
1440         } else if (p == AudioContentProperty::STREAMS) {
1441                 signal_change (type, Property::NAME);
1442         }
1443
1444         if (type == ChangeType::DONE) {
1445                 emit (boost::bind (boost::ref (ContentChange), type, c, p, frequent));
1446                 if (!frequent) {
1447                         check_settings_consistency ();
1448                 }
1449         } else {
1450                 ContentChange (type, c, p, frequent);
1451         }
1452
1453         _dirty = true;
1454 }
1455
1456 void
1457 Film::playlist_length_change ()
1458 {
1459         LengthChange ();
1460 }
1461
1462 void
1463 Film::playlist_change (ChangeType type)
1464 {
1465         signal_change (type, Property::CONTENT);
1466         signal_change (type, Property::NAME);
1467
1468         if (type == ChangeType::DONE) {
1469                 check_settings_consistency ();
1470         }
1471
1472         _dirty = true;
1473 }
1474
1475 /** Check for (and if necessary fix) impossible settings combinations, like
1476  *  video set to being referenced when it can't be.
1477  */
1478 void
1479 Film::check_settings_consistency ()
1480 {
1481         optional<int> atmos_rate;
1482         for (auto i: content()) {
1483
1484                 if (i->atmos) {
1485                         int rate = lrintf (i->atmos->edit_rate().as_float());
1486                         if (atmos_rate && *atmos_rate != rate) {
1487                                 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."));
1488                         } else if (!atmos_rate && rate != video_frame_rate()) {
1489                                 atmos_rate = rate;
1490                                 set_video_frame_rate (rate, false);
1491                                 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."));
1492                         }
1493                 }
1494         }
1495
1496         bool change_made = false;
1497         for (auto i: content()) {
1498                 auto d = dynamic_pointer_cast<DCPContent>(i);
1499                 if (!d) {
1500                         continue;
1501                 }
1502
1503                 string why_not;
1504                 if (d->reference_video() && !d->can_reference_video(shared_from_this(), why_not)) {
1505                         d->set_reference_video(false);
1506                         change_made = true;
1507                 }
1508                 if (d->reference_audio() && !d->can_reference_audio(shared_from_this(), why_not)) {
1509                         d->set_reference_audio(false);
1510                         change_made = true;
1511                 }
1512                 if (d->reference_text(TextType::OPEN_SUBTITLE) && !d->can_reference_text(shared_from_this(), TextType::OPEN_SUBTITLE, why_not)) {
1513                         d->set_reference_text(TextType::OPEN_SUBTITLE, false);
1514                         change_made = true;
1515                 }
1516                 if (d->reference_text(TextType::CLOSED_CAPTION) && !d->can_reference_text(shared_from_this(), TextType::CLOSED_CAPTION, why_not)) {
1517                         d->set_reference_text(TextType::CLOSED_CAPTION, false);
1518                         change_made = true;
1519                 }
1520         }
1521
1522         if (change_made) {
1523                 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."));
1524         }
1525 }
1526
1527 void
1528 Film::playlist_order_changed ()
1529 {
1530         /* XXX: missing PENDING */
1531         signal_change (ChangeType::DONE, Property::CONTENT_ORDER);
1532 }
1533
1534 int
1535 Film::audio_frame_rate () const
1536 {
1537         /* It seems that nobody makes 96kHz DCPs at the moment, so let's avoid them.
1538            See #1436.
1539         */
1540         return 48000;
1541 }
1542
1543 void
1544 Film::set_sequence (bool s)
1545 {
1546         if (s == _sequence) {
1547                 return;
1548         }
1549
1550         FilmChangeSignaller cc (this, Property::SEQUENCE);
1551         _sequence = s;
1552         _playlist->set_sequence (s);
1553 }
1554
1555 /** @return Size of the largest possible image in whatever resolution we are using */
1556 dcp::Size
1557 Film::full_frame () const
1558 {
1559         switch (_resolution) {
1560         case Resolution::TWO_K:
1561                 return dcp::Size (2048, 1080);
1562         case Resolution::FOUR_K:
1563                 return dcp::Size (4096, 2160);
1564         }
1565
1566         DCPOMATIC_ASSERT (false);
1567         return dcp::Size ();
1568 }
1569
1570 /** @return Size of the frame */
1571 dcp::Size
1572 Film::frame_size () const
1573 {
1574         return fit_ratio_within (container()->ratio(), full_frame ());
1575 }
1576
1577
1578 /** @return Area of Film::frame_size() that contains picture rather than pillar/letterboxing */
1579 dcp::Size
1580 Film::active_area () const
1581 {
1582         auto const frame = frame_size ();
1583         dcp::Size active;
1584
1585         for (auto i: content()) {
1586                 if (i->video) {
1587                         dcp::Size s = i->video->scaled_size (frame);
1588                         active.width = max(active.width, s.width);
1589                         active.height = max(active.height, s.height);
1590                 }
1591         }
1592
1593         return active;
1594 }
1595
1596
1597 /** @param recipient KDM recipient certificate.
1598  *  @param trusted_devices Certificate thumbprints of other trusted devices (can be empty).
1599  *  @param cpl_file CPL filename.
1600  *  @param from KDM from time expressed as a local time with an offset from UTC.
1601  *  @param until KDM to time expressed as a local time with an offset from UTC.
1602  *  @param formulation KDM formulation to use.
1603  *  @param disable_forensic_marking_picture true to disable forensic marking of picture.
1604  *  @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio.  If set to 0,
1605  *  disable all forensic marking; if set above 0, disable forensic marking above that channel.
1606  */
1607 dcp::EncryptedKDM
1608 Film::make_kdm (
1609         dcp::Certificate recipient,
1610         vector<string> trusted_devices,
1611         boost::filesystem::path cpl_file,
1612         dcp::LocalTime from,
1613         dcp::LocalTime until,
1614         dcp::Formulation formulation,
1615         bool disable_forensic_marking_picture,
1616         optional<int> disable_forensic_marking_audio
1617         ) const
1618 {
1619         if (!_encrypted) {
1620                 throw runtime_error (_("Cannot make a KDM as this project is not encrypted."));
1621         }
1622
1623         auto cpl = make_shared<dcp::CPL>(cpl_file);
1624         auto signer = Config::instance()->signer_chain();
1625         if (!signer->valid ()) {
1626                 throw InvalidSignerError ();
1627         }
1628
1629         /* Find keys that have been added to imported, encrypted DCP content */
1630         list<dcp::DecryptedKDMKey> imported_keys;
1631         for (auto i: content()) {
1632                 auto d = dynamic_pointer_cast<DCPContent> (i);
1633                 if (d && d->kdm()) {
1634                         dcp::DecryptedKDM kdm (d->kdm().get(), Config::instance()->decryption_chain()->key().get());
1635                         auto keys = kdm.keys ();
1636                         copy (keys.begin(), keys.end(), back_inserter (imported_keys));
1637                 }
1638         }
1639
1640         map<shared_ptr<const dcp::ReelFileAsset>, dcp::Key> keys;
1641
1642         for (auto i: cpl->reel_file_assets()) {
1643                 if (!i->key_id()) {
1644                         continue;
1645                 }
1646
1647                 /* Get any imported key for this ID */
1648                 bool done = false;
1649                 for (auto j: imported_keys) {
1650                         if (j.id() == i->key_id().get()) {
1651                                 LOG_GENERAL ("Using imported key for %1", i->key_id().get());
1652                                 keys[i] = j.key();
1653                                 done = true;
1654                         }
1655                 }
1656
1657                 if (!done) {
1658                         /* No imported key; it must be an asset that we encrypted */
1659                         LOG_GENERAL ("Using our own key for %1", i->key_id().get());
1660                         keys[i] = key();
1661                 }
1662         }
1663
1664         return dcp::DecryptedKDM (
1665                 cpl->id(), keys, from, until, cpl->content_title_text(), cpl->content_title_text(), dcp::LocalTime().as_string()
1666                 ).encrypt (signer, recipient, trusted_devices, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio);
1667 }
1668
1669
1670 /** @return The approximate disk space required to encode a DCP of this film with the
1671  *  current settings, in bytes.
1672  */
1673 uint64_t
1674 Film::required_disk_space () const
1675 {
1676         return _playlist->required_disk_space (shared_from_this(), j2k_bandwidth(), audio_channels(), audio_frame_rate());
1677 }
1678
1679 /** This method checks the disk that the Film is on and tries to decide whether or not
1680  *  there will be enough space to make a DCP for it.  If so, true is returned; if not,
1681  *  false is returned and required and available are filled in with the amount of disk space
1682  *  required and available respectively (in GB).
1683  *
1684  *  Note: the decision made by this method isn't, of course, 100% reliable.
1685  */
1686 bool
1687 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1688 {
1689         /* Create a test file and see if we can hard-link it */
1690         boost::filesystem::path test = internal_video_asset_dir() / "test";
1691         boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1692         can_hard_link = true;
1693         auto f = fopen_boost (test, "w");
1694         if (f) {
1695                 fclose (f);
1696                 boost::system::error_code ec;
1697                 boost::filesystem::create_hard_link (test, test2, ec);
1698                 if (ec) {
1699                         can_hard_link = false;
1700                 }
1701                 boost::filesystem::remove (test);
1702                 boost::filesystem::remove (test2);
1703         }
1704
1705         auto s = boost::filesystem::space (internal_video_asset_dir ());
1706         required = double (required_disk_space ()) / 1073741824.0f;
1707         if (!can_hard_link) {
1708                 required *= 2;
1709         }
1710         available = double (s.available) / 1073741824.0f;
1711         return (available - required) > 1;
1712 }
1713
1714 /** @return The names of the channels that audio contents' outputs are passed into;
1715  *  this is either the DCP or a AudioProcessor.
1716  */
1717 vector<NamedChannel>
1718 Film::audio_output_names () const
1719 {
1720         if (audio_processor ()) {
1721                 return audio_processor()->input_names ();
1722         }
1723
1724         DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1725
1726         vector<NamedChannel> n;
1727
1728         for (int i = 0; i < audio_channels(); ++i) {
1729                 if (i != 8 && i != 9 && i != 15) {
1730                         n.push_back (NamedChannel(short_audio_channel_name(i), i));
1731                 }
1732         }
1733
1734         return n;
1735 }
1736
1737 void
1738 Film::repeat_content (ContentList c, int n)
1739 {
1740         _playlist->repeat (shared_from_this(), c, n);
1741 }
1742
1743 void
1744 Film::remove_content (ContentList c)
1745 {
1746         _playlist->remove (c);
1747 }
1748
1749 void
1750 Film::audio_analysis_finished ()
1751 {
1752         /* XXX */
1753 }
1754
1755 list<DCPTimePeriod>
1756 Film::reels () const
1757 {
1758         list<DCPTimePeriod> p;
1759         auto const len = length();
1760
1761         switch (reel_type ()) {
1762         case ReelType::SINGLE:
1763                 p.push_back (DCPTimePeriod (DCPTime (), len));
1764                 break;
1765         case ReelType::BY_VIDEO_CONTENT:
1766         {
1767                 /* Collect all reel boundaries */
1768                 list<DCPTime> split_points;
1769                 split_points.push_back (DCPTime());
1770                 split_points.push_back (len);
1771                 for (auto c: content()) {
1772                         if (c->video) {
1773                                 for (auto t: c->reel_split_points(shared_from_this())) {
1774                                         split_points.push_back (t);
1775                                 }
1776                                 split_points.push_back (c->end(shared_from_this()));
1777                         }
1778                 }
1779
1780                 split_points.sort ();
1781                 split_points.unique ();
1782
1783                 /* Make them into periods, coalescing any that are less than 1 second long */
1784                 optional<DCPTime> last;
1785                 for (auto t: split_points) {
1786                         if (last && (t - *last) >= DCPTime::from_seconds(1)) {
1787                                 /* Period from *last to t is long enough; use it and start a new one */
1788                                 p.push_back (DCPTimePeriod(*last, t));
1789                                 last = t;
1790                         } else if (!last) {
1791                                 /* That was the first time, so start a new period */
1792                                 last = t;
1793                         }
1794                 }
1795
1796                 if (!p.empty()) {
1797                         p.back().to = split_points.back();
1798                 }
1799                 break;
1800         }
1801         case ReelType::BY_LENGTH:
1802         {
1803                 DCPTime current;
1804                 /* Integer-divide reel length by the size of one frame to give the number of frames per reel,
1805                  * making sure we don't go less than 1s long.
1806                  */
1807                 Frame const reel_in_frames = max(_reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8), static_cast<Frame>(video_frame_rate()));
1808                 while (current < len) {
1809                         DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1810                         p.push_back (DCPTimePeriod (current, end));
1811                         current = end;
1812                 }
1813                 break;
1814         }
1815         }
1816
1817         return p;
1818 }
1819
1820 /** @param period A period within the DCP
1821  *  @return Name of the content which most contributes to the given period.
1822  */
1823 string
1824 Film::content_summary (DCPTimePeriod period) const
1825 {
1826         return _playlist->content_summary (shared_from_this(), period);
1827 }
1828
1829 void
1830 Film::use_template (string name)
1831 {
1832         _template_film.reset (new Film (optional<boost::filesystem::path>()));
1833         _template_film->read_metadata (Config::instance()->template_path (name));
1834         _use_isdcf_name = _template_film->_use_isdcf_name;
1835         _dcp_content_type = _template_film->_dcp_content_type;
1836         _container = _template_film->_container;
1837         _resolution = _template_film->_resolution;
1838         _j2k_bandwidth = _template_film->_j2k_bandwidth;
1839         _video_frame_rate = _template_film->_video_frame_rate;
1840         _encrypted = _template_film->_encrypted;
1841         _audio_channels = _template_film->_audio_channels;
1842         _sequence = _template_film->_sequence;
1843         _three_d = _template_film->_three_d;
1844         _interop = _template_film->_interop;
1845         _audio_processor = _template_film->_audio_processor;
1846         _reel_type = _template_film->_reel_type;
1847         _reel_length = _template_film->_reel_length;
1848         _isdcf_metadata = _template_film->_isdcf_metadata;
1849 }
1850
1851 pair<double, double>
1852 Film::speed_up_range (int dcp_frame_rate) const
1853 {
1854         return _playlist->speed_up_range (dcp_frame_rate);
1855 }
1856
1857 void
1858 Film::copy_from (shared_ptr<const Film> film)
1859 {
1860         read_metadata (film->file (metadata_file));
1861 }
1862
1863 bool
1864 Film::references_dcp_video () const
1865 {
1866         for (auto i: _playlist->content()) {
1867                 auto d = dynamic_pointer_cast<DCPContent>(i);
1868                 if (d && d->reference_video()) {
1869                         return true;
1870                 }
1871         }
1872
1873         return false;
1874 }
1875
1876 bool
1877 Film::references_dcp_audio () const
1878 {
1879         for (auto i: _playlist->content()) {
1880                 auto d = dynamic_pointer_cast<DCPContent>(i);
1881                 if (d && d->reference_audio()) {
1882                         return true;
1883                 }
1884         }
1885
1886         return false;
1887 }
1888
1889
1890 bool
1891 Film::contains_atmos_content () const
1892 {
1893         for (auto i: _playlist->content()) {
1894                 if (i->atmos) {
1895                         return true;
1896                 }
1897         }
1898
1899         return false;
1900 }
1901
1902
1903 list<DCPTextTrack>
1904 Film::closed_caption_tracks () const
1905 {
1906         list<DCPTextTrack> tt;
1907         for (auto i: content()) {
1908                 for (auto j: i->text) {
1909                         /* XXX: Empty DCPTextTrack ends up being a magic value here - the "unknown" or "not specified" track */
1910                         auto dtt = j->dcp_track().get_value_or(DCPTextTrack());
1911                         if (j->type() == TextType::CLOSED_CAPTION && find(tt.begin(), tt.end(), dtt) == tt.end()) {
1912                                 tt.push_back (dtt);
1913                         }
1914                 }
1915         }
1916
1917         return tt;
1918 }
1919
1920 void
1921 Film::set_marker (dcp::Marker type, DCPTime time)
1922 {
1923         FilmChangeSignaller ch (this, Property::MARKERS);
1924         _markers[type] = time;
1925 }
1926
1927
1928 void
1929 Film::unset_marker (dcp::Marker type)
1930 {
1931         FilmChangeSignaller ch (this, Property::MARKERS);
1932         _markers.erase (type);
1933 }
1934
1935
1936 void
1937 Film::clear_markers ()
1938 {
1939         FilmChangeSignaller ch (this, Property::MARKERS);
1940         _markers.clear ();
1941 }
1942
1943
1944 void
1945 Film::set_ratings (vector<dcp::Rating> r)
1946 {
1947         FilmChangeSignaller ch (this, Property::RATINGS);
1948         _ratings = r;
1949 }
1950
1951 void
1952 Film::set_content_versions (vector<string> v)
1953 {
1954         FilmChangeSignaller ch (this, Property::CONTENT_VERSIONS);
1955         _content_versions = v;
1956 }
1957
1958
1959 void
1960 Film::set_name_language (dcp::LanguageTag lang)
1961 {
1962         FilmChangeSignaller ch (this, Property::NAME_LANGUAGE);
1963         _name_language = lang;
1964 }
1965
1966
1967 void
1968 Film::set_audio_language (dcp::LanguageTag lang)
1969 {
1970         FilmChangeSignaller ch (this, Property::AUDIO_LANGUAGE);
1971         _audio_language = lang;
1972 }
1973
1974
1975 void
1976 Film::set_release_territory (optional<dcp::LanguageTag::RegionSubtag> region)
1977 {
1978         FilmChangeSignaller ch (this, Property::RELEASE_TERRITORY);
1979         _release_territory = region;
1980 }
1981
1982
1983 void
1984 Film::set_status (dcp::Status s)
1985 {
1986         FilmChangeSignaller ch (this, Property::STATUS);
1987         _status = s;
1988 }
1989
1990
1991 void
1992 Film::set_version_number (int v)
1993 {
1994         FilmChangeSignaller ch (this, Property::VERSION_NUMBER);
1995         _version_number = v;
1996 }
1997
1998
1999 void
2000 Film::set_chain (optional<string> c)
2001 {
2002         FilmChangeSignaller ch (this, Property::CHAIN);
2003         _chain = c;
2004 }
2005
2006
2007 void
2008 Film::set_distributor (optional<string> d)
2009 {
2010         FilmChangeSignaller ch (this, Property::DISTRIBUTOR);
2011         _distributor = d;
2012 }
2013
2014
2015 void
2016 Film::set_luminance (optional<dcp::Luminance> l)
2017 {
2018         FilmChangeSignaller ch (this, Property::LUMINANCE);
2019         _luminance = l;
2020 }
2021
2022
2023 void
2024 Film::set_facility (optional<string> f)
2025 {
2026         FilmChangeSignaller ch (this, Property::FACILITY);
2027         _facility = f;
2028 }
2029
2030
2031 optional<DCPTime>
2032 Film::marker (dcp::Marker type) const
2033 {
2034         auto i = _markers.find (type);
2035         if (i == _markers.end()) {
2036                 return {};
2037         }
2038         return i->second;
2039 }
2040
2041 shared_ptr<InfoFileHandle>
2042 Film::info_file_handle (DCPTimePeriod period, bool read) const
2043 {
2044         return std::make_shared<InfoFileHandle>(_info_file_mutex, info_file(period), read);
2045 }
2046
2047 InfoFileHandle::InfoFileHandle (boost::mutex& mutex, boost::filesystem::path file, bool read)
2048         : _lock (mutex)
2049         , _file (file)
2050 {
2051         if (read) {
2052                 _handle = fopen_boost (file, "rb");
2053                 if (!_handle) {
2054                         throw OpenFileError (file, errno, OpenFileError::READ);
2055                 }
2056         } else {
2057                 auto const exists = boost::filesystem::exists (file);
2058                 if (exists) {
2059                         _handle = fopen_boost (file, "r+b");
2060                 } else {
2061                         _handle = fopen_boost (file, "wb");
2062                 }
2063
2064                 if (!_handle) {
2065                         throw OpenFileError (file, errno, exists ? OpenFileError::READ_WRITE : OpenFileError::WRITE);
2066                 }
2067         }
2068 }
2069
2070 InfoFileHandle::~InfoFileHandle ()
2071 {
2072         fclose (_handle);
2073 }
2074
2075
2076 /** Add FFOC and LFOC markers to a list if they are not already there */
2077 void
2078 Film::add_ffoc_lfoc (Markers& markers) const
2079 {
2080         if (markers.find(dcp::Marker::FFOC) == markers.end()) {
2081                 markers[dcp::Marker::FFOC] = dcpomatic::DCPTime::from_frames(1, video_frame_rate());
2082         }
2083
2084         if (markers.find(dcp::Marker::LFOC) == markers.end()) {
2085                 markers[dcp::Marker::LFOC] = length() - DCPTime::from_frames(1, video_frame_rate());
2086         }
2087 }