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 if (!_thread.joinable()) {
82 /* Too late to do anything about this */
86 /** Start the job in a separate thread, returning immediately */
91 _start_time = time (0);
92 _sub_start_time = time (0);
93 _thread = boost::thread (boost::bind(&Job::run_wrapper, this));
94 #ifdef DCPOMATIC_LINUX
95 pthread_setname_np (_thread.native_handle(), "job-wrapper");
99 /** A wrapper for the ::run() method to catch exceptions */
107 } catch (dcp::FileError& e) {
109 string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf());
112 boost::filesystem::space_info const s = boost::filesystem::space (e.filename());
113 if (s.available < pow (1024, 3)) {
115 m += _("The drive that the film is stored on is low in disc space. Free some more space and try again.");
121 set_error (e.what(), m);
123 set_state (FINISHED_ERROR);
125 } catch (dcp::StartCompressionError& e) {
129 #ifdef DCPOMATIC_WINDOWS
130 #if (__GNUC__ && !__x86_64__)
133 _("Failed to encode the DCP."),
134 _("This error has probably occurred because you are running the 32-bit version of DCP-o-matic and "
135 "trying to use too many encoding threads. Please reduce the 'number of threads DCP-o-matic should "
136 "use' in the General tab of Preferences and try again.")
141 if (running_32_on_64()) {
143 _("Failed to encode the DCP."),
144 _("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.")
154 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
159 set_state (FINISHED_ERROR);
161 } catch (OpenFileError& e) {
164 String::compose (_("Could not open %1"), e.file().string()),
166 _("DCP-o-matic could not open the file %1 (%2). Perhaps it does not exist or is in an unexpected format."),
167 boost::filesystem::absolute (e.file()).string(),
173 set_state (FINISHED_ERROR);
175 } catch (boost::filesystem::filesystem_error& e) {
177 if (e.code() == boost::system::errc::no_such_file_or_directory) {
179 String::compose (_("Could not open %1"), e.path1().string ()),
181 _("DCP-o-matic could not open the file %1 (%2). Perhaps it does not exist or is in an unexpected format."),
182 boost::filesystem::absolute (e.path1()).string(),
189 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
194 set_state (FINISHED_ERROR);
196 } catch (boost::thread_interrupted &) {
198 set_state (FINISHED_CANCELLED);
200 } catch (sub::SubripError& e) {
202 string extra = "Error is near:\n";
203 BOOST_FOREACH (string i, e.context()) {
207 set_error (e.what (), extra);
209 set_state (FINISHED_ERROR);
211 } catch (std::bad_alloc& e) {
213 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."));
215 set_state (FINISHED_ERROR);
217 } catch (dcp::ReadError& e) {
219 set_error (e.message(), e.detail().get_value_or(""));
221 set_state (FINISHED_ERROR);
223 } catch (KDMError& e) {
225 set_error (e.summary(), e.detail());
227 set_state (FINISHED_ERROR);
229 } catch (FileError& e) {
231 set_error (e.what(), e.what());
233 set_state (FINISHED_ERROR);
235 } catch (std::exception& e) {
239 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
243 set_state (FINISHED_ERROR);
249 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
253 set_state (FINISHED_ERROR);
257 /** @return true if this job is new (ie has not started running) */
261 boost::mutex::scoped_lock lm (_state_mutex);
262 return _state == NEW;
265 /** @return true if the job is running */
267 Job::running () const
269 boost::mutex::scoped_lock lm (_state_mutex);
270 return _state == RUNNING;
273 /** @return true if the job has finished (either successfully or unsuccessfully) */
275 Job::finished () const
277 boost::mutex::scoped_lock lm (_state_mutex);
278 return _state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED;
281 /** @return true if the job has finished successfully */
283 Job::finished_ok () const
285 boost::mutex::scoped_lock lm (_state_mutex);
286 return _state == FINISHED_OK;
289 /** @return true if the job has finished unsuccessfully */
291 Job::finished_in_error () const
293 boost::mutex::scoped_lock lm (_state_mutex);
294 return _state == FINISHED_ERROR;
298 Job::finished_cancelled () const
300 boost::mutex::scoped_lock lm (_state_mutex);
301 return _state == FINISHED_CANCELLED;
305 Job::paused_by_user () const
307 boost::mutex::scoped_lock lm (_state_mutex);
308 return _state == PAUSED_BY_USER;
312 Job::paused_by_priority () const
314 boost::mutex::scoped_lock lm (_state_mutex);
315 return _state == PAUSED_BY_PRIORITY;
318 /** Set the state of this job.
319 * @param s New state.
322 Job::set_state (State s)
324 bool finished = false;
327 boost::mutex::scoped_lock lm (_state_mutex);
330 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
331 _ran_for = time(0) - _start_time;
338 emit (boost::bind (boost::ref (Finished)));
339 FinishedImmediate ();
343 /** @return DCPTime (in seconds) that this sub-job has been running */
345 Job::elapsed_sub_time () const
347 if (_sub_start_time == 0) {
351 return time (0) - _sub_start_time;
354 /** Check to see if this job has been interrupted or paused */
356 Job::check_for_interruption_or_pause ()
358 boost::this_thread::interruption_point ();
360 boost::mutex::scoped_lock lm (_state_mutex);
361 while (_state == PAUSED_BY_USER || _state == PAUSED_BY_PRIORITY) {
362 emit (boost::bind (boost::ref (Progress)));
363 _pause_changed.wait (lm);
367 /** Set the progress of the current part of the job.
368 * @param p Progress (from 0 to 1)
369 * @param force Do not ignore this update, even if it hasn't been long since the last one.
372 Job::set_progress (float p, bool force)
374 check_for_interruption_or_pause ();
377 /* Check for excessively frequent progress reporting */
378 boost::mutex::scoped_lock lm (_progress_mutex);
380 gettimeofday (&now, 0);
381 if (_last_progress_update && _last_progress_update->tv_sec > 0) {
382 double const elapsed = (now.tv_sec + now.tv_usec / 1000000.0)
383 - (_last_progress_update->tv_sec + _last_progress_update->tv_usec / 1000000.0);
388 _last_progress_update = now;
391 set_progress_common (p);
395 Job::set_progress_common (optional<float> p)
398 boost::mutex::scoped_lock lm (_progress_mutex);
402 emit (boost::bind (boost::ref (Progress)));
405 /** @return fractional progress of the current sub-job, if known */
407 Job::progress () const
409 boost::mutex::scoped_lock lm (_progress_mutex);
417 boost::mutex::scoped_lock lm (_progress_mutex);
418 LOG_GENERAL ("Sub-job %1 starting", n);
422 set_progress (0, true);
423 _sub_start_time = time (0);
427 Job::error_details () const
429 boost::mutex::scoped_lock lm (_state_mutex);
430 return _error_details;
433 /** @return A summary of any error that the job has generated */
435 Job::error_summary () const
437 boost::mutex::scoped_lock lm (_state_mutex);
438 return _error_summary;
441 /** Set the current error string.
442 * @param s New error string.
443 * @param d New error detail string.
446 Job::set_error (string s, string d)
449 _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), LogEntry::TYPE_ERROR);
452 boost::mutex::scoped_lock lm (_state_mutex);
457 /** Say that this job's progress will be unknown until further notice */
459 Job::set_progress_unknown ()
461 check_for_interruption_or_pause ();
462 set_progress_common (optional<float> ());
465 /** @return Human-readable status of this job */
469 optional<float> p = progress ();
470 int const t = elapsed_sub_time ();
471 int const r = remaining_time ();
474 if (!finished () && p) {
475 int pc = lrintf (p.get() * 100);
477 /* 100% makes it sound like we've finished when we haven't */
482 snprintf (buffer, sizeof(buffer), "%d%%", pc);
485 if (t > 10 && r > 0) {
486 boost::posix_time::ptime now = boost::posix_time::second_clock::local_time();
487 boost::posix_time::ptime finish = now + boost::posix_time::seconds(r);
488 char finish_string[16];
489 snprintf (finish_string, sizeof(finish_string), "%02d:%02d", int(finish.time_of_day().hours()), int(finish.time_of_day().minutes()));
491 if (now.date() != finish.date()) {
492 /// TRANSLATORS: the %1 in this string will be filled in with a day of the week
493 /// to say what day a job will finish.
494 day = String::compose (_(" on %1"), day_of_week_to_string(finish.date().day_of_week()));
496 /// TRANSLATORS: "remaining; finishing at" here follows an amount of time that is remaining
497 /// on an operation; after it is an estimated wall-clock completion time.
498 s += String::compose(
499 _("; %1 remaining; finishing at %2%3"),
500 seconds_to_approximate_hms(r), finish_string, day
503 } else if (finished_ok ()) {
504 s = String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
505 } else if (finished_in_error ()) {
506 s = String::compose (_("Error: %1"), error_summary ());
507 } else if (finished_cancelled ()) {
515 Job::json_status () const
517 boost::mutex::scoped_lock lm (_state_mutex);
523 return N_("running");
525 case PAUSED_BY_PRIORITY:
528 return N_("finished_ok");
530 return N_("finished_error");
531 case FINISHED_CANCELLED:
532 return N_("finished_cancelled");
538 /** @return An estimate of the remaining time for this sub-job, in seconds */
540 Job::remaining_time () const
542 if (progress().get_value_or(0) == 0) {
543 return elapsed_sub_time ();
546 return elapsed_sub_time() / progress().get() - elapsed_sub_time();
552 if (!_thread.joinable()) {
556 if (paused_by_user() || paused_by_priority()) {
560 _thread.interrupt ();
564 /** @return true if the job was paused, false if it was not running */
566 Job::pause_by_user ()
570 boost::mutex::scoped_lock lm (_state_mutex);
571 /* We can set _state here directly because we have a lock and we aren't
572 setting the job to FINISHED_*
574 if (_state == RUNNING) {
576 _state = PAUSED_BY_USER;
581 _pause_changed.notify_all ();
588 Job::pause_by_priority ()
591 set_state (PAUSED_BY_PRIORITY);
592 _pause_changed.notify_all ();
599 if (paused_by_user() || paused_by_priority()) {
601 _pause_changed.notify_all ();
606 Job::when_finished (boost::signals2::connection& connection, function<void()> finished)
608 boost::mutex::scoped_lock lm (_state_mutex);
609 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
612 connection = Finished.connect (finished);
617 Job::message () const
619 boost::mutex::scoped_lock lm (_state_mutex);
624 Job::set_message (string m)
626 boost::mutex::scoped_lock lm (_state_mutex);