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