src/lib/film.cc

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