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