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