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