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