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