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