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