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