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 #include "ardour/types.h"
  25
  26 namespace ARDOUR {
  27
  28 class Session;
  29
  30 class Butler {
  31 public:
  32         Butler(Session* session);
  33         ~Butler();
  34
  35         int  start_thread();
  36         void terminate_thread();
  37         void schedule_transport_work();
  38         void summon();
  39         void stop();
  40         void wait_until_finished();
  41         bool transport_work_requested() const;
  42
  43         float read_data_rate() const; ///< in usec
  44         float write_data_rate() const;
  45
  46         uint32_t audio_diskstream_buffer_size() const { return audio_dstream_buffer_size; }
  47         uint32_t midi_diskstream_buffer_size()  const { return midi_dstream_buffer_size; }
  48
  49         static void* _thread_work(void *arg);
  50         void*         thread_work();
  51
  52         struct Request {
  53                 enum Type {
  54                         Wake,
  55                         Run,
  56                         Pause,
  57                         Quit
  58                 };
  59         };
  60
  61         Session*     session;
  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__