src/lib/film.cc

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