Hand-apply 111f02f4fc8ace359a16aea1c88c2821bf3dde31 from master; improve progress...

[dcpomatic.git] / src / lib / job.h

diff --git a/src/lib/job.h b/src/lib/job.h
index f5175c525024ee6b4636e73c35f24e58cbc6a06f..f6120f1289458814d3569970a177ab5257a884b6 100644 (file)
--- a/src/lib/job.h
+++ b/src/lib/job.h
@@ -21,24 +21,24 @@
  *  @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 <boost/thread/mutex.hpp>
 #include <boost/enable_shared_from_this.hpp>
 #include <boost/signals2.hpp>
 #include <boost/thread.hpp>
+#include <string>
 
 class Film;
 
 /** @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 boost::noncopyable
 {
 public:
-       Job (boost::shared_ptr<Film>);
+       Job (boost::shared_ptr<const Film>);
        virtual ~Job() {}
 
        /** @return user-readable name of this job */
@@ -47,6 +47,8 @@ public:
        virtual void run () = 0;
        
        void start ();
+       void pause ();
+       void resume ();
        void cancel ();
 
        bool is_new () const;
@@ -55,20 +57,28 @@ public:
        bool finished_ok () const;
        bool finished_in_error () const;
        bool finished_cancelled () const;
+       bool paused () const;
 
        std::string error_summary () const;
        std::string error_details () const;
 
        int elapsed_time () const;
        virtual std::string 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;
 
-       /** Emitted by the JobManagerView from the UI thread */
+       boost::shared_ptr<const Film> film () const {
+               return _film;
+       }
+
+       boost::signals2::signal<void()> Progress;
+       /** Emitted from the UI thread when the job is finished */
        boost::signals2::signal<void()> Finished;
 
 protected:
@@ -77,9 +87,10 @@ 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
+               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
        };
@@ -87,7 +98,7 @@ protected:
        void set_state (State);
        void set_error (std::string s, std::string d);
 
-       boost::shared_ptr<Film> _film;
+       boost::shared_ptr<const Film> _film;
 
 private:
 
@@ -103,23 +114,18 @@ private:
        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;
 };