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