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