src/lib/film.cc

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