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