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 <fstream>
  23 #include <cstdlib>
  24 #include <sstream>
  25 #include <iomanip>
  26 #include <unistd.h>
  27 #include <boost/filesystem.hpp>
  28 #include <boost/algorithm/string.hpp>
  29 #include "film.h"
  30 #include "format.h"
  31 #include "tiff_encoder.h"
  32 #include "job.h"
  33 #include "filter.h"
  34 #include "transcoder.h"
  35 #include "util.h"
  36 #include "job_manager.h"
  37 #include "ab_transcode_job.h"
  38 #include "transcode_job.h"
  39 #include "scp_dcp_job.h"
  40 #include "copy_from_dvd_job.h"
  41 #include "make_dcp_job.h"
  42 #include "film_state.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
  51 using namespace std;
  52 using namespace boost;
  53
  54 /** Construct a Film object in a given directory, reading any metadata
  55  *  file that exists in that directory.  An exception will be thrown if
  56  *  must_exist is true, and the specified directory does not exist.
  57  *
  58  *  @param d Film directory.
  59  *  @param must_exist true to throw an exception if does not exist.
  60  */
  61
  62 Film::Film (string d, bool must_exist)
  63         : _dirty (false)
  64 {
  65         /* Make _state.directory a complete path without ..s (where possible)
  66            (Code swiped from Adam Bowen on stackoverflow)
  67         */
  68
  69         filesystem::path p (filesystem::system_complete (d));
  70         filesystem::path result;
  71         for(filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
  72                 if (*i == "..") {
  73                         if (filesystem::is_symlink (result) || result.filename() == "..") {
  74                                 result /= *i;
  75                         } else {
  76                                 result = result.parent_path ();
  77                         }
  78                 } else if (*i != ".") {
  79                         result /= *i;
  80                 }
  81         }
  82
  83         _state.directory = result.string ();
  84
  85         if (must_exist && !filesystem::exists (_state.directory)) {
  86                 throw OpenFileError (_state.directory);
  87         }
  88
  89         read_metadata ();
  90
  91         _log = new Log (_state.file ("log"));
  92 }
  93
  94 /** Copy constructor */
  95 Film::Film (Film const & other)
  96         : _state (other._state)
  97         , _dirty (other._dirty)
  98 {
  99
 100 }
 101
 102 Film::~Film ()
 103 {
 104         delete _log;
 105 }
 106
 107 /** Read the `metadata' file inside this Film's directory, and fill the
 108  *  object's data with its content.
 109  */
 110
 111 void
 112 Film::read_metadata ()
 113 {
 114         ifstream f (metadata_file().c_str ());
 115         string line;
 116         while (getline (f, line)) {
 117                 if (line.empty ()) {
 118                         continue;
 119                 }
 120
 121                 if (line[0] == '#') {
 122                         continue;
 123                 }
 124
 125                 size_t const s = line.find (' ');
 126                 if (s == string::npos) {
 127                         continue;
 128                 }
 129
 130                 _state.read_metadata (line.substr (0, s), line.substr (s + 1));
 131         }
 132
 133         _dirty = false;
 134 }
 135
 136 /** Write our state to a file `metadata' inside the Film's directory */
 137 void
 138 Film::write_metadata () const
 139 {
 140         filesystem::create_directories (_state.directory);
 141
 142         ofstream f (metadata_file().c_str ());
 143         if (!f.good ()) {
 144                 throw CreateFileError (metadata_file ());
 145         }
 146
 147         _state.write_metadata (f);
 148
 149         _dirty = false;
 150 }
 151
 152 /** Set the name by which DVD-o-matic refers to this Film */
 153 void
 154 Film::set_name (string n)
 155 {
 156         _state.name = n;
 157         signal_changed (NAME);
 158 }
 159
 160 /** Set the content file for this film.
 161  *  @param c New content file; if specified as an absolute path, the content should
 162  *  be within the film's _state.directory; if specified as a relative path, the content
 163  *  will be assumed to be within the film's _state.directory.
 164  */
 165 void
 166 Film::set_content (string c)
 167 {
 168         if (filesystem::path(c).has_root_directory () && starts_with (c, _state.directory)) {
 169                 c = c.substr (_state.directory.length() + 1);
 170         }
 171
 172         if (c == _state.content) {
 173                 return;
 174         }
 175
 176         /* Create a temporary decoder so that we can get information
 177            about the content.
 178         */
 179         shared_ptr<FilmState> s = state_copy ();
 180         s->content = c;
 181         shared_ptr<Options> o (new Options ("", "", ""));
 182         o->out_size = Size (1024, 1024);
 183
 184         shared_ptr<Decoder> d = decoder_factory (s, o, 0, _log);
 185
 186         _state.size = d->native_size ();
 187         _state.length = d->length_in_frames ();
 188         _state.frames_per_second = d->frames_per_second ();
 189         _state.audio_channels = d->audio_channels ();
 190         _state.audio_sample_rate = d->audio_sample_rate ();
 191         _state.audio_sample_format = d->audio_sample_format ();
 192
 193         _state.content_digest = md5_digest (c);
 194         _state.content = c;
 195
 196         signal_changed (SIZE);
 197         signal_changed (LENGTH);
 198         signal_changed (FRAMES_PER_SECOND);
 199         signal_changed (AUDIO_CHANNELS);
 200         signal_changed (AUDIO_SAMPLE_RATE);
 201         signal_changed (CONTENT);
 202 }
 203
 204 /** Set the format that this Film should be shown in */
 205 void
 206 Film::set_format (Format const * f)
 207 {
 208         _state.format = f;
 209         signal_changed (FORMAT);
 210 }
 211
 212 /** Set the type to specify the DCP as having
 213  *  (feature, trailer etc.)
 214  */
 215 void
 216 Film::set_dcp_content_type (DCPContentType const * t)
 217 {
 218         _state.dcp_content_type = t;
 219         signal_changed (DCP_CONTENT_TYPE);
 220 }
 221
 222 /** Set the number of pixels by which to crop the left of the source video */
 223 void
 224 Film::set_left_crop (int c)
 225 {
 226         if (c == _state.left_crop) {
 227                 return;
 228         }
 229
 230         _state.left_crop = c;
 231         signal_changed (LEFT_CROP);
 232 }
 233
 234 /** Set the number of pixels by which to crop the right of the source video */
 235 void
 236 Film::set_right_crop (int c)
 237 {
 238         if (c == _state.right_crop) {
 239                 return;
 240         }
 241
 242         _state.right_crop = c;
 243         signal_changed (RIGHT_CROP);
 244 }
 245
 246 /** Set the number of pixels by which to crop the top of the source video */
 247 void
 248 Film::set_top_crop (int c)
 249 {
 250         if (c == _state.top_crop) {
 251                 return;
 252         }
 253
 254         _state.top_crop = c;
 255         signal_changed (TOP_CROP);
 256 }
 257
 258 /** Set the number of pixels by which to crop the bottom of the source video */
 259 void
 260 Film::set_bottom_crop (int c)
 261 {
 262         if (c == _state.bottom_crop) {
 263                 return;
 264         }
 265
 266         _state.bottom_crop = c;
 267         signal_changed (BOTTOM_CROP);
 268 }
 269
 270 /** Set the filters to apply to the image when generating thumbnails
 271  *  or a DCP.
 272  */
 273 void
 274 Film::set_filters (vector<Filter const *> const & f)
 275 {
 276         _state.filters = f;
 277         signal_changed (FILTERS);
 278 }
 279
 280 /** Set the number of frames to put in any generated DCP (from
 281  *  the start of the film).  0 indicates that all frames should
 282  *  be used.
 283  */
 284 void
 285 Film::set_dcp_frames (int n)
 286 {
 287         _state.dcp_frames = n;
 288         signal_changed (DCP_FRAMES);
 289 }
 290
 291 void
 292 Film::set_dcp_trim_action (TrimAction a)
 293 {
 294         _state.dcp_trim_action = a;
 295         signal_changed (DCP_TRIM_ACTION);
 296 }
 297
 298 /** Set whether or not to generate a A/B comparison DCP.
 299  *  Such a DCP has the left half of its frame as the Film
 300  *  content without any filtering or post-processing; the
 301  *  right half is rendered with filters and post-processing.
 302  */
 303 void
 304 Film::set_dcp_ab (bool a)
 305 {
 306         _state.dcp_ab = a;
 307         signal_changed (DCP_AB);
 308 }
 309
 310 void
 311 Film::set_audio_gain (float g)
 312 {
 313         _state.audio_gain = g;
 314         signal_changed (AUDIO_GAIN);
 315 }
 316
 317 void
 318 Film::set_audio_delay (int d)
 319 {
 320         _state.audio_delay = d;
 321         signal_changed (AUDIO_DELAY);
 322 }
 323
 324 /** @return path of metadata file */
 325 string
 326 Film::metadata_file () const
 327 {
 328         return _state.file ("metadata");
 329 }
 330
 331 /** @return full path of the content (actual video) file
 332  *  of this Film.
 333  */
 334 string
 335 Film::content () const
 336 {
 337         return _state.content_path ();
 338 }
 339
 340 /** The pre-processing GUI part of a thumbs update.
 341  *  Must be called from the GUI thread.
 342  */
 343 void
 344 Film::update_thumbs_pre_gui ()
 345 {
 346         _state.thumbs.clear ();
 347         filesystem::remove_all (_state.dir ("thumbs"));
 348
 349         /* This call will recreate the directory */
 350         _state.dir ("thumbs");
 351 }
 352
 353 /** The post-processing GUI part of a thumbs update.
 354  *  Must be called from the GUI thread.
 355  */
 356 void
 357 Film::update_thumbs_post_gui ()
 358 {
 359         string const tdir = _state.dir ("thumbs");
 360
 361         for (filesystem::directory_iterator i = filesystem::directory_iterator (tdir); i != filesystem::directory_iterator(); ++i) {
 362
 363                 /* Aah, the sweet smell of progress */
 364 #if BOOST_FILESYSTEM_VERSION == 3
 365                 string const l = filesystem::path(*i).leaf().generic_string();
 366 #else
 367                 string const l = i->leaf ();
 368 #endif
 369
 370                 size_t const d = l.find (".tiff");
 371                 if (d != string::npos) {
 372                         _state.thumbs.push_back (atoi (l.substr (0, d).c_str()));
 373                 }
 374         }
 375
 376         sort (_state.thumbs.begin(), _state.thumbs.end());
 377
 378         write_metadata ();
 379         signal_changed (THUMBS);
 380 }
 381
 382 /** @return the number of thumbnail images that we have */
 383 int
 384 Film::num_thumbs () const
 385 {
 386         return _state.thumbs.size ();
 387 }
 388
 389 /** @param n A thumb index.
 390  *  @return The frame within the Film that it is for.
 391  */
 392 int
 393 Film::thumb_frame (int n) const
 394 {
 395         return _state.thumb_frame (n);
 396 }
 397
 398 /** @param n A thumb index.
 399  *  @return The path to the thumb's image file.
 400  */
 401 string
 402 Film::thumb_file (int n) const
 403 {
 404         return _state.thumb_file (n);
 405 }
 406
 407 /** @return The path to the directory to write JPEG2000 files to */
 408 string
 409 Film::j2k_dir () const
 410 {
 411         assert (format());
 412
 413         filesystem::path p;
 414
 415
 416         /* Start with j2c */
 417         p /= "j2c";
 418
 419         pair<string, string> f = Filter::ffmpeg_strings (filters ());
 420
 421         /* Write stuff to specify the filter / post-processing settings that are in use,
 422            so that we don't get confused about J2K files generated using different
 423            settings.
 424         */
 425         stringstream s;
 426         s << _state.format->id()
 427           << "_" << _state.content_digest
 428           << "_" << left_crop() << "_" << right_crop() << "_" << top_crop() << "_" << bottom_crop()
 429           << "_" << f.first << "_" << f.second
 430           << "_" << _state.scaler->id();
 431
 432         p /= s.str ();
 433
 434         /* Similarly for the A/B case */
 435         if (dcp_ab()) {
 436                 stringstream s;
 437                 pair<string, string> fa = Filter::ffmpeg_strings (Config::instance()->reference_filters());
 438                 s << "ab_" << Config::instance()->reference_scaler()->id() << "_" << fa.first << "_" << fa.second;
 439                 p /= s.str ();
 440         }
 441
 442         return _state.dir (p.string ());
 443 }
 444
 445 /** Handle a change to the Film's metadata */
 446 void
 447 Film::signal_changed (Property p)
 448 {
 449         _dirty = true;
 450         Changed (p);
 451 }
 452
 453 /** Add suitable Jobs to the JobManager to create a DCP for this Film.
 454  *  @param true to transcode, false to use the WAV and J2K files that are already there.
 455  */
 456 void
 457 Film::make_dcp (bool transcode, int freq)
 458 {
 459         string const t = name ();
 460         if (t.find ("/") != string::npos) {
 461                 throw BadSettingError ("name", "cannot contain slashes");
 462         }
 463
 464         {
 465                 stringstream s;
 466                 s << "DVD-o-matic " << DVDOMATIC_VERSION << " using " << dependency_version_summary ();
 467                 log()->log (s.str ());
 468         }
 469
 470         {
 471                 char buffer[128];
 472                 gethostname (buffer, sizeof (buffer));
 473                 stringstream s;
 474                 s << "Starting to make a DCP on " << buffer;
 475                 log()->log (s.str ());
 476         }
 477
 478         if (format() == 0) {
 479                 throw MissingSettingError ("format");
 480         }
 481
 482         if (content().empty ()) {
 483                 throw MissingSettingError ("content");
 484         }
 485
 486         if (dcp_content_type() == 0) {
 487                 throw MissingSettingError ("content type");
 488         }
 489
 490         if (name().empty()) {
 491                 throw MissingSettingError ("name");
 492         }
 493
 494         shared_ptr<const FilmState> fs = state_copy ();
 495         shared_ptr<Options> o (new Options (j2k_dir(), ".j2c", _state.dir ("wavs")));
 496         o->out_size = format()->dcp_size ();
 497         if (dcp_frames() == 0) {
 498                 /* Decode the whole film, no blacking */
 499                 o->num_frames = 0;
 500                 o->black_after = 0;
 501         } else {
 502                 switch (dcp_trim_action()) {
 503                 case CUT:
 504                         /* Decode only part of the film, no blacking */
 505                         o->num_frames = dcp_frames ();
 506                         o->black_after = 0;
 507                         break;
 508                 case BLACK_OUT:
 509                         /* Decode the whole film, but black some frames out */
 510                         o->num_frames = 0;
 511                         o->black_after = dcp_frames ();
 512                 }
 513         }
 514
 515         o->decode_video_frequency = freq;
 516         o->padding = format()->dcp_padding ();
 517         o->ratio = format()->ratio_as_float ();
 518
 519         if (transcode) {
 520                 if (_state.dcp_ab) {
 521                         JobManager::instance()->add (shared_ptr<Job> (new ABTranscodeJob (fs, o, log ())));
 522                 } else {
 523                         JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (fs, o, log ())));
 524                 }
 525         }
 526
 527         JobManager::instance()->add (shared_ptr<Job> (new MakeDCPJob (fs, o, log ())));
 528 }
 529
 530 shared_ptr<FilmState>
 531 Film::state_copy () const
 532 {
 533         return shared_ptr<FilmState> (new FilmState (_state));
 534 }
 535
 536 void
 537 Film::copy_from_dvd_post_gui ()
 538 {
 539         const string dvd_dir = _state.dir ("dvd");
 540
 541         string largest_file;
 542         uintmax_t largest_size = 0;
 543         for (filesystem::directory_iterator i = filesystem::directory_iterator (dvd_dir); i != filesystem::directory_iterator(); ++i) {
 544                 uintmax_t const s = filesystem::file_size (*i);
 545                 if (s > largest_size) {
 546
 547 #if BOOST_FILESYSTEM_VERSION == 3
 548                         largest_file = filesystem::path(*i).generic_string();
 549 #else
 550                         largest_file = i->string ();
 551 #endif
 552                         largest_size = s;
 553                 }
 554         }
 555
 556         set_content (largest_file);
 557 }
 558
 559 void
 560 Film::examine_content ()
 561 {
 562         if (_examine_content_job) {
 563                 return;
 564         }
 565
 566         _examine_content_job.reset (new ExamineContentJob (state_copy (), log ()));
 567         _examine_content_job->Finished.connect (sigc::mem_fun (*this, &Film::examine_content_post_gui));
 568         JobManager::instance()->add (_examine_content_job);
 569 }
 570
 571 void
 572 Film::examine_content_post_gui ()
 573 {
 574         _state.length = _examine_content_job->last_video_frame ();
 575         signal_changed (LENGTH);
 576
 577         _examine_content_job.reset ();
 578 }
 579
 580 void
 581 Film::set_scaler (Scaler const * s)
 582 {
 583         _state.scaler = s;
 584         signal_changed (SCALER);
 585 }
 586
 587 void
 588 Film::set_frames_per_second (float f)
 589 {
 590         _state.frames_per_second = f;
 591         signal_changed (FRAMES_PER_SECOND);
 592 }
 593
 594 /** @return full paths to any audio files that this Film has */
 595 vector<string>
 596 Film::audio_files () const
 597 {
 598         vector<string> f;
 599         for (filesystem::directory_iterator i = filesystem::directory_iterator (_state.dir("wavs")); i != filesystem::directory_iterator(); ++i) {
 600                 f.push_back (i->path().string ());
 601         }
 602
 603         return f;
 604 }
 605
 606 ContentType
 607 Film::content_type () const
 608 {
 609         return _state.content_type ();
 610 }
 611
 612 void
 613 Film::set_still_duration (int d)
 614 {
 615         _state.still_duration = d;
 616         signal_changed (STILL_DURATION);
 617 }
 618
 619 void
 620 Film::send_dcp_to_tms ()
 621 {
 622         shared_ptr<Job> j (new SCPDCPJob (state_copy (), log ()));
 623         JobManager::instance()->add (j);
 624 }
 625
 626 void
 627 Film::copy_from_dvd ()
 628 {
 629         shared_ptr<Job> j (new CopyFromDVDJob (state_copy (), log ()));
 630         j->Finished.connect (sigc::mem_fun (*this, &Film::copy_from_dvd_post_gui));
 631         JobManager::instance()->add (j);
 632 }
 633