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