src/lib/film.cc

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