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