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