src/lib/film.cc

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