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