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