src/lib/film.cc

   1 /*
   2     Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 /** @file  src/film.cc
  22  *  @brief A representation of some audio and video content, and details of
  23  *  how they should be presented in a DCP.
  24  */
  25
  26 #include "film.h"
  27 #include "job.h"
  28 #include "util.h"
  29 #include "job_manager.h"
  30 #include "transcode_job.h"
  31 #include "upload_job.h"
  32 #include "null_log.h"
  33 #include "file_log.h"
  34 #include "exceptions.h"
  35 #include "examine_content_job.h"
  36 #include "config.h"
  37 #include "playlist.h"
  38 #include "dcp_content_type.h"
  39 #include "ratio.h"
  40 #include "cross.h"
  41 #include "environment_info.h"
  42 #include "raw_convert.h"
  43 #include "audio_processor.h"
  44 #include "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 "dcp_content.h"
  52 #include "screen_kdm.h"
  53 #include "cinema.h"
  54 #include <libcxml/cxml.h>
  55 #include <dcp/cpl.h>
  56 #include <dcp/certificate_chain.h>
  57 #include <dcp/util.h>
  58 #include <dcp/local_time.h>
  59 #include <dcp/decrypted_kdm.h>
  60 #include <libxml++/libxml++.h>
  61 #include <boost/filesystem.hpp>
  62 #include <boost/algorithm/string.hpp>
  63 #include <boost/foreach.hpp>
  64 #include <boost/regex.hpp>
  65 #include <unistd.h>
  66 #include <stdexcept>
  67 #include <iostream>
  68 #include <algorithm>
  69 #include <cstdlib>
  70 #include <iomanip>
  71 #include <set>
  72
  73 #include "i18n.h"
  74
  75 using std::string;
  76 using std::pair;
  77 using std::vector;
  78 using std::setfill;
  79 using std::min;
  80 using std::max;
  81 using std::make_pair;
  82 using std::cout;
  83 using std::list;
  84 using std::set;
  85 using std::runtime_error;
  86 using boost::shared_ptr;
  87 using boost::weak_ptr;
  88 using boost::dynamic_pointer_cast;
  89 using boost::optional;
  90 using boost::is_any_of;
  91
  92 #define LOG_GENERAL(...) log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
  93 #define LOG_GENERAL_NC(...) log()->log (__VA_ARGS__, LogEntry::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  * 32 -> 33
 110  * Changed <Period> to <Subtitle> in FFmpegSubtitleStream
 111  * 33 -> 34
 112  * Content only contains audio/subtitle-related tags if those things
 113  * are present.
 114  * 34 -> 35
 115  * VideoFrameType in VideoContent is a string rather than an integer.
 116  * 35 -> 36
 117  * EffectColour rather than OutlineColour in Subtitle.
 118  */
 119 int const Film::current_state_version = 36;
 120
 121 /** Construct a Film object in a given directory.
 122  *
 123  *  @param dir Film directory.
 124  */
 125
 126 Film::Film (boost::filesystem::path dir, bool log)
 127         : _playlist (new Playlist)
 128         , _use_isdcf_name (true)
 129         , _dcp_content_type (Config::instance()->default_dcp_content_type ())
 130         , _container (Config::instance()->default_container ())
 131         , _resolution (RESOLUTION_2K)
 132         , _signed (true)
 133         , _encrypted (false)
 134         , _j2k_bandwidth (Config::instance()->default_j2k_bandwidth ())
 135         , _isdcf_metadata (Config::instance()->default_isdcf_metadata ())
 136         , _video_frame_rate (24)
 137         , _audio_channels (Config::instance()->default_dcp_audio_channels ())
 138         , _three_d (false)
 139         , _sequence (true)
 140         , _interop (Config::instance()->default_interop ())
 141         , _audio_processor (0)
 142         , _reel_type (REELTYPE_SINGLE)
 143         , _reel_length (2000000000)
 144         , _upload_after_make_dcp (false)
 145         , _state_version (current_state_version)
 146         , _dirty (false)
 147 {
 148         set_isdcf_date_today ();
 149
 150         _playlist_changed_connection = _playlist->Changed.connect (bind (&Film::playlist_changed, this));
 151         _playlist_order_changed_connection = _playlist->OrderChanged.connect (bind (&Film::playlist_order_changed, this));
 152         _playlist_content_changed_connection = _playlist->ContentChanged.connect (bind (&Film::playlist_content_changed, this, _1, _2, _3));
 153
 154         /* Make state.directory a complete path without ..s (where possible)
 155            (Code swiped from Adam Bowen on stackoverflow)
 156            XXX: couldn't/shouldn't this just be boost::filesystem::canonical?
 157         */
 158
 159         boost::filesystem::path p (boost::filesystem::system_complete (dir));
 160         boost::filesystem::path result;
 161         for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
 162                 if (*i == "..") {
 163                         if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
 164                                 result /= *i;
 165                         } else {
 166                                 result = result.parent_path ();
 167                         }
 168                 } else if (*i != ".") {
 169                         result /= *i;
 170                 }
 171         }
 172
 173         set_directory (result.make_preferred ());
 174         if (log) {
 175                 _log.reset (new FileLog (file ("log")));
 176         } else {
 177                 _log.reset (new NullLog);
 178         }
 179
 180         _playlist->set_sequence (_sequence);
 181 }
 182
 183 Film::~Film ()
 184 {
 185         BOOST_FOREACH (boost::signals2::connection& i, _job_connections) {
 186                 i.disconnect ();
 187         }
 188
 189         BOOST_FOREACH (boost::signals2::connection& i, _audio_analysis_connections) {
 190                 i.disconnect ();
 191         }
 192 }
 193
 194 string
 195 Film::video_identifier () const
 196 {
 197         DCPOMATIC_ASSERT (container ());
 198
 199         string s = container()->id()
 200                 + "_" + resolution_to_string (_resolution)
 201                 + "_" + _playlist->video_identifier()
 202                 + "_" + raw_convert<string>(_video_frame_rate)
 203                 + "_" + raw_convert<string>(j2k_bandwidth());
 204
 205         if (encrypted ()) {
 206                 s += "_E";
 207         } else {
 208                 s += "_P";
 209         }
 210
 211         if (_interop) {
 212                 s += "_I";
 213         } else {
 214                 s += "_S";
 215         }
 216
 217         if (_three_d) {
 218                 s += "_3D";
 219         }
 220
 221         return s;
 222 }
 223
 224 /** @return The file to write video frame info to */
 225 boost::filesystem::path
 226 Film::info_file (DCPTimePeriod period) const
 227 {
 228         boost::filesystem::path p;
 229         p /= "info";
 230         p /= video_identifier () + "_" + raw_convert<string> (period.from.get()) + "_" + raw_convert<string> (period.to.get());
 231         return file (p);
 232 }
 233
 234 boost::filesystem::path
 235 Film::internal_video_asset_dir () const
 236 {
 237         return dir ("video");
 238 }
 239
 240 boost::filesystem::path
 241 Film::internal_video_asset_filename (DCPTimePeriod p) const
 242 {
 243         return video_identifier() + "_" + raw_convert<string> (p.from.get()) + "_" + raw_convert<string> (p.to.get()) + ".mxf";
 244 }
 245
 246 boost::filesystem::path
 247 Film::audio_analysis_path (shared_ptr<const Playlist> playlist) const
 248 {
 249         boost::filesystem::path p = dir ("analysis");
 250
 251         Digester digester;
 252         BOOST_FOREACH (shared_ptr<Content> i, playlist->content ()) {
 253                 if (!i->audio) {
 254                         continue;
 255                 }
 256
 257                 digester.add (i->digest ());
 258                 digester.add (i->audio->mapping().digest ());
 259                 if (playlist->content().size() != 1) {
 260                         /* Analyses should be considered equal regardless of gain
 261                            if they were made from just one piece of content.  This
 262                            is because we can fake any gain change in a single-content
 263                            analysis at the plotting stage rather than having to
 264                            recompute it.
 265                         */
 266                         digester.add (i->audio->gain ());
 267                 }
 268         }
 269
 270         if (audio_processor ()) {
 271                 digester.add (audio_processor()->id ());
 272         }
 273
 274         p /= digester.get ();
 275         return p;
 276 }
 277
 278 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
 279 void
 280 Film::make_dcp ()
 281 {
 282         if (dcp_name().find ("/") != string::npos) {
 283                 throw BadSettingError (_("name"), _("cannot contain slashes"));
 284         }
 285
 286         set_isdcf_date_today ();
 287
 288         BOOST_FOREACH (string i, environment_info ()) {
 289                 LOG_GENERAL_NC (i);
 290         }
 291
 292         BOOST_FOREACH (shared_ptr<const Content> i, content ()) {
 293                 LOG_GENERAL ("Content: %1", i->technical_summary());
 294         }
 295         LOG_GENERAL ("DCP video rate %1 fps", video_frame_rate());
 296         if (Config::instance()->only_servers_encode ()) {
 297                 LOG_GENERAL_NC ("0 threads: ONLY SERVERS SET TO ENCODE");
 298         } else {
 299                 LOG_GENERAL ("%1 threads", Config::instance()->num_local_encoding_threads());
 300         }
 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 runtime_error (_("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 UploadJob (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("Sequence")->add_child_text (_sequence ? "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         root->add_child("ReelType")->add_child_text (raw_convert<string> (_reel_type));
 364         root->add_child("ReelLength")->add_child_text (raw_convert<string> (_reel_length));
 365         root->add_child("UploadAfterMakeDCP")->add_child_text (_upload_after_make_dcp ? "1" : "0");
 366         _playlist->as_xml (root->add_child ("Playlist"));
 367
 368         return doc;
 369 }
 370
 371 /** Write state to our `metadata' file */
 372 void
 373 Film::write_metadata () const
 374 {
 375         boost::filesystem::create_directories (directory ());
 376         shared_ptr<xmlpp::Document> doc = metadata ();
 377         doc->write_to_file_formatted (file("metadata.xml").string ());
 378         _dirty = false;
 379 }
 380
 381 /** Read state from our metadata file.
 382  *  @return Notes about things that the user should know about, or empty.
 383  */
 384 list<string>
 385 Film::read_metadata ()
 386 {
 387         if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
 388                 throw runtime_error (_("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!"));
 389         }
 390
 391         cxml::Document f ("Metadata");
 392         f.read_file (file ("metadata.xml"));
 393
 394         _state_version = f.number_child<int> ("Version");
 395         if (_state_version > current_state_version) {
 396                 throw runtime_error (_("This film was created with a newer version of DCP-o-matic, and it cannot be loaded into this version.  Sorry!"));
 397         }
 398
 399         _name = f.string_child ("Name");
 400         if (_state_version >= 9) {
 401                 _use_isdcf_name = f.bool_child ("UseISDCFName");
 402                 _isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
 403                 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("ISDCFDate"));
 404         } else {
 405                 _use_isdcf_name = f.bool_child ("UseDCIName");
 406                 _isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
 407                 _isdcf_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
 408         }
 409
 410         {
 411                 optional<string> c = f.optional_string_child ("DCPContentType");
 412                 if (c) {
 413                         _dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
 414                 }
 415         }
 416
 417         {
 418                 optional<string> c = f.optional_string_child ("Container");
 419                 if (c) {
 420                         _container = Ratio::from_id (c.get ());
 421                 }
 422         }
 423
 424         _resolution = string_to_resolution (f.string_child ("Resolution"));
 425         _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
 426         _video_frame_rate = f.number_child<int> ("VideoFrameRate");
 427         _signed = f.optional_bool_child("Signed").get_value_or (true);
 428         _encrypted = f.bool_child ("Encrypted");
 429         _audio_channels = f.number_child<int> ("AudioChannels");
 430         /* We used to allow odd numbers (and zero) channels, but it's just not worth
 431            the pain.
 432         */
 433         if (_audio_channels == 0) {
 434                 _audio_channels = 2;
 435         } else if ((_audio_channels % 2) == 1) {
 436                 _audio_channels++;
 437         }
 438
 439         if (f.optional_bool_child("SequenceVideo")) {
 440                 _sequence = f.bool_child("SequenceVideo");
 441         } else {
 442                 _sequence = f.bool_child("Sequence");
 443         }
 444
 445         _three_d = f.bool_child ("ThreeD");
 446         _interop = f.bool_child ("Interop");
 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         _reel_type = static_cast<ReelType> (f.optional_number_child<int>("ReelType").get_value_or (static_cast<int>(REELTYPE_SINGLE)));
 456         _reel_length = f.optional_number_child<int64_t>("ReelLength").get_value_or (2000000000);
 457         _upload_after_make_dcp = f.optional_bool_child("UploadAfterMakeDCP").get_value_or (false);
 458
 459         list<string> notes;
 460         /* This method is the only one that can return notes (so far) */
 461         _playlist->set_from_xml (shared_from_this(), f.node_child ("Playlist"), _state_version, notes);
 462
 463         /* Write backtraces to this film's directory, until another film is loaded */
 464         set_backtrace_file (file ("backtrace.txt"));
 465
 466         _dirty = false;
 467         return notes;
 468 }
 469
 470 /** Given a directory name, return its full path within the Film's directory.
 471  *  The directory (and its parents) will be created if they do not exist.
 472  */
 473 boost::filesystem::path
 474 Film::dir (boost::filesystem::path d) const
 475 {
 476         boost::filesystem::path p;
 477         p /= _directory;
 478         p /= d;
 479
 480         boost::filesystem::create_directories (p);
 481
 482         return p;
 483 }
 484
 485 /** Given a file or directory name, return its full path within the Film's directory.
 486  *  Any required parent directories will be created.
 487  */
 488 boost::filesystem::path
 489 Film::file (boost::filesystem::path f) const
 490 {
 491         boost::filesystem::path p;
 492         p /= _directory;
 493         p /= f;
 494
 495         boost::filesystem::create_directories (p.parent_path ());
 496
 497         return p;
 498 }
 499
 500 list<int>
 501 Film::mapped_audio_channels () const
 502 {
 503         list<int> mapped;
 504
 505         if (audio_processor ()) {
 506                 /* Processors are mapped 1:1 to DCP outputs so we can work out mappings from there */
 507                 for (int i = 0; i < audio_processor()->out_channels(); ++i) {
 508                         mapped.push_back (i);
 509                 }
 510         } else {
 511                 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
 512                         if (i->audio) {
 513                                 list<int> c = i->audio->mapping().mapped_output_channels ();
 514                                 copy (c.begin(), c.end(), back_inserter (mapped));
 515                         }
 516                 }
 517
 518                 mapped.sort ();
 519                 mapped.unique ();
 520         }
 521
 522         return mapped;
 523 }
 524
 525 /** @return a ISDCF-compliant name for a DCP of this film */
 526 string
 527 Film::isdcf_name (bool if_created_now) const
 528 {
 529         string d;
 530
 531         string raw_name = name ();
 532
 533         /* Split the raw name up into words */
 534         vector<string> words;
 535         split (words, raw_name, is_any_of (" _-"));
 536
 537         string fixed_name;
 538
 539         /* Add each word to fixed_name */
 540         for (vector<string>::const_iterator i = words.begin(); i != words.end(); ++i) {
 541                 string w = *i;
 542
 543                 /* First letter is always capitalised */
 544                 w[0] = toupper (w[0]);
 545
 546                 /* Count caps in w */
 547                 size_t caps = 0;
 548                 for (size_t i = 0; i < w.size(); ++i) {
 549                         if (isupper (w[i])) {
 550                                 ++caps;
 551                         }
 552                 }
 553
 554                 /* If w is all caps make the rest of it lower case, otherwise
 555                    leave it alone.
 556                 */
 557                 if (caps == w.size ()) {
 558                         for (size_t i = 1; i < w.size(); ++i) {
 559                                 w[i] = tolower (w[i]);
 560                         }
 561                 }
 562
 563                 for (size_t i = 0; i < w.size(); ++i) {
 564                         fixed_name += w[i];
 565                 }
 566         }
 567
 568         if (fixed_name.length() > 14) {
 569                 fixed_name = fixed_name.substr (0, 14);
 570         }
 571
 572         d += fixed_name;
 573
 574         if (dcp_content_type()) {
 575                 d += "_" + dcp_content_type()->isdcf_name();
 576                 d += "-" + raw_convert<string>(isdcf_metadata().content_version);
 577         }
 578
 579         ISDCFMetadata const dm = isdcf_metadata ();
 580
 581         if (dm.temp_version) {
 582                 d += "-Temp";
 583         }
 584
 585         if (dm.pre_release) {
 586                 d += "-Pre";
 587         }
 588
 589         if (dm.red_band) {
 590                 d += "-RedBand";
 591         }
 592
 593         if (!dm.chain.empty ()) {
 594                 d += "-" + dm.chain;
 595         }
 596
 597         if (three_d ()) {
 598                 d += "-3D";
 599         }
 600
 601         if (dm.two_d_version_of_three_d) {
 602                 d += "-2D";
 603         }
 604
 605         if (!dm.mastered_luminance.empty ()) {
 606                 d += "-" + dm.mastered_luminance;
 607         }
 608
 609         if (video_frame_rate() != 24) {
 610                 d += "-" + raw_convert<string>(video_frame_rate());
 611         }
 612
 613         if (container()) {
 614                 d += "_" + container()->isdcf_name();
 615         }
 616
 617         /* XXX: this uses the first bit of content only */
 618
 619         /* The standard says we don't do this for trailers, for some strange reason */
 620         if (dcp_content_type() && dcp_content_type()->libdcp_kind() != dcp::TRAILER) {
 621                 Ratio const * content_ratio = 0;
 622                 BOOST_FOREACH (shared_ptr<Content> i, content ()) {
 623                         if (i->video) {
 624                                 /* Here's the first piece of video content */
 625                                 if (i->video->scale().ratio ()) {
 626                                         content_ratio = i->video->scale().ratio ();
 627                                 } else {
 628                                         content_ratio = Ratio::from_ratio (i->video->size().ratio ());
 629                                 }
 630                                 break;
 631                         }
 632                 }
 633
 634                 if (content_ratio && content_ratio != container()) {
 635                         d += "-" + content_ratio->isdcf_name();
 636                 }
 637         }
 638
 639         if (!dm.audio_language.empty ()) {
 640                 d += "_" + dm.audio_language;
 641                 if (!dm.subtitle_language.empty()) {
 642
 643                         bool burnt_in = true;
 644                         BOOST_FOREACH (shared_ptr<Content> i, content ()) {
 645                                 if (!i->subtitle) {
 646                                         continue;
 647                                 }
 648
 649                                 if (i->subtitle->use() && !i->subtitle->burn()) {
 650                                         burnt_in = false;
 651                                 }
 652                         }
 653
 654                         string language = dm.subtitle_language;
 655                         if (burnt_in && language != "XX") {
 656                                 transform (language.begin(), language.end(), language.begin(), ::tolower);
 657                         } else {
 658                                 transform (language.begin(), language.end(), language.begin(), ::toupper);
 659                         }
 660
 661                         d += "-" + language;
 662                 } else {
 663                         d += "-XX";
 664                 }
 665         }
 666
 667         if (!dm.territory.empty ()) {
 668                 d += "_" + dm.territory;
 669                 if (dm.rating.empty ()) {
 670                         d += "-NR";
 671                 } else {
 672                         d += "-" + dm.rating;
 673                 }
 674         }
 675
 676         /* Count mapped audio channels */
 677
 678         int non_lfe = 0;
 679         int lfe = 0;
 680
 681         BOOST_FOREACH (int i, mapped_audio_channels ()) {
 682                 if (i >= audio_channels()) {
 683                         /* This channel is mapped but is not included in the DCP */
 684                         continue;
 685                 }
 686
 687                 if (static_cast<dcp::Channel> (i) == dcp::LFE) {
 688                         ++lfe;
 689                 } else {
 690                         ++non_lfe;
 691                 }
 692         }
 693
 694         if (non_lfe) {
 695                 d += String::compose("_%1%2", non_lfe, lfe);
 696         }
 697
 698         /* XXX: HI/VI */
 699
 700         d += "_" + resolution_to_string (_resolution);
 701
 702         if (!dm.studio.empty ()) {
 703                 d += "_" + dm.studio;
 704         }
 705
 706         if (if_created_now) {
 707                 d += "_" + boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
 708         } else {
 709                 d += "_" + boost::gregorian::to_iso_string (_isdcf_date);
 710         }
 711
 712         if (!dm.facility.empty ()) {
 713                 d += "_" + dm.facility;
 714         }
 715
 716         if (_interop) {
 717                 d += "_IOP";
 718         } else {
 719                 d += "_SMPTE";
 720         }
 721
 722         if (three_d ()) {
 723                 d += "-3D";
 724         }
 725
 726         bool vf = false;
 727         BOOST_FOREACH (shared_ptr<Content> i, content ()) {
 728                 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (i);
 729                 if (dc && (dc->reference_video() || dc->reference_audio() || dc->reference_subtitle())) {
 730                         vf = true;
 731                 }
 732         }
 733
 734         if (vf) {
 735                 d += "_VF";
 736         } else {
 737                 d += "_OV";
 738         }
 739
 740         return d;
 741 }
 742
 743 /** @return name to give the DCP */
 744 string
 745 Film::dcp_name (bool if_created_now) const
 746 {
 747         string unfiltered;
 748         if (use_isdcf_name()) {
 749                 unfiltered = isdcf_name (if_created_now);
 750         } else {
 751                 unfiltered = name ();
 752         }
 753
 754         /* Filter out `bad' characters which cause problems with some systems.
 755            There's no apparent list of what really is allowed, so this is a guess.
 756         */
 757
 758         string filtered;
 759         string const allowed = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_";
 760         for (size_t i = 0; i < unfiltered.size(); ++i) {
 761                 if (allowed.find (unfiltered[i]) != string::npos) {
 762                         filtered += unfiltered[i];
 763                 }
 764         }
 765
 766         return filtered;
 767 }
 768
 769 void
 770 Film::set_directory (boost::filesystem::path d)
 771 {
 772         _directory = d;
 773         _dirty = true;
 774 }
 775
 776 void
 777 Film::set_name (string n)
 778 {
 779         _name = n;
 780         signal_changed (NAME);
 781 }
 782
 783 void
 784 Film::set_use_isdcf_name (bool u)
 785 {
 786         _use_isdcf_name = u;
 787         signal_changed (USE_ISDCF_NAME);
 788 }
 789
 790 void
 791 Film::set_dcp_content_type (DCPContentType const * t)
 792 {
 793         _dcp_content_type = t;
 794         signal_changed (DCP_CONTENT_TYPE);
 795 }
 796
 797 void
 798 Film::set_container (Ratio const * c)
 799 {
 800         _container = c;
 801         signal_changed (CONTAINER);
 802 }
 803
 804 void
 805 Film::set_resolution (Resolution r)
 806 {
 807         _resolution = r;
 808         signal_changed (RESOLUTION);
 809 }
 810
 811 void
 812 Film::set_j2k_bandwidth (int b)
 813 {
 814         _j2k_bandwidth = b;
 815         signal_changed (J2K_BANDWIDTH);
 816 }
 817
 818 void
 819 Film::set_isdcf_metadata (ISDCFMetadata m)
 820 {
 821         _isdcf_metadata = m;
 822         signal_changed (ISDCF_METADATA);
 823 }
 824
 825 void
 826 Film::set_video_frame_rate (int f)
 827 {
 828         _video_frame_rate = f;
 829         signal_changed (VIDEO_FRAME_RATE);
 830 }
 831
 832 void
 833 Film::set_audio_channels (int c)
 834 {
 835         _audio_channels = c;
 836         signal_changed (AUDIO_CHANNELS);
 837 }
 838
 839 void
 840 Film::set_three_d (bool t)
 841 {
 842         _three_d = t;
 843         signal_changed (THREE_D);
 844
 845         if (_three_d && _isdcf_metadata.two_d_version_of_three_d) {
 846                 _isdcf_metadata.two_d_version_of_three_d = false;
 847                 signal_changed (ISDCF_METADATA);
 848         }
 849 }
 850
 851 void
 852 Film::set_interop (bool i)
 853 {
 854         _interop = i;
 855         signal_changed (INTEROP);
 856 }
 857
 858 void
 859 Film::set_audio_processor (AudioProcessor const * processor)
 860 {
 861         _audio_processor = processor;
 862         signal_changed (AUDIO_PROCESSOR);
 863         signal_changed (AUDIO_CHANNELS);
 864 }
 865
 866 void
 867 Film::set_reel_type (ReelType t)
 868 {
 869         _reel_type = t;
 870         signal_changed (REEL_TYPE);
 871 }
 872
 873 /** @param r Desired reel length in bytes */
 874 void
 875 Film::set_reel_length (int64_t r)
 876 {
 877         _reel_length = r;
 878         signal_changed (REEL_LENGTH);
 879 }
 880
 881 void
 882 Film::set_upload_after_make_dcp (bool u)
 883 {
 884         _upload_after_make_dcp = u;
 885         signal_changed (UPLOAD_AFTER_MAKE_DCP);
 886 }
 887
 888 void
 889 Film::signal_changed (Property p)
 890 {
 891         _dirty = true;
 892
 893         switch (p) {
 894         case Film::CONTENT:
 895                 set_video_frame_rate (_playlist->best_video_frame_rate ());
 896                 break;
 897         case Film::VIDEO_FRAME_RATE:
 898         case Film::SEQUENCE:
 899                 _playlist->maybe_sequence ();
 900                 break;
 901         default:
 902                 break;
 903         }
 904
 905         emit (boost::bind (boost::ref (Changed), p));
 906 }
 907
 908 void
 909 Film::set_isdcf_date_today ()
 910 {
 911         _isdcf_date = boost::gregorian::day_clock::local_day ();
 912 }
 913
 914 boost::filesystem::path
 915 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
 916 {
 917         boost::filesystem::path p;
 918         p /= "j2c";
 919         p /= video_identifier ();
 920
 921         char buffer[256];
 922         snprintf(buffer, sizeof(buffer), "%08d_%08" PRId64, reel, frame);
 923         string s (buffer);
 924
 925         if (eyes == EYES_LEFT) {
 926                 s += ".L";
 927         } else if (eyes == EYES_RIGHT) {
 928                 s += ".R";
 929         }
 930
 931         s += ".j2c";
 932
 933         if (tmp) {
 934                 s += ".tmp";
 935         }
 936
 937         p /= s;
 938         return file (p);
 939 }
 940
 941 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs */
 942 vector<CPLSummary>
 943 Film::cpls () const
 944 {
 945         vector<CPLSummary> out;
 946
 947         boost::filesystem::path const dir = directory ();
 948         for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
 949                 if (
 950                         boost::filesystem::is_directory (*i) &&
 951                         i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
 952                         ) {
 953
 954                         try {
 955                                 dcp::DCP dcp (*i);
 956                                 dcp.read ();
 957                                 out.push_back (
 958                                         CPLSummary (
 959                                                 i->path().leaf().string(),
 960                                                 dcp.cpls().front()->id(),
 961                                                 dcp.cpls().front()->annotation_text(),
 962                                                 dcp.cpls().front()->file()
 963                                                 )
 964                                         );
 965                         } catch (...) {
 966
 967                         }
 968                 }
 969         }
 970
 971         return out;
 972 }
 973
 974 void
 975 Film::set_signed (bool s)
 976 {
 977         _signed = s;
 978         signal_changed (SIGNED);
 979 }
 980
 981 void
 982 Film::set_encrypted (bool e)
 983 {
 984         _encrypted = e;
 985         signal_changed (ENCRYPTED);
 986 }
 987
 988 void
 989 Film::set_key (dcp::Key key)
 990 {
 991         _key = key;
 992         signal_changed (KEY);
 993 }
 994
 995 ContentList
 996 Film::content () const
 997 {
 998         return _playlist->content ();
 999 }
1000
1001 void
1002 Film::examine_content (shared_ptr<Content> c)
1003 {
1004         shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
1005         JobManager::instance()->add (j);
1006 }
1007
1008 void
1009 Film::examine_and_add_content (shared_ptr<Content> c)
1010 {
1011         if (dynamic_pointer_cast<FFmpegContent> (c) && !_directory.empty ()) {
1012                 run_ffprobe (c->path(0), file ("ffprobe.log"), _log);
1013         }
1014
1015         shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c));
1016
1017         _job_connections.push_back (
1018                 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job> (j), weak_ptr<Content> (c)))
1019                 );
1020
1021         JobManager::instance()->add (j);
1022 }
1023
1024 void
1025 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c)
1026 {
1027         shared_ptr<Job> job = j.lock ();
1028         if (!job || !job->finished_ok ()) {
1029                 return;
1030         }
1031
1032         shared_ptr<Content> content = c.lock ();
1033         if (!content) {
1034                 return;
1035         }
1036
1037         add_content (content);
1038         if (Config::instance()->automatic_audio_analysis() && content->audio) {
1039                 shared_ptr<Playlist> playlist (new Playlist);
1040                 playlist->add (content);
1041                 boost::signals2::connection c;
1042                 JobManager::instance()->analyse_audio (
1043                         shared_from_this (), playlist, c, bind (&Film::audio_analysis_finished, this)
1044                         );
1045                 _audio_analysis_connections.push_back (c);
1046         }
1047 }
1048
1049 void
1050 Film::add_content (shared_ptr<Content> c)
1051 {
1052         /* Add {video,subtitle} content after any existing {video,subtitle} content */
1053         if (c->video) {
1054                 c->set_position (_playlist->video_end ());
1055         } else if (c->subtitle) {
1056                 c->set_position (_playlist->subtitle_end ());
1057         }
1058
1059         _playlist->add (c);
1060 }
1061
1062 void
1063 Film::remove_content (shared_ptr<Content> c)
1064 {
1065         _playlist->remove (c);
1066 }
1067
1068 void
1069 Film::move_content_earlier (shared_ptr<Content> c)
1070 {
1071         _playlist->move_earlier (c);
1072 }
1073
1074 void
1075 Film::move_content_later (shared_ptr<Content> c)
1076 {
1077         _playlist->move_later (c);
1078 }
1079
1080 /** @return length of the film from time 0 to the last thing on the playlist */
1081 DCPTime
1082 Film::length () const
1083 {
1084         return _playlist->length ();
1085 }
1086
1087 int
1088 Film::best_video_frame_rate () const
1089 {
1090         return _playlist->best_video_frame_rate ();
1091 }
1092
1093 FrameRateChange
1094 Film::active_frame_rate_change (DCPTime t) const
1095 {
1096         return _playlist->active_frame_rate_change (t, video_frame_rate ());
1097 }
1098
1099 void
1100 Film::playlist_content_changed (weak_ptr<Content> c, int p, bool frequent)
1101 {
1102         _dirty = true;
1103
1104         if (p == ContentProperty::VIDEO_FRAME_RATE) {
1105                 set_video_frame_rate (_playlist->best_video_frame_rate ());
1106         } else if (p == AudioContentProperty::STREAMS) {
1107                 signal_changed (NAME);
1108         }
1109
1110         emit (boost::bind (boost::ref (ContentChanged), c, p, frequent));
1111 }
1112
1113 void
1114 Film::playlist_changed ()
1115 {
1116         signal_changed (CONTENT);
1117         signal_changed (NAME);
1118 }
1119
1120 void
1121 Film::playlist_order_changed ()
1122 {
1123         signal_changed (CONTENT_ORDER);
1124 }
1125
1126 int
1127 Film::audio_frame_rate () const
1128 {
1129         BOOST_FOREACH (shared_ptr<Content> i, content ()) {
1130                 if (i->audio && i->audio->has_rate_above_48k ()) {
1131                         return 96000;
1132                 }
1133         }
1134
1135         return 48000;
1136 }
1137
1138 void
1139 Film::set_sequence (bool s)
1140 {
1141         _sequence = s;
1142         _playlist->set_sequence (s);
1143         signal_changed (SEQUENCE);
1144 }
1145
1146 /** @return Size of the largest possible image in whatever resolution we are using */
1147 dcp::Size
1148 Film::full_frame () const
1149 {
1150         switch (_resolution) {
1151         case RESOLUTION_2K:
1152                 return dcp::Size (2048, 1080);
1153         case RESOLUTION_4K:
1154                 return dcp::Size (4096, 2160);
1155         }
1156
1157         DCPOMATIC_ASSERT (false);
1158         return dcp::Size ();
1159 }
1160
1161 /** @return Size of the frame */
1162 dcp::Size
1163 Film::frame_size () const
1164 {
1165         return fit_ratio_within (container()->ratio(), full_frame ());
1166 }
1167
1168 /** @param from KDM from time expressed as a local time with an offset from UTC
1169  *  @param to KDM to time expressed as a local time with an offset from UTC
1170  */
1171 dcp::EncryptedKDM
1172 Film::make_kdm (
1173         dcp::Certificate recipient,
1174         vector<dcp::Certificate> trusted_devices,
1175         boost::filesystem::path cpl_file,
1176         dcp::LocalTime from,
1177         dcp::LocalTime until,
1178         dcp::Formulation formulation
1179         ) const
1180 {
1181         shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
1182         shared_ptr<const dcp::CertificateChain> signer = Config::instance()->signer_chain ();
1183         if (!signer->valid ()) {
1184                 throw InvalidSignerError ();
1185         }
1186
1187         return dcp::DecryptedKDM (
1188                 cpl, key(), from, until, cpl->content_title_text(), cpl->content_title_text(), dcp::LocalTime().as_string()
1189                 ).encrypt (signer, recipient, trusted_devices, formulation);
1190 }
1191
1192 /** @param from KDM from time expressed as a local time in the time zone of the Screen's Cinema.
1193  *  @param to KDM to time expressed as a local time in the time zone of the Screen's Cinema.
1194  */
1195 list<ScreenKDM>
1196 Film::make_kdms (
1197         list<shared_ptr<Screen> > screens,
1198         boost::filesystem::path dcp,
1199         boost::posix_time::ptime from,
1200         boost::posix_time::ptime until,
1201         dcp::Formulation formulation
1202         ) const
1203 {
1204         list<ScreenKDM> kdms;
1205
1206         BOOST_FOREACH (shared_ptr<Screen> i, screens) {
1207                 if (i->recipient) {
1208                         dcp::EncryptedKDM const kdm = make_kdm (
1209                                 i->recipient.get(),
1210                                 i->trusted_devices,
1211                                 dcp,
1212                                 dcp::LocalTime (from, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
1213                                 dcp::LocalTime (until, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
1214                                 formulation
1215                                 );
1216
1217                         kdms.push_back (ScreenKDM (i, kdm));
1218                 }
1219         }
1220
1221         return kdms;
1222 }
1223
1224 /** @return The approximate disk space required to encode a DCP of this film with the
1225  *  current settings, in bytes.
1226  */
1227 uint64_t
1228 Film::required_disk_space () const
1229 {
1230         return _playlist->required_disk_space (j2k_bandwidth(), audio_channels(), audio_frame_rate());
1231 }
1232
1233 /** This method checks the disk that the Film is on and tries to decide whether or not
1234  *  there will be enough space to make a DCP for it.  If so, true is returned; if not,
1235  *  false is returned and required and available are filled in with the amount of disk space
1236  *  required and available respectively (in Gb).
1237  *
1238  *  Note: the decision made by this method isn't, of course, 100% reliable.
1239  */
1240 bool
1241 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1242 {
1243         /* Create a test file and see if we can hard-link it */
1244         boost::filesystem::path test = internal_video_asset_dir() / "test";
1245         boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1246         can_hard_link = true;
1247         FILE* f = fopen_boost (test, "w");
1248         if (f) {
1249                 fclose (f);
1250                 boost::system::error_code ec;
1251                 boost::filesystem::create_hard_link (test, test2, ec);
1252                 if (ec) {
1253                         can_hard_link = false;
1254                 }
1255                 boost::filesystem::remove (test);
1256                 boost::filesystem::remove (test2);
1257         }
1258
1259         boost::filesystem::space_info s = boost::filesystem::space (internal_video_asset_dir ());
1260         required = double (required_disk_space ()) / 1073741824.0f;
1261         if (!can_hard_link) {
1262                 required *= 2;
1263         }
1264         available = double (s.available) / 1073741824.0f;
1265         return (available - required) > 1;
1266 }
1267
1268 string
1269 Film::subtitle_language () const
1270 {
1271         set<string> languages;
1272
1273         ContentList cl = content ();
1274         BOOST_FOREACH (shared_ptr<Content>& c, cl) {
1275                 if (c->subtitle) {
1276                         languages.insert (c->subtitle->language ());
1277                 }
1278         }
1279
1280         string all;
1281         BOOST_FOREACH (string s, languages) {
1282                 if (!all.empty ()) {
1283                         all += "/" + s;
1284                 } else {
1285                         all += s;
1286                 }
1287         }
1288
1289         return all;
1290 }
1291
1292 /** Change the gains of the supplied AudioMapping to make it a default
1293  *  for this film.  The defaults are guessed based on what processor (if any)
1294  *  is in use, the number of input channels and any filename supplied.
1295  */
1296 void
1297 Film::make_audio_mapping_default (AudioMapping& mapping, optional<boost::filesystem::path> filename) const
1298 {
1299         static string const regex[] = {
1300                 ".*[\\._-]L[\\._-].*",
1301                 ".*[\\._-]R[\\._-].*",
1302                 ".*[\\._-]C[\\._-].*",
1303                 ".*[\\._-]Lfe[\\._-].*",
1304                 ".*[\\._-]Ls[\\._-].*",
1305                 ".*[\\._-]Rs[\\._-].*"
1306         };
1307
1308         static int const regexes = sizeof(regex) / sizeof(*regex);
1309
1310         if (audio_processor ()) {
1311                 audio_processor()->make_audio_mapping_default (mapping);
1312         } else {
1313                 mapping.make_zero ();
1314                 if (mapping.input_channels() == 1) {
1315                         bool guessed = false;
1316
1317                         /* See if we can guess where this stream should go */
1318                         if (filename) {
1319                                 for (int i = 0; i < regexes; ++i) {
1320                                         boost::regex e (regex[i], boost::regex::icase);
1321                                         if (boost::regex_match (filename->string(), e) && i < mapping.output_channels()) {
1322                                                 mapping.set (0, i, 1);
1323                                                 guessed = true;
1324                                         }
1325                                 }
1326                         }
1327
1328                         if (!guessed) {
1329                                 /* If we have no idea, just put it on centre */
1330                                 mapping.set (0, static_cast<int> (dcp::CENTRE), 1);
1331                         }
1332                 } else {
1333                         /* 1:1 mapping */
1334                         for (int i = 0; i < min (mapping.input_channels(), mapping.output_channels()); ++i) {
1335                                 mapping.set (i, i, 1);
1336                         }
1337                 }
1338         }
1339 }
1340
1341 /** @return The names of the channels that audio contents' outputs are passed into;
1342  *  this is either the DCP or a AudioProcessor.
1343  */
1344 vector<string>
1345 Film::audio_output_names () const
1346 {
1347         if (audio_processor ()) {
1348                 return audio_processor()->input_names ();
1349         }
1350
1351         DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1352
1353         vector<string> n;
1354         n.push_back (_("L"));
1355         n.push_back (_("R"));
1356         n.push_back (_("C"));
1357         n.push_back (_("Lfe"));
1358         n.push_back (_("Ls"));
1359         n.push_back (_("Rs"));
1360         n.push_back (_("HI"));
1361         n.push_back (_("VI"));
1362         n.push_back (_("Lc"));
1363         n.push_back (_("Rc"));
1364         n.push_back (_("BsL"));
1365         n.push_back (_("BsR"));
1366         n.push_back (_("DBP"));
1367         n.push_back (_("DBS"));
1368         n.push_back ("");
1369         n.push_back ("");
1370
1371         return vector<string> (n.begin(), n.begin() + audio_channels ());
1372 }
1373
1374 void
1375 Film::repeat_content (ContentList c, int n)
1376 {
1377         _playlist->repeat (c, n);
1378 }
1379
1380 void
1381 Film::remove_content (ContentList c)
1382 {
1383         _playlist->remove (c);
1384 }
1385
1386 void
1387 Film::audio_analysis_finished ()
1388 {
1389         /* XXX */
1390 }
1391
1392 list<DCPTimePeriod>
1393 Film::reels () const
1394 {
1395         list<DCPTimePeriod> p;
1396         DCPTime const len = length().round_up (video_frame_rate ());
1397
1398         switch (reel_type ()) {
1399         case REELTYPE_SINGLE:
1400                 p.push_back (DCPTimePeriod (DCPTime (), len));
1401                 break;
1402         case REELTYPE_BY_VIDEO_CONTENT:
1403         {
1404                 optional<DCPTime> last_split;
1405                 shared_ptr<Content> last_video;
1406                 BOOST_FOREACH (shared_ptr<Content> c, content ()) {
1407                         if (c->video) {
1408                                 BOOST_FOREACH (DCPTime t, c->reel_split_points()) {
1409                                         if (last_split) {
1410                                                 p.push_back (DCPTimePeriod (last_split.get(), t));
1411                                         }
1412                                         last_split = t;
1413                                 }
1414                                 last_video = c;
1415                         }
1416                 }
1417
1418                 DCPTime video_end = last_video ? last_video->end() : DCPTime(0);
1419                 if (last_split) {
1420                         /* Definitely go from the last split to the end of the video content */
1421                         p.push_back (DCPTimePeriod (last_split.get(), video_end));
1422                 }
1423
1424                 if (video_end < len) {
1425                         /* And maybe go after that as well if there is any non-video hanging over the end */
1426                         p.push_back (DCPTimePeriod (video_end, len));
1427                 }
1428                 break;
1429         }
1430         case REELTYPE_BY_LENGTH:
1431         {
1432                 DCPTime current;
1433                 /* Integer-divide reel length by the size of one frame to give the number of frames per reel */
1434                 Frame const reel_in_frames = _reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8);
1435                 while (current < len) {
1436                         DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1437                         p.push_back (DCPTimePeriod (current, end));
1438                         current = end;
1439                 }
1440                 break;
1441         }
1442         }
1443
1444         return p;
1445 }
1446
1447 string
1448 Film::content_summary (DCPTimePeriod period) const
1449 {
1450         return _playlist->content_summary (period);
1451 }