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