2 Copyright (C) 2002-2004 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_audioengine_h__
21 #define __ardour_audioengine_h__
24 #include "libardour-config.h"
34 #include <glibmm/threads.h>
36 #include "pbd/signals.h"
37 #include "pbd/stacktrace.h"
39 #include <jack/weakjack.h>
40 #include <jack/jack.h>
41 #include <jack/transport.h>
42 #include <jack/thread.h>
44 #include "ardour/ardour.h"
46 #include "ardour/data_type.h"
47 #include "ardour/session_handle.h"
48 #include "ardour/types.h"
49 #include "ardour/chan_count.h"
50 #include "ardour/port_manager.h"
52 #ifdef HAVE_JACK_SESSION
53 #include <jack/session.h>
64 class AudioBackendInfo;
66 class AudioEngine : public SessionHandlePtr, public PortManager
70 static AudioEngine* create (const std::string& client_name, const std::string& session_uuid);
72 virtual ~AudioEngine ();
74 int discover_backends();
75 std::vector<std::string> available_backends() const;
76 std::string current_backend_name () const;
77 int set_backend (const std::string&);
79 ProcessThread* main_thread() const { return _main_thread; }
81 std::string client_name() const { return backend_client_name; }
83 /* START BACKEND PROXY API
85 * See audio_backend.h for full documentation and semantics. These wrappers
86 * just forward to a backend implementation.
92 int freewheel (bool start_stop);
93 float get_cpu_load() const ;
94 void transport_start ();
95 void transport_stop ();
96 TransportState transport_state ();
97 void transport_locate (framepos_t pos);
98 framepos_t transport_frame();
99 framecnt_t sample_rate () const;
100 pframes_t samples_per_cycle () const;
101 int usecs_per_cycle () const;
102 size_t raw_buffer_size (DataType t);
103 pframes_t sample_time ();
104 pframes_t sample_time_at_cycle_start ();
105 pframes_t samples_since_cycle_start ();
106 bool get_sync_offset (pframes_t& offset) const;
107 int create_process_thread (boost::function<void()> func, pthread_t*, size_t stacksize);
108 bool is_realtime() const;
109 bool connected() const;
111 int set_device_name (const std::string&);
112 int set_sample_rate (float);
113 int set_buffer_size (uint32_t);
114 int set_sample_format (SampleFormat);
115 int set_interleaved (bool yn);
116 int set_input_channels (uint32_t);
117 int set_output_channels (uint32_t);
118 int set_systemic_input_latency (uint32_t);
119 int set_systemic_output_latency (uint32_t);
121 /* END BACKEND PROXY API */
123 bool freewheeling() const { return _freewheeling; }
124 bool running() const { return _running; }
126 Glib::Threads::Mutex& process_lock() { return _process_lock; }
128 int request_buffer_size (pframes_t samples) {
129 return set_buffer_size (samples);
132 framecnt_t processed_frames() const { return _processed_frames; }
134 void set_session (Session *);
135 void remove_session (); // not a replacement for SessionHandle::session_going_away()
137 class NoBackendAvailable : public std::exception {
139 virtual const char *what() const throw() { return "could not connect to engine backend"; }
142 void split_cycle (pframes_t offset);
144 int reset_timebase ();
146 void update_latencies ();
149 /* this signal is sent for every process() cycle while freewheeling.
150 (the regular process() call to session->process() is not made)
153 PBD::Signal1<int, pframes_t> Freewheel;
155 PBD::Signal0<void> Xrun;
157 /* this signal is if the backend notifies us of a graph order event */
159 PBD::Signal0<void> GraphReordered;
161 #ifdef HAVE_JACK_SESSION
162 PBD::Signal1<void,jack_session_event_t *> JackSessionEvent;
165 /* this signal is emitted if the sample rate changes */
167 PBD::Signal1<void, framecnt_t> SampleRateChanged;
169 /* this signal is sent if the backend ever disconnects us */
171 PBD::Signal1<void,const char*> Halted;
173 /* these two are emitted when the engine itself is
177 PBD::Signal0<void> Running;
178 PBD::Signal0<void> Stopped;
180 static AudioEngine* instance() { return _instance; }
181 static void destroy();
184 /* The backend will cause these at the appropriate time(s)
186 int process_callback (pframes_t nframes);
187 int buffer_size_change (pframes_t nframes);
188 int sample_rate_change (pframes_t nframes);
189 void freewheel_callback (bool);
190 void timebase_callback (TransportState state, pframes_t nframes, framepos_t pos, int new_position);
191 int sync_callback (TransportState state, framepos_t position);
192 int port_registration_callback ();
193 void latency_callback (bool for_playback);
194 void halted_callback (const char* reason);
196 /* sets up the process callback thread */
197 static void thread_init_callback (void *);
200 AudioEngine (const std::string& client_name, const std::string& session_uuid);
202 static AudioEngine* _instance;
204 boost::shared_ptr<AudioBackend> _backend;
206 Glib::Threads::Mutex _process_lock;
207 Glib::Threads::Cond session_removed;
208 bool session_remove_pending;
209 frameoffset_t session_removal_countdown;
210 gain_t session_removal_gain;
211 gain_t session_removal_gain_step;
214 mutable framecnt_t _buffer_size;
215 std::map<DataType,size_t> _raw_buffer_sizes;
216 mutable framecnt_t _frame_rate;
217 /// number of frames between each check for changes in monitor input
218 framecnt_t monitor_check_interval;
219 /// time of the last monitor check in frames
220 framecnt_t last_monitor_check;
221 /// the number of frames processed since start() was called
222 framecnt_t _processed_frames;
224 bool _pre_freewheel_mmc_enabled;
225 int _usecs_per_cycle;
226 bool port_remove_in_progress;
227 Glib::Threads::Thread* m_meter_thread;
228 ProcessThread* _main_thread;
230 std::string backend_client_name;
231 std::string backend_session_uuid;
233 void meter_thread ();
234 void start_metering_thread ();
235 void stop_metering_thread ();
237 static gint m_meter_exit;
239 void parameter_changed (const std::string&);
240 PBD::ScopedConnection config_connection;
242 typedef std::map<std::string,AudioBackendInfo*> BackendMap;
243 BackendMap _backends;
244 AudioBackendInfo* backend_discover (const std::string&);
245 void drop_backend ();
248 } // namespace ARDOUR
250 #endif /* __ardour_audioengine_h__ */