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