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