/*
- Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
*/
-/** @file src/job.cc
+/** @file src/job.cc
* @brief A parent class to represent long-running tasks which are run in their own thread.
*/
-#include <boost/thread.hpp>
-#include <boost/filesystem.hpp>
-#include <dcp/exceptions.h>
#include "job.h"
#include "util.h"
#include "cross.h"
-#include "ui_signaller.h"
#include "exceptions.h"
+#include "film.h"
+#include "log.h"
+#include "compose.hpp"
+#include <dcp/exceptions.h>
+#include <boost/thread.hpp>
+#include <boost/filesystem.hpp>
+#include <iostream>
#include "i18n.h"
using std::string;
using std::list;
using std::cout;
-using std::stringstream;
using boost::shared_ptr;
+using boost::optional;
+using boost::function;
+
+#define LOG_ERROR_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_ERROR);
-Job::Job (shared_ptr<const Film> f)
- : _film (f)
+/** @param film Associated film, or 0 */
+Job::Job (shared_ptr<const Film> film)
+ : _film (film)
, _thread (0)
, _state (NEW)
, _start_time (0)
}
+Job::~Job ()
+{
+ if (_thread) {
+ _thread->interrupt ();
+ DCPOMATIC_ASSERT (_thread->joinable ());
+ _thread->join ();
+ }
+
+ delete _thread;
+}
+
/** Start the job in a separate thread, returning immediately */
void
Job::start ()
run ();
} catch (dcp::FileError& e) {
-
+
string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf());
try {
set_error (e.what(), m);
set_progress (1);
set_state (FINISHED_ERROR);
-
+
} catch (OpenFileError& e) {
set_error (
set_progress (1);
set_state (FINISHED_ERROR);
+ } catch (boost::filesystem::filesystem_error& e) {
+
+ if (e.code() == boost::system::errc::no_such_file_or_directory) {
+ set_error (
+ String::compose (_("Could not open %1"), e.path1().string ()),
+ 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())
+ );
+ } else {
+ set_error (
+ e.what (),
+ string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
+ );
+ }
+
+ set_progress (1);
+ set_state (FINISHED_ERROR);
+
} 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_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."));
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)")
+ string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
);
set_progress (1);
set_state (FINISHED_ERROR);
-
+
} 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)")
+ string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
);
set_progress (1);
boost::mutex::scoped_lock lm (_state_mutex);
return _state == PAUSED;
}
-
+
/** Set the state of this job.
* @param s New state.
*/
}
}
- if (finished && ui_signaller) {
- ui_signaller->emit (boost::bind (boost::ref (Finished)));
- }
+ if (finished) {
+ emit (boost::bind (boost::ref (Finished)));
+ }
}
/** @return DCPTime (in seconds) that this sub-job has been running */
if (_start_time == 0) {
return 0;
}
-
+
return time (0) - _start_time;
}
void
Job::set_progress (float p, bool force)
{
- if (!force && fabs (p - progress()) < 0.01) {
+ if (!force && fabs (p - progress().get_value_or(0)) < 0.01) {
/* Calm excessive progress reporting */
return;
}
+ set_progress_common (p);
+}
+
+void
+Job::set_progress_common (optional<float> p)
+{
boost::mutex::scoped_lock lm (_progress_mutex);
_progress = p;
boost::this_thread::interruption_point ();
- if (paused ()) {
- dcpomatic_sleep (1);
+ boost::mutex::scoped_lock lm2 (_state_mutex);
+ while (_state == PAUSED) {
+ _pause_changed.wait (lm2);
}
- if (ui_signaller) {
- ui_signaller->emit (boost::bind (boost::ref (Progress)));
- }
+ lm.unlock ();
+ lm2.unlock ();
+
+ emit (boost::bind (boost::ref (Progress)));
}
-/** @return fractional progress of the current sub-job, or -1 if not known */
-float
+/** @return fractional progress of the current sub-job, if known */
+optional<float>
Job::progress () const
{
boost::mutex::scoped_lock lm (_progress_mutex);
- return _progress.get_value_or (-1);
+ return _progress;
}
void
boost::mutex::scoped_lock lm (_progress_mutex);
_sub_name = n;
}
-
+
set_progress (0, true);
}
void
Job::set_error (string s, string d)
{
+ if (_film) {
+ LOG_ERROR_NC (s);
+ LOG_ERROR_NC (d);
+ _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), LogEntry::TYPE_ERROR);
+ }
+
boost::mutex::scoped_lock lm (_state_mutex);
_error_summary = s;
_error_details = d;
void
Job::set_progress_unknown ()
{
- boost::mutex::scoped_lock lm (_progress_mutex);
- _progress.reset ();
+ set_progress_common (optional<float> ());
}
/** @return Human-readable status of this job */
string
Job::status () const
{
- float const p = progress ();
+ optional<float> 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;
- }
+ SafeStringStream s;
+ if (!finished () && p) {
+ int pc = lrintf (p.get() * 100);
+ if (pc == 100) {
+ /* 100% makes it sound like we've finished when we haven't */
+ pc = 99;
+ }
- stringstream s;
- if (!finished ()) {
s << pc << N_("%");
- if (p >= 0 && t > 10 && r > 0) {
+
+ if (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 << String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
} else if (finished_in_error ()) {
- s << String::compose (_("Error (%1)"), error_summary());
+ s << String::compose (_("Error: %1"), error_summary ());
} else if (finished_cancelled ()) {
s << _("Cancelled");
}
int
Job::remaining_time () const
{
- return elapsed_time() / progress() - elapsed_time();
+ if (progress().get_value_or(0) == 0) {
+ return elapsed_time ();
+ }
+
+ return elapsed_time() / progress().get() - elapsed_time();
}
void
return;
}
+ if (paused ()) {
+ resume ();
+ }
+
_thread->interrupt ();
+ DCPOMATIC_ASSERT (_thread->joinable ());
_thread->join ();
+ delete _thread;
+ _thread = 0;
}
void
{
if (running ()) {
set_state (PAUSED);
+ _pause_changed.notify_all ();
}
}
{
if (paused ()) {
set_state (RUNNING);
+ _pause_changed.notify_all ();
+ }
+}
+
+void
+Job::when_finished (boost::signals2::connection& connection, function<void()> finished)
+{
+ boost::mutex::scoped_lock lm (_state_mutex);
+ if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
+ finished ();
+ } else {
+ connection = Finished.connect (finished);
}
}
projects / dcpomatic.git / blobdiff