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