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