src/lib/film.cc

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