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 (true)
 131         , _interop (Config::instance()->default_interop ())
 132         , _audio_processor (0)
 133         , _reel_type (REELTYPE_SINGLE)
 134         , _reel_length (2000000000)
 135         , _upload_after_make_dcp (false)
 136         , _state_version (current_state_version)
 137         , _dirty (false)
 138 {
 139         set_isdcf_date_today ();
 140
 141         _playlist_changed_connection = _playlist->Changed.connect (bind (&Film::playlist_changed, this));
 142         _playlist_order_changed_connection = _playlist->OrderChanged.connect (bind (&Film::playlist_order_changed, this));
 143         _playlist_content_changed_connection = _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2, _3));
 144
 145         /* Make state.directory a complete path without ..s (where possible)
 146            (Code swiped from Adam Bowen on stackoverflow)
 147            XXX: couldn't/shouldn't this just be boost::filesystem::canonical?
 148         */
 149
 150         boost::filesystem::path p (boost::filesystem::system_complete (dir));
 151         boost::filesystem::path result;
 152         for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
 153                 if (*i == "..") {
 154                         if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
 155                                 result /= *i;
 156                         } else {
 157                                 result = result.parent_path ();
 158                         }
 159                 } else if (*i != ".") {
 160                         result /= *i;
 161                 }
 162         }
 163
 164         set_directory (result.make_preferred ());
 165         if (log) {
 166                 _log.reset (new FileLog (file ("log")));
 167         } else {
 168                 _log.reset (new NullLog);
 169         }
 170
 171         _playlist->set_sequence (_sequence);
 172 }
 173
 174 Film::~Film ()
 175 {
 176         BOOST_FOREACH (boost::signals2::connection& i, _job_connections) {
 177                 i.disconnect ();
 178         }
 179
 180         BOOST_FOREACH (boost::signals2::connection& i, _audio_analysis_connections) {
 181                 i.disconnect ();
 182         }
 183 }
 184
 185 string
 186 Film::video_identifier () const
 187 {
 188         DCPOMATIC_ASSERT (container ());
 189
 190         SafeStringStream s;
 191         s.imbue (std::locale::classic ());
 192
 193         s << container()->id()
 194           << "_" << resolution_to_string (_resolution)
 195           << "_" << _playlist->video_identifier()
 196           << "_" << _video_frame_rate
 197           << "_" << j2k_bandwidth();
 198
 199         if (encrypted ()) {
 200                 s << "_E";
 201         } else {
 202                 s << "_P";
 203         }
 204
 205         if (_interop) {
 206                 s << "_I";
 207         } else {
 208                 s << "_S";
 209         }
 210
 211         if (_three_d) {
 212                 s << "_3D";
 213         }
 214
 215         return s.str ();
 216 }
 217
 218 /** @return The file to write video frame info to */
 219 boost::filesystem::path
 220 Film::info_file (DCPTimePeriod period) const
 221 {
 222         boost::filesystem::path p;
 223         p /= "info";
 224         p /= video_identifier () + "_" + raw_convert<string> (period.from.get()) + "_" + raw_convert<string> (period.to.get());
 225         return file (p);
 226 }
 227
 228 boost::filesystem::path
 229 Film::internal_video_asset_dir () const
 230 {
 231         return dir ("video");
 232 }
 233
 234 boost::filesystem::path
 235 Film::internal_video_asset_filename (DCPTimePeriod p) const
 236 {
 237         return video_identifier() + "_" + raw_convert<string> (p.from.get()) + "_" + raw_convert<string> (p.to.get()) + ".mxf";
 238 }
 239
 240 boost::filesystem::path
 241 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
 242 {
 243         boost::filesystem::path p = dir ("analysis");
 244
 245         MD5Digester digester;
 246         BOOST_FOREACH (shared_ptr<Content> i, playlist->content ()) {
 247                 shared_ptr<AudioContent> ac = dynamic_pointer_cast<AudioContent> (i);
 248                 if (!ac) {
 249                         continue;
 250                 }
 251
 252                 digester.add (ac->digest ());
 253                 digester.add (ac->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 (ac->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 /** @return a ISDCF-compliant name for a DCP of this film */
 496 string
 497 Film::isdcf_name (bool if_created_now) const
 498 {
 499         SafeStringStream d;
 500
 501         string raw_name = name ();
 502
 503         /* Split the raw name up into words */
 504         vector<string> words;
 505         split (words, raw_name, is_any_of (" _-"));
 506
 507         string fixed_name;
 508
 509         /* Add each word to fixed_name */
 510         for (vector<string>::const_iterator i = words.begin(); i != words.end(); ++i) {
 511                 string w = *i;
 512
 513                 /* First letter is always capitalised */
 514                 w[0] = toupper (w[0]);
 515
 516                 /* Count caps in w */
 517                 size_t caps = 0;
 518                 for (size_t i = 0; i < w.size(); ++i) {
 519                         if (isupper (w[i])) {
 520                                 ++caps;
 521                         }
 522                 }
 523
 524                 /* If w is all caps make the rest of it lower case, otherwise
 525                    leave it alone.
 526                 */
 527                 if (caps == w.size ()) {
 528                         for (size_t i = 1; i < w.size(); ++i) {
 529                                 w[i] = tolower (w[i]);
 530                         }
 531                 }
 532
 533                 for (size_t i = 0; i < w.size(); ++i) {
 534                         fixed_name += w[i];
 535                 }
 536         }
 537
 538         if (fixed_name.length() > 14) {
 539                 fixed_name = fixed_name.substr (0, 14);
 540         }
 541
 542         d << fixed_name;
 543
 544         if (dcp_content_type()) {
 545                 d << "_" << dcp_content_type()->isdcf_name();
 546                 d << "-" << isdcf_metadata().content_version;
 547         }
 548
 549         ISDCFMetadata const dm = isdcf_metadata ();
 550
 551         if (dm.temp_version) {
 552                 d << "-Temp";
 553         }
 554
 555         if (dm.pre_release) {
 556                 d << "-Pre";
 557         }
 558
 559         if (dm.red_band) {
 560                 d << "-RedBand";
 561         }
 562
 563         if (!dm.chain.empty ()) {
 564                 d << "-" << dm.chain;
 565         }
 566
 567         if (three_d ()) {
 568                 d << "-3D";
 569         }
 570
 571         if (dm.two_d_version_of_three_d) {
 572                 d << "-2D";
 573         }
 574
 575         if (!dm.mastered_luminance.empty ()) {
 576                 d << "-" << dm.mastered_luminance;
 577         }
 578
 579         if (video_frame_rate() != 24) {
 580                 d << "-" << video_frame_rate();
 581         }
 582
 583         if (container()) {
 584                 d << "_" << container()->isdcf_name();
 585         }
 586
 587         /* XXX: this uses the first bit of content only */
 588
 589         /* The standard says we don't do this for trailers, for some strange reason */
 590         if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::TRAILER) {
 591                 Ratio const * content_ratio = 0;
 592                 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
 593                         shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (i);
 594                         if (vc) {
 595                                 /* Here's the first piece of video content */
 596                                 if (vc->scale().ratio ()) {
 597                                         content_ratio = vc->scale().ratio ();
 598                                 } else {
 599                                         content_ratio = Ratio::from_ratio (vc->video_size().ratio ());
 600                                 }
 601                                 break;
 602                         }
 603                 }
 604
 605                 if (content_ratio && content_ratio != container()) {
 606                         d << "-" << content_ratio->isdcf_name();
 607                 }
 608         }
 609
 610         if (!dm.audio_language.empty ()) {
 611                 d << "_" << dm.audio_language;
 612                 if (!dm.subtitle_language.empty()) {
 613
 614                         bool burnt_in = false;
 615                         BOOST_FOREACH (shared_ptr<Content> i, content ()) {
 616                                 shared_ptr<SubtitleContent> sc = dynamic_pointer_cast<SubtitleContent> (i);
 617                                 if (!sc) {
 618                                         continue;
 619                                 }
 620
 621                                 if (sc->use_subtitles() && sc->burn_subtitles()) {
 622                                         burnt_in = true;
 623                                 }
 624                         }
 625
 626                         string language = dm.subtitle_language;
 627                         if (burnt_in) {
 628                                 transform (language.begin(), language.end(), language.begin(), ::tolower);
 629                         } else {
 630                                 transform (language.begin(), language.end(), language.begin(), ::toupper);
 631                         }
 632
 633                         d << "-" << language;
 634                 } else {
 635                         d << "-XX";
 636                 }
 637         }
 638
 639         if (!dm.territory.empty ()) {
 640                 d << "_" << dm.territory;
 641                 if (dm.rating.empty ()) {
 642                         d << "-NR";
 643                 } else {
 644                         d << "-" << dm.rating;
 645                 }
 646         }
 647
 648         /* Find all mapped channels */
 649
 650         int non_lfe = 0;
 651         int lfe = 0;
 652
 653         if (audio_processor ()) {
 654                 /* Processors are mapped 1:1 to DCP outputs so we can guess the number of LFE/
 655                    non-LFE from the channel counts.
 656                 */
 657                 non_lfe = audio_processor()->out_channels ();
 658                 if (non_lfe >= 4) {
 659                         --non_lfe;
 660                         ++lfe;
 661                 }
 662         } else {
 663                 list<int> mapped;
 664                 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
 665                         shared_ptr<const AudioContent> ac = dynamic_pointer_cast<const AudioContent> (i);
 666                         if (ac) {
 667                                 list<int> c = ac->audio_mapping().mapped_output_channels ();
 668                                 copy (c.begin(), c.end(), back_inserter (mapped));
 669                         }
 670                 }
 671
 672                 mapped.sort ();
 673                 mapped.unique ();
 674
 675                 /* Count them */
 676
 677                 for (list<int>::const_iterator i = mapped.begin(); i != mapped.end(); ++i) {
 678                         if (*i >= audio_channels()) {
 679                                 /* This channel is mapped but is not included in the DCP */
 680                                 continue;
 681                         }
 682
 683                         if (static_cast<dcp::Channel> (*i) == dcp::LFE) {
 684                                 ++lfe;
 685                         } else {
 686                                 ++non_lfe;
 687                         }
 688                 }
 689         }
 690
 691         if (non_lfe) {
 692                 d << "_" << non_lfe << lfe;
 693         }
 694
 695         /* XXX: HI/VI */
 696
 697         d << "_" << resolution_to_string (_resolution);
 698
 699         if (!dm.studio.empty ()) {
 700                 d << "_" << dm.studio;
 701         }
 702
 703         if (if_created_now) {
 704                 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
 705         } else {
 706                 d << "_" << boost::gregorian::to_iso_string (_isdcf_date);
 707         }
 708
 709         if (!dm.facility.empty ()) {
 710                 d << "_" << dm.facility;
 711         }
 712
 713         if (_interop) {
 714                 d << "_IOP";
 715         } else {
 716                 d << "_SMPTE";
 717         }
 718
 719         if (three_d ()) {
 720                 d << "-3D";
 721         }
 722
 723         bool vf = false;
 724         BOOST_FOREACH (shared_ptr<Content> i, content ()) {
 725                 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (i);
 726                 if (dc && (dc->reference_video() || dc->reference_audio() || dc->reference_subtitle())) {
 727                         vf = true;
 728                 }
 729         }
 730
 731         if (vf) {
 732                 d << "_VF";
 733         } else {
 734                 d << "_OV";
 735         }
 736
 737         return d.str ();
 738 }
 739
 740 /** @return name to give the DCP */
 741 string
 742 Film::dcp_name (bool if_created_now) const
 743 {
 744         string unfiltered;
 745         if (use_isdcf_name()) {
 746                 unfiltered = isdcf_name (if_created_now);
 747         } else {
 748                 unfiltered = name ();
 749         }
 750
 751         /* Filter out `bad' characters which cause problems with some systems.
 752            There's no apparent list of what really is allowed, so this is a guess.
 753         */
 754
 755         string filtered;
 756         string const allowed = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_";
 757         for (size_t i = 0; i < unfiltered.size(); ++i) {
 758                 if (allowed.find (unfiltered[i]) != string::npos) {
 759                         filtered += unfiltered[i];
 760                 }
 761         }
 762
 763         return filtered;
 764 }
 765
 766 void
 767 Film::set_directory (boost::filesystem::path d)
 768 {
 769         _directory = d;
 770         _dirty = true;
 771 }
 772
 773 void
 774 Film::set_name (string n)
 775 {
 776         _name = n;
 777         signal_changed (NAME);
 778 }
 779
 780 void
 781 Film::set_use_isdcf_name (bool u)
 782 {
 783         _use_isdcf_name = u;
 784         signal_changed (USE_ISDCF_NAME);
 785 }
 786
 787 void
 788 Film::set_dcp_content_type (DCPContentType const * t)
 789 {
 790         _dcp_content_type = t;
 791         signal_changed (DCP_CONTENT_TYPE);
 792 }
 793
 794 void
 795 Film::set_container (Ratio const * c)
 796 {
 797         _container = c;
 798         signal_changed (CONTAINER);
 799 }
 800
 801 void
 802 Film::set_resolution (Resolution r)
 803 {
 804         _resolution = r;
 805         signal_changed (RESOLUTION);
 806 }
 807
 808 void
 809 Film::set_j2k_bandwidth (int b)
 810 {
 811         _j2k_bandwidth = b;
 812         signal_changed (J2K_BANDWIDTH);
 813 }
 814
 815 void
 816 Film::set_isdcf_metadata (ISDCFMetadata m)
 817 {
 818         _isdcf_metadata = m;
 819         signal_changed (ISDCF_METADATA);
 820 }
 821
 822 void
 823 Film::set_video_frame_rate (int f)
 824 {
 825         _video_frame_rate = f;
 826         signal_changed (VIDEO_FRAME_RATE);
 827 }
 828
 829 void
 830 Film::set_audio_channels (int c)
 831 {
 832         _audio_channels = c;
 833         signal_changed (AUDIO_CHANNELS);
 834 }
 835
 836 void
 837 Film::set_three_d (bool t)
 838 {
 839         _three_d = t;
 840         signal_changed (THREE_D);
 841
 842         if (_three_d && _isdcf_metadata.two_d_version_of_three_d) {
 843                 _isdcf_metadata.two_d_version_of_three_d = false;
 844                 signal_changed (ISDCF_METADATA);
 845         }
 846 }
 847
 848 void
 849 Film::set_interop (bool i)
 850 {
 851         _interop = i;
 852         signal_changed (INTEROP);
 853 }
 854
 855 void
 856 Film::set_audio_processor (AudioProcessor const * processor)
 857 {
 858         _audio_processor = processor;
 859         signal_changed (AUDIO_PROCESSOR);
 860         signal_changed (AUDIO_CHANNELS);
 861 }
 862
 863 void
 864 Film::set_reel_type (ReelType t)
 865 {
 866         _reel_type = t;
 867         signal_changed (REEL_TYPE);
 868 }
 869
 870 /** @param r Desired reel length in bytes */
 871 void
 872 Film::set_reel_length (int64_t r)
 873 {
 874         _reel_length = r;
 875         signal_changed (REEL_LENGTH);
 876 }
 877
 878 void
 879 Film::set_upload_after_make_dcp (bool u)
 880 {
 881         _upload_after_make_dcp = u;
 882         signal_changed (UPLOAD_AFTER_MAKE_DCP);
 883 }
 884
 885 void
 886 Film::signal_changed (Property p)
 887 {
 888         _dirty = true;
 889
 890         switch (p) {
 891         case Film::CONTENT:
 892                 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
 893                 break;
 894         case Film::VIDEO_FRAME_RATE:
 895         case Film::SEQUENCE:
 896                 _playlist->maybe_sequence ();
 897                 break;
 898         default:
 899                 break;
 900         }
 901
 902         emit (boost::bind (boost::ref (Changed), p));
 903 }
 904
 905 void
 906 Film::set_isdcf_date_today ()
 907 {
 908         _isdcf_date = boost::gregorian::day_clock::local_day ();
 909 }
 910
 911 boost::filesystem::path
 912 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
 913 {
 914         boost::filesystem::path p;
 915         p /= "j2c";
 916         p /= video_identifier ();
 917
 918         SafeStringStream s;
 919         s.width (8);
 920         s << setfill('0') << reel << "_" << frame;
 921
 922         if (eyes == EYES_LEFT) {
 923                 s << ".L";
 924         } else if (eyes == EYES_RIGHT) {
 925                 s << ".R";
 926         }
 927
 928         s << ".j2c";
 929
 930         if (tmp) {
 931                 s << ".tmp";
 932         }
 933
 934         p /= s.str();
 935         return file (p);
 936 }
 937
 938 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs */
 939 vector<CPLSummary>
 940 Film::cpls () const
 941 {
 942         vector<CPLSummary> out;
 943
 944         boost::filesystem::path const dir = directory ();
 945         for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
 946                 if (
 947                         boost::filesystem::is_directory (*i) &&
 948                         i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
 949                         ) {
 950
 951                         try {
 952                                 dcp::DCP dcp (*i);
 953                                 dcp.read ();
 954                                 out.push_back (
 955                                         CPLSummary (
 956                                                 i->path().leaf().string(),
 957                                                 dcp.cpls().front()->id(),
 958                                                 dcp.cpls().front()->annotation_text(),
 959                                                 dcp.cpls().front()->file()
 960                                                 )
 961                                         );
 962                         } catch (...) {
 963
 964                         }
 965                 }
 966         }
 967
 968         return out;
 969 }
 970
 971 void
 972 Film::set_signed (bool s)
 973 {
 974         _signed = s;
 975         signal_changed (SIGNED);
 976 }
 977
 978 void
 979 Film::set_encrypted (bool e)
 980 {
 981         _encrypted = e;
 982         signal_changed (ENCRYPTED);
 983 }
 984
 985 void
 986 Film::set_key (dcp::Key key)
 987 {
 988         _key = key;
 989         signal_changed (KEY);
 990 }
 991
 992 ContentList
 993 Film::content () const
 994 {
 995         return _playlist->content ();
 996 }
 997
 998 void
 999 Film::examine_content (shared_ptr<Content> c)
1000 {
1001         shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
1002         JobManager::instance()->add (j);
1003 }
1004
1005 void
1006 Film::examine_and_add_content (shared_ptr<Content> c)
1007 {
1008         if (dynamic_pointer_cast<FFmpegContent> (c) && !_directory.empty ()) {
1009                 run_ffprobe (c->path(0), file ("ffprobe.log"), _log);
1010         }
1011
1012         shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
1013
1014         _job_connections.push_back (
1015                 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job> (j), weak_ptr<Content> (c)))
1016                 );
1017
1018         JobManager::instance()->add (j);
1019 }
1020
1021 void
1022 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
1023 {
1024         shared_ptr<Job> job = j.lock ();
1025         if (!job || !job->finished_ok ()) {
1026                 return;
1027         }
1028
1029         shared_ptr<Content> content = c.lock ();
1030         if (!content) {
1031                 return;
1032         }
1033
1034         add_content (content);
1035         if (Config::instance()->automatic_audio_analysis() && dynamic_pointer_cast<AudioContent> (content)) {
1036                 shared_ptr<Playlist> playlist (new Playlist);
1037                 playlist->add (content);
1038                 boost::signals2::connection c;
1039                 JobManager::instance()->analyse_audio (
1040                         shared_from_this (), playlist, c, bind (&Film::audio_analysis_finished, this)
1041                         );
1042                 _audio_analysis_connections.push_back (c);
1043         }
1044 }
1045
1046 void
1047 Film::add_content (shared_ptr<Content> c)
1048 {
1049         /* Add {video,subtitle} content after any existing {video,subtitle} content */
1050         if (dynamic_pointer_cast<VideoContent> (c)) {
1051                 c->set_position (_playlist->video_end ());
1052         } else if (dynamic_pointer_cast<SubtitleContent> (c)) {
1053                 c->set_position (_playlist->subtitle_end ());
1054         }
1055
1056         _playlist->add (c);
1057 }
1058
1059 void
1060 Film::remove_content (shared_ptr<Content> c)
1061 {
1062         _playlist->remove (c);
1063 }
1064
1065 void
1066 Film::move_content_earlier (shared_ptr<Content> c)
1067 {
1068         _playlist->move_earlier (c);
1069 }
1070
1071 void
1072 Film::move_content_later (shared_ptr<Content> c)
1073 {
1074         _playlist->move_later (c);
1075 }
1076
1077 /** @return length of the film from time 0 to the last thing on the playlist */
1078 DCPTime
1079 Film::length () const
1080 {
1081         return _playlist->length ();
1082 }
1083
1084 int
1085 Film::best_video_frame_rate () const
1086 {
1087         return _playlist->best_dcp_frame_rate ();
1088 }
1089
1090 FrameRateChange
1091 Film::active_frame_rate_change (DCPTime t) const
1092 {
1093         return _playlist->active_frame_rate_change (t, video_frame_rate ());
1094 }
1095
1096 void
1097 Film::playlist_content_changed (weak_ptr<Content> c, int p, bool frequent)
1098 {
1099         _dirty = true;
1100
1101         if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
1102                 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
1103         } else if (p == AudioContentProperty::AUDIO_STREAMS) {
1104                 signal_changed (NAME);
1105         }
1106
1107         emit (boost::bind (boost::ref (ContentChanged), c, p, frequent));
1108 }
1109
1110 void
1111 Film::playlist_changed ()
1112 {
1113         signal_changed (CONTENT);
1114         signal_changed (NAME);
1115 }
1116
1117 void
1118 Film::playlist_order_changed ()
1119 {
1120         signal_changed (CONTENT_ORDER);
1121 }
1122
1123 int
1124 Film::audio_frame_rate () const
1125 {
1126         BOOST_FOREACH (shared_ptr<Content> i, content ()) {
1127                 shared_ptr<AudioContent> a = dynamic_pointer_cast<AudioContent> (i);
1128                 if (a && a->has_rate_above_48k ()) {
1129                         return 96000;
1130                 }
1131         }
1132
1133         return 48000;
1134 }
1135
1136 void
1137 Film::set_sequence (bool s)
1138 {
1139         _sequence = s;
1140         _playlist->set_sequence (s);
1141         signal_changed (SEQUENCE);
1142 }
1143
1144 /** @return Size of the largest possible image in whatever resolution we are using */
1145 dcp::Size
1146 Film::full_frame () const
1147 {
1148         switch (_resolution) {
1149         case RESOLUTION_2K:
1150                 return dcp::Size (2048, 1080);
1151         case RESOLUTION_4K:
1152                 return dcp::Size (4096, 2160);
1153         }
1154
1155         DCPOMATIC_ASSERT (false);
1156         return dcp::Size ();
1157 }
1158
1159 /** @return Size of the frame */
1160 dcp::Size
1161 Film::frame_size () const
1162 {
1163         return fit_ratio_within (container()->ratio(), full_frame ());
1164 }
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, "DCP-o-matic", cpl->content_title_text(), dcp::LocalTime().as_string()
1184                 ).encrypt (signer, recipient, trusted_devices, formulation);
1185 }
1186
1187 list<ScreenKDM>
1188 Film::make_kdms (
1189         list<shared_ptr<Screen> > screens,
1190         boost::filesystem::path dcp,
1191         dcp::LocalTime from,
1192         dcp::LocalTime until,
1193         dcp::Formulation formulation
1194         ) const
1195 {
1196         list<ScreenKDM> kdms;
1197
1198         BOOST_FOREACH (shared_ptr<Screen> i, screens) {
1199                 if (i->recipient) {
1200                         kdms.push_back (ScreenKDM (i, make_kdm (i->recipient.get(), i->trusted_devices, dcp, from, until, formulation)));
1201                 }
1202         }
1203
1204         return kdms;
1205 }
1206
1207 /** @return The approximate disk space required to encode a DCP of this film with the
1208  *  current settings, in bytes.
1209  */
1210 uint64_t
1211 Film::required_disk_space () const
1212 {
1213         return _playlist->required_disk_space (j2k_bandwidth(), audio_channels(), audio_frame_rate());
1214 }
1215
1216 /** This method checks the disk that the Film is on and tries to decide whether or not
1217  *  there will be enough space to make a DCP for it.  If so, true is returned; if not,
1218  *  false is returned and required and available are filled in with the amount of disk space
1219  *  required and available respectively (in Gb).
1220  *
1221  *  Note: the decision made by this method isn't, of course, 100% reliable.
1222  */
1223 bool
1224 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1225 {
1226         /* Create a test file and see if we can hard-link it */
1227         boost::filesystem::path test = internal_video_asset_dir() / "test";
1228         boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1229         can_hard_link = true;
1230         FILE* f = fopen_boost (test, "w");
1231         if (f) {
1232                 fclose (f);
1233                 boost::system::error_code ec;
1234                 boost::filesystem::create_hard_link (test, test2, ec);
1235                 if (ec) {
1236                         can_hard_link = false;
1237                 }
1238                 boost::filesystem::remove (test);
1239                 boost::filesystem::remove (test2);
1240         }
1241
1242         boost::filesystem::space_info s = boost::filesystem::space (internal_video_asset_dir ());
1243         required = double (required_disk_space ()) / 1073741824.0f;
1244         if (!can_hard_link) {
1245                 required *= 2;
1246         }
1247         available = double (s.available) / 1073741824.0f;
1248         return (available - required) > 1;
1249 }
1250
1251 string
1252 Film::subtitle_language () const
1253 {
1254         set<string> languages;
1255
1256         ContentList cl = content ();
1257         BOOST_FOREACH (shared_ptr<Content>& c, cl) {
1258                 shared_ptr<SubtitleContent> sc = dynamic_pointer_cast<SubtitleContent> (c);
1259                 if (sc) {
1260                         languages.insert (sc->subtitle_language ());
1261                 }
1262         }
1263
1264         string all;
1265         BOOST_FOREACH (string s, languages) {
1266                 if (!all.empty ()) {
1267                         all += "/" + s;
1268                 } else {
1269                         all += s;
1270                 }
1271         }
1272
1273         return all;
1274 }
1275
1276 /** Change the gains of the supplied AudioMapping to make it a default
1277  *  for this film.  The defaults are guessed based on what processor (if any)
1278  *  is in use and the number of input channels.
1279  */
1280 void
1281 Film::make_audio_mapping_default (AudioMapping& mapping) const
1282 {
1283         if (audio_processor ()) {
1284                 audio_processor()->make_audio_mapping_default (mapping);
1285         } else {
1286                 mapping.make_zero ();
1287                 if (mapping.input_channels() == 1) {
1288                         /* Mono -> Centre */
1289                         mapping.set (0, static_cast<int> (dcp::CENTRE), 1);
1290                 } else {
1291                         /* 1:1 mapping */
1292                         for (int i = 0; i < min (mapping.input_channels(), mapping.output_channels()); ++i) {
1293                                 mapping.set (i, i, 1);
1294                         }
1295                 }
1296         }
1297 }
1298
1299 /** @return The names of the channels that audio contents' outputs are passed into;
1300  *  this is either the DCP or a AudioProcessor.
1301  */
1302 vector<string>
1303 Film::audio_output_names () const
1304 {
1305         if (audio_processor ()) {
1306                 return audio_processor()->input_names ();
1307         }
1308
1309         DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1310
1311         vector<string> n;
1312         n.push_back (_("L"));
1313         n.push_back (_("R"));
1314         n.push_back (_("C"));
1315         n.push_back (_("Lfe"));
1316         n.push_back (_("Ls"));
1317         n.push_back (_("Rs"));
1318         n.push_back (_("HI"));
1319         n.push_back (_("VI"));
1320         n.push_back (_("Lc"));
1321         n.push_back (_("Rc"));
1322         n.push_back (_("BsL"));
1323         n.push_back (_("BsR"));
1324         n.push_back (_("DBP"));
1325         n.push_back (_("DBS"));
1326         n.push_back ("");
1327         n.push_back ("");
1328
1329         return vector<string> (n.begin(), n.begin() + audio_channels ());
1330 }
1331
1332 void
1333 Film::repeat_content (ContentList c, int n)
1334 {
1335         _playlist->repeat (c, n);
1336 }
1337
1338 void
1339 Film::remove_content (ContentList c)
1340 {
1341         _playlist->remove (c);
1342 }
1343
1344 void
1345 Film::audio_analysis_finished ()
1346 {
1347         /* XXX */
1348 }
1349
1350 list<DCPTimePeriod>
1351 Film::reels () const
1352 {
1353         list<DCPTimePeriod> p;
1354         DCPTime const len = length().round_up (video_frame_rate ());
1355
1356         switch (reel_type ()) {
1357         case REELTYPE_SINGLE:
1358                 p.push_back (DCPTimePeriod (DCPTime (), len));
1359                 break;
1360         case REELTYPE_BY_VIDEO_CONTENT:
1361         {
1362                 optional<DCPTime> last_split;
1363                 shared_ptr<VideoContent> last_video;
1364                 ContentList cl = content ();
1365                 BOOST_FOREACH (shared_ptr<Content> c, content ()) {
1366                         shared_ptr<VideoContent> v = dynamic_pointer_cast<VideoContent> (c);
1367                         if (v) {
1368                                 BOOST_FOREACH (DCPTime t, v->reel_split_points()) {
1369                                         if (last_split) {
1370                                                 p.push_back (DCPTimePeriod (last_split.get(), t));
1371                                         }
1372                                         last_split = t;
1373                                 }
1374                                 last_video = v;
1375                         }
1376                 }
1377
1378                 DCPTime video_end = last_video ? last_video->end() : DCPTime(0);
1379                 if (last_split) {
1380                         /* Definitely go from the last split to the end of the video content */
1381                         p.push_back (DCPTimePeriod (last_split.get(), video_end));
1382                 }
1383
1384                 if (video_end < len) {
1385                         /* And maybe go after that as well if there is any non-video hanging over the end */
1386                         p.push_back (DCPTimePeriod (video_end, len));
1387                 }
1388                 break;
1389         }
1390         case REELTYPE_BY_LENGTH:
1391         {
1392                 DCPTime current;
1393                 /* Integer-divide reel length by the size of one frame to give the number of frames per reel */
1394                 Frame const reel_in_frames = _reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8);
1395                 while (current < len) {
1396                         DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1397                         p.push_back (DCPTimePeriod (current, end));
1398                         current = end;
1399                 }
1400                 break;
1401         }
1402         }
1403
1404         return p;
1405 }