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 <boost/date_time.hpp>
  32 #include <libxml++/libxml++.h>
  33 #include <libcxml/cxml.h>
  34 #include <libdcp/signer_chain.h>
  35 #include <libdcp/cpl.h>
  36 #include <libdcp/signer.h>
  37 #include <libdcp/util.h>
  38 #include <libdcp/kdm.h>
  39 #include "film.h"
  40 #include "job.h"
  41 #include "util.h"
  42 #include "job_manager.h"
  43 #include "transcode_job.h"
  44 #include "scp_dcp_job.h"
  45 #include "log.h"
  46 #include "exceptions.h"
  47 #include "examine_content_job.h"
  48 #include "scaler.h"
  49 #include "config.h"
  50 #include "version.h"
  51 #include "ui_signaller.h"
  52 #include "playlist.h"
  53 #include "player.h"
  54 #include "dcp_content_type.h"
  55 #include "ratio.h"
  56 #include "cross.h"
  57 #include "cinema.h"
  58
  59 #include "i18n.h"
  60
  61 using std::string;
  62 using std::stringstream;
  63 using std::multimap;
  64 using std::pair;
  65 using std::map;
  66 using std::vector;
  67 using std::setfill;
  68 using std::min;
  69 using std::make_pair;
  70 using std::endl;
  71 using std::cout;
  72 using std::list;
  73 using boost::shared_ptr;
  74 using boost::weak_ptr;
  75 using boost::lexical_cast;
  76 using boost::dynamic_pointer_cast;
  77 using boost::to_upper_copy;
  78 using boost::ends_with;
  79 using boost::starts_with;
  80 using boost::optional;
  81 using libdcp::Size;
  82 using libdcp::Signer;
  83
  84 /* 5 -> 6
  85  * AudioMapping XML changed.
  86  * 6 -> 7
  87  * Subtitle offset changed to subtitle y offset, and subtitle x offset added.
  88  * 7 -> 8
  89  * Use <Scale> tag in <VideoContent> rather than <Ratio>.
  90  */
  91 int const Film::current_state_version = 8;
  92
  93 /** Construct a Film object in a given directory.
  94  *
  95  *  @param dir Film directory.
  96  */
  97
  98 Film::Film (boost::filesystem::path dir, bool log)
  99         : _playlist (new Playlist)
 100         , _use_dci_name (true)
 101         , _dcp_content_type (Config::instance()->default_dcp_content_type ())
 102         , _container (Config::instance()->default_container ())
 103         , _resolution (RESOLUTION_2K)
 104         , _scaler (Scaler::from_id ("bicubic"))
 105         , _with_subtitles (false)
 106         , _signed (true)
 107         , _encrypted (false)
 108         , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
 109         , _dci_metadata (Config::instance()->default_dci_metadata ())
 110         , _video_frame_rate (24)
 111         , _audio_channels (6)
 112         , _three_d (false)
 113         , _sequence_video (true)
 114         , _interop (false)
 115         , _state_version (current_state_version)
 116         , _dirty (false)
 117 {
 118         set_dci_date_today ();
 119
 120         _playlist->Changed.connect (bind (&Film::playlist_changed, this));
 121         _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2));
 122
 123         /* Make state.directory a complete path without ..s (where possible)
 124            (Code swiped from Adam Bowen on stackoverflow)
 125         */
 126
 127         boost::filesystem::path p (boost::filesystem::system_complete (dir));
 128         boost::filesystem::path result;
 129         for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
 130                 if (*i == "..") {
 131                         if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
 132                                 result /= *i;
 133                         } else {
 134                                 result = result.parent_path ();
 135                         }
 136                 } else if (*i != ".") {
 137                         result /= *i;
 138                 }
 139         }
 140
 141         set_directory (result);
 142         if (log) {
 143                 _log.reset (new FileLog (file ("log")));
 144         } else {
 145                 _log.reset (new NullLog);
 146         }
 147
 148         _playlist->set_sequence_video (_sequence_video);
 149 }
 150
 151 string
 152 Film::video_identifier () const
 153 {
 154         assert (container ());
 155         LocaleGuard lg;
 156
 157         stringstream s;
 158         s << container()->id()
 159           << "_" << resolution_to_string (_resolution)
 160           << "_" << _playlist->video_identifier()
 161           << "_" << _video_frame_rate
 162           << "_" << scaler()->id()
 163           << "_" << j2k_bandwidth();
 164
 165         if (encrypted ()) {
 166                 s << "_E";
 167         } else {
 168                 s << "_P";
 169         }
 170
 171         if (_interop) {
 172                 s << "_I";
 173         } else {
 174                 s << "_S";
 175         }
 176
 177         if (_three_d) {
 178                 s << "_3D";
 179         }
 180
 181         return s.str ();
 182 }
 183
 184 /** @return The path to the directory to write video frame info files to */
 185 boost::filesystem::path
 186 Film::info_dir () const
 187 {
 188         boost::filesystem::path p;
 189         p /= "info";
 190         p /= video_identifier ();
 191         return dir (p);
 192 }
 193
 194 boost::filesystem::path
 195 Film::internal_video_mxf_dir () const
 196 {
 197         return dir ("video");
 198 }
 199
 200 boost::filesystem::path
 201 Film::internal_video_mxf_filename () const
 202 {
 203         return video_identifier() + ".mxf";
 204 }
 205
 206 boost::filesystem::path
 207 Film::video_mxf_filename () const
 208 {
 209         return filename_safe_name() + "_video.mxf";
 210 }
 211
 212 boost::filesystem::path
 213 Film::audio_mxf_filename () const
 214 {
 215         return filename_safe_name() + "_audio.mxf";
 216 }
 217
 218 string
 219 Film::filename_safe_name () const
 220 {
 221         string const n = name ();
 222         string o;
 223         for (size_t i = 0; i < n.length(); ++i) {
 224                 if (isalnum (n[i])) {
 225                         o += n[i];
 226                 } else {
 227                         o += "_";
 228                 }
 229         }
 230
 231         return o;
 232 }
 233
 234 boost::filesystem::path
 235 Film::audio_analysis_dir () const
 236 {
 237         return dir ("analysis");
 238 }
 239
 240 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
 241 void
 242 Film::make_dcp ()
 243 {
 244         set_dci_date_today ();
 245
 246         if (dcp_name().find ("/") != string::npos) {
 247                 throw BadSettingError (_("name"), _("cannot contain slashes"));
 248         }
 249
 250         /* It seems to make sense to auto-save metadata here, since the make DCP may last
 251            a long time, and crashes/power failures are moderately likely.
 252          */
 253         write_metadata ();
 254
 255         log()->log (String::compose ("DCP-o-matic %1 git %2 using %3", dcpomatic_version, dcpomatic_git_commit, dependency_version_summary()));
 256
 257         {
 258                 char buffer[128];
 259                 gethostname (buffer, sizeof (buffer));
 260                 log()->log (String::compose ("Starting to make DCP on %1", buffer));
 261         }
 262
 263         ContentList cl = content ();
 264         for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
 265                 log()->log (String::compose ("Content: %1", (*i)->technical_summary()));
 266         }
 267         log()->log (String::compose ("DCP video rate %1 fps", video_frame_rate()));
 268         log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
 269         log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
 270 #ifdef DCPOMATIC_DEBUG
 271         log()->log ("DCP-o-matic built in debug mode.");
 272 #else
 273         log()->log ("DCP-o-matic built in optimised mode.");
 274 #endif
 275 #ifdef LIBDCP_DEBUG
 276         log()->log ("libdcp built in debug mode.");
 277 #else
 278         log()->log ("libdcp built in optimised mode.");
 279 #endif
 280
 281 #ifdef DCPOMATIC_WINDOWS
 282         OSVERSIONINFO info;
 283         info.dwOSVersionInfoSize = sizeof (info);
 284         GetVersionEx (&info);
 285         log()->log (String::compose ("Windows version %1.%2.%3 SP %4", info.dwMajorVersion, info.dwMinorVersion, info.dwBuildNumber, info.szCSDVersion));
 286 #endif
 287
 288         log()->log (String::compose ("CPU: %1, %2 processors", cpu_info(), boost::thread::hardware_concurrency ()));
 289         list<pair<string, string> > const m = mount_info ();
 290         for (list<pair<string, string> >::const_iterator i = m.begin(); i != m.end(); ++i) {
 291                 log()->log (String::compose ("Mount: %1 %2", i->first, i->second));
 292         }
 293
 294         if (container() == 0) {
 295                 throw MissingSettingError (_("container"));
 296         }
 297
 298         if (content().empty()) {
 299                 throw StringError (_("You must add some content to the DCP before creating it"));
 300         }
 301
 302         if (dcp_content_type() == 0) {
 303                 throw MissingSettingError (_("content type"));
 304         }
 305
 306         if (name().empty()) {
 307                 throw MissingSettingError (_("name"));
 308         }
 309
 310         JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
 311 }
 312
 313 /** Start a job to send our DCP to the configured TMS */
 314 void
 315 Film::send_dcp_to_tms ()
 316 {
 317         shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
 318         JobManager::instance()->add (j);
 319 }
 320
 321 /** Count the number of frames that have been encoded for this film.
 322  *  @return frame count.
 323  */
 324 int
 325 Film::encoded_frames () const
 326 {
 327         if (container() == 0) {
 328                 return 0;
 329         }
 330
 331         int N = 0;
 332         for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
 333                 ++N;
 334                 boost::this_thread::interruption_point ();
 335         }
 336
 337         return N;
 338 }
 339
 340 shared_ptr<xmlpp::Document>
 341 Film::metadata () const
 342 {
 343         LocaleGuard lg;
 344
 345         shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
 346         xmlpp::Element* root = doc->create_root_node ("Metadata");
 347
 348         root->add_child("Version")->add_child_text (lexical_cast<string> (current_state_version));
 349         root->add_child("Name")->add_child_text (_name);
 350         root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
 351
 352         if (_dcp_content_type) {
 353                 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ());
 354         }
 355
 356         if (_container) {
 357                 root->add_child("Container")->add_child_text (_container->id ());
 358         }
 359
 360         root->add_child("Resolution")->add_child_text (resolution_to_string (_resolution));
 361         root->add_child("Scaler")->add_child_text (_scaler->id ());
 362         root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0");
 363         root->add_child("J2KBandwidth")->add_child_text (lexical_cast<string> (_j2k_bandwidth));
 364         _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
 365         root->add_child("VideoFrameRate")->add_child_text (lexical_cast<string> (_video_frame_rate));
 366         root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date));
 367         root->add_child("AudioChannels")->add_child_text (lexical_cast<string> (_audio_channels));
 368         root->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
 369         root->add_child("SequenceVideo")->add_child_text (_sequence_video ? "1" : "0");
 370         root->add_child("Interop")->add_child_text (_interop ? "1" : "0");
 371         root->add_child("Signed")->add_child_text (_signed ? "1" : "0");
 372         root->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
 373         root->add_child("Key")->add_child_text (_key.hex ());
 374         _playlist->as_xml (root->add_child ("Playlist"));
 375
 376         return doc;
 377 }
 378
 379 /** Write state to our `metadata' file */
 380 void
 381 Film::write_metadata () const
 382 {
 383         boost::filesystem::create_directories (directory ());
 384         shared_ptr<xmlpp::Document> doc = metadata ();
 385         doc->write_to_file_formatted (file("metadata.xml").string ());
 386         _dirty = false;
 387 }
 388
 389 /** Read state from our metadata file.
 390  *  @return Notes about things that the user should know about, or empty.
 391  */
 392 list<string>
 393 Film::read_metadata ()
 394 {
 395         LocaleGuard lg;
 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 /** @return List of subdirectories (not full paths) containing DCPs that can be successfully libdcp::DCP::read() */
 770 list<boost::filesystem::path>
 771 Film::dcps () const
 772 {
 773         list<boost::filesystem::path> 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 (i->path().leaf ());
 786                         } catch (...) {
 787
 788                         }
 789                 }
 790         }
 791
 792         return out;
 793 }
 794
 795 shared_ptr<Player>
 796 Film::make_player () const
 797 {
 798         return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
 799 }
 800
 801 void
 802 Film::set_signed (bool s)
 803 {
 804         _signed = s;
 805         signal_changed (SIGNED);
 806 }
 807
 808 void
 809 Film::set_encrypted (bool e)
 810 {
 811         _encrypted = e;
 812         signal_changed (ENCRYPTED);
 813 }
 814
 815 shared_ptr<Playlist>
 816 Film::playlist () const
 817 {
 818         return _playlist;
 819 }
 820
 821 ContentList
 822 Film::content () const
 823 {
 824         return _playlist->content ();
 825 }
 826
 827 void
 828 Film::examine_and_add_content (shared_ptr<Content> c)
 829 {
 830         shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
 831         j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
 832         JobManager::instance()->add (j);
 833 }
 834
 835 void
 836 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
 837 {
 838         shared_ptr<Job> job = j.lock ();
 839         if (!job || !job->finished_ok ()) {
 840                 return;
 841         }
 842
 843         shared_ptr<Content> content = c.lock ();
 844         if (content) {
 845                 add_content (content);
 846         }
 847 }
 848
 849 void
 850 Film::add_content (shared_ptr<Content> c)
 851 {
 852         /* Add video content after any existing content */
 853         if (dynamic_pointer_cast<VideoContent> (c)) {
 854                 c->set_position (_playlist->video_end ());
 855         }
 856
 857         _playlist->add (c);
 858 }
 859
 860 void
 861 Film::remove_content (shared_ptr<Content> c)
 862 {
 863         _playlist->remove (c);
 864 }
 865
 866 void
 867 Film::move_content_earlier (shared_ptr<Content> c)
 868 {
 869         _playlist->move_earlier (c);
 870 }
 871
 872 void
 873 Film::move_content_later (shared_ptr<Content> c)
 874 {
 875         _playlist->move_later (c);
 876 }
 877
 878 Time
 879 Film::length () const
 880 {
 881         return _playlist->length ();
 882 }
 883
 884 bool
 885 Film::has_subtitles () const
 886 {
 887         return _playlist->has_subtitles ();
 888 }
 889
 890 OutputVideoFrame
 891 Film::best_video_frame_rate () const
 892 {
 893         return _playlist->best_dcp_frame_rate ();
 894 }
 895
 896 void
 897 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
 898 {
 899         if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
 900                 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
 901         }
 902
 903         if (ui_signaller) {
 904                 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
 905         }
 906 }
 907
 908 void
 909 Film::playlist_changed ()
 910 {
 911         signal_changed (CONTENT);
 912 }
 913
 914 OutputAudioFrame
 915 Film::time_to_audio_frames (Time t) const
 916 {
 917         return divide_with_round (t * audio_frame_rate (), TIME_HZ);
 918 }
 919
 920 OutputVideoFrame
 921 Film::time_to_video_frames (Time t) const
 922 {
 923         return divide_with_round (t * video_frame_rate (), TIME_HZ);
 924 }
 925
 926 Time
 927 Film::audio_frames_to_time (OutputAudioFrame f) const
 928 {
 929         return divide_with_round (f * TIME_HZ, audio_frame_rate ());
 930 }
 931
 932 Time
 933 Film::video_frames_to_time (OutputVideoFrame f) const
 934 {
 935         return divide_with_round (f * TIME_HZ, video_frame_rate ());
 936 }
 937
 938 OutputAudioFrame
 939 Film::audio_frame_rate () const
 940 {
 941         /* XXX */
 942         return 48000;
 943 }
 944
 945 void
 946 Film::set_sequence_video (bool s)
 947 {
 948         _sequence_video = s;
 949         _playlist->set_sequence_video (s);
 950         signal_changed (SEQUENCE_VIDEO);
 951 }
 952
 953 /** @return Size of the largest possible image in whatever resolution we are using */
 954 libdcp::Size
 955 Film::full_frame () const
 956 {
 957         switch (_resolution) {
 958         case RESOLUTION_2K:
 959                 return libdcp::Size (2048, 1080);
 960         case RESOLUTION_4K:
 961                 return libdcp::Size (4096, 2160);
 962         }
 963
 964         assert (false);
 965         return libdcp::Size ();
 966 }
 967
 968 /** @return Size of the frame */
 969 libdcp::Size
 970 Film::frame_size () const
 971 {
 972         return fit_ratio_within (container()->ratio(), full_frame ());
 973 }
 974
 975 libdcp::KDM
 976 Film::make_kdm (
 977         shared_ptr<libdcp::Certificate> target,
 978         boost::filesystem::path dcp_dir,
 979         boost::posix_time::ptime from,
 980         boost::posix_time::ptime until
 981         ) const
 982 {
 983         shared_ptr<const Signer> signer = make_signer ();
 984
 985         libdcp::DCP dcp (dir (dcp_dir.string ()));
 986
 987         try {
 988                 dcp.read ();
 989         } catch (...) {
 990                 throw KDMError (_("Could not read DCP to make KDM for"));
 991         }
 992
 993         time_t now = time (0);
 994         struct tm* tm = localtime (&now);
 995         string const issue_date = libdcp::tm_to_string (tm);
 996
 997         dcp.cpls().front()->set_mxf_keys (key ());
 998
 999         return libdcp::KDM (dcp.cpls().front(), signer, target, from, until, "DCP-o-matic", issue_date);
1000 }
1001
1002 list<libdcp::KDM>
1003 Film::make_kdms (
1004         list<shared_ptr<Screen> > screens,
1005         boost::filesystem::path dcp,
1006         boost::posix_time::ptime from,
1007         boost::posix_time::ptime until
1008         ) const
1009 {
1010         list<libdcp::KDM> kdms;
1011
1012         for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
1013                 kdms.push_back (make_kdm ((*i)->certificate, dcp, from, until));
1014         }
1015
1016         return kdms;
1017 }
1018
1019 /** @return The approximate disk space required to encode a DCP of this film with the
1020  *  current settings, in bytes.
1021  */
1022 uint64_t
1023 Film::required_disk_space () const
1024 {
1025         return uint64_t (j2k_bandwidth() / 8) * length() / TIME_HZ;
1026 }
1027
1028 /** This method checks the disk that the Film is on and tries to decide whether or not
1029  *  there will be enough space to make a DCP for it.  If so, true is returned; if not,
1030  *  false is returned and required and availabe are filled in with the amount of disk space
1031  *  required and available respectively (in Gb).
1032  *
1033  *  Note: the decision made by this method isn't, of course, 100% reliable.
1034  */
1035 bool
1036 Film::should_be_enough_disk_space (double& required, double& available) const
1037 {
1038         boost::filesystem::space_info s = boost::filesystem::space (internal_video_mxf_dir ());
1039         required = double (required_disk_space ()) / 1073741824.0f;
1040         available = double (s.available) / 1073741824.0f;
1041         return (available - required) > 1;
1042 }