src/lib/film.cc

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