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)
73 _thread->interrupt ();
74 /* We can't use DCPOMATIC_ASSERT here as it may throw an exception */
75 if (_thread->joinable ()) {
79 /* Too late to do anything about this */
88 /** Start the job in a separate thread, returning immediately */
93 _start_time = time (0);
94 _sub_start_time = time (0);
95 _thread = new boost::thread (boost::bind (&Job::run_wrapper, this));
96 #ifdef DCPOMATIC_LINUX
97 pthread_setname_np (_thread->native_handle(), "job-wrapper");
101 /** A wrapper for the ::run() method to catch exceptions */
109 } catch (dcp::FileError& e) {
111 string m = String::compose (_("An error occurred whilst handling the file %1."), boost::filesystem::path (e.filename()).leaf());
114 boost::filesystem::space_info const s = boost::filesystem::space (e.filename());
115 if (s.available < pow (1024, 3)) {
117 m += _("The drive that the film is stored on is low in disc space. Free some more space and try again.");
123 set_error (e.what(), m);
125 set_state (FINISHED_ERROR);
127 } catch (OpenFileError& e) {
130 String::compose (_("Could not open %1"), e.file().string()),
132 _("DCP-o-matic could not open the file %1 (%2). Perhaps it does not exist or is in an unexpected format."),
133 boost::filesystem::absolute (e.file()).string(),
139 set_state (FINISHED_ERROR);
141 } catch (boost::filesystem::filesystem_error& e) {
143 if (e.code() == boost::system::errc::no_such_file_or_directory) {
145 String::compose (_("Could not open %1"), e.path1().string ()),
147 _("DCP-o-matic could not open the file %1 (%2). Perhaps it does not exist or is in an unexpected format."),
148 boost::filesystem::absolute (e.path1()).string(),
155 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
160 set_state (FINISHED_ERROR);
162 } catch (boost::thread_interrupted &) {
164 set_state (FINISHED_CANCELLED);
166 } catch (sub::SubripError& e) {
168 string extra = "Error is near:\n";
169 BOOST_FOREACH (string i, e.context()) {
173 set_error (e.what (), extra);
175 set_state (FINISHED_ERROR);
177 } catch (std::bad_alloc& e) {
179 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."));
181 set_state (FINISHED_ERROR);
183 } catch (dcp::MissingAssetError& e) {
185 set_error (e.message(), e.path().string());
187 set_state (FINISHED_ERROR);
189 } catch (dcp::DCPReadError& e) {
191 set_error (e.message(), e.detail().get_value_or(""));
193 set_state (FINISHED_ERROR);
195 } catch (KDMError& e) {
197 set_error (e.summary(), e.detail());
199 set_state (FINISHED_ERROR);
201 } catch (FileError& e) {
203 set_error (e.what(), e.what());
205 set_state (FINISHED_ERROR);
207 } catch (std::exception& e) {
211 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
215 set_state (FINISHED_ERROR);
221 string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
225 set_state (FINISHED_ERROR);
229 /** @return true if this job is new (ie has not started running) */
233 boost::mutex::scoped_lock lm (_state_mutex);
234 return _state == NEW;
237 /** @return true if the job is running */
239 Job::running () const
241 boost::mutex::scoped_lock lm (_state_mutex);
242 return _state == RUNNING;
245 /** @return true if the job has finished (either successfully or unsuccessfully) */
247 Job::finished () const
249 boost::mutex::scoped_lock lm (_state_mutex);
250 return _state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED;
253 /** @return true if the job has finished successfully */
255 Job::finished_ok () const
257 boost::mutex::scoped_lock lm (_state_mutex);
258 return _state == FINISHED_OK;
261 /** @return true if the job has finished unsuccessfully */
263 Job::finished_in_error () const
265 boost::mutex::scoped_lock lm (_state_mutex);
266 return _state == FINISHED_ERROR;
270 Job::finished_cancelled () const
272 boost::mutex::scoped_lock lm (_state_mutex);
273 return _state == FINISHED_CANCELLED;
277 Job::paused_by_user () const
279 boost::mutex::scoped_lock lm (_state_mutex);
280 return _state == PAUSED_BY_USER;
284 Job::paused_by_priority () const
286 boost::mutex::scoped_lock lm (_state_mutex);
287 return _state == PAUSED_BY_PRIORITY;
290 /** Set the state of this job.
291 * @param s New state.
294 Job::set_state (State s)
296 bool finished = false;
299 boost::mutex::scoped_lock lm (_state_mutex);
302 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
303 _ran_for = time(0) - _start_time;
310 emit (boost::bind (boost::ref (Finished)));
311 FinishedImmediate ();
315 /** @return DCPTime (in seconds) that this sub-job has been running */
317 Job::elapsed_sub_time () const
319 if (_sub_start_time == 0) {
323 return time (0) - _sub_start_time;
326 /** Check to see if this job has been interrupted or paused */
328 Job::check_for_interruption_or_pause ()
330 boost::this_thread::interruption_point ();
332 boost::mutex::scoped_lock lm (_state_mutex);
333 while (_state == PAUSED_BY_USER || _state == PAUSED_BY_PRIORITY) {
334 emit (boost::bind (boost::ref (Progress)));
335 _pause_changed.wait (lm);
339 /** Set the progress of the current part of the job.
340 * @param p Progress (from 0 to 1)
341 * @param force Do not ignore this update, even if it hasn't been long since the last one.
344 Job::set_progress (float p, bool force)
346 check_for_interruption_or_pause ();
349 /* Check for excessively frequent progress reporting */
350 boost::mutex::scoped_lock lm (_progress_mutex);
352 gettimeofday (&now, 0);
353 if (_last_progress_update && _last_progress_update->tv_sec > 0) {
354 double const elapsed = (now.tv_sec + now.tv_usec / 1000000.0)
355 - (_last_progress_update->tv_sec + _last_progress_update->tv_usec / 1000000.0);
360 _last_progress_update = now;
363 set_progress_common (p);
367 Job::set_progress_common (optional<float> p)
370 boost::mutex::scoped_lock lm (_progress_mutex);
374 emit (boost::bind (boost::ref (Progress)));
377 /** @return fractional progress of the current sub-job, if known */
379 Job::progress () const
381 boost::mutex::scoped_lock lm (_progress_mutex);
389 boost::mutex::scoped_lock lm (_progress_mutex);
390 LOG_GENERAL ("Sub-job %1 starting", n);
394 set_progress (0, true);
395 _sub_start_time = time (0);
399 Job::error_details () const
401 boost::mutex::scoped_lock lm (_state_mutex);
402 return _error_details;
405 /** @return A summary of any error that the job has generated */
407 Job::error_summary () const
409 boost::mutex::scoped_lock lm (_state_mutex);
410 return _error_summary;
413 /** Set the current error string.
414 * @param s New error string.
415 * @param d New error detail string.
418 Job::set_error (string s, string d)
421 _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), LogEntry::TYPE_ERROR);
424 boost::mutex::scoped_lock lm (_state_mutex);
429 /** Say that this job's progress will be unknown until further notice */
431 Job::set_progress_unknown ()
433 check_for_interruption_or_pause ();
434 set_progress_common (optional<float> ());
437 /** @return Human-readable status of this job */
441 optional<float> p = progress ();
442 int const t = elapsed_sub_time ();
443 int const r = remaining_time ();
446 if (!finished () && p) {
447 int pc = lrintf (p.get() * 100);
449 /* 100% makes it sound like we've finished when we haven't */
454 snprintf (buffer, sizeof(buffer), "%d%%", pc);
457 if (t > 10 && r > 0) {
458 boost::posix_time::ptime now = boost::posix_time::second_clock::local_time();
459 boost::posix_time::ptime finish = now + boost::posix_time::seconds(r);
460 char finish_string[16];
461 snprintf (finish_string, sizeof(finish_string), "%02d:%02d", int(finish.time_of_day().hours()), int(finish.time_of_day().minutes()));
463 if (now.date() != finish.date()) {
464 /// TRANSLATORS: the %1 in this string will be filled in with a day of the week
465 /// to say what day a job will finish.
466 day = String::compose (_(" on %1"), day_of_week_to_string(finish.date().day_of_week()));
468 /// TRANSLATORS: "remaining; finishing at" here follows an amount of time that is remaining
469 /// on an operation; after it is an estimated wall-clock completion time.
470 s += String::compose(
471 _("; %1 remaining; finishing at %2%3"),
472 seconds_to_approximate_hms(r), finish_string, day
475 } else if (finished_ok ()) {
476 s = String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
477 } else if (finished_in_error ()) {
478 s = String::compose (_("Error: %1"), error_summary ());
479 } else if (finished_cancelled ()) {
487 Job::json_status () const
489 boost::mutex::scoped_lock lm (_state_mutex);
495 return N_("running");
497 case PAUSED_BY_PRIORITY:
500 return N_("finished_ok");
502 return N_("finished_error");
503 case FINISHED_CANCELLED:
504 return N_("finished_cancelled");
510 /** @return An estimate of the remaining time for this sub-job, in seconds */
512 Job::remaining_time () const
514 if (progress().get_value_or(0) == 0) {
515 return elapsed_sub_time ();
518 return elapsed_sub_time() / progress().get() - elapsed_sub_time();
528 if (paused_by_user() || paused_by_priority()) {
532 _thread->interrupt ();
533 DCPOMATIC_ASSERT (_thread->joinable ());
539 /** @return true if the job was paused, false if it was not running */
541 Job::pause_by_user ()
545 boost::mutex::scoped_lock lm (_state_mutex);
546 /* We can set _state here directly because we have a lock and we aren't
547 setting the job to FINISHED_*
549 if (_state == RUNNING) {
551 _state = PAUSED_BY_USER;
556 _pause_changed.notify_all ();
563 Job::pause_by_priority ()
566 set_state (PAUSED_BY_PRIORITY);
567 _pause_changed.notify_all ();
574 if (paused_by_user() || paused_by_priority()) {
576 _pause_changed.notify_all ();
581 Job::when_finished (boost::signals2::connection& connection, function<void()> finished)
583 boost::mutex::scoped_lock lm (_state_mutex);
584 if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
587 connection = Finished.connect (finished);
592 Job::message () const
594 boost::mutex::scoped_lock lm (_state_mutex);
599 Job::set_message (string m)
601 boost::mutex::scoped_lock lm (_state_mutex);