src/lib/film.cc

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