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