src/lib/film.cc

   1 /*
   2     Copyright (C) 2012 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 <sstream>
  26 #include <iomanip>
  27 #include <unistd.h>
  28 #include <boost/filesystem.hpp>
  29 #include <boost/algorithm/string.hpp>
  30 #include <boost/lexical_cast.hpp>
  31 #include <boost/date_time.hpp>
  32 #include <libxml++/libxml++.h>
  33 #include <libcxml/cxml.h>
  34 #include "film.h"
  35 #include "format.h"
  36 #include "job.h"
  37 #include "filter.h"
  38 #include "util.h"
  39 #include "job_manager.h"
  40 #include "ab_transcode_job.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 "analyse_audio_job.h"
  51 #include "playlist.h"
  52 #include "player.h"
  53 #include "ffmpeg_content.h"
  54 #include "imagemagick_content.h"
  55 #include "sndfile_content.h"
  56 #include "dcp_content_type.h"
  57
  58 #include "i18n.h"
  59
  60 using std::string;
  61 using std::stringstream;
  62 using std::multimap;
  63 using std::pair;
  64 using std::map;
  65 using std::vector;
  66 using std::ifstream;
  67 using std::ofstream;
  68 using std::setfill;
  69 using std::min;
  70 using std::make_pair;
  71 using std::endl;
  72 using std::list;
  73 using boost::shared_ptr;
  74 using boost::lexical_cast;
  75 using boost::to_upper_copy;
  76 using boost::ends_with;
  77 using boost::starts_with;
  78 using boost::optional;
  79 using libdcp::Size;
  80
  81 int const Film::state_version = 4;
  82
  83 /** Construct a Film object in a given directory, reading any metadata
  84  *  file that exists in that directory.  An exception will be thrown if
  85  *  must_exist is true and the specified directory does not exist.
  86  *
  87  *  @param d Film directory.
  88  *  @param must_exist true to throw an exception if does not exist.
  89  */
  90
  91 Film::Film (string d, bool must_exist)
  92         : _playlist (new Playlist)
  93         , _use_dci_name (true)
  94         , _trust_content_headers (true)
  95         , _dcp_content_type (0)
  96         , _format (Format::from_id ("185"))
  97         , _scaler (Scaler::from_id ("bicubic"))
  98         , _trim_start (0)
  99         , _trim_end (0)
 100         , _ab (false)
 101         , _audio_gain (0)
 102         , _audio_delay (0)
 103         , _with_subtitles (false)
 104         , _subtitle_offset (0)
 105         , _subtitle_scale (1)
 106         , _colour_lut (0)
 107         , _j2k_bandwidth (200000000)
 108         , _dci_metadata (Config::instance()->default_dci_metadata ())
 109         , _dcp_frame_rate (0)
 110         , _dirty (false)
 111 {
 112         set_dci_date_today ();
 113
 114         _playlist->ContentChanged.connect (bind (&Film::content_changed, this, _1, _2));
 115
 116         /* Make state.directory a complete path without ..s (where possible)
 117            (Code swiped from Adam Bowen on stackoverflow)
 118         */
 119
 120         boost::filesystem::path p (boost::filesystem::system_complete (d));
 121         boost::filesystem::path result;
 122         for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
 123                 if (*i == "..") {
 124                         if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
 125                                 result /= *i;
 126                         } else {
 127                                 result = result.parent_path ();
 128                         }
 129                 } else if (*i != ".") {
 130                         result /= *i;
 131                 }
 132         }
 133
 134         set_directory (result.string ());
 135
 136         if (!boost::filesystem::exists (directory())) {
 137                 if (must_exist) {
 138                         throw OpenFileError (directory());
 139                 } else {
 140                         boost::filesystem::create_directory (directory());
 141                 }
 142         }
 143
 144         if (must_exist) {
 145                 read_metadata ();
 146         }
 147
 148         _log.reset (new FileLog (file ("log")));
 149 }
 150
 151 Film::Film (Film const & o)
 152         : boost::enable_shared_from_this<Film> (o)
 153         /* note: the copied film shares the original's log */
 154         , _log               (o._log)
 155         , _playlist          (new Playlist)
 156         , _directory         (o._directory)
 157         , _name              (o._name)
 158         , _use_dci_name      (o._use_dci_name)
 159         , _trust_content_headers (o._trust_content_headers)
 160         , _dcp_content_type  (o._dcp_content_type)
 161         , _format            (o._format)
 162         , _crop              (o._crop)
 163         , _filters           (o._filters)
 164         , _scaler            (o._scaler)
 165         , _trim_start        (o._trim_start)
 166         , _trim_end          (o._trim_end)
 167         , _ab                (o._ab)
 168         , _audio_gain        (o._audio_gain)
 169         , _audio_delay       (o._audio_delay)
 170         , _with_subtitles    (o._with_subtitles)
 171         , _subtitle_offset   (o._subtitle_offset)
 172         , _subtitle_scale    (o._subtitle_scale)
 173         , _colour_lut        (o._colour_lut)
 174         , _j2k_bandwidth     (o._j2k_bandwidth)
 175         , _dci_metadata      (o._dci_metadata)
 176         , _dcp_frame_rate    (o._dcp_frame_rate)
 177         , _dci_date          (o._dci_date)
 178         , _dirty             (o._dirty)
 179 {
 180         for (ContentList::const_iterator i = o._content.begin(); i != o._content.end(); ++i) {
 181                 _content.push_back ((*i)->clone ());
 182         }
 183
 184         _playlist->ContentChanged.connect (bind (&Film::content_changed, this, _1, _2));
 185
 186         _playlist->setup (_content);
 187 }
 188
 189 string
 190 Film::video_state_identifier () const
 191 {
 192         assert (format ());
 193
 194         return "XXX";
 195
 196 #if 0
 197
 198         pair<string, string> f = Filter::ffmpeg_strings (filters());
 199
 200         stringstream s;
 201         s << format()->id()
 202           << "_" << content_digest()
 203           << "_" << crop().left << "_" << crop().right << "_" << crop().top << "_" << crop().bottom
 204           << "_" << _dcp_frame_rate
 205           << "_" << f.first << "_" << f.second
 206           << "_" << scaler()->id()
 207           << "_" << j2k_bandwidth()
 208           << "_" << boost::lexical_cast<int> (colour_lut());
 209
 210         if (ab()) {
 211                 pair<string, string> fa = Filter::ffmpeg_strings (Config::instance()->reference_filters());
 212                 s << "ab_" << Config::instance()->reference_scaler()->id() << "_" << fa.first << "_" << fa.second;
 213         }
 214
 215         return s.str ();
 216 #endif
 217 }
 218
 219 /** @return The path to the directory to write video frame info files to */
 220 string
 221 Film::info_dir () const
 222 {
 223         boost::filesystem::path p;
 224         p /= "info";
 225         p /= video_state_identifier ();
 226         return dir (p.string());
 227 }
 228
 229 string
 230 Film::video_mxf_dir () const
 231 {
 232         boost::filesystem::path p;
 233         return dir ("video");
 234 }
 235
 236 string
 237 Film::video_mxf_filename () const
 238 {
 239         return video_state_identifier() + ".mxf";
 240 }
 241
 242 string
 243 Film::audio_analysis_path () const
 244 {
 245         boost::filesystem::path p;
 246         p /= "analysis";
 247         p /= "XXX";//content_digest();
 248         return file (p.string ());
 249 }
 250
 251 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
 252 void
 253 Film::make_dcp ()
 254 {
 255         set_dci_date_today ();
 256
 257         if (dcp_name().find ("/") != string::npos) {
 258                 throw BadSettingError (_("name"), _("cannot contain slashes"));
 259         }
 260
 261         log()->log (String::compose ("DVD-o-matic %1 git %2 using %3", dvdomatic_version, dvdomatic_git_commit, dependency_version_summary()));
 262
 263         {
 264                 char buffer[128];
 265                 gethostname (buffer, sizeof (buffer));
 266                 log()->log (String::compose ("Starting to make DCP on %1", buffer));
 267         }
 268
 269 //      log()->log (String::compose ("Content is %1; type %2", content_path(), (content_type() == STILL ? _("still") : _("video"))));
 270 //      if (length()) {
 271 //              log()->log (String::compose ("Content length %1", length().get()));
 272 //      }
 273 //      log()->log (String::compose ("Content digest %1", content_digest()));
 274 //      log()->log (String::compose ("Content at %1 fps, DCP at %2 fps", source_frame_rate(), dcp_frame_rate()));
 275         log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
 276         log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
 277 #ifdef DVDOMATIC_DEBUG
 278         log()->log ("DVD-o-matic built in debug mode.");
 279 #else
 280         log()->log ("DVD-o-matic built in optimised mode.");
 281 #endif
 282 #ifdef LIBDCP_DEBUG
 283         log()->log ("libdcp built in debug mode.");
 284 #else
 285         log()->log ("libdcp built in optimised mode.");
 286 #endif
 287         pair<string, int> const c = cpu_info ();
 288         log()->log (String::compose ("CPU: %1, %2 processors", c.first, c.second));
 289
 290         if (format() == 0) {
 291                 throw MissingSettingError (_("format"));
 292         }
 293
 294         if (content().empty ()) {
 295                 throw MissingSettingError (_("content"));
 296         }
 297
 298         if (dcp_content_type() == 0) {
 299                 throw MissingSettingError (_("content type"));
 300         }
 301
 302         if (name().empty()) {
 303                 throw MissingSettingError (_("name"));
 304         }
 305
 306         shared_ptr<Job> r;
 307
 308         if (ab()) {
 309                 r = JobManager::instance()->add (shared_ptr<Job> (new ABTranscodeJob (shared_from_this())));
 310         } else {
 311                 r = JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this())));
 312         }
 313 }
 314
 315 /** Start a job to analyse the audio in our Playlist */
 316 void
 317 Film::analyse_audio ()
 318 {
 319         if (_analyse_audio_job) {
 320                 return;
 321         }
 322
 323         _analyse_audio_job.reset (new AnalyseAudioJob (shared_from_this()));
 324         _analyse_audio_job->Finished.connect (bind (&Film::analyse_audio_finished, this));
 325         JobManager::instance()->add (_analyse_audio_job);
 326 }
 327
 328 /** Start a job to examine a piece of content */
 329 void
 330 Film::examine_content (shared_ptr<Content> c)
 331 {
 332         shared_ptr<Job> j (new ExamineContentJob (shared_from_this(), c, trust_content_headers ()));
 333         JobManager::instance()->add (j);
 334 }
 335
 336 void
 337 Film::analyse_audio_finished ()
 338 {
 339         ensure_ui_thread ();
 340
 341         if (_analyse_audio_job->finished_ok ()) {
 342                 AudioAnalysisSucceeded ();
 343         }
 344
 345         _analyse_audio_job.reset ();
 346 }
 347
 348 /** Start a job to send our DCP to the configured TMS */
 349 void
 350 Film::send_dcp_to_tms ()
 351 {
 352         shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
 353         JobManager::instance()->add (j);
 354 }
 355
 356 /** Count the number of frames that have been encoded for this film.
 357  *  @return frame count.
 358  */
 359 int
 360 Film::encoded_frames () const
 361 {
 362         if (format() == 0) {
 363                 return 0;
 364         }
 365
 366         int N = 0;
 367         for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
 368                 ++N;
 369                 boost::this_thread::interruption_point ();
 370         }
 371
 372         return N;
 373 }
 374
 375 /** Write state to our `metadata' file */
 376 void
 377 Film::write_metadata () const
 378 {
 379         ContentList the_content = content ();
 380
 381         boost::mutex::scoped_lock lm (_state_mutex);
 382
 383         boost::filesystem::create_directories (directory());
 384
 385         xmlpp::Document doc;
 386         xmlpp::Element* root = doc.create_root_node ("Metadata");
 387
 388         root->add_child("Version")->add_child_text (boost::lexical_cast<string> (state_version));
 389         root->add_child("Name")->add_child_text (_name);
 390         root->add_child("UseDCIName")->add_child_text (_use_dci_name ? "1" : "0");
 391         root->add_child("TrustContentHeaders")->add_child_text (_trust_content_headers ? "1" : "0");
 392         if (_dcp_content_type) {
 393                 root->add_child("DCPContentType")->add_child_text (_dcp_content_type->dci_name ());
 394         }
 395         if (_format) {
 396                 root->add_child("Format")->add_child_text (_format->id ());
 397         }
 398         root->add_child("LeftCrop")->add_child_text (boost::lexical_cast<string> (_crop.left));
 399         root->add_child("RightCrop")->add_child_text (boost::lexical_cast<string> (_crop.right));
 400         root->add_child("TopCrop")->add_child_text (boost::lexical_cast<string> (_crop.top));
 401         root->add_child("BottomCrop")->add_child_text (boost::lexical_cast<string> (_crop.bottom));
 402
 403         for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
 404                 root->add_child("Filter")->add_child_text ((*i)->id ());
 405         }
 406
 407         root->add_child("Scaler")->add_child_text (_scaler->id ());
 408         root->add_child("TrimStart")->add_child_text (boost::lexical_cast<string> (_trim_start));
 409         root->add_child("TrimEnd")->add_child_text (boost::lexical_cast<string> (_trim_end));
 410         root->add_child("AB")->add_child_text (_ab ? "1" : "0");
 411         root->add_child("AudioGain")->add_child_text (boost::lexical_cast<string> (_audio_gain));
 412         root->add_child("AudioDelay")->add_child_text (boost::lexical_cast<string> (_audio_delay));
 413         root->add_child("WithSubtitles")->add_child_text (_with_subtitles ? "1" : "0");
 414         root->add_child("SubtitleOffset")->add_child_text (boost::lexical_cast<string> (_subtitle_offset));
 415         root->add_child("SubtitleScale")->add_child_text (boost::lexical_cast<string> (_subtitle_scale));
 416         root->add_child("ColourLUT")->add_child_text (boost::lexical_cast<string> (_colour_lut));
 417         root->add_child("J2KBandwidth")->add_child_text (boost::lexical_cast<string> (_j2k_bandwidth));
 418         _dci_metadata.as_xml (root->add_child ("DCIMetadata"));
 419         root->add_child("DCPFrameRate")->add_child_text (boost::lexical_cast<string> (_dcp_frame_rate));
 420         root->add_child("DCIDate")->add_child_text (boost::gregorian::to_iso_string (_dci_date));
 421
 422         for (ContentList::iterator i = the_content.begin(); i != the_content.end(); ++i) {
 423                 (*i)->as_xml (root->add_child ("Content"));
 424         }
 425
 426         doc.write_to_file_formatted (file ("metadata.xml"));
 427
 428         _dirty = false;
 429 }
 430
 431 /** Read state from our metadata file */
 432 void
 433 Film::read_metadata ()
 434 {
 435         boost::mutex::scoped_lock lm (_state_mutex);
 436
 437         if (boost::filesystem::exists (file ("metadata")) && !boost::filesystem::exists (file ("metadata.xml"))) {
 438                 throw StringError (_("This film was created with an older version of DVD-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!"));
 439         }
 440
 441         cxml::File f (file ("metadata.xml"), "Metadata");
 442
 443         _name = f.string_child ("Name");
 444         _use_dci_name = f.bool_child ("UseDCIName");
 445         _trust_content_headers = f.bool_child ("TrustContentHeaders");
 446
 447         {
 448                 optional<string> c = f.optional_string_child ("DCPContentType");
 449                 if (c) {
 450                         _dcp_content_type = DCPContentType::from_dci_name (c.get ());
 451                 }
 452         }
 453
 454         {
 455                 optional<string> c = f.optional_string_child ("Format");
 456                 if (c) {
 457                         _format = Format::from_id (c.get ());
 458                 }
 459         }
 460
 461         _crop.left = f.number_child<int> ("LeftCrop");
 462         _crop.right = f.number_child<int> ("RightCrop");
 463         _crop.top = f.number_child<int> ("TopCrop");
 464         _crop.bottom = f.number_child<int> ("BottomCrop");
 465
 466         {
 467                 list<shared_ptr<cxml::Node> > c = f.node_children ("Filter");
 468                 for (list<shared_ptr<cxml::Node> >::iterator i = c.begin(); i != c.end(); ++i) {
 469                         _filters.push_back (Filter::from_id ((*i)->content ()));
 470                 }
 471         }
 472
 473         _scaler = Scaler::from_id (f.string_child ("Scaler"));
 474         _trim_start = f.number_child<int> ("TrimStart");
 475         _trim_end = f.number_child<int> ("TrimEnd");
 476         _ab = f.bool_child ("AB");
 477         _audio_gain = f.number_child<float> ("AudioGain");
 478         _audio_delay = f.number_child<int> ("AudioDelay");
 479         _with_subtitles = f.bool_child ("WithSubtitles");
 480         _subtitle_offset = f.number_child<float> ("SubtitleOffset");
 481         _subtitle_scale = f.number_child<float> ("SubtitleScale");
 482         _colour_lut = f.number_child<int> ("ColourLUT");
 483         _j2k_bandwidth = f.number_child<int> ("J2KBandwidth");
 484         _dci_metadata = DCIMetadata (f.node_child ("DCIMetadata"));
 485         _dcp_frame_rate = f.number_child<int> ("DCPFrameRate");
 486         _dci_date = boost::gregorian::from_undelimited_string (f.string_child ("DCIDate"));
 487
 488         list<shared_ptr<cxml::Node> > c = f.node_children ("Content");
 489         for (list<shared_ptr<cxml::Node> >::iterator i = c.begin(); i != c.end(); ++i) {
 490
 491                 string const type = (*i)->string_child ("Type");
 492                 boost::shared_ptr<Content> c;
 493
 494                 if (type == "FFmpeg") {
 495                         c.reset (new FFmpegContent (*i));
 496                 } else if (type == "ImageMagick") {
 497                         c.reset (new ImageMagickContent (*i));
 498                 } else if (type == "Sndfile") {
 499                         c.reset (new SndfileContent (*i));
 500                 }
 501
 502                 _content.push_back (c);
 503         }
 504
 505         _dirty = false;
 506
 507         _playlist->setup (_content);
 508 }
 509
 510 libdcp::Size
 511 Film::cropped_size (libdcp::Size s) const
 512 {
 513         boost::mutex::scoped_lock lm (_state_mutex);
 514         s.width -= _crop.left + _crop.right;
 515         s.height -= _crop.top + _crop.bottom;
 516         return s;
 517 }
 518
 519 /** Given a directory name, return its full path within the Film's directory.
 520  *  The directory (and its parents) will be created if they do not exist.
 521  */
 522 string
 523 Film::dir (string d) const
 524 {
 525         boost::mutex::scoped_lock lm (_directory_mutex);
 526
 527         boost::filesystem::path p;
 528         p /= _directory;
 529         p /= d;
 530
 531         boost::filesystem::create_directories (p);
 532
 533         return p.string ();
 534 }
 535
 536 /** Given a file or directory name, return its full path within the Film's directory.
 537  *  _directory_mutex must not be locked on entry.
 538  *  Any required parent directories will be created.
 539  */
 540 string
 541 Film::file (string f) const
 542 {
 543         boost::mutex::scoped_lock lm (_directory_mutex);
 544
 545         boost::filesystem::path p;
 546         p /= _directory;
 547         p /= f;
 548
 549         boost::filesystem::create_directories (p.parent_path ());
 550
 551         return p.string ();
 552 }
 553
 554 /** @return The sampling rate that we will resample the audio to */
 555 int
 556 Film::target_audio_sample_rate () const
 557 {
 558         if (!has_audio ()) {
 559                 return 0;
 560         }
 561
 562         /* Resample to a DCI-approved sample rate */
 563         double t = dcp_audio_sample_rate (audio_frame_rate());
 564
 565         FrameRateConversion frc (video_frame_rate(), dcp_frame_rate());
 566
 567         /* Compensate if the DCP is being run at a different frame rate
 568            to the source; that is, if the video is run such that it will
 569            look different in the DCP compared to the source (slower or faster).
 570            skip/repeat doesn't come into effect here.
 571         */
 572
 573         if (frc.change_speed) {
 574                 t *= video_frame_rate() * frc.factor() / dcp_frame_rate();
 575         }
 576
 577         return rint (t);
 578 }
 579
 580 /** @return a DCI-compliant name for a DCP of this film */
 581 string
 582 Film::dci_name (bool if_created_now) const
 583 {
 584         stringstream d;
 585
 586         string fixed_name = to_upper_copy (name());
 587         for (size_t i = 0; i < fixed_name.length(); ++i) {
 588                 if (fixed_name[i] == ' ') {
 589                         fixed_name[i] = '-';
 590                 }
 591         }
 592
 593         /* Spec is that the name part should be maximum 14 characters, as I understand it */
 594         if (fixed_name.length() > 14) {
 595                 fixed_name = fixed_name.substr (0, 14);
 596         }
 597
 598         d << fixed_name;
 599
 600         if (dcp_content_type()) {
 601                 d << "_" << dcp_content_type()->dci_name();
 602         }
 603
 604         if (format()) {
 605                 d << "_" << format()->dci_name();
 606         }
 607
 608         DCIMetadata const dm = dci_metadata ();
 609
 610         if (!dm.audio_language.empty ()) {
 611                 d << "_" << dm.audio_language;
 612                 if (!dm.subtitle_language.empty()) {
 613                         d << "-" << dm.subtitle_language;
 614                 } else {
 615                         d << "-XX";
 616                 }
 617         }
 618
 619         if (!dm.territory.empty ()) {
 620                 d << "_" << dm.territory;
 621                 if (!dm.rating.empty ()) {
 622                         d << "-" << dm.rating;
 623                 }
 624         }
 625
 626         switch (audio_channels ()) {
 627         case 1:
 628                 d << "_10";
 629                 break;
 630         case 2:
 631                 d << "_20";
 632                 break;
 633         case 6:
 634                 d << "_51";
 635                 break;
 636         case 8:
 637                 d << "_71";
 638                 break;
 639         }
 640
 641         d << "_2K";
 642
 643         if (!dm.studio.empty ()) {
 644                 d << "_" << dm.studio;
 645         }
 646
 647         if (if_created_now) {
 648                 d << "_" << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ());
 649         } else {
 650                 d << "_" << boost::gregorian::to_iso_string (_dci_date);
 651         }
 652
 653         if (!dm.facility.empty ()) {
 654                 d << "_" << dm.facility;
 655         }
 656
 657         if (!dm.package_type.empty ()) {
 658                 d << "_" << dm.package_type;
 659         }
 660
 661         return d.str ();
 662 }
 663
 664 /** @return name to give the DCP */
 665 string
 666 Film::dcp_name (bool if_created_now) const
 667 {
 668         if (use_dci_name()) {
 669                 return dci_name (if_created_now);
 670         }
 671
 672         return name();
 673 }
 674
 675
 676 void
 677 Film::set_directory (string d)
 678 {
 679         boost::mutex::scoped_lock lm (_state_mutex);
 680         _directory = d;
 681         _dirty = true;
 682 }
 683
 684 void
 685 Film::set_name (string n)
 686 {
 687         {
 688                 boost::mutex::scoped_lock lm (_state_mutex);
 689                 _name = n;
 690         }
 691         signal_changed (NAME);
 692 }
 693
 694 void
 695 Film::set_use_dci_name (bool u)
 696 {
 697         {
 698                 boost::mutex::scoped_lock lm (_state_mutex);
 699                 _use_dci_name = u;
 700         }
 701         signal_changed (USE_DCI_NAME);
 702 }
 703
 704 void
 705 Film::set_trust_content_headers (bool t)
 706 {
 707         {
 708                 boost::mutex::scoped_lock lm (_state_mutex);
 709                 _trust_content_headers = t;
 710         }
 711
 712         signal_changed (TRUST_CONTENT_HEADERS);
 713
 714         if (!_trust_content_headers && !content().empty()) {
 715                 /* We just said that we don't trust the content's header */
 716                 ContentList c = content ();
 717                 for (ContentList::iterator i = c.begin(); i != c.end(); ++i) {
 718                         examine_content (*i);
 719                 }
 720         }
 721 }
 722
 723 void
 724 Film::set_dcp_content_type (DCPContentType const * t)
 725 {
 726         {
 727                 boost::mutex::scoped_lock lm (_state_mutex);
 728                 _dcp_content_type = t;
 729         }
 730         signal_changed (DCP_CONTENT_TYPE);
 731 }
 732
 733 void
 734 Film::set_format (Format const * f)
 735 {
 736         {
 737                 boost::mutex::scoped_lock lm (_state_mutex);
 738                 _format = f;
 739         }
 740         signal_changed (FORMAT);
 741 }
 742
 743 void
 744 Film::set_crop (Crop c)
 745 {
 746         {
 747                 boost::mutex::scoped_lock lm (_state_mutex);
 748                 _crop = c;
 749         }
 750         signal_changed (CROP);
 751 }
 752
 753 void
 754 Film::set_left_crop (int c)
 755 {
 756         {
 757                 boost::mutex::scoped_lock lm (_state_mutex);
 758
 759                 if (_crop.left == c) {
 760                         return;
 761                 }
 762
 763                 _crop.left = c;
 764         }
 765         signal_changed (CROP);
 766 }
 767
 768 void
 769 Film::set_right_crop (int c)
 770 {
 771         {
 772                 boost::mutex::scoped_lock lm (_state_mutex);
 773                 if (_crop.right == c) {
 774                         return;
 775                 }
 776
 777                 _crop.right = c;
 778         }
 779         signal_changed (CROP);
 780 }
 781
 782 void
 783 Film::set_top_crop (int c)
 784 {
 785         {
 786                 boost::mutex::scoped_lock lm (_state_mutex);
 787                 if (_crop.top == c) {
 788                         return;
 789                 }
 790
 791                 _crop.top = c;
 792         }
 793         signal_changed (CROP);
 794 }
 795
 796 void
 797 Film::set_bottom_crop (int c)
 798 {
 799         {
 800                 boost::mutex::scoped_lock lm (_state_mutex);
 801                 if (_crop.bottom == c) {
 802                         return;
 803                 }
 804
 805                 _crop.bottom = c;
 806         }
 807         signal_changed (CROP);
 808 }
 809
 810 void
 811 Film::set_filters (vector<Filter const *> f)
 812 {
 813         {
 814                 boost::mutex::scoped_lock lm (_state_mutex);
 815                 _filters = f;
 816         }
 817         signal_changed (FILTERS);
 818 }
 819
 820 void
 821 Film::set_scaler (Scaler const * s)
 822 {
 823         {
 824                 boost::mutex::scoped_lock lm (_state_mutex);
 825                 _scaler = s;
 826         }
 827         signal_changed (SCALER);
 828 }
 829
 830 void
 831 Film::set_trim_start (int t)
 832 {
 833         {
 834                 boost::mutex::scoped_lock lm (_state_mutex);
 835                 _trim_start = t;
 836         }
 837         signal_changed (TRIM_START);
 838 }
 839
 840 void
 841 Film::set_trim_end (int t)
 842 {
 843         {
 844                 boost::mutex::scoped_lock lm (_state_mutex);
 845                 _trim_end = t;
 846         }
 847         signal_changed (TRIM_END);
 848 }
 849
 850 void
 851 Film::set_ab (bool a)
 852 {
 853         {
 854                 boost::mutex::scoped_lock lm (_state_mutex);
 855                 _ab = a;
 856         }
 857         signal_changed (AB);
 858 }
 859
 860 void
 861 Film::set_audio_gain (float g)
 862 {
 863         {
 864                 boost::mutex::scoped_lock lm (_state_mutex);
 865                 _audio_gain = g;
 866         }
 867         signal_changed (AUDIO_GAIN);
 868 }
 869
 870 void
 871 Film::set_audio_delay (int d)
 872 {
 873         {
 874                 boost::mutex::scoped_lock lm (_state_mutex);
 875                 _audio_delay = d;
 876         }
 877         signal_changed (AUDIO_DELAY);
 878 }
 879
 880 void
 881 Film::set_with_subtitles (bool w)
 882 {
 883         {
 884                 boost::mutex::scoped_lock lm (_state_mutex);
 885                 _with_subtitles = w;
 886         }
 887         signal_changed (WITH_SUBTITLES);
 888 }
 889
 890 void
 891 Film::set_subtitle_offset (int o)
 892 {
 893         {
 894                 boost::mutex::scoped_lock lm (_state_mutex);
 895                 _subtitle_offset = o;
 896         }
 897         signal_changed (SUBTITLE_OFFSET);
 898 }
 899
 900 void
 901 Film::set_subtitle_scale (float s)
 902 {
 903         {
 904                 boost::mutex::scoped_lock lm (_state_mutex);
 905                 _subtitle_scale = s;
 906         }
 907         signal_changed (SUBTITLE_SCALE);
 908 }
 909
 910 void
 911 Film::set_colour_lut (int i)
 912 {
 913         {
 914                 boost::mutex::scoped_lock lm (_state_mutex);
 915                 _colour_lut = i;
 916         }
 917         signal_changed (COLOUR_LUT);
 918 }
 919
 920 void
 921 Film::set_j2k_bandwidth (int b)
 922 {
 923         {
 924                 boost::mutex::scoped_lock lm (_state_mutex);
 925                 _j2k_bandwidth = b;
 926         }
 927         signal_changed (J2K_BANDWIDTH);
 928 }
 929
 930 void
 931 Film::set_dci_metadata (DCIMetadata m)
 932 {
 933         {
 934                 boost::mutex::scoped_lock lm (_state_mutex);
 935                 _dci_metadata = m;
 936         }
 937         signal_changed (DCI_METADATA);
 938 }
 939
 940
 941 void
 942 Film::set_dcp_frame_rate (int f)
 943 {
 944         {
 945                 boost::mutex::scoped_lock lm (_state_mutex);
 946                 _dcp_frame_rate = f;
 947         }
 948         signal_changed (DCP_FRAME_RATE);
 949 }
 950
 951 void
 952 Film::signal_changed (Property p)
 953 {
 954         {
 955                 boost::mutex::scoped_lock lm (_state_mutex);
 956                 _dirty = true;
 957         }
 958
 959         switch (p) {
 960         case Film::CONTENT:
 961                 _playlist->setup (content ());
 962                 set_dcp_frame_rate (best_dcp_frame_rate (video_frame_rate ()));
 963                 set_audio_mapping (_playlist->default_audio_mapping ());
 964                 break;
 965         default:
 966                 break;
 967         }
 968
 969         if (ui_signaller) {
 970                 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
 971         }
 972 }
 973
 974 void
 975 Film::set_dci_date_today ()
 976 {
 977         _dci_date = boost::gregorian::day_clock::local_day ();
 978 }
 979
 980 string
 981 Film::info_path (int f) const
 982 {
 983         boost::filesystem::path p;
 984         p /= info_dir ();
 985
 986         stringstream s;
 987         s.width (8);
 988         s << setfill('0') << f << ".md5";
 989
 990         p /= s.str();
 991
 992         /* info_dir() will already have added any initial bit of the path,
 993            so don't call file() on this.
 994         */
 995         return p.string ();
 996 }
 997
 998 string
 999 Film::j2c_path (int f, bool t) const
1000 {
1001         boost::filesystem::path p;
1002         p /= "j2c";
1003         p /= video_state_identifier ();
1004
1005         stringstream s;
1006         s.width (8);
1007         s << setfill('0') << f << ".j2c";
1008
1009         if (t) {
1010                 s << ".tmp";
1011         }
1012
1013         p /= s.str();
1014         return file (p.string ());
1015 }
1016
1017 /** Make an educated guess as to whether we have a complete DCP
1018  *  or not.
1019  *  @return true if we do.
1020  */
1021
1022 bool
1023 Film::have_dcp () const
1024 {
1025         try {
1026                 libdcp::DCP dcp (dir (dcp_name()));
1027                 dcp.read ();
1028         } catch (...) {
1029                 return false;
1030         }
1031
1032         return true;
1033 }
1034
1035 shared_ptr<Player>
1036 Film::player () const
1037 {
1038         boost::mutex::scoped_lock lm (_state_mutex);
1039         return shared_ptr<Player> (new Player (shared_from_this (), _playlist));
1040 }
1041
1042 void
1043 Film::add_content (shared_ptr<Content> c)
1044 {
1045         {
1046                 boost::mutex::scoped_lock lm (_state_mutex);
1047                 _content.push_back (c);
1048         }
1049
1050         signal_changed (CONTENT);
1051
1052         examine_content (c);
1053 }
1054
1055 void
1056 Film::remove_content (shared_ptr<Content> c)
1057 {
1058         {
1059                 boost::mutex::scoped_lock lm (_state_mutex);
1060                 ContentList::iterator i = find (_content.begin(), _content.end(), c);
1061                 if (i != _content.end ()) {
1062                         _content.erase (i);
1063                 }
1064         }
1065
1066         signal_changed (CONTENT);
1067 }
1068
1069 void
1070 Film::move_content_earlier (shared_ptr<Content> c)
1071 {
1072         {
1073                 boost::mutex::scoped_lock lm (_state_mutex);
1074                 ContentList::iterator i = find (_content.begin(), _content.end(), c);
1075                 if (i == _content.begin () || i == _content.end()) {
1076                         return;
1077                 }
1078
1079                 ContentList::iterator j = i;
1080                 --j;
1081
1082                 swap (*i, *j);
1083                 _playlist->setup (_content);
1084         }
1085
1086         signal_changed (CONTENT);
1087 }
1088
1089 void
1090 Film::move_content_later (shared_ptr<Content> c)
1091 {
1092         {
1093                 boost::mutex::scoped_lock lm (_state_mutex);
1094                 ContentList::iterator i = find (_content.begin(), _content.end(), c);
1095                 if (i == _content.end()) {
1096                         return;
1097                 }
1098
1099                 ContentList::iterator j = i;
1100                 ++j;
1101                 if (j == _content.end ()) {
1102                         return;
1103                 }
1104
1105                 swap (*i, *j);
1106                 _playlist->setup (_content);
1107         }
1108
1109         signal_changed (CONTENT);
1110
1111 }
1112
1113 ContentAudioFrame
1114 Film::audio_length () const
1115 {
1116         return _playlist->audio_length ();
1117 }
1118
1119 int
1120 Film::audio_channels () const
1121 {
1122         return _playlist->audio_channels ();
1123 }
1124
1125 int
1126 Film::audio_frame_rate () const
1127 {
1128         return _playlist->audio_frame_rate ();
1129 }
1130
1131 int64_t
1132 Film::audio_channel_layout () const
1133 {
1134         return _playlist->audio_channel_layout ();
1135 }
1136
1137 bool
1138 Film::has_audio () const
1139 {
1140         return _playlist->has_audio ();
1141 }
1142
1143 float
1144 Film::video_frame_rate () const
1145 {
1146         return _playlist->video_frame_rate ();
1147 }
1148
1149 libdcp::Size
1150 Film::video_size () const
1151 {
1152         return _playlist->video_size ();
1153 }
1154
1155 ContentVideoFrame
1156 Film::video_length () const
1157 {
1158         return _playlist->video_length ();
1159 }
1160
1161 /** Unfortunately this is needed as the GUI has FFmpeg-specific controls */
1162 shared_ptr<FFmpegContent>
1163 Film::ffmpeg () const
1164 {
1165         boost::mutex::scoped_lock lm (_state_mutex);
1166
1167         for (ContentList::const_iterator i = _content.begin (); i != _content.end(); ++i) {
1168                 shared_ptr<FFmpegContent> f = boost::dynamic_pointer_cast<FFmpegContent> (*i);
1169                 if (f) {
1170                         return f;
1171                 }
1172         }
1173
1174         return shared_ptr<FFmpegContent> ();
1175 }
1176
1177 vector<FFmpegSubtitleStream>
1178 Film::ffmpeg_subtitle_streams () const
1179 {
1180         shared_ptr<FFmpegContent> f = ffmpeg ();
1181         if (f) {
1182                 return f->subtitle_streams ();
1183         }
1184
1185         return vector<FFmpegSubtitleStream> ();
1186 }
1187
1188 boost::optional<FFmpegSubtitleStream>
1189 Film::ffmpeg_subtitle_stream () const
1190 {
1191         shared_ptr<FFmpegContent> f = ffmpeg ();
1192         if (f) {
1193                 return f->subtitle_stream ();
1194         }
1195
1196         return boost::none;
1197 }
1198
1199 vector<FFmpegAudioStream>
1200 Film::ffmpeg_audio_streams () const
1201 {
1202         shared_ptr<FFmpegContent> f = ffmpeg ();
1203         if (f) {
1204                 return f->audio_streams ();
1205         }
1206
1207         return vector<FFmpegAudioStream> ();
1208 }
1209
1210 boost::optional<FFmpegAudioStream>
1211 Film::ffmpeg_audio_stream () const
1212 {
1213         shared_ptr<FFmpegContent> f = ffmpeg ();
1214         if (f) {
1215                 return f->audio_stream ();
1216         }
1217
1218         return boost::none;
1219 }
1220
1221 void
1222 Film::set_ffmpeg_subtitle_stream (FFmpegSubtitleStream s)
1223 {
1224         shared_ptr<FFmpegContent> f = ffmpeg ();
1225         if (f) {
1226                 f->set_subtitle_stream (s);
1227         }
1228 }
1229
1230 void
1231 Film::set_ffmpeg_audio_stream (FFmpegAudioStream s)
1232 {
1233         shared_ptr<FFmpegContent> f = ffmpeg ();
1234         if (f) {
1235                 f->set_audio_stream (s);
1236         }
1237 }
1238
1239 void
1240 Film::set_audio_mapping (AudioMapping m)
1241 {
1242         {
1243                 boost::mutex::scoped_lock lm (_state_mutex);
1244                 _audio_mapping = m;
1245         }
1246
1247         signal_changed (AUDIO_MAPPING);
1248 }
1249
1250 void
1251 Film::content_changed (boost::weak_ptr<Content> c, int p)
1252 {
1253         if (p == VideoContentProperty::VIDEO_FRAME_RATE) {
1254                 set_dcp_frame_rate (best_dcp_frame_rate (video_frame_rate ()));
1255         } else if (p == AudioContentProperty::AUDIO_CHANNELS) {
1256                 set_audio_mapping (_playlist->default_audio_mapping ());
1257         }
1258
1259         if (ui_signaller) {
1260                 ui_signaller->emit (boost::bind (boost::ref (ContentChanged), c, p));
1261         }
1262 }