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