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