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 "ardour/ardour.h"
40 #include "ardour/data_type.h"
41 #include "ardour/session_handle.h"
42 #include "ardour/types.h"
43 #include "ardour/chan_count.h"
44 #include "ardour/port_manager.h"
46 #ifdef HAVE_JACK_SESSION
47 #include <jack/session.h>
60 class AudioBackendInfo;
62 class AudioEngine : public SessionHandlePtr, public PortManager
66 static AudioEngine* create ();
68 virtual ~AudioEngine ();
70 int discover_backends();
71 std::vector<const AudioBackendInfo*> available_backends() const;
72 std::string current_backend_name () const;
73 boost::shared_ptr<AudioBackend> set_backend (const std::string&, const std::string& arg1, const std::string& arg2);
74 boost::shared_ptr<AudioBackend> current_backend() const { return _backend; }
75 bool setup_required () const;
77 ProcessThread* main_thread() const { return _main_thread; }
79 /* START BACKEND PROXY API
81 * See audio_backend.h for full documentation and semantics. These wrappers
82 * just forward to a backend implementation.
88 int freewheel (bool start_stop);
89 float get_cpu_load() const ;
90 void transport_start ();
91 void transport_stop ();
92 TransportState transport_state ();
93 void transport_locate (framepos_t pos);
94 framepos_t transport_frame();
95 framecnt_t sample_rate () const;
96 pframes_t samples_per_cycle () const;
97 int usecs_per_cycle () const;
98 size_t raw_buffer_size (DataType t);
99 pframes_t sample_time ();
100 pframes_t sample_time_at_cycle_start ();
101 pframes_t samples_since_cycle_start ();
102 bool get_sync_offset (pframes_t& offset) const;
103 int create_process_thread (boost::function<void()> func, AudioBackendNativeThread*, size_t stacksize);
104 int wait_for_process_thread_exit (AudioBackendNativeThread);
105 bool is_realtime() const;
106 bool connected() const;
108 int set_device_name (const std::string&);
109 int set_sample_rate (float);
110 int set_buffer_size (uint32_t);
111 int set_sample_format (SampleFormat);
112 int set_interleaved (bool yn);
113 int set_input_channels (uint32_t);
114 int set_output_channels (uint32_t);
115 int set_systemic_input_latency (uint32_t);
116 int set_systemic_output_latency (uint32_t);
118 /* END BACKEND PROXY API */
120 bool freewheeling() const { return _freewheeling; }
121 bool running() const { return _running; }
123 Glib::Threads::Mutex& process_lock() { return _process_lock; }
125 int request_buffer_size (pframes_t samples) {
126 return set_buffer_size (samples);
129 framecnt_t processed_frames() const { return _processed_frames; }
131 void set_session (Session *);
132 void remove_session (); // not a replacement for SessionHandle::session_going_away()
133 Session* session() const { return _session; }
135 class NoBackendAvailable : public std::exception {
137 virtual const char *what() const throw() { return "could not connect to engine backend"; }
140 void split_cycle (pframes_t offset);
142 int reset_timebase ();
144 void update_latencies ();
146 /* this signal is sent for every process() cycle while freewheeling.
147 (the regular process() call to session->process() is not made)
150 PBD::Signal1<int, pframes_t> Freewheel;
152 PBD::Signal0<void> Xrun;
154 /* this signal is emitted if the sample rate changes */
156 PBD::Signal1<void, framecnt_t> SampleRateChanged;
158 /* this signal is sent if the backend ever disconnects us */
160 PBD::Signal1<void,const char*> Halted;
162 /* these two are emitted when the engine itself is
166 PBD::Signal0<void> Running;
167 PBD::Signal0<void> Stopped;
169 static AudioEngine* instance() { return _instance; }
170 static void destroy();
173 /* The backend will cause these at the appropriate time(s)
175 int process_callback (pframes_t nframes);
176 int buffer_size_change (pframes_t nframes);
177 int sample_rate_change (pframes_t nframes);
178 void freewheel_callback (bool);
179 void timebase_callback (TransportState state, pframes_t nframes, framepos_t pos, int new_position);
180 int sync_callback (TransportState state, framepos_t position);
181 int port_registration_callback ();
182 void latency_callback (bool for_playback);
183 void halted_callback (const char* reason);
185 /* sets up the process callback thread */
186 static void thread_init_callback (void *);
188 /* latency measurement */
191 int prepare_for_latency_measurement ();
192 void start_latency_detection ();
193 void stop_latency_detection ();
194 void set_latency_input_port (const std::string&);
195 void set_latency_output_port (const std::string&);
196 uint32_t latency_signal_delay () const { return _latency_signal_latency; }
201 static AudioEngine* _instance;
203 boost::shared_ptr<AudioBackend> _backend;
205 Glib::Threads::Mutex _process_lock;
206 Glib::Threads::Cond session_removed;
207 bool session_remove_pending;
208 frameoffset_t session_removal_countdown;
209 gain_t session_removal_gain;
210 gain_t session_removal_gain_step;
213 /// number of frames between each check for changes in monitor input
214 framecnt_t monitor_check_interval;
215 /// time of the last monitor check in frames
216 framecnt_t last_monitor_check;
217 /// the number of frames processed since start() was called
218 framecnt_t _processed_frames;
219 Glib::Threads::Thread* m_meter_thread;
220 ProcessThread* _main_thread;
222 bool _measuring_latency;
223 PortEngine::PortHandle _latency_input_port;
224 PortEngine::PortHandle _latency_output_port;
225 framecnt_t _latency_flush_frames;
226 std::string _latency_input_name;
227 std::string _latency_output_name;
228 framecnt_t _latency_signal_latency;
229 bool _started_for_latency;
231 void meter_thread ();
232 void start_metering_thread ();
233 void stop_metering_thread ();
235 static gint m_meter_exit;
237 void parameter_changed (const std::string&);
238 PBD::ScopedConnection config_connection;
240 typedef std::map<std::string,AudioBackendInfo*> BackendMap;
241 BackendMap _backends;
242 AudioBackendInfo* backend_discover (const std::string&);
243 void drop_backend ();
246 } // namespace ARDOUR
248 #endif /* __ardour_audioengine_h__ */