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>
28 #include "pbd/glib_semaphore.h"
31 #include "pbd/ringbuffer.h"
33 #include "ardour/types.h"
34 #include "ardour/session_handle.h"
41 * One of the Butler's functions is to clean up (ie delete) unused CrossThreadPools.
42 * When a thread with a CrossThreadPool terminates, its CTP is added to pool_trash.
43 * When the Butler thread wakes up, we check this trash buffer for CTPs, and if they
44 * are empty they are deleted.
47 class Butler : public SessionHandleRef
50 Butler (Session& session);
54 void terminate_thread();
55 void schedule_transport_work();
58 void wait_until_finished();
59 bool transport_work_requested() const;
60 void drop_references ();
62 framecnt_t audio_diskstream_capture_buffer_size() const { return audio_dstream_capture_buffer_size; }
63 framecnt_t audio_diskstream_playback_buffer_size() const { return audio_dstream_playback_buffer_size; }
64 uint32_t midi_diskstream_buffer_size() const { return midi_dstream_buffer_size; }
66 static void* _thread_work(void *arg);
78 Glib::Threads::Mutex request_lock;
79 Glib::Threads::Cond paused;
81 mutable gint should_do_transport_work;
82 framecnt_t audio_dstream_capture_buffer_size;
83 framecnt_t audio_dstream_playback_buffer_size;
84 uint32_t midi_dstream_buffer_size;
85 RingBuffer<CrossThreadPool*> pool_trash;
88 PBD::atomic_counter m_request_state;
89 PBD::GlibSemaphore m_request_sem;
95 void empty_pool_trash ();
96 void config_changed (std::string);
99 int setup_request_pipe ();
103 * return true if there are requests to be processed
105 bool wait_for_requests ();
108 * Remove request from butler request queue
110 * return true if there was another request and req is valid
112 bool dequeue_request (Request::Type& req);
115 * Add request to butler thread request queue
117 void queue_request (Request::Type r);
121 } // namespace ARDOUR
123 #endif // __ardour_butler_h__