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