src/lib/film.cc

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <stdexcept>
  21 #include <iostream>
  22 #include <algorithm>
  23 #include <fstream>
  24 #include <cstdlib>
  25 #include <sstream>
  26 #include <iomanip>
  27 #include <unistd.h>
  28 #include <boost/filesystem.hpp>
  29 #include <boost/algorithm/string.hpp>
  30 #include <boost/lexical_cast.hpp>
  31 #include <boost/date_time.hpp>
  32 #include "film.h"
  33 #include "format.h"
  34 #include "job.h"
  35 #include "filter.h"
  36 #include "transcoder.h"
  37 #include "util.h"
  38 #include "job_manager.h"
  39 #include "ab_transcode_job.h"
  40 #include "transcode_job.h"
  41 #include "scp_dcp_job.h"
  42 #include "make_dcp_job.h"
  43 #include "log.h"
  44 #include "options.h"
  45 #include "exceptions.h"
  46 #include "examine_content_job.h"
  47 #include "scaler.h"
  48 #include "decoder_factory.h"
  49 #include "config.h"
  50 #include "check_hashes_job.h"
  51 #include "version.h"
  52 #include "ui_signaller.h"
  53 #include "video_decoder.h"
  54 #include "audio_decoder.h"
  55 #include "external_audio_decoder.h"
  56
  57 using std::string;
  58 using std::stringstream;
  59 using std::multimap;
  60 using std::pair;
  61 using std::map;
  62 using std::vector;
  63 using std::ifstream;
  64 using std::ofstream;
  65 using std::setfill;
  66 using std::min;
  67 using std::make_pair;
  68 using std::cout;
  69 using boost::shared_ptr;
  70 using boost::lexical_cast;
  71 using boost::to_upper_copy;
  72 using boost::ends_with;
  73 using boost::starts_with;
  74 using boost::optional;
  75
  76 int const Film::state_version = 1;
  77
  78 /** Construct a Film object in a given directory, reading any metadata
  79  *  file that exists in that directory.  An exception will be thrown if
  80  *  must_exist is true and the specified directory does not exist.
  81  *
  82  *  @param d Film directory.
  83  *  @param must_exist true to throw an exception if does not exist.
  84  */
  85
  86 Film::Film (string d, bool must_exist)
  87         : _use_dci_name (true)
  88         , _trust_content_header (true)
  89         , _dcp_content_type (0)
  90         , _format (0)
  91         , _scaler (Scaler::from_id ("bicubic"))
  92         , _dcp_trim_start (0)
  93         , _dcp_trim_end (0)
  94         , _dcp_ab (false)
  95         , _use_content_audio (true)
  96         , _audio_gain (0)
  97         , _audio_delay (0)
  98         , _still_duration (10)
  99         , _with_subtitles (false)
 100         , _subtitle_offset (0)
 101         , _subtitle_scale (1)
 102         , _colour_lut (0)
 103         , _j2k_bandwidth (200000000)
 104         , _dci_metadata (Config::instance()->default_dci_metadata ())
 105         , _frames_per_second (0)
 106         , _dirty (false)
 107 {
 108         /* Make state.directory a complete path without ..s (where possible)
 109            (Code swiped from Adam Bowen on stackoverflow)
 110         */
 111
 112         boost::filesystem::path p (boost::filesystem::system_complete (d));
 113         boost::filesystem::path result;
 114         for (boost::filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
 115                 if (*i == "..") {
 116                         if (boost::filesystem::is_symlink (result) || result.filename() == "..") {
 117                                 result /= *i;
 118                         } else {
 119                                 result = result.parent_path ();
 120                         }
 121                 } else if (*i != ".") {
 122                         result /= *i;
 123                 }
 124         }
 125
 126         set_directory (result.string ());
 127
 128         if (!boost::filesystem::exists (directory())) {
 129                 if (must_exist) {
 130                         throw OpenFileError (directory());
 131                 } else {
 132                         boost::filesystem::create_directory (directory());
 133                 }
 134         }
 135
 136         _external_audio_stream = ExternalAudioStream::create ();
 137
 138         if (must_exist) {
 139                 read_metadata ();
 140         }
 141
 142         _log = new FileLog (file ("log"));
 143         set_dci_date_today ();
 144 }
 145
 146 Film::Film (Film const & o)
 147         : boost::enable_shared_from_this<Film> (o)
 148         , _log (0)
 149         , _directory         (o._directory)
 150         , _name              (o._name)
 151         , _use_dci_name      (o._use_dci_name)
 152         , _content           (o._content)
 153         , _trust_content_header (o._trust_content_header)
 154         , _dcp_content_type  (o._dcp_content_type)
 155         , _format            (o._format)
 156         , _crop              (o._crop)
 157         , _filters           (o._filters)
 158         , _scaler            (o._scaler)
 159         , _dcp_trim_start    (o._dcp_trim_start)
 160         , _dcp_trim_end      (o._dcp_trim_end)
 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         , _dci_metadata      (o._dci_metadata)
 175         , _size              (o._size)
 176         , _length            (o._length)
 177         , _content_digest    (o._content_digest)
 178         , _content_audio_streams (o._content_audio_streams)
 179         , _external_audio_stream (o._external_audio_stream)
 180         , _subtitle_streams  (o._subtitle_streams)
 181         , _frames_per_second (o._frames_per_second)
 182         , _dirty             (o._dirty)
 183 {
 184
 185 }
 186
 187 Film::~Film ()
 188 {
 189         delete _log;
 190 }
 191
 192 /** @return The path to the directory to write JPEG2000 files to */
 193 string
 194 Film::j2k_dir () const
 195 {
 196         assert (format());
 197
 198         boost::filesystem::path p;
 199
 200         /* Start with j2c */
 201         p /= "j2c";
 202
 203         pair<string, string> f = Filter::ffmpeg_strings (filters());
 204
 205         /* Write stuff to specify the filter / post-processing settings that are in use,
 206            so that we don't get confused about J2K files generated using different
 207            settings.
 208         */
 209         stringstream s;
 210         s << format()->id()
 211           << "_" << content_digest()
 212           << "_" << crop().left << "_" << crop().right << "_" << crop().top << "_" << crop().bottom
 213           << "_" << f.first << "_" << f.second
 214           << "_" << scaler()->id()
 215           << "_" << j2k_bandwidth()
 216           << "_" << boost::lexical_cast<int> (colour_lut());
 217
 218         p /= s.str ();
 219
 220         /* Similarly for the A/B case */
 221         if (dcp_ab()) {
 222                 stringstream s;
 223                 pair<string, string> fa = Filter::ffmpeg_strings (Config::instance()->reference_filters());
 224                 s << "ab_" << Config::instance()->reference_scaler()->id() << "_" << fa.first << "_" << fa.second;
 225                 p /= s.str ();
 226         }
 227
 228         return dir (p.string());
 229 }
 230
 231 /** Add suitable Jobs to the JobManager to create a DCP for this Film.
 232  *  @param true to transcode, false to use the WAV and J2K files that are already there.
 233  */
 234 void
 235 Film::make_dcp (bool transcode)
 236 {
 237         set_dci_date_today ();
 238
 239         if (dcp_name().find ("/") != string::npos) {
 240                 throw BadSettingError ("name", "cannot contain slashes");
 241         }
 242
 243         log()->log (String::compose ("DVD-o-matic %1 git %2 using %3", dvdomatic_version, dvdomatic_git_commit, dependency_version_summary()));
 244
 245         {
 246                 char buffer[128];
 247                 gethostname (buffer, sizeof (buffer));
 248                 log()->log (String::compose ("Starting to make DCP on %1", buffer));
 249         }
 250
 251         log()->log (String::compose ("Content is %1; type %2", content_path(), (content_type() == STILL ? "still" : "video")));
 252         log()->log (String::compose ("Content length %1", length().get()));
 253         log()->log (String::compose ("Content digest %1", content_digest()));
 254         log()->log (String::compose ("%1 threads", Config::instance()->num_local_encoding_threads()));
 255         log()->log (String::compose ("J2K bandwidth %1", j2k_bandwidth()));
 256 #ifdef DVDOMATIC_DEBUG
 257         log()->log ("DVD-o-matic built in debug mode.");
 258 #else
 259         log()->log ("DVD-o-matic built in optimised mode.");
 260 #endif
 261 #ifdef LIBDCP_DEBUG
 262         log()->log ("libdcp built in debug mode.");
 263 #else
 264         log()->log ("libdcp built in optimised mode.");
 265 #endif
 266         pair<string, int> const c = cpu_info ();
 267         log()->log (String::compose ("CPU: %1, %2 processors", c.first, c.second));
 268
 269         if (format() == 0) {
 270                 throw MissingSettingError ("format");
 271         }
 272
 273         if (content().empty ()) {
 274                 throw MissingSettingError ("content");
 275         }
 276
 277         if (dcp_content_type() == 0) {
 278                 throw MissingSettingError ("content type");
 279         }
 280
 281         if (name().empty()) {
 282                 throw MissingSettingError ("name");
 283         }
 284
 285         shared_ptr<EncodeOptions> oe (new EncodeOptions (j2k_dir(), ".j2c", dir ("wavs")));
 286         oe->out_size = format()->dcp_size ();
 287         oe->padding = format()->dcp_padding (shared_from_this ());
 288         if (dcp_length ()) {
 289                 oe->video_range = make_pair (dcp_trim_start(), dcp_trim_start() + dcp_length().get());
 290                 if (audio_stream()) {
 291                         oe->audio_range = make_pair (
 292
 293                                 video_frames_to_audio_frames (
 294                                         oe->video_range.get().first,
 295                                         dcp_audio_sample_rate (audio_stream()->sample_rate()),
 296                                         dcp_frame_rate (frames_per_second()).frames_per_second
 297                                         ),
 298
 299                                 video_frames_to_audio_frames (
 300                                         oe->video_range.get().second,
 301                                         dcp_audio_sample_rate (audio_stream()->sample_rate()),
 302                                         dcp_frame_rate (frames_per_second()).frames_per_second
 303                                         )
 304                                 );
 305                 }
 306
 307         }
 308
 309         oe->video_skip = dcp_frame_rate (frames_per_second()).skip;
 310
 311         shared_ptr<DecodeOptions> od (new DecodeOptions);
 312         od->decode_subtitles = with_subtitles ();
 313
 314         shared_ptr<Job> r;
 315
 316         if (transcode) {
 317                 if (dcp_ab()) {
 318                         r = JobManager::instance()->add (shared_ptr<Job> (new ABTranscodeJob (shared_from_this(), od, oe, shared_ptr<Job> ())));
 319                 } else {
 320                         r = JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (shared_from_this(), od, oe, shared_ptr<Job> ())));
 321                 }
 322         }
 323
 324         r = JobManager::instance()->add (shared_ptr<Job> (new CheckHashesJob (shared_from_this(), od, oe, r)));
 325         JobManager::instance()->add (shared_ptr<Job> (new MakeDCPJob (shared_from_this(), oe, r)));
 326 }
 327
 328 /** Start a job to examine our content file */
 329 void
 330 Film::examine_content ()
 331 {
 332         if (_examine_content_job) {
 333                 return;
 334         }
 335
 336         _examine_content_job.reset (new ExamineContentJob (shared_from_this(), shared_ptr<Job> ()));
 337         _examine_content_job->Finished.connect (bind (&Film::examine_content_finished, this));
 338         JobManager::instance()->add (_examine_content_job);
 339 }
 340
 341 void
 342 Film::examine_content_finished ()
 343 {
 344         _examine_content_job.reset ();
 345 }
 346
 347 /** Start a job to send our DCP to the configured TMS */
 348 void
 349 Film::send_dcp_to_tms ()
 350 {
 351         shared_ptr<Job> j (new SCPDCPJob (shared_from_this(), shared_ptr<Job> ()));
 352         JobManager::instance()->add (j);
 353 }
 354
 355 /** Count the number of frames that have been encoded for this film.
 356  *  @return frame count.
 357  */
 358 int
 359 Film::encoded_frames () const
 360 {
 361         if (format() == 0) {
 362                 return 0;
 363         }
 364
 365         int N = 0;
 366         for (boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (j2k_dir ()); i != boost::filesystem::directory_iterator(); ++i) {
 367                 ++N;
 368                 boost::this_thread::interruption_point ();
 369         }
 370
 371         return N;
 372 }
 373
 374 /** Write state to our `metadata' file */
 375 void
 376 Film::write_metadata () const
 377 {
 378         boost::mutex::scoped_lock lm (_state_mutex);
 379
 380         boost::filesystem::create_directories (directory());
 381
 382         string const m = file ("metadata");
 383         ofstream f (m.c_str ());
 384         if (!f.good ()) {
 385                 throw CreateFileError (m);
 386         }
 387
 388         f << "version " << state_version << "\n";
 389
 390         /* User stuff */
 391         f << "name " << _name << "\n";
 392         f << "use_dci_name " << _use_dci_name << "\n";
 393         f << "content " << _content << "\n";
 394         f << "trust_content_header " << (_trust_content_header ? "1" : "0") << "\n";
 395         if (_dcp_content_type) {
 396                 f << "dcp_content_type " << _dcp_content_type->pretty_name () << "\n";
 397         }
 398         if (_format) {
 399                 f << "format " << _format->as_metadata () << "\n";
 400         }
 401         f << "left_crop " << _crop.left << "\n";
 402         f << "right_crop " << _crop.right << "\n";
 403         f << "top_crop " << _crop.top << "\n";
 404         f << "bottom_crop " << _crop.bottom << "\n";
 405         for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
 406                 f << "filter " << (*i)->id () << "\n";
 407         }
 408         f << "scaler " << _scaler->id () << "\n";
 409         f << "dcp_trim_start " << _dcp_trim_start << "\n";
 410         f << "dcp_trim_end " << _dcp_trim_end << "\n";
 411         f << "dcp_ab " << (_dcp_ab ? "1" : "0") << "\n";
 412         if (_content_audio_stream) {
 413                 f << "selected_content_audio_stream " << _content_audio_stream->to_string() << "\n";
 414         }
 415         for (vector<string>::const_iterator i = _external_audio.begin(); i != _external_audio.end(); ++i) {
 416                 f << "external_audio " << *i << "\n";
 417         }
 418         f << "use_content_audio " << (_use_content_audio ? "1" : "0") << "\n";
 419         f << "audio_gain " << _audio_gain << "\n";
 420         f << "audio_delay " << _audio_delay << "\n";
 421         f << "still_duration " << _still_duration << "\n";
 422         if (_subtitle_stream) {
 423                 f << "selected_subtitle_stream " << _subtitle_stream->to_string() << "\n";
 424         }
 425         f << "with_subtitles " << _with_subtitles << "\n";
 426         f << "subtitle_offset " << _subtitle_offset << "\n";
 427         f << "subtitle_scale " << _subtitle_scale << "\n";
 428         f << "colour_lut " << _colour_lut << "\n";
 429         f << "j2k_bandwidth " << _j2k_bandwidth << "\n";
 430         _dci_metadata.write (f);
 431         f << "width " << _size.width << "\n";
 432         f << "height " << _size.height << "\n";
 433         f << "length " << _length.get_value_or(0) << "\n";
 434         f << "content_digest " << _content_digest << "\n";
 435
 436         for (vector<shared_ptr<AudioStream> >::const_iterator i = _content_audio_streams.begin(); i != _content_audio_streams.end(); ++i) {
 437                 f << "content_audio_stream " << (*i)->to_string () << "\n";
 438         }
 439
 440         f << "external_audio_stream " << _external_audio_stream->to_string() << "\n";
 441
 442         for (vector<shared_ptr<SubtitleStream> >::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
 443                 f << "subtitle_stream " << (*i)->to_string () << "\n";
 444         }
 445
 446         f << "frames_per_second " << _frames_per_second << "\n";
 447
 448         _dirty = false;
 449 }
 450
 451 /** Read state from our metadata file */
 452 void
 453 Film::read_metadata ()
 454 {
 455         boost::mutex::scoped_lock lm (_state_mutex);
 456
 457         _external_audio.clear ();
 458         _content_audio_streams.clear ();
 459         _subtitle_streams.clear ();
 460
 461         boost::optional<int> version;
 462
 463         /* Backward compatibility things */
 464         boost::optional<int> audio_sample_rate;
 465         boost::optional<int> audio_stream_index;
 466         boost::optional<int> subtitle_stream_index;
 467
 468         ifstream f (file ("metadata").c_str());
 469         if (!f.good()) {
 470                 throw OpenFileError (file("metadata"));
 471         }
 472
 473         multimap<string, string> kv = read_key_value (f);
 474
 475         /* We need version before anything else */
 476         multimap<string, string>::iterator v = kv.find ("version");
 477         if (v != kv.end ()) {
 478                 version = atoi (v->second.c_str());
 479         }
 480
 481         for (multimap<string, string>::const_iterator i = kv.begin(); i != kv.end(); ++i) {
 482                 string const k = i->first;
 483                 string const v = i->second;
 484
 485                 if (k == "audio_sample_rate") {
 486                         audio_sample_rate = atoi (v.c_str());
 487                 }
 488
 489                 /* User-specified stuff */
 490                 if (k == "name") {
 491                         _name = v;
 492                 } else if (k == "use_dci_name") {
 493                         _use_dci_name = (v == "1");
 494                 } else if (k == "content") {
 495                         _content = v;
 496                 } else if (k == "trust_content_header") {
 497                         _trust_content_header = (v == "1");
 498                 } else if (k == "dcp_content_type") {
 499                         _dcp_content_type = DCPContentType::from_pretty_name (v);
 500                 } else if (k == "format") {
 501                         _format = Format::from_metadata (v);
 502                 } else if (k == "left_crop") {
 503                         _crop.left = atoi (v.c_str ());
 504                 } else if (k == "right_crop") {
 505                         _crop.right = atoi (v.c_str ());
 506                 } else if (k == "top_crop") {
 507                         _crop.top = atoi (v.c_str ());
 508                 } else if (k == "bottom_crop") {
 509                         _crop.bottom = atoi (v.c_str ());
 510                 } else if (k == "filter") {
 511                         _filters.push_back (Filter::from_id (v));
 512                 } else if (k == "scaler") {
 513                         _scaler = Scaler::from_id (v);
 514                 } else if (k == "dcp_trim_start") {
 515                         _dcp_trim_start = atoi (v.c_str ());
 516                 } else if (k == "dcp_trim_end") {
 517                         _dcp_trim_end = atoi (v.c_str ());
 518                 } else if (k == "dcp_ab") {
 519                         _dcp_ab = (v == "1");
 520                 } else if (k == "selected_content_audio_stream" || (!version && k == "selected_audio_stream")) {
 521                         if (!version) {
 522                                 audio_stream_index = atoi (v.c_str ());
 523                         } else {
 524                                 _content_audio_stream = audio_stream_factory (v, version);
 525                         }
 526                 } else if (k == "external_audio") {
 527                         _external_audio.push_back (v);
 528                 } else if (k == "use_content_audio") {
 529                         _use_content_audio = (v == "1");
 530                 } else if (k == "audio_gain") {
 531                         _audio_gain = atof (v.c_str ());
 532                 } else if (k == "audio_delay") {
 533                         _audio_delay = atoi (v.c_str ());
 534                 } else if (k == "still_duration") {
 535                         _still_duration = atoi (v.c_str ());
 536                 } else if (k == "selected_subtitle_stream") {
 537                         if (!version) {
 538                                 subtitle_stream_index = atoi (v.c_str ());
 539                         } else {
 540                                 _subtitle_stream = subtitle_stream_factory (v, version);
 541                         }
 542                 } else if (k == "with_subtitles") {
 543                         _with_subtitles = (v == "1");
 544                 } else if (k == "subtitle_offset") {
 545                         _subtitle_offset = atoi (v.c_str ());
 546                 } else if (k == "subtitle_scale") {
 547                         _subtitle_scale = atof (v.c_str ());
 548                 } else if (k == "colour_lut") {
 549                         _colour_lut = atoi (v.c_str ());
 550                 } else if (k == "j2k_bandwidth") {
 551                         _j2k_bandwidth = atoi (v.c_str ());
 552                 }
 553
 554                 _dci_metadata.read (k, v);
 555
 556                 /* Cached stuff */
 557                 if (k == "width") {
 558                         _size.width = atoi (v.c_str ());
 559                 } else if (k == "height") {
 560                         _size.height = atoi (v.c_str ());
 561                 } else if (k == "length") {
 562                         int const vv = atoi (v.c_str ());
 563                         if (vv) {
 564                                 _length = vv;
 565                         }
 566                 } else if (k == "content_digest") {
 567                         _content_digest = v;
 568                 } else if (k == "content_audio_stream" || (!version && k == "audio_stream")) {
 569                         _content_audio_streams.push_back (audio_stream_factory (v, version));
 570                 } else if (k == "external_audio_stream") {
 571                         _external_audio_stream = audio_stream_factory (v, version);
 572                 } else if (k == "subtitle_stream") {
 573                         _subtitle_streams.push_back (subtitle_stream_factory (v, version));
 574                 } else if (k == "frames_per_second") {
 575                         _frames_per_second = atof (v.c_str ());
 576                 }
 577         }
 578
 579         if (!version) {
 580                 if (audio_sample_rate) {
 581                         /* version < 1 didn't specify sample rate in the audio streams, so fill it in here */
 582                         for (vector<shared_ptr<AudioStream> >::iterator i = _content_audio_streams.begin(); i != _content_audio_streams.end(); ++i) {
 583                                 (*i)->set_sample_rate (audio_sample_rate.get());
 584                         }
 585                 }
 586
 587                 /* also the selected stream was specified as an index */
 588                 if (audio_stream_index && audio_stream_index.get() >= 0 && audio_stream_index.get() < (int) _content_audio_streams.size()) {
 589                         _content_audio_stream = _content_audio_streams[audio_stream_index.get()];
 590                 }
 591
 592                 /* similarly the subtitle */
 593                 if (subtitle_stream_index && subtitle_stream_index.get() >= 0 && subtitle_stream_index.get() < (int) _subtitle_streams.size()) {
 594                         _subtitle_stream = _subtitle_streams[subtitle_stream_index.get()];
 595                 }
 596         }
 597
 598         _dirty = false;
 599 }
 600
 601 libdcp::Size
 602 Film::cropped_size (libdcp::Size s) const
 603 {
 604         boost::mutex::scoped_lock lm (_state_mutex);
 605         s.width -= _crop.left + _crop.right;
 606         s.height -= _crop.top + _crop.bottom;
 607         return s;
 608 }
 609
 610 /** Given a directory name, return its full path within the Film's directory.
 611  *  The directory (and its parents) will be created if they do not exist.
 612  */
 613 string
 614 Film::dir (string d) const
 615 {
 616         boost::mutex::scoped_lock lm (_directory_mutex);
 617         boost::filesystem::path p;
 618         p /= _directory;
 619         p /= d;
 620         boost::filesystem::create_directories (p);
 621         return p.string ();
 622 }
 623
 624 /** Given a file or directory name, return its full path within the Film's directory.
 625  *  _directory_mutex must not be locked on entry.
 626  */
 627 string
 628 Film::file (string f) const
 629 {
 630         boost::mutex::scoped_lock lm (_directory_mutex);
 631         boost::filesystem::path p;
 632         p /= _directory;
 633         p /= f;
 634         return p.string ();
 635 }
 636
 637 /** @return full path of the content (actual video) file
 638  *  of the Film.
 639  */
 640 string
 641 Film::content_path () const
 642 {
 643         boost::mutex::scoped_lock lm (_state_mutex);
 644         if (boost::filesystem::path(_content).has_root_directory ()) {
 645                 return _content;
 646         }
 647
 648         return file (_content);
 649 }
 650
 651 ContentType
 652 Film::content_type () const
 653 {
 654         if (boost::filesystem::is_directory (_content)) {
 655                 /* Directory of images, we assume */
 656                 return VIDEO;
 657         }
 658
 659         if (still_image_file (_content)) {
 660                 return STILL;
 661         }
 662
 663         return VIDEO;
 664 }
 665
 666 /** @return The sampling rate that we will resample the audio to */
 667 int
 668 Film::target_audio_sample_rate () const
 669 {
 670         if (!audio_stream()) {
 671                 return 0;
 672         }
 673
 674         /* Resample to a DCI-approved sample rate */
 675         double t = dcp_audio_sample_rate (audio_stream()->sample_rate());
 676
 677         DCPFrameRate dfr = dcp_frame_rate (frames_per_second ());
 678
 679         /* Compensate for the fact that video will be rounded to the
 680            nearest integer number of frames per second.
 681         */
 682         if (dfr.run_fast) {
 683                 t *= _frames_per_second * dfr.skip / dfr.frames_per_second;
 684         }
 685
 686         return rint (t);
 687 }
 688
 689 boost::optional<int>
 690 Film::dcp_length () const
 691 {
 692         if (content_type() == STILL) {
 693                 return _still_duration * frames_per_second();
 694         }
 695
 696         if (!length()) {
 697                 return boost::optional<int> ();
 698         }
 699
 700         return length().get() - dcp_trim_start() - dcp_trim_end();
 701 }
 702
 703 /** @return a DCI-compliant name for a DCP of this film */
 704 string
 705 Film::dci_name () const
 706 {
 707         stringstream d;
 708
 709         string fixed_name = to_upper_copy (name());
 710         for (size_t i = 0; i < fixed_name.length(); ++i) {
 711                 if (fixed_name[i] == ' ') {
 712                         fixed_name[i] = '-';
 713                 }
 714         }
 715
 716         /* Spec is that the name part should be maximum 14 characters, as I understand it */
 717         if (fixed_name.length() > 14) {
 718                 fixed_name = fixed_name.substr (0, 14);
 719         }
 720
 721         d << fixed_name << "_";
 722
 723         if (dcp_content_type()) {
 724                 d << dcp_content_type()->dci_name() << "_";
 725         }
 726
 727         if (format()) {
 728                 d << format()->dci_name() << "_";
 729         }
 730
 731         DCIMetadata const dm = dci_metadata ();
 732
 733         if (!dm.audio_language.empty ()) {
 734                 d << dm.audio_language;
 735                 if (!dm.subtitle_language.empty() && with_subtitles()) {
 736                         d << "-" << dm.subtitle_language;
 737                 } else {
 738                         d << "-XX";
 739                 }
 740
 741                 d << "_";
 742         }
 743
 744         if (!dm.territory.empty ()) {
 745                 d << dm.territory;
 746                 if (!dm.rating.empty ()) {
 747                         d << "-" << dm.rating;
 748                 }
 749                 d << "_";
 750         }
 751
 752         switch (audio_channels()) {
 753         case 1:
 754                 d << "10_";
 755                 break;
 756         case 2:
 757                 d << "20_";
 758                 break;
 759         case 6:
 760                 d << "51_";
 761                 break;
 762         case 8:
 763                 d << "71_";
 764                 break;
 765         }
 766
 767         d << "2K_";
 768
 769         if (!dm.studio.empty ()) {
 770                 d << dm.studio << "_";
 771         }
 772
 773         d << boost::gregorian::to_iso_string (_dci_date) << "_";
 774
 775         if (!dm.facility.empty ()) {
 776                 d << dm.facility << "_";
 777         }
 778
 779         if (!dm.package_type.empty ()) {
 780                 d << dm.package_type;
 781         }
 782
 783         return d.str ();
 784 }
 785
 786 /** @return name to give the DCP */
 787 string
 788 Film::dcp_name () const
 789 {
 790         if (use_dci_name()) {
 791                 return dci_name ();
 792         }
 793
 794         return name();
 795 }
 796
 797
 798 void
 799 Film::set_directory (string d)
 800 {
 801         boost::mutex::scoped_lock lm (_state_mutex);
 802         _directory = d;
 803         _dirty = true;
 804 }
 805
 806 void
 807 Film::set_name (string n)
 808 {
 809         {
 810                 boost::mutex::scoped_lock lm (_state_mutex);
 811                 _name = n;
 812         }
 813         signal_changed (NAME);
 814 }
 815
 816 void
 817 Film::set_use_dci_name (bool u)
 818 {
 819         {
 820                 boost::mutex::scoped_lock lm (_state_mutex);
 821                 _use_dci_name = u;
 822         }
 823         signal_changed (USE_DCI_NAME);
 824 }
 825
 826 void
 827 Film::set_content (string c)
 828 {
 829         string check = directory ();
 830
 831 #if BOOST_FILESYSTEM_VERSION == 3
 832         boost::filesystem::path slash ("/");
 833         string platform_slash = slash.make_preferred().string ();
 834 #else
 835 #ifdef DVDOMATIC_WINDOWS
 836         string platform_slash = "\\";
 837 #else
 838         string platform_slash = "/";
 839 #endif
 840 #endif
 841
 842         if (!ends_with (check, platform_slash)) {
 843                 check += platform_slash;
 844         }
 845
 846         if (boost::filesystem::path(c).has_root_directory () && starts_with (c, check)) {
 847                 c = c.substr (_directory.length() + 1);
 848         }
 849
 850         string old_content;
 851
 852         {
 853                 boost::mutex::scoped_lock lm (_state_mutex);
 854                 if (c == _content) {
 855                         return;
 856                 }
 857
 858                 old_content = _content;
 859                 _content = c;
 860         }
 861
 862         /* Reset streams here in case the new content doesn't have one or the other */
 863         _content_audio_stream = shared_ptr<AudioStream> ();
 864         _subtitle_stream = shared_ptr<SubtitleStream> ();
 865
 866         /* Start off using content audio */
 867         set_use_content_audio (true);
 868
 869         /* Create a temporary decoder so that we can get information
 870            about the content.
 871         */
 872
 873         try {
 874                 shared_ptr<DecodeOptions> o (new DecodeOptions);
 875                 Decoders d = decoder_factory (shared_from_this(), o, 0);
 876
 877                 set_size (d.video->native_size ());
 878                 set_frames_per_second (d.video->frames_per_second ());
 879                 set_subtitle_streams (d.video->subtitle_streams ());
 880                 if (d.audio) {
 881                         set_content_audio_streams (d.audio->audio_streams ());
 882                 }
 883
 884                 /* Start off with the first audio and subtitle streams */
 885                 if (d.audio && !d.audio->audio_streams().empty()) {
 886                         set_content_audio_stream (d.audio->audio_streams().front());
 887                 }
 888
 889                 if (!d.video->subtitle_streams().empty()) {
 890                         set_subtitle_stream (d.video->subtitle_streams().front());
 891                 }
 892
 893                 {
 894                         boost::mutex::scoped_lock lm (_state_mutex);
 895                         _content = c;
 896                 }
 897
 898                 signal_changed (CONTENT);
 899
 900                 examine_content ();
 901
 902         } catch (...) {
 903
 904                 boost::mutex::scoped_lock lm (_state_mutex);
 905                 _content = old_content;
 906                 throw;
 907
 908         }
 909
 910         /* Default format */
 911         switch (content_type()) {
 912         case STILL:
 913                 set_format (Format::from_id ("var-185"));
 914                 break;
 915         case VIDEO:
 916                 set_format (Format::from_id ("185"));
 917                 break;
 918         }
 919
 920         /* Still image DCPs must use external audio */
 921         if (content_type() == STILL) {
 922                 set_use_content_audio (false);
 923         }
 924 }
 925
 926 void
 927 Film::set_trust_content_header (bool t)
 928 {
 929         {
 930                 boost::mutex::scoped_lock lm (_state_mutex);
 931                 _trust_content_header = t;
 932         }
 933
 934         signal_changed (TRUST_CONTENT_HEADER);
 935
 936         if (!_trust_content_header && !content().empty()) {
 937                 /* We just said that we don't trust the content's header */
 938                 examine_content ();
 939         }
 940 }
 941
 942 void
 943 Film::set_dcp_content_type (DCPContentType const * t)
 944 {
 945         {
 946                 boost::mutex::scoped_lock lm (_state_mutex);
 947                 _dcp_content_type = t;
 948         }
 949         signal_changed (DCP_CONTENT_TYPE);
 950 }
 951
 952 void
 953 Film::set_format (Format const * f)
 954 {
 955         {
 956                 boost::mutex::scoped_lock lm (_state_mutex);
 957                 _format = f;
 958         }
 959         signal_changed (FORMAT);
 960 }
 961
 962 void
 963 Film::set_crop (Crop c)
 964 {
 965         {
 966                 boost::mutex::scoped_lock lm (_state_mutex);
 967                 _crop = c;
 968         }
 969         signal_changed (CROP);
 970 }
 971
 972 void
 973 Film::set_left_crop (int c)
 974 {
 975         {
 976                 boost::mutex::scoped_lock lm (_state_mutex);
 977
 978                 if (_crop.left == c) {
 979                         return;
 980                 }
 981
 982                 _crop.left = c;
 983         }
 984         signal_changed (CROP);
 985 }
 986
 987 void
 988 Film::set_right_crop (int c)
 989 {
 990         {
 991                 boost::mutex::scoped_lock lm (_state_mutex);
 992                 if (_crop.right == c) {
 993                         return;
 994                 }
 995
 996                 _crop.right = c;
 997         }
 998         signal_changed (CROP);
 999 }
1000
1001 void
1002 Film::set_top_crop (int c)
1003 {
1004         {
1005                 boost::mutex::scoped_lock lm (_state_mutex);
1006                 if (_crop.top == c) {
1007                         return;
1008                 }
1009
1010                 _crop.top = c;
1011         }
1012         signal_changed (CROP);
1013 }
1014
1015 void
1016 Film::set_bottom_crop (int c)
1017 {
1018         {
1019                 boost::mutex::scoped_lock lm (_state_mutex);
1020                 if (_crop.bottom == c) {
1021                         return;
1022                 }
1023
1024                 _crop.bottom = c;
1025         }
1026         signal_changed (CROP);
1027 }
1028
1029 void
1030 Film::set_filters (vector<Filter const *> f)
1031 {
1032         {
1033                 boost::mutex::scoped_lock lm (_state_mutex);
1034                 _filters = f;
1035         }
1036         signal_changed (FILTERS);
1037 }
1038
1039 void
1040 Film::set_scaler (Scaler const * s)
1041 {
1042         {
1043                 boost::mutex::scoped_lock lm (_state_mutex);
1044                 _scaler = s;
1045         }
1046         signal_changed (SCALER);
1047 }
1048
1049 void
1050 Film::set_dcp_trim_start (int t)
1051 {
1052         {
1053                 boost::mutex::scoped_lock lm (_state_mutex);
1054                 _dcp_trim_start = t;
1055         }
1056         signal_changed (DCP_TRIM_START);
1057 }
1058
1059 void
1060 Film::set_dcp_trim_end (int t)
1061 {
1062         {
1063                 boost::mutex::scoped_lock lm (_state_mutex);
1064                 _dcp_trim_end = t;
1065         }
1066         signal_changed (DCP_TRIM_END);
1067 }
1068
1069 void
1070 Film::set_dcp_ab (bool a)
1071 {
1072         {
1073                 boost::mutex::scoped_lock lm (_state_mutex);
1074                 _dcp_ab = a;
1075         }
1076         signal_changed (DCP_AB);
1077 }
1078
1079 void
1080 Film::set_content_audio_stream (shared_ptr<AudioStream> s)
1081 {
1082         {
1083                 boost::mutex::scoped_lock lm (_state_mutex);
1084                 _content_audio_stream = s;
1085         }
1086         signal_changed (CONTENT_AUDIO_STREAM);
1087 }
1088
1089 void
1090 Film::set_external_audio (vector<string> a)
1091 {
1092         {
1093                 boost::mutex::scoped_lock lm (_state_mutex);
1094                 _external_audio = a;
1095         }
1096
1097         shared_ptr<DecodeOptions> o (new DecodeOptions);
1098         shared_ptr<ExternalAudioDecoder> decoder (new ExternalAudioDecoder (shared_from_this(), o, 0));
1099         if (decoder->audio_stream()) {
1100                 _external_audio_stream = decoder->audio_stream ();
1101         }
1102
1103         signal_changed (EXTERNAL_AUDIO);
1104 }
1105
1106 void
1107 Film::set_use_content_audio (bool e)
1108 {
1109         {
1110                 boost::mutex::scoped_lock lm (_state_mutex);
1111                 _use_content_audio = e;
1112         }
1113
1114         signal_changed (USE_CONTENT_AUDIO);
1115 }
1116
1117 void
1118 Film::set_audio_gain (float g)
1119 {
1120         {
1121                 boost::mutex::scoped_lock lm (_state_mutex);
1122                 _audio_gain = g;
1123         }
1124         signal_changed (AUDIO_GAIN);
1125 }
1126
1127 void
1128 Film::set_audio_delay (int d)
1129 {
1130         {
1131                 boost::mutex::scoped_lock lm (_state_mutex);
1132                 _audio_delay = d;
1133         }
1134         signal_changed (AUDIO_DELAY);
1135 }
1136
1137 void
1138 Film::set_still_duration (int d)
1139 {
1140         {
1141                 boost::mutex::scoped_lock lm (_state_mutex);
1142                 _still_duration = d;
1143         }
1144         signal_changed (STILL_DURATION);
1145 }
1146
1147 void
1148 Film::set_subtitle_stream (shared_ptr<SubtitleStream> s)
1149 {
1150         {
1151                 boost::mutex::scoped_lock lm (_state_mutex);
1152                 _subtitle_stream = s;
1153         }
1154         signal_changed (SUBTITLE_STREAM);
1155 }
1156
1157 void
1158 Film::set_with_subtitles (bool w)
1159 {
1160         {
1161                 boost::mutex::scoped_lock lm (_state_mutex);
1162                 _with_subtitles = w;
1163         }
1164         signal_changed (WITH_SUBTITLES);
1165 }
1166
1167 void
1168 Film::set_subtitle_offset (int o)
1169 {
1170         {
1171                 boost::mutex::scoped_lock lm (_state_mutex);
1172                 _subtitle_offset = o;
1173         }
1174         signal_changed (SUBTITLE_OFFSET);
1175 }
1176
1177 void
1178 Film::set_subtitle_scale (float s)
1179 {
1180         {
1181                 boost::mutex::scoped_lock lm (_state_mutex);
1182                 _subtitle_scale = s;
1183         }
1184         signal_changed (SUBTITLE_SCALE);
1185 }
1186
1187 void
1188 Film::set_colour_lut (int i)
1189 {
1190         {
1191                 boost::mutex::scoped_lock lm (_state_mutex);
1192                 _colour_lut = i;
1193         }
1194         signal_changed (COLOUR_LUT);
1195 }
1196
1197 void
1198 Film::set_j2k_bandwidth (int b)
1199 {
1200         {
1201                 boost::mutex::scoped_lock lm (_state_mutex);
1202                 _j2k_bandwidth = b;
1203         }
1204         signal_changed (J2K_BANDWIDTH);
1205 }
1206
1207 void
1208 Film::set_dci_metadata (DCIMetadata m)
1209 {
1210         {
1211                 boost::mutex::scoped_lock lm (_state_mutex);
1212                 _dci_metadata = m;
1213         }
1214         signal_changed (DCI_METADATA);
1215 }
1216
1217 void
1218 Film::set_size (libdcp::Size s)
1219 {
1220         {
1221                 boost::mutex::scoped_lock lm (_state_mutex);
1222                 _size = s;
1223         }
1224         signal_changed (SIZE);
1225 }
1226
1227 void
1228 Film::set_length (SourceFrame l)
1229 {
1230         {
1231                 boost::mutex::scoped_lock lm (_state_mutex);
1232                 _length = l;
1233         }
1234         signal_changed (LENGTH);
1235 }
1236
1237 void
1238 Film::unset_length ()
1239 {
1240         {
1241                 boost::mutex::scoped_lock lm (_state_mutex);
1242                 _length = boost::none;
1243         }
1244         signal_changed (LENGTH);
1245 }
1246
1247 void
1248 Film::set_content_digest (string d)
1249 {
1250         {
1251                 boost::mutex::scoped_lock lm (_state_mutex);
1252                 _content_digest = d;
1253         }
1254         _dirty = true;
1255 }
1256
1257 void
1258 Film::set_content_audio_streams (vector<shared_ptr<AudioStream> > s)
1259 {
1260         {
1261                 boost::mutex::scoped_lock lm (_state_mutex);
1262                 _content_audio_streams = s;
1263         }
1264         signal_changed (CONTENT_AUDIO_STREAMS);
1265 }
1266
1267 void
1268 Film::set_subtitle_streams (vector<shared_ptr<SubtitleStream> > s)
1269 {
1270         {
1271                 boost::mutex::scoped_lock lm (_state_mutex);
1272                 _subtitle_streams = s;
1273         }
1274         signal_changed (SUBTITLE_STREAMS);
1275 }
1276
1277 void
1278 Film::set_frames_per_second (float f)
1279 {
1280         {
1281                 boost::mutex::scoped_lock lm (_state_mutex);
1282                 _frames_per_second = f;
1283         }
1284         signal_changed (FRAMES_PER_SECOND);
1285 }
1286
1287 void
1288 Film::signal_changed (Property p)
1289 {
1290         {
1291                 boost::mutex::scoped_lock lm (_state_mutex);
1292                 _dirty = true;
1293         }
1294
1295         if (ui_signaller) {
1296                 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
1297         }
1298 }
1299
1300 int
1301 Film::audio_channels () const
1302 {
1303         shared_ptr<AudioStream> s = audio_stream ();
1304         if (!s) {
1305                 return 0;
1306         }
1307
1308         return s->channels ();
1309 }
1310
1311 void
1312 Film::set_dci_date_today ()
1313 {
1314         _dci_date = boost::gregorian::day_clock::local_day ();
1315 }
1316
1317 boost::shared_ptr<AudioStream>
1318 Film::audio_stream () const
1319 {
1320         if (use_content_audio()) {
1321                 return _content_audio_stream;
1322         }
1323
1324         return _external_audio_stream;
1325 }