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