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