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