Use uchardet to guess encoding of subtitle files and reject non-UTF-8.
[dcpomatic.git] / src / lib / job.h
index 97e3fc29637d292597d943f4c9e70a77cdd8dfad..32e71d6581c0bb3767f68dca222cc58ce601aa80 100644 (file)
 #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 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>, public boost::noncopyable
+class Job : public boost::enable_shared_from_this<Job>, public Signaller, public boost::noncopyable
 {
 public:
        Job (boost::shared_ptr<const Film>);
-       virtual ~Job() {}
+       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 ();
@@ -64,6 +66,7 @@ public:
 
        int elapsed_time () const;
        virtual std::string status () const;
+       std::string json_status () const;
        std::string sub_name () const {
                return _sub_name;
        }
@@ -71,15 +74,14 @@ public:
        void set_progress_unknown ();
        void set_progress (float, bool force = false);
        void sub (std::string);
-       float progress () const;
-       bool progress_unknown () const {
-               return !_progress;
-       }
+       boost::optional<float> progress () const;
 
        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;
@@ -97,7 +99,7 @@ protected:
                FINISHED_ERROR, ///< the job has finished in error
                FINISHED_CANCELLED ///< the job was cancelled
        };
-       
+
        void set_state (State);
        void set_error (std::string s, std::string d);
 
@@ -106,6 +108,7 @@ protected:
 private:
 
        void run_wrapper ();
+       void set_progress_common (boost::optional<float> p);
 
        boost::thread* _thread;
 
@@ -125,6 +128,11 @@ private:
        mutable boost::mutex _progress_mutex;
        boost::optional<float> _progress;
 
+       /** 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;
 };