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