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/threads.h>
  24
  25 #ifdef WIN32
  26 #include "pbd/glib_semaphore.h"
  27 #endif
  28
  29 #include "pbd/ringbuffer.h"
  30 #include "pbd/pool.h"
  31 #include "ardour/types.h"
  32 #include "ardour/session_handle.h"
  33
  34
  35
  36 namespace ARDOUR {
  37
  38 /**
  39  *  One of the Butler's functions is to clean up (ie delete) unused CrossThreadPools.
  40  *  When a thread with a CrossThreadPool terminates, its CTP is added to pool_trash.
  41  *  When the Butler thread wakes up, we check this trash buffer for CTPs, and if they
  42  *  are empty they are deleted.
  43  */
  44
  45 class Butler : public SessionHandleRef
  46 {
  47   public:
  48         Butler (Session& session);
  49         ~Butler();
  50
  51         int  start_thread();
  52         void terminate_thread();
  53         void schedule_transport_work();
  54         void summon();
  55         void stop();
  56         void wait_until_finished();
  57         bool transport_work_requested() const;
  58         void drop_references ();
  59
  60         framecnt_t audio_diskstream_capture_buffer_size() const { return audio_dstream_capture_buffer_size; }
  61         framecnt_t audio_diskstream_playback_buffer_size() const { return audio_dstream_playback_buffer_size; }
  62         uint32_t midi_diskstream_buffer_size()  const { return midi_dstream_buffer_size; }
  63
  64         static void* _thread_work(void *arg);
  65         void*         thread_work();
  66
  67         struct Request {
  68                 enum Type {
  69                         Run,
  70                         Pause,
  71                         Quit
  72                 };
  73         };
  74
  75         pthread_t    thread;
  76         Glib::Threads::Mutex  request_lock;
  77         Glib::Threads::Cond   paused;
  78         bool         should_run;
  79         mutable gint should_do_transport_work;
  80         framecnt_t   audio_dstream_capture_buffer_size;
  81         framecnt_t   audio_dstream_playback_buffer_size;
  82         uint32_t     midi_dstream_buffer_size;
  83         RingBuffer<CrossThreadPool*> pool_trash;
  84
  85 #ifdef WIN32
  86         PBD::atomic_counter m_request_state;
  87         PBD::GlibSemaphore   m_request_sem;
  88 #else
  89         int          request_pipe[2];
  90 #endif
  91
  92 private:
  93         void empty_pool_trash ();
  94         void config_changed (std::string);
  95
  96 #ifndef WIN32
  97         int setup_request_pipe ();
  98 #endif
  99
 100         /**
 101          * return true if there are requests to be processed
 102          */
 103         bool wait_for_requests ();
 104
 105         /**
 106          * Remove request from butler request queue
 107          *
 108          * return true if there was another request and req is valid
 109          */
 110         bool dequeue_request (Request::Type& req);
 111
 112         /**
 113          * Add request to butler thread request queue
 114          */
 115         void queue_request (Request::Type r);
 116
 117 };
 118
 119 } // namespace ARDOUR
 120
 121 #endif // __ardour_butler_h__