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