src/lib/film.cc

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