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>
37 #include "pbd/signals.h"
38 #include "pbd/stacktrace.h"
40 #include <jack/weakjack.h>
41 #include <jack/jack.h>
42 #include <jack/transport.h>
43 #include <jack/thread.h>
45 #include "ardour/ardour.h"
47 #include "ardour/data_type.h"
48 #include "ardour/session_handle.h"
49 #include "ardour/types.h"
50 #include "ardour/chan_count.h"
52 #ifdef HAVE_JACK_SESSION
53 #include <jack/session.h>
64 class AudioEngine : public SessionHandlePtr
67 typedef std::map<std::string,boost::shared_ptr<Port> > Ports;
69 AudioEngine (std::string client_name, std::string session_uuid);
70 virtual ~AudioEngine ();
72 jack_client_t* jack() const;
73 bool connected() const { return _jack != 0; }
75 bool is_realtime () const;
77 ProcessThread* main_thread() const { return _main_thread; }
79 std::string client_name() const { return jack_client_name; }
81 int reconnect_to_jack ();
82 int disconnect_from_jack();
84 int stop (bool forever = false);
86 bool running() const { return _running; }
88 Glib::Threads::Mutex& process_lock() { return _process_lock; }
90 framecnt_t frame_rate () const;
91 pframes_t frames_per_cycle () const;
93 size_t raw_buffer_size(DataType t);
95 int usecs_per_cycle () const { return _usecs_per_cycle; }
97 bool get_sync_offset (pframes_t & offset) const;
99 pframes_t frames_since_cycle_start () {
100 jack_client_t* _priv_jack = _jack;
101 if (!_running || !_priv_jack) {
104 return jack_frames_since_cycle_start (_priv_jack);
107 pframes_t frame_time () {
108 jack_client_t* _priv_jack = _jack;
109 if (!_running || !_priv_jack) {
112 return jack_frame_time (_priv_jack);
115 pframes_t frame_time_at_cycle_start () {
116 jack_client_t* _priv_jack = _jack;
117 if (!_running || !_priv_jack) {
120 return jack_last_frame_time (_priv_jack);
123 pframes_t transport_frame () const {
124 const jack_client_t* _priv_jack = _jack;
125 if (!_running || !_priv_jack) {
128 return jack_get_current_transport_frame (_priv_jack);
131 int request_buffer_size (pframes_t);
133 framecnt_t processed_frames() const { return _processed_frames; }
135 float get_cpu_load() {
136 jack_client_t* _priv_jack = _jack;
137 if (!_running || !_priv_jack) {
140 return jack_cpu_load (_priv_jack);
143 void set_session (Session *);
144 void remove_session (); // not a replacement for SessionHandle::session_going_away()
146 class PortRegistrationFailure : public std::exception {
148 PortRegistrationFailure (std::string const & why = "")
151 ~PortRegistrationFailure () throw () {}
153 virtual const char *what() const throw () { return reason.c_str(); }
159 class NoBackendAvailable : public std::exception {
161 virtual const char *what() const throw() { return "could not connect to engine backend"; }
164 boost::shared_ptr<Port> register_input_port (DataType, const std::string& portname);
165 boost::shared_ptr<Port> register_output_port (DataType, const std::string& portname);
166 int unregister_port (boost::shared_ptr<Port>);
168 bool port_is_physical (const std::string&) const;
169 void request_jack_monitors_input (const std::string&, bool) const;
171 void split_cycle (pframes_t offset);
173 int connect (const std::string& source, const std::string& destination);
174 int disconnect (const std::string& source, const std::string& destination);
175 int disconnect (boost::shared_ptr<Port>);
177 const char ** get_ports (const std::string& port_name_pattern, const std::string& type_name_pattern, uint32_t flags);
179 bool can_request_hardware_monitoring ();
181 ChanCount n_physical_outputs () const;
182 ChanCount n_physical_inputs () const;
184 void get_physical_outputs (DataType type, std::vector<std::string>&);
185 void get_physical_inputs (DataType type, std::vector<std::string>&);
187 boost::shared_ptr<Port> get_port_by_name (const std::string &);
188 void port_renamed (const std::string&, const std::string&);
190 enum TransportState {
191 TransportStopped = JackTransportStopped,
192 TransportRolling = JackTransportRolling,
193 TransportLooping = JackTransportLooping,
194 TransportStarting = JackTransportStarting
197 void transport_start ();
198 void transport_stop ();
199 void transport_locate (framepos_t);
200 TransportState transport_state ();
202 int reset_timebase ();
204 void update_latencies ();
206 /* start/stop freewheeling */
208 int freewheel (bool onoff);
209 bool freewheeling() const { return _freewheeling; }
211 /* this signal is sent for every process() cycle while freewheeling.
212 _ the regular process() call to session->process() is not made.
215 PBD::Signal1<int, pframes_t> Freewheel;
217 PBD::Signal0<void> Xrun;
219 /* this signal is if JACK notifies us of a graph order event */
221 PBD::Signal0<void> GraphReordered;
223 #ifdef HAVE_JACK_SESSION
224 PBD::Signal1<void,jack_session_event_t *> JackSessionEvent;
228 /* this signal is emitted if the sample rate changes */
230 PBD::Signal1<void, framecnt_t> SampleRateChanged;
232 /* this signal is sent if JACK ever disconnects us */
234 PBD::Signal1<void,const char*> Halted;
236 /* these two are emitted when the engine itself is
240 PBD::Signal0<void> Running;
241 PBD::Signal0<void> Stopped;
243 /** Emitted if a JACK port is registered or unregistered */
244 PBD::Signal0<void> PortRegisteredOrUnregistered;
246 /** Emitted if a JACK port is connected or disconnected.
247 * The Port parameters are the ports being connected / disconnected, or 0 if they are not known to Ardour.
248 * The std::string parameters are the (long) port names.
249 * The bool parameter is true if ports were connected, or false for disconnected.
251 PBD::Signal5<void, boost::weak_ptr<Port>, std::string, boost::weak_ptr<Port>, std::string, bool> PortConnectedOrDisconnected;
253 std::string make_port_name_relative (std::string) const;
254 std::string make_port_name_non_relative (std::string) const;
255 bool port_is_mine (const std::string&) const;
257 static AudioEngine* instance() { return _instance; }
258 static void destroy();
261 int create_process_thread (boost::function<void()>, pthread_t*, size_t stacksize);
263 boost::shared_ptr<Port> ltc_input_port() const { return _ltc_input; }
264 boost::shared_ptr<Port> ltc_output_port() const { return _ltc_output; }
267 static AudioEngine* _instance;
269 jack_client_t* volatile _jack; /* could be reset to null by SIGPIPE or another thread */
270 std::string jack_client_name;
271 Glib::Threads::Mutex _process_lock;
272 Glib::Threads::Cond session_removed;
273 bool session_remove_pending;
274 frameoffset_t session_removal_countdown;
275 gain_t session_removal_gain;
276 gain_t session_removal_gain_step;
279 mutable framecnt_t _buffer_size;
280 std::map<DataType,size_t> _raw_buffer_sizes;
281 mutable framecnt_t _frame_rate;
282 /// number of frames between each check for changes in monitor input
283 framecnt_t monitor_check_interval;
284 /// time of the last monitor check in frames
285 framecnt_t last_monitor_check;
286 /// the number of frames processed since start() was called
287 framecnt_t _processed_frames;
289 bool _pre_freewheel_mmc_enabled;
290 int _usecs_per_cycle;
291 bool port_remove_in_progress;
292 Glib::Threads::Thread* m_meter_thread;
293 ProcessThread* _main_thread;
295 boost::shared_ptr<Port> _ltc_input;
296 boost::shared_ptr<Port> _ltc_output;
297 void reconnect_ltc ();
299 SerializedRCUManager<Ports> ports;
301 boost::shared_ptr<Port> register_port (DataType type, const std::string& portname, bool input);
303 int process_callback (pframes_t nframes);
304 void* process_thread ();
305 void remove_all_ports ();
307 ChanCount n_physical (unsigned long) const;
308 void get_physical (DataType, unsigned long, std::vector<std::string> &);
310 void port_registration_failure (const std::string& portname);
312 static int _xrun_callback (void *arg);
313 #ifdef HAVE_JACK_SESSION
314 static void _session_callback (jack_session_event_t *event, void *arg);
316 static int _graph_order_callback (void *arg);
317 static void* _process_thread (void *arg);
318 static int _sample_rate_callback (pframes_t nframes, void *arg);
319 static int _bufsize_callback (pframes_t nframes, void *arg);
320 static void _jack_timebase_callback (jack_transport_state_t, pframes_t, jack_position_t*, int, void*);
321 static int _jack_sync_callback (jack_transport_state_t, jack_position_t*, void *arg);
322 static void _freewheel_callback (int , void *arg);
323 static void _registration_callback (jack_port_id_t, int, void *);
324 static void _connect_callback (jack_port_id_t, jack_port_id_t, int, void *);
326 void jack_timebase_callback (jack_transport_state_t, pframes_t, jack_position_t*, int);
327 int jack_sync_callback (jack_transport_state_t, jack_position_t*);
328 int jack_bufsize_callback (pframes_t);
329 int jack_sample_rate_callback (pframes_t);
330 void freewheel_callback (int);
331 void connect_callback (jack_port_id_t, jack_port_id_t, int);
333 void set_jack_callbacks ();
335 static void _latency_callback (jack_latency_callback_mode_t, void*);
336 void jack_latency_callback (jack_latency_callback_mode_t);
338 int connect_to_jack (std::string client_name, std::string session_uuid);
340 static void halted (void *);
341 static void halted_info (jack_status_t,const char*,void *);
343 void meter_thread ();
344 void start_metering_thread ();
345 void stop_metering_thread ();
347 static gint m_meter_exit;
351 boost::function<void()> f;
354 ThreadData (AudioEngine* ae, boost::function<void()> fp, size_t stacksz)
355 : engine (ae) , f (fp) , stacksize (stacksz) {}
358 static void* _start_process_thread (void*);
359 void parameter_changed (const std::string&);
360 PBD::ScopedConnection config_connection;
363 } // namespace ARDOUR
365 #endif /* __ardour_audioengine_h__ */