2 Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
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.
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.
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.
28 #include <boost/filesystem.hpp>
29 #include <boost/algorithm/string.hpp>
32 #include "tiff_encoder.h"
35 #include "transcoder.h"
37 #include "job_manager.h"
38 #include "ab_transcode_job.h"
39 #include "transcode_job.h"
40 #include "scp_dcp_job.h"
41 #include "copy_from_dvd_job.h"
42 #include "make_dcp_job.h"
43 #include "film_state.h"
46 #include "exceptions.h"
47 #include "examine_content_job.h"
49 #include "decoder_factory.h"
51 #include "check_hashes_job.h"
55 using namespace boost;
57 /** Construct a Film object in a given directory, reading any metadata
58 * file that exists in that directory. An exception will be thrown if
59 * must_exist is true, and the specified directory does not exist.
61 * @param d Film directory.
62 * @param must_exist true to throw an exception if does not exist.
65 Film::Film (string d, bool must_exist)
68 /* Make _state.directory a complete path without ..s (where possible)
69 (Code swiped from Adam Bowen on stackoverflow)
72 filesystem::path p (filesystem::system_complete (d));
73 filesystem::path result;
74 for (filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
76 if (filesystem::is_symlink (result) || result.filename() == "..") {
79 result = result.parent_path ();
81 } else if (*i != ".") {
86 _state.directory = result.string ();
88 if (!filesystem::exists (_state.directory)) {
90 throw OpenFileError (_state.directory);
92 filesystem::create_directory (_state.directory);
98 _log = new FileLog (_state.file ("log"));
101 /** Copy constructor */
102 Film::Film (Film const & other)
103 : _state (other._state)
104 , _dirty (other._dirty)
114 /** Read the `metadata' file inside this Film's directory, and fill the
115 * object's data with its content.
119 Film::read_metadata ()
121 ifstream f (metadata_file().c_str ());
123 while (getline (f, line)) {
128 if (line[0] == '#') {
132 if (line[line.size() - 1] == '\r') {
133 line = line.substr (0, line.size() - 1);
136 size_t const s = line.find (' ');
137 if (s == string::npos) {
141 _state.read_metadata (line.substr (0, s), line.substr (s + 1));
147 /** Write our state to a file `metadata' inside the Film's directory */
149 Film::write_metadata () const
151 filesystem::create_directories (_state.directory);
153 ofstream f (metadata_file().c_str ());
155 throw CreateFileError (metadata_file ());
158 _state.write_metadata (f);
163 /** Set the name by which DVD-o-matic refers to this Film */
165 Film::set_name (string n)
168 signal_changed (NAME);
171 /** Set the content file for this film.
172 * @param c New content file; if specified as an absolute path, the content should
173 * be within the film's _state.directory; if specified as a relative path, the content
174 * will be assumed to be within the film's _state.directory.
177 Film::set_content (string c)
179 string check = _state.directory;
181 #if BOOST_FILESYSTEM_VERSION == 3
182 filesystem::path slash ("/");
183 string platform_slash = slash.make_preferred().string ();
185 #ifdef DVDOMATIC_WINDOWS
186 string platform_slash = "\\";
188 string platform_slash = "/";
192 if (!ends_with (check, platform_slash)) {
193 check += platform_slash;
196 if (filesystem::path(c).has_root_directory () && starts_with (c, check)) {
197 c = c.substr (_state.directory.length() + 1);
200 if (c == _state.content) {
204 /* Create a temporary decoder so that we can get information
207 shared_ptr<FilmState> s = state_copy ();
209 shared_ptr<Options> o (new Options ("", "", ""));
210 o->out_size = Size (1024, 1024);
212 shared_ptr<Decoder> d = decoder_factory (s, o, 0, _log);
214 _state.size = d->native_size ();
215 _state.length = d->length_in_frames ();
216 _state.frames_per_second = d->frames_per_second ();
217 _state.audio_channels = d->audio_channels ();
218 _state.audio_sample_rate = d->audio_sample_rate ();
219 _state.audio_sample_format = d->audio_sample_format ();
221 _state.content_digest = md5_digest (s->content_path ());
224 signal_changed (SIZE);
225 signal_changed (LENGTH);
226 signal_changed (FRAMES_PER_SECOND);
227 signal_changed (AUDIO_CHANNELS);
228 signal_changed (AUDIO_SAMPLE_RATE);
229 signal_changed (CONTENT);
232 /** Set the format that this Film should be shown in */
234 Film::set_format (Format const * f)
237 signal_changed (FORMAT);
240 /** Set the type to specify the DCP as having
241 * (feature, trailer etc.)
244 Film::set_dcp_content_type (DCPContentType const * t)
246 _state.dcp_content_type = t;
247 signal_changed (DCP_CONTENT_TYPE);
250 /** Set the number of pixels by which to crop the left of the source video */
252 Film::set_left_crop (int c)
254 if (c == _state.crop.left) {
258 _state.crop.left = c;
259 signal_changed (CROP);
262 /** Set the number of pixels by which to crop the right of the source video */
264 Film::set_right_crop (int c)
266 if (c == _state.crop.right) {
270 _state.crop.right = c;
271 signal_changed (CROP);
274 /** Set the number of pixels by which to crop the top of the source video */
276 Film::set_top_crop (int c)
278 if (c == _state.crop.top) {
283 signal_changed (CROP);
286 /** Set the number of pixels by which to crop the bottom of the source video */
288 Film::set_bottom_crop (int c)
290 if (c == _state.crop.bottom) {
294 _state.crop.bottom = c;
295 signal_changed (CROP);
298 /** Set the filters to apply to the image when generating thumbnails
302 Film::set_filters (vector<Filter const *> const & f)
305 signal_changed (FILTERS);
308 /** Set the number of frames to put in any generated DCP (from
309 * the start of the film). 0 indicates that all frames should
313 Film::set_dcp_frames (int n)
315 _state.dcp_frames = n;
316 signal_changed (DCP_FRAMES);
320 Film::set_dcp_trim_action (TrimAction a)
322 _state.dcp_trim_action = a;
323 signal_changed (DCP_TRIM_ACTION);
326 /** Set whether or not to generate a A/B comparison DCP.
327 * Such a DCP has the left half of its frame as the Film
328 * content without any filtering or post-processing; the
329 * right half is rendered with filters and post-processing.
332 Film::set_dcp_ab (bool a)
335 signal_changed (DCP_AB);
339 Film::set_audio_gain (float g)
341 _state.audio_gain = g;
342 signal_changed (AUDIO_GAIN);
346 Film::set_audio_delay (int d)
348 _state.audio_delay = d;
349 signal_changed (AUDIO_DELAY);
352 /** @return path of metadata file */
354 Film::metadata_file () const
356 return _state.file ("metadata");
359 /** @return full path of the content (actual video) file
363 Film::content () const
365 return _state.content_path ();
368 /** The pre-processing GUI part of a thumbs update.
369 * Must be called from the GUI thread.
372 Film::update_thumbs_pre_gui ()
374 _state.thumbs.clear ();
375 filesystem::remove_all (_state.dir ("thumbs"));
377 /* This call will recreate the directory */
378 _state.dir ("thumbs");
381 /** The post-processing GUI part of a thumbs update.
382 * Must be called from the GUI thread.
385 Film::update_thumbs_post_gui ()
387 string const tdir = _state.dir ("thumbs");
389 for (filesystem::directory_iterator i = filesystem::directory_iterator (tdir); i != filesystem::directory_iterator(); ++i) {
391 /* Aah, the sweet smell of progress */
392 #if BOOST_FILESYSTEM_VERSION == 3
393 string const l = filesystem::path(*i).leaf().generic_string();
395 string const l = i->leaf ();
398 size_t const d = l.find (".tiff");
399 if (d != string::npos) {
400 _state.thumbs.push_back (atoi (l.substr (0, d).c_str()));
404 sort (_state.thumbs.begin(), _state.thumbs.end());
407 signal_changed (THUMBS);
410 /** @return the number of thumbnail images that we have */
412 Film::num_thumbs () const
414 return _state.thumbs.size ();
417 /** @param n A thumb index.
418 * @return The frame within the Film that it is for.
421 Film::thumb_frame (int n) const
423 return _state.thumb_frame (n);
426 /** @param n A thumb index.
427 * @return The path to the thumb's image file.
430 Film::thumb_file (int n) const
432 return _state.thumb_file (n);
435 /** @return The path to the directory to write JPEG2000 files to */
437 Film::j2k_dir () const
446 pair<string, string> f = Filter::ffmpeg_strings (filters ());
448 /* Write stuff to specify the filter / post-processing settings that are in use,
449 so that we don't get confused about J2K files generated using different
453 s << _state.format->id()
454 << "_" << _state.content_digest
455 << "_" << crop().left << "_" << crop().right << "_" << crop().top << "_" << crop().bottom
456 << "_" << f.first << "_" << f.second
457 << "_" << _state.scaler->id();
461 /* Similarly for the A/B case */
464 pair<string, string> fa = Filter::ffmpeg_strings (Config::instance()->reference_filters());
465 s << "ab_" << Config::instance()->reference_scaler()->id() << "_" << fa.first << "_" << fa.second;
469 return _state.dir (p.string ());
472 /** Handle a change to the Film's metadata */
474 Film::signal_changed (Property p)
480 /** Add suitable Jobs to the JobManager to create a DCP for this Film.
481 * @param true to transcode, false to use the WAV and J2K files that are already there.
484 Film::make_dcp (bool transcode, int freq)
486 string const t = name ();
487 if (t.find ("/") != string::npos) {
488 throw BadSettingError ("name", "cannot contain slashes");
491 log()->log (String::compose ("DVD-o-matic %1 git %2 using %3", dvdomatic_version, dvdomatic_git_commit, dependency_version_summary()));
495 gethostname (buffer, sizeof (buffer));
496 log()->log (String::compose ("Starting to make DCP on %1", buffer));
500 throw MissingSettingError ("format");
503 if (content().empty ()) {
504 throw MissingSettingError ("content");
507 if (dcp_content_type() == 0) {
508 throw MissingSettingError ("content type");
511 if (name().empty()) {
512 throw MissingSettingError ("name");
515 shared_ptr<const FilmState> fs = state_copy ();
516 shared_ptr<Options> o (new Options (j2k_dir(), ".j2c", _state.dir ("wavs")));
517 o->out_size = format()->dcp_size ();
518 if (dcp_frames() == 0) {
519 /* Decode the whole film, no blacking */
522 switch (dcp_trim_action()) {
524 /* Decode only part of the film, no blacking */
528 /* Decode the whole film, but black some frames out */
529 o->black_after = dcp_frames ();
533 o->decode_video_frequency = freq;
534 o->padding = format()->dcp_padding (this);
535 o->ratio = format()->ratio_as_float (this);
541 r = JobManager::instance()->add (shared_ptr<Job> (new ABTranscodeJob (fs, o, log(), shared_ptr<Job> ())));
543 r = JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (fs, o, log(), shared_ptr<Job> ())));
547 r = JobManager::instance()->add (shared_ptr<Job> (new CheckHashesJob (fs, o, log(), r)));
548 JobManager::instance()->add (shared_ptr<Job> (new MakeDCPJob (fs, o, log(), r)));
551 shared_ptr<FilmState>
552 Film::state_copy () const
554 return shared_ptr<FilmState> (new FilmState (_state));
558 Film::copy_from_dvd_post_gui ()
560 const string dvd_dir = _state.dir ("dvd");
563 uintmax_t largest_size = 0;
564 for (filesystem::directory_iterator i = filesystem::directory_iterator (dvd_dir); i != filesystem::directory_iterator(); ++i) {
565 uintmax_t const s = filesystem::file_size (*i);
566 if (s > largest_size) {
568 #if BOOST_FILESYSTEM_VERSION == 3
569 largest_file = filesystem::path(*i).generic_string();
571 largest_file = i->string ();
577 set_content (largest_file);
581 Film::examine_content ()
583 if (_examine_content_job) {
587 _examine_content_job.reset (new ExamineContentJob (state_copy (), log(), shared_ptr<Job> ()));
588 _examine_content_job->Finished.connect (sigc::mem_fun (*this, &Film::examine_content_post_gui));
589 JobManager::instance()->add (_examine_content_job);
593 Film::examine_content_post_gui ()
595 _state.length = _examine_content_job->last_video_frame ();
596 signal_changed (LENGTH);
598 _examine_content_job.reset ();
602 Film::set_scaler (Scaler const * s)
605 signal_changed (SCALER);
608 /** @return full paths to any audio files that this Film has */
610 Film::audio_files () const
613 for (filesystem::directory_iterator i = filesystem::directory_iterator (_state.dir("wavs")); i != filesystem::directory_iterator(); ++i) {
614 f.push_back (i->path().string ());
621 Film::content_type () const
623 return _state.content_type ();
627 Film::set_still_duration (int d)
629 _state.still_duration = d;
630 signal_changed (STILL_DURATION);
634 Film::send_dcp_to_tms ()
636 shared_ptr<Job> j (new SCPDCPJob (state_copy (), log(), shared_ptr<Job> ()));
637 JobManager::instance()->add (j);
641 Film::copy_from_dvd ()
643 shared_ptr<Job> j (new CopyFromDVDJob (state_copy (), log(), shared_ptr<Job> ()));
644 j->Finished.connect (sigc::mem_fun (*this, &Film::copy_from_dvd_post_gui));
645 JobManager::instance()->add (j);
649 Film::encoded_frames () const
656 for (filesystem::directory_iterator i = filesystem::directory_iterator (j2k_dir ()); i != filesystem::directory_iterator(); ++i) {
658 this_thread::interruption_point ();