src/lib/film.cc

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