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"
54 using namespace boost;
56 /** Construct a Film object in a given directory, reading any metadata
57 * file that exists in that directory. An exception will be thrown if
58 * must_exist is true, and the specified directory does not exist.
60 * @param d Film directory.
61 * @param must_exist true to throw an exception if does not exist.
64 Film::Film (string d, bool must_exist)
67 /* Make _state.directory a complete path without ..s (where possible)
68 (Code swiped from Adam Bowen on stackoverflow)
71 filesystem::path p (filesystem::system_complete (d));
72 filesystem::path result;
73 for (filesystem::path::iterator i = p.begin(); i != p.end(); ++i) {
75 if (filesystem::is_symlink (result) || result.filename() == "..") {
78 result = result.parent_path ();
80 } else if (*i != ".") {
85 _state.directory = result.string ();
87 if (must_exist && !filesystem::exists (_state.directory)) {
88 throw OpenFileError (_state.directory);
93 _log = new FileLog (_state.file ("log"));
96 /** Copy constructor */
97 Film::Film (Film const & other)
98 : _state (other._state)
99 , _dirty (other._dirty)
109 /** Read the `metadata' file inside this Film's directory, and fill the
110 * object's data with its content.
114 Film::read_metadata ()
116 ifstream f (metadata_file().c_str ());
118 while (getline (f, line)) {
123 if (line[0] == '#') {
127 if (line[line.size() - 1] == '\r') {
128 line = line.substr (0, line.size() - 1);
131 size_t const s = line.find (' ');
132 if (s == string::npos) {
136 _state.read_metadata (line.substr (0, s), line.substr (s + 1));
142 /** Write our state to a file `metadata' inside the Film's directory */
144 Film::write_metadata () const
146 filesystem::create_directories (_state.directory);
148 ofstream f (metadata_file().c_str ());
150 throw CreateFileError (metadata_file ());
153 _state.write_metadata (f);
158 /** Set the name by which DVD-o-matic refers to this Film */
160 Film::set_name (string n)
163 signal_changed (NAME);
166 /** Set the content file for this film.
167 * @param c New content file; if specified as an absolute path, the content should
168 * be within the film's _state.directory; if specified as a relative path, the content
169 * will be assumed to be within the film's _state.directory.
172 Film::set_content (string c)
174 string check = _state.directory;
176 #if BOOST_FILESYSTEM_VERSION == 3
177 filesystem::path slash ("/");
178 string platform_slash = slash.make_preferred().string ();
180 #ifdef DVDOMATIC_WINDOWS
181 string platform_slash = "\\";
183 string platform_slash = "/";
187 if (!ends_with (check, platform_slash)) {
188 check += platform_slash;
191 if (filesystem::path(c).has_root_directory () && starts_with (c, check)) {
192 c = c.substr (_state.directory.length() + 1);
195 if (c == _state.content) {
199 /* Create a temporary decoder so that we can get information
202 shared_ptr<FilmState> s = state_copy ();
204 shared_ptr<Options> o (new Options ("", "", ""));
205 o->out_size = Size (1024, 1024);
207 shared_ptr<Decoder> d = decoder_factory (s, o, 0, _log);
209 _state.size = d->native_size ();
210 _state.length = d->length_in_frames ();
211 _state.frames_per_second = d->frames_per_second ();
212 _state.audio_channels = d->audio_channels ();
213 _state.audio_sample_rate = d->audio_sample_rate ();
214 _state.audio_sample_format = d->audio_sample_format ();
216 _state.content_digest = md5_digest (s->content_path ());
219 signal_changed (SIZE);
220 signal_changed (LENGTH);
221 signal_changed (FRAMES_PER_SECOND);
222 signal_changed (AUDIO_CHANNELS);
223 signal_changed (AUDIO_SAMPLE_RATE);
224 signal_changed (CONTENT);
227 /** Set the format that this Film should be shown in */
229 Film::set_format (Format const * f)
232 signal_changed (FORMAT);
235 /** Set the type to specify the DCP as having
236 * (feature, trailer etc.)
239 Film::set_dcp_content_type (DCPContentType const * t)
241 _state.dcp_content_type = t;
242 signal_changed (DCP_CONTENT_TYPE);
245 /** Set the number of pixels by which to crop the left of the source video */
247 Film::set_left_crop (int c)
249 if (c == _state.crop.left) {
253 _state.crop.left = c;
254 signal_changed (CROP);
257 /** Set the number of pixels by which to crop the right of the source video */
259 Film::set_right_crop (int c)
261 if (c == _state.crop.right) {
265 _state.crop.right = c;
266 signal_changed (CROP);
269 /** Set the number of pixels by which to crop the top of the source video */
271 Film::set_top_crop (int c)
273 if (c == _state.crop.top) {
278 signal_changed (CROP);
281 /** Set the number of pixels by which to crop the bottom of the source video */
283 Film::set_bottom_crop (int c)
285 if (c == _state.crop.bottom) {
289 _state.crop.bottom = c;
290 signal_changed (CROP);
293 /** Set the filters to apply to the image when generating thumbnails
297 Film::set_filters (vector<Filter const *> const & f)
300 signal_changed (FILTERS);
303 /** Set the number of frames to put in any generated DCP (from
304 * the start of the film). 0 indicates that all frames should
308 Film::set_dcp_frames (int n)
310 _state.dcp_frames = n;
311 signal_changed (DCP_FRAMES);
315 Film::set_dcp_trim_action (TrimAction a)
317 _state.dcp_trim_action = a;
318 signal_changed (DCP_TRIM_ACTION);
321 /** Set whether or not to generate a A/B comparison DCP.
322 * Such a DCP has the left half of its frame as the Film
323 * content without any filtering or post-processing; the
324 * right half is rendered with filters and post-processing.
327 Film::set_dcp_ab (bool a)
330 signal_changed (DCP_AB);
334 Film::set_audio_gain (float g)
336 _state.audio_gain = g;
337 signal_changed (AUDIO_GAIN);
341 Film::set_audio_delay (int d)
343 _state.audio_delay = d;
344 signal_changed (AUDIO_DELAY);
347 /** @return path of metadata file */
349 Film::metadata_file () const
351 return _state.file ("metadata");
354 /** @return full path of the content (actual video) file
358 Film::content () const
360 return _state.content_path ();
363 /** The pre-processing GUI part of a thumbs update.
364 * Must be called from the GUI thread.
367 Film::update_thumbs_pre_gui ()
369 _state.thumbs.clear ();
370 filesystem::remove_all (_state.dir ("thumbs"));
372 /* This call will recreate the directory */
373 _state.dir ("thumbs");
376 /** The post-processing GUI part of a thumbs update.
377 * Must be called from the GUI thread.
380 Film::update_thumbs_post_gui ()
382 string const tdir = _state.dir ("thumbs");
384 for (filesystem::directory_iterator i = filesystem::directory_iterator (tdir); i != filesystem::directory_iterator(); ++i) {
386 /* Aah, the sweet smell of progress */
387 #if BOOST_FILESYSTEM_VERSION == 3
388 string const l = filesystem::path(*i).leaf().generic_string();
390 string const l = i->leaf ();
393 size_t const d = l.find (".tiff");
394 if (d != string::npos) {
395 _state.thumbs.push_back (atoi (l.substr (0, d).c_str()));
399 sort (_state.thumbs.begin(), _state.thumbs.end());
402 signal_changed (THUMBS);
405 /** @return the number of thumbnail images that we have */
407 Film::num_thumbs () const
409 return _state.thumbs.size ();
412 /** @param n A thumb index.
413 * @return The frame within the Film that it is for.
416 Film::thumb_frame (int n) const
418 return _state.thumb_frame (n);
421 /** @param n A thumb index.
422 * @return The path to the thumb's image file.
425 Film::thumb_file (int n) const
427 return _state.thumb_file (n);
430 /** @return The path to the directory to write JPEG2000 files to */
432 Film::j2k_dir () const
441 pair<string, string> f = Filter::ffmpeg_strings (filters ());
443 /* Write stuff to specify the filter / post-processing settings that are in use,
444 so that we don't get confused about J2K files generated using different
448 s << _state.format->id()
449 << "_" << _state.content_digest
450 << "_" << crop().left << "_" << crop().right << "_" << crop().top << "_" << crop().bottom
451 << "_" << f.first << "_" << f.second
452 << "_" << _state.scaler->id();
456 /* Similarly for the A/B case */
459 pair<string, string> fa = Filter::ffmpeg_strings (Config::instance()->reference_filters());
460 s << "ab_" << Config::instance()->reference_scaler()->id() << "_" << fa.first << "_" << fa.second;
464 return _state.dir (p.string ());
467 /** Handle a change to the Film's metadata */
469 Film::signal_changed (Property p)
475 /** Add suitable Jobs to the JobManager to create a DCP for this Film.
476 * @param true to transcode, false to use the WAV and J2K files that are already there.
479 Film::make_dcp (bool transcode, int freq)
481 string const t = name ();
482 if (t.find ("/") != string::npos) {
483 throw BadSettingError ("name", "cannot contain slashes");
486 log()->log (String::compose ("DVD-o-matic %1 using %2", DVDOMATIC_VERSION, dependency_version_summary()));
490 gethostname (buffer, sizeof (buffer));
491 log()->log (String::compose ("Starting to make DCP on %1", buffer));
495 throw MissingSettingError ("format");
498 if (content().empty ()) {
499 throw MissingSettingError ("content");
502 if (dcp_content_type() == 0) {
503 throw MissingSettingError ("content type");
506 if (name().empty()) {
507 throw MissingSettingError ("name");
510 shared_ptr<const FilmState> fs = state_copy ();
511 shared_ptr<Options> o (new Options (j2k_dir(), ".j2c", _state.dir ("wavs")));
512 o->out_size = format()->dcp_size ();
513 if (dcp_frames() == 0) {
514 /* Decode the whole film, no blacking */
518 switch (dcp_trim_action()) {
520 /* Decode only part of the film, no blacking */
521 o->num_frames = dcp_frames ();
525 /* Decode the whole film, but black some frames out */
527 o->black_after = dcp_frames ();
531 o->decode_video_frequency = freq;
532 o->padding = format()->dcp_padding ();
533 o->ratio = format()->ratio_as_float ();
537 JobManager::instance()->add (shared_ptr<Job> (new ABTranscodeJob (fs, o, log ())));
539 JobManager::instance()->add (shared_ptr<Job> (new TranscodeJob (fs, o, log ())));
543 JobManager::instance()->add (shared_ptr<Job> (new CheckHashesJob (fs, o, log ())));
544 JobManager::instance()->add (shared_ptr<Job> (new MakeDCPJob (fs, o, log ())));
547 shared_ptr<FilmState>
548 Film::state_copy () const
550 return shared_ptr<FilmState> (new FilmState (_state));
554 Film::copy_from_dvd_post_gui ()
556 const string dvd_dir = _state.dir ("dvd");
559 uintmax_t largest_size = 0;
560 for (filesystem::directory_iterator i = filesystem::directory_iterator (dvd_dir); i != filesystem::directory_iterator(); ++i) {
561 uintmax_t const s = filesystem::file_size (*i);
562 if (s > largest_size) {
564 #if BOOST_FILESYSTEM_VERSION == 3
565 largest_file = filesystem::path(*i).generic_string();
567 largest_file = i->string ();
573 set_content (largest_file);
577 Film::examine_content ()
579 if (_examine_content_job) {
583 _examine_content_job.reset (new ExamineContentJob (state_copy (), log ()));
584 _examine_content_job->Finished.connect (sigc::mem_fun (*this, &Film::examine_content_post_gui));
585 JobManager::instance()->add (_examine_content_job);
589 Film::examine_content_post_gui ()
591 _state.length = _examine_content_job->last_video_frame ();
592 signal_changed (LENGTH);
594 _examine_content_job.reset ();
598 Film::set_scaler (Scaler const * s)
601 signal_changed (SCALER);
604 /** @return full paths to any audio files that this Film has */
606 Film::audio_files () const
609 for (filesystem::directory_iterator i = filesystem::directory_iterator (_state.dir("wavs")); i != filesystem::directory_iterator(); ++i) {
610 f.push_back (i->path().string ());
617 Film::content_type () const
619 return _state.content_type ();
623 Film::set_still_duration (int d)
625 _state.still_duration = d;
626 signal_changed (STILL_DURATION);
630 Film::send_dcp_to_tms ()
632 shared_ptr<Job> j (new SCPDCPJob (state_copy (), log ()));
633 JobManager::instance()->add (j);
637 Film::copy_from_dvd ()
639 shared_ptr<Job> j (new CopyFromDVDJob (state_copy (), log ()));
640 j->Finished.connect (sigc::mem_fun (*this, &Film::copy_from_dvd_post_gui));
641 JobManager::instance()->add (j);
645 Film::encoded_frames () const
652 for (filesystem::directory_iterator i = filesystem::directory_iterator (j2k_dir ()); i != filesystem::directory_iterator(); ++i) {
654 this_thread::interruption_point ();