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