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