X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Fjob.h;h=a6777bc449e4a805c3db74d72c6c9d25938bba8e;hp=41cefb9bee113a2ba322f06845fb4e02cf3daca0;hb=3828baf56467224f5d44049bf1e7a7ed11f43a05;hpb=5e8d74d83b479c3175e837c402d341fb558d3873

diff --git a/src/lib/job.h b/src/lib/job.h
index 41cefb9be..a6777bc44 100644
--- a/src/lib/job.h
+++ b/src/lib/job.h
@@ -1,19 +1,20 @@
 /*
     Copyright (C) 2012 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/>.
 
 */
 
@@ -21,54 +22,69 @@
  *  @brief A parent class to represent long-running tasks which are run in their own thread.
  */
 
-#ifndef DVDOMATIC_JOB_H
-#define DVDOMATIC_JOB_H
+#ifndef DCPOMATIC_JOB_H
+#define DCPOMATIC_JOB_H
 
-#include <string>
+#include "signaller.h"
 #include <boost/thread/mutex.hpp>
 #include <boost/enable_shared_from_this.hpp>
 #include <boost/signals2.hpp>
+#include <boost/thread.hpp>
+#include <string>
 
 class Film;
-class Options;
 
 /** @class Job
  *  @brief A parent class to represent long-running tasks which are run in their own thread.
  */
-class Job : public boost::enable_shared_from_this<Job>
+class Job : public boost::enable_shared_from_this<Job>, public Signaller, public boost::noncopyable
 {
 public:
-	Job (boost::shared_ptr<Film> s, boost::shared_ptr<Job> req);
-	virtual ~Job() {}
+	Job (boost::shared_ptr<const Film>);
+	virtual ~Job ();
 
 	/** @return user-readable name of this job */
 	virtual std::string name () const = 0;
+	virtual std::string json_name () const = 0;
 	/** Run this job in the current thread. */
 	virtual void run () = 0;
-	
+
 	void start ();
+	void pause ();
+	void resume ();
+	void cancel ();
 
 	bool is_new () const;
 	bool running () const;
 	bool finished () const;
 	bool finished_ok () const;
 	bool finished_in_error () const;
+	bool finished_cancelled () const;
+	bool paused () const;
 
-	std::string error () const;
+	std::string error_summary () const;
+	std::string error_details () const;
 
 	int elapsed_time () const;
 	virtual std::string status () const;
+	std::string json_status () const;
+	std::string sub_name () const {
+		return _sub_name;
+	}
 
 	void set_progress_unknown ();
-	void set_progress (float);
-	void ascend ();
-	void descend (float);
-	float overall_progress () const;
+	void set_progress (float, bool force = false);
+	void sub (std::string);
+	boost::optional<float> progress () const;
 
-	boost::shared_ptr<Job> required () const {
-		return _required;
+	boost::shared_ptr<const Film> film () const {
+		return _film;
 	}
 
+	void when_finished (boost::signals2::connection& connection, boost::function<void()> finished);
+
+	boost::signals2::signal<void()> Progress;
+	/** Emitted from the UI thread when the job is finished */
 	boost::signals2::signal<void()> Finished;
 
 protected:
@@ -77,48 +93,46 @@ protected:
 
 	/** Description of a job's state */
 	enum State {
-		NEW,           ///< the job hasn't been started yet
-		RUNNING,       ///< the job is running
-		FINISHED_OK,   ///< the job has finished successfully
-		FINISHED_ERROR ///< the job has finished in error
+		NEW,		///< the job hasn't been started yet
+		RUNNING,	///< the job is running
+		PAUSED,		///< the job has been paused
+		FINISHED_OK,	///< the job has finished successfully
+		FINISHED_ERROR, ///< the job has finished in error
+		FINISHED_CANCELLED ///< the job was cancelled
 	};
-	
+
 	void set_state (State);
-	void set_error (std::string e);
+	void set_error (std::string s, std::string d);
 
-	/** Film for this job */
-	boost::shared_ptr<Film> _film;
+	boost::shared_ptr<const Film> _film;
 
 private:
 
 	void run_wrapper ();
+	void set_progress_common (boost::optional<float> p);
 
-	boost::shared_ptr<Job> _required;
+	boost::thread* _thread;
 
 	/** mutex for _state and _error */
 	mutable boost::mutex _state_mutex;
 	/** current state of the job */
 	State _state;
-	/** message for an error that has occurred (when state == FINISHED_ERROR) */
-	std::string _error;
+	/** summary of an error that has occurred (when state == FINISHED_ERROR) */
+	std::string _error_summary;
+	std::string _error_details;
 
-	/** time that this job was started */
+	/** time that this sub-job was started */
 	time_t _start_time;
+	std::string _sub_name;
 
-	/** mutex for _stack and _progress_unknown */
+	/** mutex for _progress */
 	mutable boost::mutex _progress_mutex;
+	boost::optional<float> _progress;
 
-	struct Level {
-		Level (float a) : allocation (a), normalised (0) {}
-
-		float allocation;
-		float normalised;
-	};
-
-	std::list<Level> _stack;
-
-	/** true if this job's progress will always be unknown */
-	bool _progress_unknown;
+	/** condition to signal changes to pause/resume so that we know when to wake;
+	    this could be a general _state_change if it made more sense.
+	*/
+	boost::condition_variable _pause_changed;
 
 	int _ran_for;
 };