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         LOG_GENERAL ("CPU: %1, %2 processors", cpu_info(), boost::thread::hardware_concurrency ());
 314         list<pair<string, string> > const m = mount_info ();
 315         for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
 316                 LOG_GENERAL ("Mount: %1 %2", i->first, i->second);
 317         }
 318
 319         if (container() == 0) {
 320                 throw MissingSettingError (_("container"));
 321         }
 322
 323         if (content().empty()) {
 324                 throw StringError (_("You must add some content to the DCP before creating it"));
 325         }
 326
 327         if (dcp_content_type() == 0) {
 328                 throw MissingSettingError (_("content type"));
 329         }
 330
 331         if (name().empty()) {
 332                 throw MissingSettingError (_("name"));
 333         }
 334
 335         JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
 336 }
 337
 338 /** Start a job to send our DCP to the configured TMS */
 339 void
 340 Film::send_dcp_to_tms ()
 341 {
 342         shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
 343         JobManager::instance()->add (j);
 344 }
 345
 346 /** Count the number of frames that have been encoded for this film.
 347  *  @return frame count.
 348  */
 349 int
 350 Film::encoded_frames () const
 351 {
 352         if (container() == 0) {
 353                 return 0;
 354         }
 355
 356         int N = 0;
 357         for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
 358                 ++N;
 359                 boost::this_thread::interruption_point ();
 360         }
 361
 362         return N;
 363 }
 364
 365 shared_ptr<xmlpp::Document>
 366 Film::metadata () const
 367 {
 368         shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
 369         xmlpp::Element* root = doc->create_root_node ("Metadata");
 370
 371         root->add_child("Version")->add_child_text (raw_convert<string> (current_state_version));
 372         root->add_child("Name")->add_child_text (_name);
 373         root->add_child("UseISDCFName")->add_child_text (_use_isdcf_name ? "1" : "0");
 374
 375         if (_dcp_content_type) {
 376                 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->isdcf_name ());
 377         }
 378
 379         if (_container) {
 380                 root->add_child("Container")->add_child_text (_container->id ());
 381         }
 382
 383         root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
 384         root->add_child("Scaler")->add_child_text (_scaler->id ());
 385         root->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
 386         _isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
 387         root->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
 388         root->add_child("ISDCFDate")->add_child_text (boost::gregorian::to_iso_string (_isdcf_date));
 389         root->add_child("AudioChannels")->add_child_text (raw_convert<string> (_audio_channels));
 390         root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
 391         root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
 392         root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
 393         root->add_child("BurnSubtitles")->add_child_text (_burn_subtitles ? "1" : "0");
 394         root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
 395         root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
 396         root->add_child("Key")->add_child_text (_key.hex ());
 397         _playlist->as_xml (root->add_child ("Playlist"));
 398
 399         return doc;
 400 }
 401
 402 /** Write state to our `metadata' file */
 403 void
 404 Film::write_metadata () const
 405 {
 406         boost::filesystem::create_directories (directory ());
 407         shared_ptr<xmlpp::Document> doc = metadata ();
 408         doc->write_to_file_formatted (file("metadata.xml").string ());
 409         _dirty = false;
 410 }
 411
 412 /** Read state from our metadata file.
 413  *  @return Notes about things that the user should know about, or empty.
 414  */
 415 list<string>
 416 Film::read_metadata ()
 417 {
 418         if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
 419                 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!"));
 420         }
 421
 422         cxml::Document f ("Metadata");
 423         f.read_file (file ("metadata.xml"));
 424
 425         _state_version = f.number_child<int> ("Version");
 426         if (_state_version > current_state_version) {
 427                 throw StringError (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version.  Sorry!"));
 428         }
 429
 430         _name = f.string_child ("Name");
 431         if (_state_version >= 9) {
 432                 _use_isdcf_name = f.bool_child ("UseISDCFName");
 433                 _isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
 434                 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
 435         } else {
 436                 _use_isdcf_name = f.bool_child ("UseDCIName");
 437                 _isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
 438                 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
 439         }
 440
 441         {
 442                 optional<string> c = f.optional_string_child ("DCPContentType");
 443                 if (c) {
 444                         _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
 445                 }
 446         }
 447
 448         {
 449                 optional<string> c = f.optional_string_child ("Container");
 450                 if (c) {
 451                         _container = Ratio::from_id (c.get ());
 452                 }
 453         }
 454
 455         _resolution = string_to_resolution (f.string_child ("Resolution"));
 456         _scaler = Scaler::from_id (f.string_child ("Scaler"));
 457         _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
 458         _video_frame_rate = f.number_child<int> ("VideoFrameRate");
 459         _signed = f.optional_bool_child("Signed").get_value_or (true);
 460         _encrypted = f.bool_child ("Encrypted");
 461         _audio_channels = f.number_child<int> ("AudioChannels");
 462         _sequence_video = f.bool_child ("SequenceVideo");
 463         _three_d = f.bool_child ("ThreeD");
 464         _interop = f.bool_child ("Interop");
 465         if (_state_version >= 32) {
 466                 _burn_subtitles = f.bool_child ("BurnSubtitles");
 467         }
 468         _key = dcp::Key (f.string_child ("Key"));
 469
 470         list<string> notes;
 471         /* This method is the only one that can return notes (so far) */
 472         _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
 473
 474         /* Write backtraces to this film's directory, until another film is loaded */
 475         set_backtrace_file (file ("backtrace.txt"));
 476
 477         _dirty = false;
 478         return notes;
 479 }
 480
 481 /** Given a directory name, return its full path within the Film's directory.
 482  *  The directory (and its parents) will be created if they do not exist.
 483  */
 484 boost::filesystem::path
 485 Film::dir (boost::filesystem::path d) const
 486 {
 487         boost::filesystem::path p;
 488         p /= _directory;
 489         p /= d;
 490
 491         boost::filesystem::create_directories (p);
 492
 493         return p;
 494 }
 495
 496 /** Given a file or directory name, return its full path within the Film's directory.
 497  *  Any required parent directories will be created.
 498  */
 499 boost::filesystem::path
 500 Film::file (boost::filesystem::path f) const
 501 {
 502         boost::filesystem::path p;
 503         p /= _directory;
 504         p /= f;
 505
 506         boost::filesystem::create_directories (p.parent_path ());
 507
 508         return p;
 509 }
 510
 511 /** @return a ISDCF-compliant name for a DCP of this film */
 512 string
 513 Film::isdcf_name (bool if_created_now) const
 514 {
 515         SafeStringStream d;
 516
 517         string raw_name = name ();
 518
 519         /* Split the raw name up into words */
 520         vector<string> words;
 521         split (words, raw_name, is_any_of (" "));
 522
 523         string fixed_name;
 524
 525         /* Add each word to fixed_name */
 526         for (vector<string>::const_iterator i = words.begin(); i != words.end(); ++i) {
 527                 string w = *i;
 528
 529                 /* First letter is always capitalised */
 530                 w[0] = toupper (w[0]);
 531
 532                 /* Count caps in w */
 533                 size_t caps = 0;
 534                 for (size_t i = 0; i < w.size(); ++i) {
 535                         if (isupper (w[i])) {
 536                                 ++caps;
 537                         }
 538                 }
 539
 540                 /* If w is all caps make the rest of it lower case, otherwise
 541                    leave it alone.
 542                 */
 543                 if (caps == w.size ()) {
 544                         for (size_t i = 1; i < w.size(); ++i) {
 545                                 w[i] = tolower (w[i]);
 546                         }
 547                 }
 548
 549                 for (size_t i = 0; i < w.size(); ++i) {
 550                         fixed_name += w[i];
 551                 }
 552         }
 553
 554         if (fixed_name.length() > 14) {
 555                 fixed_name = fixed_name.substr (0, 14);
 556         }
 557
 558         d << fixed_name;
 559
 560         if (dcp_content_type()) {
 561                 d << "_" << dcp_content_type()->isdcf_name();
 562                 d << "-" << isdcf_metadata().content_version;
 563         }
 564
 565         ISDCFMetadata const dm = isdcf_metadata ();
 566
 567         if (dm.temp_version) {
 568                 d << "-Temp";
 569         }
 570
 571         if (dm.pre_release) {
 572                 d << "-Pre";
 573         }
 574
 575         if (dm.red_band) {
 576                 d << "-RedBand";
 577         }
 578
 579         if (!dm.chain.empty ()) {
 580                 d << "-" << dm.chain;
 581         }
 582
 583         if (three_d ()) {
 584                 d << "-3D";
 585         }
 586
 587         if (dm.two_d_version_of_three_d) {
 588                 d << "-2D";
 589         }
 590
 591         if (!dm.mastered_luminance.empty ()) {
 592                 d << "-" << dm.mastered_luminance;
 593         }
 594
 595         if (video_frame_rate() != 24) {
 596                 d << "-" << video_frame_rate();
 597         }
 598
 599         if (container()) {
 600                 d << "_" << container()->isdcf_name();
 601         }
 602
 603         /* XXX: this uses the first bit of content only */
 604
 605         /* The standard says we don't do this for trailers, for some strange reason */
 606         if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::TRAILER) {
 607                 ContentList cl = content ();
 608                 Ratio const * content_ratio = 0;
 609                 for (ContentList::iterator i = cl.begin(); i != cl.end(); ++i) {
 610                         shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (*i);
 611                         if (vc) {
 612                                 /* Here's the first piece of video content */
 613                                 if (vc->scale().ratio ()) {
 614                                         content_ratio = vc->scale().ratio ();
 615                                 } else {
 616                                         content_ratio = Ratio::from_ratio (vc->video_size().ratio ());
 617                                 }
 618                                 break;
 619                         }
 620                 }
 621
 622                 if (content_ratio && content_ratio != container()) {
 623                         d << "-" << content_ratio->isdcf_name();
 624                 }
 625         }
 626
 627         if (!dm.audio_language.empty ()) {
 628                 d << "_" << dm.audio_language;
 629                 if (!dm.subtitle_language.empty()) {
 630                         d << "-" << dm.subtitle_language;
 631                 } else {
 632                         d << "-XX";
 633                 }
 634         }
 635
 636         if (!dm.territory.empty ()) {
 637                 d << "_" << dm.territory;
 638                 if (!dm.rating.empty ()) {
 639                         d << "-" << dm.rating;
 640                 }
 641         }
 642
 643         switch (audio_channels ()) {
 644         case 1:
 645                 d << "_10";
 646                 break;
 647         case 2:
 648                 d << "_20";
 649                 break;
 650         case 3:
 651                 d << "_30";
 652                 break;
 653         case 4:
 654                 d << "_40";
 655                 break;
 656         case 5:
 657                 d << "_50";
 658                 break;
 659         case 6:
 660                 d << "_51";
 661                 break;
 662         }
 663
 664         /* XXX: HI/VI */
 665
 666         d << "_" << resolution_to_string (_resolution);
 667
 668         if (!dm.studio.empty ()) {
 669                 d << "_" << dm.studio;
 670         }
 671
 672         if (if_created_now) {
 673                 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
 674         } else {
 675                 d << "_" << boost::gregorian::to_iso_string (_isdcf_date);
 676         }
 677
 678         if (!dm.facility.empty ()) {
 679                 d << "_" << dm.facility;
 680         }
 681
 682         if (_interop) {
 683                 d << "_IOP";
 684         } else {
 685                 d << "_SMPTE";
 686         }
 687
 688         if (three_d ()) {
 689                 d << "-3D";
 690         }
 691
 692         if (!dm.package_type.empty ()) {
 693                 d << "_" << dm.package_type;
 694         }
 695
 696         return d.str ();
 697 }
 698
 699 /** @return name to give the DCP */
 700 string
 701 Film::dcp_name (bool if_created_now) const
 702 {
 703         if (use_isdcf_name()) {
 704                 return isdcf_name (if_created_now);
 705         }
 706
 707         return name();
 708 }
 709
 710 void
 711 Film::set_directory (boost::filesystem::path d)
 712 {
 713         _directory = d;
 714         _dirty = true;
 715 }
 716
 717 void
 718 Film::set_name (string n)
 719 {
 720         _name = n;
 721         signal_changed (NAME);
 722 }
 723
 724 void
 725 Film::set_use_isdcf_name (bool u)
 726 {
 727         _use_isdcf_name = u;
 728         signal_changed (USE_ISDCF_NAME);
 729 }
 730
 731 void
 732 Film::set_dcp_content_type (DCPContentType const * t)
 733 {
 734         _dcp_content_type = t;
 735         signal_changed (DCP_CONTENT_TYPE);
 736 }
 737
 738 void
 739 Film::set_container (Ratio const * c)
 740 {
 741         _container = c;
 742         signal_changed (CONTAINER);
 743 }
 744
 745 void
 746 Film::set_resolution (Resolution r)
 747 {
 748         _resolution = r;
 749         signal_changed (RESOLUTION);
 750 }
 751
 752 void
 753 Film::set_scaler (Scaler const * s)
 754 {
 755         _scaler = s;
 756         signal_changed (SCALER);
 757 }
 758
 759 void
 760 Film::set_j2k_bandwidth (int b)
 761 {
 762         _j2k_bandwidth = b;
 763         signal_changed (J2K_BANDWIDTH);
 764 }
 765
 766 void
 767 Film::set_isdcf_metadata (ISDCFMetadata m)
 768 {
 769         _isdcf_metadata = m;
 770         signal_changed (ISDCF_METADATA);
 771 }
 772
 773 void
 774 Film::set_video_frame_rate (int f)
 775 {
 776         _video_frame_rate = f;
 777         signal_changed (VIDEO_FRAME_RATE);
 778 }
 779
 780 void
 781 Film::set_audio_channels (int c)
 782 {
 783         _audio_channels = c;
 784         signal_changed (AUDIO_CHANNELS);
 785 }
 786
 787 void
 788 Film::set_three_d (bool t)
 789 {
 790         _three_d = t;
 791         signal_changed (THREE_D);
 792 }
 793
 794 void
 795 Film::set_interop (bool i)
 796 {
 797         _interop = i;
 798         signal_changed (INTEROP);
 799 }
 800
 801 void
 802 Film::set_burn_subtitles (bool b)
 803 {
 804         _burn_subtitles = b;
 805         signal_changed (BURN_SUBTITLES);
 806 }
 807
 808 void
 809 Film::signal_changed (Property p)
 810 {
 811         _dirty = true;
 812
 813         switch (p) {
 814         case Film::CONTENT:
 815                 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
 816                 break;
 817         case Film::VIDEO_FRAME_RATE:
 818         case Film::SEQUENCE_VIDEO:
 819                 _playlist->maybe_sequence_video ();
 820                 break;
 821         default:
 822                 break;
 823         }
 824
 825         if (ui_signaller) {
 826                 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
 827         }
 828 }
 829
 830 void
 831 Film::set_isdcf_date_today ()
 832 {
 833         _isdcf_date = boost::gregorian::day_clock::local_day ();
 834 }
 835
 836 boost::filesystem::path
 837 Film::info_path (int f, Eyes e) const
 838 {
 839         boost::filesystem::path p;
 840         p /= info_dir ();
 841
 842         SafeStringStream s;
 843         s.width (8);
 844         s << setfill('0') << f;
 845
 846         if (e == EYES_LEFT) {
 847                 s << ".L";
 848         } else if (e == EYES_RIGHT) {
 849                 s << ".R";
 850         }
 851
 852         s << ".md5";
 853
 854         p /= s.str();
 855
 856         /* info_dir() will already have added any initial bit of the path,
 857            so don't call file() on this.
 858         */
 859         return p;
 860 }
 861
 862 boost::filesystem::path
 863 Film::j2c_path (int f, Eyes e, bool t) const
 864 {
 865         boost::filesystem::path p;
 866         p /= "j2c";
 867         p /= video_identifier ();
 868
 869         SafeStringStream s;
 870         s.width (8);
 871         s << setfill('0') << f;
 872
 873         if (e == EYES_LEFT) {
 874                 s << ".L";
 875         } else if (e == EYES_RIGHT) {
 876                 s << ".R";
 877         }
 878
 879         s << ".j2c";
 880
 881         if (t) {
 882                 s << ".tmp";
 883         }
 884
 885         p /= s.str();
 886         return file (p);
 887 }
 888
 889 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs */
 890 vector<CPLSummary>
 891 Film::cpls () const
 892 {
 893         vector<CPLSummary> out;
 894
 895         boost::filesystem::path const dir = directory ();
 896         for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
 897                 if (
 898                         boost::filesystem::is_directory (*i) &&
 899                         i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
 900                         ) {
 901
 902                         try {
 903                                 dcp::DCP dcp (*i);
 904                                 dcp.read ();
 905                                 out.push_back (
 906                                         CPLSummary (
 907                                                 i->path().leaf().string(),
 908                                                 dcp.cpls().front()->id(),
 909                                                 dcp.cpls().front()->annotation_text(),
 910                                                 dcp.cpls().front()->file()
 911                                                 )
 912                                         );
 913                         } catch (...) {
 914
 915                         }
 916                 }
 917         }
 918
 919         return out;
 920 }
 921
 922 shared_ptr<Player>
 923 Film::make_player () const
 924 {
 925         return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
 926 }
 927
 928 void
 929 Film::set_signed (bool s)
 930 {
 931         _signed = s;
 932         signal_changed (SIGNED);
 933 }
 934
 935 void
 936 Film::set_encrypted (bool e)
 937 {
 938         _encrypted = e;
 939         signal_changed (ENCRYPTED);
 940 }
 941
 942 shared_ptr<Playlist>
 943 Film::playlist () const
 944 {
 945         return _playlist;
 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, bool calculate_digest)
 956 {
 957         shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c, calculate_digest));
 958         JobManager::instance()->add (j);
 959 }
 960
 961 void
 962 Film::examine_and_add_content (shared_ptr<Content> c, bool calculate_digest)
 963 {
 964         if (dynamic_pointer_cast<FFmpegContent> (c)) {
 965                 run_ffprobe (c->path(0), file ("ffprobe.log"), _log);
 966         }
 967
 968         shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c, calculate_digest));
 969         j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
 970         JobManager::instance()->add (j);
 971 }
 972
 973 void
 974 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
 975 {
 976         shared_ptr<Job> job = j.lock ();
 977         if (!job || !job->finished_ok ()) {
 978                 return;
 979         }
 980
 981         shared_ptr<Content> content = c.lock ();
 982         if (content) {
 983                 add_content (content);
 984         }
 985 }
 986
 987 void
 988 Film::add_content (shared_ptr<Content> c)
 989 {
 990         /* Add video content after any existing content */
 991         if (dynamic_pointer_cast<VideoContent> (c)) {
 992                 c->set_position (_playlist->video_end ());
 993         }
 994
 995         _playlist->add (c);
 996 }
 997
 998 void
 999 Film::remove_content (shared_ptr<Content> c)
1000 {
1001         _playlist->remove (c);
1002 }
1003
1004 void
1005 Film::move_content_earlier (shared_ptr<Content> c)
1006 {
1007         _playlist->move_earlier (c);
1008 }
1009
1010 void
1011 Film::move_content_later (shared_ptr<Content> c)
1012 {
1013         _playlist->move_later (c);
1014 }
1015
1016 DCPTime
1017 Film::length () const
1018 {
1019         return _playlist->length ();
1020 }
1021
1022 int
1023 Film::best_video_frame_rate () const
1024 {
1025         return _playlist->best_dcp_frame_rate ();
1026 }
1027
1028 FrameRateChange
1029 Film::active_frame_rate_change (DCPTime t) const
1030 {
1031         return _playlist->active_frame_rate_change (t, video_frame_rate ());
1032 }
1033
1034 void
1035 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
1036 {
1037         if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
1038                 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
1039         }
1040
1041         if (ui_signaller) {
1042                 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
1043         }
1044 }
1045
1046 void
1047 Film::playlist_changed ()
1048 {
1049         signal_changed (CONTENT);
1050 }
1051
1052 int
1053 Film::audio_frame_rate () const
1054 {
1055         /* XXX */
1056         return 48000;
1057 }
1058
1059 void
1060 Film::set_sequence_video (bool s)
1061 {
1062         _sequence_video = s;
1063         _playlist->set_sequence_video (s);
1064         signal_changed (SEQUENCE_VIDEO);
1065 }
1066
1067 /** @return Size of the largest possible image in whatever resolution we are using */
1068 dcp::Size
1069 Film::full_frame () const
1070 {
1071         switch (_resolution) {
1072         case RESOLUTION_2K:
1073                 return dcp::Size (2048, 1080);
1074         case RESOLUTION_4K:
1075                 return dcp::Size (4096, 2160);
1076         }
1077
1078         DCPOMATIC_ASSERT (false);
1079         return dcp::Size ();
1080 }
1081
1082 /** @return Size of the frame */
1083 dcp::Size
1084 Film::frame_size () const
1085 {
1086         return fit_ratio_within (container()->ratio(), full_frame (), 1);
1087 }
1088
1089 dcp::EncryptedKDM
1090 Film::make_kdm (
1091         dcp::Certificate target,
1092         boost::filesystem::path cpl_file,
1093         dcp::LocalTime from,
1094         dcp::LocalTime until,
1095         dcp::Formulation formulation
1096         ) const
1097 {
1098         shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
1099         shared_ptr<const dcp::Signer> signer = Config::instance()->signer();
1100         if (!signer->valid ()) {
1101                 throw InvalidSignerError ();
1102         }
1103
1104         return dcp::DecryptedKDM (
1105                 cpl, key(), from, until, "DCP-o-matic", cpl->content_title_text(), dcp::LocalTime().as_string()
1106                 ).encrypt (signer, target, formulation);
1107 }
1108
1109 list<dcp::EncryptedKDM>
1110 Film::make_kdms (
1111         list<shared_ptr<Screen> > screens,
1112         boost::filesystem::path dcp,
1113         dcp::LocalTime from,
1114         dcp::LocalTime until,
1115         dcp::Formulation formulation
1116         ) const
1117 {
1118         list<dcp::EncryptedKDM> kdms;
1119
1120         for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
1121                 if ((*i)->certificate) {
1122                         kdms.push_back (make_kdm ((*i)->certificate.get(), dcp, from, until, formulation));
1123                 }
1124         }
1125
1126         return kdms;
1127 }
1128
1129 /** @return The approximate disk space required to encode a DCP of this film with the
1130  *  current settings, in bytes.
1131  */
1132 uint64_t
1133 Film::required_disk_space () const
1134 {
1135         return uint64_t (j2k_bandwidth() / 8) * length().seconds();
1136 }
1137
1138 /** This method checks the disk that the Film is on and tries to decide whether or not
1139  *  there will be enough space to make a DCP for it.  If so, true is returned; if not,
1140  *  false is returned and required and availabe are filled in with the amount of disk space
1141  *  required and available respectively (in Gb).
1142  *
1143  *  Note: the decision made by this method isn't, of course, 100% reliable.
1144  */
1145 bool
1146 Film::should_be_enough_disk_space (double& required, double& available) const
1147 {
1148         boost::filesystem::space_info s = boost::filesystem::space (internal_video_mxf_dir ());
1149         required = double (required_disk_space ()) / 1073741824.0f;
1150         available = double (s.available) / 1073741824.0f;
1151         return (available - required) > 1;
1152 }
1153
1154 string
1155 Film::subtitle_language () const
1156 {
1157         set<string> languages;
1158
1159         ContentList cl = content ();
1160         BOOST_FOREACH (shared_ptr<Content>& c, cl) {
1161                 shared_ptr<SubtitleContent> sc = dynamic_pointer_cast<SubtitleContent> (c);
1162                 if (sc) {
1163                         languages.insert (sc->subtitle_language ());
1164                 }
1165         }
1166
1167         string all;
1168         BOOST_FOREACH (string s, languages) {
1169                 if (!all.empty ()) {
1170                         all += "/" + s;
1171                 } else {
1172                         all += s;
1173                 }
1174         }
1175
1176         return all;
1177 }