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