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