src/lib/film.cc

   1 /*
   2     Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file  src/film.cc
  21  *  @brief A representation of some audio and video content, and details of
  22  *  how they should be presented in a DCP.
  23  */
  24
  25 #include "film.h"
  26 #include "job.h"
  27 #include "util.h"
  28 #include "job_manager.h"
  29 #include "transcode_job.h"
  30 #include "upload_job.h"
  31 #include "null_log.h"
  32 #include "file_log.h"
  33 #include "exceptions.h"
  34 #include "examine_content_job.h"
  35 #include "config.h"
  36 #include "playlist.h"
  37 #include "dcp_content_type.h"
  38 #include "ratio.h"
  39 #include "cross.h"
  40 #include "safe_stringstream.h"
  41 #include "environment_info.h"
  42 #include "raw_convert.h"
  43 #include "audio_processor.h"
  44 #include "md5_digester.h"
  45 #include "compose.hpp"
  46 #include "screen.h"
  47 #include "audio_content.h"
  48 #include "video_content.h"
  49 #include "subtitle_content.h"
  50 #include "ffmpeg_content.h"
  51 #include "dcp_content.h"
  52 #include "screen_kdm.h"
  53 #include "cinema.h"
  54 #include <libcxml/cxml.h>
  55 #include <dcp/cpl.h>
  56 #include <dcp/certificate_chain.h>
  57 #include <dcp/util.h>
  58 #include <dcp/local_time.h>
  59 #include <dcp/decrypted_kdm.h>
  60 #include <libxml++/libxml++.h>
  61 #include <boost/filesystem.hpp>
  62 #include <boost/algorithm/string.hpp>
  63 #include <boost/foreach.hpp>
  64 #include <unistd.h>
  65 #include <stdexcept>
  66 #include <iostream>
  67 #include <algorithm>
  68 #include <cstdlib>
  69 #include <iomanip>
  70 #include <set>
  71
  72 #include "i18n.h"
  73
  74 using std::string;
  75 using std::pair;
  76 using std::vector;
  77 using std::setfill;
  78 using std::min;
  79 using std::max;
  80 using std::make_pair;
  81 using std::cout;
  82 using std::list;
  83 using std::set;
  84 using std::runtime_error;
  85 using boost::shared_ptr;
  86 using boost::weak_ptr;
  87 using boost::dynamic_pointer_cast;
  88 using boost::optional;
  89 using boost::is_any_of;
  90
  91 #define LOG_GENERAL(...) log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
  92 #define LOG_GENERAL_NC(...) log()->log (__VA_ARGS__, LogEntry::TYPE_GENERAL);
  93
  94 /* 5 -> 6
  95  * AudioMapping XML changed.
  96  * 6 -> 7
  97  * Subtitle offset changed to subtitle y offset, and subtitle x offset added.
  98  * 7 -> 8
  99  * Use <Scale> tag in <VideoContent> rather than <Ratio>.
 100  * 8 -> 9
 101  * DCI -> ISDCF
 102  * 9 -> 10
 103  * Subtitle X and Y scale.
 104  *
 105  * Bumped to 32 for 2.0 branch; some times are expressed in Times rather
 106  * than frames now.
 107  *
 108  * 32 -> 33
 109  * Changed <Period> to <Subtitle> in FFmpegSubtitleStream
 110  */
 111 int const Film::current_state_version = 33;
 112
 113 /** Construct a Film object in a given directory.
 114  *
 115  *  @param dir Film directory.
 116  */
 117
 118 Film::Film (boost::filesystem::path dir, bool log)
 119         : _playlist (new Playlist)
 120         , _use_isdcf_name (true)
 121         , _dcp_content_type (Config::instance()->default_dcp_content_type ())
 122         , _container (Config::instance()->default_container ())
 123         , _resolution (RESOLUTION_2K)
 124         , _signed (true)
 125         , _encrypted (false)
 126         , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
 127         , _isdcf_metadata (Config::instance()->default_isdcf_metadata ())
 128         , _video_frame_rate (24)
 129         , _audio_channels (6)
 130         , _three_d (false)
 131         , _sequence (true)
 132         , _interop (Config::instance()->default_interop ())
 133         , _audio_processor (0)
 134         , _reel_type (REELTYPE_SINGLE)
 135         , _reel_length (2000000000)
 136         , _upload_after_make_dcp (false)
 137         , _state_version (current_state_version)
 138         , _dirty (false)
 139 {
 140         set_isdcf_date_today ();
 141
 142         _playlist_changed_connection = _playlist->Changed.connect (bind (&Film::playlist_changed, this));
 143         _playlist_order_changed_connection = _playlist->OrderChanged.connect (bind (&Film::playlist_order_changed, this));
 144         _playlist_content_changed_connection = _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2, _3));
 145
 146         /* Make state.directory a complete path without ..s (where possible)
 147            (Code swiped from Adam Bowen on stackoverflow)
 148            XXX: couldn't/shouldn't this just be boost::filesystem::canonical?
 149         */
 150
 151         boost::filesystem::path p (boost::filesystem::system_complete (dir));
 152         boost::filesystem::path result;
 153         for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
 154                 if (*i == "..") {
 155                         if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
 156                                 result /= *i;
 157                         } else {
 158                                 result = result.parent_path ();
 159                         }
 160                 } else if (*i != ".") {
 161                         result /= *i;
 162                 }
 163         }
 164
 165         set_directory (result.make_preferred ());
 166         if (log) {
 167                 _log.reset (new FileLog (file ("log")));
 168         } else {
 169                 _log.reset (new NullLog);
 170         }
 171
 172         _playlist->set_sequence (_sequence);
 173 }
 174
 175 Film::~Film ()
 176 {
 177         BOOST_FOREACH (boost::signals2::connection& i, _job_connections) {
 178                 i.disconnect ();
 179         }
 180
 181         BOOST_FOREACH (boost::signals2::connection& i, _audio_analysis_connections) {
 182                 i.disconnect ();
 183         }
 184 }
 185
 186 string
 187 Film::video_identifier () const
 188 {
 189         DCPOMATIC_ASSERT (container ());
 190
 191         SafeStringStream s;
 192         s.imbue (std::locale::classic ());
 193
 194         s << container()->id()
 195           << "_" << resolution_to_string (_resolution)
 196           << "_" << _playlist->video_identifier()
 197           << "_" << _video_frame_rate
 198           << "_" << j2k_bandwidth();
 199
 200         if (encrypted ()) {
 201                 s << "_E";
 202         } else {
 203                 s << "_P";
 204         }
 205
 206         if (_interop) {
 207                 s << "_I";
 208         } else {
 209                 s << "_S";
 210         }
 211
 212         if (_three_d) {
 213                 s << "_3D";
 214         }
 215
 216         return s.str ();
 217 }
 218
 219 /** @return The file to write video frame info to */
 220 boost::filesystem::path
 221 Film::info_file (DCPTimePeriod period) const
 222 {
 223         boost::filesystem::path p;
 224         p /= "info";
 225         p /= video_identifier () + "_" + raw_convert<string> (period.from.get()) + "_" + raw_convert<string> (period.to.get());
 226         return file (p);
 227 }
 228
 229 boost::filesystem::path
 230 Film::internal_video_asset_dir () const
 231 {
 232         return dir ("video");
 233 }
 234
 235 boost::filesystem::path
 236 Film::internal_video_asset_filename (DCPTimePeriod p) const
 237 {
 238         return video_identifier() + "_" + raw_convert<string> (p.from.get()) + "_" + raw_convert<string> (p.to.get()) + ".mxf";
 239 }
 240
 241 boost::filesystem::path
 242 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
 243 {
 244         boost::filesystem::path p = dir ("analysis");
 245
 246         MD5Digester digester;
 247         BOOST_FOREACH (shared_ptr<Content> i, playlist->content ()) {
 248                 if (!i->audio) {
 249                         continue;
 250                 }
 251
 252                 digester.add (i->digest ());
 253                 digester.add (i->audio->mapping().digest ());
 254                 if (playlist->content().size() != 1) {
 255                         /* Analyses should be considered equal regardless of gain
 256                            if they were made from just one piece of content.  This
 257                            is because we can fake any gain change in a single-content
 258                            analysis at the plotting stage rather than having to
 259                            recompute it.
 260                         */
 261                         digester.add (i->audio->gain ());
 262                 }
 263         }
 264
 265         if (audio_processor ()) {
 266                 digester.add (audio_processor()->id ());
 267         }
 268
 269         p /= digester.get ();
 270         return p;
 271 }
 272
 273 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
 274 void
 275 Film::make_dcp ()
 276 {
 277         if (dcp_name().find ("/") != string::npos) {
 278                 throw BadSettingError (_("name"), _("cannot contain slashes"));
 279         }
 280
 281         set_isdcf_date_today ();
 282
 283         BOOST_FOREACH (string i, environment_info ()) {
 284                 LOG_GENERAL_NC (i);
 285         }
 286
 287         BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
 288                 LOG_GENERAL ("Content: %1", i->technical_summary());
 289         }
 290         LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
 291         if (Config::instance()->only_servers_encode ()) {
 292                 LOG_GENERAL_NC ("0 threads: ONLY SERVERS SET TO ENCODE");
 293         } else {
 294                 LOG_GENERAL ("%1 threads", Config::instance()->num_local_encoding_threads());
 295         }
 296         LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
 297
 298         if (container() == 0) {
 299                 throw MissingSettingError (_("container"));
 300         }
 301
 302         if (content().empty()) {
 303                 throw runtime_error (_("You must add some content to the DCP before creating it"));
 304         }
 305
 306         if (dcp_content_type() == 0) {
 307                 throw MissingSettingError (_("content type"));
 308         }
 309
 310         if (name().empty()) {
 311                 throw MissingSettingError (_("name"));
 312         }
 313
 314         JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
 315 }
 316
 317 /** Start a job to send our DCP to the configured TMS */
 318 void
 319 Film::send_dcp_to_tms ()
 320 {
 321         shared_ptr<Job> j (new UploadJob (shared_from_this()));
 322         JobManager::instance()->add (j);
 323 }
 324
 325 shared_ptr<xmlpp::Document>
 326 Film::metadata () const
 327 {
 328         shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
 329         xmlpp::Element* root = doc->create_root_node ("Metadata");
 330
 331         root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
 332         root->add_child("Name")->add_child_text (_name);
 333         root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
 334
 335         if (_dcp_content_type) {
 336                 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
 337         }
 338
 339         if (_container) {
 340                 root->add_child("Container")->add_child_text (_container->id ());
 341         }
 342
 343         root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
 344         root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
 345         _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
 346         root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
 347         root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
 348         root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
 349         root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
 350         root->add_child("Sequence")->add_child_text (_sequence ? "1" : "0");
 351         root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
 352         root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
 353         root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
 354         root->add_child("Key")->add_child_text (_key.hex ());
 355         if (_audio_processor) {
 356                 root->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
 357         }
 358         root->add_child("ReelType")->add_child_text (raw_convert<string> (_reel_type));
 359         root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
 360         root->add_child("UploadAfterMakeDCP")->add_child_text (_upload_after_make_dcp ? "1" : "0");
 361         _playlist->as_xml (root->add_child ("Playlist"));
 362
 363         return doc;
 364 }
 365
 366 /** Write state to our `metadata' file */
 367 void
 368 Film::write_metadata () const
 369 {
 370         boost::filesystem::create_directories (directory ());
 371         shared_ptr<xmlpp::Document> doc = metadata ();
 372         doc->write_to_file_formatted (file("metadata.xml").string ());
 373         _dirty = false;
 374 }
 375
 376 /** Read state from our metadata file.
 377  *  @return Notes about things that the user should know about, or empty.
 378  */
 379 list<string>
 380 Film::read_metadata ()
 381 {
 382         if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
 383                 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!"));
 384         }
 385
 386         cxml::Document f ("Metadata");
 387         f.read_file (file ("metadata.xml"));
 388
 389         _state_version = f.number_child<int> ("Version");
 390         if (_state_version > current_state_version) {
 391                 throw runtime_error (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version.  Sorry!"));
 392         }
 393
 394         _name = f.string_child ("Name");
 395         if (_state_version >= 9) {
 396                 _use_isdcf_name = f.bool_child ("UseISDCFName");
 397                 _isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
 398                 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
 399         } else {
 400                 _use_isdcf_name = f.bool_child ("UseDCIName");
 401                 _isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
 402                 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
 403         }
 404
 405         {
 406                 optional<string> c = f.optional_string_child ("DCPContentType");
 407                 if (c) {
 408                         _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
 409                 }
 410         }
 411
 412         {
 413                 optional<string> c = f.optional_string_child ("Container");
 414                 if (c) {
 415                         _container = Ratio::from_id (c.get ());
 416                 }
 417         }
 418
 419         _resolution = string_to_resolution (f.string_child ("Resolution"));
 420         _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
 421         _video_frame_rate = f.number_child<int> ("VideoFrameRate");
 422         _signed = f.optional_bool_child("Signed").get_value_or (true);
 423         _encrypted = f.bool_child ("Encrypted");
 424         _audio_channels = f.number_child<int> ("AudioChannels");
 425         /* We used to allow odd numbers (and zero) channels, but it's just not worth
 426            the pain.
 427         */
 428         if (_audio_channels == 0) {
 429                 _audio_channels = 2;
 430         } else if ((_audio_channels % 2) == 1) {
 431                 _audio_channels++;
 432         }
 433
 434         if (f.optional_bool_child("SequenceVideo")) {
 435                 _sequence = f.bool_child("SequenceVideo");
 436         } else {
 437                 _sequence = f.bool_child("Sequence");
 438         }
 439
 440         _three_d = f.bool_child ("ThreeD");
 441         _interop = f.bool_child ("Interop");
 442         _key = dcp::Key (f.string_child ("Key"));
 443
 444         if (f.optional_string_child ("AudioProcessor")) {
 445                 _audio_processor = AudioProcessor::from_id (f.string_child ("AudioProcessor"));
 446         } else {
 447                 _audio_processor = 0;
 448         }
 449
 450         _reel_type = static_cast<ReelType> (f.optional_number_child<int>("ReelType").get_value_or (static_cast<int>(REELTYPE_SINGLE)));
 451         _reel_length = f.optional_number_child<int64_t>("ReelLength").get_value_or (2000000000);
 452         _upload_after_make_dcp = f.optional_bool_child("UploadAfterMakeDCP").get_value_or (false);
 453
 454         list<string> notes;
 455         /* This method is the only one that can return notes (so far) */
 456         _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
 457
 458         /* Write backtraces to this film's directory, until another film is loaded */
 459         set_backtrace_file (file ("backtrace.txt"));
 460
 461         _dirty = false;
 462         return notes;
 463 }
 464
 465 /** Given a directory name, return its full path within the Film's directory.
 466  *  The directory (and its parents) will be created if they do not exist.
 467  */
 468 boost::filesystem::path
 469 Film::dir (boost::filesystem::path d) const
 470 {
 471         boost::filesystem::path p;
 472         p /= _directory;
 473         p /= d;
 474
 475         boost::filesystem::create_directories (p);
 476
 477         return p;
 478 }
 479
 480 /** Given a file or directory name, return its full path within the Film's directory.
 481  *  Any required parent directories will be created.
 482  */
 483 boost::filesystem::path
 484 Film::file (boost::filesystem::path f) const
 485 {
 486         boost::filesystem::path p;
 487         p /= _directory;
 488         p /= f;
 489
 490         boost::filesystem::create_directories (p.parent_path ());
 491
 492         return p;
 493 }
 494
 495 list<int>
 496 Film::mapped_audio_channels () const
 497 {
 498         list<int> mapped;
 499
 500         if (audio_processor ()) {
 501                 /* Processors are mapped 1:1 to DCP outputs so we can work out mappings from there */
 502                 for (int i = 0; i < audio_processor()->out_channels(); ++i) {
 503                         mapped.push_back (i);
 504                 }
 505         } else {
 506                 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
 507                         if (i->audio) {
 508                                 list<int> c = i->audio->mapping().mapped_output_channels ();
 509                                 copy (c.begin(), c.end(), back_inserter (mapped));
 510                         }
 511                 }
 512
 513                 mapped.sort ();
 514                 mapped.unique ();
 515         }
 516
 517         return mapped;
 518 }
 519
 520 /** @return a ISDCF-compliant name for a DCP of this film */
 521 string
 522 Film::isdcf_name (bool if_created_now) const
 523 {
 524         SafeStringStream d;
 525
 526         string raw_name = name ();
 527
 528         /* Split the raw name up into words */
 529         vector<string> words;
 530         split (words, raw_name, is_any_of (" _-"));
 531
 532         string fixed_name;
 533
 534         /* Add each word to fixed_name */
 535         for (vector<string>::const_iterator i = words.begin(); i != words.end(); ++i) {
 536                 string w = *i;
 537
 538                 /* First letter is always capitalised */
 539                 w[0] = toupper (w[0]);
 540
 541                 /* Count caps in w */
 542                 size_t caps = 0;
 543                 for (size_t i = 0; i < w.size(); ++i) {
 544                         if (isupper (w[i])) {
 545                                 ++caps;
 546                         }
 547                 }
 548
 549                 /* If w is all caps make the rest of it lower case, otherwise
 550                    leave it alone.
 551                 */
 552                 if (caps == w.size ()) {
 553                         for (size_t i = 1; i < w.size(); ++i) {
 554                                 w[i] = tolower (w[i]);
 555                         }
 556                 }
 557
 558                 for (size_t i = 0; i < w.size(); ++i) {
 559                         fixed_name += w[i];
 560                 }
 561         }
 562
 563         if (fixed_name.length() > 14) {
 564                 fixed_name = fixed_name.substr (0, 14);
 565         }
 566
 567         d << fixed_name;
 568
 569         if (dcp_content_type()) {
 570                 d << "_" << dcp_content_type()->isdcf_name();
 571                 d << "-" << isdcf_metadata().content_version;
 572         }
 573
 574         ISDCFMetadata const dm = isdcf_metadata ();
 575
 576         if (dm.temp_version) {
 577                 d << "-Temp";
 578         }
 579
 580         if (dm.pre_release) {
 581                 d << "-Pre";
 582         }
 583
 584         if (dm.red_band) {
 585                 d << "-RedBand";
 586         }
 587
 588         if (!dm.chain.empty ()) {
 589                 d << "-" << dm.chain;
 590         }
 591
 592         if (three_d ()) {
 593                 d << "-3D";
 594         }
 595
 596         if (dm.two_d_version_of_three_d) {
 597                 d << "-2D";
 598         }
 599
 600         if (!dm.mastered_luminance.empty ()) {
 601                 d << "-" << dm.mastered_luminance;
 602         }
 603
 604         if (video_frame_rate() != 24) {
 605                 d << "-" << video_frame_rate();
 606         }
 607
 608         if (container()) {
 609                 d << "_" << container()->isdcf_name();
 610         }
 611
 612         /* XXX: this uses the first bit of content only */
 613
 614         /* The standard says we don't do this for trailers, for some strange reason */
 615         if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::TRAILER) {
 616                 Ratio const * content_ratio = 0;
 617                 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
 618                         if (i->video) {
 619                                 /* Here's the first piece of video content */
 620                                 if (i->video->scale().ratio ()) {
 621                                         content_ratio = i->video->scale().ratio ();
 622                                 } else {
 623                                         content_ratio = Ratio::from_ratio (i->video->size().ratio ());
 624                                 }
 625                                 break;
 626                         }
 627                 }
 628
 629                 if (content_ratio && content_ratio != container()) {
 630                         d << "-" << content_ratio->isdcf_name();
 631                 }
 632         }
 633
 634         if (!dm.audio_language.empty ()) {
 635                 d << "_" << dm.audio_language;
 636                 if (!dm.subtitle_language.empty()) {
 637
 638                         bool burnt_in = true;
 639                         BOOST_FOREACH (shared_ptr<Content> i, content ()) {
 640                                 if (!i->subtitle) {
 641                                         continue;
 642                                 }
 643
 644                                 if (i->subtitle->use() && !i->subtitle->burn()) {
 645                                         burnt_in = false;
 646                                 }
 647                         }
 648
 649                         string language = dm.subtitle_language;
 650                         if (burnt_in && language != "XX") {
 651                                 transform (language.begin(), language.end(), language.begin(), ::tolower);
 652                         } else {
 653                                 transform (language.begin(), language.end(), language.begin(), ::toupper);
 654                         }
 655
 656                         d << "-" << language;
 657                 } else {
 658                         d << "-XX";
 659                 }
 660         }
 661
 662         if (!dm.territory.empty ()) {
 663                 d << "_" << dm.territory;
 664                 if (dm.rating.empty ()) {
 665                         d << "-NR";
 666                 } else {
 667                         d << "-" << dm.rating;
 668                 }
 669         }
 670
 671         /* Count mapped audio channels */
 672
 673         int non_lfe = 0;
 674         int lfe = 0;
 675
 676         BOOST_FOREACH (int i, mapped_audio_channels ()) {
 677                 if (i >= audio_channels()) {
 678                         /* This channel is mapped but is not included in the DCP */
 679                         continue;
 680                 }
 681
 682                 if (static_cast<dcp::Channel> (i) == dcp::LFE) {
 683                         ++lfe;
 684                 } else {
 685                         ++non_lfe;
 686                 }
 687         }
 688
 689         if (non_lfe) {
 690                 d << "_" << non_lfe << lfe;
 691         }
 692
 693         /* XXX: HI/VI */
 694
 695         d << "_" << resolution_to_string (_resolution);
 696
 697         if (!dm.studio.empty ()) {
 698                 d << "_" << dm.studio;
 699         }
 700
 701         if (if_created_now) {
 702                 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
 703         } else {
 704                 d << "_" << boost::gregorian::to_iso_string (_isdcf_date);
 705         }
 706
 707         if (!dm.facility.empty ()) {
 708                 d << "_" << dm.facility;
 709         }
 710
 711         if (_interop) {
 712                 d << "_IOP";
 713         } else {
 714                 d << "_SMPTE";
 715         }
 716
 717         if (three_d ()) {
 718                 d << "-3D";
 719         }
 720
 721         bool vf = false;
 722         BOOST_FOREACH (shared_ptr<Content> i, content ()) {
 723                 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (i);
 724                 if (dc && (dc->reference_video() || dc->reference_audio() || dc->reference_subtitle())) {
 725                         vf = true;
 726                 }
 727         }
 728
 729         if (vf) {
 730                 d << "_VF";
 731         } else {
 732                 d << "_OV";
 733         }
 734
 735         return d.str ();
 736 }
 737
 738 /** @return name to give the DCP */
 739 string
 740 Film::dcp_name (bool if_created_now) const
 741 {
 742         string unfiltered;
 743         if (use_isdcf_name()) {
 744                 unfiltered = isdcf_name (if_created_now);
 745         } else {
 746                 unfiltered = name ();
 747         }
 748
 749         /* Filter out `bad' characters which cause problems with some systems.
 750            There's no apparent list of what really is allowed, so this is a guess.
 751         */
 752
 753         string filtered;
 754         string const allowed = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_";
 755         for (size_t i = 0; i < unfiltered.size(); ++i) {
 756                 if (allowed.find (unfiltered[i]) != string::npos) {
 757                         filtered += unfiltered[i];
 758                 }
 759         }
 760
 761         return filtered;
 762 }
 763
 764 void
 765 Film::set_directory (boost::filesystem::path d)
 766 {
 767         _directory = d;
 768         _dirty = true;
 769 }
 770
 771 void
 772 Film::set_name (string n)
 773 {
 774         _name = n;
 775         signal_changed (NAME);
 776 }
 777
 778 void
 779 Film::set_use_isdcf_name (bool u)
 780 {
 781         _use_isdcf_name = u;
 782         signal_changed (USE_ISDCF_NAME);
 783 }
 784
 785 void
 786 Film::set_dcp_content_type (DCPContentType const * t)
 787 {
 788         _dcp_content_type = t;
 789         signal_changed (DCP_CONTENT_TYPE);
 790 }
 791
 792 void
 793 Film::set_container (Ratio const * c)
 794 {
 795         _container = c;
 796         signal_changed (CONTAINER);
 797 }
 798
 799 void
 800 Film::set_resolution (Resolution r)
 801 {
 802         _resolution = r;
 803         signal_changed (RESOLUTION);
 804 }
 805
 806 void
 807 Film::set_j2k_bandwidth (int b)
 808 {
 809         _j2k_bandwidth = b;
 810         signal_changed (J2K_BANDWIDTH);
 811 }
 812
 813 void
 814 Film::set_isdcf_metadata (ISDCFMetadata m)
 815 {
 816         _isdcf_metadata = m;
 817         signal_changed (ISDCF_METADATA);
 818 }
 819
 820 void
 821 Film::set_video_frame_rate (int f)
 822 {
 823         _video_frame_rate = f;
 824         signal_changed (VIDEO_FRAME_RATE);
 825 }
 826
 827 void
 828 Film::set_audio_channels (int c)
 829 {
 830         _audio_channels = c;
 831         signal_changed (AUDIO_CHANNELS);
 832 }
 833
 834 void
 835 Film::set_three_d (bool t)
 836 {
 837         _three_d = t;
 838         signal_changed (THREE_D);
 839
 840         if (_three_d && _isdcf_metadata.two_d_version_of_three_d) {
 841                 _isdcf_metadata.two_d_version_of_three_d = false;
 842                 signal_changed (ISDCF_METADATA);
 843         }
 844 }
 845
 846 void
 847 Film::set_interop (bool i)
 848 {
 849         _interop = i;
 850         signal_changed (INTEROP);
 851 }
 852
 853 void
 854 Film::set_audio_processor (AudioProcessor const * processor)
 855 {
 856         _audio_processor = processor;
 857         signal_changed (AUDIO_PROCESSOR);
 858         signal_changed (AUDIO_CHANNELS);
 859 }
 860
 861 void
 862 Film::set_reel_type (ReelType t)
 863 {
 864         _reel_type = t;
 865         signal_changed (REEL_TYPE);
 866 }
 867
 868 /** @param r Desired reel length in bytes */
 869 void
 870 Film::set_reel_length (int64_t r)
 871 {
 872         _reel_length = r;
 873         signal_changed (REEL_LENGTH);
 874 }
 875
 876 void
 877 Film::set_upload_after_make_dcp (bool u)
 878 {
 879         _upload_after_make_dcp = u;
 880         signal_changed (UPLOAD_AFTER_MAKE_DCP);
 881 }
 882
 883 void
 884 Film::signal_changed (Property p)
 885 {
 886         _dirty = true;
 887
 888         switch (p) {
 889         case Film::CONTENT:
 890                 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
 891                 break;
 892         case Film::VIDEO_FRAME_RATE:
 893         case Film::SEQUENCE:
 894                 _playlist->maybe_sequence ();
 895                 break;
 896         default:
 897                 break;
 898         }
 899
 900         emit (boost::bind (boost::ref (Changed), p));
 901 }
 902
 903 void
 904 Film::set_isdcf_date_today ()
 905 {
 906         _isdcf_date = boost::gregorian::day_clock::local_day ();
 907 }
 908
 909 boost::filesystem::path
 910 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
 911 {
 912         boost::filesystem::path p;
 913         p /= "j2c";
 914         p /= video_identifier ();
 915
 916         SafeStringStream s;
 917         s.width (8);
 918         s << setfill('0') << reel << "_" << frame;
 919
 920         if (eyes == EYES_LEFT) {
 921                 s << ".L";
 922         } else if (eyes == EYES_RIGHT) {
 923                 s << ".R";
 924         }
 925
 926         s << ".j2c";
 927
 928         if (tmp) {
 929                 s << ".tmp";
 930         }
 931
 932         p /= s.str();
 933         return file (p);
 934 }
 935
 936 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs */
 937 vector<CPLSummary>
 938 Film::cpls () const
 939 {
 940         vector<CPLSummary> out;
 941
 942         boost::filesystem::path const dir = directory ();
 943         for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
 944                 if (
 945                         boost::filesystem::is_directory (*i) &&
 946                         i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
 947                         ) {
 948
 949                         try {
 950                                 dcp::DCP dcp (*i);
 951                                 dcp.read ();
 952                                 out.push_back (
 953                                         CPLSummary (
 954                                                 i->path().leaf().string(),
 955                                                 dcp.cpls().front()->id(),
 956                                                 dcp.cpls().front()->annotation_text(),
 957                                                 dcp.cpls().front()->file()
 958                                                 )
 959                                         );
 960                         } catch (...) {
 961
 962                         }
 963                 }
 964         }
 965
 966         return out;
 967 }
 968
 969 void
 970 Film::set_signed (bool s)
 971 {
 972         _signed = s;
 973         signal_changed (SIGNED);
 974 }
 975
 976 void
 977 Film::set_encrypted (bool e)
 978 {
 979         _encrypted = e;
 980         signal_changed (ENCRYPTED);
 981 }
 982
 983 void
 984 Film::set_key (dcp::Key key)
 985 {
 986         _key = key;
 987         signal_changed (KEY);
 988 }
 989
 990 ContentList
 991 Film::content () const
 992 {
 993         return _playlist->content ();
 994 }
 995
 996 void
 997 Film::examine_content (shared_ptr<Content> c)
 998 {
 999         shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
1000         JobManager::instance()->add (j);
1001 }
1002
1003 void
1004 Film::examine_and_add_content (shared_ptr<Content> c)
1005 {
1006         if (dynamic_pointer_cast<FFmpegContent> (c) && !_directory.empty ()) {
1007                 run_ffprobe (c->path(0), file ("ffprobe.log"), _log);
1008         }
1009
1010         shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
1011
1012         _job_connections.push_back (
1013                 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job> (j), weak_ptr<Content> (c)))
1014                 );
1015
1016         JobManager::instance()->add (j);
1017 }
1018
1019 void
1020 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
1021 {
1022         shared_ptr<Job> job = j.lock ();
1023         if (!job || !job->finished_ok ()) {
1024                 return;
1025         }
1026
1027         shared_ptr<Content> content = c.lock ();
1028         if (!content) {
1029                 return;
1030         }
1031
1032         add_content (content);
1033         if (Config::instance()->automatic_audio_analysis() && content->audio) {
1034                 shared_ptr<Playlist> playlist (new Playlist);
1035                 playlist->add (content);
1036                 boost::signals2::connection c;
1037                 JobManager::instance()->analyse_audio (
1038                         shared_from_this (), playlist, c, bind (&Film::audio_analysis_finished, this)
1039                         );
1040                 _audio_analysis_connections.push_back (c);
1041         }
1042 }
1043
1044 void
1045 Film::add_content (shared_ptr<Content> c)
1046 {
1047         /* Add {video,subtitle} content after any existing {video,subtitle} content */
1048         if (c->video) {
1049                 c->set_position (_playlist->video_end ());
1050         } else if (c->subtitle) {
1051                 c->set_position (_playlist->subtitle_end ());
1052         }
1053
1054         _playlist->add (c);
1055 }
1056
1057 void
1058 Film::remove_content (shared_ptr<Content> c)
1059 {
1060         _playlist->remove (c);
1061 }
1062
1063 void
1064 Film::move_content_earlier (shared_ptr<Content> c)
1065 {
1066         _playlist->move_earlier (c);
1067 }
1068
1069 void
1070 Film::move_content_later (shared_ptr<Content> c)
1071 {
1072         _playlist->move_later (c);
1073 }
1074
1075 /** @return length of the film from time 0 to the last thing on the playlist */
1076 DCPTime
1077 Film::length () const
1078 {
1079         return _playlist->length ();
1080 }
1081
1082 int
1083 Film::best_video_frame_rate () const
1084 {
1085         return _playlist->best_dcp_frame_rate ();
1086 }
1087
1088 FrameRateChange
1089 Film::active_frame_rate_change (DCPTime t) const
1090 {
1091         return _playlist->active_frame_rate_change (t, video_frame_rate ());
1092 }
1093
1094 void
1095 Film::playlist_content_changed (weak_ptr<Content> c, int p, bool frequent)
1096 {
1097         _dirty = true;
1098
1099         if (p == VideoContentProperty::FRAME_RATE) {
1100                 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
1101         } else if (p == AudioContentProperty::STREAMS) {
1102                 signal_changed (NAME);
1103         }
1104
1105         emit (boost::bind (boost::ref (ContentChanged), c, p, frequent));
1106 }
1107
1108 void
1109 Film::playlist_changed ()
1110 {
1111         signal_changed (CONTENT);
1112         signal_changed (NAME);
1113 }
1114
1115 void
1116 Film::playlist_order_changed ()
1117 {
1118         signal_changed (CONTENT_ORDER);
1119 }
1120
1121 int
1122 Film::audio_frame_rate () const
1123 {
1124         BOOST_FOREACH (shared_ptr<Content> i, content ()) {
1125                 if (i->audio && i->audio->has_rate_above_48k ()) {
1126                         return 96000;
1127                 }
1128         }
1129
1130         return 48000;
1131 }
1132
1133 void
1134 Film::set_sequence (bool s)
1135 {
1136         _sequence = s;
1137         _playlist->set_sequence (s);
1138         signal_changed (SEQUENCE);
1139 }
1140
1141 /** @return Size of the largest possible image in whatever resolution we are using */
1142 dcp::Size
1143 Film::full_frame () const
1144 {
1145         switch (_resolution) {
1146         case RESOLUTION_2K:
1147                 return dcp::Size (2048, 1080);
1148         case RESOLUTION_4K:
1149                 return dcp::Size (4096, 2160);
1150         }
1151
1152         DCPOMATIC_ASSERT (false);
1153         return dcp::Size ();
1154 }
1155
1156 /** @return Size of the frame */
1157 dcp::Size
1158 Film::frame_size () const
1159 {
1160         return fit_ratio_within (container()->ratio(), full_frame ());
1161 }
1162
1163 /** @param from KDM from time expressed as a local time with an offset from UTC
1164  *  @param to KDM to time expressed as a local time with an offset from UTC
1165  */
1166 dcp::EncryptedKDM
1167 Film::make_kdm (
1168         dcp::Certificate recipient,
1169         vector<dcp::Certificate> trusted_devices,
1170         boost::filesystem::path cpl_file,
1171         dcp::LocalTime from,
1172         dcp::LocalTime until,
1173         dcp::Formulation formulation
1174         ) const
1175 {
1176         shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
1177         shared_ptr<const dcp::CertificateChain> signer = Config::instance()->signer_chain ();
1178         if (!signer->valid ()) {
1179                 throw InvalidSignerError ();
1180         }
1181
1182         return dcp::DecryptedKDM (
1183                 cpl, key(), from, until, cpl->content_title_text(), cpl->content_title_text(), dcp::LocalTime().as_string()
1184                 ).encrypt (signer, recipient, trusted_devices, formulation);
1185 }
1186
1187 /** @param from KDM from time expressed as a local time in the time zone of the Screen's Cinema.
1188  *  @param to KDM to time expressed as a local time in the time zone of the Screen's Cinema.
1189  */
1190 list<ScreenKDM>
1191 Film::make_kdms (
1192         list<shared_ptr<Screen> > screens,
1193         boost::filesystem::path dcp,
1194         boost::posix_time::ptime from,
1195         boost::posix_time::ptime until,
1196         dcp::Formulation formulation
1197         ) const
1198 {
1199         list<ScreenKDM> kdms;
1200
1201         BOOST_FOREACH (shared_ptr<Screen> i, screens) {
1202                 if (i->recipient) {
1203                         dcp::EncryptedKDM const kdm = make_kdm (
1204                                 i->recipient.get(),
1205                                 i->trusted_devices,
1206                                 dcp,
1207                                 dcp::LocalTime (from, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
1208                                 dcp::LocalTime (until, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
1209                                 formulation
1210                                 );
1211
1212                         kdms.push_back (ScreenKDM (i, kdm));
1213                 }
1214         }
1215
1216         return kdms;
1217 }
1218
1219 /** @return The approximate disk space required to encode a DCP of this film with the
1220  *  current settings, in bytes.
1221  */
1222 uint64_t
1223 Film::required_disk_space () const
1224 {
1225         return _playlist->required_disk_space (j2k_bandwidth(), audio_channels(), audio_frame_rate());
1226 }
1227
1228 /** This method checks the disk that the Film is on and tries to decide whether or not
1229  *  there will be enough space to make a DCP for it.  If so, true is returned; if not,
1230  *  false is returned and required and available are filled in with the amount of disk space
1231  *  required and available respectively (in Gb).
1232  *
1233  *  Note: the decision made by this method isn't, of course, 100% reliable.
1234  */
1235 bool
1236 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1237 {
1238         /* Create a test file and see if we can hard-link it */
1239         boost::filesystem::path test = internal_video_asset_dir() / "test";
1240         boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1241         can_hard_link = true;
1242         FILE* f = fopen_boost (test, "w");
1243         if (f) {
1244                 fclose (f);
1245                 boost::system::error_code ec;
1246                 boost::filesystem::create_hard_link (test, test2, ec);
1247                 if (ec) {
1248                         can_hard_link = false;
1249                 }
1250                 boost::filesystem::remove (test);
1251                 boost::filesystem::remove (test2);
1252         }
1253
1254         boost::filesystem::space_info s = boost::filesystem::space (internal_video_asset_dir ());
1255         required = double (required_disk_space ()) / 1073741824.0f;
1256         if (!can_hard_link) {
1257                 required *= 2;
1258         }
1259         available = double (s.available) / 1073741824.0f;
1260         return (available - required) > 1;
1261 }
1262
1263 string
1264 Film::subtitle_language () const
1265 {
1266         set<string> languages;
1267
1268         ContentList cl = content ();
1269         BOOST_FOREACH (shared_ptr<Content>& c, cl) {
1270                 if (c->subtitle) {
1271                         languages.insert (c->subtitle->language ());
1272                 }
1273         }
1274
1275         string all;
1276         BOOST_FOREACH (string s, languages) {
1277                 if (!all.empty ()) {
1278                         all += "/" + s;
1279                 } else {
1280                         all += s;
1281                 }
1282         }
1283
1284         return all;
1285 }
1286
1287 /** Change the gains of the supplied AudioMapping to make it a default
1288  *  for this film.  The defaults are guessed based on what processor (if any)
1289  *  is in use and the number of input channels.
1290  */
1291 void
1292 Film::make_audio_mapping_default (AudioMapping& mapping) const
1293 {
1294         if (audio_processor ()) {
1295                 audio_processor()->make_audio_mapping_default (mapping);
1296         } else {
1297                 mapping.make_zero ();
1298                 if (mapping.input_channels() == 1) {
1299                         /* Mono -> Centre */
1300                         mapping.set (0, static_cast<int> (dcp::CENTRE), 1);
1301                 } else {
1302                         /* 1:1 mapping */
1303                         for (int i = 0; i < min (mapping.input_channels(), mapping.output_channels()); ++i) {
1304                                 mapping.set (i, i, 1);
1305                         }
1306                 }
1307         }
1308 }
1309
1310 /** @return The names of the channels that audio contents' outputs are passed into;
1311  *  this is either the DCP or a AudioProcessor.
1312  */
1313 vector<string>
1314 Film::audio_output_names () const
1315 {
1316         if (audio_processor ()) {
1317                 return audio_processor()->input_names ();
1318         }
1319
1320         DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1321
1322         vector<string> n;
1323         n.push_back (_("L"));
1324         n.push_back (_("R"));
1325         n.push_back (_("C"));
1326         n.push_back (_("Lfe"));
1327         n.push_back (_("Ls"));
1328         n.push_back (_("Rs"));
1329         n.push_back (_("HI"));
1330         n.push_back (_("VI"));
1331         n.push_back (_("Lc"));
1332         n.push_back (_("Rc"));
1333         n.push_back (_("BsL"));
1334         n.push_back (_("BsR"));
1335         n.push_back (_("DBP"));
1336         n.push_back (_("DBS"));
1337         n.push_back ("");
1338         n.push_back ("");
1339
1340         return vector<string> (n.begin(), n.begin() + audio_channels ());
1341 }
1342
1343 void
1344 Film::repeat_content (ContentList c, int n)
1345 {
1346         _playlist->repeat (c, n);
1347 }
1348
1349 void
1350 Film::remove_content (ContentList c)
1351 {
1352         _playlist->remove (c);
1353 }
1354
1355 void
1356 Film::audio_analysis_finished ()
1357 {
1358         /* XXX */
1359 }
1360
1361 list<DCPTimePeriod>
1362 Film::reels () const
1363 {
1364         list<DCPTimePeriod> p;
1365         DCPTime const len = length().round_up (video_frame_rate ());
1366
1367         switch (reel_type ()) {
1368         case REELTYPE_SINGLE:
1369                 p.push_back (DCPTimePeriod (DCPTime (), len));
1370                 break;
1371         case REELTYPE_BY_VIDEO_CONTENT:
1372         {
1373                 optional<DCPTime> last_split;
1374                 shared_ptr<Content> last_video;
1375                 ContentList cl = content ();
1376                 BOOST_FOREACH (shared_ptr<Content> c, content ()) {
1377                         if (c->video) {
1378                                 BOOST_FOREACH (DCPTime t, c->reel_split_points()) {
1379                                         if (last_split) {
1380                                                 p.push_back (DCPTimePeriod (last_split.get(), t));
1381                                         }
1382                                         last_split = t;
1383                                 }
1384                                 last_video = c;
1385                         }
1386                 }
1387
1388                 DCPTime video_end = last_video ? last_video->end() : DCPTime(0);
1389                 if (last_split) {
1390                         /* Definitely go from the last split to the end of the video content */
1391                         p.push_back (DCPTimePeriod (last_split.get(), video_end));
1392                 }
1393
1394                 if (video_end < len) {
1395                         /* And maybe go after that as well if there is any non-video hanging over the end */
1396                         p.push_back (DCPTimePeriod (video_end, len));
1397                 }
1398                 break;
1399         }
1400         case REELTYPE_BY_LENGTH:
1401         {
1402                 DCPTime current;
1403                 /* Integer-divide reel length by the size of one frame to give the number of frames per reel */
1404                 Frame const reel_in_frames = _reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8);
1405                 while (current < len) {
1406                         DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1407                         p.push_back (DCPTimePeriod (current, end));
1408                         current = end;
1409                 }
1410                 break;
1411         }
1412         }
1413
1414         return p;
1415 }