2 Copyright (C) 2012-2021 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/>.
23 * @brief A parent class to represent long-running tasks which are run in their own thread.
27 #include "compose.hpp"
29 #include "dcpomatic_log.h"
30 #include "exceptions.h"
35 #include <dcp/exceptions.h>
36 #include <sub/exceptions.h>
37 #include <boost/date_time/posix_time/posix_time.hpp>
38 #include <boost/filesystem.hpp>
39 #include <boost/thread.hpp>
48 using std::shared_ptr;
50 using boost::optional;
51 using namespace dcpomatic;
54 /** @param film Associated film, or 0 */
55 Job::Job (shared_ptr<const Film> film)
69 #ifdef DCPOMATIC_DEBUG
70 /* Any subclass should have called stop_thread in its destructor */
71 assert (!_thread.joinable());
79 boost::this_thread::disable_interruption dis;
88 /** Start the job in a separate thread, returning immediately */
93 _start_time = time (0);
94 _sub_start_time = time (0);
95 _thread = boost::thread (boost::bind(&Job::run_wrapper, this));
96 #ifdef DCPOMATIC_LINUX
97 pthread_setname_np (_thread.native_handle(), "job-wrapper");
102 /** A wrapper for the ::run() method to catch exceptions */
106 start_of_thread (String::compose("Job-%1", json_name()));
112 } catch (dcp::FileError& e) {
114 string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf());
117 auto const s = boost::filesystem::space (e.filename());
118 if (s.available < pow (1024, 3)) {
120 m += _("The drive that the film is stored on is low in disc space. Free some more space and try again.");
126 set_error (e.what(), m);
128 set_state (FINISHED_ERROR);
130 } catch (dcp::StartCompressionError& e) {
134 #ifdef DCPOMATIC_WINDOWS
135 #if (__GNUC__ && !__x86_64__)
138 _("Failed to encode the DCP."),
139 _("This error has probably occurred because you are running the 32-bit version of DCP-o-matic and "
140 "trying to use too many encoding threads. Please reduce the 'number of threads DCP-o-matic should "
141 "use' in the General tab of Preferences and try again.")
146 if (running_32_on_64()) {
148 _("Failed to encode the DCP."),
149 _("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.")
159 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
164 set_state (FINISHED_ERROR);
166 } catch (OpenFileError& e) {
169 String::compose (_("Could not open %1"), e.file().string()),
171 _("DCP-o-matic could not open the file %1 (%2). Perhaps it does not exist or is in an unexpected format."),
172 boost::filesystem::absolute (e.file()).string(),
178 set_state (FINISHED_ERROR);
180 } catch (boost::filesystem::filesystem_error& e) {
182 if (e.code() == boost::system::errc::no_such_file_or_directory) {
184 String::compose (_("Could not open %1"), e.path1().string ()),
186 _("DCP-o-matic could not open the file %1 (%2). Perhaps it does not exist or is in an unexpected format."),
187 boost::filesystem::absolute (e.path1()).string(),
194 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
199 set_state (FINISHED_ERROR);
201 } catch (boost::thread_interrupted &) {
203 set_state (FINISHED_CANCELLED);
205 } catch (sub::SubripError& e) {
207 string extra = "Error is near:\n";
208 for (auto i: e.context()) {
212 set_error (e.what (), extra);
214 set_state (FINISHED_ERROR);
216 } catch (std::bad_alloc& e) {
218 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."));
220 set_state (FINISHED_ERROR);
222 } catch (dcp::ReadError& e) {
224 set_error (e.message(), e.detail().get_value_or(""));
226 set_state (FINISHED_ERROR);
228 } catch (KDMError& e) {
230 set_error (e.summary(), e.detail());
232 set_state (FINISHED_ERROR);
234 } catch (FileError& e) {
236 set_error (e.what(), e.what());
238 set_state (FINISHED_ERROR);
240 } catch (std::exception& e) {
244 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
248 set_state (FINISHED_ERROR);
254 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
258 set_state (FINISHED_ERROR);
263 /** @return true if this job is new (ie has not started running) */
267 boost::mutex::scoped_lock lm (_state_mutex);
268 return _state == NEW;
272 /** @return true if the job is running */
274 Job::running () const
276 boost::mutex::scoped_lock lm (_state_mutex);
277 return _state == RUNNING;
281 /** @return true if the job has finished (either successfully or unsuccessfully) */
283 Job::finished () const
285 boost::mutex::scoped_lock lm (_state_mutex);
286 return _state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED;
290 /** @return true if the job has finished successfully */
292 Job::finished_ok () const
294 boost::mutex::scoped_lock lm (_state_mutex);
295 return _state == FINISHED_OK;
299 /** @return true if the job has finished unsuccessfully */
301 Job::finished_in_error () const
303 boost::mutex::scoped_lock lm (_state_mutex);
304 return _state == FINISHED_ERROR;
309 Job::finished_cancelled () const
311 boost::mutex::scoped_lock lm (_state_mutex);
312 return _state == FINISHED_CANCELLED;
317 Job::paused_by_user () const
319 boost::mutex::scoped_lock lm (_state_mutex);
320 return _state == PAUSED_BY_USER;
325 Job::paused_by_priority () const
327 boost::mutex::scoped_lock lm (_state_mutex);
328 return _state == PAUSED_BY_PRIORITY;
332 /** Set the state of this job.
333 * @param s New state.
336 Job::set_state (State s)
338 bool finished = false;
341 boost::mutex::scoped_lock lm (_state_mutex);
344 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
345 _ran_for = time(0) - _start_time;
352 emit (boost::bind (boost::ref (Finished)));
353 FinishedImmediate ();
358 /** @return DCPTime (in seconds) that this sub-job has been running */
360 Job::elapsed_sub_time () const
362 if (_sub_start_time == 0) {
366 return time (0) - _sub_start_time;
370 /** Check to see if this job has been interrupted or paused */
372 Job::check_for_interruption_or_pause ()
374 boost::this_thread::interruption_point ();
376 boost::mutex::scoped_lock lm (_state_mutex);
377 while (_state == PAUSED_BY_USER || _state == PAUSED_BY_PRIORITY) {
378 emit (boost::bind (boost::ref (Progress)));
379 _pause_changed.wait (lm);
385 Job::seconds_since_last_progress_update () const
387 boost::mutex::scoped_lock lm (_progress_mutex);
388 if (!_last_progress_update) {
393 gettimeofday (&now, 0);
395 return seconds(now) - seconds(*_last_progress_update);
399 /** Set the progress of the current part of the job.
400 * @param p Progress (from 0 to 1)
401 * @param force Do not ignore this update, even if it hasn't been long since the last one.
404 Job::set_progress (float p, bool force)
406 check_for_interruption_or_pause ();
409 /* Check for excessively frequent progress reporting */
410 boost::mutex::scoped_lock lm (_progress_mutex);
412 gettimeofday (&now, 0);
413 if (_last_progress_update && _last_progress_update->tv_sec > 0) {
414 double const elapsed = seconds(now) - seconds(*_last_progress_update);
419 _last_progress_update = now;
422 set_progress_common (p);
427 Job::set_progress_common (optional<float> p)
430 boost::mutex::scoped_lock lm (_progress_mutex);
434 emit (boost::bind (boost::ref (Progress)));
438 /** @return fractional progress of the current sub-job, if known */
440 Job::progress () const
442 boost::mutex::scoped_lock lm (_progress_mutex);
451 boost::mutex::scoped_lock lm (_progress_mutex);
452 LOG_GENERAL ("Sub-job %1 starting", n);
456 set_progress (0, true);
457 _sub_start_time = time (0);
462 Job::error_details () const
464 boost::mutex::scoped_lock lm (_state_mutex);
465 return _error_details;
469 /** @return A summary of any error that the job has generated */
471 Job::error_summary () const
473 boost::mutex::scoped_lock lm (_state_mutex);
474 return _error_summary;
478 /** Set the current error string.
479 * @param s New error string.
480 * @param d New error detail string.
483 Job::set_error (string s, string d)
486 _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), LogEntry::TYPE_ERROR);
489 boost::mutex::scoped_lock lm (_state_mutex);
495 /** Say that this job's progress will be unknown until further notice */
497 Job::set_progress_unknown ()
499 check_for_interruption_or_pause ();
500 set_progress_common (optional<float> ());
504 /** @return Human-readable status of this job */
508 optional<float> p = progress ();
509 int const t = elapsed_sub_time ();
510 int const r = remaining_time ();
513 if (!finished () && p) {
514 int pc = lrintf (p.get() * 100);
516 /* 100% makes it sound like we've finished when we haven't */
521 snprintf (buffer, sizeof(buffer), "%d%%", pc);
524 if (t > 10 && r > 0) {
525 auto now = boost::posix_time::second_clock::local_time();
526 auto finish = now + boost::posix_time::seconds(r);
527 char finish_string[16];
528 snprintf (finish_string, sizeof(finish_string), "%02d:%02d", int(finish.time_of_day().hours()), int(finish.time_of_day().minutes()));
530 if (now.date() != finish.date()) {
531 /// TRANSLATORS: the %1 in this string will be filled in with a day of the week
532 /// to say what day a job will finish.
533 day = String::compose (_(" on %1"), day_of_week_to_string(finish.date().day_of_week()));
535 /// TRANSLATORS: "remaining; finishing at" here follows an amount of time that is remaining
536 /// on an operation; after it is an estimated wall-clock completion time.
537 s += String::compose(
538 _("; %1 remaining; finishing at %2%3"),
539 seconds_to_approximate_hms(r), finish_string, day
542 } else if (finished_ok ()) {
543 s = String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
544 } else if (finished_in_error ()) {
545 s = String::compose (_("Error: %1"), error_summary ());
546 } else if (finished_cancelled ()) {
555 Job::json_status () const
557 boost::mutex::scoped_lock lm (_state_mutex);
563 return N_("running");
565 case PAUSED_BY_PRIORITY:
568 return N_("finished_ok");
570 return N_("finished_error");
571 case FINISHED_CANCELLED:
572 return N_("finished_cancelled");
579 /** @return An estimate of the remaining time for this sub-job, in seconds */
581 Job::remaining_time () const
583 if (progress().get_value_or(0) == 0) {
584 return elapsed_sub_time ();
587 return elapsed_sub_time() / progress().get() - elapsed_sub_time();
594 if (!_thread.joinable()) {
598 if (paused_by_user() || paused_by_priority()) {
602 _thread.interrupt ();
607 /** @return true if the job was paused, false if it was not running */
609 Job::pause_by_user ()
613 boost::mutex::scoped_lock lm (_state_mutex);
614 /* We can set _state here directly because we have a lock and we aren't
615 setting the job to FINISHED_*
617 if (_state == RUNNING) {
619 _state = PAUSED_BY_USER;
624 _pause_changed.notify_all ();
632 Job::pause_by_priority ()
635 set_state (PAUSED_BY_PRIORITY);
636 _pause_changed.notify_all ();
644 if (paused_by_user() || paused_by_priority()) {
646 _pause_changed.notify_all ();
652 Job::when_finished (boost::signals2::connection& connection, function<void()> finished)
654 boost::mutex::scoped_lock lm (_state_mutex);
655 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
658 connection = Finished.connect (finished);
664 Job::message () const
666 boost::mutex::scoped_lock lm (_state_mutex);
672 Job::set_message (string m)
674 boost::mutex::scoped_lock lm (_state_mutex);