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