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                 if (!dm.subtitle_language.empty()) {
 726
 727                         /* I'm not clear on the precise details of the convention for CCAP labelling;
 728                            for now I'm just appending -CCAP if we have any closed captions.
 729                         */
 730
 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() && !j->burn()) {
 736                                                 burnt_in = false;
 737                                         } else if (j->type() == TEXT_CLOSED_CAPTION) {
 738                                                 ccap = true;
 739                                         }
 740                                 }
 741                         }
 742
 743                         string language = dm.subtitle_language;
 744                         if (burnt_in && language != "XX") {
 745                                 transform (language.begin(), language.end(), language.begin(), ::tolower);
 746                         } else {
 747                                 transform (language.begin(), language.end(), language.begin(), ::toupper);
 748                         }
 749
 750                         d += "-" + language;
 751                         if (ccap) {
 752                                 d += "-CCAP";
 753                         }
 754                 } else {
 755                         d += "-XX";
 756                 }
 757         }
 758
 759         if (!dm.territory.empty ()) {
 760                 d += "_" + dm.territory;
 761                 if (dm.rating.empty ()) {
 762                         d += "-NR";
 763                 } else {
 764                         d += "-" + dm.rating;
 765                 }
 766         }
 767
 768         /* Count mapped audio channels */
 769
 770         pair<int, int> ch = audio_channel_types (mapped_audio_channels(), audio_channels());
 771         if (!ch.first && !ch.second) {
 772                 d += "_MOS";
 773         } else if (ch.first) {
 774                 d += String::compose("_%1%2", ch.first, ch.second);
 775         }
 776
 777         /* XXX: HI/VI */
 778
 779         d += "_" + resolution_to_string (_resolution);
 780
 781         if (!dm.studio.empty ()) {
 782                 d += "_" + dm.studio;
 783         }
 784
 785         if (if_created_now) {
 786                 d += "_" + boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
 787         } else {
 788                 d += "_" + boost::gregorian::to_iso_string (_isdcf_date);
 789         }
 790
 791         if (!dm.facility.empty ()) {
 792                 d += "_" + dm.facility;
 793         }
 794
 795         if (_interop) {
 796                 d += "_IOP";
 797         } else {
 798                 d += "_SMPTE";
 799         }
 800
 801         if (three_d ()) {
 802                 d += "-3D";
 803         }
 804
 805         bool vf = false;
 806         BOOST_FOREACH (shared_ptr<Content> i, content ()) {
 807                 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (i);
 808                 if (!dc) {
 809                         continue;
 810                 }
 811
 812                 bool any_text = false;
 813                 for (int i = 0; i < TEXT_COUNT; ++i) {
 814                         if (dc->reference_text(static_cast<TextType>(i))) {
 815                                 any_text = true;
 816                         }
 817                 }
 818                 if (dc->reference_video() || dc->reference_audio() || any_text) {
 819                         vf = true;
 820                 }
 821         }
 822
 823         if (vf) {
 824                 d += "_VF";
 825         } else {
 826                 d += "_OV";
 827         }
 828
 829         return d;
 830 }
 831
 832 /** @return name to give the DCP */
 833 string
 834 Film::dcp_name (bool if_created_now) const
 835 {
 836         string unfiltered;
 837         if (use_isdcf_name()) {
 838                 return careful_string_filter (isdcf_name (if_created_now));
 839         }
 840
 841         return careful_string_filter (name ());
 842 }
 843
 844 void
 845 Film::set_directory (boost::filesystem::path d)
 846 {
 847         _directory = d;
 848         _dirty = true;
 849 }
 850
 851 void
 852 Film::set_name (string n)
 853 {
 854         ChangeSignaller<Film> ch (this, NAME);
 855         _name = n;
 856 }
 857
 858 void
 859 Film::set_use_isdcf_name (bool u)
 860 {
 861         ChangeSignaller<Film> ch (this, USE_ISDCF_NAME);
 862         _use_isdcf_name = u;
 863 }
 864
 865 void
 866 Film::set_dcp_content_type (DCPContentType const * t)
 867 {
 868         ChangeSignaller<Film> ch (this, DCP_CONTENT_TYPE);
 869         _dcp_content_type = t;
 870 }
 871
 872 void
 873 Film::set_container (Ratio const * c)
 874 {
 875         ChangeSignaller<Film> ch (this, CONTAINER);
 876         _container = c;
 877 }
 878
 879 void
 880 Film::set_resolution (Resolution r)
 881 {
 882         ChangeSignaller<Film> ch (this, RESOLUTION);
 883         _resolution = r;
 884 }
 885
 886 void
 887 Film::set_j2k_bandwidth (int b)
 888 {
 889         ChangeSignaller<Film> ch (this, J2K_BANDWIDTH);
 890         _j2k_bandwidth = b;
 891 }
 892
 893 void
 894 Film::set_isdcf_metadata (ISDCFMetadata m)
 895 {
 896         ChangeSignaller<Film> ch (this, ISDCF_METADATA);
 897         _isdcf_metadata = m;
 898 }
 899
 900 /** @param f New frame rate.
 901  *  @param user_explicit true if this comes from a direct user instruction, false if it is from
 902  *  DCP-o-matic being helpful.
 903  */
 904 void
 905 Film::set_video_frame_rate (int f, bool user_explicit)
 906 {
 907         ChangeSignaller<Film> ch (this, VIDEO_FRAME_RATE);
 908         _video_frame_rate = f;
 909         if (user_explicit) {
 910                 _user_explicit_video_frame_rate = true;
 911         }
 912 }
 913
 914 void
 915 Film::set_audio_channels (int c)
 916 {
 917         ChangeSignaller<Film> ch (this, AUDIO_CHANNELS);
 918         _audio_channels = c;
 919 }
 920
 921 void
 922 Film::set_three_d (bool t)
 923 {
 924         ChangeSignaller<Film> ch (this, THREE_D);
 925         _three_d = t;
 926
 927         if (_three_d && _isdcf_metadata.two_d_version_of_three_d) {
 928                 ChangeSignaller<Film> ch (this, ISDCF_METADATA);
 929                 _isdcf_metadata.two_d_version_of_three_d = false;
 930         }
 931 }
 932
 933 void
 934 Film::set_interop (bool i)
 935 {
 936         ChangeSignaller<Film> ch (this, INTEROP);
 937         _interop = i;
 938 }
 939
 940 void
 941 Film::set_audio_processor (AudioProcessor const * processor)
 942 {
 943         ChangeSignaller<Film> ch1 (this, AUDIO_PROCESSOR);
 944         ChangeSignaller<Film> ch2 (this, AUDIO_CHANNELS);
 945         _audio_processor = processor;
 946 }
 947
 948 void
 949 Film::set_reel_type (ReelType t)
 950 {
 951         ChangeSignaller<Film> ch (this, REEL_TYPE);
 952         _reel_type = t;
 953 }
 954
 955 /** @param r Desired reel length in bytes */
 956 void
 957 Film::set_reel_length (int64_t r)
 958 {
 959         ChangeSignaller<Film> ch (this, REEL_LENGTH);
 960         _reel_length = r;
 961 }
 962
 963 void
 964 Film::set_upload_after_make_dcp (bool u)
 965 {
 966         ChangeSignaller<Film> ch (this, UPLOAD_AFTER_MAKE_DCP);
 967         _upload_after_make_dcp = u;
 968 }
 969
 970 void
 971 Film::set_reencode_j2k (bool r)
 972 {
 973         ChangeSignaller<Film> ch (this, REENCODE_J2K);
 974         _reencode_j2k = r;
 975 }
 976
 977 void
 978 Film::signal_change (ChangeType type, int p)
 979 {
 980         signal_change (type, static_cast<Property>(p));
 981 }
 982
 983 void
 984 Film::signal_change (ChangeType type, Property p)
 985 {
 986         if (type == CHANGE_TYPE_DONE) {
 987                 _dirty = true;
 988
 989                 if (p == Film::CONTENT) {
 990                         if (!_user_explicit_video_frame_rate) {
 991                                 set_video_frame_rate (best_video_frame_rate());
 992                         }
 993                 }
 994
 995                 emit (boost::bind (boost::ref (Change), type, p));
 996
 997                 if (p == Film::VIDEO_FRAME_RATE || p == Film::SEQUENCE) {
 998                         /* We want to call Playlist::maybe_sequence but this must happen after the
 999                            main signal emission (since the butler will see that emission and un-suspend itself).
1000                         */
1001                         emit (boost::bind(&Playlist::maybe_sequence, _playlist.get(), shared_from_this()));
1002                 }
1003         } else {
1004                 Change (type, p);
1005         }
1006 }
1007
1008 void
1009 Film::set_isdcf_date_today ()
1010 {
1011         _isdcf_date = boost::gregorian::day_clock::local_day ();
1012 }
1013
1014 boost::filesystem::path
1015 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
1016 {
1017         boost::filesystem::path p;
1018         p /= "j2c";
1019         p /= video_identifier ();
1020
1021         char buffer[256];
1022         snprintf(buffer, sizeof(buffer), "%08d_%08" PRId64, reel, frame);
1023         string s (buffer);
1024
1025         if (eyes == EYES_LEFT) {
1026                 s += ".L";
1027         } else if (eyes == EYES_RIGHT) {
1028                 s += ".R";
1029         }
1030
1031         s += ".j2c";
1032
1033         if (tmp) {
1034                 s += ".tmp";
1035         }
1036
1037         p /= s;
1038         return file (p);
1039 }
1040
1041 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs */
1042 vector<CPLSummary>
1043 Film::cpls () const
1044 {
1045         if (!directory ()) {
1046                 return vector<CPLSummary> ();
1047         }
1048
1049         vector<CPLSummary> out;
1050
1051         boost::filesystem::path const dir = directory().get();
1052         for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
1053                 if (
1054                         boost::filesystem::is_directory (*i) &&
1055                         i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
1056                         ) {
1057
1058                         try {
1059                                 out.push_back (CPLSummary(*i));
1060                         } catch (...) {
1061
1062                         }
1063                 }
1064         }
1065
1066         return out;
1067 }
1068
1069 void
1070 Film::set_signed (bool s)
1071 {
1072         ChangeSignaller<Film> ch (this, SIGNED);
1073         _signed = s;
1074 }
1075
1076 void
1077 Film::set_encrypted (bool e)
1078 {
1079         ChangeSignaller<Film> ch (this, ENCRYPTED);
1080         _encrypted = e;
1081 }
1082
1083 void
1084 Film::set_key (dcp::Key key)
1085 {
1086         ChangeSignaller<Film> ch (this, KEY);
1087         _key = key;
1088 }
1089
1090 ContentList
1091 Film::content () const
1092 {
1093         return _playlist->content ();
1094 }
1095
1096 /** @param content Content to add.
1097  *  @param disable_audio_analysis true to never do automatic audio analysis, even if it is enabled in configuration.
1098  */
1099 void
1100 Film::examine_and_add_content (shared_ptr<Content> content, bool disable_audio_analysis)
1101 {
1102         if (dynamic_pointer_cast<FFmpegContent> (content) && _directory) {
1103                 run_ffprobe (content->path(0), file("ffprobe.log"));
1104         }
1105
1106         shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), content));
1107
1108         _job_connections.push_back (
1109                 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job>(j), weak_ptr<Content>(content), disable_audio_analysis))
1110                 );
1111
1112         JobManager::instance()->add (j);
1113 }
1114
1115 void
1116 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c, bool disable_audio_analysis)
1117 {
1118         shared_ptr<Job> job = j.lock ();
1119         if (!job || !job->finished_ok ()) {
1120                 return;
1121         }
1122
1123         shared_ptr<Content> content = c.lock ();
1124         if (!content) {
1125                 return;
1126         }
1127
1128         add_content (content);
1129
1130         if (Config::instance()->automatic_audio_analysis() && content->audio && !disable_audio_analysis) {
1131                 shared_ptr<Playlist> playlist (new Playlist);
1132                 playlist->add (shared_from_this(), content);
1133                 boost::signals2::connection c;
1134                 JobManager::instance()->analyse_audio (
1135                         shared_from_this(), playlist, false, c, bind (&Film::audio_analysis_finished, this)
1136                         );
1137                 _audio_analysis_connections.push_back (c);
1138         }
1139 }
1140
1141 void
1142 Film::add_content (shared_ptr<Content> c)
1143 {
1144         /* Add {video,subtitle} content after any existing {video,subtitle} content */
1145         if (c->video) {
1146                 c->set_position (shared_from_this(), _playlist->video_end(shared_from_this()));
1147         } else if (!c->text.empty()) {
1148                 c->set_position (shared_from_this(), _playlist->text_end(shared_from_this()));
1149         }
1150
1151         if (_template_film) {
1152                 /* Take settings from the first piece of content of c's type in _template */
1153                 BOOST_FOREACH (shared_ptr<Content> i, _template_film->content()) {
1154                         c->take_settings_from (i);
1155                 }
1156         }
1157
1158         _playlist->add (shared_from_this(), c);
1159 }
1160
1161 void
1162 Film::remove_content (shared_ptr<Content> c)
1163 {
1164         _playlist->remove (c);
1165 }
1166
1167 void
1168 Film::move_content_earlier (shared_ptr<Content> c)
1169 {
1170         _playlist->move_earlier (shared_from_this(), c);
1171 }
1172
1173 void
1174 Film::move_content_later (shared_ptr<Content> c)
1175 {
1176         _playlist->move_later (shared_from_this(), c);
1177 }
1178
1179 /** @return length of the film from time 0 to the last thing on the playlist */
1180 DCPTime
1181 Film::length () const
1182 {
1183         return _playlist->length(shared_from_this()).ceil(video_frame_rate());
1184 }
1185
1186 int
1187 Film::best_video_frame_rate () const
1188 {
1189         /* Don't default to anything above 30fps (make the user select that explicitly) */
1190         int best = _playlist->best_video_frame_rate ();
1191         if (best > 30) {
1192                 best /= 2;
1193         }
1194         return best;
1195 }
1196
1197 FrameRateChange
1198 Film::active_frame_rate_change (DCPTime t) const
1199 {
1200         return _playlist->active_frame_rate_change (t, video_frame_rate ());
1201 }
1202
1203 void
1204 Film::playlist_content_change (ChangeType type, weak_ptr<Content> c, int p, bool frequent)
1205 {
1206         if (p == ContentProperty::VIDEO_FRAME_RATE) {
1207                 signal_change (type, Film::CONTENT);
1208         } else if (p == AudioContentProperty::STREAMS) {
1209                 signal_change (type, Film::NAME);
1210         }
1211
1212         if (type == CHANGE_TYPE_DONE) {
1213                 emit (boost::bind (boost::ref (ContentChange), type, c, p, frequent));
1214         } else {
1215                 ContentChange (type, c, p, frequent);
1216         }
1217 }
1218
1219 void
1220 Film::playlist_change (ChangeType type)
1221 {
1222         signal_change (type, CONTENT);
1223         signal_change (type, NAME);
1224
1225         if (type == CHANGE_TYPE_DONE) {
1226                 /* Check that this change hasn't made our settings inconsistent */
1227                 bool change_made = false;
1228                 BOOST_FOREACH (shared_ptr<Content> i, content()) {
1229                         shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent>(i);
1230                         if (!d) {
1231                                 continue;
1232                         }
1233
1234                         string why_not;
1235                         if (d->reference_video() && !d->can_reference_video(shared_from_this(), why_not)) {
1236                                 d->set_reference_video(false);
1237                                 change_made = true;
1238                         }
1239                         if (d->reference_audio() && !d->can_reference_audio(shared_from_this(), why_not)) {
1240                                 d->set_reference_audio(false);
1241                                 change_made = true;
1242                         }
1243                 }
1244
1245                 if (change_made) {
1246                         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."));
1247                 }
1248         }
1249 }
1250
1251 void
1252 Film::playlist_order_changed ()
1253 {
1254         /* XXX: missing PENDING */
1255         signal_change (CHANGE_TYPE_DONE, CONTENT_ORDER);
1256 }
1257
1258 int
1259 Film::audio_frame_rate () const
1260 {
1261         /* It seems that nobody makes 96kHz DCPs at the moment, so let's avoid them.
1262            See #1436.
1263         */
1264         return 48000;
1265 }
1266
1267 void
1268 Film::set_sequence (bool s)
1269 {
1270         if (s == _sequence) {
1271                 return;
1272         }
1273
1274         ChangeSignaller<Film> cc (this, SEQUENCE);
1275         _sequence = s;
1276         _playlist->set_sequence (s);
1277 }
1278
1279 /** @return Size of the largest possible image in whatever resolution we are using */
1280 dcp::Size
1281 Film::full_frame () const
1282 {
1283         switch (_resolution) {
1284         case RESOLUTION_2K:
1285                 return dcp::Size (2048, 1080);
1286         case RESOLUTION_4K:
1287                 return dcp::Size (4096, 2160);
1288         }
1289
1290         DCPOMATIC_ASSERT (false);
1291         return dcp::Size ();
1292 }
1293
1294 /** @return Size of the frame */
1295 dcp::Size
1296 Film::frame_size () const
1297 {
1298         return fit_ratio_within (container()->ratio(), full_frame ());
1299 }
1300
1301 /** @param recipient KDM recipient certificate.
1302  *  @param trusted_devices Certificate thumbprints of other trusted devices (can be empty).
1303  *  @param cpl_file CPL filename.
1304  *  @param from KDM from time expressed as a local time with an offset from UTC.
1305  *  @param until KDM to time expressed as a local time with an offset from UTC.
1306  *  @param formulation KDM formulation to use.
1307  *  @param disable_forensic_marking_picture true to disable forensic marking of picture.
1308  *  @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio.  If set to 0,
1309  *  disable all forensic marking; if set above 0, disable forensic marking above that channel.
1310  */
1311 dcp::EncryptedKDM
1312 Film::make_kdm (
1313         dcp::Certificate recipient,
1314         vector<string> trusted_devices,
1315         boost::filesystem::path cpl_file,
1316         dcp::LocalTime from,
1317         dcp::LocalTime until,
1318         dcp::Formulation formulation,
1319         bool disable_forensic_marking_picture,
1320         optional<int> disable_forensic_marking_audio
1321         ) const
1322 {
1323         if (!_encrypted) {
1324                 throw runtime_error (_("Cannot make a KDM as this project is not encrypted."));
1325         }
1326
1327         shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
1328         shared_ptr<const dcp::CertificateChain> signer = Config::instance()->signer_chain ();
1329         if (!signer->valid ()) {
1330                 throw InvalidSignerError ();
1331         }
1332
1333         /* Find keys that have been added to imported, encrypted DCP content */
1334         list<dcp::DecryptedKDMKey> imported_keys;
1335         BOOST_FOREACH (shared_ptr<Content> i, content()) {
1336                 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (i);
1337                 if (d && d->kdm()) {
1338                         dcp::DecryptedKDM kdm (d->kdm().get(), Config::instance()->decryption_chain()->key().get());
1339                         list<dcp::DecryptedKDMKey> keys = kdm.keys ();
1340                         copy (keys.begin(), keys.end(), back_inserter (imported_keys));
1341                 }
1342         }
1343
1344         map<shared_ptr<const dcp::ReelMXF>, dcp::Key> keys;
1345
1346         BOOST_FOREACH(shared_ptr<const dcp::ReelAsset> i, cpl->reel_assets ()) {
1347                 shared_ptr<const dcp::ReelMXF> mxf = boost::dynamic_pointer_cast<const dcp::ReelMXF> (i);
1348                 if (!mxf || !mxf->key_id()) {
1349                         continue;
1350                 }
1351
1352                 /* Get any imported key for this ID */
1353                 bool done = false;
1354                 BOOST_FOREACH (dcp::DecryptedKDMKey j, imported_keys) {
1355                         if (j.id() == mxf->key_id().get()) {
1356                                 LOG_GENERAL ("Using imported key for %1", mxf->key_id().get());
1357                                 keys[mxf] = j.key();
1358                                 done = true;
1359                         }
1360                 }
1361
1362                 if (!done) {
1363                         /* No imported key; it must be an asset that we encrypted */
1364                         LOG_GENERAL ("Using our own key for %1", mxf->key_id().get());
1365                         keys[mxf] = key();
1366                 }
1367         }
1368
1369         return dcp::DecryptedKDM (
1370                 cpl->id(), keys, from, until, cpl->content_title_text(), cpl->content_title_text(), dcp::LocalTime().as_string()
1371                 ).encrypt (signer, recipient, trusted_devices, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio);
1372 }
1373
1374 /** @param screens Screens to make KDMs for.
1375  *  @param cpl_file Path to CPL to make KDMs for.
1376  *  @param from KDM from time expressed as a local time in the time zone of the Screen's Cinema.
1377  *  @param until KDM to time expressed as a local time in the time zone of the Screen's Cinema.
1378  *  @param formulation KDM formulation to use.
1379  *  @param disable_forensic_marking_picture true to disable forensic marking of picture.
1380  *  @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio.  If set to 0,
1381  *  disable all forensic marking; if set above 0, disable forensic marking above that channel.
1382  */
1383 list<ScreenKDM>
1384 Film::make_kdms (
1385         list<shared_ptr<Screen> > screens,
1386         boost::filesystem::path cpl_file,
1387         boost::posix_time::ptime from,
1388         boost::posix_time::ptime until,
1389         dcp::Formulation formulation,
1390         bool disable_forensic_marking_picture,
1391         optional<int> disable_forensic_marking_audio
1392         ) const
1393 {
1394         list<ScreenKDM> kdms;
1395
1396         BOOST_FOREACH (shared_ptr<Screen> i, screens) {
1397                 if (i->recipient) {
1398                         dcp::EncryptedKDM const kdm = make_kdm (
1399                                 i->recipient.get(),
1400                                 i->trusted_device_thumbprints(),
1401                                 cpl_file,
1402                                 dcp::LocalTime (from,  i->cinema ? i->cinema->utc_offset_hour() : 0, i->cinema ? i->cinema->utc_offset_minute() : 0),
1403                                 dcp::LocalTime (until, i->cinema ? i->cinema->utc_offset_hour() : 0, i->cinema ? i->cinema->utc_offset_minute() : 0),
1404                                 formulation,
1405                                 disable_forensic_marking_picture,
1406                                 disable_forensic_marking_audio
1407                                 );
1408
1409                         kdms.push_back (ScreenKDM (i, kdm));
1410                 }
1411         }
1412
1413         return kdms;
1414 }
1415
1416 /** @return The approximate disk space required to encode a DCP of this film with the
1417  *  current settings, in bytes.
1418  */
1419 uint64_t
1420 Film::required_disk_space () const
1421 {
1422         return _playlist->required_disk_space (shared_from_this(), j2k_bandwidth(), audio_channels(), audio_frame_rate());
1423 }
1424
1425 /** This method checks the disk that the Film is on and tries to decide whether or not
1426  *  there will be enough space to make a DCP for it.  If so, true is returned; if not,
1427  *  false is returned and required and available are filled in with the amount of disk space
1428  *  required and available respectively (in GB).
1429  *
1430  *  Note: the decision made by this method isn't, of course, 100% reliable.
1431  */
1432 bool
1433 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1434 {
1435         /* Create a test file and see if we can hard-link it */
1436         boost::filesystem::path test = internal_video_asset_dir() / "test";
1437         boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1438         can_hard_link = true;
1439         FILE* f = fopen_boost (test, "w");
1440         if (f) {
1441                 fclose (f);
1442                 boost::system::error_code ec;
1443                 boost::filesystem::create_hard_link (test, test2, ec);
1444                 if (ec) {
1445                         can_hard_link = false;
1446                 }
1447                 boost::filesystem::remove (test);
1448                 boost::filesystem::remove (test2);
1449         }
1450
1451         boost::filesystem::space_info s = boost::filesystem::space (internal_video_asset_dir ());
1452         required = double (required_disk_space ()) / 1073741824.0f;
1453         if (!can_hard_link) {
1454                 required *= 2;
1455         }
1456         available = double (s.available) / 1073741824.0f;
1457         return (available - required) > 1;
1458 }
1459
1460 string
1461 Film::subtitle_language () const
1462 {
1463         set<string> languages;
1464
1465         BOOST_FOREACH (shared_ptr<Content> i, content()) {
1466                 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
1467                         languages.insert (j->language ());
1468                 }
1469         }
1470
1471         string all;
1472         BOOST_FOREACH (string s, languages) {
1473                 if (!all.empty ()) {
1474                         all += "/" + s;
1475                 } else {
1476                         all += s;
1477                 }
1478         }
1479
1480         return all;
1481 }
1482
1483 /** @return The names of the channels that audio contents' outputs are passed into;
1484  *  this is either the DCP or a AudioProcessor.
1485  */
1486 vector<string>
1487 Film::audio_output_names () const
1488 {
1489         if (audio_processor ()) {
1490                 return audio_processor()->input_names ();
1491         }
1492
1493         DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1494
1495         vector<string> n;
1496
1497         for (int i = 0; i < audio_channels(); ++i) {
1498                 n.push_back (short_audio_channel_name (i));
1499         }
1500
1501         return n;
1502 }
1503
1504 void
1505 Film::repeat_content (ContentList c, int n)
1506 {
1507         _playlist->repeat (shared_from_this(), c, n);
1508 }
1509
1510 void
1511 Film::remove_content (ContentList c)
1512 {
1513         _playlist->remove (c);
1514 }
1515
1516 void
1517 Film::audio_analysis_finished ()
1518 {
1519         /* XXX */
1520 }
1521
1522 list<DCPTimePeriod>
1523 Film::reels () const
1524 {
1525         list<DCPTimePeriod> p;
1526         DCPTime const len = length();
1527
1528         switch (reel_type ()) {
1529         case REELTYPE_SINGLE:
1530                 p.push_back (DCPTimePeriod (DCPTime (), len));
1531                 break;
1532         case REELTYPE_BY_VIDEO_CONTENT:
1533         {
1534                 optional<DCPTime> last_split;
1535                 shared_ptr<Content> last_video;
1536                 BOOST_FOREACH (shared_ptr<Content> c, content ()) {
1537                         if (c->video) {
1538                                 BOOST_FOREACH (DCPTime t, c->reel_split_points(shared_from_this())) {
1539                                         if (last_split) {
1540                                                 p.push_back (DCPTimePeriod (last_split.get(), t));
1541                                         }
1542                                         last_split = t;
1543                                 }
1544                                 last_video = c;
1545                         }
1546                 }
1547
1548                 DCPTime video_end = last_video ? last_video->end(shared_from_this()) : DCPTime(0);
1549                 if (last_split) {
1550                         /* Definitely go from the last split to the end of the video content */
1551                         p.push_back (DCPTimePeriod (last_split.get(), video_end));
1552                 }
1553
1554                 if (video_end < len) {
1555                         /* And maybe go after that as well if there is any non-video hanging over the end */
1556                         p.push_back (DCPTimePeriod (video_end, len));
1557                 }
1558                 break;
1559         }
1560         case REELTYPE_BY_LENGTH:
1561         {
1562                 DCPTime current;
1563                 /* Integer-divide reel length by the size of one frame to give the number of frames per reel */
1564                 Frame const reel_in_frames = _reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8);
1565                 while (current < len) {
1566                         DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1567                         p.push_back (DCPTimePeriod (current, end));
1568                         current = end;
1569                 }
1570                 break;
1571         }
1572         }
1573
1574         return p;
1575 }
1576
1577 /** @param period A period within the DCP
1578  *  @return Name of the content which most contributes to the given period.
1579  */
1580 string
1581 Film::content_summary (DCPTimePeriod period) const
1582 {
1583         return _playlist->content_summary (shared_from_this(), period);
1584 }
1585
1586 void
1587 Film::use_template (string name)
1588 {
1589         _template_film.reset (new Film (optional<boost::filesystem::path>()));
1590         _template_film->read_metadata (Config::instance()->template_path (name));
1591         _use_isdcf_name = _template_film->_use_isdcf_name;
1592         _dcp_content_type = _template_film->_dcp_content_type;
1593         _container = _template_film->_container;
1594         _resolution = _template_film->_resolution;
1595         _j2k_bandwidth = _template_film->_j2k_bandwidth;
1596         _video_frame_rate = _template_film->_video_frame_rate;
1597         _signed = _template_film->_signed;
1598         _encrypted = _template_film->_encrypted;
1599         _audio_channels = _template_film->_audio_channels;
1600         _sequence = _template_film->_sequence;
1601         _three_d = _template_film->_three_d;
1602         _interop = _template_film->_interop;
1603         _audio_processor = _template_film->_audio_processor;
1604         _reel_type = _template_film->_reel_type;
1605         _reel_length = _template_film->_reel_length;
1606         _upload_after_make_dcp = _template_film->_upload_after_make_dcp;
1607         _isdcf_metadata = _template_film->_isdcf_metadata;
1608 }
1609
1610 pair<double, double>
1611 Film::speed_up_range (int dcp_frame_rate) const
1612 {
1613         return _playlist->speed_up_range (dcp_frame_rate);
1614 }
1615
1616 void
1617 Film::copy_from (shared_ptr<const Film> film)
1618 {
1619         read_metadata (film->file (metadata_file));
1620 }
1621
1622 bool
1623 Film::references_dcp_video () const
1624 {
1625         BOOST_FOREACH (shared_ptr<Content> i, _playlist->content()) {
1626                 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent>(i);
1627                 if (d && d->reference_video()) {
1628                         return true;
1629                 }
1630         }
1631
1632         return false;
1633 }
1634
1635 bool
1636 Film::references_dcp_audio () const
1637 {
1638         BOOST_FOREACH (shared_ptr<Content> i, _playlist->content()) {
1639                 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent>(i);
1640                 if (d && d->reference_audio()) {
1641                         return true;
1642                 }
1643         }
1644
1645         return false;
1646 }
1647
1648 list<DCPTextTrack>
1649 Film::closed_caption_tracks () const
1650 {
1651         list<DCPTextTrack> tt;
1652         BOOST_FOREACH (shared_ptr<Content> i, content()) {
1653                 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
1654                         /* XXX: Empty DCPTextTrack ends up being a magic value here */
1655                         DCPTextTrack dtt = j->dcp_track().get_value_or(DCPTextTrack());
1656                         if (j->type() == TEXT_CLOSED_CAPTION && find(tt.begin(), tt.end(), dtt) == tt.end()) {
1657                                 tt.push_back (dtt);
1658                         }
1659                 }
1660         }
1661
1662         return tt;
1663 }