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