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