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