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