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