src/lib/film.cc

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