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