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