src/lib/film.cc

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