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