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>
30 #include <boost/lexical_cast.hpp>
33 #include "tiff_encoder.h"
36 #include "transcoder.h"
38 #include "job_manager.h"
39 #include "ab_transcode_job.h"
40 #include "transcode_job.h"
41 #include "scp_dcp_job.h"
42 #include "copy_from_dvd_job.h"
43 #include "make_dcp_job.h"
44 #include "film_state.h"
47 #include "exceptions.h"
48 #include "examine_content_job.h"
50 #include "decoder_factory.h"
52 #include "check_hashes_job.h"
56 using namespace boost;
58 /** Construct a Film object in a given directory, reading any metadata
59 * file that exists in that directory. An exception will be thrown if
60 * must_exist is true, and the specified directory does not exist.
62 * @param d Film directory.
63 * @param must_exist true to throw an exception if does not exist.
66 Film::Film (string d, bool must_exist)
69 /* Make _state.directory a complete path without ..s (where possible)
70 (Code swiped from Adam Bowen on stackoverflow)
73 filesystem::path p (filesystem::system_complete (d));
74 filesystem::path result;
75 for (filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
77 if (filesystem::is_symlink (result) || result.filename() == "..") {
80 result = result.parent_path ();
82 } else if (*i != ".") {
87 _state.directory = result.string ();
89 if (!filesystem::exists (_state.directory)) {
91 throw OpenFileError (_state.directory);
93 filesystem::create_directory (_state.directory);
99 _log = new FileLog (_state.file ("log"));
102 /** Copy constructor */
103 Film::Film (Film const & other)
104 : _state (other._state)
105 , _dirty (other._dirty)
115 /** Read the `metadata' file inside this Film's directory, and fill the
116 * object's data with its content.
120 Film::read_metadata ()
122 ifstream f (metadata_file().c_str ());
124 while (getline (f, line)) {
129 if (line[0] == '#') {
133 if (line[line.size() - 1] == '\r') {
134 line = line.substr (0, line.size() - 1);
137 size_t const s = line.find (' ');
138 if (s == string::npos) {
142 _state.read_metadata (line.substr (0, s), line.substr (s + 1));
148 /** Write our state to a file `metadata' inside the Film's directory */
150 Film::write_metadata () const
152 filesystem::create_directories (_state.directory);
154 ofstream f (metadata_file().c_str ());
156 throw CreateFileError (metadata_file ());
159 _state.write_metadata (f);
164 /** Set the name by which DVD-o-matic refers to this Film */
166 Film::set_name (string n)
169 signal_changed (NAME);
172 /** Set the content file for this film.
173 * @param c New content file; if specified as an absolute path, the content should
174 * be within the film's _state.directory; if specified as a relative path, the content
175 * will be assumed to be within the film's _state.directory.
178 Film::set_content (string c)
180 string check = _state.directory;
182 #if BOOST_FILESYSTEM_VERSION == 3
183 filesystem::path slash ("/");
184 string platform_slash = slash.make_preferred().string ();
186 #ifdef DVDOMATIC_WINDOWS
187 string platform_slash = "\\";
189 string platform_slash = "/";
193 if (!ends_with (check, platform_slash)) {
194 check += platform_slash;
197 if (filesystem::path(c).has_root_directory () && starts_with (c, check)) {
198 c = c.substr (_state.directory.length() + 1);
201 if (c == _state.content) {
205 /* Create a temporary decoder so that we can get information
208 shared_ptr<FilmState> s = state_copy ();
210 shared_ptr<Options> o (new Options ("", "", ""));
211 o->out_size = Size (1024, 1024);
213 shared_ptr<Decoder> d = decoder_factory (s, o, 0, _log);
215 _state.size = d->native_size ();
216 _state.length = d->length_in_frames ();
217 _state.frames_per_second = d->frames_per_second ();
218 _state.audio_channels = d->audio_channels ();
219 _state.audio_sample_rate = d->audio_sample_rate ();
220 _state.audio_sample_format = d->audio_sample_format ();
221 _state.has_subtitles = d->has_subtitles ();
223 _state.content_digest = md5_digest (s->content_path ());
226 signal_changed (SIZE);
227 signal_changed (LENGTH);
228 signal_changed (FRAMES_PER_SECOND);
229 signal_changed (AUDIO_CHANNELS);
230 signal_changed (AUDIO_SAMPLE_RATE);
231 signal_changed (CONTENT);
234 /** Set the format that this Film should be shown in */
236 Film::set_format (Format const * f)
239 signal_changed (FORMAT);
242 /** Set the type to specify the DCP as having
243 * (feature, trailer etc.)
246 Film::set_dcp_content_type (DCPContentType const * t)
248 _state.dcp_content_type = t;
249 signal_changed (DCP_CONTENT_TYPE);
252 /** Set the number of pixels by which to crop the left of the source video */
254 Film::set_left_crop (int c)
256 if (c == _state.crop.left) {
260 _state.crop.left = c;
261 signal_changed (CROP);
264 /** Set the number of pixels by which to crop the right of the source video */
266 Film::set_right_crop (int c)
268 if (c == _state.crop.right) {
272 _state.crop.right = c;
273 signal_changed (CROP);
276 /** Set the number of pixels by which to crop the top of the source video */
278 Film::set_top_crop (int c)
280 if (c == _state.crop.top) {
285 signal_changed (CROP);
288 /** Set the number of pixels by which to crop the bottom of the source video */
290 Film::set_bottom_crop (int c)
292 if (c == _state.crop.bottom) {
296 _state.crop.bottom = c;
297 signal_changed (CROP);
300 /** Set the filters to apply to the image when generating thumbnails
304 Film::set_filters (vector<Filter const *> const & f)
307 signal_changed (FILTERS);
310 /** Set the number of frames to put in any generated DCP (from
311 * the start of the film). 0 indicates that all frames should
315 Film::set_dcp_frames (int n)
317 _state.dcp_frames = n;
318 signal_changed (DCP_FRAMES);
322 Film::set_dcp_trim_action (TrimAction a)
324 _state.dcp_trim_action = a;
325 signal_changed (DCP_TRIM_ACTION);
328 /** Set whether or not to generate a A/B comparison DCP.
329 * Such a DCP has the left half of its frame as the Film
330 * content without any filtering or post-processing; the
331 * right half is rendered with filters and post-processing.
334 Film::set_dcp_ab (bool a)
337 signal_changed (DCP_AB);
341 Film::set_audio_gain (float g)
343 _state.audio_gain = g;
344 signal_changed (AUDIO_GAIN);
348 Film::set_audio_delay (int d)
350 _state.audio_delay = d;
351 signal_changed (AUDIO_DELAY);
354 /** @return path of metadata file */
356 Film::metadata_file () const
358 return _state.file ("metadata");
361 /** @return full path of the content (actual video) file
365 Film::content () const
367 return _state.content_path ();
370 /** The pre-processing GUI part of a thumbs update.
371 * Must be called from the GUI thread.
374 Film::update_thumbs_pre_gui ()
376 _state.thumbs.clear ();
377 filesystem::remove_all (_state.dir ("thumbs"));
379 /* This call will recreate the directory */
380 _state.dir ("thumbs");
383 /** The post-processing GUI part of a thumbs update.
384 * Must be called from the GUI thread.
387 Film::update_thumbs_post_gui ()
389 string const tdir = _state.dir ("thumbs");
391 for (filesystem::directory_iterator i = filesystem::directory_iterator (tdir); i != filesystem::directory_iterator(); ++i) {
393 /* Aah, the sweet smell of progress */
394 #if BOOST_FILESYSTEM_VERSION == 3
395 string const l = filesystem::path(*i).leaf().generic_string();
397 string const l = i->leaf ();
400 size_t const d = l.find (".tiff");
401 if (d != string::npos) {
402 _state.thumbs.push_back (atoi (l.substr (0, d).c_str()));
406 sort (_state.thumbs.begin(), _state.thumbs.end());
409 signal_changed (THUMBS);
412 /** @return the number of thumbnail images that we have */
414 Film::num_thumbs () const
416 return _state.thumbs.size ();
419 /** @param n A thumb index.
420 * @return The frame within the Film that it is for.
423 Film::thumb_frame (int n) const
425 return _state.thumb_frame (n);
428 /** @param n A thumb index.
429 * @return The path to the thumb's image file.
432 Film::thumb_file (int n) const
434 return _state.thumb_file (n);
437 /** @return The path to the directory to write JPEG2000 files to */
439 Film::j2k_dir () const
448 pair<string, string> f = Filter::ffmpeg_strings (filters ());
450 /* Write stuff to specify the filter / post-processing settings that are in use,
451 so that we don't get confused about J2K files generated using different
455 s << _state.format->id()
456 << "_" << _state.content_digest
457 << "_" << crop().left << "_" << crop().right << "_" << crop().top << "_" << crop().bottom
458 << "_" << f.first << "_" << f.second
459 << "_" << _state.scaler->id();
463 /* Similarly for the A/B case */
466 pair<string, string> fa = Filter::ffmpeg_strings (Config::instance()->reference_filters());
467 s << "ab_" << Config::instance()->reference_scaler()->id() << "_" << fa.first << "_" << fa.second;
471 return _state.dir (p.string ());
474 /** Handle a change to the Film's metadata */
476 Film::signal_changed (Property p)
482 /** Add suitable Jobs to the JobManager to create a DCP for this Film.
483 * @param true to transcode, false to use the WAV and J2K files that are already there.
486 Film::make_dcp (bool transcode, int freq)
488 string const t = name ();
489 if (t.find ("/") != string::npos) {
490 throw BadSettingError ("name", "cannot contain slashes");
493 log()->log (String::compose ("DVD-o-matic %1 git %2 using %3", dvdomatic_version, dvdomatic_git_commit, dependency_version_summary()));
497 gethostname (buffer, sizeof (buffer));
498 log()->log (String::compose ("Starting to make DCP on %1", buffer));
502 throw MissingSettingError ("format");
505 if (content().empty ()) {
506 throw MissingSettingError ("content");
509 if (dcp_content_type() == 0) {
510 throw MissingSettingError ("content type");
513 if (name().empty()) {
514 throw MissingSettingError ("name");
517 shared_ptr<const FilmState> fs = state_copy ();
518 shared_ptr<Options> o (new Options (j2k_dir(), ".j2c", _state.dir ("wavs")));
519 o->out_size = format()->dcp_size ();
520 if (dcp_frames() == 0) {
521 /* Decode the whole film, no blacking */
524 switch (dcp_trim_action()) {
526 /* Decode only part of the film, no blacking */
530 /* Decode the whole film, but black some frames out */
531 o->black_after = dcp_frames ();
535 o->decode_video_frequency = freq;
536 o->padding = format()->dcp_padding (this);
537 o->ratio = format()->ratio_as_float (this);
543 r = JobManager::instance()->add (shared_ptr<Job> (new ABTranscodeJob (fs, o, log(), shared_ptr<Job> ())));
545 r = JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (fs, o, log(), shared_ptr<Job> ())));
549 r = JobManager::instance()->add (shared_ptr<Job> (new CheckHashesJob (fs, o, log(), r)));
550 JobManager::instance()->add (shared_ptr<Job> (new MakeDCPJob (fs, o, log(), r)));
553 shared_ptr<FilmState>
554 Film::state_copy () const
556 return shared_ptr<FilmState> (new FilmState (_state));
560 Film::copy_from_dvd_post_gui ()
562 const string dvd_dir = _state.dir ("dvd");
565 uintmax_t largest_size = 0;
566 for (filesystem::directory_iterator i = filesystem::directory_iterator (dvd_dir); i != filesystem::directory_iterator(); ++i) {
567 uintmax_t const s = filesystem::file_size (*i);
568 if (s > largest_size) {
570 #if BOOST_FILESYSTEM_VERSION == 3
571 largest_file = filesystem::path(*i).generic_string();
573 largest_file = i->string ();
579 set_content (largest_file);
583 Film::examine_content ()
585 if (_examine_content_job) {
589 _examine_content_job.reset (new ExamineContentJob (state_copy (), log(), shared_ptr<Job> ()));
590 _examine_content_job->Finished.connect (sigc::mem_fun (*this, &Film::examine_content_post_gui));
591 JobManager::instance()->add (_examine_content_job);
595 Film::examine_content_post_gui ()
597 _state.length = _examine_content_job->last_video_frame ();
598 signal_changed (LENGTH);
600 _examine_content_job.reset ();
604 Film::set_scaler (Scaler const * s)
607 signal_changed (SCALER);
610 /** @return full paths to any audio files that this Film has */
612 Film::audio_files () const
615 for (filesystem::directory_iterator i = filesystem::directory_iterator (_state.dir("wavs")); i != filesystem::directory_iterator(); ++i) {
616 f.push_back (i->path().string ());
623 Film::content_type () const
625 return _state.content_type ();
629 Film::set_still_duration (int d)
631 _state.still_duration = d;
632 signal_changed (STILL_DURATION);
636 Film::send_dcp_to_tms ()
638 shared_ptr<Job> j (new SCPDCPJob (state_copy (), log(), shared_ptr<Job> ()));
639 JobManager::instance()->add (j);
643 Film::copy_from_dvd ()
645 shared_ptr<Job> j (new CopyFromDVDJob (state_copy (), log(), shared_ptr<Job> ()));
646 j->Finished.connect (sigc::mem_fun (*this, &Film::copy_from_dvd_post_gui));
647 JobManager::instance()->add (j);
651 Film::encoded_frames () const
658 for (filesystem::directory_iterator i = filesystem::directory_iterator (j2k_dir ()); i != filesystem::directory_iterator(); ++i) {
660 this_thread::interruption_point ();
667 Film::set_with_subtitles (bool w)
669 _state.with_subtitles = w;
670 signal_changed (WITH_SUBTITLES);
673 list<pair<Position, string> >
674 Film::thumb_subtitles (int n) const
676 string sub_file = _state.thumb_base(n) + ".sub";
677 if (!filesystem::exists (sub_file)) {
678 return list<pair<Position, string> > ();
681 ifstream f (sub_file.c_str ());
686 list<pair<Position, string> > subs;
688 while (getline (f, line)) {
693 if (line[line.size() - 1] == '\r') {
694 line = line.substr (0, line.size() - 1);
697 size_t const s = line.find (' ');
698 if (s == string::npos) {
702 string const k = line.substr (0, s);
703 int const v = lexical_cast<int> (line.substr(s + 1));
707 } else if (k == "x") {
709 } else if (k == "y") {
710 subs.push_back (make_pair (Position (sub_x, v), String::compose ("%1.sub.%2.tiff", _state.thumb_base(n), sub_number)));