src/lib/film.cc

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