src/lib/film.cc

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