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                         AudioStream st (v);
 519                         /* check for -1 for backwards compatibility */
 520                         if (st.id() != -1) {
 521                                 _audio_stream = AudioStream (v);
 522                         }
 523                 } else if (k == "external_audio") {
 524                         _external_audio.push_back (v);
 525                 } else if (k == "audio_gain") {
 526                         _audio_gain = atof (v.c_str ());
 527                 } else if (k == "audio_delay") {
 528                         _audio_delay = atoi (v.c_str ());
 529                 } else if (k == "still_duration") {
 530                         _still_duration = atoi (v.c_str ());
 531                 } else if (k == "selected_subtitle_stream") {
 532                         SubtitleStream st (v);
 533                         /* check for -1 for backwards compatibility */
 534                         if (st.id() != -1) {
 535                                 _subtitle_stream = st;
 536                         }
 537                 } else if (k == "with_subtitles") {
 538                         _with_subtitles = (v == "1");
 539                 } else if (k == "subtitle_offset") {
 540                         _subtitle_offset = atoi (v.c_str ());
 541                 } else if (k == "subtitle_scale") {
 542                         _subtitle_scale = atof (v.c_str ());
 543                 } else if (k == "audio_language") {
 544                         _audio_language = v;
 545                 } else if (k == "subtitle_language") {
 546                         _subtitle_language = v;
 547                 } else if (k == "territory") {
 548                         _territory = v;
 549                 } else if (k == "rating") {
 550                         _rating = v;
 551                 } else if (k == "studio") {
 552                         _studio = v;
 553                 } else if (k == "facility") {
 554                         _facility = v;
 555                 } else if (k == "package_type") {
 556                         _package_type = v;
 557                 }
 558
 559                 /* Cached stuff */
 560                 if (k == "thumb") {
 561                         int const n = atoi (v.c_str ());
 562                         /* Only add it to the list if it still exists */
 563                         if (boost::filesystem::exists (thumb_file_for_frame (n))) {
 564                                 _thumbs.push_back (n);
 565                         }
 566                 } else if (k == "width") {
 567                         _size.width = atoi (v.c_str ());
 568                 } else if (k == "height") {
 569                         _size.height = atoi (v.c_str ());
 570                 } else if (k == "length") {
 571                         int const vv = atoi (v.c_str ());
 572                         if (vv) {
 573                                 _length = vv;
 574                         }
 575                 } else if (k == "content_digest") {
 576                         _content_digest = v;
 577                 } else if (k == "audio_stream") {
 578                         _audio_streams.push_back (AudioStream (v));
 579                 } else if (k == "subtitle_stream") {
 580                         _subtitle_streams.push_back (SubtitleStream (v));
 581                 } else if (k == "frames_per_second") {
 582                         _frames_per_second = atof (v.c_str ());
 583                 }
 584         }
 585
 586         _dirty = false;
 587 }
 588
 589 /** @param n A thumb index.
 590  *  @return The path to the thumb's image file.
 591  */
 592 string
 593 Film::thumb_file (int n) const
 594 {
 595         return thumb_file_for_frame (thumb_frame (n));
 596 }
 597
 598 /** @param n A frame index within the Film's source.
 599  *  @return The path to the thumb's image file for this frame;
 600  *  we assume that it exists.
 601  */
 602 string
 603 Film::thumb_file_for_frame (SourceFrame n) const
 604 {
 605         return thumb_base_for_frame(n) + ".png";
 606 }
 607
 608 /** @param n Thumb index.
 609  *  Must not be called with the _state_mutex locked.
 610  */
 611 string
 612 Film::thumb_base (int n) const
 613 {
 614         return thumb_base_for_frame (thumb_frame (n));
 615 }
 616
 617 string
 618 Film::thumb_base_for_frame (SourceFrame n) const
 619 {
 620         stringstream s;
 621         s.width (8);
 622         s << setfill('0') << n;
 623
 624         boost::filesystem::path p;
 625         p /= dir ("thumbs");
 626         p /= s.str ();
 627
 628         return p.string ();
 629 }
 630
 631 /** @param n A thumb index.
 632  *  @return The frame within the Film's source that it is for.
 633  *
 634  *  Must not be called with the _state_mutex locked.
 635  */
 636 SourceFrame
 637 Film::thumb_frame (int n) const
 638 {
 639         boost::mutex::scoped_lock lm (_state_mutex);
 640         assert (n < int (_thumbs.size ()));
 641         return _thumbs[n];
 642 }
 643
 644 Size
 645 Film::cropped_size (Size s) const
 646 {
 647         boost::mutex::scoped_lock lm (_state_mutex);
 648         s.width -= _crop.left + _crop.right;
 649         s.height -= _crop.top + _crop.bottom;
 650         return s;
 651 }
 652
 653 /** Given a directory name, return its full path within the Film's directory.
 654  *  The directory (and its parents) will be created if they do not exist.
 655  */
 656 string
 657 Film::dir (string d) const
 658 {
 659         boost::mutex::scoped_lock lm (_directory_mutex);
 660         boost::filesystem::path p;
 661         p /= _directory;
 662         p /= d;
 663         boost::filesystem::create_directories (p);
 664         return p.string ();
 665 }
 666
 667 /** Given a file or directory name, return its full path within the Film's directory.
 668  *  _directory_mutex must not be locked on entry.
 669  */
 670 string
 671 Film::file (string f) const
 672 {
 673         boost::mutex::scoped_lock lm (_directory_mutex);
 674         boost::filesystem::path p;
 675         p /= _directory;
 676         p /= f;
 677         return p.string ();
 678 }
 679
 680 /** @return full path of the content (actual video) file
 681  *  of the Film.
 682  */
 683 string
 684 Film::content_path () const
 685 {
 686         boost::mutex::scoped_lock lm (_state_mutex);
 687         if (boost::filesystem::path(_content).has_root_directory ()) {
 688                 return _content;
 689         }
 690
 691         return file (_content);
 692 }
 693
 694 ContentType
 695 Film::content_type () const
 696 {
 697         if (boost::filesystem::is_directory (_content)) {
 698                 /* Directory of images, we assume */
 699                 return VIDEO;
 700         }
 701
 702         if (still_image_file (_content)) {
 703                 return STILL;
 704         }
 705
 706         return VIDEO;
 707 }
 708
 709 /** @return The sampling rate that we will resample the audio to */
 710 int
 711 Film::target_audio_sample_rate () const
 712 {
 713         /* Resample to a DCI-approved sample rate */
 714         double t = dcp_audio_sample_rate (audio_stream().get().sample_rate());
 715
 716         DCPFrameRate dfr = dcp_frame_rate (frames_per_second ());
 717
 718         /* Compensate for the fact that video will be rounded to the
 719            nearest integer number of frames per second.
 720         */
 721         if (dfr.run_fast) {
 722                 t *= _frames_per_second * dfr.skip / dfr.frames_per_second;
 723         }
 724
 725         return rint (t);
 726 }
 727
 728 boost::optional<SourceFrame>
 729 Film::dcp_length () const
 730 {
 731         if (!length()) {
 732                 return boost::optional<SourceFrame> ();
 733         }
 734
 735         return length().get() - dcp_trim_start() - dcp_trim_end();
 736 }
 737
 738 /** @return a DCI-compliant name for a DCP of this film */
 739 string
 740 Film::dci_name () const
 741 {
 742         stringstream d;
 743
 744         string fixed_name = to_upper_copy (name());
 745         for (size_t i = 0; i < fixed_name.length(); ++i) {
 746                 if (fixed_name[i] == ' ') {
 747                         fixed_name[i] = '-';
 748                 }
 749         }
 750
 751         /* Spec is that the name part should be maximum 14 characters, as I understand it */
 752         if (fixed_name.length() > 14) {
 753                 fixed_name = fixed_name.substr (0, 14);
 754         }
 755
 756         d << fixed_name << "_";
 757
 758         if (dcp_content_type()) {
 759                 d << dcp_content_type()->dci_name() << "_";
 760         }
 761
 762         if (format()) {
 763                 d << format()->dci_name() << "_";
 764         }
 765
 766         if (!audio_language().empty ()) {
 767                 d << audio_language();
 768                 if (!subtitle_language().empty() && with_subtitles()) {
 769                         d << "-" << subtitle_language();
 770                 } else {
 771                         d << "-XX";
 772                 }
 773
 774                 d << "_";
 775         }
 776
 777         if (!territory().empty ()) {
 778                 d << territory();
 779                 if (!rating().empty ()) {
 780                         d << "-" << rating();
 781                 }
 782                 d << "_";
 783         }
 784
 785         switch (audio_channels()) {
 786         case 1:
 787                 d << "10_";
 788                 break;
 789         case 2:
 790                 d << "20_";
 791                 break;
 792         case 6:
 793                 d << "51_";
 794                 break;
 795         case 8:
 796                 d << "71_";
 797                 break;
 798         }
 799
 800         d << "2K_";
 801
 802         if (!studio().empty ()) {
 803                 d << studio() << "_";
 804         }
 805
 806         d << boost::gregorian::to_iso_string (_dci_date) << "_";
 807
 808         if (!facility().empty ()) {
 809                 d << facility() << "_";
 810         }
 811
 812         if (!package_type().empty ()) {
 813                 d << package_type();
 814         }
 815
 816         return d.str ();
 817 }
 818
 819 /** @return name to give the DCP */
 820 string
 821 Film::dcp_name () const
 822 {
 823         if (use_dci_name()) {
 824                 return dci_name ();
 825         }
 826
 827         return name();
 828 }
 829
 830
 831 void
 832 Film::set_directory (string d)
 833 {
 834         boost::mutex::scoped_lock lm (_state_mutex);
 835         _directory = d;
 836         _dirty = true;
 837 }
 838
 839 void
 840 Film::set_name (string n)
 841 {
 842         {
 843                 boost::mutex::scoped_lock lm (_state_mutex);
 844                 _name = n;
 845         }
 846         signal_changed (NAME);
 847 }
 848
 849 void
 850 Film::set_use_dci_name (bool u)
 851 {
 852         {
 853                 boost::mutex::scoped_lock lm (_state_mutex);
 854                 _use_dci_name = u;
 855         }
 856         signal_changed (USE_DCI_NAME);
 857 }
 858
 859 void
 860 Film::set_content (string c)
 861 {
 862         string check = directory ();
 863
 864 #if BOOST_FILESYSTEM_VERSION == 3
 865         boost::filesystem::path slash ("/");
 866         string platform_slash = slash.make_preferred().string ();
 867 #else
 868 #ifdef DVDOMATIC_WINDOWS
 869         string platform_slash = "\\";
 870 #else
 871         string platform_slash = "/";
 872 #endif
 873 #endif
 874
 875         if (!ends_with (check, platform_slash)) {
 876                 check += platform_slash;
 877         }
 878
 879         if (boost::filesystem::path(c).has_root_directory () && starts_with (c, check)) {
 880                 c = c.substr (_directory.length() + 1);
 881         }
 882
 883         string old_content;
 884
 885         {
 886                 boost::mutex::scoped_lock lm (_state_mutex);
 887                 if (c == _content) {
 888                         return;
 889                 }
 890
 891                 old_content = _content;
 892                 _content = c;
 893         }
 894
 895         _audio_stream = optional<AudioStream> ();
 896         _subtitle_stream = optional<SubtitleStream> ();
 897
 898         /* Create a temporary decoder so that we can get information
 899            about the content.
 900         */
 901
 902         try {
 903                 shared_ptr<Options> o (new Options ("", "", ""));
 904                 o->out_size = Size (1024, 1024);
 905
 906                 shared_ptr<Decoder> d = decoder_factory (shared_from_this(), o, 0);
 907
 908                 set_size (d->native_size ());
 909                 set_frames_per_second (d->frames_per_second ());
 910                 set_audio_streams (d->audio_streams ());
 911                 set_subtitle_streams (d->subtitle_streams ());
 912
 913                 /* Start off with the first audio and subtitle streams */
 914                 if (!d->audio_streams().empty()) {
 915                         set_audio_stream (d->audio_streams().front());
 916                 }
 917
 918                 if (!d->subtitle_streams().empty()) {
 919                         set_subtitle_stream (d->subtitle_streams().front());
 920                 }
 921
 922                 {
 923                         boost::mutex::scoped_lock lm (_state_mutex);
 924                         _content = c;
 925                 }
 926
 927                 signal_changed (CONTENT);
 928
 929                 set_content_digest (md5_digest (content_path ()));
 930
 931                 examine_content ();
 932
 933         } catch (...) {
 934
 935                 boost::mutex::scoped_lock lm (_state_mutex);
 936                 _content = old_content;
 937                 throw;
 938
 939         }
 940 }
 941
 942 void
 943 Film::set_dcp_content_type (DCPContentType const * t)
 944 {
 945         {
 946                 boost::mutex::scoped_lock lm (_state_mutex);
 947                 _dcp_content_type = t;
 948         }
 949         signal_changed (DCP_CONTENT_TYPE);
 950 }
 951
 952 void
 953 Film::set_format (Format const * f)
 954 {
 955         {
 956                 boost::mutex::scoped_lock lm (_state_mutex);
 957                 _format = f;
 958         }
 959         signal_changed (FORMAT);
 960 }
 961
 962 void
 963 Film::set_crop (Crop c)
 964 {
 965         {
 966                 boost::mutex::scoped_lock lm (_state_mutex);
 967                 _crop = c;
 968         }
 969         signal_changed (CROP);
 970 }
 971
 972 void
 973 Film::set_left_crop (int c)
 974 {
 975         {
 976                 boost::mutex::scoped_lock lm (_state_mutex);
 977
 978                 if (_crop.left == c) {
 979                         return;
 980                 }
 981
 982                 _crop.left = c;
 983         }
 984         signal_changed (CROP);
 985 }
 986
 987 void
 988 Film::set_right_crop (int c)
 989 {
 990         {
 991                 boost::mutex::scoped_lock lm (_state_mutex);
 992                 if (_crop.right == c) {
 993                         return;
 994                 }
 995
 996                 _crop.right = c;
 997         }
 998         signal_changed (CROP);
 999 }
1000
1001 void
1002 Film::set_top_crop (int c)
1003 {
1004         {
1005                 boost::mutex::scoped_lock lm (_state_mutex);
1006                 if (_crop.top == c) {
1007                         return;
1008                 }
1009
1010                 _crop.top = c;
1011         }
1012         signal_changed (CROP);
1013 }
1014
1015 void
1016 Film::set_bottom_crop (int c)
1017 {
1018         {
1019                 boost::mutex::scoped_lock lm (_state_mutex);
1020                 if (_crop.bottom == c) {
1021                         return;
1022                 }
1023
1024                 _crop.bottom = c;
1025         }
1026         signal_changed (CROP);
1027 }
1028
1029 void
1030 Film::set_filters (vector<Filter const *> f)
1031 {
1032         {
1033                 boost::mutex::scoped_lock lm (_state_mutex);
1034                 _filters = f;
1035         }
1036         signal_changed (FILTERS);
1037 }
1038
1039 void
1040 Film::set_scaler (Scaler const * s)
1041 {
1042         {
1043                 boost::mutex::scoped_lock lm (_state_mutex);
1044                 _scaler = s;
1045         }
1046         signal_changed (SCALER);
1047 }
1048
1049 void
1050 Film::set_dcp_trim_start (int t)
1051 {
1052         {
1053                 boost::mutex::scoped_lock lm (_state_mutex);
1054                 _dcp_trim_start = t;
1055         }
1056         signal_changed (DCP_TRIM_START);
1057 }
1058
1059 void
1060 Film::set_dcp_trim_end (int t)
1061 {
1062         {
1063                 boost::mutex::scoped_lock lm (_state_mutex);
1064                 _dcp_trim_end = t;
1065         }
1066         signal_changed (DCP_TRIM_END);
1067 }
1068
1069 void
1070 Film::set_dcp_ab (bool a)
1071 {
1072         {
1073                 boost::mutex::scoped_lock lm (_state_mutex);
1074                 _dcp_ab = a;
1075         }
1076         signal_changed (DCP_AB);
1077 }
1078
1079 void
1080 Film::set_use_content_audio (bool s)
1081 {
1082         {
1083                 boost::mutex::scoped_lock lm (_state_mutex);
1084                 _use_content_audio = s;
1085         }
1086         signal_changed (USE_CONTENT_AUDIO);
1087 }
1088
1089 void
1090 Film::set_audio_stream (optional<AudioStream> s)
1091 {
1092         {
1093                 boost::mutex::scoped_lock lm (_state_mutex);
1094                 _audio_stream = s;
1095         }
1096         signal_changed (AUDIO_STREAM);
1097 }
1098
1099 void
1100 Film::set_external_audio (vector<string> a)
1101 {
1102         {
1103                 boost::mutex::scoped_lock lm (_state_mutex);
1104                 _external_audio = a;
1105         }
1106         signal_changed (EXTERNAL_AUDIO);
1107 }
1108
1109 void
1110 Film::set_audio_gain (float g)
1111 {
1112         {
1113                 boost::mutex::scoped_lock lm (_state_mutex);
1114                 _audio_gain = g;
1115         }
1116         signal_changed (AUDIO_GAIN);
1117 }
1118
1119 void
1120 Film::set_audio_delay (int d)
1121 {
1122         {
1123                 boost::mutex::scoped_lock lm (_state_mutex);
1124                 _audio_delay = d;
1125         }
1126         signal_changed (AUDIO_DELAY);
1127 }
1128
1129 void
1130 Film::set_still_duration (int d)
1131 {
1132         {
1133                 boost::mutex::scoped_lock lm (_state_mutex);
1134                 _still_duration = d;
1135         }
1136         signal_changed (STILL_DURATION);
1137 }
1138
1139 void
1140 Film::set_subtitle_stream (optional<SubtitleStream> s)
1141 {
1142         {
1143                 boost::mutex::scoped_lock lm (_state_mutex);
1144                 _subtitle_stream = s;
1145         }
1146         signal_changed (SUBTITLE_STREAM);
1147 }
1148
1149 void
1150 Film::set_with_subtitles (bool w)
1151 {
1152         {
1153                 boost::mutex::scoped_lock lm (_state_mutex);
1154                 _with_subtitles = w;
1155         }
1156         signal_changed (WITH_SUBTITLES);
1157 }
1158
1159 void
1160 Film::set_subtitle_offset (int o)
1161 {
1162         {
1163                 boost::mutex::scoped_lock lm (_state_mutex);
1164                 _subtitle_offset = o;
1165         }
1166         signal_changed (SUBTITLE_OFFSET);
1167 }
1168
1169 void
1170 Film::set_subtitle_scale (float s)
1171 {
1172         {
1173                 boost::mutex::scoped_lock lm (_state_mutex);
1174                 _subtitle_scale = s;
1175         }
1176         signal_changed (SUBTITLE_SCALE);
1177 }
1178
1179 void
1180 Film::set_audio_language (string l)
1181 {
1182         {
1183                 boost::mutex::scoped_lock lm (_state_mutex);
1184                 _audio_language = l;
1185         }
1186         signal_changed (DCI_METADATA);
1187 }
1188
1189 void
1190 Film::set_subtitle_language (string l)
1191 {
1192         {
1193                 boost::mutex::scoped_lock lm (_state_mutex);
1194                 _subtitle_language = l;
1195         }
1196         signal_changed (DCI_METADATA);
1197 }
1198
1199 void
1200 Film::set_territory (string t)
1201 {
1202         {
1203                 boost::mutex::scoped_lock lm (_state_mutex);
1204                 _territory = t;
1205         }
1206         signal_changed (DCI_METADATA);
1207 }
1208
1209 void
1210 Film::set_rating (string r)
1211 {
1212         {
1213                 boost::mutex::scoped_lock lm (_state_mutex);
1214                 _rating = r;
1215         }
1216         signal_changed (DCI_METADATA);
1217 }
1218
1219 void
1220 Film::set_studio (string s)
1221 {
1222         {
1223                 boost::mutex::scoped_lock lm (_state_mutex);
1224                 _studio = s;
1225         }
1226         signal_changed (DCI_METADATA);
1227 }
1228
1229 void
1230 Film::set_facility (string f)
1231 {
1232         {
1233                 boost::mutex::scoped_lock lm (_state_mutex);
1234                 _facility = f;
1235         }
1236         signal_changed (DCI_METADATA);
1237 }
1238
1239 void
1240 Film::set_package_type (string p)
1241 {
1242         {
1243                 boost::mutex::scoped_lock lm (_state_mutex);
1244                 _package_type = p;
1245         }
1246         signal_changed (DCI_METADATA);
1247 }
1248
1249 void
1250 Film::set_thumbs (vector<SourceFrame> t)
1251 {
1252         {
1253                 boost::mutex::scoped_lock lm (_state_mutex);
1254                 _thumbs = t;
1255         }
1256         signal_changed (THUMBS);
1257 }
1258
1259 void
1260 Film::set_size (Size s)
1261 {
1262         {
1263                 boost::mutex::scoped_lock lm (_state_mutex);
1264                 _size = s;
1265         }
1266         signal_changed (SIZE);
1267 }
1268
1269 void
1270 Film::set_length (SourceFrame l)
1271 {
1272         {
1273                 boost::mutex::scoped_lock lm (_state_mutex);
1274                 _length = l;
1275         }
1276         signal_changed (LENGTH);
1277 }
1278
1279 void
1280 Film::unset_length ()
1281 {
1282         {
1283                 boost::mutex::scoped_lock lm (_state_mutex);
1284                 _length = boost::none;
1285         }
1286         signal_changed (LENGTH);
1287 }
1288
1289 void
1290 Film::set_content_digest (string d)
1291 {
1292         {
1293                 boost::mutex::scoped_lock lm (_state_mutex);
1294                 _content_digest = d;
1295         }
1296         _dirty = true;
1297 }
1298
1299 void
1300 Film::set_audio_streams (vector<AudioStream> s)
1301 {
1302         {
1303                 boost::mutex::scoped_lock lm (_state_mutex);
1304                 _audio_streams = s;
1305         }
1306         _dirty = true;
1307 }
1308
1309 void
1310 Film::set_subtitle_streams (vector<SubtitleStream> s)
1311 {
1312         {
1313                 boost::mutex::scoped_lock lm (_state_mutex);
1314                 _subtitle_streams = s;
1315         }
1316         _dirty = true;
1317 }
1318
1319 void
1320 Film::set_frames_per_second (float f)
1321 {
1322         {
1323                 boost::mutex::scoped_lock lm (_state_mutex);
1324                 _frames_per_second = f;
1325         }
1326         signal_changed (FRAMES_PER_SECOND);
1327 }
1328
1329 void
1330 Film::signal_changed (Property p)
1331 {
1332         {
1333                 boost::mutex::scoped_lock lm (_state_mutex);
1334                 _dirty = true;
1335         }
1336
1337         if (ui_signaller) {
1338                 ui_signaller->emit (boost::bind (boost::ref (Changed), p));
1339         }
1340 }
1341
1342 int
1343 Film::audio_channels () const
1344 {
1345         boost::mutex::scoped_lock lm (_state_mutex);
1346
1347         if (_use_content_audio) {
1348                 if (_audio_stream) {
1349                         return _audio_stream.get().channels ();
1350                 }
1351         } else {
1352                 int last_filled = -1;
1353                 for (size_t i = 0; i < _external_audio.size(); ++i) {
1354                         if (!_external_audio[i].empty()) {
1355                                 last_filled = i;
1356                         }
1357                 }
1358
1359                 return last_filled + 1;
1360         }
1361
1362         return 0;
1363 }
1364
1365 void
1366 Film::set_dci_date_today ()
1367 {
1368         _dci_date = boost::gregorian::day_clock::local_day ();
1369 }
1370