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