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/crossthread.h"
32 #include "pbd/ringbuffer.h"
34 #include "ardour/libardour_visibility.h"
35 #include "ardour/types.h"
36 #include "ardour/session_handle.h"
43 * One of the Butler's functions is to clean up (ie delete) unused CrossThreadPools.
44 * When a thread with a CrossThreadPool terminates, its CTP is added to pool_trash.
45 * When the Butler thread wakes up, we check this trash buffer for CTPs, and if they
46 * are empty they are deleted.
49 class LIBARDOUR_API Butler : public SessionHandleRef
52 Butler (Session& session);
56 void terminate_thread();
57 void schedule_transport_work();
60 void wait_until_finished();
61 bool transport_work_requested() const;
62 void drop_references ();
64 void map_parameters ();
66 framecnt_t audio_diskstream_capture_buffer_size() const { return audio_dstream_capture_buffer_size; }
67 framecnt_t audio_diskstream_playback_buffer_size() const { return audio_dstream_playback_buffer_size; }
68 uint32_t midi_diskstream_buffer_size() const { return midi_dstream_buffer_size; }
70 bool flush_tracks_to_disk_after_locate (boost::shared_ptr<RouteList>, uint32_t& errors);
72 static void* _thread_work(void *arg);
85 Glib::Threads::Mutex request_lock;
86 Glib::Threads::Cond paused;
88 mutable gint should_do_transport_work;
89 framecnt_t audio_dstream_capture_buffer_size;
90 framecnt_t audio_dstream_playback_buffer_size;
91 uint32_t midi_dstream_buffer_size;
92 RingBuffer<CrossThreadPool*> pool_trash;
95 void empty_pool_trash ();
96 void config_changed (std::string);
98 bool flush_tracks_to_disk_normal (boost::shared_ptr<RouteList>, uint32_t& errors);
101 * Add request to butler thread request queue
103 void queue_request (Request::Type r);
105 CrossThreadChannel _xthread;
109 } // namespace ARDOUR
111 #endif // __ardour_butler_h__