2 Copyright (C) 2000-2009 Paul Davis
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.
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.
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.
20 #ifndef __ardour_butler_h__
21 #define __ardour_butler_h__
25 #include <glibmm/threads.h>
27 #ifdef PLATFORM_WINDOWS
28 #include "pbd/glib_semaphore.h"
31 #include "pbd/ringbuffer.h"
33 #include "ardour/libardour_visibility.h"
34 #include "ardour/types.h"
35 #include "ardour/session_handle.h"
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.
48 class LIBARDOUR_API Butler : public SessionHandleRef
51 Butler (Session& session);
55 void terminate_thread();
56 void schedule_transport_work();
59 void wait_until_finished();
60 bool transport_work_requested() const;
61 void drop_references ();
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; }
67 static void* _thread_work(void *arg);
80 Glib::Threads::Mutex request_lock;
81 Glib::Threads::Cond paused;
83 mutable gint should_do_transport_work;
84 framecnt_t audio_dstream_capture_buffer_size;
85 framecnt_t audio_dstream_playback_buffer_size;
86 uint32_t midi_dstream_buffer_size;
87 RingBuffer<CrossThreadPool*> pool_trash;
89 #ifdef PLATFORM_WINDOWS
90 PBD::atomic_counter m_request_state;
91 PBD::GlibSemaphore m_request_sem;
97 void empty_pool_trash ();
98 void config_changed (std::string);
100 #ifndef PLATFORM_WINDOWS
101 int setup_request_pipe ();
105 * return true if there are requests to be processed
107 bool wait_for_requests ();
110 * Remove request from butler request queue
112 * return true if there was another request and req is valid
114 bool dequeue_request (Request::Type& req);
117 * Add request to butler thread request queue
119 void queue_request (Request::Type r);
123 } // namespace ARDOUR
125 #endif // __ardour_butler_h__