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