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 "exceptions.h"
  36 #include "examine_content_job.h"
  37 #include "config.h"
  38 #include "playlist.h"
  39 #include "dcp_content_type.h"
  40 #include "ratio.h"
  41 #include "cross.h"
  42 #include "environment_info.h"
  43 #include "audio_processor.h"
  44 #include "digester.h"
  45 #include "compose.hpp"
  46 #include "screen.h"
  47 #include "audio_content.h"
  48 #include "video_content.h"
  49 #include "text_content.h"
  50 #include "ffmpeg_content.h"
  51 #include "dcp_content.h"
  52 #include "screen_kdm.h"
  53 #include "cinema.h"
  54 #include "change_signaller.h"
  55 #include "check_content_change_job.h"
  56 #include <libcxml/cxml.h>
  57 #include <dcp/cpl.h>
  58 #include <dcp/certificate_chain.h>
  59 #include <dcp/util.h>
  60 #include <dcp/local_time.h>
  61 #include <dcp/decrypted_kdm.h>
  62 #include <dcp/raw_convert.h>
  63 #include <dcp/reel_mxf.h>
  64 #include <dcp/reel_asset.h>
  65 #include <libxml++/libxml++.h>
  66 #include <boost/filesystem.hpp>
  67 #include <boost/algorithm/string.hpp>
  68 #include <boost/foreach.hpp>
  69 #include <boost/regex.hpp>
  70 #include <unistd.h>
  71 #include <stdexcept>
  72 #include <iostream>
  73 #include <algorithm>
  74 #include <cstdlib>
  75 #include <iomanip>
  76 #include <set>
  77
  78 #include "i18n.h"
  79
  80 using std::string;
  81 using std::pair;
  82 using std::vector;
  83 using std::setfill;
  84 using std::min;
  85 using std::max;
  86 using std::make_pair;
  87 using std::cout;
  88 using std::list;
  89 using std::set;
  90 using std::runtime_error;
  91 using std::copy;
  92 using std::back_inserter;
  93 using std::map;
  94 using boost::shared_ptr;
  95 using boost::weak_ptr;
  96 using boost::dynamic_pointer_cast;
  97 using boost::optional;
  98 using boost::is_any_of;
  99 using dcp::raw_convert;
 100
 101 #define LOG_GENERAL(...) log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
 102 #define LOG_GENERAL_NC(...) log()->log (__VA_ARGS__, LogEntry::TYPE_GENERAL);
 103
 104 string const Film::metadata_file = "metadata.xml";
 105
 106 /* 5 -> 6
 107  * AudioMapping XML changed.
 108  * 6 -> 7
 109  * Subtitle offset changed to subtitle y offset, and subtitle x offset added.
 110  * 7 -> 8
 111  * Use <Scale> tag in <VideoContent> rather than <Ratio>.
 112  * 8 -> 9
 113  * DCI -> ISDCF
 114  * 9 -> 10
 115  * Subtitle X and Y scale.
 116  *
 117  * Bumped to 32 for 2.0 branch; some times are expressed in Times rather
 118  * than frames now.
 119  *
 120  * 32 -> 33
 121  * Changed <Period> to <Subtitle> in FFmpegSubtitleStream
 122  * 33 -> 34
 123  * Content only contains audio/subtitle-related tags if those things
 124  * are present.
 125  * 34 -> 35
 126  * VideoFrameType in VideoContent is a string rather than an integer.
 127  * 35 -> 36
 128  * EffectColour rather than OutlineColour in Subtitle.
 129  * 36 -> 37
 130  * TextContent can be in a Caption tag, and some of the tag names
 131  * have had Subtitle prefixes or suffixes removed.
 132  */
 133 int const Film::current_state_version = 37;
 134
 135 /** Construct a Film object in a given directory.
 136  *
 137  *  @param dir Film directory.
 138  */
 139
 140 Film::Film (optional<boost::filesystem::path> dir)
 141         : _playlist (new Playlist)
 142         , _use_isdcf_name (true)
 143         , _dcp_content_type (Config::instance()->default_dcp_content_type ())
 144         , _container (Config::instance()->default_container ())
 145         , _resolution (RESOLUTION_2K)
 146         , _signed (true)
 147         , _encrypted (false)
 148         , _context_id (dcp::make_uuid ())
 149         , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
 150         , _isdcf_metadata (Config::instance()->default_isdcf_metadata ())
 151         , _video_frame_rate (24)
 152         , _audio_channels (Config::instance()->default_dcp_audio_channels ())
 153         , _three_d (false)
 154         , _sequence (true)
 155         , _interop (Config::instance()->default_interop ())
 156         , _audio_processor (0)
 157         , _reel_type (REELTYPE_SINGLE)
 158         , _reel_length (2000000000)
 159         , _upload_after_make_dcp (Config::instance()->default_upload_after_make_dcp())
 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         p /= digester.get ();
 293         return p;
 294 }
 295
 296 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
 297 void
 298 Film::make_dcp ()
 299 {
 300         if (dcp_name().find ("/") != string::npos) {
 301                 throw BadSettingError (_("name"), _("Cannot contain slashes"));
 302         }
 303
 304         if (container() == 0) {
 305                 throw MissingSettingError (_("container"));
 306         }
 307
 308         if (content().empty()) {
 309                 throw runtime_error (_("You must add some content to the DCP before creating it"));
 310         }
 311
 312         if (dcp_content_type() == 0) {
 313                 throw MissingSettingError (_("content type"));
 314         }
 315
 316         if (name().empty()) {
 317                 set_name ("DCP");
 318         }
 319
 320         BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
 321                 if (!i->paths_valid()) {
 322                         throw runtime_error (_("some of your content is missing"));
 323                 }
 324                 shared_ptr<const DCPContent> dcp = dynamic_pointer_cast<const DCPContent> (i);
 325                 if (dcp && dcp->needs_kdm()) {
 326                         throw runtime_error (_("Some of your content needs a KDM"));
 327                 }
 328                 if (dcp && dcp->needs_assets()) {
 329                         throw runtime_error (_("Some of your content needs an OV"));
 330                 }
 331         }
 332
 333         set_isdcf_date_today ();
 334
 335         BOOST_FOREACH (string i, environment_info ()) {
 336                 LOG_GENERAL_NC (i);
 337         }
 338
 339         BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
 340                 LOG_GENERAL ("Content: %1", i->technical_summary());
 341         }
 342         LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
 343         if (Config::instance()->only_servers_encode ()) {
 344                 LOG_GENERAL_NC ("0 threads: ONLY SERVERS SET TO ENCODE");
 345         } else {
 346                 LOG_GENERAL ("%1 threads", Config::instance()->master_encoding_threads());
 347         }
 348         LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
 349
 350         shared_ptr<TranscodeJob> tj (new TranscodeJob (shared_from_this()));
 351         tj->set_encoder (shared_ptr<Encoder> (new DCPEncoder (shared_from_this(), tj)));
 352         shared_ptr<CheckContentChangeJob> cc (new CheckContentChangeJob (shared_from_this(), tj));
 353         JobManager::instance()->add (cc);
 354 }
 355
 356 /** Start a job to send our DCP to the configured TMS */
 357 void
 358 Film::send_dcp_to_tms ()
 359 {
 360         shared_ptr<Job> j (new UploadJob (shared_from_this()));
 361         JobManager::instance()->add (j);
 362 }
 363
 364 shared_ptr<xmlpp::Document>
 365 Film::metadata (bool with_content_paths) const
 366 {
 367         shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
 368         xmlpp::Element* root = doc->create_root_node ("Metadata");
 369
 370         root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
 371         root->add_child("Name")->add_child_text (_name);
 372         root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
 373
 374         if (_dcp_content_type) {
 375                 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
 376         }
 377
 378         if (_container) {
 379                 root->add_child("Container")->add_child_text (_container->id ());
 380         }
 381
 382         root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
 383         root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
 384         _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
 385         root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
 386         root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
 387         root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
 388         root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
 389         root->add_child("Sequence")->add_child_text (_sequence ? "1" : "0");
 390         root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
 391         root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
 392         root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
 393         root->add_child("Key")->add_child_text (_key.hex ());
 394         root->add_child("ContextID")->add_child_text (_context_id);
 395         if (_audio_processor) {
 396                 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
 397         }
 398         root->add_child("ReelType")->add_child_text (raw_convert<string> (static_cast<int> (_reel_type)));
 399         root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
 400         root->add_child("UploadAfterMakeDCP")->add_child_text (_upload_after_make_dcp ? "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
 516         list<string> notes;
 517         /* This method is the only one that can return notes (so far) */
 518         _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
 519
 520         /* Write backtraces to this film's directory, until another film is loaded */
 521         if (_directory) {
 522                 set_backtrace_file (file ("backtrace.txt"));
 523         }
 524
 525         _dirty = false;
 526         return notes;
 527 }
 528
 529 /** Given a directory name, return its full path within the Film's directory.
 530  *  @param d directory name within the Film's directory.
 531  *  @param create true to create the directory (and its parents) if they do not exist.
 532  */
 533 boost::filesystem::path
 534 Film::dir (boost::filesystem::path d, bool create) const
 535 {
 536         DCPOMATIC_ASSERT (_directory);
 537
 538         boost::filesystem::path p;
 539         p /= _directory.get();
 540         p /= d;
 541
 542         if (create) {
 543                 boost::filesystem::create_directories (p);
 544         }
 545
 546         return p;
 547 }
 548
 549 /** Given a file or directory name, return its full path within the Film's directory.
 550  *  Any required parent directories will be created.
 551  */
 552 boost::filesystem::path
 553 Film::file (boost::filesystem::path f) const
 554 {
 555         DCPOMATIC_ASSERT (_directory);
 556
 557         boost::filesystem::path p;
 558         p /= _directory.get();
 559         p /= f;
 560
 561         boost::filesystem::create_directories (p.parent_path ());
 562
 563         return p;
 564 }
 565
 566 list<int>
 567 Film::mapped_audio_channels () const
 568 {
 569         list<int> mapped;
 570
 571         if (audio_processor ()) {
 572                 /* Processors are mapped 1:1 to DCP outputs so we can work out mappings from there */
 573                 for (int i = 0; i < audio_processor()->out_channels(); ++i) {
 574                         mapped.push_back (i);
 575                 }
 576         } else {
 577                 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
 578                         if (i->audio) {
 579                                 list<int> c = i->audio->mapping().mapped_output_channels ();
 580                                 copy (c.begin(), c.end(), back_inserter (mapped));
 581                         }
 582                 }
 583
 584                 mapped.sort ();
 585                 mapped.unique ();
 586         }
 587
 588         return mapped;
 589 }
 590
 591 /** @return a ISDCF-compliant name for a DCP of this film */
 592 string
 593 Film::isdcf_name (bool if_created_now) const
 594 {
 595         string d;
 596
 597         string raw_name = name ();
 598
 599         /* Split the raw name up into words */
 600         vector<string> words;
 601         split (words, raw_name, is_any_of (" _-"));
 602
 603         string fixed_name;
 604
 605         /* Add each word to fixed_name */
 606         for (vector<string>::const_iterator i = words.begin(); i != words.end(); ++i) {
 607                 string w = *i;
 608
 609                 /* First letter is always capitalised */
 610                 w[0] = toupper (w[0]);
 611
 612                 /* Count caps in w */
 613                 size_t caps = 0;
 614                 for (size_t i = 0; i < w.size(); ++i) {
 615                         if (isupper (w[i])) {
 616                                 ++caps;
 617                         }
 618                 }
 619
 620                 /* If w is all caps make the rest of it lower case, otherwise
 621                    leave it alone.
 622                 */
 623                 if (caps == w.size ()) {
 624                         for (size_t i = 1; i < w.size(); ++i) {
 625                                 w[i] = tolower (w[i]);
 626                         }
 627                 }
 628
 629                 for (size_t i = 0; i < w.size(); ++i) {
 630                         fixed_name += w[i];
 631                 }
 632         }
 633
 634         if (fixed_name.length() > 14) {
 635                 fixed_name = fixed_name.substr (0, 14);
 636         }
 637
 638         d += fixed_name;
 639
 640         if (dcp_content_type()) {
 641                 d += "_" + dcp_content_type()->isdcf_name();
 642                 d += "-" + raw_convert<string>(isdcf_metadata().content_version);
 643         }
 644
 645         ISDCFMetadata const dm = isdcf_metadata ();
 646
 647         if (dm.temp_version) {
 648                 d += "-Temp";
 649         }
 650
 651         if (dm.pre_release) {
 652                 d += "-Pre";
 653         }
 654
 655         if (dm.red_band) {
 656                 d += "-RedBand";
 657         }
 658
 659         if (!dm.chain.empty ()) {
 660                 d += "-" + dm.chain;
 661         }
 662
 663         if (three_d ()) {
 664                 d += "-3D";
 665         }
 666
 667         if (dm.two_d_version_of_three_d) {
 668                 d += "-2D";
 669         }
 670
 671         if (!dm.mastered_luminance.empty ()) {
 672                 d += "-" + dm.mastered_luminance;
 673         }
 674
 675         if (video_frame_rate() != 24) {
 676                 d += "-" + raw_convert<string>(video_frame_rate());
 677         }
 678
 679         if (container()) {
 680                 d += "_" + container()->isdcf_name();
 681         }
 682
 683         /* XXX: this uses the first bit of content only */
 684
 685         /* Interior aspect ratio.  The standard says we don't do this for trailers, for some strange reason */
 686         if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::TRAILER) {
 687                 Ratio const * content_ratio = 0;
 688                 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
 689                         if (i->video) {
 690                                 /* Here's the first piece of video content */
 691                                 if (i->video->scale().ratio ()) {
 692                                         content_ratio = i->video->scale().ratio ();
 693                                 } else {
 694                                         content_ratio = Ratio::from_ratio (i->video->size().ratio ());
 695                                 }
 696                                 break;
 697                         }
 698                 }
 699
 700                 if (content_ratio && content_ratio != container()) {
 701                         /* This needs to be the numeric version of the ratio, and ::id() is close enough */
 702                         d += "-" + content_ratio->id();
 703                 }
 704         }
 705
 706         if (!dm.audio_language.empty ()) {
 707                 d += "_" + dm.audio_language;
 708                 if (!dm.subtitle_language.empty()) {
 709
 710                         /* I'm not clear on the precise details of the convention for CCAP labelling;
 711                            for now I'm just appending -CCAP if we have any closed captions.
 712                         */
 713
 714                         bool burnt_in = true;
 715                         bool ccap = false;
 716                         BOOST_FOREACH (shared_ptr<Content> i, content()) {
 717                                 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
 718                                         if (j->type() == TEXT_OPEN_SUBTITLE && j->use() && !j->burn()) {
 719                                                 burnt_in = false;
 720                                         } else if (j->type() == TEXT_CLOSED_CAPTION) {
 721                                                 ccap = true;
 722                                         }
 723                                 }
 724                         }
 725
 726                         string language = dm.subtitle_language;
 727                         if (burnt_in && language != "XX") {
 728                                 transform (language.begin(), language.end(), language.begin(), ::tolower);
 729                         } else {
 730                                 transform (language.begin(), language.end(), language.begin(), ::toupper);
 731                         }
 732
 733                         d += "-" + language;
 734                         if (ccap) {
 735                                 d += "-CCAP";
 736                         }
 737                 } else {
 738                         d += "-XX";
 739                 }
 740         }
 741
 742         if (!dm.territory.empty ()) {
 743                 d += "_" + dm.territory;
 744                 if (dm.rating.empty ()) {
 745                         d += "-NR";
 746                 } else {
 747                         d += "-" + dm.rating;
 748                 }
 749         }
 750
 751         /* Count mapped audio channels */
 752
 753         pair<int, int> ch = audio_channel_types (mapped_audio_channels(), audio_channels());
 754         if (!ch.first && !ch.second) {
 755                 d += "_MOS";
 756         } else if (ch.first) {
 757                 d += String::compose("_%1%2", ch.first, ch.second);
 758         }
 759
 760         /* XXX: HI/VI */
 761
 762         d += "_" + resolution_to_string (_resolution);
 763
 764         if (!dm.studio.empty ()) {
 765                 d += "_" + dm.studio;
 766         }
 767
 768         if (if_created_now) {
 769                 d += "_" + boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
 770         } else {
 771                 d += "_" + boost::gregorian::to_iso_string (_isdcf_date);
 772         }
 773
 774         if (!dm.facility.empty ()) {
 775                 d += "_" + dm.facility;
 776         }
 777
 778         if (_interop) {
 779                 d += "_IOP";
 780         } else {
 781                 d += "_SMPTE";
 782         }
 783
 784         if (three_d ()) {
 785                 d += "-3D";
 786         }
 787
 788         bool vf = false;
 789         BOOST_FOREACH (shared_ptr<Content> i, content ()) {
 790                 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (i);
 791                 if (!dc) {
 792                         continue;
 793                 }
 794
 795                 bool any_text = false;
 796                 for (int i = 0; i < TEXT_COUNT; ++i) {
 797                         if (dc->reference_text(static_cast<TextType>(i))) {
 798                                 any_text = true;
 799                         }
 800                 }
 801                 if (dc->reference_video() || dc->reference_audio() || any_text) {
 802                         vf = true;
 803                 }
 804         }
 805
 806         if (vf) {
 807                 d += "_VF";
 808         } else {
 809                 d += "_OV";
 810         }
 811
 812         return d;
 813 }
 814
 815 /** @return name to give the DCP */
 816 string
 817 Film::dcp_name (bool if_created_now) const
 818 {
 819         string unfiltered;
 820         if (use_isdcf_name()) {
 821                 return careful_string_filter (isdcf_name (if_created_now));
 822         }
 823
 824         return careful_string_filter (name ());
 825 }
 826
 827 void
 828 Film::set_directory (boost::filesystem::path d)
 829 {
 830         _directory = d;
 831         _dirty = true;
 832 }
 833
 834 void
 835 Film::set_name (string n)
 836 {
 837         ChangeSignaller<Film> ch (this, NAME);
 838         _name = n;
 839 }
 840
 841 void
 842 Film::set_use_isdcf_name (bool u)
 843 {
 844         ChangeSignaller<Film> ch (this, USE_ISDCF_NAME);
 845         _use_isdcf_name = u;
 846 }
 847
 848 void
 849 Film::set_dcp_content_type (DCPContentType const * t)
 850 {
 851         ChangeSignaller<Film> ch (this, DCP_CONTENT_TYPE);
 852         _dcp_content_type = t;
 853 }
 854
 855 void
 856 Film::set_container (Ratio const * c)
 857 {
 858         ChangeSignaller<Film> ch (this, CONTAINER);
 859         _container = c;
 860 }
 861
 862 void
 863 Film::set_resolution (Resolution r)
 864 {
 865         ChangeSignaller<Film> ch (this, RESOLUTION);
 866         _resolution = r;
 867 }
 868
 869 void
 870 Film::set_j2k_bandwidth (int b)
 871 {
 872         ChangeSignaller<Film> ch (this, J2K_BANDWIDTH);
 873         _j2k_bandwidth = b;
 874 }
 875
 876 void
 877 Film::set_isdcf_metadata (ISDCFMetadata m)
 878 {
 879         ChangeSignaller<Film> ch (this, ISDCF_METADATA);
 880         _isdcf_metadata = m;
 881 }
 882
 883 void
 884 Film::set_video_frame_rate (int f)
 885 {
 886         ChangeSignaller<Film> ch (this, VIDEO_FRAME_RATE);
 887         _video_frame_rate = f;
 888 }
 889
 890 void
 891 Film::set_audio_channels (int c)
 892 {
 893         ChangeSignaller<Film> ch (this, AUDIO_CHANNELS);
 894         _audio_channels = c;
 895 }
 896
 897 void
 898 Film::set_three_d (bool t)
 899 {
 900         ChangeSignaller<Film> ch (this, THREE_D);
 901         _three_d = t;
 902
 903         if (_three_d && _isdcf_metadata.two_d_version_of_three_d) {
 904                 ChangeSignaller<Film> ch (this, ISDCF_METADATA);
 905                 _isdcf_metadata.two_d_version_of_three_d = false;
 906         }
 907 }
 908
 909 void
 910 Film::set_interop (bool i)
 911 {
 912         ChangeSignaller<Film> ch (this, INTEROP);
 913         _interop = i;
 914 }
 915
 916 void
 917 Film::set_audio_processor (AudioProcessor const * processor)
 918 {
 919         ChangeSignaller<Film> ch1 (this, AUDIO_PROCESSOR);
 920         ChangeSignaller<Film> ch2 (this, AUDIO_CHANNELS);
 921         _audio_processor = processor;
 922 }
 923
 924 void
 925 Film::set_reel_type (ReelType t)
 926 {
 927         ChangeSignaller<Film> ch (this, REEL_TYPE);
 928         _reel_type = t;
 929 }
 930
 931 /** @param r Desired reel length in bytes */
 932 void
 933 Film::set_reel_length (int64_t r)
 934 {
 935         ChangeSignaller<Film> ch (this, REEL_LENGTH);
 936         _reel_length = r;
 937 }
 938
 939 void
 940 Film::set_upload_after_make_dcp (bool u)
 941 {
 942         ChangeSignaller<Film> ch (this, UPLOAD_AFTER_MAKE_DCP);
 943         _upload_after_make_dcp = u;
 944 }
 945
 946 void
 947 Film::signal_change (ChangeType type, int p)
 948 {
 949         signal_change (type, static_cast<Property>(p));
 950 }
 951
 952 void
 953 Film::signal_change (ChangeType type, Property p)
 954 {
 955         if (type == CHANGE_TYPE_DONE) {
 956                 _dirty = true;
 957
 958                 if (p == Film::CONTENT) {
 959                         set_video_frame_rate (_playlist->best_video_frame_rate ());
 960                 }
 961
 962                 emit (boost::bind (boost::ref (Change), type, p));
 963
 964                 if (p == Film::VIDEO_FRAME_RATE || p == Film::SEQUENCE) {
 965                         /* We want to call Playlist::maybe_sequence but this must happen after the
 966                            main signal emission (since the butler will see that emission and un-suspend itself).
 967                         */
 968                         emit (boost::bind(&Playlist::maybe_sequence, _playlist.get()));
 969                 }
 970         } else {
 971                 Change (type, p);
 972         }
 973 }
 974
 975 void
 976 Film::set_isdcf_date_today ()
 977 {
 978         _isdcf_date = boost::gregorian::day_clock::local_day ();
 979 }
 980
 981 boost::filesystem::path
 982 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
 983 {
 984         boost::filesystem::path p;
 985         p /= "j2c";
 986         p /= video_identifier ();
 987
 988         char buffer[256];
 989         snprintf(buffer, sizeof(buffer), "%08d_%08" PRId64, reel, frame);
 990         string s (buffer);
 991
 992         if (eyes == EYES_LEFT) {
 993                 s += ".L";
 994         } else if (eyes == EYES_RIGHT) {
 995                 s += ".R";
 996         }
 997
 998         s += ".j2c";
 999
1000         if (tmp) {
1001                 s += ".tmp";
1002         }
1003
1004         p /= s;
1005         return file (p);
1006 }
1007
1008 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs */
1009 vector<CPLSummary>
1010 Film::cpls () const
1011 {
1012         if (!directory ()) {
1013                 return vector<CPLSummary> ();
1014         }
1015
1016         vector<CPLSummary> out;
1017
1018         boost::filesystem::path const dir = directory().get();
1019         for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
1020                 if (
1021                         boost::filesystem::is_directory (*i) &&
1022                         i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
1023                         ) {
1024
1025                         try {
1026                                 dcp::DCP dcp (*i);
1027                                 dcp.read ();
1028                                 DCPOMATIC_ASSERT (dcp.cpls().front()->file());
1029                                 out.push_back (
1030                                         CPLSummary (
1031                                                 i->path().leaf().string(),
1032                                                 dcp.cpls().front()->id(),
1033                                                 dcp.cpls().front()->annotation_text(),
1034                                                 dcp.cpls().front()->file().get()
1035                                                 )
1036                                         );
1037                         } catch (...) {
1038
1039                         }
1040                 }
1041         }
1042
1043         return out;
1044 }
1045
1046 void
1047 Film::set_signed (bool s)
1048 {
1049         ChangeSignaller<Film> ch (this, SIGNED);
1050         _signed = s;
1051 }
1052
1053 void
1054 Film::set_encrypted (bool e)
1055 {
1056         ChangeSignaller<Film> ch (this, ENCRYPTED);
1057         _encrypted = e;
1058 }
1059
1060 void
1061 Film::set_key (dcp::Key key)
1062 {
1063         ChangeSignaller<Film> ch (this, KEY);
1064         _key = key;
1065 }
1066
1067 ContentList
1068 Film::content () const
1069 {
1070         return _playlist->content ();
1071 }
1072
1073 /** @param content Content to add.
1074  *  @param disable_audio_analysis true to never do automatic audio analysis, even if it is enabled in configuration.
1075  */
1076 void
1077 Film::examine_and_add_content (shared_ptr<Content> content, bool disable_audio_analysis)
1078 {
1079         if (dynamic_pointer_cast<FFmpegContent> (content) && _directory) {
1080                 run_ffprobe (content->path(0), file ("ffprobe.log"), _log);
1081         }
1082
1083         shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), content));
1084
1085         _job_connections.push_back (
1086                 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job>(j), weak_ptr<Content>(content), disable_audio_analysis))
1087                 );
1088
1089         JobManager::instance()->add (j);
1090 }
1091
1092 void
1093 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c, bool disable_audio_analysis)
1094 {
1095         shared_ptr<Job> job = j.lock ();
1096         if (!job || !job->finished_ok ()) {
1097                 return;
1098         }
1099
1100         shared_ptr<Content> content = c.lock ();
1101         if (!content) {
1102                 return;
1103         }
1104
1105         add_content (content);
1106
1107         if (Config::instance()->automatic_audio_analysis() && content->audio && !disable_audio_analysis) {
1108                 shared_ptr<Playlist> playlist (new Playlist);
1109                 playlist->add (content);
1110                 boost::signals2::connection c;
1111                 JobManager::instance()->analyse_audio (
1112                         shared_from_this(), playlist, false, c, bind (&Film::audio_analysis_finished, this)
1113                         );
1114                 _audio_analysis_connections.push_back (c);
1115         }
1116 }
1117
1118 void
1119 Film::add_content (shared_ptr<Content> c)
1120 {
1121         /* Add {video,subtitle} content after any existing {video,subtitle} content */
1122         if (c->video) {
1123                 c->set_position (_playlist->video_end());
1124         } else if (!c->text.empty()) {
1125                 c->set_position (_playlist->text_end());
1126         }
1127
1128         if (_template_film) {
1129                 /* Take settings from the first piece of content of c's type in _template */
1130                 BOOST_FOREACH (shared_ptr<Content> i, _template_film->content()) {
1131                         c->take_settings_from (i);
1132                 }
1133         }
1134
1135         _playlist->add (c);
1136 }
1137
1138 void
1139 Film::remove_content (shared_ptr<Content> c)
1140 {
1141         _playlist->remove (c);
1142 }
1143
1144 void
1145 Film::move_content_earlier (shared_ptr<Content> c)
1146 {
1147         _playlist->move_earlier (c);
1148 }
1149
1150 void
1151 Film::move_content_later (shared_ptr<Content> c)
1152 {
1153         _playlist->move_later (c);
1154 }
1155
1156 /** @return length of the film from time 0 to the last thing on the playlist */
1157 DCPTime
1158 Film::length () const
1159 {
1160         return _playlist->length().ceil(video_frame_rate());
1161 }
1162
1163 int
1164 Film::best_video_frame_rate () const
1165 {
1166         return _playlist->best_video_frame_rate ();
1167 }
1168
1169 FrameRateChange
1170 Film::active_frame_rate_change (DCPTime t) const
1171 {
1172         return _playlist->active_frame_rate_change (t, video_frame_rate ());
1173 }
1174
1175 void
1176 Film::playlist_content_change (ChangeType type, weak_ptr<Content> c, int p, bool frequent)
1177 {
1178         if (p == ContentProperty::VIDEO_FRAME_RATE) {
1179                 signal_change (type, Film::CONTENT);
1180         } else if (p == AudioContentProperty::STREAMS) {
1181                 signal_change (type, Film::NAME);
1182         }
1183
1184         if (type == CHANGE_TYPE_DONE) {
1185                 emit (boost::bind (boost::ref (ContentChange), type, c, p, frequent));
1186         } else {
1187                 ContentChange (type, c, p, frequent);
1188         }
1189 }
1190
1191 void
1192 Film::playlist_change (ChangeType type)
1193 {
1194         signal_change (type, CONTENT);
1195         signal_change (type, NAME);
1196 }
1197
1198 void
1199 Film::playlist_order_changed ()
1200 {
1201         /* XXX: missing PENDING */
1202         signal_change (CHANGE_TYPE_DONE, CONTENT_ORDER);
1203 }
1204
1205 int
1206 Film::audio_frame_rate () const
1207 {
1208         BOOST_FOREACH (shared_ptr<Content> i, content ()) {
1209                 if (i->audio && i->audio->has_rate_above_48k ()) {
1210                         return 96000;
1211                 }
1212         }
1213
1214         return 48000;
1215 }
1216
1217 void
1218 Film::set_sequence (bool s)
1219 {
1220         if (s == _sequence) {
1221                 return;
1222         }
1223
1224         ChangeSignaller<Film> cc (this, SEQUENCE);
1225         _sequence = s;
1226         _playlist->set_sequence (s);
1227 }
1228
1229 /** @return Size of the largest possible image in whatever resolution we are using */
1230 dcp::Size
1231 Film::full_frame () const
1232 {
1233         switch (_resolution) {
1234         case RESOLUTION_2K:
1235                 return dcp::Size (2048, 1080);
1236         case RESOLUTION_4K:
1237                 return dcp::Size (4096, 2160);
1238         }
1239
1240         DCPOMATIC_ASSERT (false);
1241         return dcp::Size ();
1242 }
1243
1244 /** @return Size of the frame */
1245 dcp::Size
1246 Film::frame_size () const
1247 {
1248         return fit_ratio_within (container()->ratio(), full_frame ());
1249 }
1250
1251 /** @param recipient KDM recipient certificate.
1252  *  @param trusted_devices Certificates of other trusted devices (can be empty).
1253  *  @param cpl_file CPL filename.
1254  *  @param from KDM from time expressed as a local time with an offset from UTC.
1255  *  @param until KDM to time expressed as a local time with an offset from UTC.
1256  *  @param formulation KDM formulation to use.
1257  *  @param disable_forensic_marking_picture true to disable forensic marking of picture.
1258  *  @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio.  If set to 0,
1259  *  disable all forensic marking; if set above 0, disable forensic marking above that channel.
1260  */
1261 dcp::EncryptedKDM
1262 Film::make_kdm (
1263         dcp::Certificate recipient,
1264         vector<dcp::Certificate> trusted_devices,
1265         boost::filesystem::path cpl_file,
1266         dcp::LocalTime from,
1267         dcp::LocalTime until,
1268         dcp::Formulation formulation,
1269         bool disable_forensic_marking_picture,
1270         optional<int> disable_forensic_marking_audio
1271         ) const
1272 {
1273         if (!_encrypted) {
1274                 throw runtime_error (_("Cannot make a KDM as this project is not encrypted."));
1275         }
1276
1277         shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
1278         shared_ptr<const dcp::CertificateChain> signer = Config::instance()->signer_chain ();
1279         if (!signer->valid ()) {
1280                 throw InvalidSignerError ();
1281         }
1282
1283         /* Find keys that have been added to imported, encrypted DCP content */
1284         list<dcp::DecryptedKDMKey> imported_keys;
1285         BOOST_FOREACH (shared_ptr<Content> i, content()) {
1286                 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (i);
1287                 if (d && d->kdm()) {
1288                         dcp::DecryptedKDM kdm (d->kdm().get(), Config::instance()->decryption_chain()->key().get());
1289                         list<dcp::DecryptedKDMKey> keys = kdm.keys ();
1290                         copy (keys.begin(), keys.end(), back_inserter (imported_keys));
1291                 }
1292         }
1293
1294         map<shared_ptr<const dcp::ReelMXF>, dcp::Key> keys;
1295
1296         BOOST_FOREACH(shared_ptr<const dcp::ReelAsset> i, cpl->reel_assets ()) {
1297                 shared_ptr<const dcp::ReelMXF> mxf = boost::dynamic_pointer_cast<const dcp::ReelMXF> (i);
1298                 if (!mxf || !mxf->key_id()) {
1299                         continue;
1300                 }
1301
1302                 /* Get any imported key for this ID */
1303                 bool done = false;
1304                 BOOST_FOREACH (dcp::DecryptedKDMKey j, imported_keys) {
1305                         if (j.id() == mxf->key_id().get()) {
1306                                 LOG_GENERAL ("Using imported key for %1", mxf->key_id().get());
1307                                 keys[mxf] = j.key();
1308                                 done = true;
1309                         }
1310                 }
1311
1312                 if (!done) {
1313                         /* No imported key; it must be an asset that we encrypted */
1314                         LOG_GENERAL ("Using our own key for %1", mxf->key_id().get());
1315                         keys[mxf] = key();
1316                 }
1317         }
1318
1319         return dcp::DecryptedKDM (
1320                 cpl->id(), keys, from, until, cpl->content_title_text(), cpl->content_title_text(), dcp::LocalTime().as_string()
1321                 ).encrypt (signer, recipient, trusted_devices, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio);
1322 }
1323
1324 /** @param screens Screens to make KDMs for.
1325  *  @param cpl_file Path to CPL to make KDMs for.
1326  *  @param from KDM from time expressed as a local time in the time zone of the Screen's Cinema.
1327  *  @param until KDM to time expressed as a local time in the time zone of the Screen's Cinema.
1328  *  @param formulation KDM formulation to use.
1329  *  @param disable_forensic_marking_picture true to disable forensic marking of picture.
1330  *  @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio.  If set to 0,
1331  *  disable all forensic marking; if set above 0, disable forensic marking above that channel.
1332  */
1333 list<ScreenKDM>
1334 Film::make_kdms (
1335         list<shared_ptr<Screen> > screens,
1336         boost::filesystem::path cpl_file,
1337         boost::posix_time::ptime from,
1338         boost::posix_time::ptime until,
1339         dcp::Formulation formulation,
1340         bool disable_forensic_marking_picture,
1341         optional<int> disable_forensic_marking_audio
1342         ) const
1343 {
1344         list<ScreenKDM> kdms;
1345
1346         BOOST_FOREACH (shared_ptr<Screen> i, screens) {
1347                 if (i->recipient) {
1348                         dcp::EncryptedKDM const kdm = make_kdm (
1349                                 i->recipient.get(),
1350                                 i->trusted_devices,
1351                                 cpl_file,
1352                                 dcp::LocalTime (from, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
1353                                 dcp::LocalTime (until, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
1354                                 formulation,
1355                                 disable_forensic_marking_picture,
1356                                 disable_forensic_marking_audio
1357                                 );
1358
1359                         kdms.push_back (ScreenKDM (i, kdm));
1360                 }
1361         }
1362
1363         return kdms;
1364 }
1365
1366 /** @return The approximate disk space required to encode a DCP of this film with the
1367  *  current settings, in bytes.
1368  */
1369 uint64_t
1370 Film::required_disk_space () const
1371 {
1372         return _playlist->required_disk_space (j2k_bandwidth(), audio_channels(), audio_frame_rate());
1373 }
1374
1375 /** This method checks the disk that the Film is on and tries to decide whether or not
1376  *  there will be enough space to make a DCP for it.  If so, true is returned; if not,
1377  *  false is returned and required and available are filled in with the amount of disk space
1378  *  required and available respectively (in Gb).
1379  *
1380  *  Note: the decision made by this method isn't, of course, 100% reliable.
1381  */
1382 bool
1383 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1384 {
1385         /* Create a test file and see if we can hard-link it */
1386         boost::filesystem::path test = internal_video_asset_dir() / "test";
1387         boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1388         can_hard_link = true;
1389         FILE* f = fopen_boost (test, "w");
1390         if (f) {
1391                 fclose (f);
1392                 boost::system::error_code ec;
1393                 boost::filesystem::create_hard_link (test, test2, ec);
1394                 if (ec) {
1395                         can_hard_link = false;
1396                 }
1397                 boost::filesystem::remove (test);
1398                 boost::filesystem::remove (test2);
1399         }
1400
1401         boost::filesystem::space_info s = boost::filesystem::space (internal_video_asset_dir ());
1402         required = double (required_disk_space ()) / 1073741824.0f;
1403         if (!can_hard_link) {
1404                 required *= 2;
1405         }
1406         available = double (s.available) / 1073741824.0f;
1407         return (available - required) > 1;
1408 }
1409
1410 string
1411 Film::subtitle_language () const
1412 {
1413         set<string> languages;
1414
1415         BOOST_FOREACH (shared_ptr<Content> i, content()) {
1416                 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
1417                         languages.insert (j->language ());
1418                 }
1419         }
1420
1421         string all;
1422         BOOST_FOREACH (string s, languages) {
1423                 if (!all.empty ()) {
1424                         all += "/" + s;
1425                 } else {
1426                         all += s;
1427                 }
1428         }
1429
1430         return all;
1431 }
1432
1433 /** Change the gains of the supplied AudioMapping to make it a default
1434  *  for this film.  The defaults are guessed based on what processor (if any)
1435  *  is in use, the number of input channels and any filename supplied.
1436  */
1437 void
1438 Film::make_audio_mapping_default (AudioMapping& mapping, optional<boost::filesystem::path> filename) const
1439 {
1440         static string const regex[] = {
1441                 ".*[\\._-]L[\\._-].*",
1442                 ".*[\\._-]R[\\._-].*",
1443                 ".*[\\._-]C[\\._-].*",
1444                 ".*[\\._-]Lfe[\\._-].*",
1445                 ".*[\\._-]Ls[\\._-].*",
1446                 ".*[\\._-]Rs[\\._-].*"
1447         };
1448
1449         static int const regexes = sizeof(regex) / sizeof(*regex);
1450
1451         if (audio_processor ()) {
1452                 audio_processor()->make_audio_mapping_default (mapping);
1453         } else {
1454                 mapping.make_zero ();
1455                 if (mapping.input_channels() == 1) {
1456                         bool guessed = false;
1457
1458                         /* See if we can guess where this stream should go */
1459                         if (filename) {
1460                                 for (int i = 0; i < regexes; ++i) {
1461                                         boost::regex e (regex[i], boost::regex::icase);
1462                                         if (boost::regex_match (filename->string(), e) && i < mapping.output_channels()) {
1463                                                 mapping.set (0, i, 1);
1464                                                 guessed = true;
1465                                         }
1466                                 }
1467                         }
1468
1469                         if (!guessed) {
1470                                 /* If we have no idea, just put it on centre */
1471                                 mapping.set (0, static_cast<int> (dcp::CENTRE), 1);
1472                         }
1473                 } else {
1474                         /* 1:1 mapping */
1475                         for (int i = 0; i < min (mapping.input_channels(), mapping.output_channels()); ++i) {
1476                                 mapping.set (i, i, 1);
1477                         }
1478                 }
1479         }
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 (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()) {
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() : 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 (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 }