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