#include <libdcp/exceptions.h>
#include "job.h"
#include "util.h"
+#include "cross.h"
+#include "ui_signaller.h"
+#include "exceptions.h"
+
+#include "i18n.h"
using std::string;
using std::list;
+using std::cout;
using std::stringstream;
using boost::shared_ptr;
-/** @param s Film that we are operating on.
- * @param req Job that must be completed before this job is run.
- */
-Job::Job (shared_ptr<Film> f, shared_ptr<Job> req)
+Job::Job (shared_ptr<const Film> f)
: _film (f)
- , _required (req)
+ , _thread (0)
, _state (NEW)
, _start_time (0)
- , _progress_unknown (false)
+ , _progress (0)
, _ran_for (0)
{
- descend (1);
+
}
/** Start the job in a separate thread, returning immediately */
{
set_state (RUNNING);
_start_time = time (0);
- boost::thread (boost::bind (&Job::run_wrapper, this));
+ _thread = new boost::thread (boost::bind (&Job::run_wrapper, this));
}
/** A wrapper for the ::run() method to catch exceptions */
} catch (libdcp::FileError& e) {
+ string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf());
+
+ try {
+ boost::filesystem::space_info const s = boost::filesystem::space (e.filename());
+ if (s.available < pow (1024, 3)) {
+ m += N_("\n\n");
+ m += _("The drive that the film is stored on is low in disc space. Free some more space and try again.");
+ }
+ } catch (...) {
+
+ }
+
+ set_error (e.what(), m);
set_progress (1);
set_state (FINISHED_ERROR);
- set_error (String::compose ("%1 (%2)", e.what(), boost::filesystem::path (e.filename()).leaf()));
- } catch (std::exception& e) {
+ } catch (OpenFileError& e) {
+
+ set_error (
+ String::compose (_("Could not open %1"), e.file().string()),
+ 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())
+ );
set_progress (1);
set_state (FINISHED_ERROR);
- set_error (e.what ());
- } catch (...) {
+ } catch (boost::thread_interrupted &) {
+
+ set_state (FINISHED_CANCELLED);
+
+ } catch (std::bad_alloc& e) {
+
+ set_error (_("Out of memory"), _("There was not enough memory to do this."));
+ set_progress (1);
+ set_state (FINISHED_ERROR);
+
+ } catch (std::exception& e) {
+
+ set_error (
+ e.what (),
+ _("It is not known what caused this error. The best idea is to report the problem to the DCP-o-matic mailing list (carl@dcpomatic.com)")
+ );
set_progress (1);
set_state (FINISHED_ERROR);
- set_error ("unknown exception");
+
+ } catch (...) {
+
+ set_error (
+ _("Unknown error"),
+ _("It is not known what caused this error. The best idea is to report the problem to the DCP-o-matic mailing list (carl@dcpomatic.com)")
+ );
+ set_progress (1);
+ set_state (FINISHED_ERROR);
}
}
Job::finished () const
{
boost::mutex::scoped_lock lm (_state_mutex);
- return _state == FINISHED_OK || _state == FINISHED_ERROR;
+ return _state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED;
}
/** @return true if the job has finished successfully */
return _state == FINISHED_ERROR;
}
+bool
+Job::finished_cancelled () const
+{
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _state == FINISHED_CANCELLED;
+}
+
+bool
+Job::paused () const
+{
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _state == PAUSED;
+}
+
/** Set the state of this job.
* @param s New state.
*/
void
Job::set_state (State s)
{
- boost::mutex::scoped_lock lm (_state_mutex);
- _state = s;
+ bool finished = false;
+
+ {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ _state = s;
+
+ if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
+ _ran_for = elapsed_time ();
+ finished = true;
+ _sub_name.clear ();
+ }
+ }
- if (_state == FINISHED_OK || _state == FINISHED_ERROR) {
- _ran_for = elapsed_time ();
- Finished ();
+ if (finished && ui_signaller) {
+ ui_signaller->emit (boost::bind (boost::ref (Finished)));
}
}
-/** @return Time (in seconds) that this job has been running */
+/** @return Time (in seconds) that this sub-job has been running */
int
Job::elapsed_time () const
{
* @param p Progress (from 0 to 1)
*/
void
-Job::set_progress (float p)
+Job::set_progress (float p, bool force)
{
- boost::mutex::scoped_lock lm (_progress_mutex);
- _progress_unknown = false;
- _stack.back().normalised = p;
-}
+ if (!force && fabs (p - progress()) < 0.01) {
+ /* Calm excessive progress reporting */
+ return;
+ }
-/** @return fractional overall progress, or -1 if not known */
-float
-Job::overall_progress () const
-{
boost::mutex::scoped_lock lm (_progress_mutex);
- if (_progress_unknown) {
- return -1;
- }
+ _progress = p;
+ boost::this_thread::interruption_point ();
- float overall = 0;
- float factor = 1;
- for (list<Level>::const_iterator i = _stack.begin(); i != _stack.end(); ++i) {
- factor *= i->allocation;
- overall += i->normalised * factor;
+ if (paused ()) {
+ dcpomatic_sleep (1);
}
- if (overall > 1) {
- overall = 1;
+ if (ui_signaller) {
+ ui_signaller->emit (boost::bind (boost::ref (Progress)));
}
-
- return overall;
}
-/** Ascend up one level in terms of progress reporting; see descend() */
-void
-Job::ascend ()
+/** @return fractional progress of the current sub-job, or -1 if not known */
+float
+Job::progress () const
{
boost::mutex::scoped_lock lm (_progress_mutex);
-
- assert (!_stack.empty ());
- float const a = _stack.back().allocation;
- _stack.pop_back ();
- _stack.back().normalised += a;
+ return _progress.get_value_or (-1);
}
-/** Descend down one level in terms of progress reporting; e.g. if
- * there is a task which is split up into N subtasks, each of which
- * report their progress from 0 to 100%, call descend() before executing
- * each subtask, and ascend() afterwards to ensure that overall progress
- * is reported correctly.
- *
- * @param a Fraction (from 0 to 1) of the current task to allocate to the subtask.
- */
void
-Job::descend (float a)
+Job::sub (string n)
{
- boost::mutex::scoped_lock lm (_progress_mutex);
- _stack.push_back (Level (a));
+ {
+ boost::mutex::scoped_lock lm (_progress_mutex);
+ _sub_name = n;
+ }
+
+ set_progress (0, true);
+}
+
+string
+Job::error_details () const
+{
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _error_details;
}
-/** @return Any error string that the job has generated */
+/** @return A summary of any error that the job has generated */
string
-Job::error () const
+Job::error_summary () const
{
boost::mutex::scoped_lock lm (_state_mutex);
- return _error;
+ return _error_summary;
}
/** Set the current error string.
* @param e New error string.
*/
void
-Job::set_error (string e)
+Job::set_error (string s, string d)
{
boost::mutex::scoped_lock lm (_state_mutex);
- _error = e;
+ _error_summary = s;
+ _error_details = d;
}
/** Say that this job's progress will be unknown until further notice */
Job::set_progress_unknown ()
{
boost::mutex::scoped_lock lm (_progress_mutex);
- _progress_unknown = true;
+ _progress.reset ();
}
/** @return Human-readable status of this job */
string
Job::status () const
{
- float const p = overall_progress ();
+ float const p = progress ();
int const t = elapsed_time ();
int const r = remaining_time ();
+ int pc = rint (p * 100);
+ if (pc == 100) {
+ /* 100% makes it sound like we've finished when we haven't */
+ pc = 99;
+ }
+
stringstream s;
- if (!finished () && p >= 0 && t > 10 && r > 0) {
- s << rint (p * 100) << "%; " << seconds_to_approximate_hms (r) << " remaining";
- } else if (!finished () && (t <= 10 || r == 0)) {
- s << rint (p * 100) << "%";
+ if (!finished ()) {
+ s << pc << N_("%");
+ if (p >= 0 && t > 10 && r > 0) {
+ /// TRANSLATORS: remaining here follows an amount of time that is remaining
+ /// on an operation.
+ s << "; " << seconds_to_approximate_hms (r) << " " << _("remaining");
+ }
} else if (finished_ok ()) {
- s << "OK (ran for " << seconds_to_hms (_ran_for) << ")";
+ s << String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
} else if (finished_in_error ()) {
- s << "Error (" << error() << ")";
+ s << String::compose (_("Error (%1)"), error_summary());
+ } else if (finished_cancelled ()) {
+ s << _("Cancelled");
}
return s.str ();
}
-/** @return An estimate of the remaining time for this job, in seconds */
+string
+Job::json_status () const
+{
+ boost::mutex::scoped_lock lm (_state_mutex);
+
+ switch (_state) {
+ case NEW:
+ return N_("new");
+ case RUNNING:
+ return N_("running");
+ case PAUSED:
+ return N_("paused");
+ case FINISHED_OK:
+ return N_("finished_ok");
+ case FINISHED_ERROR:
+ return N_("finished_error");
+ case FINISHED_CANCELLED:
+ return N_("finished_cancelled");
+ }
+
+ return "";
+}
+
+/** @return An estimate of the remaining time for this sub-job, in seconds */
int
Job::remaining_time () const
{
- return elapsed_time() / overall_progress() - elapsed_time();
+ return elapsed_time() / progress() - elapsed_time();
+}
+
+void
+Job::cancel ()
+{
+ if (!_thread) {
+ return;
+ }
+
+ _thread->interrupt ();
+ _thread->join ();
+}
+
+void
+Job::pause ()
+{
+ if (running ()) {
+ set_state (PAUSED);
+ }
+}
+
+void
+Job::resume ()
+{
+ if (paused ()) {
+ set_state (RUNNING);
+ }
}
projects / dcpomatic.git / blobdiff