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