src/lib/film.cc

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