2 Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
22 * @brief A parent class to represent long-running tasks which are run in their own thread.
28 #include "exceptions.h"
31 #include "compose.hpp"
32 #include <dcp/exceptions.h>
33 #include <boost/thread.hpp>
34 #include <boost/filesystem.hpp>
42 using boost::shared_ptr;
43 using boost::optional;
44 using boost::function;
46 #define LOG_ERROR_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_ERROR);
47 #define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
49 /** @param film Associated film, or 0 */
50 Job::Job (shared_ptr<const Film> film)
65 _thread->interrupt ();
66 /* We can't use DCPOMATIC_ASSERT here as it may throw an exception */
67 if (_thread->joinable ()) {
71 /* Too late to do anything about this */
79 /** Start the job in a separate thread, returning immediately */
84 _start_time = time (0);
85 _sub_start_time = time (0);
86 _thread = new boost::thread (boost::bind (&Job::run_wrapper, this));
89 /** A wrapper for the ::run() method to catch exceptions */
97 } catch (dcp::FileError& e) {
99 string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf());
102 boost::filesystem::space_info const s = boost::filesystem::space (e.filename());
103 if (s.available < pow (1024, 3)) {
105 m += _("The drive that the film is stored on is low in disc space. Free some more space and try again.");
111 set_error (e.what(), m);
113 set_state (FINISHED_ERROR);
115 } catch (OpenFileError& e) {
118 String::compose (_("Could not open %1"), e.file().string()),
120 _("DCP-o-matic could not open the file %1. Perhaps it does not exist or is in an unexpected format."),
121 boost::filesystem::absolute (e.file()).string()
126 set_state (FINISHED_ERROR);
128 } catch (boost::filesystem::filesystem_error& e) {
130 if (e.code() == boost::system::errc::no_such_file_or_directory) {
132 String::compose (_("Could not open %1"), e.path1().string ()),
134 _("DCP-o-matic could not open the file %1. Perhaps it does not exist or is in an unexpected format."),
135 boost::filesystem::absolute (e.path1()).string()
141 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
146 set_state (FINISHED_ERROR);
148 } catch (boost::thread_interrupted &) {
150 set_state (FINISHED_CANCELLED);
152 } catch (std::bad_alloc& e) {
154 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."));
156 set_state (FINISHED_ERROR);
158 } catch (std::exception& e) {
162 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
166 set_state (FINISHED_ERROR);
172 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
176 set_state (FINISHED_ERROR);
180 /** @return true if this job is new (ie has not started running) */
184 boost::mutex::scoped_lock lm (_state_mutex);
185 return _state == NEW;
188 /** @return true if the job is running */
190 Job::running () const
192 boost::mutex::scoped_lock lm (_state_mutex);
193 return _state == RUNNING;
196 /** @return true if the job has finished (either successfully or unsuccessfully) */
198 Job::finished () const
200 boost::mutex::scoped_lock lm (_state_mutex);
201 return _state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED;
204 /** @return true if the job has finished successfully */
206 Job::finished_ok () const
208 boost::mutex::scoped_lock lm (_state_mutex);
209 return _state == FINISHED_OK;
212 /** @return true if the job has finished unsuccessfully */
214 Job::finished_in_error () const
216 boost::mutex::scoped_lock lm (_state_mutex);
217 return _state == FINISHED_ERROR;
221 Job::finished_cancelled () const
223 boost::mutex::scoped_lock lm (_state_mutex);
224 return _state == FINISHED_CANCELLED;
230 boost::mutex::scoped_lock lm (_state_mutex);
231 return _state == PAUSED;
234 /** Set the state of this job.
235 * @param s New state.
238 Job::set_state (State s)
240 bool finished = false;
243 boost::mutex::scoped_lock lm (_state_mutex);
246 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
247 _ran_for = time(0) - _start_time;
254 emit (boost::bind (boost::ref (Finished)));
258 /** @return DCPTime (in seconds) that this sub-job has been running */
260 Job::elapsed_sub_time () const
262 if (_sub_start_time == 0) {
266 return time (0) - _sub_start_time;
269 /** Set the progress of the current part of the job.
270 * @param p Progress (from 0 to 1)
273 Job::set_progress (float p, bool force)
276 /* Check for excessively frequent progress reporting */
277 boost::mutex::scoped_lock lm (_progress_mutex);
279 gettimeofday (&now, 0);
280 if (_last_progress_update && _last_progress_update->tv_sec > 0) {
281 double const elapsed = (now.tv_sec + now.tv_usec / 1000000.0)
282 - (_last_progress_update->tv_sec + _last_progress_update->tv_usec / 1000000.0);
287 _last_progress_update = now;
290 set_progress_common (p);
294 Job::set_progress_common (optional<float> p)
296 boost::mutex::scoped_lock lm (_progress_mutex);
298 boost::this_thread::interruption_point ();
300 boost::mutex::scoped_lock lm2 (_state_mutex);
301 while (_state == PAUSED) {
302 _pause_changed.wait (lm2);
308 emit (boost::bind (boost::ref (Progress)));
311 /** @return fractional progress of the current sub-job, if known */
313 Job::progress () const
315 boost::mutex::scoped_lock lm (_progress_mutex);
323 boost::mutex::scoped_lock lm (_progress_mutex);
324 LOG_GENERAL ("Sub-job %1 starting", n);
328 set_progress (0, true);
329 _sub_start_time = time (0);
333 Job::error_details () const
335 boost::mutex::scoped_lock lm (_state_mutex);
336 return _error_details;
339 /** @return A summary of any error that the job has generated */
341 Job::error_summary () const
343 boost::mutex::scoped_lock lm (_state_mutex);
344 return _error_summary;
347 /** Set the current error string.
348 * @param e New error string.
351 Job::set_error (string s, string d)
356 _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), LogEntry::TYPE_ERROR);
359 boost::mutex::scoped_lock lm (_state_mutex);
364 /** Say that this job's progress will be unknown until further notice */
366 Job::set_progress_unknown ()
368 set_progress_common (optional<float> ());
371 /** @return Human-readable status of this job */
375 optional<float> p = progress ();
376 int const t = elapsed_sub_time ();
377 int const r = remaining_time ();
380 if (!finished () && p) {
381 int pc = lrintf (p.get() * 100);
383 /* 100% makes it sound like we've finished when we haven't */
388 snprintf (buffer, sizeof(buffer), "%d%%", pc);
391 if (t > 10 && r > 0) {
392 /// TRANSLATORS: remaining here follows an amount of time that is remaining
394 s += "; " + seconds_to_approximate_hms (r) + " " + _("remaining");
396 } else if (finished_ok ()) {
397 s = String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
398 } else if (finished_in_error ()) {
399 s = String::compose (_("Error: %1"), error_summary ());
400 } else if (finished_cancelled ()) {
408 Job::json_status () const
410 boost::mutex::scoped_lock lm (_state_mutex);
416 return N_("running");
420 return N_("finished_ok");
422 return N_("finished_error");
423 case FINISHED_CANCELLED:
424 return N_("finished_cancelled");
430 /** @return An estimate of the remaining time for this sub-job, in seconds */
432 Job::remaining_time () const
434 if (progress().get_value_or(0) == 0) {
435 return elapsed_sub_time ();
438 return elapsed_sub_time() / progress().get() - elapsed_sub_time();
452 _thread->interrupt ();
453 DCPOMATIC_ASSERT (_thread->joinable ());
464 _pause_changed.notify_all ();
473 _pause_changed.notify_all ();
478 Job::when_finished (boost::signals2::connection& connection, function<void()> finished)
480 boost::mutex::scoped_lock lm (_state_mutex);
481 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
484 connection = Finished.connect (finished);