move ARDOUR::Configuration and ARDOUR::ConfigVariable into libpbd
[ardour.git] / libs / ardour / ardour / butler.h
index 60697517fb4095bb20cf86456b7d967dc231aad6..949668dab3d1f4d82c991861cf92511d1384d548 100644 (file)
 #ifndef __ardour_butler_h__
 #define __ardour_butler_h__
 
-#include <glibmm/thread.h>
+#include <pthread.h>
 
+#include <glibmm/threads.h>
+
+#ifdef PLATFORM_WINDOWS
+#include "pbd/glib_semaphore.h"
+#endif
+
+#include "pbd/ringbuffer.h"
+#include "pbd/pool.h"
+#include "ardour/libardour_visibility.h"
 #include "ardour/types.h"
 #include "ardour/session_handle.h"
 
+
+
 namespace ARDOUR {
 
-class Butler : public SessionHandleRef
+/**
+ *  One of the Butler's functions is to clean up (ie delete) unused CrossThreadPools.
+ *  When a thread with a CrossThreadPool terminates, its CTP is added to pool_trash.
+ *  When the Butler thread wakes up, we check this trash buffer for CTPs, and if they
+ *  are empty they are deleted.
+ */
+
+class LIBARDOUR_API Butler : public SessionHandleRef
 {
   public:
        Butler (Session& session);
        ~Butler();
-       
+
        int  start_thread();
        void terminate_thread();
        void schedule_transport_work();
@@ -40,11 +58,10 @@ class Butler : public SessionHandleRef
        void stop();
        void wait_until_finished();
        bool transport_work_requested() const;
+       void drop_references ();
 
-       float read_data_rate() const; ///< in usec
-       float write_data_rate() const;
-
-       uint32_t audio_diskstream_buffer_size() const { return audio_dstream_buffer_size; }
+       framecnt_t audio_diskstream_capture_buffer_size() const { return audio_dstream_capture_buffer_size; }
+       framecnt_t audio_diskstream_playback_buffer_size() const { return audio_dstream_playback_buffer_size; }
        uint32_t midi_diskstream_buffer_size()  const { return midi_dstream_buffer_size; }
 
        static void* _thread_work(void *arg);
@@ -52,7 +69,6 @@ class Butler : public SessionHandleRef
 
        struct Request {
                enum Type {
-                       Wake,
                        Run,
                        Pause,
                        Quit
@@ -60,13 +76,48 @@ class Butler : public SessionHandleRef
        };
 
        pthread_t    thread;
-       Glib::Mutex  request_lock;
-       Glib::Cond   paused;
+       bool         have_thread;
+       Glib::Threads::Mutex  request_lock;
+        Glib::Threads::Cond   paused;
        bool         should_run;
        mutable gint should_do_transport_work;
-       int          request_pipe[2];
-       uint32_t     audio_dstream_buffer_size;
+       framecnt_t   audio_dstream_capture_buffer_size;
+       framecnt_t   audio_dstream_playback_buffer_size;
        uint32_t     midi_dstream_buffer_size;
+       RingBuffer<CrossThreadPool*> pool_trash;
+
+#ifdef PLATFORM_WINDOWS
+       PBD::atomic_counter m_request_state;
+       PBD::GlibSemaphore   m_request_sem;
+#else
+       int          request_pipe[2];
+#endif
+
+private:
+       void empty_pool_trash ();
+       void config_changed (std::string);
+
+#ifndef PLATFORM_WINDOWS
+       int setup_request_pipe ();
+#endif
+
+       /**
+        * return true if there are requests to be processed
+        */
+       bool wait_for_requests ();
+
+       /**
+        * Remove request from butler request queue
+        *
+        * return true if there was another request and req is valid
+        */
+       bool dequeue_request (Request::Type& req);
+
+       /**
+        * Add request to butler thread request queue
+        */
+       void queue_request (Request::Type r);
+
 };
 
 } // namespace ARDOUR