src/lib/film.cc

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