/*
Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
- This program is free software; you can redistribute it and/or modify
+ This file is part of DCP-o-matic.
+
+ DCP-o-matic is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
- This program is distributed in the hope that it will be useful,
+ DCP-o-matic is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
*/
-/** @file src/job.cc
+/** @file src/job.cc
* @brief A parent class to represent long-running tasks which are run in their own thread.
*/
-#include <boost/thread.hpp>
-#include <boost/filesystem.hpp>
-#include <dcp/exceptions.h>
#include "job.h"
#include "util.h"
#include "cross.h"
-#include "ui_signaller.h"
#include "exceptions.h"
#include "film.h"
#include "log.h"
+#include "compose.hpp"
+#include <dcp/exceptions.h>
+#include <boost/thread.hpp>
+#include <boost/filesystem.hpp>
+#include <iostream>
#include "i18n.h"
using std::cout;
using boost::shared_ptr;
using boost::optional;
+using boost::function;
-#define LOG_ERROR_NC(...) _film->log()->log (__VA_ARGS__, Log::TYPE_ERROR);
+#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);
-Job::Job (shared_ptr<const Film> f)
- : _film (f)
+/** @param film Associated film, or 0 */
+Job::Job (shared_ptr<const Film> film)
+ : _film (film)
, _thread (0)
, _state (NEW)
, _start_time (0)
+ , _sub_start_time (0)
, _progress (0)
, _ran_for (0)
{
}
+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 */
+ }
+ }
+ }
+
+ delete _thread;
+}
+
/** Start the job in a separate thread, returning immediately */
void
Job::start ()
{
set_state (RUNNING);
_start_time = time (0);
+ _sub_start_time = time (0);
_thread = new boost::thread (boost::bind (&Job::run_wrapper, this));
}
set_error (e.what(), m);
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."), 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()
+ )
);
set_progress (1);
set_state (FINISHED_ERROR);
+ } catch (boost::filesystem::filesystem_error& e) {
+
+ if (e.code() == boost::system::errc::no_such_file_or_directory) {
+ 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()
+ )
+ );
+ } else {
+ set_error (
+ e.what (),
+ string (_("It is not known what caused this error.")) + " " + REPORT_PROBLEM
+ );
+ }
+
+ set_progress (1);
+ set_state (FINISHED_ERROR);
+
} catch (boost::thread_interrupted &) {
set_state (FINISHED_CANCELLED);
} catch (std::bad_alloc& e) {
- set_error (_("Out of memory"), _("There was not enough memory to do this."));
+ 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."));
set_progress (1);
set_state (FINISHED_ERROR);
-
+
} catch (std::exception& e) {
set_error (
set_progress (1);
set_state (FINISHED_ERROR);
-
+
} catch (...) {
set_error (
boost::mutex::scoped_lock lm (_state_mutex);
return _state == PAUSED;
}
-
+
/** Set the state of this job.
* @param s New state.
*/
_state = s;
if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
- _ran_for = elapsed_time ();
+ _ran_for = time(0) - _start_time;
finished = true;
_sub_name.clear ();
}
}
- if (finished && ui_signaller) {
- ui_signaller->emit (boost::bind (boost::ref (Finished)));
- }
+ if (finished) {
+ emit (boost::bind (boost::ref (Finished)));
+ }
}
/** @return DCPTime (in seconds) that this sub-job has been running */
int
-Job::elapsed_time () const
+Job::elapsed_sub_time () const
{
- if (_start_time == 0) {
+ if (_sub_start_time == 0) {
return 0;
}
-
- return time (0) - _start_time;
+
+ return time (0) - _sub_start_time;
}
/** Set the progress of the current part of the job.
void
Job::set_progress (float p, bool force)
{
- if (!force && fabs (p - progress().get_value_or(0)) < 0.01) {
- /* Calm excessive progress reporting */
- return;
+ if (!force) {
+ /* Check for excessively frequent progress reporting */
+ boost::mutex::scoped_lock lm (_progress_mutex);
+ struct timeval now;
+ gettimeofday (&now, 0);
+ if (_last_progress_update && _last_progress_update->tv_sec > 0) {
+ double const elapsed = (now.tv_sec + now.tv_usec / 1000000.0)
+ - (_last_progress_update->tv_sec + _last_progress_update->tv_usec / 1000000.0);
+ if (elapsed < 0.5) {
+ return;
+ }
+ }
+ _last_progress_update = now;
}
+ set_progress_common (p);
+}
+
+void
+Job::set_progress_common (optional<float> p)
+{
boost::mutex::scoped_lock lm (_progress_mutex);
_progress = p;
boost::this_thread::interruption_point ();
_pause_changed.wait (lm2);
}
- if (ui_signaller) {
- ui_signaller->emit (boost::bind (boost::ref (Progress)));
- }
+ lm.unlock ();
+ lm2.unlock ();
+
+ emit (boost::bind (boost::ref (Progress)));
}
/** @return fractional progress of the current sub-job, if known */
{
{
boost::mutex::scoped_lock lm (_progress_mutex);
+ LOG_GENERAL ("Sub-job %1 starting", n);
_sub_name = n;
}
-
+
set_progress (0, true);
+ _sub_start_time = time (0);
}
string
void
Job::set_error (string s, string d)
{
- LOG_ERROR_NC (s);
- LOG_ERROR_NC (d);
-
- _film->log()->log (String::compose ("Error in job: %1 (%2)", s, d), Log::TYPE_ERROR);
+ 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);
+ }
+
boost::mutex::scoped_lock lm (_state_mutex);
_error_summary = s;
_error_details = d;
void
Job::set_progress_unknown ()
{
- boost::mutex::scoped_lock lm (_progress_mutex);
- _progress.reset ();
- lm.unlock ();
-
- if (ui_signaller) {
- ui_signaller->emit (boost::bind (boost::ref (Progress)));
- }
+ set_progress_common (optional<float> ());
}
/** @return Human-readable status of this job */
Job::status () const
{
optional<float> p = progress ();
- int const t = elapsed_time ();
+ int const t = elapsed_sub_time ();
int const r = remaining_time ();
- SafeStringStream s;
+ locked_stringstream s;
if (!finished () && p) {
- int pc = rint (p.get() * 100);
+ int pc = lrintf (p.get() * 100);
if (pc == 100) {
/* 100% makes it sound like we've finished when we haven't */
pc = 99;
}
-
+
s << pc << N_("%");
-
+
if (t > 10 && r > 0) {
/// TRANSLATORS: remaining here follows an amount of time that is remaining
/// on an operation.
} else if (finished_ok ()) {
s << String::compose (_("OK (ran for %1)"), seconds_to_hms (_ran_for));
} else if (finished_in_error ()) {
- s << String::compose (_("Error (%1)"), error_summary ());
+ s << String::compose (_("Error: %1"), error_summary ());
} else if (finished_cancelled ()) {
s << _("Cancelled");
}
Job::remaining_time () const
{
if (progress().get_value_or(0) == 0) {
- return elapsed_time ();
+ return elapsed_sub_time ();
}
-
- return elapsed_time() / progress().get() - elapsed_time();
+
+ return elapsed_sub_time() / progress().get() - elapsed_sub_time();
}
void
return;
}
+ if (paused ()) {
+ resume ();
+ }
+
_thread->interrupt ();
+ DCPOMATIC_ASSERT (_thread->joinable ());
_thread->join ();
+ delete _thread;
+ _thread = 0;
}
void
_pause_changed.notify_all ();
}
}
+
+void
+Job::when_finished (boost::signals2::connection& connection, function<void()> finished)
+{
+ boost::mutex::scoped_lock lm (_state_mutex);
+ if (_state == FINISHED_OK || _state == FINISHED_ERROR || _state == FINISHED_CANCELLED) {
+ finished ();
+ } else {
+ connection = Finished.connect (finished);
+ }
+}
projects / dcpomatic.git / blobdiff