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