src/lib/film.cc

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