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