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