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