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 "imagemagick_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 ());
123 multimap<string, string> kv = read_key_value (f);
124 for (multimap<string, string>::const_iterator i = kv.begin(); i != kv.end(); ++i) {
125 _state.read_metadata (i->first, i->second);
130 /** Write our state to a file `metadata' inside the Film's directory */
132 Film::write_metadata () const
134 filesystem::create_directories (_state.directory);
136 ofstream f (metadata_file().c_str ());
138 throw CreateFileError (metadata_file ());
141 _state.write_metadata (f);
146 /** Set the name by which DVD-o-matic refers to this Film */
148 Film::set_name (string n)
151 signal_changed (NAME);
154 /** Set the content file for this film.
155 * @param c New content file; if specified as an absolute path, the content should
156 * be within the film's _state.directory; if specified as a relative path, the content
157 * will be assumed to be within the film's _state.directory.
160 Film::set_content (string c)
162 string check = _state.directory;
164 #if BOOST_FILESYSTEM_VERSION == 3
165 filesystem::path slash ("/");
166 string platform_slash = slash.make_preferred().string ();
168 #ifdef DVDOMATIC_WINDOWS
169 string platform_slash = "\\";
171 string platform_slash = "/";
175 if (!ends_with (check, platform_slash)) {
176 check += platform_slash;
179 if (filesystem::path(c).has_root_directory () && starts_with (c, check)) {
180 c = c.substr (_state.directory.length() + 1);
183 if (c == _state.content) {
187 /* Create a temporary decoder so that we can get information
190 shared_ptr<FilmState> s = state_copy ();
192 shared_ptr<Options> o (new Options ("", "", ""));
193 o->out_size = Size (1024, 1024);
195 shared_ptr<Decoder> d = decoder_factory (s, o, 0, _log);
197 _state.size = d->native_size ();
198 _state.length = d->length_in_frames ();
199 _state.frames_per_second = d->frames_per_second ();
200 _state.audio_channels = d->audio_channels ();
201 _state.audio_sample_rate = d->audio_sample_rate ();
202 _state.audio_sample_format = d->audio_sample_format ();
203 _state.has_subtitles = d->has_subtitles ();
204 _state.audio_streams = d->audio_streams ();
205 _state.subtitle_streams = d->subtitle_streams ();
206 _state.audio_stream = _state.audio_streams.empty() ? -1 : _state.audio_streams.front().id;
207 _state.subtitle_stream = _state.subtitle_streams.empty() ? -1 : _state.subtitle_streams.front().id;
209 _state.content_digest = md5_digest (s->content_path ());
212 signal_changed (SIZE);
213 signal_changed (LENGTH);
214 signal_changed (FRAMES_PER_SECOND);
215 signal_changed (AUDIO_CHANNELS);
216 signal_changed (AUDIO_SAMPLE_RATE);
217 signal_changed (CONTENT);
218 signal_changed (AUDIO_STREAM);
219 signal_changed (SUBTITLE_STREAM);
222 /** Set the format that this Film should be shown in */
224 Film::set_format (Format const * f)
227 signal_changed (FORMAT);
230 /** Set the type to specify the DCP as having
231 * (feature, trailer etc.)
234 Film::set_dcp_content_type (DCPContentType const * t)
236 _state.dcp_content_type = t;
237 signal_changed (DCP_CONTENT_TYPE);
240 /** Set the number of pixels by which to crop the left of the source video */
242 Film::set_left_crop (int c)
244 if (c == _state.crop.left) {
248 _state.crop.left = c;
249 signal_changed (CROP);
252 /** Set the number of pixels by which to crop the right of the source video */
254 Film::set_right_crop (int c)
256 if (c == _state.crop.right) {
260 _state.crop.right = c;
261 signal_changed (CROP);
264 /** Set the number of pixels by which to crop the top of the source video */
266 Film::set_top_crop (int c)
268 if (c == _state.crop.top) {
273 signal_changed (CROP);
276 /** Set the number of pixels by which to crop the bottom of the source video */
278 Film::set_bottom_crop (int c)
280 if (c == _state.crop.bottom) {
284 _state.crop.bottom = c;
285 signal_changed (CROP);
288 /** Set the filters to apply to the image when generating thumbnails
292 Film::set_filters (vector<Filter const *> const & f)
295 signal_changed (FILTERS);
298 /** Set the number of frames to put in any generated DCP (from
299 * the start of the film). 0 indicates that all frames should
303 Film::set_dcp_frames (int n)
305 _state.dcp_frames = n;
306 signal_changed (DCP_FRAMES);
310 Film::set_dcp_trim_action (TrimAction a)
312 _state.dcp_trim_action = a;
313 signal_changed (DCP_TRIM_ACTION);
316 /** Set whether or not to generate a A/B comparison DCP.
317 * Such a DCP has the left half of its frame as the Film
318 * content without any filtering or post-processing; the
319 * right half is rendered with filters and post-processing.
322 Film::set_dcp_ab (bool a)
325 signal_changed (DCP_AB);
329 Film::set_audio_gain (float g)
331 _state.audio_gain = g;
332 signal_changed (AUDIO_GAIN);
336 Film::set_audio_delay (int d)
338 _state.audio_delay = d;
339 signal_changed (AUDIO_DELAY);
342 /** @return path of metadata file */
344 Film::metadata_file () const
346 return _state.file ("metadata");
349 /** @return full path of the content (actual video) file
353 Film::content () const
355 return _state.content_path ();
358 /** The pre-processing GUI part of a thumbs update.
359 * Must be called from the GUI thread.
362 Film::update_thumbs_pre_gui ()
364 _state.thumbs.clear ();
365 filesystem::remove_all (_state.dir ("thumbs"));
367 /* This call will recreate the directory */
368 _state.dir ("thumbs");
371 /** The post-processing GUI part of a thumbs update.
372 * Must be called from the GUI thread.
375 Film::update_thumbs_post_gui ()
377 string const tdir = _state.dir ("thumbs");
379 for (filesystem::directory_iterator i = filesystem::directory_iterator (tdir); i != filesystem::directory_iterator(); ++i) {
381 /* Aah, the sweet smell of progress */
382 #if BOOST_FILESYSTEM_VERSION == 3
383 string const l = filesystem::path(*i).leaf().generic_string();
385 string const l = i->leaf ();
388 size_t const d = l.find (".png");
389 if (d != string::npos) {
390 _state.thumbs.push_back (atoi (l.substr (0, d).c_str()));
394 sort (_state.thumbs.begin(), _state.thumbs.end());
397 signal_changed (THUMBS);
400 /** @return the number of thumbnail images that we have */
402 Film::num_thumbs () const
404 return _state.thumbs.size ();
407 /** @param n A thumb index.
408 * @return The frame within the Film that it is for.
411 Film::thumb_frame (int n) const
413 return _state.thumb_frame (n);
416 /** @param n A thumb index.
417 * @return The path to the thumb's image file.
420 Film::thumb_file (int n) const
422 return _state.thumb_file (n);
425 /** @return The path to the directory to write JPEG2000 files to */
427 Film::j2k_dir () const
436 pair<string, string> f = Filter::ffmpeg_strings (filters ());
438 /* Write stuff to specify the filter / post-processing settings that are in use,
439 so that we don't get confused about J2K files generated using different
443 s << _state.format->id()
444 << "_" << _state.content_digest
445 << "_" << crop().left << "_" << crop().right << "_" << crop().top << "_" << crop().bottom
446 << "_" << f.first << "_" << f.second
447 << "_" << _state.scaler->id();
451 /* Similarly for the A/B case */
454 pair<string, string> fa = Filter::ffmpeg_strings (Config::instance()->reference_filters());
455 s << "ab_" << Config::instance()->reference_scaler()->id() << "_" << fa.first << "_" << fa.second;
459 return _state.dir (p.string ());
462 /** Handle a change to the Film's metadata */
464 Film::signal_changed (Property p)
470 /** Add suitable Jobs to the JobManager to create a DCP for this Film.
471 * @param true to transcode, false to use the WAV and J2K files that are already there.
474 Film::make_dcp (bool transcode, int freq)
476 if (dcp_name().find ("/") != string::npos) {
477 throw BadSettingError ("name", "cannot contain slashes");
480 log()->log (String::compose ("DVD-o-matic %1 git %2 using %3", dvdomatic_version, dvdomatic_git_commit, dependency_version_summary()));
484 gethostname (buffer, sizeof (buffer));
485 log()->log (String::compose ("Starting to make DCP on %1", buffer));
489 throw MissingSettingError ("format");
492 if (content().empty ()) {
493 throw MissingSettingError ("content");
496 if (dcp_content_type() == 0) {
497 throw MissingSettingError ("content type");
500 if (name().empty()) {
501 throw MissingSettingError ("name");
504 shared_ptr<const FilmState> fs = state_copy ();
505 shared_ptr<Options> o (new Options (j2k_dir(), ".j2c", _state.dir ("wavs")));
506 o->out_size = format()->dcp_size ();
507 if (dcp_frames() == 0) {
508 /* Decode the whole film, no blacking */
511 switch (dcp_trim_action()) {
513 /* Decode only part of the film, no blacking */
517 /* Decode the whole film, but black some frames out */
518 o->black_after = dcp_frames ();
522 o->decode_video_frequency = freq;
523 o->padding = format()->dcp_padding (this);
524 o->ratio = format()->ratio_as_float (this);
525 o->decode_subtitles = with_subtitles ();
531 r = JobManager::instance()->add (shared_ptr<Job> (new ABTranscodeJob (fs, o, log(), shared_ptr<Job> ())));
533 r = JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (fs, o, log(), shared_ptr<Job> ())));
537 r = JobManager::instance()->add (shared_ptr<Job> (new CheckHashesJob (fs, o, log(), r)));
538 JobManager::instance()->add (shared_ptr<Job> (new MakeDCPJob (fs, o, log(), r)));
541 shared_ptr<FilmState>
542 Film::state_copy () const
544 return shared_ptr<FilmState> (new FilmState (_state));
548 Film::copy_from_dvd_post_gui ()
550 const string dvd_dir = _state.dir ("dvd");
553 uintmax_t largest_size = 0;
554 for (filesystem::directory_iterator i = filesystem::directory_iterator (dvd_dir); i != filesystem::directory_iterator(); ++i) {
555 uintmax_t const s = filesystem::file_size (*i);
556 if (s > largest_size) {
558 #if BOOST_FILESYSTEM_VERSION == 3
559 largest_file = filesystem::path(*i).generic_string();
561 largest_file = i->string ();
567 set_content (largest_file);
571 Film::examine_content ()
573 if (_examine_content_job) {
577 _examine_content_job.reset (new ExamineContentJob (state_copy (), log(), shared_ptr<Job> ()));
578 _examine_content_job->Finished.connect (sigc::mem_fun (*this, &Film::examine_content_post_gui));
579 JobManager::instance()->add (_examine_content_job);
583 Film::examine_content_post_gui ()
585 _state.length = _examine_content_job->last_video_frame ();
586 signal_changed (LENGTH);
588 _examine_content_job.reset ();
592 Film::set_scaler (Scaler const * s)
595 signal_changed (SCALER);
598 /** @return full paths to any audio files that this Film has */
600 Film::audio_files () const
603 for (filesystem::directory_iterator i = filesystem::directory_iterator (_state.dir("wavs")); i != filesystem::directory_iterator(); ++i) {
604 f.push_back (i->path().string ());
611 Film::content_type () const
613 return _state.content_type ();
617 Film::set_still_duration (int d)
619 _state.still_duration = d;
620 signal_changed (STILL_DURATION);
624 Film::send_dcp_to_tms ()
626 shared_ptr<Job> j (new SCPDCPJob (state_copy (), log(), shared_ptr<Job> ()));
627 JobManager::instance()->add (j);
631 Film::copy_from_dvd ()
633 shared_ptr<Job> j (new CopyFromDVDJob (state_copy (), log(), shared_ptr<Job> ()));
634 j->Finished.connect (sigc::mem_fun (*this, &Film::copy_from_dvd_post_gui));
635 JobManager::instance()->add (j);
639 Film::encoded_frames () const
646 for (filesystem::directory_iterator i = filesystem::directory_iterator (j2k_dir ()); i != filesystem::directory_iterator(); ++i) {
648 this_thread::interruption_point ();
655 Film::set_with_subtitles (bool w)
657 _state.with_subtitles = w;
658 signal_changed (WITH_SUBTITLES);
662 Film::set_subtitle_offset (int o)
664 _state.subtitle_offset = o;
665 signal_changed (SUBTITLE_OFFSET);
669 Film::set_subtitle_scale (float s)
671 _state.subtitle_scale = s;
672 signal_changed (SUBTITLE_SCALE);
675 pair<Position, string>
676 Film::thumb_subtitle (int n) const
678 string sub_file = _state.thumb_base(n) + ".sub";
679 if (!filesystem::exists (sub_file)) {
680 return pair<Position, string> ();
683 pair<Position, string> sub;
685 ifstream f (sub_file.c_str ());
686 multimap<string, string> kv = read_key_value (f);
687 for (map<string, string>::const_iterator i = kv.begin(); i != kv.end(); ++i) {
688 if (i->first == "x") {
689 sub.first.x = lexical_cast<int> (i->second);
690 } else if (i->first == "y") {
691 sub.first.y = lexical_cast<int> (i->second);
692 sub.second = String::compose ("%1.sub.png", _state.thumb_base(n));
700 Film::set_audio_language (string v)
702 _state.audio_language = v;
703 signal_changed (DCI_METADATA);
707 Film::set_subtitle_language (string v)
709 _state.subtitle_language = v;
710 signal_changed (DCI_METADATA);
714 Film::set_territory (string v)
716 _state.territory = v;
717 signal_changed (DCI_METADATA);
721 Film::set_rating (string v)
724 signal_changed (DCI_METADATA);
728 Film::set_studio (string v)
731 signal_changed (DCI_METADATA);
735 Film::set_facility (string v)
738 signal_changed (DCI_METADATA);
742 Film::set_package_type (string v)
744 _state.package_type = v;
745 signal_changed (DCI_METADATA);
749 Film::set_use_dci_name (bool v)
751 _state.use_dci_name = v;
752 signal_changed (USE_DCI_NAME);
756 Film::set_audio_stream (int id)
758 _state.audio_stream = id;
759 signal_changed (AUDIO_STREAM);
763 Film::set_subtitle_stream (int id)
765 _state.subtitle_stream = id;
766 signal_changed (SUBTITLE_STREAM);