libs/ardour/ardour/butler.h

   1 /*
   2     Copyright (C) 2000-2009 Paul Davis
   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 #ifndef __ardour_butler_h__
  21 #define __ardour_butler_h__
  22
  23 #include <glibmm/thread.h>
  24
  25 #include "ardour/types.h"
  26 #include "ardour/session_handle.h"
  27
  28 namespace ARDOUR {
  29
  30 class Butler : public SessionHandleRef
  31 {
  32   public:
  33         Butler (Session& session);
  34         ~Butler();
  35
  36         int  start_thread();
  37         void terminate_thread();
  38         void schedule_transport_work();
  39         void summon();
  40         void stop();
  41         void wait_until_finished();
  42         bool transport_work_requested() const;
  43
  44         float read_data_rate() const; ///< in usec
  45         float write_data_rate() const;
  46
  47         uint32_t audio_diskstream_buffer_size() const { return audio_dstream_buffer_size; }
  48         uint32_t midi_diskstream_buffer_size()  const { return midi_dstream_buffer_size; }
  49
  50         static void* _thread_work(void *arg);
  51         void*         thread_work();
  52
  53         struct Request {
  54                 enum Type {
  55                         Wake,
  56                         Run,
  57                         Pause,
  58                         Quit
  59                 };
  60         };
  61
  62         pthread_t    thread;
  63         Glib::Mutex  request_lock;
  64         Glib::Cond   paused;
  65         bool         should_run;
  66         mutable gint should_do_transport_work;
  67         int          request_pipe[2];
  68         uint32_t     audio_dstream_buffer_size;
  69         uint32_t     midi_dstream_buffer_size;
  70 };
  71
  72 } // namespace ARDOUR
  73
  74 #endif // __ardour_butler_h__