2 Copyright (C) 2012-2019 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/>.
22 * @brief A parent class to represent long-running tasks which are run in their own thread.
28 #include "exceptions.h"
31 #include "dcpomatic_log.h"
32 #include "compose.hpp"
33 #include <dcp/exceptions.h>
34 #include <sub/exceptions.h>
35 #include <boost/thread.hpp>
36 #include <boost/filesystem.hpp>
37 #include <boost/foreach.hpp>
38 #include <boost/date_time/posix_time/posix_time.hpp>
46 using boost::shared_ptr;
47 using boost::optional;
48 using boost::function;
49 using namespace dcpomatic;
51 /** @param film Associated film, or 0 */
52 Job::Job (shared_ptr<const Film> film)
65 #ifdef DCPOMATIC_DEBUG
66 /* Any subclass should have called stop_thread in its destructor */
67 assert (!_thread.joinable());
74 boost::this_thread::disable_interruption dis;
82 /** Start the job in a separate thread, returning immediately */
87 _start_time = time (0);
88 _sub_start_time = time (0);
89 _thread = boost::thread (boost::bind(&Job::run_wrapper, this));
90 #ifdef DCPOMATIC_LINUX
91 pthread_setname_np (_thread.native_handle(), "job-wrapper");
95 /** A wrapper for the ::run() method to catch exceptions */
103 } catch (dcp::FileError& e) {
105 string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf());
108 boost::filesystem::space_info const s = boost::filesystem::space (e.filename());
109 if (s.available < pow (1024, 3)) {
111 m += _("The drive that the film is stored on is low in disc space. Free some more space and try again.");
117 set_error (e.what(), m);
119 set_state (FINISHED_ERROR);
121 } catch (dcp::StartCompressionError& e) {
125 #ifdef DCPOMATIC_WINDOWS
126 #if (__GNUC__ && !__x86_64__)
129 _("Failed to encode the DCP."),
130 _("This error has probably occurred because you are running the 32-bit version of DCP-o-matic and "
131 "trying to use too many encoding threads. Please reduce the 'number of threads DCP-o-matic should "
132 "use' in the General tab of Preferences and try again.")
137 if (running_32_on_64()) {
139 _("Failed to encode the DCP."),
140 _("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.")
150 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
155 set_state (FINISHED_ERROR);
157 } catch (OpenFileError& e) {
160 String::compose (_("Could not open %1"), e.file().string()),
162 _("DCP-o-matic could not open the file %1 (%2). Perhaps it does not exist or is in an unexpected format."),
163 boost::filesystem::absolute (e.file()).string(),
169 set_state (FINISHED_ERROR);
171 } catch (boost::filesystem::filesystem_error& e) {
173 if (e.code() == boost::system::errc::no_such_file_or_directory) {
175 String::compose (_("Could not open %1"), e.path1().string ()),
177 _("DCP-o-matic could not open the file %1 (%2). Perhaps it does not exist or is in an unexpected format."),
178 boost::filesystem::absolute (e.path1()).string(),
185 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
190 set_state (FINISHED_ERROR);
192 } catch (boost::thread_interrupted &) {
194 set_state (FINISHED_CANCELLED);
196 } catch (sub::SubripError& e) {
198 string extra = "Error is near:\n";
199 BOOST_FOREACH (string i, e.context()) {
203 set_error (e.what (), extra);
205 set_state (FINISHED_ERROR);
207 } catch (std::bad_alloc& e) {
209 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."));
211 set_state (FINISHED_ERROR);
213 } catch (dcp::ReadError& e) {
215 set_error (e.message(), e.detail().get_value_or(""));
217 set_state (FINISHED_ERROR);
219 } catch (KDMError& e) {
221 set_error (e.summary(), e.detail());
223 set_state (FINISHED_ERROR);
225 } catch (FileError& e) {
227 set_error (e.what(), e.what());
229 set_state (FINISHED_ERROR);
231 } catch (std::exception& e) {
235 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
239 set_state (FINISHED_ERROR);
245 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
249 set_state (FINISHED_ERROR);
253 /** @return true if this job is new (ie has not started running) */
257 boost::mutex::scoped_lock lm (_state_mutex);
258 return _state == NEW;
261 /** @return true if the job is running */
263 Job::running () const
265 boost::mutex::scoped_lock lm (_state_mutex);
266 return _state == RUNNING;
269 /** @return true if the job has finished (either successfully or unsuccessfully) */
271 Job::finished () const
273 boost::mutex::scoped_lock lm (_state_mutex);
274 return _state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED;
277 /** @return true if the job has finished successfully */
279 Job::finished_ok () const
281 boost::mutex::scoped_lock lm (_state_mutex);
282 return _state == FINISHED_OK;
285 /** @return true if the job has finished unsuccessfully */
287 Job::finished_in_error () const
289 boost::mutex::scoped_lock lm (_state_mutex);
290 return _state == FINISHED_ERROR;
294 Job::finished_cancelled () const
296 boost::mutex::scoped_lock lm (_state_mutex);
297 return _state == FINISHED_CANCELLED;
301 Job::paused_by_user () const
303 boost::mutex::scoped_lock lm (_state_mutex);
304 return _state == PAUSED_BY_USER;
308 Job::paused_by_priority () const
310 boost::mutex::scoped_lock lm (_state_mutex);
311 return _state == PAUSED_BY_PRIORITY;
314 /** Set the state of this job.
315 * @param s New state.
318 Job::set_state (State s)
320 bool finished = false;
323 boost::mutex::scoped_lock lm (_state_mutex);
326 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
327 _ran_for = time(0) - _start_time;
334 emit (boost::bind (boost::ref (Finished)));
335 FinishedImmediate ();
339 /** @return DCPTime (in seconds) that this sub-job has been running */
341 Job::elapsed_sub_time () const
343 if (_sub_start_time == 0) {
347 return time (0) - _sub_start_time;
350 /** Check to see if this job has been interrupted or paused */
352 Job::check_for_interruption_or_pause ()
354 boost::this_thread::interruption_point ();
356 boost::mutex::scoped_lock lm (_state_mutex);
357 while (_state == PAUSED_BY_USER || _state == PAUSED_BY_PRIORITY) {
358 emit (boost::bind (boost::ref (Progress)));
359 _pause_changed.wait (lm);
363 /** Set the progress of the current part of the job.
364 * @param p Progress (from 0 to 1)
365 * @param force Do not ignore this update, even if it hasn't been long since the last one.
368 Job::set_progress (float p, bool force)
370 check_for_interruption_or_pause ();
373 /* Check for excessively frequent progress reporting */
374 boost::mutex::scoped_lock lm (_progress_mutex);
376 gettimeofday (&now, 0);
377 if (_last_progress_update && _last_progress_update->tv_sec > 0) {
378 double const elapsed = (now.tv_sec + now.tv_usec / 1000000.0)
379 - (_last_progress_update->tv_sec + _last_progress_update->tv_usec / 1000000.0);
384 _last_progress_update = now;
387 set_progress_common (p);
391 Job::set_progress_common (optional<float> p)
394 boost::mutex::scoped_lock lm (_progress_mutex);
398 emit (boost::bind (boost::ref (Progress)));
401 /** @return fractional progress of the current sub-job, if known */
403 Job::progress () const
405 boost::mutex::scoped_lock lm (_progress_mutex);
413 boost::mutex::scoped_lock lm (_progress_mutex);
414 LOG_GENERAL ("Sub-job %1 starting", n);
418 set_progress (0, true);
419 _sub_start_time = time (0);
423 Job::error_details () const
425 boost::mutex::scoped_lock lm (_state_mutex);
426 return _error_details;
429 /** @return A summary of any error that the job has generated */
431 Job::error_summary () const
433 boost::mutex::scoped_lock lm (_state_mutex);
434 return _error_summary;
437 /** Set the current error string.
438 * @param s New error string.
439 * @param d New error detail string.
442 Job::set_error (string s, string d)
445 _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), LogEntry::TYPE_ERROR);
448 boost::mutex::scoped_lock lm (_state_mutex);
453 /** Say that this job's progress will be unknown until further notice */
455 Job::set_progress_unknown ()
457 check_for_interruption_or_pause ();
458 set_progress_common (optional<float> ());
461 /** @return Human-readable status of this job */
465 optional<float> p = progress ();
466 int const t = elapsed_sub_time ();
467 int const r = remaining_time ();
470 if (!finished () && p) {
471 int pc = lrintf (p.get() * 100);
473 /* 100% makes it sound like we've finished when we haven't */
478 snprintf (buffer, sizeof(buffer), "%d%%", pc);
481 if (t > 10 && r > 0) {
482 boost::posix_time::ptime now = boost::posix_time::second_clock::local_time();
483 boost::posix_time::ptime finish = now + boost::posix_time::seconds(r);
484 char finish_string[16];
485 snprintf (finish_string, sizeof(finish_string), "%02d:%02d", int(finish.time_of_day().hours()), int(finish.time_of_day().minutes()));
487 if (now.date() != finish.date()) {
488 /// TRANSLATORS: the %1 in this string will be filled in with a day of the week
489 /// to say what day a job will finish.
490 day = String::compose (_(" on %1"), day_of_week_to_string(finish.date().day_of_week()));
492 /// TRANSLATORS: "remaining; finishing at" here follows an amount of time that is remaining
493 /// on an operation; after it is an estimated wall-clock completion time.
494 s += String::compose(
495 _("; %1 remaining; finishing at %2%3"),
496 seconds_to_approximate_hms(r), finish_string, day
499 } else if (finished_ok ()) {
500 s = String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
501 } else if (finished_in_error ()) {
502 s = String::compose (_("Error: %1"), error_summary ());
503 } else if (finished_cancelled ()) {
511 Job::json_status () const
513 boost::mutex::scoped_lock lm (_state_mutex);
519 return N_("running");
521 case PAUSED_BY_PRIORITY:
524 return N_("finished_ok");
526 return N_("finished_error");
527 case FINISHED_CANCELLED:
528 return N_("finished_cancelled");
534 /** @return An estimate of the remaining time for this sub-job, in seconds */
536 Job::remaining_time () const
538 if (progress().get_value_or(0) == 0) {
539 return elapsed_sub_time ();
542 return elapsed_sub_time() / progress().get() - elapsed_sub_time();
548 if (!_thread.joinable()) {
552 if (paused_by_user() || paused_by_priority()) {
556 _thread.interrupt ();
560 /** @return true if the job was paused, false if it was not running */
562 Job::pause_by_user ()
566 boost::mutex::scoped_lock lm (_state_mutex);
567 /* We can set _state here directly because we have a lock and we aren't
568 setting the job to FINISHED_*
570 if (_state == RUNNING) {
572 _state = PAUSED_BY_USER;
577 _pause_changed.notify_all ();
584 Job::pause_by_priority ()
587 set_state (PAUSED_BY_PRIORITY);
588 _pause_changed.notify_all ();
595 if (paused_by_user() || paused_by_priority()) {
597 _pause_changed.notify_all ();
602 Job::when_finished (boost::signals2::connection& connection, function<void()> finished)
604 boost::mutex::scoped_lock lm (_state_mutex);
605 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
608 connection = Finished.connect (finished);
613 Job::message () const
615 boost::mutex::scoped_lock lm (_state_mutex);
620 Job::set_message (string m)
622 boost::mutex::scoped_lock lm (_state_mutex);