2 Copyright (C) 2012-2015 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.
21 * @brief A parent class to represent long-running tasks which are run in their own thread.
27 #include "exceptions.h"
30 #include "compose.hpp"
31 #include <dcp/exceptions.h>
32 #include <boost/thread.hpp>
33 #include <boost/filesystem.hpp>
41 using boost::shared_ptr;
42 using boost::optional;
43 using boost::function;
45 #define LOG_ERROR_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_ERROR);
47 /** @param film Associated film, or 0 */
48 Job::Job (shared_ptr<const Film> film)
62 _thread->interrupt ();
63 DCPOMATIC_ASSERT (_thread->joinable ());
70 /** Start the job in a separate thread, returning immediately */
75 _start_time = time (0);
76 _thread = new boost::thread (boost::bind (&Job::run_wrapper, this));
79 /** A wrapper for the ::run() method to catch exceptions */
87 } catch (dcp::FileError& e) {
89 string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf());
92 boost::filesystem::space_info const s = boost::filesystem::space (e.filename());
93 if (s.available < pow (1024, 3)) {
95 m += _("The drive that the film is stored on is low in disc space. Free some more space and try again.");
101 set_error (e.what(), m);
103 set_state (FINISHED_ERROR);
105 } catch (OpenFileError& e) {
108 String::compose (_("Could not open %1"), e.file().string()),
109 String::compose (_("DCP-o-matic could not open the file %1. Perhaps it does not exist or is in an unexpected format."), e.file().string())
113 set_state (FINISHED_ERROR);
115 } catch (boost::filesystem::filesystem_error& e) {
117 if (e.code() == boost::system::errc::no_such_file_or_directory) {
119 String::compose (_("Could not open %1"), e.path1().string ()),
120 String::compose (_("DCP-o-matic could not open the file %1. Perhaps it does not exist or is in an unexpected format."), e.path1().string())
125 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
130 set_state (FINISHED_ERROR);
132 } catch (boost::thread_interrupted &) {
134 set_state (FINISHED_CANCELLED);
136 } catch (std::bad_alloc& e) {
138 set_error (_("Out of memory"), _("There was not enough memory to do this. If you are running a 32-bit operating system try reducing the number of encoding threads in the General tab of Preferences."));
140 set_state (FINISHED_ERROR);
142 } catch (std::exception& e) {
146 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
150 set_state (FINISHED_ERROR);
156 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
160 set_state (FINISHED_ERROR);
164 /** @return true if this job is new (ie has not started running) */
168 boost::mutex::scoped_lock lm (_state_mutex);
169 return _state == NEW;
172 /** @return true if the job is running */
174 Job::running () const
176 boost::mutex::scoped_lock lm (_state_mutex);
177 return _state == RUNNING;
180 /** @return true if the job has finished (either successfully or unsuccessfully) */
182 Job::finished () const
184 boost::mutex::scoped_lock lm (_state_mutex);
185 return _state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED;
188 /** @return true if the job has finished successfully */
190 Job::finished_ok () const
192 boost::mutex::scoped_lock lm (_state_mutex);
193 return _state == FINISHED_OK;
196 /** @return true if the job has finished unsuccessfully */
198 Job::finished_in_error () const
200 boost::mutex::scoped_lock lm (_state_mutex);
201 return _state == FINISHED_ERROR;
205 Job::finished_cancelled () const
207 boost::mutex::scoped_lock lm (_state_mutex);
208 return _state == FINISHED_CANCELLED;
214 boost::mutex::scoped_lock lm (_state_mutex);
215 return _state == PAUSED;
218 /** Set the state of this job.
219 * @param s New state.
222 Job::set_state (State s)
224 bool finished = false;
227 boost::mutex::scoped_lock lm (_state_mutex);
230 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
231 _ran_for = elapsed_time ();
238 emit (boost::bind (boost::ref (Finished)));
242 /** @return DCPTime (in seconds) that this sub-job has been running */
244 Job::elapsed_time () const
246 if (_start_time == 0) {
250 return time (0) - _start_time;
253 /** Set the progress of the current part of the job.
254 * @param p Progress (from 0 to 1)
257 Job::set_progress (float p, bool force)
259 if (!force && fabs (p - progress().get_value_or(0)) < 0.01) {
260 /* Calm excessive progress reporting */
264 set_progress_common (p);
268 Job::set_progress_common (optional<float> p)
270 boost::mutex::scoped_lock lm (_progress_mutex);
272 boost::this_thread::interruption_point ();
274 boost::mutex::scoped_lock lm2 (_state_mutex);
275 while (_state == PAUSED) {
276 _pause_changed.wait (lm2);
282 emit (boost::bind (boost::ref (Progress)));
285 /** @return fractional progress of the current sub-job, if known */
287 Job::progress () const
289 boost::mutex::scoped_lock lm (_progress_mutex);
297 boost::mutex::scoped_lock lm (_progress_mutex);
301 set_progress (0, true);
305 Job::error_details () const
307 boost::mutex::scoped_lock lm (_state_mutex);
308 return _error_details;
311 /** @return A summary of any error that the job has generated */
313 Job::error_summary () const
315 boost::mutex::scoped_lock lm (_state_mutex);
316 return _error_summary;
319 /** Set the current error string.
320 * @param e New error string.
323 Job::set_error (string s, string d)
328 _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), LogEntry::TYPE_ERROR);
331 boost::mutex::scoped_lock lm (_state_mutex);
336 /** Say that this job's progress will be unknown until further notice */
338 Job::set_progress_unknown ()
340 set_progress_common (optional<float> ());
343 /** @return Human-readable status of this job */
347 optional<float> p = progress ();
348 int const t = elapsed_time ();
349 int const r = remaining_time ();
352 if (!finished () && p) {
353 int pc = lrintf (p.get() * 100);
355 /* 100% makes it sound like we've finished when we haven't */
361 if (t > 10 && r > 0) {
362 /// TRANSLATORS: remaining here follows an amount of time that is remaining
364 s << "; " << seconds_to_approximate_hms (r) << " " << _("remaining");
366 } else if (finished_ok ()) {
367 s << String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
368 } else if (finished_in_error ()) {
369 s << String::compose (_("Error: %1"), error_summary ());
370 } else if (finished_cancelled ()) {
378 Job::json_status () const
380 boost::mutex::scoped_lock lm (_state_mutex);
386 return N_("running");
390 return N_("finished_ok");
392 return N_("finished_error");
393 case FINISHED_CANCELLED:
394 return N_("finished_cancelled");
400 /** @return An estimate of the remaining time for this sub-job, in seconds */
402 Job::remaining_time () const
404 if (progress().get_value_or(0) == 0) {
405 return elapsed_time ();
408 return elapsed_time() / progress().get() - elapsed_time();
422 _thread->interrupt ();
423 DCPOMATIC_ASSERT (_thread->joinable ());
434 _pause_changed.notify_all ();
443 _pause_changed.notify_all ();
448 Job::when_finished (boost::signals2::connection& connection, function<void()> finished)
450 boost::mutex::scoped_lock lm (_state_mutex);
451 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
454 connection = Finished.connect (finished);