/*
- Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
- This program is free software; you can redistribute it and/or modify
+ This file is part of DCP-o-matic.
+
+ DCP-o-matic is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
- This program is distributed in the hope that it will be useful,
+ DCP-o-matic is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
*/
-/** @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 <libdcp/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 "dcpomatic_log.h"
+#include "compose.hpp"
+#include <dcp/exceptions.h>
+#include <sub/exceptions.h>
+#include <boost/thread.hpp>
+#include <boost/filesystem.hpp>
+#include <boost/foreach.hpp>
+#include <boost/date_time/posix_time/posix_time.hpp>
+#include <iostream>
#include "i18n.h"
using std::string;
using std::list;
-using std::stringstream;
+using std::cout;
using boost::shared_ptr;
+using boost::optional;
+using boost::function;
+using namespace dcpomatic;
-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)
- , _progress_unknown (false)
+ , _sub_start_time (0)
+ , _progress (0)
, _ran_for (0)
{
- descend (1);
+
+}
+
+Job::~Job ()
+{
+ stop_thread ();
+}
+
+void
+Job::stop_thread ()
+{
+ if (_thread) {
+ _thread->interrupt ();
+ /* We can't use DCPOMATIC_ASSERT here as it may throw an exception */
+ if (_thread->joinable ()) {
+ try {
+ _thread->join ();
+ } catch (...) {
+ /* Too late to do anything about this */
+ }
+ }
+ }
+
+ delete _thread;
+ _thread = 0;
}
/** Start the job in a separate thread, returning immediately */
{
set_state (RUNNING);
_start_time = time (0);
+ _sub_start_time = time (0);
_thread = new boost::thread (boost::bind (&Job::run_wrapper, this));
+#ifdef DCPOMATIC_LINUX
+ pthread_setname_np (_thread->native_handle(), "job-wrapper");
+#endif
}
/** A wrapper for the ::run() method to catch exceptions */
run ();
- } catch (libdcp::FileError& e) {
-
- set_progress (1);
- set_state (FINISHED_ERROR);
-
+ } 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 (
+ String::compose (_("Could not open %1"), e.file().string()),
+ String::compose (
+ _("DCP-o-matic could not open the file %1 (%2). Perhaps it does not exist or is in an unexpected format."),
+ boost::filesystem::absolute (e.file()).string(),
+ e.what()
+ )
+ );
+
+ 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 (%2). Perhaps it does not exist or is in an unexpected format."),
+ boost::filesystem::absolute (e.path1()).string(),
+ e.what()
+ )
+ );
+ } 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::exception& e) {
+ } catch (sub::SubripError& e) {
+
+ string extra = "Error is near:\n";
+ BOOST_FOREACH (string i, e.context()) {
+ extra += i + "\n";
+ }
+
+ set_error (e.what (), extra);
+ set_progress (1);
+ set_state (FINISHED_ERROR);
+
+ } catch (std::bad_alloc& e) {
+
+ 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 (dcp::DCPReadError& e) {
+
+ set_error (e.message(), e.detail().get_value_or(""));
+ set_progress (1);
+ set_state (FINISHED_ERROR);
+
+ } catch (KDMError& e) {
+
+ set_error (e.summary(), e.detail());
+ set_progress (1);
+ set_state (FINISHED_ERROR);
+
+ } catch (FileError& e) {
+
+ set_error (e.what(), e.what());
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 (dcpomatic@carlh.net)")
+ string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
);
- } catch (...) {
-
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 (dcpomatic@carlh.net)")
+ string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
);
+ set_progress (1);
+ set_state (FINISHED_ERROR);
}
}
}
bool
-Job::paused () const
+Job::paused_by_user () const
{
boost::mutex::scoped_lock lm (_state_mutex);
- return _state == PAUSED;
+ return _state == PAUSED_BY_USER;
}
-
+
+bool
+Job::paused_by_priority () const
+{
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _state == PAUSED_BY_PRIORITY;
+}
+
/** 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;
- if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
- _ran_for = elapsed_time ();
- if (ui_signaller) {
- ui_signaller->emit (boost::bind (boost::ref (Finished)));
+ {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ _state = s;
+
+ if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
+ _ran_for = time(0) - _start_time;
+ finished = true;
+ _sub_name.clear ();
}
}
+
+ if (finished) {
+ emit (boost::bind (boost::ref (Finished)));
+ FinishedImmediate ();
+ }
}
-/** @return Time (in seconds) that this job has been running */
+/** @return DCPTime (in seconds) that this sub-job has been running */
int
-Job::elapsed_time () const
+Job::elapsed_sub_time () const
{
- if (_start_time == 0) {
+ if (_sub_start_time == 0) {
return 0;
}
-
- return time (0) - _start_time;
+
+ return time (0) - _sub_start_time;
}
-/** Set the progress of the current part of the job.
- * @param p Progress (from 0 to 1)
- */
+/** Check to see if this job has been interrupted or paused */
void
-Job::set_progress (float p)
+Job::check_for_interruption_or_pause ()
{
- boost::mutex::scoped_lock lm (_progress_mutex);
- _progress_unknown = false;
- _stack.back().normalised = p;
boost::this_thread::interruption_point ();
- if (paused ()) {
- dcpomatic_sleep (1);
+ boost::mutex::scoped_lock lm (_state_mutex);
+ while (_state == PAUSED_BY_USER || _state == PAUSED_BY_PRIORITY) {
+ emit (boost::bind (boost::ref (Progress)));
+ _pause_changed.wait (lm);
}
}
-/** @return fractional overall progress, or -1 if not known */
-float
-Job::overall_progress () const
+/** Set the progress of the current part of the job.
+ * @param p Progress (from 0 to 1)
+ * @param force Do not ignore this update, even if it hasn't been long since the last one.
+ */
+void
+Job::set_progress (float p, bool force)
{
- boost::mutex::scoped_lock lm (_progress_mutex);
- if (_progress_unknown) {
- return -1;
+ check_for_interruption_or_pause ();
+
+ if (!force) {
+ /* Check for excessively frequent progress reporting */
+ boost::mutex::scoped_lock lm (_progress_mutex);
+ struct timeval now;
+ gettimeofday (&now, 0);
+ if (_last_progress_update && _last_progress_update->tv_sec > 0) {
+ double const elapsed = (now.tv_sec + now.tv_usec / 1000000.0)
+ - (_last_progress_update->tv_sec + _last_progress_update->tv_usec / 1000000.0);
+ if (elapsed < 0.5) {
+ return;
+ }
+ }
+ _last_progress_update = now;
}
- 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;
- }
+ set_progress_common (p);
+}
- if (overall > 1) {
- overall = 1;
+void
+Job::set_progress_common (optional<float> p)
+{
+ {
+ boost::mutex::scoped_lock lm (_progress_mutex);
+ _progress = p;
}
-
- return overall;
+
+ emit (boost::bind (boost::ref (Progress)));
}
-/** Ascend up one level in terms of progress reporting; see descend() */
-void
-Job::ascend ()
+/** @return fractional progress of the current sub-job, if known */
+optional<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;
-}
-
-/** 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.
- */
+ return _progress;
+}
+
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);
+ LOG_GENERAL ("Sub-job %1 starting", n);
+ _sub_name = n;
+ }
+
+ set_progress (0, true);
+ _sub_start_time = time (0);
}
string
}
/** Set the current error string.
- * @param e New error string.
+ * @param s New error string.
+ * @param d New error detail string.
*/
void
Job::set_error (string s, string d)
{
+ if (_film) {
+ _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_unknown = true;
+ check_for_interruption_or_pause ();
+ set_progress_common (optional<float> ());
}
/** @return Human-readable status of this job */
string
Job::status () const
{
- float const p = overall_progress ();
- int const t = elapsed_time ();
+ optional<float> p = progress ();
+ int const t = elapsed_sub_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;
- }
+ string 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) {
- /// TRANSLATORS: remaining here follows an amount of time that is remaining
- /// on an operation.
- s << "; " << seconds_to_approximate_hms (r) << " " << _("remaining");
+ char buffer[64];
+ snprintf (buffer, sizeof(buffer), "%d%%", pc);
+ s += buffer;
+
+ if (t > 10 && r > 0) {
+ boost::posix_time::ptime now = boost::posix_time::second_clock::local_time();
+ boost::posix_time::ptime finish = now + boost::posix_time::seconds(r);
+ char finish_string[16];
+ snprintf (finish_string, sizeof(finish_string), "%02d:%02d", int(finish.time_of_day().hours()), int(finish.time_of_day().minutes()));
+ string day;
+ if (now.date() != finish.date()) {
+ /// TRANSLATORS: the %1 in this string will be filled in with a day of the week
+ /// to say what day a job will finish.
+ day = String::compose (_(" on %1"), day_of_week_to_string(finish.date().day_of_week()));
+ }
+ /// TRANSLATORS: "remaining; finishing at" here follows an amount of time that is remaining
+ /// on an operation; after it is an estimated wall-clock completion time.
+ s += String::compose(
+ _("; %1 remaining; finishing at %2%3"),
+ seconds_to_approximate_hms(r), finish_string, day
+ );
}
} else if (finished_ok ()) {
- s << String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
+ 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");
+ s = _("Cancelled");
}
- return s.str ();
+ return s;
}
-/** @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_BY_USER:
+ case PAUSED_BY_PRIORITY:
+ 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();
+ if (progress().get_value_or(0) == 0) {
+ return elapsed_sub_time ();
+ }
+
+ return elapsed_sub_time() / progress().get() - elapsed_sub_time();
}
void
return;
}
+ if (paused_by_user() || paused_by_priority()) {
+ resume ();
+ }
+
_thread->interrupt ();
+ DCPOMATIC_ASSERT (_thread->joinable ());
_thread->join ();
+ delete _thread;
+ _thread = 0;
+}
+
+/** @return true if the job was paused, false if it was not running */
+bool
+Job::pause_by_user ()
+{
+ bool paused = false;
+ {
+ boost::mutex::scoped_lock lm (_state_mutex);
+ /* We can set _state here directly because we have a lock and we aren't
+ setting the job to FINISHED_*
+ */
+ if (_state == RUNNING) {
+ paused = true;
+ _state = PAUSED_BY_USER;
+ }
+ }
+
+ if (paused) {
+ _pause_changed.notify_all ();
+ }
+
+ return paused;
}
void
-Job::pause ()
+Job::pause_by_priority ()
{
if (running ()) {
- set_state (PAUSED);
+ set_state (PAUSED_BY_PRIORITY);
+ _pause_changed.notify_all ();
}
}
void
Job::resume ()
{
- if (paused ()) {
+ if (paused_by_user() || paused_by_priority()) {
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);
+ }
+}
+
+optional<string>
+Job::message () const
+{
+ boost::mutex::scoped_lock lm (_state_mutex);
+ return _message;
+}
+
+void
+Job::set_message (string m)
+{
+ boost::mutex::scoped_lock lm (_state_mutex);
+ _message = m;
+}
projects / dcpomatic.git / blobdiff