src/lib/film.cc

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