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