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