src/lib/film.cc

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