src/lib/film.cc

   1 /*
   2     Copyright (C) 2012-2019 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 "film.h"
  27 #include "job.h"
  28 #include "util.h"
  29 #include "job_manager.h"
  30 #include "dcp_encoder.h"
  31 #include "transcode_job.h"
  32 #include "upload_job.h"
  33 #include "null_log.h"
  34 #include "file_log.h"
  35 #include "dcpomatic_log.h"
  36 #include "exceptions.h"
  37 #include "examine_content_job.h"
  38 #include "config.h"
  39 #include "playlist.h"
  40 #include "dcp_content_type.h"
  41 #include "ratio.h"
  42 #include "cross.h"
  43 #include "environment_info.h"
  44 #include "audio_processor.h"
  45 #include "digester.h"
  46 #include "compose.hpp"
  47 #include "screen.h"
  48 #include "audio_content.h"
  49 #include "video_content.h"
  50 #include "text_content.h"
  51 #include "ffmpeg_content.h"
  52 #include "dcp_content.h"
  53 #include "screen_kdm.h"
  54 #include "cinema.h"
  55 #include "change_signaller.h"
  56 #include "check_content_change_job.h"
  57 #include <libcxml/cxml.h>
  58 #include <dcp/cpl.h>
  59 #include <dcp/certificate_chain.h>
  60 #include <dcp/util.h>
  61 #include <dcp/local_time.h>
  62 #include <dcp/decrypted_kdm.h>
  63 #include <dcp/raw_convert.h>
  64 #include <dcp/reel_mxf.h>
  65 #include <dcp/reel_asset.h>
  66 #include <libxml++/libxml++.h>
  67 #include <boost/filesystem.hpp>
  68 #include <boost/algorithm/string.hpp>
  69 #include <boost/foreach.hpp>
  70 #include <boost/regex.hpp>
  71 #include <unistd.h>
  72 #include <stdexcept>
  73 #include <iostream>
  74 #include <algorithm>
  75 #include <cstdlib>
  76 #include <iomanip>
  77 #include <set>
  78
  79 #include "i18n.h"
  80
  81 using std::string;
  82 using std::pair;
  83 using std::vector;
  84 using std::setfill;
  85 using std::min;
  86 using std::max;
  87 using std::make_pair;
  88 using std::cout;
  89 using std::list;
  90 using std::set;
  91 using std::runtime_error;
  92 using std::copy;
  93 using std::back_inserter;
  94 using std::map;
  95 using std::exception;
  96 using boost::shared_ptr;
  97 using boost::weak_ptr;
  98 using boost::dynamic_pointer_cast;
  99 using boost::optional;
 100 using boost::is_any_of;
 101 using dcp::raw_convert;
 102 using namespace dcpomatic;
 103
 104 string const Film::metadata_file = "metadata.xml";
 105
 106 /* 5 -> 6
 107  * AudioMapping XML changed.
 108  * 6 -> 7
 109  * Subtitle offset changed to subtitle y offset, and subtitle x offset added.
 110  * 7 -> 8
 111  * Use <Scale> tag in <VideoContent> rather than <Ratio>.
 112  * 8 -> 9
 113  * DCI -> ISDCF
 114  * 9 -> 10
 115  * Subtitle X and Y scale.
 116  *
 117  * Bumped to 32 for 2.0 branch; some times are expressed in Times rather
 118  * than frames now.
 119  *
 120  * 32 -> 33
 121  * Changed <Period> to <Subtitle> in FFmpegSubtitleStream
 122  * 33 -> 34
 123  * Content only contains audio/subtitle-related tags if those things
 124  * are present.
 125  * 34 -> 35
 126  * VideoFrameType in VideoContent is a string rather than an integer.
 127  * 35 -> 36
 128  * EffectColour rather than OutlineColour in Subtitle.
 129  * 36 -> 37
 130  * TextContent can be in a Caption tag, and some of the tag names
 131  * have had Subtitle prefixes or suffixes removed.
 132  */
 133 int const Film::current_state_version = 37;
 134
 135 /** Construct a Film object in a given directory.
 136  *
 137  *  @param dir Film directory.
 138  */
 139
 140 Film::Film (optional<boost::filesystem::path> dir)
 141         : _playlist (new Playlist)
 142         , _use_isdcf_name (true)
 143         , _dcp_content_type (Config::instance()->default_dcp_content_type ())
 144         , _container (Config::instance()->default_container ())
 145         , _resolution (RESOLUTION_2K)
 146         , _signed (true)
 147         , _encrypted (false)
 148         , _context_id (dcp::make_uuid ())
 149         , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
 150         , _isdcf_metadata (Config::instance()->default_isdcf_metadata ())
 151         , _video_frame_rate (24)
 152         , _audio_channels (Config::instance()->default_dcp_audio_channels ())
 153         , _three_d (false)
 154         , _sequence (true)
 155         , _interop (Config::instance()->default_interop ())
 156         , _audio_processor (0)
 157         , _reel_type (REELTYPE_SINGLE)
 158         , _reel_length (2000000000)
 159         , _upload_after_make_dcp (Config::instance()->default_upload_after_make_dcp())
 160         , _reencode_j2k (false)
 161         , _user_explicit_video_frame_rate (false)
 162         , _state_version (current_state_version)
 163         , _dirty (false)
 164 {
 165         set_isdcf_date_today ();
 166
 167         _playlist_change_connection = _playlist->Change.connect (bind (&Film::playlist_change, this, _1));
 168         _playlist_order_changed_connection = _playlist->OrderChanged.connect (bind (&Film::playlist_order_changed, this));
 169         _playlist_content_change_connection = _playlist->ContentChange.connect (bind (&Film::playlist_content_change, this, _1, _2, _3, _4));
 170
 171         if (dir) {
 172                 /* Make state.directory a complete path without ..s (where possible)
 173                    (Code swiped from Adam Bowen on stackoverflow)
 174                    XXX: couldn't/shouldn't this just be boost::filesystem::canonical?
 175                 */
 176
 177                 boost::filesystem::path p (boost::filesystem::system_complete (dir.get()));
 178                 boost::filesystem::path result;
 179                 for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
 180                         if (*i == "..") {
 181                                 if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
 182                                         result /= *i;
 183                                 } else {
 184                                         result = result.parent_path ();
 185                                 }
 186                         } else if (*i != ".") {
 187                                 result /= *i;
 188                         }
 189                 }
 190
 191                 set_directory (result.make_preferred ());
 192         }
 193
 194         if (_directory) {
 195                 _log.reset (new FileLog (file ("log")));
 196         } else {
 197                 _log.reset (new NullLog);
 198         }
 199
 200         _playlist->set_sequence (_sequence);
 201 }
 202
 203 Film::~Film ()
 204 {
 205         BOOST_FOREACH (boost::signals2::connection& i, _job_connections) {
 206                 i.disconnect ();
 207         }
 208
 209         BOOST_FOREACH (boost::signals2::connection& i, _audio_analysis_connections) {
 210                 i.disconnect ();
 211         }
 212 }
 213
 214 string
 215 Film::video_identifier () const
 216 {
 217         DCPOMATIC_ASSERT (container ());
 218
 219         string s = container()->id()
 220                 + "_" + resolution_to_string (_resolution)
 221                 + "_" + _playlist->video_identifier()
 222                 + "_" + raw_convert<string>(_video_frame_rate)
 223                 + "_" + raw_convert<string>(j2k_bandwidth());
 224
 225         if (encrypted ()) {
 226                 s += "_E";
 227         } else {
 228                 s += "_P";
 229         }
 230
 231         if (_interop) {
 232                 s += "_I";
 233         } else {
 234                 s += "_S";
 235         }
 236
 237         if (_three_d) {
 238                 s += "_3D";
 239         }
 240
 241         return s;
 242 }
 243
 244 /** @return The file to write video frame info to */
 245 boost::filesystem::path
 246 Film::info_file (DCPTimePeriod period) const
 247 {
 248         boost::filesystem::path p;
 249         p /= "info";
 250         p /= video_identifier () + "_" + raw_convert<string> (period.from.get()) + "_" + raw_convert<string> (period.to.get());
 251         return file (p);
 252 }
 253
 254 boost::filesystem::path
 255 Film::internal_video_asset_dir () const
 256 {
 257         return dir ("video");
 258 }
 259
 260 boost::filesystem::path
 261 Film::internal_video_asset_filename (DCPTimePeriod p) const
 262 {
 263         return video_identifier() + "_" + raw_convert<string> (p.from.get()) + "_" + raw_convert<string> (p.to.get()) + ".mxf";
 264 }
 265
 266 boost::filesystem::path
 267 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
 268 {
 269         boost::filesystem::path p = dir ("analysis");
 270
 271         Digester digester;
 272         BOOST_FOREACH (shared_ptr<Content> i, playlist->content ()) {
 273                 if (!i->audio) {
 274                         continue;
 275                 }
 276
 277                 digester.add (i->digest ());
 278                 digester.add (i->audio->mapping().digest ());
 279                 if (playlist->content().size() != 1) {
 280                         /* Analyses should be considered equal regardless of gain
 281                            if they were made from just one piece of content.  This
 282                            is because we can fake any gain change in a single-content
 283                            analysis at the plotting stage rather than having to
 284                            recompute it.
 285                         */
 286                         digester.add (i->audio->gain ());
 287                 }
 288         }
 289
 290         if (audio_processor ()) {
 291                 digester.add (audio_processor()->id ());
 292         }
 293
 294         digester.add (audio_channels());
 295
 296         p /= digester.get ();
 297         return p;
 298 }
 299
 300 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
 301 void
 302 Film::make_dcp (bool gui)
 303 {
 304         if (dcp_name().find ("/") != string::npos) {
 305                 throw BadSettingError (_("name"), _("Cannot contain slashes"));
 306         }
 307
 308         if (container() == 0) {
 309                 throw MissingSettingError (_("container"));
 310         }
 311
 312         if (content().empty()) {
 313                 throw runtime_error (_("You must add some content to the DCP before creating it"));
 314         }
 315
 316         if (dcp_content_type() == 0) {
 317                 throw MissingSettingError (_("content type"));
 318         }
 319
 320         if (name().empty()) {
 321                 set_name ("DCP");
 322         }
 323
 324         BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
 325                 if (!i->paths_valid()) {
 326                         throw runtime_error (_("some of your content is missing"));
 327                 }
 328                 shared_ptr<const DCPContent> dcp = dynamic_pointer_cast<const DCPContent> (i);
 329                 if (dcp && dcp->needs_kdm()) {
 330                         throw runtime_error (_("Some of your content needs a KDM"));
 331                 }
 332                 if (dcp && dcp->needs_assets()) {
 333                         throw runtime_error (_("Some of your content needs an OV"));
 334                 }
 335         }
 336
 337         set_isdcf_date_today ();
 338
 339         BOOST_FOREACH (string i, environment_info ()) {
 340                 LOG_GENERAL_NC (i);
 341         }
 342
 343         BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
 344                 LOG_GENERAL ("Content: %1", i->technical_summary());
 345         }
 346         LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
 347         if (Config::instance()->only_servers_encode ()) {
 348                 LOG_GENERAL_NC ("0 threads: ONLY SERVERS SET TO ENCODE");
 349         } else {
 350                 LOG_GENERAL ("%1 threads", Config::instance()->master_encoding_threads());
 351         }
 352         LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
 353
 354         shared_ptr<TranscodeJob> tj (new TranscodeJob (shared_from_this()));
 355         tj->set_encoder (shared_ptr<Encoder> (new DCPEncoder (shared_from_this(), tj)));
 356         shared_ptr<CheckContentChangeJob> cc (new CheckContentChangeJob(shared_from_this(), tj, gui));
 357         JobManager::instance()->add (cc);
 358 }
 359
 360 /** Start a job to send our DCP to the configured TMS */
 361 void
 362 Film::send_dcp_to_tms ()
 363 {
 364         shared_ptr<Job> j (new UploadJob (shared_from_this()));
 365         JobManager::instance()->add (j);
 366 }
 367
 368 shared_ptr<xmlpp::Document>
 369 Film::metadata (bool with_content_paths) const
 370 {
 371         shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
 372         xmlpp::Element* root = doc->create_root_node ("Metadata");
 373
 374         root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
 375         root->add_child("Name")->add_child_text (_name);
 376         root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
 377
 378         if (_dcp_content_type) {
 379                 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
 380         }
 381
 382         if (_container) {
 383                 root->add_child("Container")->add_child_text (_container->id ());
 384         }
 385
 386         root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
 387         root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
 388         _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
 389         root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
 390         root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
 391         root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
 392         root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
 393         root->add_child("Sequence")->add_child_text (_sequence ? "1" : "0");
 394         root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
 395         root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
 396         root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
 397         root->add_child("Key")->add_child_text (_key.hex ());
 398         root->add_child("ContextID")->add_child_text (_context_id);
 399         if (_audio_processor) {
 400                 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
 401         }
 402         root->add_child("ReelType")->add_child_text (raw_convert<string> (static_cast<int> (_reel_type)));
 403         root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
 404         root->add_child("UploadAfterMakeDCP")->add_child_text (_upload_after_make_dcp ? "1" : "0");
 405         root->add_child("ReencodeJ2K")->add_child_text (_reencode_j2k ? "1" : "0");
 406         root->add_child("UserExplicitVideoFrameRate")->add_child_text(_user_explicit_video_frame_rate ? "1" : "0");
 407         for (map<dcp::Marker, DCPTime>::const_iterator i = _markers.begin(); i != _markers.end(); ++i) {
 408                 xmlpp::Element* m = root->add_child("Marker");
 409                 m->set_attribute("Type", dcp::marker_to_string(i->first));
 410                 m->add_child_text(raw_convert<string>(i->second.get()));
 411         }
 412         BOOST_FOREACH (dcp::Rating i, _ratings) {
 413                 i.as_xml (root->add_child("Rating"));
 414         }
 415         _playlist->as_xml (root->add_child ("Playlist"), with_content_paths);
 416
 417         return doc;
 418 }
 419
 420 void
 421 Film::write_metadata (boost::filesystem::path path) const
 422 {
 423         shared_ptr<xmlpp::Document> doc = metadata ();
 424         doc->write_to_file_formatted (path.string());
 425 }
 426
 427 /** Write state to our `metadata' file */
 428 void
 429 Film::write_metadata () const
 430 {
 431         DCPOMATIC_ASSERT (directory());
 432         boost::filesystem::create_directories (directory().get());
 433         shared_ptr<xmlpp::Document> doc = metadata ();
 434         doc->write_to_file_formatted (file(metadata_file).string ());
 435         _dirty = false;
 436 }
 437
 438 /** Write a template from this film */
 439 void
 440 Film::write_template (boost::filesystem::path path) const
 441 {
 442         boost::filesystem::create_directories (path.parent_path());
 443         shared_ptr<xmlpp::Document> doc = metadata (false);
 444         doc->write_to_file_formatted (path.string ());
 445 }
 446
 447 /** Read state from our metadata file.
 448  *  @return Notes about things that the user should know about, or empty.
 449  */
 450 list<string>
 451 Film::read_metadata (optional<boost::filesystem::path> path)
 452 {
 453         if (!path) {
 454                 if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file (metadata_file))) {
 455                         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!"));
 456                 }
 457
 458                 path = file (metadata_file);
 459         }
 460
 461         cxml::Document f ("Metadata");
 462         f.read_file (path.get ());
 463
 464         _state_version = f.number_child<int> ("Version");
 465         if (_state_version > current_state_version) {
 466                 throw runtime_error (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version.  Sorry!"));
 467         } else if (_state_version < current_state_version) {
 468                 /* This is an older version; save a copy (if we haven't already) */
 469                 boost::filesystem::path const older = path->parent_path() / String::compose("metadata.%1.xml", _state_version);
 470                 if (!boost::filesystem::is_regular_file(older)) {
 471                         try {
 472                                 boost::filesystem::copy_file(*path, older);
 473                         } catch (...) {
 474                                 /* Never mind; at least we tried */
 475                         }
 476                 }
 477         }
 478
 479         _name = f.string_child ("Name");
 480         if (_state_version >= 9) {
 481                 _use_isdcf_name = f.bool_child ("UseISDCFName");
 482                 _isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
 483                 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
 484         } else {
 485                 _use_isdcf_name = f.bool_child ("UseDCIName");
 486                 _isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
 487                 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
 488         }
 489
 490
 491         {
 492                 optional<string> c = f.optional_string_child ("DCPContentType");
 493                 if (c) {
 494                         _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
 495                 }
 496         }
 497
 498         {
 499                 optional<string> c = f.optional_string_child ("Container");
 500                 if (c) {
 501                         _container = Ratio::from_id (c.get ());
 502                 }
 503         }
 504
 505         _resolution = string_to_resolution (f.string_child ("Resolution"));
 506         _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
 507         _video_frame_rate = f.number_child<int> ("VideoFrameRate");
 508         _signed = f.optional_bool_child("Signed").get_value_or (true);
 509         _encrypted = f.bool_child ("Encrypted");
 510         _audio_channels = f.number_child<int> ("AudioChannels");
 511         /* We used to allow odd numbers (and zero) channels, but it's just not worth
 512            the pain.
 513         */
 514         if (_audio_channels == 0) {
 515                 _audio_channels = 2;
 516         } else if ((_audio_channels % 2) == 1) {
 517                 _audio_channels++;
 518         }
 519
 520         if (f.optional_bool_child("SequenceVideo")) {
 521                 _sequence = f.bool_child("SequenceVideo");
 522         } else {
 523                 _sequence = f.bool_child("Sequence");
 524         }
 525
 526         _three_d = f.bool_child ("ThreeD");
 527         _interop = f.bool_child ("Interop");
 528         _key = dcp::Key (f.string_child ("Key"));
 529         _context_id = f.optional_string_child("ContextID").get_value_or (dcp::make_uuid ());
 530
 531         if (f.optional_string_child ("AudioProcessor")) {
 532                 _audio_processor = AudioProcessor::from_id (f.string_child ("AudioProcessor"));
 533         } else {
 534                 _audio_processor = 0;
 535         }
 536
 537         _reel_type = static_cast<ReelType> (f.optional_number_child<int>("ReelType").get_value_or (static_cast<int>(REELTYPE_SINGLE)));
 538         _reel_length = f.optional_number_child<int64_t>("ReelLength").get_value_or (2000000000);
 539         _upload_after_make_dcp = f.optional_bool_child("UploadAfterMakeDCP").get_value_or (false);
 540         _reencode_j2k = f.optional_bool_child("ReencodeJ2K").get_value_or(false);
 541         _user_explicit_video_frame_rate = f.optional_bool_child("UserExplicitVideoFrameRate").get_value_or(false);
 542
 543         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Marker")) {
 544                 _markers[dcp::marker_from_string(i->string_attribute("Type"))] = DCPTime(dcp::raw_convert<DCPTime::Type>(i->content()));
 545         }
 546
 547         BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Rating")) {
 548                 _ratings.push_back (dcp::Rating(i));
 549         }
 550
 551         list<string> notes;
 552         _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
 553
 554         /* Write backtraces to this film's directory, until another film is loaded */
 555         if (_directory) {
 556                 set_backtrace_file (file ("backtrace.txt"));
 557         }
 558
 559         _dirty = false;
 560         return notes;
 561 }
 562
 563 /** Given a directory name, return its full path within the Film's directory.
 564  *  @param d directory name within the Film's directory.
 565  *  @param create true to create the directory (and its parents) if they do not exist.
 566  */
 567 boost::filesystem::path
 568 Film::dir (boost::filesystem::path d, bool create) const
 569 {
 570         DCPOMATIC_ASSERT (_directory);
 571
 572         boost::filesystem::path p;
 573         p /= _directory.get();
 574         p /= d;
 575
 576         if (create) {
 577                 boost::filesystem::create_directories (p);
 578         }
 579
 580         return p;
 581 }
 582
 583 /** Given a file or directory name, return its full path within the Film's directory.
 584  *  Any required parent directories will be created.
 585  */
 586 boost::filesystem::path
 587 Film::file (boost::filesystem::path f) const
 588 {
 589         DCPOMATIC_ASSERT (_directory);
 590
 591         boost::filesystem::path p;
 592         p /= _directory.get();
 593         p /= f;
 594
 595         boost::filesystem::create_directories (p.parent_path ());
 596
 597         return p;
 598 }
 599
 600 list<int>
 601 Film::mapped_audio_channels () const
 602 {
 603         list<int> mapped;
 604
 605         if (audio_processor ()) {
 606                 /* Processors are mapped 1:1 to DCP outputs so we can work out mappings from there */
 607                 for (int i = 0; i < audio_processor()->out_channels(); ++i) {
 608                         mapped.push_back (i);
 609                 }
 610         } else {
 611                 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
 612                         if (i->audio) {
 613                                 list<int> c = i->audio->mapping().mapped_output_channels ();
 614                                 copy (c.begin(), c.end(), back_inserter (mapped));
 615                         }
 616                 }
 617
 618                 mapped.sort ();
 619                 mapped.unique ();
 620         }
 621
 622         return mapped;
 623 }
 624
 625 /** @return a ISDCF-compliant name for a DCP of this film */
 626 string
 627 Film::isdcf_name (bool if_created_now) const
 628 {
 629         string d;
 630
 631         string raw_name = name ();
 632
 633         /* Split the raw name up into words */
 634         vector<string> words;
 635         split (words, raw_name, is_any_of (" _-"));
 636
 637         string fixed_name;
 638
 639         /* Add each word to fixed_name */
 640         for (vector<string>::const_iterator i = words.begin(); i != words.end(); ++i) {
 641                 string w = *i;
 642
 643                 /* First letter is always capitalised */
 644                 w[0] = toupper (w[0]);
 645
 646                 /* Count caps in w */
 647                 size_t caps = 0;
 648                 for (size_t i = 0; i < w.size(); ++i) {
 649                         if (isupper (w[i])) {
 650                                 ++caps;
 651                         }
 652                 }
 653
 654                 /* If w is all caps make the rest of it lower case, otherwise
 655                    leave it alone.
 656                 */
 657                 if (caps == w.size ()) {
 658                         for (size_t i = 1; i < w.size(); ++i) {
 659                                 w[i] = tolower (w[i]);
 660                         }
 661                 }
 662
 663                 for (size_t i = 0; i < w.size(); ++i) {
 664                         fixed_name += w[i];
 665                 }
 666         }
 667
 668         if (fixed_name.length() > 14) {
 669                 fixed_name = fixed_name.substr (0, 14);
 670         }
 671
 672         d += fixed_name;
 673
 674         if (dcp_content_type()) {
 675                 d += "_" + dcp_content_type()->isdcf_name();
 676                 d += "-" + raw_convert<string>(isdcf_metadata().content_version);
 677         }
 678
 679         ISDCFMetadata const dm = isdcf_metadata ();
 680
 681         if (dm.temp_version) {
 682                 d += "-Temp";
 683         }
 684
 685         if (dm.pre_release) {
 686                 d += "-Pre";
 687         }
 688
 689         if (dm.red_band) {
 690                 d += "-RedBand";
 691         }
 692
 693         if (!dm.chain.empty ()) {
 694                 d += "-" + dm.chain;
 695         }
 696
 697         if (three_d ()) {
 698                 d += "-3D";
 699         }
 700
 701         if (dm.two_d_version_of_three_d) {
 702                 d += "-2D";
 703         }
 704
 705         if (!dm.mastered_luminance.empty ()) {
 706                 d += "-" + dm.mastered_luminance;
 707         }
 708
 709         if (video_frame_rate() != 24) {
 710                 d += "-" + raw_convert<string>(video_frame_rate());
 711         }
 712
 713         if (container()) {
 714                 d += "_" + container()->isdcf_name();
 715         }
 716
 717         /* XXX: this uses the first bit of content only */
 718
 719         /* Interior aspect ratio.  The standard says we don't do this for trailers, for some strange reason */
 720         if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::TRAILER) {
 721                 Ratio const * content_ratio = 0;
 722                 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
 723                         if (i->video) {
 724                                 /* Here's the first piece of video content */
 725                                 if (i->video->scale().ratio ()) {
 726                                         content_ratio = i->video->scale().ratio ();
 727                                 } else {
 728                                         content_ratio = Ratio::from_ratio (i->video->size().ratio ());
 729                                 }
 730                                 break;
 731                         }
 732                 }
 733
 734                 if (content_ratio && content_ratio != container()) {
 735                         /* This needs to be the numeric version of the ratio, and ::id() is close enough */
 736                         d += "-" + content_ratio->id();
 737                 }
 738         }
 739
 740         if (!dm.audio_language.empty ()) {
 741                 d += "_" + dm.audio_language;
 742
 743                 /* I'm not clear on the precise details of the convention for CCAP labelling;
 744                    for now I'm just appending -CCAP if we have any closed captions.
 745                 */
 746
 747                 optional<string> subtitle_language;
 748                 bool burnt_in = true;
 749                 bool ccap = false;
 750                 BOOST_FOREACH (shared_ptr<Content> i, content()) {
 751                         BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
 752                                 if (j->type() == TEXT_OPEN_SUBTITLE && j->use()) {
 753                                         subtitle_language = j->language ();
 754                                         if (!j->burn()) {
 755                                                 burnt_in = false;
 756                                         }
 757                                 } else if (j->type() == TEXT_CLOSED_CAPTION && j->use()) {
 758                                         ccap = true;
 759                                 }
 760                         }
 761                 }
 762
 763                 if (dm.subtitle_language) {
 764                         /* Subtitle language is overridden in ISDCF metadata, primarily to handle
 765                            content with pre-burnt subtitles.
 766                         */
 767                         d += "-" + *dm.subtitle_language;
 768                         if (ccap) {
 769                                 d += "-CCAP";
 770                         }
 771                 } else if (subtitle_language) {
 772                         /* Language is worked out from the content */
 773                         if (burnt_in && *subtitle_language != "XX") {
 774                                 transform (subtitle_language->begin(), subtitle_language->end(), subtitle_language->begin(), ::tolower);
 775                         } else {
 776                                 transform (subtitle_language->begin(), subtitle_language->end(), subtitle_language->begin(), ::toupper);
 777                         }
 778
 779                         d += "-" + *subtitle_language;
 780                         if (ccap) {
 781                                 d += "-CCAP";
 782                         }
 783                 } else {
 784                         /* No subtitles */
 785                         d += "-XX";
 786                 }
 787         }
 788
 789         if (!dm.territory.empty ()) {
 790                 d += "_" + dm.territory;
 791                 if (dm.rating.empty ()) {
 792                         d += "-NR";
 793                 } else {
 794                         d += "-" + dm.rating;
 795                 }
 796         }
 797
 798         /* Count mapped audio channels */
 799
 800         pair<int, int> ch = audio_channel_types (mapped_audio_channels(), audio_channels());
 801         if (!ch.first && !ch.second) {
 802                 d += "_MOS";
 803         } else if (ch.first) {
 804                 d += String::compose("_%1%2", ch.first, ch.second);
 805         }
 806
 807         /* XXX: HI/VI */
 808
 809         d += "_" + resolution_to_string (_resolution);
 810
 811         if (!dm.studio.empty ()) {
 812                 d += "_" + dm.studio;
 813         }
 814
 815         if (if_created_now) {
 816                 d += "_" + boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
 817         } else {
 818                 d += "_" + boost::gregorian::to_iso_string (_isdcf_date);
 819         }
 820
 821         if (!dm.facility.empty ()) {
 822                 d += "_" + dm.facility;
 823         }
 824
 825         if (_interop) {
 826                 d += "_IOP";
 827         } else {
 828                 d += "_SMPTE";
 829         }
 830
 831         if (three_d ()) {
 832                 d += "-3D";
 833         }
 834
 835         bool vf = false;
 836         BOOST_FOREACH (shared_ptr<Content> i, content ()) {
 837                 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (i);
 838                 if (!dc) {
 839                         continue;
 840                 }
 841
 842                 bool any_text = false;
 843                 for (int i = 0; i < TEXT_COUNT; ++i) {
 844                         if (dc->reference_text(static_cast<TextType>(i))) {
 845                                 any_text = true;
 846                         }
 847                 }
 848                 if (dc->reference_video() || dc->reference_audio() || any_text) {
 849                         vf = true;
 850                 }
 851         }
 852
 853         if (vf) {
 854                 d += "_VF";
 855         } else {
 856                 d += "_OV";
 857         }
 858
 859         return d;
 860 }
 861
 862 /** @return name to give the DCP */
 863 string
 864 Film::dcp_name (bool if_created_now) const
 865 {
 866         string unfiltered;
 867         if (use_isdcf_name()) {
 868                 return careful_string_filter (isdcf_name (if_created_now));
 869         }
 870
 871         return careful_string_filter (name ());
 872 }
 873
 874 void
 875 Film::set_directory (boost::filesystem::path d)
 876 {
 877         _directory = d;
 878         _dirty = true;
 879 }
 880
 881 void
 882 Film::set_name (string n)
 883 {
 884         ChangeSignaller<Film> ch (this, NAME);
 885         _name = n;
 886 }
 887
 888 void
 889 Film::set_use_isdcf_name (bool u)
 890 {
 891         ChangeSignaller<Film> ch (this, USE_ISDCF_NAME);
 892         _use_isdcf_name = u;
 893 }
 894
 895 void
 896 Film::set_dcp_content_type (DCPContentType const * t)
 897 {
 898         ChangeSignaller<Film> ch (this, DCP_CONTENT_TYPE);
 899         _dcp_content_type = t;
 900 }
 901
 902 void
 903 Film::set_container (Ratio const * c)
 904 {
 905         ChangeSignaller<Film> ch (this, CONTAINER);
 906         _container = c;
 907 }
 908
 909 void
 910 Film::set_resolution (Resolution r)
 911 {
 912         ChangeSignaller<Film> ch (this, RESOLUTION);
 913         _resolution = r;
 914 }
 915
 916 void
 917 Film::set_j2k_bandwidth (int b)
 918 {
 919         ChangeSignaller<Film> ch (this, J2K_BANDWIDTH);
 920         _j2k_bandwidth = b;
 921 }
 922
 923 void
 924 Film::set_isdcf_metadata (ISDCFMetadata m)
 925 {
 926         ChangeSignaller<Film> ch (this, ISDCF_METADATA);
 927         _isdcf_metadata = m;
 928 }
 929
 930 /** @param f New frame rate.
 931  *  @param user_explicit true if this comes from a direct user instruction, false if it is from
 932  *  DCP-o-matic being helpful.
 933  */
 934 void
 935 Film::set_video_frame_rate (int f, bool user_explicit)
 936 {
 937         ChangeSignaller<Film> ch (this, VIDEO_FRAME_RATE);
 938         _video_frame_rate = f;
 939         if (user_explicit) {
 940                 _user_explicit_video_frame_rate = true;
 941         }
 942 }
 943
 944 void
 945 Film::set_audio_channels (int c)
 946 {
 947         ChangeSignaller<Film> ch (this, AUDIO_CHANNELS);
 948         _audio_channels = c;
 949 }
 950
 951 void
 952 Film::set_three_d (bool t)
 953 {
 954         ChangeSignaller<Film> ch (this, THREE_D);
 955         _three_d = t;
 956
 957         if (_three_d && _isdcf_metadata.two_d_version_of_three_d) {
 958                 ChangeSignaller<Film> ch (this, ISDCF_METADATA);
 959                 _isdcf_metadata.two_d_version_of_three_d = false;
 960         }
 961 }
 962
 963 void
 964 Film::set_interop (bool i)
 965 {
 966         ChangeSignaller<Film> ch (this, INTEROP);
 967         _interop = i;
 968 }
 969
 970 void
 971 Film::set_audio_processor (AudioProcessor const * processor)
 972 {
 973         ChangeSignaller<Film> ch1 (this, AUDIO_PROCESSOR);
 974         ChangeSignaller<Film> ch2 (this, AUDIO_CHANNELS);
 975         _audio_processor = processor;
 976 }
 977
 978 void
 979 Film::set_reel_type (ReelType t)
 980 {
 981         ChangeSignaller<Film> ch (this, REEL_TYPE);
 982         _reel_type = t;
 983 }
 984
 985 /** @param r Desired reel length in bytes */
 986 void
 987 Film::set_reel_length (int64_t r)
 988 {
 989         ChangeSignaller<Film> ch (this, REEL_LENGTH);
 990         _reel_length = r;
 991 }
 992
 993 void
 994 Film::set_upload_after_make_dcp (bool u)
 995 {
 996         ChangeSignaller<Film> ch (this, UPLOAD_AFTER_MAKE_DCP);
 997         _upload_after_make_dcp = u;
 998 }
 999
1000 void
1001 Film::set_reencode_j2k (bool r)
1002 {
1003         ChangeSignaller<Film> ch (this, REENCODE_J2K);
1004         _reencode_j2k = r;
1005 }
1006
1007 void
1008 Film::signal_change (ChangeType type, int p)
1009 {
1010         signal_change (type, static_cast<Property>(p));
1011 }
1012
1013 void
1014 Film::signal_change (ChangeType type, Property p)
1015 {
1016         if (type == CHANGE_TYPE_DONE) {
1017                 _dirty = true;
1018
1019                 if (p == Film::CONTENT) {
1020                         if (!_user_explicit_video_frame_rate) {
1021                                 set_video_frame_rate (best_video_frame_rate());
1022                         }
1023                 }
1024
1025                 emit (boost::bind (boost::ref (Change), type, p));
1026
1027                 if (p == Film::VIDEO_FRAME_RATE || p == Film::SEQUENCE) {
1028                         /* We want to call Playlist::maybe_sequence but this must happen after the
1029                            main signal emission (since the butler will see that emission and un-suspend itself).
1030                         */
1031                         emit (boost::bind(&Playlist::maybe_sequence, _playlist.get(), shared_from_this()));
1032                 }
1033         } else {
1034                 Change (type, p);
1035         }
1036 }
1037
1038 void
1039 Film::set_isdcf_date_today ()
1040 {
1041         _isdcf_date = boost::gregorian::day_clock::local_day ();
1042 }
1043
1044 boost::filesystem::path
1045 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
1046 {
1047         boost::filesystem::path p;
1048         p /= "j2c";
1049         p /= video_identifier ();
1050
1051         char buffer[256];
1052         snprintf(buffer, sizeof(buffer), "%08d_%08" PRId64, reel, frame);
1053         string s (buffer);
1054
1055         if (eyes == EYES_LEFT) {
1056                 s += ".L";
1057         } else if (eyes == EYES_RIGHT) {
1058                 s += ".R";
1059         }
1060
1061         s += ".j2c";
1062
1063         if (tmp) {
1064                 s += ".tmp";
1065         }
1066
1067         p /= s;
1068         return file (p);
1069 }
1070
1071 static
1072 bool
1073 cpl_summary_compare (CPLSummary const & a, CPLSummary const & b)
1074 {
1075         return a.last_write_time > b.last_write_time;
1076 }
1077
1078 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs.
1079  *  The list will be returned in reverse order of timestamp (i.e. most recent first).
1080  */
1081 vector<CPLSummary>
1082 Film::cpls () const
1083 {
1084         if (!directory ()) {
1085                 return vector<CPLSummary> ();
1086         }
1087
1088         vector<CPLSummary> out;
1089
1090         boost::filesystem::path const dir = directory().get();
1091         for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
1092                 if (
1093                         boost::filesystem::is_directory (*i) &&
1094                         i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
1095                         ) {
1096
1097                         try {
1098                                 out.push_back (CPLSummary(*i));
1099                         } catch (...) {
1100
1101                         }
1102                 }
1103         }
1104
1105         sort (out.begin(), out.end(), cpl_summary_compare);
1106
1107         return out;
1108 }
1109
1110 void
1111 Film::set_signed (bool s)
1112 {
1113         ChangeSignaller<Film> ch (this, SIGNED);
1114         _signed = s;
1115 }
1116
1117 void
1118 Film::set_encrypted (bool e)
1119 {
1120         ChangeSignaller<Film> ch (this, ENCRYPTED);
1121         _encrypted = e;
1122 }
1123
1124 void
1125 Film::set_key (dcp::Key key)
1126 {
1127         ChangeSignaller<Film> ch (this, KEY);
1128         _key = key;
1129 }
1130
1131 ContentList
1132 Film::content () const
1133 {
1134         return _playlist->content ();
1135 }
1136
1137 /** @param content Content to add.
1138  *  @param disable_audio_analysis true to never do automatic audio analysis, even if it is enabled in configuration.
1139  */
1140 void
1141 Film::examine_and_add_content (shared_ptr<Content> content, bool disable_audio_analysis)
1142 {
1143         if (dynamic_pointer_cast<FFmpegContent> (content) && _directory) {
1144                 run_ffprobe (content->path(0), file("ffprobe.log"));
1145         }
1146
1147         shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), content));
1148
1149         _job_connections.push_back (
1150                 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job>(j), weak_ptr<Content>(content), disable_audio_analysis))
1151                 );
1152
1153         JobManager::instance()->add (j);
1154 }
1155
1156 void
1157 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c, bool disable_audio_analysis)
1158 {
1159         shared_ptr<Job> job = j.lock ();
1160         if (!job || !job->finished_ok ()) {
1161                 return;
1162         }
1163
1164         shared_ptr<Content> content = c.lock ();
1165         if (!content) {
1166                 return;
1167         }
1168
1169         add_content (content);
1170
1171         if (Config::instance()->automatic_audio_analysis() && content->audio && !disable_audio_analysis) {
1172                 shared_ptr<Playlist> playlist (new Playlist);
1173                 playlist->add (shared_from_this(), content);
1174                 boost::signals2::connection c;
1175                 JobManager::instance()->analyse_audio (
1176                         shared_from_this(), playlist, false, c, bind (&Film::audio_analysis_finished, this)
1177                         );
1178                 _audio_analysis_connections.push_back (c);
1179         }
1180 }
1181
1182 void
1183 Film::add_content (shared_ptr<Content> c)
1184 {
1185         /* Add {video,subtitle} content after any existing {video,subtitle} content */
1186         if (c->video) {
1187                 c->set_position (shared_from_this(), _playlist->video_end(shared_from_this()));
1188         } else if (!c->text.empty()) {
1189                 c->set_position (shared_from_this(), _playlist->text_end(shared_from_this()));
1190         }
1191
1192         if (_template_film) {
1193                 /* Take settings from the first piece of content of c's type in _template */
1194                 BOOST_FOREACH (shared_ptr<Content> i, _template_film->content()) {
1195                         c->take_settings_from (i);
1196                 }
1197         }
1198
1199         _playlist->add (shared_from_this(), c);
1200 }
1201
1202 void
1203 Film::remove_content (shared_ptr<Content> c)
1204 {
1205         _playlist->remove (c);
1206 }
1207
1208 void
1209 Film::move_content_earlier (shared_ptr<Content> c)
1210 {
1211         _playlist->move_earlier (shared_from_this(), c);
1212 }
1213
1214 void
1215 Film::move_content_later (shared_ptr<Content> c)
1216 {
1217         _playlist->move_later (shared_from_this(), c);
1218 }
1219
1220 /** @return length of the film from time 0 to the last thing on the playlist */
1221 DCPTime
1222 Film::length () const
1223 {
1224         return _playlist->length(shared_from_this()).ceil(video_frame_rate());
1225 }
1226
1227 int
1228 Film::best_video_frame_rate () const
1229 {
1230         /* Don't default to anything above 30fps (make the user select that explicitly) */
1231         int best = _playlist->best_video_frame_rate ();
1232         if (best > 30) {
1233                 best /= 2;
1234         }
1235         return best;
1236 }
1237
1238 FrameRateChange
1239 Film::active_frame_rate_change (DCPTime t) const
1240 {
1241         return _playlist->active_frame_rate_change (t, video_frame_rate ());
1242 }
1243
1244 void
1245 Film::playlist_content_change (ChangeType type, weak_ptr<Content> c, int p, bool frequent)
1246 {
1247         if (p == ContentProperty::VIDEO_FRAME_RATE) {
1248                 signal_change (type, Film::CONTENT);
1249         } else if (p == AudioContentProperty::STREAMS) {
1250                 signal_change (type, Film::NAME);
1251         }
1252
1253         if (type == CHANGE_TYPE_DONE) {
1254                 emit (boost::bind (boost::ref (ContentChange), type, c, p, frequent));
1255         } else {
1256                 ContentChange (type, c, p, frequent);
1257         }
1258 }
1259
1260 void
1261 Film::playlist_change (ChangeType type)
1262 {
1263         signal_change (type, CONTENT);
1264         signal_change (type, NAME);
1265
1266         if (type == CHANGE_TYPE_DONE) {
1267                 /* Check that this change hasn't made our settings inconsistent */
1268                 bool change_made = false;
1269                 BOOST_FOREACH (shared_ptr<Content> i, content()) {
1270                         shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent>(i);
1271                         if (!d) {
1272                                 continue;
1273                         }
1274
1275                         string why_not;
1276                         if (d->reference_video() && !d->can_reference_video(shared_from_this(), why_not)) {
1277                                 d->set_reference_video(false);
1278                                 change_made = true;
1279                         }
1280                         if (d->reference_audio() && !d->can_reference_audio(shared_from_this(), why_not)) {
1281                                 d->set_reference_audio(false);
1282                                 change_made = true;
1283                         }
1284                 }
1285
1286                 if (change_made) {
1287                         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."));
1288                 }
1289         }
1290 }
1291
1292 void
1293 Film::playlist_order_changed ()
1294 {
1295         /* XXX: missing PENDING */
1296         signal_change (CHANGE_TYPE_DONE, CONTENT_ORDER);
1297 }
1298
1299 int
1300 Film::audio_frame_rate () const
1301 {
1302         /* It seems that nobody makes 96kHz DCPs at the moment, so let's avoid them.
1303            See #1436.
1304         */
1305         return 48000;
1306 }
1307
1308 void
1309 Film::set_sequence (bool s)
1310 {
1311         if (s == _sequence) {
1312                 return;
1313         }
1314
1315         ChangeSignaller<Film> cc (this, SEQUENCE);
1316         _sequence = s;
1317         _playlist->set_sequence (s);
1318 }
1319
1320 /** @return Size of the largest possible image in whatever resolution we are using */
1321 dcp::Size
1322 Film::full_frame () const
1323 {
1324         switch (_resolution) {
1325         case RESOLUTION_2K:
1326                 return dcp::Size (2048, 1080);
1327         case RESOLUTION_4K:
1328                 return dcp::Size (4096, 2160);
1329         }
1330
1331         DCPOMATIC_ASSERT (false);
1332         return dcp::Size ();
1333 }
1334
1335 /** @return Size of the frame */
1336 dcp::Size
1337 Film::frame_size () const
1338 {
1339         return fit_ratio_within (container()->ratio(), full_frame ());
1340 }
1341
1342 /** @param recipient KDM recipient certificate.
1343  *  @param trusted_devices Certificate thumbprints of other trusted devices (can be empty).
1344  *  @param cpl_file CPL filename.
1345  *  @param from KDM from time expressed as a local time with an offset from UTC.
1346  *  @param until KDM to time expressed as a local time with an offset from UTC.
1347  *  @param formulation KDM formulation to use.
1348  *  @param disable_forensic_marking_picture true to disable forensic marking of picture.
1349  *  @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio.  If set to 0,
1350  *  disable all forensic marking; if set above 0, disable forensic marking above that channel.
1351  */
1352 dcp::EncryptedKDM
1353 Film::make_kdm (
1354         dcp::Certificate recipient,
1355         vector<string> trusted_devices,
1356         boost::filesystem::path cpl_file,
1357         dcp::LocalTime from,
1358         dcp::LocalTime until,
1359         dcp::Formulation formulation,
1360         bool disable_forensic_marking_picture,
1361         optional<int> disable_forensic_marking_audio
1362         ) const
1363 {
1364         if (!_encrypted) {
1365                 throw runtime_error (_("Cannot make a KDM as this project is not encrypted."));
1366         }
1367
1368         shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
1369         shared_ptr<const dcp::CertificateChain> signer = Config::instance()->signer_chain ();
1370         if (!signer->valid ()) {
1371                 throw InvalidSignerError ();
1372         }
1373
1374         /* Find keys that have been added to imported, encrypted DCP content */
1375         list<dcp::DecryptedKDMKey> imported_keys;
1376         BOOST_FOREACH (shared_ptr<Content> i, content()) {
1377                 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (i);
1378                 if (d && d->kdm()) {
1379                         dcp::DecryptedKDM kdm (d->kdm().get(), Config::instance()->decryption_chain()->key().get());
1380                         list<dcp::DecryptedKDMKey> keys = kdm.keys ();
1381                         copy (keys.begin(), keys.end(), back_inserter (imported_keys));
1382                 }
1383         }
1384
1385         map<shared_ptr<const dcp::ReelMXF>, dcp::Key> keys;
1386
1387         BOOST_FOREACH(shared_ptr<const dcp::ReelMXF> i, cpl->reel_mxfs()) {
1388                 if (!i->key_id()) {
1389                         continue;
1390                 }
1391
1392                 /* Get any imported key for this ID */
1393                 bool done = false;
1394                 BOOST_FOREACH (dcp::DecryptedKDMKey j, imported_keys) {
1395                         if (j.id() == i->key_id().get()) {
1396                                 LOG_GENERAL ("Using imported key for %1", i->key_id().get());
1397                                 keys[i] = j.key();
1398                                 done = true;
1399                         }
1400                 }
1401
1402                 if (!done) {
1403                         /* No imported key; it must be an asset that we encrypted */
1404                         LOG_GENERAL ("Using our own key for %1", i->key_id().get());
1405                         keys[i] = key();
1406                 }
1407         }
1408
1409         return dcp::DecryptedKDM (
1410                 cpl->id(), keys, from, until, cpl->content_title_text(), cpl->content_title_text(), dcp::LocalTime().as_string()
1411                 ).encrypt (signer, recipient, trusted_devices, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio);
1412 }
1413
1414 /** @param screens Screens to make KDMs for.
1415  *  @param cpl_file Path to CPL to make KDMs for.
1416  *  @param from KDM from time expressed as a local time in the time zone of the Screen's Cinema.
1417  *  @param until KDM to time expressed as a local time in the time zone of the Screen's Cinema.
1418  *  @param formulation KDM formulation to use.
1419  *  @param disable_forensic_marking_picture true to disable forensic marking of picture.
1420  *  @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio.  If set to 0,
1421  *  disable all forensic marking; if set above 0, disable forensic marking above that channel.
1422  */
1423 list<shared_ptr<ScreenKDM> >
1424 Film::make_kdms (
1425         list<shared_ptr<Screen> > screens,
1426         boost::filesystem::path cpl_file,
1427         boost::posix_time::ptime from,
1428         boost::posix_time::ptime until,
1429         dcp::Formulation formulation,
1430         bool disable_forensic_marking_picture,
1431         optional<int> disable_forensic_marking_audio
1432         ) const
1433 {
1434         list<shared_ptr<ScreenKDM> > kdms;
1435
1436         BOOST_FOREACH (shared_ptr<Screen> i, screens) {
1437                 if (i->recipient) {
1438                         dcp::EncryptedKDM const kdm = make_kdm (
1439                                 i->recipient.get(),
1440                                 i->trusted_device_thumbprints(),
1441                                 cpl_file,
1442                                 dcp::LocalTime (from,  i->cinema ? i->cinema->utc_offset_hour() : 0, i->cinema ? i->cinema->utc_offset_minute() : 0),
1443                                 dcp::LocalTime (until, i->cinema ? i->cinema->utc_offset_hour() : 0, i->cinema ? i->cinema->utc_offset_minute() : 0),
1444                                 formulation,
1445                                 disable_forensic_marking_picture,
1446                                 disable_forensic_marking_audio
1447                                 );
1448
1449                         kdms.push_back (shared_ptr<ScreenKDM>(new DCPScreenKDM(i, kdm)));
1450                 }
1451         }
1452
1453         return kdms;
1454 }
1455
1456 /** @return The approximate disk space required to encode a DCP of this film with the
1457  *  current settings, in bytes.
1458  */
1459 uint64_t
1460 Film::required_disk_space () const
1461 {
1462         return _playlist->required_disk_space (shared_from_this(), j2k_bandwidth(), audio_channels(), audio_frame_rate());
1463 }
1464
1465 /** This method checks the disk that the Film is on and tries to decide whether or not
1466  *  there will be enough space to make a DCP for it.  If so, true is returned; if not,
1467  *  false is returned and required and available are filled in with the amount of disk space
1468  *  required and available respectively (in GB).
1469  *
1470  *  Note: the decision made by this method isn't, of course, 100% reliable.
1471  */
1472 bool
1473 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1474 {
1475         /* Create a test file and see if we can hard-link it */
1476         boost::filesystem::path test = internal_video_asset_dir() / "test";
1477         boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1478         can_hard_link = true;
1479         FILE* f = fopen_boost (test, "w");
1480         if (f) {
1481                 fclose (f);
1482                 boost::system::error_code ec;
1483                 boost::filesystem::create_hard_link (test, test2, ec);
1484                 if (ec) {
1485                         can_hard_link = false;
1486                 }
1487                 boost::filesystem::remove (test);
1488                 boost::filesystem::remove (test2);
1489         }
1490
1491         boost::filesystem::space_info s = boost::filesystem::space (internal_video_asset_dir ());
1492         required = double (required_disk_space ()) / 1073741824.0f;
1493         if (!can_hard_link) {
1494                 required *= 2;
1495         }
1496         available = double (s.available) / 1073741824.0f;
1497         return (available - required) > 1;
1498 }
1499
1500 string
1501 Film::subtitle_language () const
1502 {
1503         set<string> languages;
1504
1505         BOOST_FOREACH (shared_ptr<Content> i, content()) {
1506                 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
1507                         languages.insert (j->language ());
1508                 }
1509         }
1510
1511         string all;
1512         BOOST_FOREACH (string s, languages) {
1513                 if (!all.empty ()) {
1514                         all += "/" + s;
1515                 } else {
1516                         all += s;
1517                 }
1518         }
1519
1520         return all;
1521 }
1522
1523 /** @return The names of the channels that audio contents' outputs are passed into;
1524  *  this is either the DCP or a AudioProcessor.
1525  */
1526 vector<string>
1527 Film::audio_output_names () const
1528 {
1529         if (audio_processor ()) {
1530                 return audio_processor()->input_names ();
1531         }
1532
1533         DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1534
1535         vector<string> n;
1536
1537         for (int i = 0; i < audio_channels(); ++i) {
1538                 n.push_back (short_audio_channel_name (i));
1539         }
1540
1541         return n;
1542 }
1543
1544 void
1545 Film::repeat_content (ContentList c, int n)
1546 {
1547         _playlist->repeat (shared_from_this(), c, n);
1548 }
1549
1550 void
1551 Film::remove_content (ContentList c)
1552 {
1553         _playlist->remove (c);
1554 }
1555
1556 void
1557 Film::audio_analysis_finished ()
1558 {
1559         /* XXX */
1560 }
1561
1562 list<DCPTimePeriod>
1563 Film::reels () const
1564 {
1565         list<DCPTimePeriod> p;
1566         DCPTime const len = length();
1567
1568         switch (reel_type ()) {
1569         case REELTYPE_SINGLE:
1570                 p.push_back (DCPTimePeriod (DCPTime (), len));
1571                 break;
1572         case REELTYPE_BY_VIDEO_CONTENT:
1573         {
1574                 optional<DCPTime> last_split;
1575                 shared_ptr<Content> last_video;
1576                 BOOST_FOREACH (shared_ptr<Content> c, content ()) {
1577                         if (c->video) {
1578                                 BOOST_FOREACH (DCPTime t, c->reel_split_points(shared_from_this())) {
1579                                         if (last_split) {
1580                                                 p.push_back (DCPTimePeriod (last_split.get(), t));
1581                                         }
1582                                         last_split = t;
1583                                 }
1584                                 last_video = c;
1585                         }
1586                 }
1587
1588                 DCPTime video_end = last_video ? last_video->end(shared_from_this()) : DCPTime(0);
1589                 if (last_split) {
1590                         /* Definitely go from the last split to the end of the video content */
1591                         p.push_back (DCPTimePeriod (last_split.get(), video_end));
1592                 }
1593
1594                 if (video_end < len) {
1595                         /* And maybe go after that as well if there is any non-video hanging over the end */
1596                         p.push_back (DCPTimePeriod (video_end, len));
1597                 }
1598                 break;
1599         }
1600         case REELTYPE_BY_LENGTH:
1601         {
1602                 DCPTime current;
1603                 /* Integer-divide reel length by the size of one frame to give the number of frames per reel */
1604                 Frame const reel_in_frames = _reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8);
1605                 while (current < len) {
1606                         DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1607                         p.push_back (DCPTimePeriod (current, end));
1608                         current = end;
1609                 }
1610                 break;
1611         }
1612         }
1613
1614         return p;
1615 }
1616
1617 /** @param period A period within the DCP
1618  *  @return Name of the content which most contributes to the given period.
1619  */
1620 string
1621 Film::content_summary (DCPTimePeriod period) const
1622 {
1623         return _playlist->content_summary (shared_from_this(), period);
1624 }
1625
1626 void
1627 Film::use_template (string name)
1628 {
1629         _template_film.reset (new Film (optional<boost::filesystem::path>()));
1630         _template_film->read_metadata (Config::instance()->template_path (name));
1631         _use_isdcf_name = _template_film->_use_isdcf_name;
1632         _dcp_content_type = _template_film->_dcp_content_type;
1633         _container = _template_film->_container;
1634         _resolution = _template_film->_resolution;
1635         _j2k_bandwidth = _template_film->_j2k_bandwidth;
1636         _video_frame_rate = _template_film->_video_frame_rate;
1637         _signed = _template_film->_signed;
1638         _encrypted = _template_film->_encrypted;
1639         _audio_channels = _template_film->_audio_channels;
1640         _sequence = _template_film->_sequence;
1641         _three_d = _template_film->_three_d;
1642         _interop = _template_film->_interop;
1643         _audio_processor = _template_film->_audio_processor;
1644         _reel_type = _template_film->_reel_type;
1645         _reel_length = _template_film->_reel_length;
1646         _upload_after_make_dcp = _template_film->_upload_after_make_dcp;
1647         _isdcf_metadata = _template_film->_isdcf_metadata;
1648 }
1649
1650 pair<double, double>
1651 Film::speed_up_range (int dcp_frame_rate) const
1652 {
1653         return _playlist->speed_up_range (dcp_frame_rate);
1654 }
1655
1656 void
1657 Film::copy_from (shared_ptr<const Film> film)
1658 {
1659         read_metadata (film->file (metadata_file));
1660 }
1661
1662 bool
1663 Film::references_dcp_video () const
1664 {
1665         BOOST_FOREACH (shared_ptr<Content> i, _playlist->content()) {
1666                 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent>(i);
1667                 if (d && d->reference_video()) {
1668                         return true;
1669                 }
1670         }
1671
1672         return false;
1673 }
1674
1675 bool
1676 Film::references_dcp_audio () const
1677 {
1678         BOOST_FOREACH (shared_ptr<Content> i, _playlist->content()) {
1679                 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent>(i);
1680                 if (d && d->reference_audio()) {
1681                         return true;
1682                 }
1683         }
1684
1685         return false;
1686 }
1687
1688 list<DCPTextTrack>
1689 Film::closed_caption_tracks () const
1690 {
1691         list<DCPTextTrack> tt;
1692         BOOST_FOREACH (shared_ptr<Content> i, content()) {
1693                 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
1694                         /* XXX: Empty DCPTextTrack ends up being a magic value here - the "unknown" or "not specified" track */
1695                         DCPTextTrack dtt = j->dcp_track().get_value_or(DCPTextTrack());
1696                         if (j->type() == TEXT_CLOSED_CAPTION && find(tt.begin(), tt.end(), dtt) == tt.end()) {
1697                                 tt.push_back (dtt);
1698                         }
1699                 }
1700         }
1701
1702         return tt;
1703 }
1704
1705 void
1706 Film::set_marker (dcp::Marker type, DCPTime time)
1707 {
1708         ChangeSignaller<Film> ch (this, MARKERS);
1709         _markers[type] = time;
1710 }
1711
1712 void
1713 Film::unset_marker (dcp::Marker type)
1714 {
1715         ChangeSignaller<Film> ch (this, MARKERS);
1716         _markers.erase (type);
1717 }
1718
1719 void
1720 Film::set_ratings (vector<dcp::Rating> r)
1721 {
1722         ChangeSignaller<Film> ch (this, RATINGS);
1723         _ratings = r;
1724 }
1725
1726 optional<DCPTime>
1727 Film::marker (dcp::Marker type) const
1728 {
1729         map<dcp::Marker, DCPTime>::const_iterator i = _markers.find (type);
1730         if (i == _markers.end()) {
1731                 return optional<DCPTime>();
1732         }
1733         return i->second;
1734 }