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