src/lib/film.cc

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