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 "scp_dcp_job.h"
  31 #include "log.h"
  32 #include "exceptions.h"
  33 #include "examine_content_job.h"
  34 #include "scaler.h"
  35 #include "config.h"
  36 #include "version.h"
  37 #include "ui_signaller.h"
  38 #include "playlist.h"
  39 #include "player.h"
  40 #include "dcp_content_type.h"
  41 #include "ratio.h"
  42 #include "cross.h"
  43 #include "cinema.h"
  44 #include "safe_stringstream.h"
  45 #include <libcxml/cxml.h>
  46 #include <dcp/cpl.h>
  47 #include <dcp/signer.h>
  48 #include <dcp/util.h>
  49 #include <dcp/local_time.h>
  50 #include <dcp/raw_convert.h>
  51 #include <dcp/decrypted_kdm.h>
  52 #include <libxml++/libxml++.h>
  53 #include <boost/filesystem.hpp>
  54 #include <boost/algorithm/string.hpp>
  55 #include <boost/lexical_cast.hpp>
  56 #include <boost/foreach.hpp>
  57 #include <unistd.h>
  58 #include <stdexcept>
  59 #include <iostream>
  60 #include <algorithm>
  61 #include <fstream>
  62 #include <cstdlib>
  63 #include <iomanip>
  64 #include <set>
  65
  66 #include "i18n.h"
  67
  68 using std::string;
  69 using std::multimap;
  70 using std::pair;
  71 using std::map;
  72 using std::vector;
  73 using std::setfill;
  74 using std::min;
  75 using std::make_pair;
  76 using std::endl;
  77 using std::cout;
  78 using std::list;
  79 using std::set;
  80 using boost::shared_ptr;
  81 using boost::weak_ptr;
  82 using boost::dynamic_pointer_cast;
  83 using boost::to_upper_copy;
  84 using boost::ends_with;
  85 using boost::starts_with;
  86 using boost::optional;
  87 using boost::is_any_of;
  88 using dcp::Size;
  89 using dcp::Signer;
  90 using dcp::raw_convert;
  91 using dcp::raw_convert;
  92
  93 #define LOG_GENERAL(...) log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
  94 #define LOG_GENERAL_NC(...) log()->log (__VA_ARGS__, Log::TYPE_GENERAL);
  95
  96 /* 5 -> 6
  97  * AudioMapping XML changed.
  98  * 6 -> 7
  99  * Subtitle offset changed to subtitle y offset, and subtitle x offset added.
 100  * 7 -> 8
 101  * Use <Scale> tag in <VideoContent> rather than <Ratio>.
 102  * 8 -> 9
 103  * DCI -> ISDCF
 104  * 9 -> 10
 105  * Subtitle X and Y scale.
 106  *
 107  * Bumped to 32 for 2.0 branch; some times are expressed in Times rather
 108  * than frames now.
 109  */
 110 int const Film::current_state_version = 32;
 111
 112 /** Construct a Film object in a given directory.
 113  *
 114  *  @param dir Film directory.
 115  */
 116
 117 Film::Film (boost::filesystem::path dir, bool log)
 118         : _playlist (new Playlist)
 119         , _use_isdcf_name (true)
 120         , _dcp_content_type (Config::instance()->default_dcp_content_type ())
 121         , _container (Config::instance()->default_container ())
 122         , _resolution (RESOLUTION_2K)
 123         , _scaler (Scaler::from_id ("bicubic"))
 124         , _signed (true)
 125         , _encrypted (false)
 126         , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
 127         , _isdcf_metadata (Config::instance()->default_isdcf_metadata ())
 128         , _video_frame_rate (24)
 129         , _audio_channels (6)
 130         , _three_d (false)
 131         , _sequence_video (true)
 132         , _interop (false)
 133         , _burn_subtitles (false)
 134         , _state_version (current_state_version)
 135         , _dirty (false)
 136 {
 137         set_isdcf_date_today ();
 138
 139         _playlist->Changed.connect (bind (&Film::playlist_changed, this));
 140         _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
 141
 142         /* Make state.directory a complete path without ..s (where possible)
 143            (Code swiped from Adam Bowen on stackoverflow)
 144         */
 145
 146         boost::filesystem::path p (boost::filesystem::system_complete (dir));
 147         boost::filesystem::path result;
 148         for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
 149                 if (*i == "..") {
 150                         if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
 151                                 result /= *i;
 152                         } else {
 153                                 result = result.parent_path ();
 154                         }
 155                 } else if (*i != ".") {
 156                         result /= *i;
 157                 }
 158         }
 159
 160         set_directory (result.make_preferred ());
 161         if (log) {
 162                 _log.reset (new FileLog (file ("log")));
 163         } else {
 164                 _log.reset (new NullLog);
 165         }
 166
 167         _playlist->set_sequence_video (_sequence_video);
 168 }
 169
 170 string
 171 Film::video_identifier () const
 172 {
 173         DCPOMATIC_ASSERT (container ());
 174
 175         SafeStringStream s;
 176         s.imbue (std::locale::classic ());
 177
 178         s << container()->id()
 179           << "_" << resolution_to_string (_resolution)
 180           << "_" << _playlist->video_identifier()
 181           << "_" << _video_frame_rate
 182           << "_" << scaler()->id()
 183           << "_" << j2k_bandwidth();
 184
 185         if (encrypted ()) {
 186                 s << "_E";
 187         } else {
 188                 s << "_P";
 189         }
 190
 191         if (_interop) {
 192                 s << "_I";
 193         } else {
 194                 s << "_S";
 195         }
 196
 197         if (_burn_subtitles) {
 198                 s << "_B";
 199         }
 200
 201         if (_three_d) {
 202                 s << "_3D";
 203         }
 204
 205         return s.str ();
 206 }
 207
 208 /** @return The path to the directory to write video frame info files to */
 209 boost::filesystem::path
 210 Film::info_dir () const
 211 {
 212         boost::filesystem::path p;
 213         p /= "info";
 214         p /= video_identifier ();
 215         return dir (p);
 216 }
 217
 218 boost::filesystem::path
 219 Film::internal_video_mxf_dir () const
 220 {
 221         return dir ("video");
 222 }
 223
 224 boost::filesystem::path
 225 Film::internal_video_mxf_filename () const
 226 {
 227         return video_identifier() + ".mxf";
 228 }
 229
 230 boost::filesystem::path
 231 Film::video_mxf_filename () const
 232 {
 233         return filename_safe_name() + "_video.mxf";
 234 }
 235
 236 boost::filesystem::path
 237 Film::audio_mxf_filename () const
 238 {
 239         return filename_safe_name() + "_audio.mxf";
 240 }
 241
 242 boost::filesystem::path
 243 Film::subtitle_xml_filename () const
 244 {
 245         return filename_safe_name() + "_subtitle.xml";
 246 }
 247
 248 string
 249 Film::filename_safe_name () const
 250 {
 251         string const n = name ();
 252         string o;
 253         for (size_t i = 0; i < n.length(); ++i) {
 254                 if (isalnum (n[i])) {
 255                         o += n[i];
 256                 } else {
 257                         o += "_";
 258                 }
 259         }
 260
 261         return o;
 262 }
 263
 264 boost::filesystem::path
 265 Film::audio_analysis_dir () const
 266 {
 267         return dir ("analysis");
 268 }
 269
 270 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
 271 void
 272 Film::make_dcp ()
 273 {
 274         set_isdcf_date_today ();
 275
 276         if (dcp_name().find ("/") != string::npos) {
 277                 throw BadSettingError (_("name"), _("cannot contain slashes"));
 278         }
 279
 280         LOG_GENERAL ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary());
 281
 282         {
 283                 char buffer[128];
 284                 gethostname (buffer, sizeof (buffer));
 285                 LOG_GENERAL ("Starting to make DCP on %1", buffer);
 286         }
 287
 288         ContentList cl = content ();
 289         for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
 290                 LOG_GENERAL ("Content: %1", (*i)->technical_summary());
 291         }
 292         LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
 293         LOG_GENERAL ("%1 threads", Config::instance()->num_local_encoding_threads());
 294         LOG_GENERAL ("J2K bandwidth %1", j2k_bandwidth());
 295 #ifdef DCPOMATIC_DEBUG
 296         LOG_GENERAL_NC ("DCP-o-matic built in debug mode.");
 297 #else
 298         LOG_GENERAL_NC ("DCP-o-matic built in optimised mode.");
 299 #endif
 300 #ifdef LIBDCP_DEBUG
 301         LOG_GENERAL_NC ("libdcp built in debug mode.");
 302 #else
 303         LOG_GENERAL_NC ("libdcp built in optimised mode.");
 304 #endif
 305
 306 #ifdef DCPOMATIC_WINDOWS
 307         OSVERSIONINFO info;
 308         info.dwOSVersionInfoSize = sizeof (info);
 309         GetVersionEx (&info);
 310         LOG_GENERAL ("Windows version %1.%2.%3 SP %4", info.dwMajorVersion, info.dwMinorVersion, info.dwBuildNumber, info.szCSDVersion);
 311 #endif
 312
 313 #if __GNUC__
 314 #if __x86_64__
 315         LOG_GENERAL_NC ("Built for 64-bit");
 316 #else
 317         LOG_GENERAL_NC ("Built for 32-bit");
 318 #endif
 319 #endif
 320
 321         LOG_GENERAL ("CPU: %1, %2 processors", cpu_info(), boost::thread::hardware_concurrency ());
 322         list<pair<string, string> > const m = mount_info ();
 323         for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
 324                 LOG_GENERAL ("Mount: %1 %2", i->first, i->second);
 325         }
 326
 327         if (container() == 0) {
 328                 throw MissingSettingError (_("container"));
 329         }
 330
 331         if (content().empty()) {
 332                 throw StringError (_("You must add some content to the DCP before creating it"));
 333         }
 334
 335         if (dcp_content_type() == 0) {
 336                 throw MissingSettingError (_("content type"));
 337         }
 338
 339         if (name().empty()) {
 340                 throw MissingSettingError (_("name"));
 341         }
 342
 343         JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
 344 }
 345
 346 /** Start a job to send our DCP to the configured TMS */
 347 void
 348 Film::send_dcp_to_tms ()
 349 {
 350         shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
 351         JobManager::instance()->add (j);
 352 }
 353
 354 /** Count the number of frames that have been encoded for this film.
 355  *  @return frame count.
 356  */
 357 int
 358 Film::encoded_frames () const
 359 {
 360         if (container() == 0) {
 361                 return 0;
 362         }
 363
 364         int N = 0;
 365         for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
 366                 ++N;
 367                 boost::this_thread::interruption_point ();
 368         }
 369
 370         return N;
 371 }
 372
 373 shared_ptr<xmlpp::Document>
 374 Film::metadata () const
 375 {
 376         shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
 377         xmlpp::Element* root = doc->create_root_node ("Metadata");
 378
 379         root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
 380         root->add_child("Name")->add_child_text (_name);
 381         root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
 382
 383         if (_dcp_content_type) {
 384                 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
 385         }
 386
 387         if (_container) {
 388                 root->add_child("Container")->add_child_text (_container->id ());
 389         }
 390
 391         root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
 392         root->add_child("Scaler")->add_child_text (_scaler->id ());
 393         root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
 394         _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
 395         root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
 396         root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
 397         root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
 398         root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
 399         root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
 400         root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
 401         root->add_child("BurnSubtitles")->add_child_text (_burn_subtitles ? "1" : "0");
 402         root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
 403         root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
 404         root->add_child("Key")->add_child_text (_key.hex ());
 405         _playlist->as_xml (root->add_child ("Playlist"));
 406
 407         return doc;
 408 }
 409
 410 /** Write state to our `metadata' file */
 411 void
 412 Film::write_metadata () const
 413 {
 414         boost::filesystem::create_directories (directory ());
 415         shared_ptr<xmlpp::Document> doc = metadata ();
 416         doc->write_to_file_formatted (file("metadata.xml").string ());
 417         _dirty = false;
 418 }
 419
 420 /** Read state from our metadata file.
 421  *  @return Notes about things that the user should know about, or empty.
 422  */
 423 list<string>
 424 Film::read_metadata ()
 425 {
 426         if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
 427                 throw StringError (_("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!"));
 428         }
 429
 430         cxml::Document f ("Metadata");
 431         f.read_file (file ("metadata.xml"));
 432
 433         _state_version = f.number_child<int> ("Version");
 434         if (_state_version > current_state_version) {
 435                 throw StringError (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version.  Sorry!"));
 436         }
 437
 438         _name = f.string_child ("Name");
 439         if (_state_version >= 9) {
 440                 _use_isdcf_name = f.bool_child ("UseISDCFName");
 441                 _isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
 442                 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
 443         } else {
 444                 _use_isdcf_name = f.bool_child ("UseDCIName");
 445                 _isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
 446                 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
 447         }
 448
 449         {
 450                 optional<string> c = f.optional_string_child ("DCPContentType");
 451                 if (c) {
 452                         _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
 453                 }
 454         }
 455
 456         {
 457                 optional<string> c = f.optional_string_child ("Container");
 458                 if (c) {
 459                         _container = Ratio::from_id (c.get ());
 460                 }
 461         }
 462
 463         _resolution = string_to_resolution (f.string_child ("Resolution"));
 464         _scaler = Scaler::from_id (f.string_child ("Scaler"));
 465         _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
 466         _video_frame_rate = f.number_child<int> ("VideoFrameRate");
 467         _signed = f.optional_bool_child("Signed").get_value_or (true);
 468         _encrypted = f.bool_child ("Encrypted");
 469         _audio_channels = f.number_child<int> ("AudioChannels");
 470         _sequence_video = f.bool_child ("SequenceVideo");
 471         _three_d = f.bool_child ("ThreeD");
 472         _interop = f.bool_child ("Interop");
 473         if (_state_version >= 32) {
 474                 _burn_subtitles = f.bool_child ("BurnSubtitles");
 475         }
 476         _key = dcp::Key (f.string_child ("Key"));
 477
 478         list<string> notes;
 479         /* This method is the only one that can return notes (so far) */
 480         _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
 481
 482         /* Write backtraces to this film's directory, until another film is loaded */
 483         set_backtrace_file (file ("backtrace.txt"));
 484
 485         _dirty = false;
 486         return notes;
 487 }
 488
 489 /** Given a directory name, return its full path within the Film's directory.
 490  *  The directory (and its parents) will be created if they do not exist.
 491  */
 492 boost::filesystem::path
 493 Film::dir (boost::filesystem::path d) const
 494 {
 495         boost::filesystem::path p;
 496         p /= _directory;
 497         p /= d;
 498
 499         boost::filesystem::create_directories (p);
 500
 501         return p;
 502 }
 503
 504 /** Given a file or directory name, return its full path within the Film's directory.
 505  *  Any required parent directories will be created.
 506  */
 507 boost::filesystem::path
 508 Film::file (boost::filesystem::path f) const
 509 {
 510         boost::filesystem::path p;
 511         p /= _directory;
 512         p /= f;
 513
 514         boost::filesystem::create_directories (p.parent_path ());
 515
 516         return p;
 517 }
 518
 519 /** @return a ISDCF-compliant name for a DCP of this film */
 520 string
 521 Film::isdcf_name (bool if_created_now) const
 522 {
 523         SafeStringStream d;
 524
 525         string raw_name = name ();
 526
 527         /* Split the raw name up into words */
 528         vector<string> words;
 529         split (words, raw_name, is_any_of (" "));
 530
 531         string fixed_name;
 532
 533         /* Add each word to fixed_name */
 534         for (vector<string>::const_iterator i = words.begin(); i != words.end(); ++i) {
 535                 string w = *i;
 536
 537                 /* First letter is always capitalised */
 538                 w[0] = toupper (w[0]);
 539
 540                 /* Count caps in w */
 541                 size_t caps = 0;
 542                 for (size_t i = 0; i < w.size(); ++i) {
 543                         if (isupper (w[i])) {
 544                                 ++caps;
 545                         }
 546                 }
 547
 548                 /* If w is all caps make the rest of it lower case, otherwise
 549                    leave it alone.
 550                 */
 551                 if (caps == w.size ()) {
 552                         for (size_t i = 1; i < w.size(); ++i) {
 553                                 w[i] = tolower (w[i]);
 554                         }
 555                 }
 556
 557                 for (size_t i = 0; i < w.size(); ++i) {
 558                         fixed_name += w[i];
 559                 }
 560         }
 561
 562         if (fixed_name.length() > 14) {
 563                 fixed_name = fixed_name.substr (0, 14);
 564         }
 565
 566         d << fixed_name;
 567
 568         if (dcp_content_type()) {
 569                 d << "_" << dcp_content_type()->isdcf_name();
 570                 d << "-" << isdcf_metadata().content_version;
 571         }
 572
 573         ISDCFMetadata const dm = isdcf_metadata ();
 574
 575         if (dm.temp_version) {
 576                 d << "-Temp";
 577         }
 578
 579         if (dm.pre_release) {
 580                 d << "-Pre";
 581         }
 582
 583         if (dm.red_band) {
 584                 d << "-RedBand";
 585         }
 586
 587         if (!dm.chain.empty ()) {
 588                 d << "-" << dm.chain;
 589         }
 590
 591         if (three_d ()) {
 592                 d << "-3D";
 593         }
 594
 595         if (dm.two_d_version_of_three_d) {
 596                 d << "-2D";
 597         }
 598
 599         if (!dm.mastered_luminance.empty ()) {
 600                 d << "-" << dm.mastered_luminance;
 601         }
 602
 603         if (video_frame_rate() != 24) {
 604                 d << "-" << video_frame_rate();
 605         }
 606
 607         if (container()) {
 608                 d << "_" << container()->isdcf_name();
 609         }
 610
 611         /* XXX: this uses the first bit of content only */
 612
 613         /* The standard says we don't do this for trailers, for some strange reason */
 614         if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::TRAILER) {
 615                 ContentList cl = content ();
 616                 Ratio const * content_ratio = 0;
 617                 for (ContentList::iterator i = cl.begin(); i != cl.end(); ++i) {
 618                         shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (*i);
 619                         if (vc) {
 620                                 /* Here's the first piece of video content */
 621                                 if (vc->scale().ratio ()) {
 622                                         content_ratio = vc->scale().ratio ();
 623                                 } else {
 624                                         content_ratio = Ratio::from_ratio (vc->video_size().ratio ());
 625                                 }
 626                                 break;
 627                         }
 628                 }
 629
 630                 if (content_ratio && content_ratio != container()) {
 631                         d << "-" << content_ratio->isdcf_name();
 632                 }
 633         }
 634
 635         if (!dm.audio_language.empty ()) {
 636                 d << "_" << dm.audio_language;
 637                 if (!dm.subtitle_language.empty()) {
 638                         d << "-" << dm.subtitle_language;
 639                 } else {
 640                         d << "-XX";
 641                 }
 642         }
 643
 644         if (!dm.territory.empty ()) {
 645                 d << "_" << dm.territory;
 646                 if (!dm.rating.empty ()) {
 647                         d << "-" << dm.rating;
 648                 }
 649         }
 650
 651         switch (audio_channels ()) {
 652         case 1:
 653                 d << "_10";
 654                 break;
 655         case 2:
 656                 d << "_20";
 657                 break;
 658         case 3:
 659                 d << "_30";
 660                 break;
 661         case 4:
 662                 d << "_40";
 663                 break;
 664         case 5:
 665                 d << "_50";
 666                 break;
 667         case 6:
 668                 d << "_51";
 669                 break;
 670         }
 671
 672         /* XXX: HI/VI */
 673
 674         d << "_" << resolution_to_string (_resolution);
 675
 676         if (!dm.studio.empty ()) {
 677                 d << "_" << dm.studio;
 678         }
 679
 680         if (if_created_now) {
 681                 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
 682         } else {
 683                 d << "_" << boost::gregorian::to_iso_string (_isdcf_date);
 684         }
 685
 686         if (!dm.facility.empty ()) {
 687                 d << "_" << dm.facility;
 688         }
 689
 690         if (_interop) {
 691                 d << "_IOP";
 692         } else {
 693                 d << "_SMPTE";
 694         }
 695
 696         if (three_d ()) {
 697                 d << "-3D";
 698         }
 699
 700         if (!dm.package_type.empty ()) {
 701                 d << "_" << dm.package_type;
 702         }
 703
 704         return d.str ();
 705 }
 706
 707 /** @return name to give the DCP */
 708 string
 709 Film::dcp_name (bool if_created_now) const
 710 {
 711         if (use_isdcf_name()) {
 712                 return isdcf_name (if_created_now);
 713         }
 714
 715         return name();
 716 }
 717
 718 void
 719 Film::set_directory (boost::filesystem::path d)
 720 {
 721         _directory = d;
 722         _dirty = true;
 723 }
 724
 725 void
 726 Film::set_name (string n)
 727 {
 728         _name = n;
 729         signal_changed (NAME);
 730 }
 731
 732 void
 733 Film::set_use_isdcf_name (bool u)
 734 {
 735         _use_isdcf_name = u;
 736         signal_changed (USE_ISDCF_NAME);
 737 }
 738
 739 void
 740 Film::set_dcp_content_type (DCPContentType const * t)
 741 {
 742         _dcp_content_type = t;
 743         signal_changed (DCP_CONTENT_TYPE);
 744 }
 745
 746 void
 747 Film::set_container (Ratio const * c)
 748 {
 749         _container = c;
 750         signal_changed (CONTAINER);
 751 }
 752
 753 void
 754 Film::set_resolution (Resolution r)
 755 {
 756         _resolution = r;
 757         signal_changed (RESOLUTION);
 758 }
 759
 760 void
 761 Film::set_scaler (Scaler const * s)
 762 {
 763         _scaler = s;
 764         signal_changed (SCALER);
 765 }
 766
 767 void
 768 Film::set_j2k_bandwidth (int b)
 769 {
 770         _j2k_bandwidth = b;
 771         signal_changed (J2K_BANDWIDTH);
 772 }
 773
 774 void
 775 Film::set_isdcf_metadata (ISDCFMetadata m)
 776 {
 777         _isdcf_metadata = m;
 778         signal_changed (ISDCF_METADATA);
 779 }
 780
 781 void
 782 Film::set_video_frame_rate (int f)
 783 {
 784         _video_frame_rate = f;
 785         signal_changed (VIDEO_FRAME_RATE);
 786 }
 787
 788 void
 789 Film::set_audio_channels (int c)
 790 {
 791         _audio_channels = c;
 792         signal_changed (AUDIO_CHANNELS);
 793 }
 794
 795 void
 796 Film::set_three_d (bool t)
 797 {
 798         _three_d = t;
 799         signal_changed (THREE_D);
 800 }
 801
 802 void
 803 Film::set_interop (bool i)
 804 {
 805         _interop = i;
 806         signal_changed (INTEROP);
 807 }
 808
 809 void
 810 Film::set_burn_subtitles (bool b)
 811 {
 812         _burn_subtitles = b;
 813         signal_changed (BURN_SUBTITLES);
 814 }
 815
 816 void
 817 Film::signal_changed (Property p)
 818 {
 819         _dirty = true;
 820
 821         switch (p) {
 822         case Film::CONTENT:
 823                 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
 824                 break;
 825         case Film::VIDEO_FRAME_RATE:
 826         case Film::SEQUENCE_VIDEO:
 827                 _playlist->maybe_sequence_video ();
 828                 break;
 829         default:
 830                 break;
 831         }
 832
 833         if (ui_signaller) {
 834                 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
 835         }
 836 }
 837
 838 void
 839 Film::set_isdcf_date_today ()
 840 {
 841         _isdcf_date = boost::gregorian::day_clock::local_day ();
 842 }
 843
 844 boost::filesystem::path
 845 Film::info_path (int f, Eyes e) const
 846 {
 847         boost::filesystem::path p;
 848         p /= info_dir ();
 849
 850         SafeStringStream s;
 851         s.width (8);
 852         s << setfill('0') << f;
 853
 854         if (e == EYES_LEFT) {
 855                 s << ".L";
 856         } else if (e == EYES_RIGHT) {
 857                 s << ".R";
 858         }
 859
 860         s << ".md5";
 861
 862         p /= s.str();
 863
 864         /* info_dir() will already have added any initial bit of the path,
 865            so don't call file() on this.
 866         */
 867         return p;
 868 }
 869
 870 boost::filesystem::path
 871 Film::j2c_path (int f, Eyes e, bool t) const
 872 {
 873         boost::filesystem::path p;
 874         p /= "j2c";
 875         p /= video_identifier ();
 876
 877         SafeStringStream s;
 878         s.width (8);
 879         s << setfill('0') << f;
 880
 881         if (e == EYES_LEFT) {
 882                 s << ".L";
 883         } else if (e == EYES_RIGHT) {
 884                 s << ".R";
 885         }
 886
 887         s << ".j2c";
 888
 889         if (t) {
 890                 s << ".tmp";
 891         }
 892
 893         p /= s.str();
 894         return file (p);
 895 }
 896
 897 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs */
 898 vector<CPLSummary>
 899 Film::cpls () const
 900 {
 901         vector<CPLSummary> out;
 902
 903         boost::filesystem::path const dir = directory ();
 904         for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
 905                 if (
 906                         boost::filesystem::is_directory (*i) &&
 907                         i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
 908                         ) {
 909
 910                         try {
 911                                 dcp::DCP dcp (*i);
 912                                 dcp.read ();
 913                                 out.push_back (
 914                                         CPLSummary (
 915                                                 i->path().leaf().string(),
 916                                                 dcp.cpls().front()->id(),
 917                                                 dcp.cpls().front()->annotation_text(),
 918                                                 dcp.cpls().front()->file()
 919                                                 )
 920                                         );
 921                         } catch (...) {
 922
 923                         }
 924                 }
 925         }
 926
 927         return out;
 928 }
 929
 930 shared_ptr<Player>
 931 Film::make_player () const
 932 {
 933         return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
 934 }
 935
 936 void
 937 Film::set_signed (bool s)
 938 {
 939         _signed = s;
 940         signal_changed (SIGNED);
 941 }
 942
 943 void
 944 Film::set_encrypted (bool e)
 945 {
 946         _encrypted = e;
 947         signal_changed (ENCRYPTED);
 948 }
 949
 950 shared_ptr<Playlist>
 951 Film::playlist () const
 952 {
 953         return _playlist;
 954 }
 955
 956 ContentList
 957 Film::content () const
 958 {
 959         return _playlist->content ();
 960 }
 961
 962 void
 963 Film::examine_content (shared_ptr<Content> c)
 964 {
 965         shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
 966         JobManager::instance()->add (j);
 967 }
 968
 969 void
 970 Film::examine_and_add_content (shared_ptr<Content> c)
 971 {
 972         if (dynamic_pointer_cast<FFmpegContent> (c)) {
 973                 run_ffprobe (c->path(0), file ("ffprobe.log"), _log);
 974         }
 975
 976         shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
 977         j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
 978         JobManager::instance()->add (j);
 979 }
 980
 981 void
 982 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
 983 {
 984         shared_ptr<Job> job = j.lock ();
 985         if (!job || !job->finished_ok ()) {
 986                 return;
 987         }
 988
 989         shared_ptr<Content> content = c.lock ();
 990         if (content) {
 991                 add_content (content);
 992         }
 993 }
 994
 995 void
 996 Film::add_content (shared_ptr<Content> c)
 997 {
 998         /* Add video content after any existing content */
 999         if (dynamic_pointer_cast<VideoContent> (c)) {
1000                 c->set_position (_playlist->video_end ());
1001         }
1002
1003         _playlist->add (c);
1004 }
1005
1006 void
1007 Film::remove_content (shared_ptr<Content> c)
1008 {
1009         _playlist->remove (c);
1010 }
1011
1012 void
1013 Film::move_content_earlier (shared_ptr<Content> c)
1014 {
1015         _playlist->move_earlier (c);
1016 }
1017
1018 void
1019 Film::move_content_later (shared_ptr<Content> c)
1020 {
1021         _playlist->move_later (c);
1022 }
1023
1024 DCPTime
1025 Film::length () const
1026 {
1027         return _playlist->length ();
1028 }
1029
1030 int
1031 Film::best_video_frame_rate () const
1032 {
1033         return _playlist->best_dcp_frame_rate ();
1034 }
1035
1036 FrameRateChange
1037 Film::active_frame_rate_change (DCPTime t) const
1038 {
1039         return _playlist->active_frame_rate_change (t, video_frame_rate ());
1040 }
1041
1042 void
1043 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
1044 {
1045         if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
1046                 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
1047         }
1048
1049         if (ui_signaller) {
1050                 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
1051         }
1052 }
1053
1054 void
1055 Film::playlist_changed ()
1056 {
1057         signal_changed (CONTENT);
1058 }
1059
1060 int
1061 Film::audio_frame_rate () const
1062 {
1063         /* XXX */
1064         return 48000;
1065 }
1066
1067 void
1068 Film::set_sequence_video (bool s)
1069 {
1070         _sequence_video = s;
1071         _playlist->set_sequence_video (s);
1072         signal_changed (SEQUENCE_VIDEO);
1073 }
1074
1075 /** @return Size of the largest possible image in whatever resolution we are using */
1076 dcp::Size
1077 Film::full_frame () const
1078 {
1079         switch (_resolution) {
1080         case RESOLUTION_2K:
1081                 return dcp::Size (2048, 1080);
1082         case RESOLUTION_4K:
1083                 return dcp::Size (4096, 2160);
1084         }
1085
1086         DCPOMATIC_ASSERT (false);
1087         return dcp::Size ();
1088 }
1089
1090 /** @return Size of the frame */
1091 dcp::Size
1092 Film::frame_size () const
1093 {
1094         return fit_ratio_within (container()->ratio(), full_frame (), 1);
1095 }
1096
1097 dcp::EncryptedKDM
1098 Film::make_kdm (
1099         dcp::Certificate target,
1100         boost::filesystem::path cpl_file,
1101         dcp::LocalTime from,
1102         dcp::LocalTime until,
1103         dcp::Formulation formulation
1104         ) const
1105 {
1106         shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
1107         shared_ptr<const dcp::Signer> signer = Config::instance()->signer();
1108         if (!signer->valid ()) {
1109                 throw InvalidSignerError ();
1110         }
1111
1112         return dcp::DecryptedKDM (
1113                 cpl, key(), from, until, "DCP-o-matic", cpl->content_title_text(), dcp::LocalTime().as_string()
1114                 ).encrypt (signer, target, formulation);
1115 }
1116
1117 list<dcp::EncryptedKDM>
1118 Film::make_kdms (
1119         list<shared_ptr<Screen> > screens,
1120         boost::filesystem::path dcp,
1121         dcp::LocalTime from,
1122         dcp::LocalTime until,
1123         dcp::Formulation formulation
1124         ) const
1125 {
1126         list<dcp::EncryptedKDM> kdms;
1127
1128         for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
1129                 if ((*i)->certificate) {
1130                         kdms.push_back (make_kdm ((*i)->certificate.get(), dcp, from, until, formulation));
1131                 }
1132         }
1133
1134         return kdms;
1135 }
1136
1137 /** @return The approximate disk space required to encode a DCP of this film with the
1138  *  current settings, in bytes.
1139  */
1140 uint64_t
1141 Film::required_disk_space () const
1142 {
1143         return uint64_t (j2k_bandwidth() / 8) * length().seconds();
1144 }
1145
1146 /** This method checks the disk that the Film is on and tries to decide whether or not
1147  *  there will be enough space to make a DCP for it.  If so, true is returned; if not,
1148  *  false is returned and required and availabe are filled in with the amount of disk space
1149  *  required and available respectively (in Gb).
1150  *
1151  *  Note: the decision made by this method isn't, of course, 100% reliable.
1152  */
1153 bool
1154 Film::should_be_enough_disk_space (double& required, double& available) const
1155 {
1156         boost::filesystem::space_info s = boost::filesystem::space (internal_video_mxf_dir ());
1157         required = double (required_disk_space ()) / 1073741824.0f;
1158         available = double (s.available) / 1073741824.0f;
1159         return (available - required) > 1;
1160 }
1161
1162 string
1163 Film::subtitle_language () const
1164 {
1165         set<string> languages;
1166
1167         ContentList cl = content ();
1168         BOOST_FOREACH (shared_ptr<Content>& c, cl) {
1169                 shared_ptr<SubtitleContent> sc = dynamic_pointer_cast<SubtitleContent> (c);
1170                 if (sc) {
1171                         languages.insert (sc->subtitle_language ());
1172                 }
1173         }
1174
1175         string all;
1176         BOOST_FOREACH (string s, languages) {
1177                 if (!all.empty ()) {
1178                         all += "/" + s;
1179                 } else {
1180                         all += s;
1181                 }
1182         }
1183
1184         return all;
1185 }