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