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 "film.h"
  33 #include "format.h"
  34 #include "job.h"
  35 #include "filter.h"
  36 #include "transcoder.h"
  37 #include "util.h"
  38 #include "job_manager.h"
  39 #include "ab_transcode_job.h"
  40 #include "transcode_job.h"
  41 #include "scp_dcp_job.h"
  42 #include "log.h"
  43 #include "options.h"
  44 #include "exceptions.h"
  45 #include "examine_content_job.h"
  46 #include "scaler.h"
  47 #include "decoder_factory.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 "external_audio_decoder.h"
  54
  55 #include "i18n.h"
  56
  57 using std::string;
  58 using std::stringstream;
  59 using std::multimap;
  60 using std::pair;
  61 using std::map;
  62 using std::vector;
  63 using std::ifstream;
  64 using std::ofstream;
  65 using std::setfill;
  66 using std::min;
  67 using std::make_pair;
  68 using boost::shared_ptr;
  69 using boost::lexical_cast;
  70 using boost::to_upper_copy;
  71 using boost::ends_with;
  72 using boost::starts_with;
  73 using boost::optional;
  74 using libdcp::Size;
  75
  76 int const Film::state_version = 3;
  77
  78 /** Construct a Film object in a given directory, reading any metadata
  79  *  file that exists in that directory.  An exception will be thrown if
  80  *  must_exist is true and the specified directory does not exist.
  81  *
  82  *  @param d Film directory.
  83  *  @param must_exist true to throw an exception if does not exist.
  84  */
  85
  86 Film::Film (string d, bool must_exist)
  87         : _use_dci_name (true)
  88         , _trust_content_header (true)
  89         , _dcp_content_type (0)
  90         , _format (0)
  91         , _scaler (Scaler::from_id ("bicubic"))
  92         , _trim_start (0)
  93         , _trim_end (0)
  94         , _dcp_ab (false)
  95         , _use_content_audio (true)
  96         , _audio_gain (0)
  97         , _audio_delay (0)
  98         , _still_duration (10)
  99         , _with_subtitles (false)
 100         , _subtitle_offset (0)
 101         , _subtitle_scale (1)
 102         , _colour_lut (0)
 103         , _j2k_bandwidth (200000000)
 104         , _dci_metadata (Config::instance()->default_dci_metadata ())
 105         , _frames_per_second (0)
 106         , _dirty (false)
 107 {
 108         set_dci_date_today ();
 109
 110         /* Make state.directory a complete path without ..s (where possible)
 111            (Code swiped from Adam Bowen on stackoverflow)
 112         */
 113
 114         boost::filesystem::path p (boost::filesystem::system_complete (d));
 115         boost::filesystem::path result;
 116         for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
 117                 if (*i == "..") {
 118                         if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
 119                                 result /= *i;
 120                         } else {
 121                                 result = result.parent_path ();
 122                         }
 123                 } else if (*i != ".") {
 124                         result /= *i;
 125                 }
 126         }
 127
 128         set_directory (result.string ());
 129
 130         if (!boost::filesystem::exists (directory())) {
 131                 if (must_exist) {
 132                         throw OpenFileError (directory());
 133                 } else {
 134                         boost::filesystem::create_directory (directory());
 135                 }
 136         }
 137
 138         _external_audio_stream = ExternalAudioStream::create ();
 139
 140         if (must_exist) {
 141                 read_metadata ();
 142         }
 143
 144         _log = new FileLog (file ("log"));
 145 }
 146
 147 Film::Film (Film const & o)
 148         : boost::enable_shared_from_this<Film> (o)
 149         , _log (0)
 150         , _directory         (o._directory)
 151         , _name              (o._name)
 152         , _use_dci_name      (o._use_dci_name)
 153         , _content           (o._content)
 154         , _trust_content_header (o._trust_content_header)
 155         , _dcp_content_type  (o._dcp_content_type)
 156         , _format            (o._format)
 157         , _crop              (o._crop)
 158         , _filters           (o._filters)
 159         , _scaler            (o._scaler)
 160         , _trim_start        (o._trim_start)
 161         , _trim_end          (o._trim_end)
 162         , _dcp_ab            (o._dcp_ab)
 163         , _content_audio_stream (o._content_audio_stream)
 164         , _external_audio    (o._external_audio)
 165         , _use_content_audio (o._use_content_audio)
 166         , _audio_gain        (o._audio_gain)
 167         , _audio_delay       (o._audio_delay)
 168         , _still_duration    (o._still_duration)
 169         , _subtitle_stream   (o._subtitle_stream)
 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         , _dci_date          (o._dci_date)
 177         , _size              (o._size)
 178         , _length            (o._length)
 179         , _dcp_intrinsic_duration (o._dcp_intrinsic_duration)
 180         , _content_digest    (o._content_digest)
 181         , _content_audio_streams (o._content_audio_streams)
 182         , _external_audio_stream (o._external_audio_stream)
 183         , _subtitle_streams  (o._subtitle_streams)
 184         , _frames_per_second (o._frames_per_second)
 185         , _dirty             (o._dirty)
 186 {
 187
 188 }
 189
 190 Film::~Film ()
 191 {
 192         delete _log;
 193 }
 194
 195 string
 196 Film::video_state_identifier () const
 197 {
 198         assert (format ());
 199
 200         pair<string, string> f = Filter::ffmpeg_strings (filters());
 201
 202         stringstream s;
 203         s << format()->id()
 204           << "_" << content_digest()
 205           << "_" << crop().left << "_" << crop().right << "_" << crop().top << "_" << crop().bottom
 206           << "_" << f.first << "_" << f.second
 207           << "_" << scaler()->id()
 208           << "_" << j2k_bandwidth()
 209           << "_" << boost::lexical_cast<int> (colour_lut());
 210
 211         if (dcp_ab()) {
 212                 pair<string, string> fa = Filter::ffmpeg_strings (Config::instance()->reference_filters());
 213                 s << "ab_" << Config::instance()->reference_scaler()->id() << "_" << fa.first << "_" << fa.second;
 214         }
 215
 216         return s.str ();
 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 /** Add suitable Jobs to the JobManager to create a DCP for this Film */
 243 void
 244 Film::make_dcp ()
 245 {
 246         set_dci_date_today ();
 247
 248         if (dcp_name().find ("/") != string::npos) {
 249                 throw BadSettingError ("name", _("cannot contain slashes"));
 250         }
 251
 252         log()->log (String::compose ("DVD-o-matic %1 git %2 using %3", dvdomatic_version, dvdomatic_git_commit, dependency_version_summary()));
 253
 254         {
 255                 char buffer[128];
 256                 gethostname (buffer, sizeof (buffer));
 257                 log()->log (String::compose ("Starting to make DCP on %1", buffer));
 258         }
 259
 260         log()->log (String::compose ("Content is %1; type %2", content_path(), (content_type() == STILL ? "still" : "video")));
 261         if (length()) {
 262                 log()->log (String::compose ("Content length %1", length().get()));
 263         }
 264         log()->log (String::compose ("Content digest %1", content_digest()));
 265         log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
 266         log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
 267 #ifdef DVDOMATIC_DEBUG
 268         log()->log ("DVD-o-matic built in debug mode.");
 269 #else
 270         log()->log ("DVD-o-matic built in optimised mode.");
 271 #endif
 272 #ifdef LIBDCP_DEBUG
 273         log()->log ("libdcp built in debug mode.");
 274 #else
 275         log()->log ("libdcp built in optimised mode.");
 276 #endif
 277         pair<string, int> const c = cpu_info ();
 278         log()->log (String::compose ("CPU: %1, %2 processors", c.first, c.second));
 279
 280         if (format() == 0) {
 281                 throw MissingSettingError ("format");
 282         }
 283
 284         if (content().empty ()) {
 285                 throw MissingSettingError ("content");
 286         }
 287
 288         if (dcp_content_type() == 0) {
 289                 throw MissingSettingError ("content type");
 290         }
 291
 292         if (name().empty()) {
 293                 throw MissingSettingError ("name");
 294         }
 295
 296         DecodeOptions od;
 297         od.decode_subtitles = with_subtitles ();
 298
 299         shared_ptr<Job> r;
 300
 301         if (dcp_ab()) {
 302                 r = JobManager::instance()->add (shared_ptr<Job> (new ABTranscodeJob (shared_from_this(), od)));
 303         } else {
 304                 r = JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this(), od)));
 305         }
 306 }
 307
 308 /** Start a job to examine our content file */
 309 void
 310 Film::examine_content ()
 311 {
 312         if (_examine_content_job) {
 313                 return;
 314         }
 315
 316         _examine_content_job.reset (new ExamineContentJob (shared_from_this()));
 317         _examine_content_job->Finished.connect (bind (&Film::examine_content_finished, this));
 318         JobManager::instance()->add (_examine_content_job);
 319 }
 320
 321 void
 322 Film::examine_content_finished ()
 323 {
 324         _examine_content_job.reset ();
 325 }
 326
 327 /** Start a job to send our DCP to the configured TMS */
 328 void
 329 Film::send_dcp_to_tms ()
 330 {
 331         shared_ptr<Job> j (new SCPDCPJob (shared_from_this()));
 332         JobManager::instance()->add (j);
 333 }
 334
 335 /** Count the number of frames that have been encoded for this film.
 336  *  @return frame count.
 337  */
 338 int
 339 Film::encoded_frames () const
 340 {
 341         if (format() == 0) {
 342                 return 0;
 343         }
 344
 345         int N = 0;
 346         for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (info_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
 347                 ++N;
 348                 boost::this_thread::interruption_point ();
 349         }
 350
 351         return N;
 352 }
 353
 354 /** Write state to our `metadata' file */
 355 void
 356 Film::write_metadata () const
 357 {
 358         boost::mutex::scoped_lock lm (_state_mutex);
 359
 360         boost::filesystem::create_directories (directory());
 361
 362         string const m = file ("metadata");
 363         ofstream f (m.c_str ());
 364         if (!f.good ()) {
 365                 throw CreateFileError (m);
 366         }
 367
 368         f << "version " << state_version << "\n";
 369
 370         /* User stuff */
 371         f << "name " << _name << "\n";
 372         f << "use_dci_name " << _use_dci_name << "\n";
 373         f << "content " << _content << "\n";
 374         f << "trust_content_header " << (_trust_content_header ? "1" : "0") << "\n";
 375         if (_dcp_content_type) {
 376                 f << "dcp_content_type " << _dcp_content_type->dci_name () << "\n";
 377         }
 378         if (_format) {
 379                 f << "format " << _format->as_metadata () << "\n";
 380         }
 381         f << "left_crop " << _crop.left << "\n";
 382         f << "right_crop " << _crop.right << "\n";
 383         f << "top_crop " << _crop.top << "\n";
 384         f << "bottom_crop " << _crop.bottom << "\n";
 385         for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
 386                 f << "filter " << (*i)->id () << "\n";
 387         }
 388         f << "scaler " << _scaler->id () << "\n";
 389         f << "trim_start " << _trim_start << "\n";
 390         f << "trim_end " << _trim_end << "\n";
 391         f << "dcp_ab " << (_dcp_ab ? "1" : "0") << "\n";
 392         if (_content_audio_stream) {
 393                 f << "selected_content_audio_stream " << _content_audio_stream->to_string() << "\n";
 394         }
 395         for (vector<string>::const_iterator i = _external_audio.begin(); i != _external_audio.end(); ++i) {
 396                 f << "external_audio " << *i << "\n";
 397         }
 398         f << "use_content_audio " << (_use_content_audio ? "1" : "0") << "\n";
 399         f << "audio_gain " << _audio_gain << "\n";
 400         f << "audio_delay " << _audio_delay << "\n";
 401         f << "still_duration " << _still_duration << "\n";
 402         if (_subtitle_stream) {
 403                 f << "selected_subtitle_stream " << _subtitle_stream->to_string() << "\n";
 404         }
 405         f << "with_subtitles " << _with_subtitles << "\n";
 406         f << "subtitle_offset " << _subtitle_offset << "\n";
 407         f << "subtitle_scale " << _subtitle_scale << "\n";
 408         f << "colour_lut " << _colour_lut << "\n";
 409         f << "j2k_bandwidth " << _j2k_bandwidth << "\n";
 410         _dci_metadata.write (f);
 411         f << "dci_date " << boost::gregorian::to_iso_string (_dci_date) << "\n";
 412         f << "width " << _size.width << "\n";
 413         f << "height " << _size.height << "\n";
 414         f << "length " << _length.get_value_or(0) << "\n";
 415         f << "dcp_intrinsic_duration " << _dcp_intrinsic_duration.get_value_or(0) << "\n";
 416         f << "content_digest " << _content_digest << "\n";
 417
 418         for (vector<shared_ptr<AudioStream> >::const_iterator i = _content_audio_streams.begin(); i != _content_audio_streams.end(); ++i) {
 419                 f << "content_audio_stream " << (*i)->to_string () << "\n";
 420         }
 421
 422         f << "external_audio_stream " << _external_audio_stream->to_string() << "\n";
 423
 424         for (vector<shared_ptr<SubtitleStream> >::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
 425                 f << "subtitle_stream " << (*i)->to_string () << "\n";
 426         }
 427
 428         f << "frames_per_second " << _frames_per_second << "\n";
 429
 430         _dirty = false;
 431 }
 432
 433 /** Read state from our metadata file */
 434 void
 435 Film::read_metadata ()
 436 {
 437         boost::mutex::scoped_lock lm (_state_mutex);
 438
 439         _external_audio.clear ();
 440         _content_audio_streams.clear ();
 441         _subtitle_streams.clear ();
 442
 443         boost::optional<int> version;
 444
 445         /* Backward compatibility things */
 446         boost::optional<int> audio_sample_rate;
 447         boost::optional<int> audio_stream_index;
 448         boost::optional<int> subtitle_stream_index;
 449
 450         ifstream f (file ("metadata").c_str());
 451         if (!f.good()) {
 452                 throw OpenFileError (file ("metadata"));
 453         }
 454
 455         multimap<string, string> kv = read_key_value (f);
 456
 457         /* We need version before anything else */
 458         multimap<string, string>::iterator v = kv.find ("version");
 459         if (v != kv.end ()) {
 460                 version = atoi (v->second.c_str());
 461         }
 462
 463         for (multimap<string, string>::const_iterator i = kv.begin(); i != kv.end(); ++i) {
 464                 string const k = i->first;
 465                 string const v = i->second;
 466
 467                 if (k == "audio_sample_rate") {
 468                         audio_sample_rate = atoi (v.c_str());
 469                 }
 470
 471                 /* User-specified stuff */
 472                 if (k == "name") {
 473                         _name = v;
 474                 } else if (k == "use_dci_name") {
 475                         _use_dci_name = (v == "1");
 476                 } else if (k == "content") {
 477                         _content = v;
 478                 } else if (k == "trust_content_header") {
 479                         _trust_content_header = (v == "1");
 480                 } else if (k == "dcp_content_type") {
 481                         if (version < 3) {
 482                                 _dcp_content_type = DCPContentType::from_pretty_name (v);
 483                         } else {
 484                                 _dcp_content_type = DCPContentType::from_dci_name (v);
 485                         }
 486                 } else if (k == "format") {
 487                         _format = Format::from_metadata (v);
 488                 } else if (k == "left_crop") {
 489                         _crop.left = atoi (v.c_str ());
 490                 } else if (k == "right_crop") {
 491                         _crop.right = atoi (v.c_str ());
 492                 } else if (k == "top_crop") {
 493                         _crop.top = atoi (v.c_str ());
 494                 } else if (k == "bottom_crop") {
 495                         _crop.bottom = atoi (v.c_str ());
 496                 } else if (k == "filter") {
 497                         _filters.push_back (Filter::from_id (v));
 498                 } else if (k == "scaler") {
 499                         _scaler = Scaler::from_id (v);
 500                 } else if ( ((!version || version < 2) && k == "dcp_trim_start") || k == "trim_start") {
 501                         _trim_start = atoi (v.c_str ());
 502                 } else if ( ((!version || version < 2) && k == "dcp_trim_end") || k == "trim_end") {
 503                         _trim_end = atoi (v.c_str ());
 504                 } else if (k == "dcp_ab") {
 505                         _dcp_ab = (v == "1");
 506                 } else if (k == "selected_content_audio_stream" || (!version && k == "selected_audio_stream")) {
 507                         if (!version) {
 508                                 audio_stream_index = atoi (v.c_str ());
 509                         } else {
 510                                 _content_audio_stream = audio_stream_factory (v, version);
 511                         }
 512                 } else if (k == "external_audio") {
 513                         _external_audio.push_back (v);
 514                 } else if (k == "use_content_audio") {
 515                         _use_content_audio = (v == "1");
 516                 } else if (k == "audio_gain") {
 517                         _audio_gain = atof (v.c_str ());
 518                 } else if (k == "audio_delay") {
 519                         _audio_delay = atoi (v.c_str ());
 520                 } else if (k == "still_duration") {
 521                         _still_duration = atoi (v.c_str ());
 522                 } else if (k == "selected_subtitle_stream") {
 523                         if (!version) {
 524                                 subtitle_stream_index = atoi (v.c_str ());
 525                         } else {
 526                                 _subtitle_stream = subtitle_stream_factory (v, version);
 527                         }
 528                 } else if (k == "with_subtitles") {
 529                         _with_subtitles = (v == "1");
 530                 } else if (k == "subtitle_offset") {
 531                         _subtitle_offset = atoi (v.c_str ());
 532                 } else if (k == "subtitle_scale") {
 533                         _subtitle_scale = atof (v.c_str ());
 534                 } else if (k == "colour_lut") {
 535                         _colour_lut = atoi (v.c_str ());
 536                 } else if (k == "j2k_bandwidth") {
 537                         _j2k_bandwidth = atoi (v.c_str ());
 538                 } else if (k == "dci_date") {
 539                         _dci_date = boost::gregorian::from_undelimited_string (v);
 540                 }
 541
 542                 _dci_metadata.read (k, v);
 543
 544                 /* Cached stuff */
 545                 if (k == "width") {
 546                         _size.width = atoi (v.c_str ());
 547                 } else if (k == "height") {
 548                         _size.height = atoi (v.c_str ());
 549                 } else if (k == "length") {
 550                         int const vv = atoi (v.c_str ());
 551                         if (vv) {
 552                                 _length = vv;
 553                         }
 554                 } else if (k == "dcp_intrinsic_duration") {
 555                         int const vv = atoi (v.c_str ());
 556                         if (vv) {
 557                                 _dcp_intrinsic_duration = vv;
 558                         }
 559                 } else if (k == "content_digest") {
 560                         _content_digest = v;
 561                 } else if (k == "content_audio_stream" || (!version && k == "audio_stream")) {
 562                         _content_audio_streams.push_back (audio_stream_factory (v, version));
 563                 } else if (k == "external_audio_stream") {
 564                         _external_audio_stream = audio_stream_factory (v, version);
 565                 } else if (k == "subtitle_stream") {
 566                         _subtitle_streams.push_back (subtitle_stream_factory (v, version));
 567                 } else if (k == "frames_per_second") {
 568                         _frames_per_second = atof (v.c_str ());
 569                 }
 570         }
 571
 572         if (!version) {
 573                 if (audio_sample_rate) {
 574                         /* version < 1 didn't specify sample rate in the audio streams, so fill it in here */
 575                         for (vector<shared_ptr<AudioStream> >::iterator i = _content_audio_streams.begin(); i != _content_audio_streams.end(); ++i) {
 576                                 (*i)->set_sample_rate (audio_sample_rate.get());
 577                         }
 578                 }
 579
 580                 /* also the selected stream was specified as an index */
 581                 if (audio_stream_index && audio_stream_index.get() >= 0 && audio_stream_index.get() < (int) _content_audio_streams.size()) {
 582                         _content_audio_stream = _content_audio_streams[audio_stream_index.get()];
 583                 }
 584
 585                 /* similarly the subtitle */
 586                 if (subtitle_stream_index && subtitle_stream_index.get() >= 0 && subtitle_stream_index.get() < (int) _subtitle_streams.size()) {
 587                         _subtitle_stream = _subtitle_streams[subtitle_stream_index.get()];
 588                 }
 589         }
 590
 591         _dirty = false;
 592 }
 593
 594 libdcp::Size
 595 Film::cropped_size (libdcp::Size s) const
 596 {
 597         boost::mutex::scoped_lock lm (_state_mutex);
 598         s.width -= _crop.left + _crop.right;
 599         s.height -= _crop.top + _crop.bottom;
 600         return s;
 601 }
 602
 603 /** Given a directory name, return its full path within the Film's directory.
 604  *  The directory (and its parents) will be created if they do not exist.
 605  */
 606 string
 607 Film::dir (string d) const
 608 {
 609         boost::mutex::scoped_lock lm (_directory_mutex);
 610
 611         boost::filesystem::path p;
 612         p /= _directory;
 613         p /= d;
 614
 615         boost::filesystem::create_directories (p);
 616
 617         return p.string ();
 618 }
 619
 620 /** Given a file or directory name, return its full path within the Film's directory.
 621  *  _directory_mutex must not be locked on entry.
 622  *  Any required parent directories will be created.
 623  */
 624 string
 625 Film::file (string f) const
 626 {
 627         boost::mutex::scoped_lock lm (_directory_mutex);
 628
 629         boost::filesystem::path p;
 630         p /= _directory;
 631         p /= f;
 632
 633         boost::filesystem::create_directories (p.parent_path ());
 634
 635         return p.string ();
 636 }
 637
 638 /** @return full path of the content (actual video) file
 639  *  of the Film.
 640  */
 641 string
 642 Film::content_path () const
 643 {
 644         boost::mutex::scoped_lock lm (_state_mutex);
 645         if (boost::filesystem::path(_content).has_root_directory ()) {
 646                 return _content;
 647         }
 648
 649         return file (_content);
 650 }
 651
 652 ContentType
 653 Film::content_type () const
 654 {
 655         if (boost::filesystem::is_directory (_content)) {
 656                 /* Directory of images, we assume */
 657                 return VIDEO;
 658         }
 659
 660         if (still_image_file (_content)) {
 661                 return STILL;
 662         }
 663
 664         return VIDEO;
 665 }
 666
 667 /** @return The sampling rate that we will resample the audio to */
 668 int
 669 Film::target_audio_sample_rate () const
 670 {
 671         if (!audio_stream()) {
 672                 return 0;
 673         }
 674
 675         /* Resample to a DCI-approved sample rate */
 676         double t = dcp_audio_sample_rate (audio_stream()->sample_rate());
 677
 678         DCPFrameRate dfr (frames_per_second ());
 679
 680         /* Compensate if the DCP is being run at a different frame rate
 681            to the source; that is, if the video is run such that it will
 682            look different in the DCP compared to the source (slower or faster).
 683            skip/repeat doesn't come into effect here.
 684         */
 685
 686         if (dfr.change_speed) {
 687                 t *= _frames_per_second * dfr.factor() / dfr.frames_per_second;
 688         }
 689
 690         return rint (t);
 691 }
 692
 693 int
 694 Film::still_duration_in_frames () const
 695 {
 696         return still_duration() * frames_per_second();
 697 }
 698
 699 /** @return a DCI-compliant name for a DCP of this film */
 700 string
 701 Film::dci_name (bool if_created_now) const
 702 {
 703         stringstream d;
 704
 705         string fixed_name = to_upper_copy (name());
 706         for (size_t i = 0; i < fixed_name.length(); ++i) {
 707                 if (fixed_name[i] == ' ') {
 708                         fixed_name[i] = '-';
 709                 }
 710         }
 711
 712         /* Spec is that the name part should be maximum 14 characters, as I understand it */
 713         if (fixed_name.length() > 14) {
 714                 fixed_name = fixed_name.substr (0, 14);
 715         }
 716
 717         d << fixed_name << "_";
 718
 719         if (dcp_content_type()) {
 720                 d << dcp_content_type()->dci_name() << "_";
 721         }
 722
 723         if (format()) {
 724                 d << format()->dci_name() << "_";
 725         }
 726
 727         DCIMetadata const dm = dci_metadata ();
 728
 729         if (!dm.audio_language.empty ()) {
 730                 d << dm.audio_language;
 731                 if (!dm.subtitle_language.empty() && with_subtitles()) {
 732                         d << "-" << dm.subtitle_language;
 733                 } else {
 734                         d << "-XX";
 735                 }
 736
 737                 d << "_";
 738         }
 739
 740         if (!dm.territory.empty ()) {
 741                 d << dm.territory;
 742                 if (!dm.rating.empty ()) {
 743                         d << "-" << dm.rating;
 744                 }
 745                 d << "_";
 746         }
 747
 748         switch (audio_channels()) {
 749         case 1:
 750                 d << "10_";
 751                 break;
 752         case 2:
 753                 d << "20_";
 754                 break;
 755         case 6:
 756                 d << "51_";
 757                 break;
 758         case 8:
 759                 d << "71_";
 760                 break;
 761         }
 762
 763         d << "2K_";
 764
 765         if (!dm.studio.empty ()) {
 766                 d << dm.studio << "_";
 767         }
 768
 769         if (if_created_now) {
 770                 d << boost::gregorian::to_iso_string (boost::gregorian::day_clock::local_day ()) << "_";
 771         } else {
 772                 d << boost::gregorian::to_iso_string (_dci_date) << "_";
 773         }
 774
 775         if (!dm.facility.empty ()) {
 776                 d << dm.facility << "_";
 777         }
 778
 779         if (!dm.package_type.empty ()) {
 780                 d << dm.package_type;
 781         }
 782
 783         return d.str ();
 784 }
 785
 786 /** @return name to give the DCP */
 787 string
 788 Film::dcp_name (bool if_created_now) const
 789 {
 790         if (use_dci_name()) {
 791                 return dci_name (if_created_now);
 792         }
 793
 794         return name();
 795 }
 796
 797
 798 void
 799 Film::set_directory (string d)
 800 {
 801         boost::mutex::scoped_lock lm (_state_mutex);
 802         _directory = d;
 803         _dirty = true;
 804 }
 805
 806 void
 807 Film::set_name (string n)
 808 {
 809         {
 810                 boost::mutex::scoped_lock lm (_state_mutex);
 811                 _name = n;
 812         }
 813         signal_changed (NAME);
 814 }
 815
 816 void
 817 Film::set_use_dci_name (bool u)
 818 {
 819         {
 820                 boost::mutex::scoped_lock lm (_state_mutex);
 821                 _use_dci_name = u;
 822         }
 823         signal_changed (USE_DCI_NAME);
 824 }
 825
 826 void
 827 Film::set_content (string c)
 828 {
 829         string check = directory ();
 830
 831         boost::filesystem::path slash ("/");
 832         string platform_slash = slash.make_preferred().string ();
 833
 834         if (!ends_with (check, platform_slash)) {
 835                 check += platform_slash;
 836         }
 837
 838         if (boost::filesystem::path(c).has_root_directory () && starts_with (c, check)) {
 839                 c = c.substr (_directory.length() + 1);
 840         }
 841
 842         string old_content;
 843
 844         {
 845                 boost::mutex::scoped_lock lm (_state_mutex);
 846                 if (c == _content) {
 847                         return;
 848                 }
 849
 850                 old_content = _content;
 851                 _content = c;
 852         }
 853
 854         /* Reset streams here in case the new content doesn't have one or the other */
 855         _content_audio_stream = shared_ptr<AudioStream> ();
 856         _subtitle_stream = shared_ptr<SubtitleStream> ();
 857
 858         /* Start off using content audio */
 859         set_use_content_audio (true);
 860
 861         /* Create a temporary decoder so that we can get information
 862            about the content.
 863         */
 864
 865         try {
 866                 Decoders d = decoder_factory (shared_from_this(), DecodeOptions());
 867
 868                 set_size (d.video->native_size ());
 869                 set_frames_per_second (d.video->frames_per_second ());
 870                 set_subtitle_streams (d.video->subtitle_streams ());
 871                 if (d.audio) {
 872                         set_content_audio_streams (d.audio->audio_streams ());
 873                 }
 874
 875                 /* Start off with the first audio and subtitle streams */
 876                 if (d.audio && !d.audio->audio_streams().empty()) {
 877                         set_content_audio_stream (d.audio->audio_streams().front());
 878                 }
 879
 880                 if (!d.video->subtitle_streams().empty()) {
 881                         set_subtitle_stream (d.video->subtitle_streams().front());
 882                 }
 883
 884                 {
 885                         boost::mutex::scoped_lock lm (_state_mutex);
 886                         _content = c;
 887                 }
 888
 889                 signal_changed (CONTENT);
 890
 891                 examine_content ();
 892
 893         } catch (...) {
 894
 895                 boost::mutex::scoped_lock lm (_state_mutex);
 896                 _content = old_content;
 897                 throw;
 898
 899         }
 900
 901         /* Default format */
 902         switch (content_type()) {
 903         case STILL:
 904                 set_format (Format::from_id ("var-185"));
 905                 break;
 906         case VIDEO:
 907                 set_format (Format::from_id ("185"));
 908                 break;
 909         }
 910
 911         /* Still image DCPs must use external audio */
 912         if (content_type() == STILL) {
 913                 set_use_content_audio (false);
 914         }
 915 }
 916
 917 void
 918 Film::set_trust_content_header (bool t)
 919 {
 920         {
 921                 boost::mutex::scoped_lock lm (_state_mutex);
 922                 _trust_content_header = t;
 923         }
 924
 925         signal_changed (TRUST_CONTENT_HEADER);
 926
 927         if (!_trust_content_header && !content().empty()) {
 928                 /* We just said that we don't trust the content's header */
 929                 examine_content ();
 930         }
 931 }
 932
 933 void
 934 Film::set_dcp_content_type (DCPContentType const * t)
 935 {
 936         {
 937                 boost::mutex::scoped_lock lm (_state_mutex);
 938                 _dcp_content_type = t;
 939         }
 940         signal_changed (DCP_CONTENT_TYPE);
 941 }
 942
 943 void
 944 Film::set_format (Format const * f)
 945 {
 946         {
 947                 boost::mutex::scoped_lock lm (_state_mutex);
 948                 _format = f;
 949         }
 950         signal_changed (FORMAT);
 951 }
 952
 953 void
 954 Film::set_crop (Crop c)
 955 {
 956         {
 957                 boost::mutex::scoped_lock lm (_state_mutex);
 958                 _crop = c;
 959         }
 960         signal_changed (CROP);
 961 }
 962
 963 void
 964 Film::set_left_crop (int c)
 965 {
 966         {
 967                 boost::mutex::scoped_lock lm (_state_mutex);
 968
 969                 if (_crop.left == c) {
 970                         return;
 971                 }
 972
 973                 _crop.left = c;
 974         }
 975         signal_changed (CROP);
 976 }
 977
 978 void
 979 Film::set_right_crop (int c)
 980 {
 981         {
 982                 boost::mutex::scoped_lock lm (_state_mutex);
 983                 if (_crop.right == c) {
 984                         return;
 985                 }
 986
 987                 _crop.right = c;
 988         }
 989         signal_changed (CROP);
 990 }
 991
 992 void
 993 Film::set_top_crop (int c)
 994 {
 995         {
 996                 boost::mutex::scoped_lock lm (_state_mutex);
 997                 if (_crop.top == c) {
 998                         return;
 999                 }
1000
1001                 _crop.top = c;
1002         }
1003         signal_changed (CROP);
1004 }
1005
1006 void
1007 Film::set_bottom_crop (int c)
1008 {
1009         {
1010                 boost::mutex::scoped_lock lm (_state_mutex);
1011                 if (_crop.bottom == c) {
1012                         return;
1013                 }
1014
1015                 _crop.bottom = c;
1016         }
1017         signal_changed (CROP);
1018 }
1019
1020 void
1021 Film::set_filters (vector<Filter const *> f)
1022 {
1023         {
1024                 boost::mutex::scoped_lock lm (_state_mutex);
1025                 _filters = f;
1026         }
1027         signal_changed (FILTERS);
1028 }
1029
1030 void
1031 Film::set_scaler (Scaler const * s)
1032 {
1033         {
1034                 boost::mutex::scoped_lock lm (_state_mutex);
1035                 _scaler = s;
1036         }
1037         signal_changed (SCALER);
1038 }
1039
1040 void
1041 Film::set_trim_start (int t)
1042 {
1043         {
1044                 boost::mutex::scoped_lock lm (_state_mutex);
1045                 _trim_start = t;
1046         }
1047         signal_changed (TRIM_START);
1048 }
1049
1050 void
1051 Film::set_trim_end (int t)
1052 {
1053         {
1054                 boost::mutex::scoped_lock lm (_state_mutex);
1055                 _trim_end = t;
1056         }
1057         signal_changed (TRIM_END);
1058 }
1059
1060 void
1061 Film::set_dcp_ab (bool a)
1062 {
1063         {
1064                 boost::mutex::scoped_lock lm (_state_mutex);
1065                 _dcp_ab = a;
1066         }
1067         signal_changed (DCP_AB);
1068 }
1069
1070 void
1071 Film::set_content_audio_stream (shared_ptr<AudioStream> s)
1072 {
1073         {
1074                 boost::mutex::scoped_lock lm (_state_mutex);
1075                 _content_audio_stream = s;
1076         }
1077         signal_changed (CONTENT_AUDIO_STREAM);
1078 }
1079
1080 void
1081 Film::set_external_audio (vector<string> a)
1082 {
1083         {
1084                 boost::mutex::scoped_lock lm (_state_mutex);
1085                 _external_audio = a;
1086         }
1087
1088         shared_ptr<ExternalAudioDecoder> decoder (new ExternalAudioDecoder (shared_from_this(), DecodeOptions()));
1089         if (decoder->audio_stream()) {
1090                 _external_audio_stream = decoder->audio_stream ();
1091         }
1092
1093         signal_changed (EXTERNAL_AUDIO);
1094 }
1095
1096 void
1097 Film::set_use_content_audio (bool e)
1098 {
1099         {
1100                 boost::mutex::scoped_lock lm (_state_mutex);
1101                 _use_content_audio = e;
1102         }
1103
1104         signal_changed (USE_CONTENT_AUDIO);
1105 }
1106
1107 void
1108 Film::set_audio_gain (float g)
1109 {
1110         {
1111                 boost::mutex::scoped_lock lm (_state_mutex);
1112                 _audio_gain = g;
1113         }
1114         signal_changed (AUDIO_GAIN);
1115 }
1116
1117 void
1118 Film::set_audio_delay (int d)
1119 {
1120         {
1121                 boost::mutex::scoped_lock lm (_state_mutex);
1122                 _audio_delay = d;
1123         }
1124         signal_changed (AUDIO_DELAY);
1125 }
1126
1127 void
1128 Film::set_still_duration (int d)
1129 {
1130         {
1131                 boost::mutex::scoped_lock lm (_state_mutex);
1132                 _still_duration = d;
1133         }
1134         signal_changed (STILL_DURATION);
1135 }
1136
1137 void
1138 Film::set_subtitle_stream (shared_ptr<SubtitleStream> s)
1139 {
1140         {
1141                 boost::mutex::scoped_lock lm (_state_mutex);
1142                 _subtitle_stream = s;
1143         }
1144         signal_changed (SUBTITLE_STREAM);
1145 }
1146
1147 void
1148 Film::set_with_subtitles (bool w)
1149 {
1150         {
1151                 boost::mutex::scoped_lock lm (_state_mutex);
1152                 _with_subtitles = w;
1153         }
1154         signal_changed (WITH_SUBTITLES);
1155 }
1156
1157 void
1158 Film::set_subtitle_offset (int o)
1159 {
1160         {
1161                 boost::mutex::scoped_lock lm (_state_mutex);
1162                 _subtitle_offset = o;
1163         }
1164         signal_changed (SUBTITLE_OFFSET);
1165 }
1166
1167 void
1168 Film::set_subtitle_scale (float s)
1169 {
1170         {
1171                 boost::mutex::scoped_lock lm (_state_mutex);
1172                 _subtitle_scale = s;
1173         }
1174         signal_changed (SUBTITLE_SCALE);
1175 }
1176
1177 void
1178 Film::set_colour_lut (int i)
1179 {
1180         {
1181                 boost::mutex::scoped_lock lm (_state_mutex);
1182                 _colour_lut = i;
1183         }
1184         signal_changed (COLOUR_LUT);
1185 }
1186
1187 void
1188 Film::set_j2k_bandwidth (int b)
1189 {
1190         {
1191                 boost::mutex::scoped_lock lm (_state_mutex);
1192                 _j2k_bandwidth = b;
1193         }
1194         signal_changed (J2K_BANDWIDTH);
1195 }
1196
1197 void
1198 Film::set_dci_metadata (DCIMetadata m)
1199 {
1200         {
1201                 boost::mutex::scoped_lock lm (_state_mutex);
1202                 _dci_metadata = m;
1203         }
1204         signal_changed (DCI_METADATA);
1205 }
1206
1207 void
1208 Film::set_size (libdcp::Size s)
1209 {
1210         {
1211                 boost::mutex::scoped_lock lm (_state_mutex);
1212                 _size = s;
1213         }
1214         signal_changed (SIZE);
1215 }
1216
1217 void
1218 Film::set_length (SourceFrame l)
1219 {
1220         {
1221                 boost::mutex::scoped_lock lm (_state_mutex);
1222                 _length = l;
1223         }
1224         signal_changed (LENGTH);
1225 }
1226
1227 void
1228 Film::unset_length ()
1229 {
1230         {
1231                 boost::mutex::scoped_lock lm (_state_mutex);
1232                 _length = boost::none;
1233         }
1234         signal_changed (LENGTH);
1235 }
1236
1237 void
1238 Film::set_dcp_intrinsic_duration (int d)
1239 {
1240         {
1241                 boost::mutex::scoped_lock lm (_state_mutex);
1242                 _dcp_intrinsic_duration = d;
1243         }
1244         signal_changed (DCP_INTRINSIC_DURATION);
1245 }
1246
1247 void
1248 Film::set_content_digest (string d)
1249 {
1250         {
1251                 boost::mutex::scoped_lock lm (_state_mutex);
1252                 _content_digest = d;
1253         }
1254         _dirty = true;
1255 }
1256
1257 void
1258 Film::set_content_audio_streams (vector<shared_ptr<AudioStream> > s)
1259 {
1260         {
1261                 boost::mutex::scoped_lock lm (_state_mutex);
1262                 _content_audio_streams = s;
1263         }
1264         signal_changed (CONTENT_AUDIO_STREAMS);
1265 }
1266
1267 void
1268 Film::set_subtitle_streams (vector<shared_ptr<SubtitleStream> > s)
1269 {
1270         {
1271                 boost::mutex::scoped_lock lm (_state_mutex);
1272                 _subtitle_streams = s;
1273         }
1274         signal_changed (SUBTITLE_STREAMS);
1275 }
1276
1277 void
1278 Film::set_frames_per_second (float f)
1279 {
1280         {
1281                 boost::mutex::scoped_lock lm (_state_mutex);
1282                 _frames_per_second = f;
1283         }
1284         signal_changed (FRAMES_PER_SECOND);
1285 }
1286
1287 void
1288 Film::signal_changed (Property p)
1289 {
1290         {
1291                 boost::mutex::scoped_lock lm (_state_mutex);
1292                 _dirty = true;
1293         }
1294
1295         if (ui_signaller) {
1296                 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
1297         }
1298 }
1299
1300 int
1301 Film::audio_channels () const
1302 {
1303         shared_ptr<AudioStream> s = audio_stream ();
1304         if (!s) {
1305                 return 0;
1306         }
1307
1308         return s->channels ();
1309 }
1310
1311 void
1312 Film::set_dci_date_today ()
1313 {
1314         _dci_date = boost::gregorian::day_clock::local_day ();
1315 }
1316
1317 boost::shared_ptr<AudioStream>
1318 Film::audio_stream () const
1319 {
1320         if (use_content_audio()) {
1321                 return _content_audio_stream;
1322         }
1323
1324         return _external_audio_stream;
1325 }
1326
1327 string
1328 Film::info_path (int f) const
1329 {
1330         boost::filesystem::path p;
1331         p /= info_dir ();
1332
1333         stringstream s;
1334         s.width (8);
1335         s << setfill('0') << f << ".md5";
1336
1337         p /= s.str();
1338
1339         /* info_dir() will already have added any initial bit of the path,
1340            so don't call file() on this.
1341         */
1342         return p.string ();
1343 }
1344
1345 string
1346 Film::j2c_path (int f, bool t) const
1347 {
1348         boost::filesystem::path p;
1349         p /= "j2c";
1350         p /= video_state_identifier ();
1351
1352         stringstream s;
1353         s.width (8);
1354         s << setfill('0') << f << ".j2c";
1355
1356         if (t) {
1357                 s << ".tmp";
1358         }
1359
1360         p /= s.str();
1361         return file (p.string ());
1362 }
1363
1364 /** Make an educated guess as to whether we have a complete DCP
1365  *  or not.
1366  *  @return true if we do.
1367  */
1368
1369 bool
1370 Film::have_dcp () const
1371 {
1372         try {
1373                 libdcp::DCP dcp (dir (dcp_name()));
1374                 dcp.read ();
1375         } catch (...) {
1376                 return false;
1377         }
1378
1379         return true;
1380 }