X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Fjob.cc;h=52558046ae8ec66ecd580194bf3f51558efd504e;hp=ed0370479a5ae1ffb8de08b07e695323b56383de;hb=2d4e8c5f69cc694625ad95dcee554499605f823b;hpb=24ae62cee407a05ce391884ce3bce03f53de7982 diff --git a/src/lib/job.cc b/src/lib/job.cc index ed0370479..52558046a 100644 --- a/src/lib/job.cc +++ b/src/lib/job.cc @@ -1,5 +1,5 @@ /* - Copyright (C) 2012-2016 Carl Hetherington + Copyright (C) 2012-2021 Carl Hetherington This file is part of DCP-o-matic. @@ -28,12 +28,13 @@ #include "exceptions.h" #include "film.h" #include "log.h" +#include "dcpomatic_log.h" #include "compose.hpp" #include #include #include #include -#include +#include #include #include "i18n.h" @@ -41,17 +42,14 @@ using std::string; using std::list; using std::cout; -using boost::shared_ptr; +using std::shared_ptr; using boost::optional; -using boost::function; - -#define LOG_ERROR_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_ERROR); -#define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL); +using std::function; +using namespace dcpomatic; /** @param film Associated film, or 0 */ Job::Job (shared_ptr film) : _film (film) - , _thread (0) , _state (NEW) , _start_time (0) , _sub_start_time (0) @@ -63,19 +61,21 @@ Job::Job (shared_ptr film) Job::~Job () { - 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 */ - } - } - } +#ifdef DCPOMATIC_DEBUG + /* Any subclass should have called stop_thread in its destructor */ + assert (!_thread.joinable()); +#endif +} - delete _thread; +void +Job::stop_thread () +{ + boost::this_thread::disable_interruption dis; + + _thread.interrupt (); + try { + _thread.join (); + } catch (...) {} } /** Start the job in a separate thread, returning immediately */ @@ -85,13 +85,18 @@ Job::start () set_state (RUNNING); _start_time = time (0); _sub_start_time = time (0); - _thread = new boost::thread (boost::bind (&Job::run_wrapper, this)); + _thread = 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 */ void Job::run_wrapper () { + start_of_thread (String::compose("Job-%1", json_name())); + try { run (); @@ -101,7 +106,7 @@ Job::run_wrapper () 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()); + auto 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."); @@ -114,13 +119,50 @@ Job::run_wrapper () set_progress (1); set_state (FINISHED_ERROR); + } catch (dcp::StartCompressionError& e) { + + bool done = false; + +#ifdef DCPOMATIC_WINDOWS +#if (__GNUC__ && !__x86_64__) + /* 32-bit */ + set_error ( + _("Failed to encode the DCP."), + _("This error has probably occurred because you are running the 32-bit version of DCP-o-matic and " + "trying to use too many encoding threads. Please reduce the 'number of threads DCP-o-matic should " + "use' in the General tab of Preferences and try again.") + ); + done = true; +#else + /* 64-bit */ + if (running_32_on_64()) { + set_error ( + _("Failed to encode the DCP."), + _("This error has probably occurred because you are running the 32-bit version of DCP-o-matic. Please re-install DCP-o-matic with the 64-bit installer and try again.") + ); + done = true; + } +#endif +#endif + + if (!done) { + set_error ( + e.what (), + string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM + ); + } + + 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. Perhaps it does not exist or is in an unexpected format."), - boost::filesystem::absolute (e.file()).string() + _("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() ) ); @@ -133,8 +175,9 @@ Job::run_wrapper () 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."), - boost::filesystem::absolute (e.path1()).string() + _("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 { @@ -154,7 +197,7 @@ Job::run_wrapper () } catch (sub::SubripError& e) { string extra = "Error is near:\n"; - BOOST_FOREACH (string i, e.context()) { + for (auto i: e.context()) { extra += i + "\n"; } @@ -168,6 +211,24 @@ Job::run_wrapper () set_progress (1); set_state (FINISHED_ERROR); + } catch (dcp::ReadError& 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 ( @@ -238,10 +299,17 @@ Job::finished_cancelled () const } bool -Job::paused () const +Job::paused_by_user () const +{ + boost::mutex::scoped_lock lm (_state_mutex); + return _state == PAUSED_BY_USER; +} + +bool +Job::paused_by_priority () const { boost::mutex::scoped_lock lm (_state_mutex); - return _state == PAUSED; + return _state == PAUSED_BY_PRIORITY; } /** Set the state of this job. @@ -265,6 +333,7 @@ Job::set_state (State s) if (finished) { emit (boost::bind (boost::ref (Finished))); + FinishedImmediate (); } } @@ -279,12 +348,28 @@ Job::elapsed_sub_time () const return time (0) - _sub_start_time; } +/** Check to see if this job has been interrupted or paused */ +void +Job::check_for_interruption_or_pause () +{ + boost::this_thread::interruption_point (); + + 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); + } +} + /** 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) { + check_for_interruption_or_pause (); + if (!force) { /* Check for excessively frequent progress reporting */ boost::mutex::scoped_lock lm (_progress_mutex); @@ -306,18 +391,11 @@ Job::set_progress (float p, bool force) void Job::set_progress_common (optional p) { - boost::mutex::scoped_lock lm (_progress_mutex); - _progress = p; - boost::this_thread::interruption_point (); - - boost::mutex::scoped_lock lm2 (_state_mutex); - while (_state == PAUSED) { - _pause_changed.wait (lm2); + { + boost::mutex::scoped_lock lm (_progress_mutex); + _progress = p; } - lm.unlock (); - lm2.unlock (); - emit (boost::bind (boost::ref (Progress))); } @@ -358,14 +436,13 @@ Job::error_summary () const } /** 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) { - LOG_ERROR_NC (s); - LOG_ERROR_NC (d); _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), LogEntry::TYPE_ERROR); } @@ -378,6 +455,7 @@ Job::set_error (string s, string d) void Job::set_progress_unknown () { + check_for_interruption_or_pause (); set_progress_common (optional ()); } @@ -402,9 +480,22 @@ Job::status () const s += buffer; 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"); + auto now = boost::posix_time::second_clock::local_time(); + auto 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)); @@ -427,7 +518,8 @@ Job::json_status () const return N_("new"); case RUNNING: return N_("running"); - case PAUSED: + case PAUSED_BY_USER: + case PAUSED_BY_PRIORITY: return N_("paused"); case FINISHED_OK: return N_("finished_ok"); @@ -454,26 +546,46 @@ Job::remaining_time () const void Job::cancel () { - if (!_thread) { + if (!_thread.joinable()) { return; } - if (paused ()) { + if (paused_by_user() || paused_by_priority()) { resume (); } - _thread->interrupt (); - DCPOMATIC_ASSERT (_thread->joinable ()); - _thread->join (); - delete _thread; - _thread = 0; + _thread.interrupt (); + _thread.join (); +} + +/** @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 (); } } @@ -481,7 +593,7 @@ Job::pause () void Job::resume () { - if (paused ()) { + if (paused_by_user() || paused_by_priority()) { set_state (RUNNING); _pause_changed.notify_all (); } @@ -497,3 +609,17 @@ Job::when_finished (boost::signals2::connection& connection, function fi connection = Finished.connect (finished); } } + +optional +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; +}