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<Options> o (new Options (j2k_dir(), ".j2c", dir ("wavs")));
 262         o->out_size = format()->dcp_size ();
 263         o->padding = format()->dcp_padding (shared_from_this ());
 264         o->ratio = format()->ratio_as_float (shared_from_this ());
 265         if (dcp_length ()) {
 266                 o->video_decode_range = make_pair (dcp_trim_start(), dcp_trim_start() + dcp_length().get());
 267                 if (audio_stream()) {
 268                         o->audio_decode_range = make_pair (
 269                                 video_frames_to_audio_frames (o->video_decode_range.get().first, audio_stream()->sample_rate(), frames_per_second()),
 270                                 video_frames_to_audio_frames (o->video_decode_range.get().second, audio_stream()->sample_rate(), frames_per_second())
 271                                 );
 272                 }
 273
 274         }
 275         o->decode_subtitles = with_subtitles ();
 276         o->decode_video_skip = dcp_frame_rate (frames_per_second()).skip;
 277
 278         shared_ptr<Job> r;
 279
 280         if (transcode) {
 281                 if (dcp_ab()) {
 282                         r = JobManager::instance()->add (shared_ptr<Job> (new ABTranscodeJob (shared_from_this(), o, shared_ptr<Job> ())));
 283                 } else {
 284                         r = JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this(), o, shared_ptr<Job> ())));
 285                 }
 286         }
 287
 288         r = JobManager::instance()->add (shared_ptr<Job> (new CheckHashesJob (shared_from_this(), o, r)));
 289         JobManager::instance()->add (shared_ptr<Job> (new MakeDCPJob (shared_from_this(), o, r)));
 290 }
 291
 292 /** Start a job to examine our content file */
 293 void
 294 Film::examine_content ()
 295 {
 296         if (_examine_content_job) {
 297                 return;
 298         }
 299
 300         _examine_content_job.reset (new ExamineContentJob (shared_from_this(), shared_ptr<Job> ()));
 301         _examine_content_job->Finished.connect (bind (&Film::examine_content_finished, this));
 302         JobManager::instance()->add (_examine_content_job);
 303 }
 304
 305 void
 306 Film::examine_content_finished ()
 307 {
 308         _examine_content_job.reset ();
 309 }
 310
 311 /** @return full paths to any audio files that this Film has */
 312 vector<string>
 313 Film::audio_files () const
 314 {
 315         vector<string> f;
 316         for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (dir("wavs")); i != boost::filesystem::directory_iterator(); ++i) {
 317                 f.push_back (i->path().string ());
 318         }
 319
 320         return f;
 321 }
 322
 323 /** Start a job to send our DCP to the configured TMS */
 324 void
 325 Film::send_dcp_to_tms ()
 326 {
 327         shared_ptr<Job> j (new SCPDCPJob (shared_from_this(), shared_ptr<Job> ()));
 328         JobManager::instance()->add (j);
 329 }
 330
 331 /** Count the number of frames that have been encoded for this film.
 332  *  @return frame count.
 333  */
 334 int
 335 Film::encoded_frames () const
 336 {
 337         if (format() == 0) {
 338                 return 0;
 339         }
 340
 341         int N = 0;
 342         for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (j2k_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
 343                 ++N;
 344                 boost::this_thread::interruption_point ();
 345         }
 346
 347         return N;
 348 }
 349
 350 /** Write state to our `metadata' file */
 351 void
 352 Film::write_metadata () const
 353 {
 354         boost::mutex::scoped_lock lm (_state_mutex);
 355
 356         boost::filesystem::create_directories (directory());
 357
 358         string const m = file ("metadata");
 359         ofstream f (m.c_str ());
 360         if (!f.good ()) {
 361                 throw CreateFileError (m);
 362         }
 363
 364         f << "version " << state_version << "\n";
 365
 366         /* User stuff */
 367         f << "name " << _name << "\n";
 368         f << "use_dci_name " << _use_dci_name << "\n";
 369         f << "content " << _content << "\n";
 370         if (_dcp_content_type) {
 371                 f << "dcp_content_type " << _dcp_content_type->pretty_name () << "\n";
 372         }
 373         if (_format) {
 374                 f << "format " << _format->as_metadata () << "\n";
 375         }
 376         f << "left_crop " << _crop.left << "\n";
 377         f << "right_crop " << _crop.right << "\n";
 378         f << "top_crop " << _crop.top << "\n";
 379         f << "bottom_crop " << _crop.bottom << "\n";
 380         for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
 381                 f << "filter " << (*i)->id () << "\n";
 382         }
 383         f << "scaler " << _scaler->id () << "\n";
 384         f << "dcp_trim_start " << _dcp_trim_start << "\n";
 385         f << "dcp_trim_end " << _dcp_trim_end << "\n";
 386         f << "dcp_ab " << (_dcp_ab ? "1" : "0") << "\n";
 387         if (_content_audio_stream) {
 388                 f << "selected_content_audio_stream " << _content_audio_stream->to_string() << "\n";
 389         }
 390         for (vector<string>::const_iterator i = _external_audio.begin(); i != _external_audio.end(); ++i) {
 391                 f << "external_audio " << *i << "\n";
 392         }
 393         f << "use_content_audio " << (_use_content_audio ? "1" : "0") << "\n";
 394         f << "audio_gain " << _audio_gain << "\n";
 395         f << "audio_delay " << _audio_delay << "\n";
 396         f << "still_duration " << _still_duration << "\n";
 397         if (_subtitle_stream) {
 398                 f << "selected_subtitle_stream " << _subtitle_stream->to_string() << "\n";
 399         }
 400         f << "with_subtitles " << _with_subtitles << "\n";
 401         f << "subtitle_offset " << _subtitle_offset << "\n";
 402         f << "subtitle_scale " << _subtitle_scale << "\n";
 403         f << "audio_language " << _audio_language << "\n";
 404         f << "subtitle_language " << _subtitle_language << "\n";
 405         f << "territory " << _territory << "\n";
 406         f << "rating " << _rating << "\n";
 407         f << "studio " << _studio << "\n";
 408         f << "facility " << _facility << "\n";
 409         f << "package_type " << _package_type << "\n";
 410
 411         f << "width " << _size.width << "\n";
 412         f << "height " << _size.height << "\n";
 413         f << "length " << _length.get_value_or(0) << "\n";
 414         f << "content_digest " << _content_digest << "\n";
 415
 416         for (vector<shared_ptr<AudioStream> >::const_iterator i = _content_audio_streams.begin(); i != _content_audio_streams.end(); ++i) {
 417                 f << "content_audio_stream " << (*i)->to_string () << "\n";
 418         }
 419
 420         f << "external_audio_stream " << _external_audio_stream->to_string() << "\n";
 421
 422         for (vector<shared_ptr<SubtitleStream> >::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
 423                 f << "subtitle_stream " << (*i)->to_string () << "\n";
 424         }
 425
 426         f << "frames_per_second " << _frames_per_second << "\n";
 427
 428         _dirty = false;
 429 }
 430
 431 /** Read state from our metadata file */
 432 void
 433 Film::read_metadata ()
 434 {
 435         boost::mutex::scoped_lock lm (_state_mutex);
 436
 437         _external_audio.clear ();
 438         _content_audio_streams.clear ();
 439         _subtitle_streams.clear ();
 440
 441         boost::optional<int> version;
 442
 443         /* Backward compatibility things */
 444         boost::optional<int> audio_sample_rate;
 445         boost::optional<int> audio_stream_index;
 446         boost::optional<int> subtitle_stream_index;
 447
 448         ifstream f (file ("metadata").c_str());
 449         multimap<string, string> kv = read_key_value (f);
 450
 451         /* We need version before anything else */
 452         multimap<string, string>::iterator v = kv.find ("version");
 453         if (v != kv.end ()) {
 454                 version = atoi (v->second.c_str());
 455         }
 456
 457         for (multimap<string, string>::const_iterator i = kv.begin(); i != kv.end(); ++i) {
 458                 string const k = i->first;
 459                 string const v = i->second;
 460
 461                 if (k == "audio_sample_rate") {
 462                         audio_sample_rate = atoi (v.c_str());
 463                 }
 464
 465                 /* User-specified stuff */
 466                 if (k == "name") {
 467                         _name = v;
 468                 } else if (k == "use_dci_name") {
 469                         _use_dci_name = (v == "1");
 470                 } else if (k == "content") {
 471                         _content = v;
 472                 } else if (k == "dcp_content_type") {
 473                         _dcp_content_type = DCPContentType::from_pretty_name (v);
 474                 } else if (k == "format") {
 475                         _format = Format::from_metadata (v);
 476                 } else if (k == "left_crop") {
 477                         _crop.left = atoi (v.c_str ());
 478                 } else if (k == "right_crop") {
 479                         _crop.right = atoi (v.c_str ());
 480                 } else if (k == "top_crop") {
 481                         _crop.top = atoi (v.c_str ());
 482                 } else if (k == "bottom_crop") {
 483                         _crop.bottom = atoi (v.c_str ());
 484                 } else if (k == "filter") {
 485                         _filters.push_back (Filter::from_id (v));
 486                 } else if (k == "scaler") {
 487                         _scaler = Scaler::from_id (v);
 488                 } else if (k == "dcp_trim_start") {
 489                         _dcp_trim_start = atoi (v.c_str ());
 490                 } else if (k == "dcp_trim_end") {
 491                         _dcp_trim_end = atoi (v.c_str ());
 492                 } else if (k == "dcp_ab") {
 493                         _dcp_ab = (v == "1");
 494                 } else if (k == "selected_content_audio_stream" || (!version && k == "selected_audio_stream")) {
 495                         if (!version) {
 496                                 audio_stream_index = atoi (v.c_str ());
 497                         } else {
 498                                 _content_audio_stream = audio_stream_factory (v, version);
 499                         }
 500                 } else if (k == "external_audio") {
 501                         _external_audio.push_back (v);
 502                 } else if (k == "use_content_audio") {
 503                         _use_content_audio = (v == "1");
 504                 } else if (k == "audio_gain") {
 505                         _audio_gain = atof (v.c_str ());
 506                 } else if (k == "audio_delay") {
 507                         _audio_delay = atoi (v.c_str ());
 508                 } else if (k == "still_duration") {
 509                         _still_duration = atoi (v.c_str ());
 510                 } else if (k == "selected_subtitle_stream") {
 511                         if (!version) {
 512                                 subtitle_stream_index = atoi (v.c_str ());
 513                         } else {
 514                                 _subtitle_stream = subtitle_stream_factory (v, version);
 515                         }
 516                 } else if (k == "with_subtitles") {
 517                         _with_subtitles = (v == "1");
 518                 } else if (k == "subtitle_offset") {
 519                         _subtitle_offset = atoi (v.c_str ());
 520                 } else if (k == "subtitle_scale") {
 521                         _subtitle_scale = atof (v.c_str ());
 522                 } else if (k == "audio_language") {
 523                         _audio_language = v;
 524                 } else if (k == "subtitle_language") {
 525                         _subtitle_language = v;
 526                 } else if (k == "territory") {
 527                         _territory = v;
 528                 } else if (k == "rating") {
 529                         _rating = v;
 530                 } else if (k == "studio") {
 531                         _studio = v;
 532                 } else if (k == "facility") {
 533                         _facility = v;
 534                 } else if (k == "package_type") {
 535                         _package_type = v;
 536                 }
 537
 538                 /* Cached stuff */
 539                 if (k == "width") {
 540                         _size.width = atoi (v.c_str ());
 541                 } else if (k == "height") {
 542                         _size.height = atoi (v.c_str ());
 543                 } else if (k == "length") {
 544                         int const vv = atoi (v.c_str ());
 545                         if (vv) {
 546                                 _length = vv;
 547                         }
 548                 } else if (k == "content_digest") {
 549                         _content_digest = v;
 550                 } else if (k == "content_audio_stream" || (!version && k == "audio_stream")) {
 551                         _content_audio_streams.push_back (audio_stream_factory (v, version));
 552                 } else if (k == "external_audio_stream") {
 553                         _external_audio_stream = audio_stream_factory (v, version);
 554                 } else if (k == "subtitle_stream") {
 555                         _subtitle_streams.push_back (subtitle_stream_factory (v, version));
 556                 } else if (k == "frames_per_second") {
 557                         _frames_per_second = atof (v.c_str ());
 558                 }
 559         }
 560
 561         if (!version) {
 562                 if (audio_sample_rate) {
 563                         /* version < 1 didn't specify sample rate in the audio streams, so fill it in here */
 564                         for (vector<shared_ptr<AudioStream> >::iterator i = _content_audio_streams.begin(); i != _content_audio_streams.end(); ++i) {
 565                                 (*i)->set_sample_rate (audio_sample_rate.get());
 566                         }
 567                 }
 568
 569                 /* also the selected stream was specified as an index */
 570                 if (audio_stream_index && audio_stream_index.get() >= 0 && audio_stream_index.get() < (int) _content_audio_streams.size()) {
 571                         _content_audio_stream = _content_audio_streams[audio_stream_index.get()];
 572                 }
 573
 574                 /* similarly the subtitle */
 575                 if (subtitle_stream_index && subtitle_stream_index.get() >= 0 && subtitle_stream_index.get() < (int) _subtitle_streams.size()) {
 576                         _subtitle_stream = _subtitle_streams[subtitle_stream_index.get()];
 577                 }
 578         }
 579
 580         _dirty = false;
 581 }
 582
 583 Size
 584 Film::cropped_size (Size s) const
 585 {
 586         boost::mutex::scoped_lock lm (_state_mutex);
 587         s.width -= _crop.left + _crop.right;
 588         s.height -= _crop.top + _crop.bottom;
 589         return s;
 590 }
 591
 592 /** Given a directory name, return its full path within the Film's directory.
 593  *  The directory (and its parents) will be created if they do not exist.
 594  */
 595 string
 596 Film::dir (string d) const
 597 {
 598         boost::mutex::scoped_lock lm (_directory_mutex);
 599         boost::filesystem::path p;
 600         p /= _directory;
 601         p /= d;
 602         boost::filesystem::create_directories (p);
 603         return p.string ();
 604 }
 605
 606 /** Given a file or directory name, return its full path within the Film's directory.
 607  *  _directory_mutex must not be locked on entry.
 608  */
 609 string
 610 Film::file (string f) const
 611 {
 612         boost::mutex::scoped_lock lm (_directory_mutex);
 613         boost::filesystem::path p;
 614         p /= _directory;
 615         p /= f;
 616         return p.string ();
 617 }
 618
 619 /** @return full path of the content (actual video) file
 620  *  of the Film.
 621  */
 622 string
 623 Film::content_path () const
 624 {
 625         boost::mutex::scoped_lock lm (_state_mutex);
 626         if (boost::filesystem::path(_content).has_root_directory ()) {
 627                 return _content;
 628         }
 629
 630         return file (_content);
 631 }
 632
 633 ContentType
 634 Film::content_type () const
 635 {
 636         if (boost::filesystem::is_directory (_content)) {
 637                 /* Directory of images, we assume */
 638                 return VIDEO;
 639         }
 640
 641         if (still_image_file (_content)) {
 642                 return STILL;
 643         }
 644
 645         return VIDEO;
 646 }
 647
 648 /** @return The sampling rate that we will resample the audio to */
 649 int
 650 Film::target_audio_sample_rate () const
 651 {
 652         if (!audio_stream()) {
 653                 return 0;
 654         }
 655
 656         /* Resample to a DCI-approved sample rate */
 657         double t = dcp_audio_sample_rate (audio_stream()->sample_rate());
 658
 659         DCPFrameRate dfr = dcp_frame_rate (frames_per_second ());
 660
 661         /* Compensate for the fact that video will be rounded to the
 662            nearest integer number of frames per second.
 663         */
 664         if (dfr.run_fast) {
 665                 t *= _frames_per_second * dfr.skip / dfr.frames_per_second;
 666         }
 667
 668         return rint (t);
 669 }
 670
 671 boost::optional<SourceFrame>
 672 Film::dcp_length () const
 673 {
 674         if (!length()) {
 675                 return boost::optional<SourceFrame> ();
 676         }
 677
 678         return length().get() - dcp_trim_start() - dcp_trim_end();
 679 }
 680
 681 /** @return a DCI-compliant name for a DCP of this film */
 682 string
 683 Film::dci_name () const
 684 {
 685         stringstream d;
 686
 687         string fixed_name = to_upper_copy (name());
 688         for (size_t i = 0; i < fixed_name.length(); ++i) {
 689                 if (fixed_name[i] == ' ') {
 690                         fixed_name[i] = '-';
 691                 }
 692         }
 693
 694         /* Spec is that the name part should be maximum 14 characters, as I understand it */
 695         if (fixed_name.length() > 14) {
 696                 fixed_name = fixed_name.substr (0, 14);
 697         }
 698
 699         d << fixed_name << "_";
 700
 701         if (dcp_content_type()) {
 702                 d << dcp_content_type()->dci_name() << "_";
 703         }
 704
 705         if (format()) {
 706                 d << format()->dci_name() << "_";
 707         }
 708
 709         if (!audio_language().empty ()) {
 710                 d << audio_language();
 711                 if (!subtitle_language().empty() && with_subtitles()) {
 712                         d << "-" << subtitle_language();
 713                 } else {
 714                         d << "-XX";
 715                 }
 716
 717                 d << "_";
 718         }
 719
 720         if (!territory().empty ()) {
 721                 d << territory();
 722                 if (!rating().empty ()) {
 723                         d << "-" << rating();
 724                 }
 725                 d << "_";
 726         }
 727
 728         switch (audio_channels()) {
 729         case 1:
 730                 d << "10_";
 731                 break;
 732         case 2:
 733                 d << "20_";
 734                 break;
 735         case 6:
 736                 d << "51_";
 737                 break;
 738         case 8:
 739                 d << "71_";
 740                 break;
 741         }
 742
 743         d << "2K_";
 744
 745         if (!studio().empty ()) {
 746                 d << studio() << "_";
 747         }
 748
 749         d << boost::gregorian::to_iso_string (_dci_date) << "_";
 750
 751         if (!facility().empty ()) {
 752                 d << facility() << "_";
 753         }
 754
 755         if (!package_type().empty ()) {
 756                 d << package_type();
 757         }
 758
 759         return d.str ();
 760 }
 761
 762 /** @return name to give the DCP */
 763 string
 764 Film::dcp_name () const
 765 {
 766         if (use_dci_name()) {
 767                 return dci_name ();
 768         }
 769
 770         return name();
 771 }
 772
 773
 774 void
 775 Film::set_directory (string d)
 776 {
 777         boost::mutex::scoped_lock lm (_state_mutex);
 778         _directory = d;
 779         _dirty = true;
 780 }
 781
 782 void
 783 Film::set_name (string n)
 784 {
 785         {
 786                 boost::mutex::scoped_lock lm (_state_mutex);
 787                 _name = n;
 788         }
 789         signal_changed (NAME);
 790 }
 791
 792 void
 793 Film::set_use_dci_name (bool u)
 794 {
 795         {
 796                 boost::mutex::scoped_lock lm (_state_mutex);
 797                 _use_dci_name = u;
 798         }
 799         signal_changed (USE_DCI_NAME);
 800 }
 801
 802 void
 803 Film::set_content (string c)
 804 {
 805         string check = directory ();
 806
 807 #if BOOST_FILESYSTEM_VERSION == 3
 808         boost::filesystem::path slash ("/");
 809         string platform_slash = slash.make_preferred().string ();
 810 #else
 811 #ifdef DVDOMATIC_WINDOWS
 812         string platform_slash = "\\";
 813 #else
 814         string platform_slash = "/";
 815 #endif
 816 #endif
 817
 818         if (!ends_with (check, platform_slash)) {
 819                 check += platform_slash;
 820         }
 821
 822         if (boost::filesystem::path(c).has_root_directory () && starts_with (c, check)) {
 823                 c = c.substr (_directory.length() + 1);
 824         }
 825
 826         string old_content;
 827
 828         {
 829                 boost::mutex::scoped_lock lm (_state_mutex);
 830                 if (c == _content) {
 831                         return;
 832                 }
 833
 834                 old_content = _content;
 835                 _content = c;
 836         }
 837
 838         /* Reset streams here in case the new content doesn't have one or the other */
 839         _content_audio_stream = shared_ptr<AudioStream> ();
 840         _subtitle_stream = shared_ptr<SubtitleStream> ();
 841
 842         /* Create a temporary decoder so that we can get information
 843            about the content.
 844         */
 845
 846         try {
 847                 shared_ptr<Options> o (new Options ("", "", ""));
 848                 o->out_size = Size (1024, 1024);
 849
 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<Options> o (new Options ("", "", ""));
1042         o->decode_audio = true;
1043         shared_ptr<ExternalAudioDecoder> decoder (new ExternalAudioDecoder (shared_from_this(), o, 0));
1044         if (decoder->audio_stream()) {
1045                 _external_audio_stream = decoder->audio_stream ();
1046         }
1047
1048         signal_changed (EXTERNAL_AUDIO);
1049 }
1050
1051 void
1052 Film::set_use_content_audio (bool e)
1053 {
1054         {
1055                 boost::mutex::scoped_lock lm (_state_mutex);
1056                 _use_content_audio = e;
1057         }
1058
1059         signal_changed (USE_CONTENT_AUDIO);
1060 }
1061
1062 void
1063 Film::set_audio_gain (float g)
1064 {
1065         {
1066                 boost::mutex::scoped_lock lm (_state_mutex);
1067                 _audio_gain = g;
1068         }
1069         signal_changed (AUDIO_GAIN);
1070 }
1071
1072 void
1073 Film::set_audio_delay (int d)
1074 {
1075         {
1076                 boost::mutex::scoped_lock lm (_state_mutex);
1077                 _audio_delay = d;
1078         }
1079         signal_changed (AUDIO_DELAY);
1080 }
1081
1082 void
1083 Film::set_still_duration (int d)
1084 {
1085         {
1086                 boost::mutex::scoped_lock lm (_state_mutex);
1087                 _still_duration = d;
1088         }
1089         signal_changed (STILL_DURATION);
1090 }
1091
1092 void
1093 Film::set_subtitle_stream (shared_ptr<SubtitleStream> s)
1094 {
1095         {
1096                 boost::mutex::scoped_lock lm (_state_mutex);
1097                 _subtitle_stream = s;
1098         }
1099         signal_changed (SUBTITLE_STREAM);
1100 }
1101
1102 void
1103 Film::set_with_subtitles (bool w)
1104 {
1105         {
1106                 boost::mutex::scoped_lock lm (_state_mutex);
1107                 _with_subtitles = w;
1108         }
1109         signal_changed (WITH_SUBTITLES);
1110 }
1111
1112 void
1113 Film::set_subtitle_offset (int o)
1114 {
1115         {
1116                 boost::mutex::scoped_lock lm (_state_mutex);
1117                 _subtitle_offset = o;
1118         }
1119         signal_changed (SUBTITLE_OFFSET);
1120 }
1121
1122 void
1123 Film::set_subtitle_scale (float s)
1124 {
1125         {
1126                 boost::mutex::scoped_lock lm (_state_mutex);
1127                 _subtitle_scale = s;
1128         }
1129         signal_changed (SUBTITLE_SCALE);
1130 }
1131
1132 void
1133 Film::set_audio_language (string l)
1134 {
1135         {
1136                 boost::mutex::scoped_lock lm (_state_mutex);
1137                 _audio_language = l;
1138         }
1139         signal_changed (DCI_METADATA);
1140 }
1141
1142 void
1143 Film::set_subtitle_language (string l)
1144 {
1145         {
1146                 boost::mutex::scoped_lock lm (_state_mutex);
1147                 _subtitle_language = l;
1148         }
1149         signal_changed (DCI_METADATA);
1150 }
1151
1152 void
1153 Film::set_territory (string t)
1154 {
1155         {
1156                 boost::mutex::scoped_lock lm (_state_mutex);
1157                 _territory = t;
1158         }
1159         signal_changed (DCI_METADATA);
1160 }
1161
1162 void
1163 Film::set_rating (string r)
1164 {
1165         {
1166                 boost::mutex::scoped_lock lm (_state_mutex);
1167                 _rating = r;
1168         }
1169         signal_changed (DCI_METADATA);
1170 }
1171
1172 void
1173 Film::set_studio (string s)
1174 {
1175         {
1176                 boost::mutex::scoped_lock lm (_state_mutex);
1177                 _studio = s;
1178         }
1179         signal_changed (DCI_METADATA);
1180 }
1181
1182 void
1183 Film::set_facility (string f)
1184 {
1185         {
1186                 boost::mutex::scoped_lock lm (_state_mutex);
1187                 _facility = f;
1188         }
1189         signal_changed (DCI_METADATA);
1190 }
1191
1192 void
1193 Film::set_package_type (string p)
1194 {
1195         {
1196                 boost::mutex::scoped_lock lm (_state_mutex);
1197                 _package_type = p;
1198         }
1199         signal_changed (DCI_METADATA);
1200 }
1201
1202 void
1203 Film::set_size (Size s)
1204 {
1205         {
1206                 boost::mutex::scoped_lock lm (_state_mutex);
1207                 _size = s;
1208         }
1209         signal_changed (SIZE);
1210 }
1211
1212 void
1213 Film::set_length (SourceFrame l)
1214 {
1215         {
1216                 boost::mutex::scoped_lock lm (_state_mutex);
1217                 _length = l;
1218         }
1219         signal_changed (LENGTH);
1220 }
1221
1222 void
1223 Film::unset_length ()
1224 {
1225         {
1226                 boost::mutex::scoped_lock lm (_state_mutex);
1227                 _length = boost::none;
1228         }
1229         signal_changed (LENGTH);
1230 }
1231
1232 void
1233 Film::set_content_digest (string d)
1234 {
1235         {
1236                 boost::mutex::scoped_lock lm (_state_mutex);
1237                 _content_digest = d;
1238         }
1239         _dirty = true;
1240 }
1241
1242 void
1243 Film::set_content_audio_streams (vector<shared_ptr<AudioStream> > s)
1244 {
1245         {
1246                 boost::mutex::scoped_lock lm (_state_mutex);
1247                 _content_audio_streams = s;
1248         }
1249         signal_changed (CONTENT_AUDIO_STREAMS);
1250 }
1251
1252 void
1253 Film::set_subtitle_streams (vector<shared_ptr<SubtitleStream> > s)
1254 {
1255         {
1256                 boost::mutex::scoped_lock lm (_state_mutex);
1257                 _subtitle_streams = s;
1258         }
1259         signal_changed (SUBTITLE_STREAMS);
1260 }
1261
1262 void
1263 Film::set_frames_per_second (float f)
1264 {
1265         {
1266                 boost::mutex::scoped_lock lm (_state_mutex);
1267                 _frames_per_second = f;
1268         }
1269         signal_changed (FRAMES_PER_SECOND);
1270 }
1271
1272 void
1273 Film::signal_changed (Property p)
1274 {
1275         {
1276                 boost::mutex::scoped_lock lm (_state_mutex);
1277                 _dirty = true;
1278         }
1279
1280         if (ui_signaller) {
1281                 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
1282         }
1283 }
1284
1285 int
1286 Film::audio_channels () const
1287 {
1288         shared_ptr<AudioStream> s = audio_stream ();
1289         if (!s) {
1290                 return 0;
1291         }
1292
1293         return s->channels ();
1294 }
1295
1296 void
1297 Film::set_dci_date_today ()
1298 {
1299         _dci_date = boost::gregorian::day_clock::local_day ();
1300 }
1301
1302 boost::shared_ptr<AudioStream>
1303 Film::audio_stream () const
1304 {
1305         if (use_content_audio()) {
1306                 return _content_audio_stream;
1307         }
1308
1309         return _external_audio_stream;
1310 }