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