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