Merge branch '1.0' of ssh://carlh.dnsalias.org/home/carl/git/dvdomatic into 1.0
[dcpomatic.git] / src / lib / job.h
1 /*
2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 /** @file src/job.h
21  *  @brief A parent class to represent long-running tasks which are run in their own thread.
22  */
23
24 #ifndef DCPOMATIC_JOB_H
25 #define DCPOMATIC_JOB_H
26
27 #include <string>
28 #include <boost/thread/mutex.hpp>
29 #include <boost/enable_shared_from_this.hpp>
30 #include <boost/signals2.hpp>
31 #include <boost/thread.hpp>
32
33 class Film;
34
35 /** @class Job
36  *  @brief A parent class to represent long-running tasks which are run in their own thread.
37  */
38 class Job : public boost::enable_shared_from_this<Job>, public boost::noncopyable
39 {
40 public:
41         Job (boost::shared_ptr<const Film>);
42         virtual ~Job() {}
43
44         /** @return user-readable name of this job */
45         virtual std::string name () const = 0;
46         /** Run this job in the current thread. */
47         virtual void run () = 0;
48         
49         void start ();
50         void pause ();
51         void resume ();
52         void cancel ();
53
54         bool is_new () const;
55         bool running () const;
56         bool finished () const;
57         bool finished_ok () const;
58         bool finished_in_error () const;
59         bool finished_cancelled () const;
60         bool paused () const;
61
62         std::string error_summary () const;
63         std::string error_details () const;
64
65         int elapsed_time () const;
66         virtual std::string status () const;
67
68         void set_progress_unknown ();
69         void set_progress (float);
70         void ascend ();
71         void descend (float);
72         float overall_progress () const;
73         bool progress_unknown () const {
74                 return _progress_unknown;
75         }
76
77         boost::signals2::signal<void()> Progress;
78         /** Emitted from the UI thread when the job is finished */
79         boost::signals2::signal<void()> Finished;
80
81 protected:
82
83         virtual int remaining_time () const;
84
85         /** Description of a job's state */
86         enum State {
87                 NEW,            ///< the job hasn't been started yet
88                 RUNNING,        ///< the job is running
89                 PAUSED,         ///< the job has been paused
90                 FINISHED_OK,    ///< the job has finished successfully
91                 FINISHED_ERROR, ///< the job has finished in error
92                 FINISHED_CANCELLED ///< the job was cancelled
93         };
94         
95         void set_state (State);
96         void set_error (std::string s, std::string d);
97
98         boost::shared_ptr<const Film> _film;
99
100 private:
101
102         void run_wrapper ();
103
104         boost::thread* _thread;
105
106         /** mutex for _state and _error */
107         mutable boost::mutex _state_mutex;
108         /** current state of the job */
109         State _state;
110         /** summary of an error that has occurred (when state == FINISHED_ERROR) */
111         std::string _error_summary;
112         std::string _error_details;
113
114         /** time that this job was started */
115         time_t _start_time;
116
117         /** mutex for _stack and _progress_unknown */
118         mutable boost::mutex _progress_mutex;
119
120         struct Level {
121                 Level (float a) : allocation (a), normalised (0) {}
122
123                 float allocation;
124                 float normalised;
125         };
126
127         std::list<Level> _stack;
128
129         /** true if this job's progress will always be unknown */
130         bool _progress_unknown;
131
132         float _last_set;
133
134         int _ran_for;
135 };
136
137 #endif