src/lib/job_manager.h

   1 /*
   2     Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 /** @file  src/job_manager.h
  22  *  @brief A simple scheduler for jobs.
  23  */
  24
  25 #include "signaller.h"
  26 #include <boost/thread/mutex.hpp>
  27 #include <boost/thread.hpp>
  28 #include <boost/signals2.hpp>
  29 #include <boost/thread/condition.hpp>
  30 #include <list>
  31
  32 class Job;
  33 class Film;
  34 class Playlist;
  35 struct threed_test7;
  36
  37 extern bool wait_for_jobs ();
  38
  39 /** @class JobManager
  40  *  @brief A simple scheduler for jobs.
  41  */
  42 class JobManager : public Signaller, public boost::noncopyable
  43 {
  44 public:
  45         boost::shared_ptr<Job> add (boost::shared_ptr<Job>);
  46         boost::shared_ptr<Job> add_after (boost::shared_ptr<Job> after, boost::shared_ptr<Job> j);
  47         std::list<boost::shared_ptr<Job> > get () const;
  48         bool work_to_do () const;
  49         bool errors () const;
  50         void increase_priority (boost::shared_ptr<Job>);
  51         void decrease_priority (boost::shared_ptr<Job>);
  52         void pause ();
  53         void resume ();
  54         bool paused () const {
  55                 boost::mutex::scoped_lock lm (_mutex);
  56                 return _paused;
  57         }
  58
  59         void analyse_audio (
  60                 boost::shared_ptr<const Film> film,
  61                 boost::shared_ptr<const Playlist> playlist,
  62                 bool from_zero,
  63                 boost::signals2::connection& connection,
  64                 boost::function<void()> ready
  65                 );
  66
  67         boost::signals2::signal<void (boost::weak_ptr<Job>)> JobAdded;
  68         boost::signals2::signal<void ()> JobsReordered;
  69         boost::signals2::signal<void (boost::optional<std::string>, boost::optional<std::string>)> ActiveJobsChanged;
  70
  71         static JobManager* instance ();
  72         static void drop ();
  73
  74 private:
  75         /* This function is part of the test suite */
  76         friend bool ::wait_for_jobs ();
  77         friend struct threed_test7;
  78
  79         JobManager ();
  80         ~JobManager ();
  81         void scheduler ();
  82         void start ();
  83         void priority_changed ();
  84         void job_finished ();
  85
  86         mutable boost::mutex _mutex;
  87         boost::condition _empty_condition;
  88         /** List of jobs in the order that they will be executed */
  89         std::list<boost::shared_ptr<Job> > _jobs;
  90         std::list<boost::signals2::connection> _connections;
  91         bool _terminate;
  92         bool _paused;
  93         boost::shared_ptr<Job> _paused_job;
  94
  95         boost::optional<std::string> _last_active_job;
  96         boost::thread* _scheduler;
  97
  98         static JobManager* _instance;
  99 };