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