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