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