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