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         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         stringstream d;
 496
 497         string raw_name = name ();
 498         string fixed_name;
 499         bool cap_next = true;
 500         for (size_t i = 0; i < raw_name.length(); ++i) {
 501                 if (raw_name[i] == ' ') {
 502                         cap_next = true;
 503                 } else if (cap_next) {
 504                         fixed_name += toupper (raw_name[i]);
 505                         cap_next = false;
 506                 } else {
 507                         fixed_name += tolower (raw_name[i]);
 508                 }
 509         }
 510
 511         if (fixed_name.length() > 14) {
 512                 fixed_name = fixed_name.substr (0, 14);
 513         }
 514
 515         d << fixed_name;
 516
 517         if (dcp_content_type()) {
 518                 d << "_" << dcp_content_type()->isdcf_name();
 519                 d << "-" << isdcf_metadata().content_version;
 520         }
 521
 522         ISDCFMetadata const dm = isdcf_metadata ();
 523
 524         if (dm.temp_version) {
 525                 d << "-Temp";
 526         }
 527
 528         if (dm.pre_release) {
 529                 d << "-Pre";
 530         }
 531
 532         if (dm.red_band) {
 533                 d << "-RedBand";
 534         }
 535
 536         if (!dm.chain.empty ()) {
 537                 d << "-" << dm.chain;
 538         }
 539
 540         if (three_d ()) {
 541                 d << "-3D";
 542         }
 543
 544         if (dm.two_d_version_of_three_d) {
 545                 d << "-2D";
 546         }
 547
 548         if (!dm.mastered_luminance.empty ()) {
 549                 d << "-" << dm.mastered_luminance;
 550         }
 551
 552         if (video_frame_rate() != 24) {
 553                 d << "-" << video_frame_rate();
 554         }
 555
 556         if (container()) {
 557                 d << "_" << container()->isdcf_name();
 558         }
 559
 560         /* XXX: this only works for content which has been scaled to a given ratio,
 561            and uses the first bit of content only.
 562         */
 563
 564         /* The standard says we don't do this for trailers, for some strange reason */
 565         if (dcp_content_type() && dcp_content_type()->libdcp_kind() != libdcp::TRAILER) {
 566                 ContentList cl = content ();
 567                 Ratio const * content_ratio = 0;
 568                 for (ContentList::const_iterator i = cl.begin(); i != cl.end(); ++i) {
 569                         shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (*i);
 570                         if (vc && (content_ratio == 0 || vc->scale().ratio() != content_ratio)) {
 571                                 content_ratio = vc->scale().ratio();
 572                         }
 573                 }
 574
 575                 if (content_ratio && content_ratio != container()) {
 576                         d << "-" << content_ratio->isdcf_name();
 577                 }
 578         }
 579
 580         if (!dm.audio_language.empty ()) {
 581                 d << "_" << dm.audio_language;
 582                 if (!dm.subtitle_language.empty()) {
 583                         d << "-" << dm.subtitle_language;
 584                 } else {
 585                         d << "-XX";
 586                 }
 587         }
 588
 589         if (!dm.territory.empty ()) {
 590                 d << "_" << dm.territory;
 591                 if (!dm.rating.empty ()) {
 592                         d << "-" << dm.rating;
 593                 }
 594         }
 595
 596         switch (audio_channels ()) {
 597         case 1:
 598                 d << "_10";
 599                 break;
 600         case 2:
 601                 d << "_20";
 602                 break;
 603         case 3:
 604                 d << "_30";
 605                 break;
 606         case 4:
 607                 d << "_40";
 608                 break;
 609         case 5:
 610                 d << "_50";
 611                 break;
 612         case 6:
 613                 d << "_51";
 614                 break;
 615         }
 616
 617         /* XXX: HI/VI */
 618
 619         d << "_" << resolution_to_string (_resolution);
 620
 621         if (!dm.studio.empty ()) {
 622                 d << "_" << dm.studio;
 623         }
 624
 625         if (if_created_now) {
 626                 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
 627         } else {
 628                 d << "_" << boost::gregorian::to_iso_string (_isdcf_date);
 629         }
 630
 631         if (!dm.facility.empty ()) {
 632                 d << "_" << dm.facility;
 633         }
 634
 635         if (_interop) {
 636                 d << "_IOP";
 637         } else {
 638                 d << "_SMPTE";
 639         }
 640
 641         if (three_d ()) {
 642                 d << "-3D";
 643         }
 644
 645         if (!dm.package_type.empty ()) {
 646                 d << "_" << dm.package_type;
 647         }
 648
 649         return d.str ();
 650 }
 651
 652 /** @return name to give the DCP */
 653 string
 654 Film::dcp_name (bool if_created_now) const
 655 {
 656         if (use_isdcf_name()) {
 657                 return isdcf_name (if_created_now);
 658         }
 659
 660         return name();
 661 }
 662
 663
 664 void
 665 Film::set_directory (boost::filesystem::path d)
 666 {
 667         _directory = d;
 668         _dirty = true;
 669 }
 670
 671 void
 672 Film::set_name (string n)
 673 {
 674         _name = n;
 675         signal_changed (NAME);
 676 }
 677
 678 void
 679 Film::set_use_isdcf_name (bool u)
 680 {
 681         _use_isdcf_name = u;
 682         signal_changed (USE_ISDCF_NAME);
 683 }
 684
 685 void
 686 Film::set_dcp_content_type (DCPContentType const * t)
 687 {
 688         _dcp_content_type = t;
 689         signal_changed (DCP_CONTENT_TYPE);
 690 }
 691
 692 void
 693 Film::set_container (Ratio const * c)
 694 {
 695         _container = c;
 696         signal_changed (CONTAINER);
 697 }
 698
 699 void
 700 Film::set_resolution (Resolution r)
 701 {
 702         _resolution = r;
 703         signal_changed (RESOLUTION);
 704 }
 705
 706 void
 707 Film::set_scaler (Scaler const * s)
 708 {
 709         _scaler = s;
 710         signal_changed (SCALER);
 711 }
 712
 713 void
 714 Film::set_with_subtitles (bool w)
 715 {
 716         _with_subtitles = w;
 717         signal_changed (WITH_SUBTITLES);
 718 }
 719
 720 void
 721 Film::set_j2k_bandwidth (int b)
 722 {
 723         _j2k_bandwidth = b;
 724         signal_changed (J2K_BANDWIDTH);
 725 }
 726
 727 void
 728 Film::set_isdcf_metadata (ISDCFMetadata m)
 729 {
 730         _isdcf_metadata = m;
 731         signal_changed (ISDCF_METADATA);
 732 }
 733
 734 void
 735 Film::set_video_frame_rate (int f)
 736 {
 737         _video_frame_rate = f;
 738         signal_changed (VIDEO_FRAME_RATE);
 739 }
 740
 741 void
 742 Film::set_audio_channels (int c)
 743 {
 744         _audio_channels = c;
 745         signal_changed (AUDIO_CHANNELS);
 746 }
 747
 748 void
 749 Film::set_three_d (bool t)
 750 {
 751         _three_d = t;
 752         signal_changed (THREE_D);
 753 }
 754
 755 void
 756 Film::set_interop (bool i)
 757 {
 758         _interop = i;
 759         signal_changed (INTEROP);
 760 }
 761
 762 void
 763 Film::signal_changed (Property p)
 764 {
 765         _dirty = true;
 766
 767         switch (p) {
 768         case Film::CONTENT:
 769                 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
 770                 break;
 771         case Film::VIDEO_FRAME_RATE:
 772         case Film::SEQUENCE_VIDEO:
 773                 _playlist->maybe_sequence_video ();
 774                 break;
 775         default:
 776                 break;
 777         }
 778
 779         if (ui_signaller) {
 780                 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
 781         }
 782 }
 783
 784 void
 785 Film::set_isdcf_date_today ()
 786 {
 787         _isdcf_date = boost::gregorian::day_clock::local_day ();
 788 }
 789
 790 boost::filesystem::path
 791 Film::info_path (int f, Eyes e) const
 792 {
 793         boost::filesystem::path p;
 794         p /= info_dir ();
 795
 796         stringstream s;
 797         s.width (8);
 798         s << setfill('0') << f;
 799
 800         if (e == EYES_LEFT) {
 801                 s << ".L";
 802         } else if (e == EYES_RIGHT) {
 803                 s << ".R";
 804         }
 805
 806         s << ".md5";
 807
 808         p /= s.str();
 809
 810         /* info_dir() will already have added any initial bit of the path,
 811            so don't call file() on this.
 812         */
 813         return p;
 814 }
 815
 816 boost::filesystem::path
 817 Film::j2c_path (int f, Eyes e, bool t) const
 818 {
 819         boost::filesystem::path p;
 820         p /= "j2c";
 821         p /= video_identifier ();
 822
 823         stringstream 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 << ".j2c";
 834
 835         if (t) {
 836                 s << ".tmp";
 837         }
 838
 839         p /= s.str();
 840         return file (p);
 841 }
 842
 843 /** Find all the DCPs in our directory that can be libdcp::DCP::read() and return details of their CPLs */
 844 vector<CPLSummary>
 845 Film::cpls () const
 846 {
 847         vector<CPLSummary> out;
 848
 849         boost::filesystem::path const dir = directory ();
 850         for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
 851                 if (
 852                         boost::filesystem::is_directory (*i) &&
 853                         i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
 854                         ) {
 855
 856                         try {
 857                                 libdcp::DCP dcp (*i);
 858                                 dcp.read ();
 859                                 out.push_back (
 860                                         CPLSummary (
 861                                                 i->path().leaf().string(), dcp.cpls().front()->id(), dcp.cpls().front()->name(), dcp.cpls().front()->filename()
 862                                                 )
 863                                         );
 864                         } catch (...) {
 865
 866                         }
 867                 }
 868         }
 869
 870         return out;
 871 }
 872
 873 shared_ptr<Player>
 874 Film::make_player () const
 875 {
 876         return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
 877 }
 878
 879 void
 880 Film::set_signed (bool s)
 881 {
 882         _signed = s;
 883         signal_changed (SIGNED);
 884 }
 885
 886 void
 887 Film::set_encrypted (bool e)
 888 {
 889         _encrypted = e;
 890         signal_changed (ENCRYPTED);
 891 }
 892
 893 shared_ptr<Playlist>
 894 Film::playlist () const
 895 {
 896         return _playlist;
 897 }
 898
 899 ContentList
 900 Film::content () const
 901 {
 902         return _playlist->content ();
 903 }
 904
 905 void
 906 Film::examine_and_add_content (shared_ptr<Content> c)
 907 {
 908         if (dynamic_pointer_cast<FFmpegContent> (c)) {
 909                 run_ffprobe (c->path(0), file ("ffprobe.log"), _log);
 910         }
 911
 912         shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
 913         j->Finished.connect (bind (&Film::maybe_add_content, this, boost::weak_ptr<Job> (j), boost::weak_ptr<Content> (c)));
 914         JobManager::instance()->add (j);
 915 }
 916
 917 void
 918 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
 919 {
 920         shared_ptr<Job> job = j.lock ();
 921         if (!job || !job->finished_ok ()) {
 922                 return;
 923         }
 924
 925         shared_ptr<Content> content = c.lock ();
 926         if (content) {
 927                 add_content (content);
 928         }
 929 }
 930
 931 void
 932 Film::add_content (shared_ptr<Content> c)
 933 {
 934         /* Add video content after any existing content */
 935         if (dynamic_pointer_cast<VideoContent> (c)) {
 936                 c->set_position (_playlist->video_end ());
 937         }
 938
 939         _playlist->add (c);
 940 }
 941
 942 void
 943 Film::remove_content (shared_ptr<Content> c)
 944 {
 945         _playlist->remove (c);
 946 }
 947
 948 void
 949 Film::move_content_earlier (shared_ptr<Content> c)
 950 {
 951         _playlist->move_earlier (c);
 952 }
 953
 954 void
 955 Film::move_content_later (shared_ptr<Content> c)
 956 {
 957         _playlist->move_later (c);
 958 }
 959
 960 Time
 961 Film::length () const
 962 {
 963         return _playlist->length ();
 964 }
 965
 966 bool
 967 Film::has_subtitles () const
 968 {
 969         return _playlist->has_subtitles ();
 970 }
 971
 972 OutputVideoFrame
 973 Film::best_video_frame_rate () const
 974 {
 975         return _playlist->best_dcp_frame_rate ();
 976 }
 977
 978 void
 979 Film::playlist_content_changed (boost::weak_ptr<Content> c, int p)
 980 {
 981         if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
 982                 set_video_frame_rate (_playlist->best_dcp_frame_rate ());
 983         }
 984
 985         if (ui_signaller) {
 986                 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
 987         }
 988 }
 989
 990 void
 991 Film::playlist_changed ()
 992 {
 993         signal_changed (CONTENT);
 994 }
 995
 996 OutputAudioFrame
 997 Film::time_to_audio_frames (Time t) const
 998 {
 999         return divide_with_round (t * audio_frame_rate (), TIME_HZ);
1000 }
1001
1002 OutputVideoFrame
1003 Film::time_to_video_frames (Time t) const
1004 {
1005         return divide_with_round (t * video_frame_rate (), TIME_HZ);
1006 }
1007
1008 Time
1009 Film::audio_frames_to_time (OutputAudioFrame f) const
1010 {
1011         return divide_with_round (f * TIME_HZ, audio_frame_rate ());
1012 }
1013
1014 Time
1015 Film::video_frames_to_time (OutputVideoFrame f) const
1016 {
1017         return divide_with_round (f * TIME_HZ, video_frame_rate ());
1018 }
1019
1020 OutputAudioFrame
1021 Film::audio_frame_rate () const
1022 {
1023         /* XXX */
1024         return 48000;
1025 }
1026
1027 void
1028 Film::set_sequence_video (bool s)
1029 {
1030         _sequence_video = s;
1031         _playlist->set_sequence_video (s);
1032         signal_changed (SEQUENCE_VIDEO);
1033 }
1034
1035 /** @return Size of the largest possible image in whatever resolution we are using */
1036 libdcp::Size
1037 Film::full_frame () const
1038 {
1039         switch (_resolution) {
1040         case RESOLUTION_2K:
1041                 return libdcp::Size (2048, 1080);
1042         case RESOLUTION_4K:
1043                 return libdcp::Size (4096, 2160);
1044         }
1045
1046         assert (false);
1047         return libdcp::Size ();
1048 }
1049
1050 /** @return Size of the frame */
1051 libdcp::Size
1052 Film::frame_size () const
1053 {
1054         return fit_ratio_within (container()->ratio(), full_frame ());
1055 }
1056
1057 /** @param from KDM from time in local time.
1058  *  @param to KDM to time in local time.
1059  */
1060 libdcp::KDM
1061 Film::make_kdm (
1062         shared_ptr<libdcp::Certificate> target,
1063         boost::filesystem::path cpl_file,
1064         boost::posix_time::ptime from,
1065         boost::posix_time::ptime until
1066         ) const
1067 {
1068         shared_ptr<const Signer> signer = make_signer ();
1069
1070         time_t now = time (0);
1071         struct tm* tm = localtime (&now);
1072         string const issue_date = libdcp::tm_to_string (tm);
1073
1074         return libdcp::KDM (cpl_file, signer, target, key (), from, until, "DCP-o-matic", issue_date);
1075 }
1076
1077 list<libdcp::KDM>
1078 Film::make_kdms (
1079         list<shared_ptr<Screen> > screens,
1080         boost::filesystem::path dcp,
1081         boost::posix_time::ptime from,
1082         boost::posix_time::ptime until
1083         ) const
1084 {
1085         list<libdcp::KDM> kdms;
1086
1087         for (list<shared_ptr<Screen> >::iterator i = screens.begin(); i != screens.end(); ++i) {
1088                 kdms.push_back (make_kdm ((*i)->certificate, dcp, from, until));
1089         }
1090
1091         return kdms;
1092 }
1093
1094 /** @return The approximate disk space required to encode a DCP of this film with the
1095  *  current settings, in bytes.
1096  */
1097 uint64_t
1098 Film::required_disk_space () const
1099 {
1100         return uint64_t (j2k_bandwidth() / 8) * length() / TIME_HZ;
1101 }
1102
1103 /** This method checks the disk that the Film is on and tries to decide whether or not
1104  *  there will be enough space to make a DCP for it.  If so, true is returned; if not,
1105  *  false is returned and required and availabe are filled in with the amount of disk space
1106  *  required and available respectively (in Gb).
1107  *
1108  *  Note: the decision made by this method isn't, of course, 100% reliable.
1109  */
1110 bool
1111 Film::should_be_enough_disk_space (double& required, double& available) const
1112 {
1113         boost::filesystem::space_info s = boost::filesystem::space (internal_video_mxf_dir ());
1114         required = double (required_disk_space ()) / 1073741824.0f;
1115         available = double (s.available) / 1073741824.0f;
1116         return (available - required) > 1;
1117 }
1118
1119 FrameRateChange
1120 Film::active_frame_rate_change (Time t) const
1121 {
1122         return _playlist->active_frame_rate_change (t, video_frame_rate ());
1123 }
1124