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