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                         bool burnt_in = true;
 701                         BOOST_FOREACH (shared_ptr<Content> i, content ()) {
 702                                 if (!i->caption) {
 703                                         continue;
 704                                 }
 705
 706                                 if (i->caption->use() && !i->caption->burn()) {
 707                                         burnt_in = false;
 708                                 }
 709                         }
 710
 711                         string language = dm.subtitle_language;
 712                         if (burnt_in && language != "XX") {
 713                                 transform (language.begin(), language.end(), language.begin(), ::tolower);
 714                         } else {
 715                                 transform (language.begin(), language.end(), language.begin(), ::toupper);
 716                         }
 717
 718                         d += "-" + language;
 719                 } else {
 720                         d += "-XX";
 721                 }
 722         }
 723
 724         if (!dm.territory.empty ()) {
 725                 d += "_" + dm.territory;
 726                 if (dm.rating.empty ()) {
 727                         d += "-NR";
 728                 } else {
 729                         d += "-" + dm.rating;
 730                 }
 731         }
 732
 733         /* Count mapped audio channels */
 734
 735         pair<int, int> ch = audio_channel_types (mapped_audio_channels(), audio_channels());
 736         if (!ch.first && !ch.second) {
 737                 d += "_MOS";
 738         } else if (ch.first) {
 739                 d += String::compose("_%1%2", ch.first, ch.second);
 740         }
 741
 742         /* XXX: HI/VI */
 743
 744         d += "_" + resolution_to_string (_resolution);
 745
 746         if (!dm.studio.empty ()) {
 747                 d += "_" + dm.studio;
 748         }
 749
 750         if (if_created_now) {
 751                 d += "_" + boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
 752         } else {
 753                 d += "_" + boost::gregorian::to_iso_string (_isdcf_date);
 754         }
 755
 756         if (!dm.facility.empty ()) {
 757                 d += "_" + dm.facility;
 758         }
 759
 760         if (_interop) {
 761                 d += "_IOP";
 762         } else {
 763                 d += "_SMPTE";
 764         }
 765
 766         if (three_d ()) {
 767                 d += "-3D";
 768         }
 769
 770         bool vf = false;
 771         BOOST_FOREACH (shared_ptr<Content> i, content ()) {
 772                 shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (i);
 773                 if (dc && (dc->reference_video() || dc->reference_audio() || dc->reference_subtitle())) {
 774                         vf = true;
 775                 }
 776         }
 777
 778         if (vf) {
 779                 d += "_VF";
 780         } else {
 781                 d += "_OV";
 782         }
 783
 784         return d;
 785 }
 786
 787 /** @return name to give the DCP */
 788 string
 789 Film::dcp_name (bool if_created_now) const
 790 {
 791         string unfiltered;
 792         if (use_isdcf_name()) {
 793                 return careful_string_filter (isdcf_name (if_created_now));
 794         }
 795
 796         return careful_string_filter (name ());
 797 }
 798
 799 void
 800 Film::set_directory (boost::filesystem::path d)
 801 {
 802         _directory = d;
 803         _dirty = true;
 804 }
 805
 806 void
 807 Film::set_name (string n)
 808 {
 809         _name = n;
 810         signal_changed (NAME);
 811 }
 812
 813 void
 814 Film::set_use_isdcf_name (bool u)
 815 {
 816         _use_isdcf_name = u;
 817         signal_changed (USE_ISDCF_NAME);
 818 }
 819
 820 void
 821 Film::set_dcp_content_type (DCPContentType const * t)
 822 {
 823         _dcp_content_type = t;
 824         signal_changed (DCP_CONTENT_TYPE);
 825 }
 826
 827 void
 828 Film::set_container (Ratio const * c)
 829 {
 830         _container = c;
 831         signal_changed (CONTAINER);
 832 }
 833
 834 void
 835 Film::set_resolution (Resolution r)
 836 {
 837         _resolution = r;
 838         signal_changed (RESOLUTION);
 839 }
 840
 841 void
 842 Film::set_j2k_bandwidth (int b)
 843 {
 844         _j2k_bandwidth = b;
 845         signal_changed (J2K_BANDWIDTH);
 846 }
 847
 848 void
 849 Film::set_isdcf_metadata (ISDCFMetadata m)
 850 {
 851         _isdcf_metadata = m;
 852         signal_changed (ISDCF_METADATA);
 853 }
 854
 855 void
 856 Film::set_video_frame_rate (int f)
 857 {
 858         _video_frame_rate = f;
 859         signal_changed (VIDEO_FRAME_RATE);
 860 }
 861
 862 void
 863 Film::set_audio_channels (int c)
 864 {
 865         _audio_channels = c;
 866         signal_changed (AUDIO_CHANNELS);
 867 }
 868
 869 void
 870 Film::set_three_d (bool t)
 871 {
 872         _three_d = t;
 873         signal_changed (THREE_D);
 874
 875         if (_three_d && _isdcf_metadata.two_d_version_of_three_d) {
 876                 _isdcf_metadata.two_d_version_of_three_d = false;
 877                 signal_changed (ISDCF_METADATA);
 878         }
 879 }
 880
 881 void
 882 Film::set_interop (bool i)
 883 {
 884         _interop = i;
 885         signal_changed (INTEROP);
 886 }
 887
 888 void
 889 Film::set_audio_processor (AudioProcessor const * processor)
 890 {
 891         _audio_processor = processor;
 892         signal_changed (AUDIO_PROCESSOR);
 893         signal_changed (AUDIO_CHANNELS);
 894 }
 895
 896 void
 897 Film::set_reel_type (ReelType t)
 898 {
 899         _reel_type = t;
 900         signal_changed (REEL_TYPE);
 901 }
 902
 903 /** @param r Desired reel length in bytes */
 904 void
 905 Film::set_reel_length (int64_t r)
 906 {
 907         _reel_length = r;
 908         signal_changed (REEL_LENGTH);
 909 }
 910
 911 void
 912 Film::set_upload_after_make_dcp (bool u)
 913 {
 914         _upload_after_make_dcp = u;
 915         signal_changed (UPLOAD_AFTER_MAKE_DCP);
 916 }
 917
 918 void
 919 Film::signal_changed (Property p)
 920 {
 921         _dirty = true;
 922
 923         switch (p) {
 924         case Film::CONTENT:
 925                 set_video_frame_rate (_playlist->best_video_frame_rate ());
 926                 break;
 927         case Film::VIDEO_FRAME_RATE:
 928         case Film::SEQUENCE:
 929                 _playlist->maybe_sequence ();
 930                 break;
 931         default:
 932                 break;
 933         }
 934
 935         emit (boost::bind (boost::ref (Changed), p));
 936 }
 937
 938 void
 939 Film::set_isdcf_date_today ()
 940 {
 941         _isdcf_date = boost::gregorian::day_clock::local_day ();
 942 }
 943
 944 boost::filesystem::path
 945 Film::j2c_path (int reel, Frame frame, Eyes eyes, bool tmp) const
 946 {
 947         boost::filesystem::path p;
 948         p /= "j2c";
 949         p /= video_identifier ();
 950
 951         char buffer[256];
 952         snprintf(buffer, sizeof(buffer), "%08d_%08" PRId64, reel, frame);
 953         string s (buffer);
 954
 955         if (eyes == EYES_LEFT) {
 956                 s += ".L";
 957         } else if (eyes == EYES_RIGHT) {
 958                 s += ".R";
 959         }
 960
 961         s += ".j2c";
 962
 963         if (tmp) {
 964                 s += ".tmp";
 965         }
 966
 967         p /= s;
 968         return file (p);
 969 }
 970
 971 /** Find all the DCPs in our directory that can be dcp::DCP::read() and return details of their CPLs */
 972 vector<CPLSummary>
 973 Film::cpls () const
 974 {
 975         if (!directory ()) {
 976                 return vector<CPLSummary> ();
 977         }
 978
 979         vector<CPLSummary> out;
 980
 981         boost::filesystem::path const dir = directory().get();
 982         for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator(dir); i != boost::filesystem::directory_iterator(); ++i) {
 983                 if (
 984                         boost::filesystem::is_directory (*i) &&
 985                         i->path().leaf() != "j2c" && i->path().leaf() != "video" && i->path().leaf() != "info" && i->path().leaf() != "analysis"
 986                         ) {
 987
 988                         try {
 989                                 dcp::DCP dcp (*i);
 990                                 dcp.read ();
 991                                 DCPOMATIC_ASSERT (dcp.cpls().front()->file());
 992                                 out.push_back (
 993                                         CPLSummary (
 994                                                 i->path().leaf().string(),
 995                                                 dcp.cpls().front()->id(),
 996                                                 dcp.cpls().front()->annotation_text(),
 997                                                 dcp.cpls().front()->file().get()
 998                                                 )
 999                                         );
1000                         } catch (...) {
1001
1002                         }
1003                 }
1004         }
1005
1006         return out;
1007 }
1008
1009 void
1010 Film::set_signed (bool s)
1011 {
1012         _signed = s;
1013         signal_changed (SIGNED);
1014 }
1015
1016 void
1017 Film::set_encrypted (bool e)
1018 {
1019         _encrypted = e;
1020         signal_changed (ENCRYPTED);
1021 }
1022
1023 void
1024 Film::set_key (dcp::Key key)
1025 {
1026         _key = key;
1027         signal_changed (KEY);
1028 }
1029
1030 ContentList
1031 Film::content () const
1032 {
1033         return _playlist->content ();
1034 }
1035
1036 /** @param content Content to add.
1037  *  @param disable_audio_analysis true to never do automatic audio analysis, even if it is enabled in configuration.
1038  */
1039 void
1040 Film::examine_and_add_content (shared_ptr<Content> content, bool disable_audio_analysis)
1041 {
1042         if (dynamic_pointer_cast<FFmpegContent> (content) && _directory) {
1043                 run_ffprobe (content->path(0), file ("ffprobe.log"), _log);
1044         }
1045
1046         shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), content));
1047
1048         _job_connections.push_back (
1049                 j->Finished.connect (bind (&Film::maybe_add_content, this, weak_ptr<Job>(j), weak_ptr<Content>(content), disable_audio_analysis))
1050                 );
1051
1052         JobManager::instance()->add (j);
1053 }
1054
1055 void
1056 Film::maybe_add_content (weak_ptr<Job> j, weak_ptr<Content> c, bool disable_audio_analysis)
1057 {
1058         shared_ptr<Job> job = j.lock ();
1059         if (!job || !job->finished_ok ()) {
1060                 return;
1061         }
1062
1063         shared_ptr<Content> content = c.lock ();
1064         if (!content) {
1065                 return;
1066         }
1067
1068         add_content (content);
1069
1070         if (Config::instance()->automatic_audio_analysis() && content->audio && !disable_audio_analysis) {
1071                 shared_ptr<Playlist> playlist (new Playlist);
1072                 playlist->add (content);
1073                 boost::signals2::connection c;
1074                 JobManager::instance()->analyse_audio (
1075                         shared_from_this(), playlist, false, c, bind (&Film::audio_analysis_finished, this)
1076                         );
1077                 _audio_analysis_connections.push_back (c);
1078         }
1079 }
1080
1081 void
1082 Film::add_content (shared_ptr<Content> c)
1083 {
1084         /* Add {video,subtitle} content after any existing {video,subtitle} content */
1085         if (c->video) {
1086                 c->set_position (_playlist->video_end ());
1087         } else if (c->caption) {
1088                 c->set_position (_playlist->subtitle_end ());
1089         }
1090
1091         if (_template_film) {
1092                 /* Take settings from the first piece of content of c's type in _template */
1093                 BOOST_FOREACH (shared_ptr<Content> i, _template_film->content()) {
1094                         c->take_settings_from (i);
1095                 }
1096         }
1097
1098         _playlist->add (c);
1099 }
1100
1101 void
1102 Film::remove_content (shared_ptr<Content> c)
1103 {
1104         _playlist->remove (c);
1105 }
1106
1107 void
1108 Film::move_content_earlier (shared_ptr<Content> c)
1109 {
1110         _playlist->move_earlier (c);
1111 }
1112
1113 void
1114 Film::move_content_later (shared_ptr<Content> c)
1115 {
1116         _playlist->move_later (c);
1117 }
1118
1119 /** @return length of the film from time 0 to the last thing on the playlist */
1120 DCPTime
1121 Film::length () const
1122 {
1123         return _playlist->length().ceil(video_frame_rate());
1124 }
1125
1126 int
1127 Film::best_video_frame_rate () const
1128 {
1129         return _playlist->best_video_frame_rate ();
1130 }
1131
1132 FrameRateChange
1133 Film::active_frame_rate_change (DCPTime t) const
1134 {
1135         return _playlist->active_frame_rate_change (t, video_frame_rate ());
1136 }
1137
1138 void
1139 Film::playlist_content_changed (weak_ptr<Content> c, int p, bool frequent)
1140 {
1141         _dirty = true;
1142
1143         if (p == ContentProperty::VIDEO_FRAME_RATE) {
1144                 set_video_frame_rate (_playlist->best_video_frame_rate ());
1145         } else if (p == AudioContentProperty::STREAMS) {
1146                 signal_changed (NAME);
1147         }
1148
1149         emit (boost::bind (boost::ref (ContentChanged), c, p, frequent));
1150 }
1151
1152 void
1153 Film::playlist_changed ()
1154 {
1155         signal_changed (CONTENT);
1156         signal_changed (NAME);
1157 }
1158
1159 void
1160 Film::playlist_order_changed ()
1161 {
1162         signal_changed (CONTENT_ORDER);
1163 }
1164
1165 int
1166 Film::audio_frame_rate () const
1167 {
1168         BOOST_FOREACH (shared_ptr<Content> i, content ()) {
1169                 if (i->audio && i->audio->has_rate_above_48k ()) {
1170                         return 96000;
1171                 }
1172         }
1173
1174         return 48000;
1175 }
1176
1177 void
1178 Film::set_sequence (bool s)
1179 {
1180         if (s == _sequence) {
1181                 return;
1182         }
1183
1184         _sequence = s;
1185         _playlist->set_sequence (s);
1186         signal_changed (SEQUENCE);
1187 }
1188
1189 /** @return Size of the largest possible image in whatever resolution we are using */
1190 dcp::Size
1191 Film::full_frame () const
1192 {
1193         switch (_resolution) {
1194         case RESOLUTION_2K:
1195                 return dcp::Size (2048, 1080);
1196         case RESOLUTION_4K:
1197                 return dcp::Size (4096, 2160);
1198         }
1199
1200         DCPOMATIC_ASSERT (false);
1201         return dcp::Size ();
1202 }
1203
1204 /** @return Size of the frame */
1205 dcp::Size
1206 Film::frame_size () const
1207 {
1208         return fit_ratio_within (container()->ratio(), full_frame ());
1209 }
1210
1211 /** @param recipient KDM recipient certificate.
1212  *  @param trusted_devices Certificates of other trusted devices (can be empty).
1213  *  @param cpl_file CPL filename.
1214  *  @param from KDM from time expressed as a local time with an offset from UTC.
1215  *  @param until KDM to time expressed as a local time with an offset from UTC.
1216  *  @param formulation KDM formulation to use.
1217  *  @param disable_forensic_marking_picture true to disable forensic marking of picture.
1218  *  @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio.  If set to 0,
1219  *  disable all forensic marking; if set above 0, disable forensic marking above that channel.
1220  */
1221 dcp::EncryptedKDM
1222 Film::make_kdm (
1223         dcp::Certificate recipient,
1224         vector<dcp::Certificate> trusted_devices,
1225         boost::filesystem::path cpl_file,
1226         dcp::LocalTime from,
1227         dcp::LocalTime until,
1228         dcp::Formulation formulation,
1229         bool disable_forensic_marking_picture,
1230         optional<int> disable_forensic_marking_audio
1231         ) const
1232 {
1233         if (!_encrypted) {
1234                 throw runtime_error (_("Cannot make a KDM as this project is not encrypted."));
1235         }
1236
1237         shared_ptr<const dcp::CPL> cpl (new dcp::CPL (cpl_file));
1238         shared_ptr<const dcp::CertificateChain> signer = Config::instance()->signer_chain ();
1239         if (!signer->valid ()) {
1240                 throw InvalidSignerError ();
1241         }
1242
1243         /* Find keys that have been added to imported, encrypted DCP content */
1244         list<dcp::DecryptedKDMKey> imported_keys;
1245         BOOST_FOREACH (shared_ptr<Content> i, content()) {
1246                 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent> (i);
1247                 if (d && d->kdm()) {
1248                         dcp::DecryptedKDM kdm (d->kdm().get(), Config::instance()->decryption_chain()->key().get());
1249                         list<dcp::DecryptedKDMKey> keys = kdm.keys ();
1250                         copy (keys.begin(), keys.end(), back_inserter (imported_keys));
1251                 }
1252         }
1253
1254         map<shared_ptr<const dcp::ReelMXF>, dcp::Key> keys;
1255
1256         BOOST_FOREACH(shared_ptr<const dcp::ReelAsset> i, cpl->reel_assets ()) {
1257                 shared_ptr<const dcp::ReelMXF> mxf = boost::dynamic_pointer_cast<const dcp::ReelMXF> (i);
1258                 if (!mxf || !mxf->key_id()) {
1259                         continue;
1260                 }
1261
1262                 /* Get any imported key for this ID */
1263                 bool done = false;
1264                 BOOST_FOREACH (dcp::DecryptedKDMKey j, imported_keys) {
1265                         if (j.id() == mxf->key_id().get()) {
1266                                 LOG_GENERAL ("Using imported key for %1", mxf->key_id().get());
1267                                 keys[mxf] = j.key();
1268                                 done = true;
1269                         }
1270                 }
1271
1272                 if (!done) {
1273                         /* No imported key; it must be an asset that we encrypted */
1274                         LOG_GENERAL ("Using our own key for %1", mxf->key_id().get());
1275                         keys[mxf] = key();
1276                 }
1277         }
1278
1279         return dcp::DecryptedKDM (
1280                 cpl->id(), keys, from, until, cpl->content_title_text(), cpl->content_title_text(), dcp::LocalTime().as_string()
1281                 ).encrypt (signer, recipient, trusted_devices, formulation, disable_forensic_marking_picture, disable_forensic_marking_audio);
1282 }
1283
1284 /** @param screens Screens to make KDMs for.
1285  *  @param cpl_file Path to CPL to make KDMs for.
1286  *  @param from KDM from time expressed as a local time in the time zone of the Screen's Cinema.
1287  *  @param until KDM to time expressed as a local time in the time zone of the Screen's Cinema.
1288  *  @param formulation KDM formulation to use.
1289  *  @param disable_forensic_marking_picture true to disable forensic marking of picture.
1290  *  @param disable_forensic_marking_audio if not set, don't disable forensic marking of audio.  If set to 0,
1291  *  disable all forensic marking; if set above 0, disable forensic marking above that channel.
1292  */
1293 list<ScreenKDM>
1294 Film::make_kdms (
1295         list<shared_ptr<Screen> > screens,
1296         boost::filesystem::path cpl_file,
1297         boost::posix_time::ptime from,
1298         boost::posix_time::ptime until,
1299         dcp::Formulation formulation,
1300         bool disable_forensic_marking_picture,
1301         optional<int> disable_forensic_marking_audio
1302         ) const
1303 {
1304         list<ScreenKDM> kdms;
1305
1306         BOOST_FOREACH (shared_ptr<Screen> i, screens) {
1307                 if (i->recipient) {
1308                         dcp::EncryptedKDM const kdm = make_kdm (
1309                                 i->recipient.get(),
1310                                 i->trusted_devices,
1311                                 cpl_file,
1312                                 dcp::LocalTime (from, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
1313                                 dcp::LocalTime (until, i->cinema->utc_offset_hour(), i->cinema->utc_offset_minute()),
1314                                 formulation,
1315                                 disable_forensic_marking_picture,
1316                                 disable_forensic_marking_audio
1317                                 );
1318
1319                         kdms.push_back (ScreenKDM (i, kdm));
1320                 }
1321         }
1322
1323         return kdms;
1324 }
1325
1326 /** @return The approximate disk space required to encode a DCP of this film with the
1327  *  current settings, in bytes.
1328  */
1329 uint64_t
1330 Film::required_disk_space () const
1331 {
1332         return _playlist->required_disk_space (j2k_bandwidth(), audio_channels(), audio_frame_rate());
1333 }
1334
1335 /** This method checks the disk that the Film is on and tries to decide whether or not
1336  *  there will be enough space to make a DCP for it.  If so, true is returned; if not,
1337  *  false is returned and required and available are filled in with the amount of disk space
1338  *  required and available respectively (in Gb).
1339  *
1340  *  Note: the decision made by this method isn't, of course, 100% reliable.
1341  */
1342 bool
1343 Film::should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const
1344 {
1345         /* Create a test file and see if we can hard-link it */
1346         boost::filesystem::path test = internal_video_asset_dir() / "test";
1347         boost::filesystem::path test2 = internal_video_asset_dir() / "test2";
1348         can_hard_link = true;
1349         FILE* f = fopen_boost (test, "w");
1350         if (f) {
1351                 fclose (f);
1352                 boost::system::error_code ec;
1353                 boost::filesystem::create_hard_link (test, test2, ec);
1354                 if (ec) {
1355                         can_hard_link = false;
1356                 }
1357                 boost::filesystem::remove (test);
1358                 boost::filesystem::remove (test2);
1359         }
1360
1361         boost::filesystem::space_info s = boost::filesystem::space (internal_video_asset_dir ());
1362         required = double (required_disk_space ()) / 1073741824.0f;
1363         if (!can_hard_link) {
1364                 required *= 2;
1365         }
1366         available = double (s.available) / 1073741824.0f;
1367         return (available - required) > 1;
1368 }
1369
1370 string
1371 Film::subtitle_language () const
1372 {
1373         set<string> languages;
1374
1375         ContentList cl = content ();
1376         BOOST_FOREACH (shared_ptr<Content>& c, cl) {
1377                 if (c->caption) {
1378                         languages.insert (c->caption->language ());
1379                 }
1380         }
1381
1382         string all;
1383         BOOST_FOREACH (string s, languages) {
1384                 if (!all.empty ()) {
1385                         all += "/" + s;
1386                 } else {
1387                         all += s;
1388                 }
1389         }
1390
1391         return all;
1392 }
1393
1394 /** Change the gains of the supplied AudioMapping to make it a default
1395  *  for this film.  The defaults are guessed based on what processor (if any)
1396  *  is in use, the number of input channels and any filename supplied.
1397  */
1398 void
1399 Film::make_audio_mapping_default (AudioMapping& mapping, optional<boost::filesystem::path> filename) const
1400 {
1401         static string const regex[] = {
1402                 ".*[\\._-]L[\\._-].*",
1403                 ".*[\\._-]R[\\._-].*",
1404                 ".*[\\._-]C[\\._-].*",
1405                 ".*[\\._-]Lfe[\\._-].*",
1406                 ".*[\\._-]Ls[\\._-].*",
1407                 ".*[\\._-]Rs[\\._-].*"
1408         };
1409
1410         static int const regexes = sizeof(regex) / sizeof(*regex);
1411
1412         if (audio_processor ()) {
1413                 audio_processor()->make_audio_mapping_default (mapping);
1414         } else {
1415                 mapping.make_zero ();
1416                 if (mapping.input_channels() == 1) {
1417                         bool guessed = false;
1418
1419                         /* See if we can guess where this stream should go */
1420                         if (filename) {
1421                                 for (int i = 0; i < regexes; ++i) {
1422                                         boost::regex e (regex[i], boost::regex::icase);
1423                                         if (boost::regex_match (filename->string(), e) && i < mapping.output_channels()) {
1424                                                 mapping.set (0, i, 1);
1425                                                 guessed = true;
1426                                         }
1427                                 }
1428                         }
1429
1430                         if (!guessed) {
1431                                 /* If we have no idea, just put it on centre */
1432                                 mapping.set (0, static_cast<int> (dcp::CENTRE), 1);
1433                         }
1434                 } else {
1435                         /* 1:1 mapping */
1436                         for (int i = 0; i < min (mapping.input_channels(), mapping.output_channels()); ++i) {
1437                                 mapping.set (i, i, 1);
1438                         }
1439                 }
1440         }
1441 }
1442
1443 /** @return The names of the channels that audio contents' outputs are passed into;
1444  *  this is either the DCP or a AudioProcessor.
1445  */
1446 vector<string>
1447 Film::audio_output_names () const
1448 {
1449         if (audio_processor ()) {
1450                 return audio_processor()->input_names ();
1451         }
1452
1453         DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
1454
1455         vector<string> n;
1456
1457         for (int i = 0; i < audio_channels(); ++i) {
1458                 n.push_back (short_audio_channel_name (i));
1459         }
1460
1461         return n;
1462 }
1463
1464 void
1465 Film::repeat_content (ContentList c, int n)
1466 {
1467         _playlist->repeat (c, n);
1468 }
1469
1470 void
1471 Film::remove_content (ContentList c)
1472 {
1473         _playlist->remove (c);
1474 }
1475
1476 void
1477 Film::audio_analysis_finished ()
1478 {
1479         /* XXX */
1480 }
1481
1482 list<DCPTimePeriod>
1483 Film::reels () const
1484 {
1485         list<DCPTimePeriod> p;
1486         DCPTime const len = length();
1487
1488         switch (reel_type ()) {
1489         case REELTYPE_SINGLE:
1490                 p.push_back (DCPTimePeriod (DCPTime (), len));
1491                 break;
1492         case REELTYPE_BY_VIDEO_CONTENT:
1493         {
1494                 optional<DCPTime> last_split;
1495                 shared_ptr<Content> last_video;
1496                 BOOST_FOREACH (shared_ptr<Content> c, content ()) {
1497                         if (c->video) {
1498                                 BOOST_FOREACH (DCPTime t, c->reel_split_points()) {
1499                                         if (last_split) {
1500                                                 p.push_back (DCPTimePeriod (last_split.get(), t));
1501                                         }
1502                                         last_split = t;
1503                                 }
1504                                 last_video = c;
1505                         }
1506                 }
1507
1508                 DCPTime video_end = last_video ? last_video->end() : DCPTime(0);
1509                 if (last_split) {
1510                         /* Definitely go from the last split to the end of the video content */
1511                         p.push_back (DCPTimePeriod (last_split.get(), video_end));
1512                 }
1513
1514                 if (video_end < len) {
1515                         /* And maybe go after that as well if there is any non-video hanging over the end */
1516                         p.push_back (DCPTimePeriod (video_end, len));
1517                 }
1518                 break;
1519         }
1520         case REELTYPE_BY_LENGTH:
1521         {
1522                 DCPTime current;
1523                 /* Integer-divide reel length by the size of one frame to give the number of frames per reel */
1524                 Frame const reel_in_frames = _reel_length / ((j2k_bandwidth() / video_frame_rate()) / 8);
1525                 while (current < len) {
1526                         DCPTime end = min (len, current + DCPTime::from_frames (reel_in_frames, video_frame_rate ()));
1527                         p.push_back (DCPTimePeriod (current, end));
1528                         current = end;
1529                 }
1530                 break;
1531         }
1532         }
1533
1534         return p;
1535 }
1536
1537 /** @param period A period within the DCP
1538  *  @return Name of the content which most contributes to the given period.
1539  */
1540 string
1541 Film::content_summary (DCPTimePeriod period) const
1542 {
1543         return _playlist->content_summary (period);
1544 }
1545
1546 void
1547 Film::use_template (string name)
1548 {
1549         _template_film.reset (new Film (optional<boost::filesystem::path>()));
1550         _template_film->read_metadata (Config::instance()->template_path (name));
1551         _use_isdcf_name = _template_film->_use_isdcf_name;
1552         _dcp_content_type = _template_film->_dcp_content_type;
1553         _container = _template_film->_container;
1554         _resolution = _template_film->_resolution;
1555         _j2k_bandwidth = _template_film->_j2k_bandwidth;
1556         _video_frame_rate = _template_film->_video_frame_rate;
1557         _signed = _template_film->_signed;
1558         _encrypted = _template_film->_encrypted;
1559         _audio_channels = _template_film->_audio_channels;
1560         _sequence = _template_film->_sequence;
1561         _three_d = _template_film->_three_d;
1562         _interop = _template_film->_interop;
1563         _audio_processor = _template_film->_audio_processor;
1564         _reel_type = _template_film->_reel_type;
1565         _reel_length = _template_film->_reel_length;
1566         _upload_after_make_dcp = _template_film->_upload_after_make_dcp;
1567         _isdcf_metadata = _template_film->_isdcf_metadata;
1568 }
1569
1570 pair<double, double>
1571 Film::speed_up_range (int dcp_frame_rate) const
1572 {
1573         return _playlist->speed_up_range (dcp_frame_rate);
1574 }
1575
1576 void
1577 Film::copy_from (shared_ptr<const Film> film)
1578 {
1579         read_metadata (film->file (metadata_file));
1580 }
1581
1582 bool
1583 Film::references_dcp_video () const
1584 {
1585         BOOST_FOREACH (shared_ptr<Content> i, _playlist->content()) {
1586                 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent>(i);
1587                 if (d && d->reference_video()) {
1588                         return true;
1589                 }
1590         }
1591
1592         return false;
1593 }
1594
1595 bool
1596 Film::references_dcp_audio () const
1597 {
1598         BOOST_FOREACH (shared_ptr<Content> i, _playlist->content()) {
1599                 shared_ptr<DCPContent> d = dynamic_pointer_cast<DCPContent>(i);
1600                 if (d && d->reference_audio()) {
1601                         return true;
1602                 }
1603         }
1604
1605         return false;
1606 }