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