src/lib/film.cc

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