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