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