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.
21 #ifndef __ardour_audioengine_h__
22 #define __ardour_audioengine_h__
30 #include <sigc++/signal.h>
32 #include <glibmm/thread.h>
34 #include <ardour/ardour.h>
35 #include <jack/jack.h>
36 #include <jack/transport.h>
43 class AudioEngine : public sigc::trackable
46 AudioEngine (std::string client_name);
47 virtual ~AudioEngine ();
49 jack_client_t* jack() const { return _jack; }
50 bool connected() const { return _jack != 0; }
52 std::string client_name() const { return jack_client_name; }
54 int reconnect_to_jack ();
55 int disconnect_from_jack();
57 bool will_reconnect_at_halt ();
58 void set_reconnect_at_halt (bool);
62 bool running() const { return _running; }
64 Glib::Mutex& process_lock() { return _process_lock; }
66 jack_nframes_t frame_rate();
67 jack_nframes_t frames_per_cycle();
69 int usecs_per_cycle () const { return _usecs_per_cycle; }
71 jack_nframes_t frames_since_cycle_start () {
72 if (!_running || !_jack) return 0;
73 return jack_frames_since_cycle_start (_jack);
75 jack_nframes_t frame_time () {
76 if (!_running || !_jack) return 0;
77 return jack_frame_time (_jack);
80 jack_nframes_t transport_frame () const {
81 if (!_running || !_jack) return 0;
82 return jack_get_current_transport_frame (_jack);
85 int request_buffer_size (jack_nframes_t);
87 jack_nframes_t set_monitor_check_interval (jack_nframes_t);
89 float get_cpu_load() {
90 if (!_running || !_jack) return 0;
91 return jack_cpu_load (_jack);
94 void set_session (Session *);
95 void remove_session ();
97 class PortRegistrationFailure : public std::exception {
99 virtual const char *what() const throw() { return "failed port registration"; }
102 class NoBackendAvailable : public std::exception {
104 virtual const char *what() const throw() { return "could not connect to engine backend"; }
107 Port *register_audio_input_port (const std::string& portname);
108 Port *register_audio_output_port (const std::string& portname);
109 int unregister_port (Port *);
111 int connect (const std::string& source, const std::string& destination);
112 int disconnect (const std::string& source, const std::string& destination);
113 int disconnect (Port *);
115 const char ** get_ports (const std::string& port_name_pattern, const std::string& type_name_pattern, uint32_t flags);
117 uint32_t n_physical_outputs () const;
118 uint32_t n_physical_inputs () const;
120 std::string get_nth_physical_output (uint32_t n) {
121 return get_nth_physical (n, JackPortIsInput);
124 std::string get_nth_physical_input (uint32_t n) {
125 return get_nth_physical (n, JackPortIsOutput);
128 jack_nframes_t get_port_total_latency (const Port&);
129 void update_total_latencies ();
131 /* the caller may not delete the object pointed to by
135 Port *get_port_by_name (const std::string& name, bool keep = true);
137 enum TransportState {
138 TransportStopped = JackTransportStopped,
139 TransportRolling = JackTransportRolling,
140 TransportLooping = JackTransportLooping,
141 TransportStarting = JackTransportStarting
144 void transport_start ();
145 void transport_stop ();
146 void transport_locate (jack_nframes_t);
147 TransportState transport_state ();
149 int reset_timebase ();
151 /* start/stop freewheeling */
153 int freewheel (bool onoff);
154 bool freewheeling() const { return _freewheeling; }
156 /* this signal is sent for every process() cycle while freewheeling.
157 the regular process() call to session->process() is not made.
160 sigc::signal<int,jack_nframes_t> Freewheel;
162 sigc::signal<void> Xrun;
164 /* this signal is if JACK notifies us of a graph order event */
166 sigc::signal<void> GraphReordered;
168 /* this signal is emitted if the sample rate changes */
170 sigc::signal<void,jack_nframes_t> SampleRateChanged;
172 /* this signal is sent if JACK ever disconnects us */
174 sigc::signal<void> Halted;
176 /* these two are emitted when the engine itself is
180 sigc::signal<void> Running;
181 sigc::signal<void> Stopped;
183 std::string make_port_name_relative (std::string);
184 std::string make_port_name_non_relative (std::string);
187 ARDOUR::Session *session;
188 jack_client_t *_jack;
189 std::string jack_client_name;
190 Glib::Mutex port_lock;
191 Glib::Mutex _process_lock;
192 Glib::Mutex session_remove_lock;
193 Glib::Cond session_removed;
194 bool session_remove_pending;
197 jack_nframes_t _buffer_size;
198 jack_nframes_t _frame_rate;
199 jack_nframes_t monitor_check_interval;
200 jack_nframes_t last_monitor_check;
201 jack_nframes_t _processed_frames;
203 bool _freewheel_thread_registered;
204 sigc::slot<int,jack_nframes_t> freewheel_action;
205 bool reconnect_on_halt;
206 int _usecs_per_cycle;
208 typedef std::set<Port*> Ports;
211 int process_callback (jack_nframes_t nframes);
212 void remove_all_ports ();
214 typedef std::pair<std::string,std::string> PortConnection;
215 typedef std::list<PortConnection> PortConnections;
217 PortConnections port_connections;
218 void remove_connections_for (Port*);
220 std::string get_nth_physical (uint32_t which, int flags);
222 static int _xrun_callback (void *arg);
223 static int _graph_order_callback (void *arg);
224 static int _process_callback (jack_nframes_t nframes, void *arg);
225 static int _sample_rate_callback (jack_nframes_t nframes, void *arg);
226 static int _bufsize_callback (jack_nframes_t nframes, void *arg);
227 static void _jack_timebase_callback (jack_transport_state_t, jack_nframes_t, jack_position_t*, int, void*);
228 static int _jack_sync_callback (jack_transport_state_t, jack_position_t*, void *arg);
229 static void _freewheel_callback (int , void *arg);
231 void jack_timebase_callback (jack_transport_state_t, jack_nframes_t, jack_position_t*, int);
232 int jack_sync_callback (jack_transport_state_t, jack_position_t*);
233 int jack_bufsize_callback (jack_nframes_t);
234 int jack_sample_rate_callback (jack_nframes_t);
236 static void halted (void *);
238 int connect_to_jack (std::string client_name);
240 void meter_thread ();
241 void start_metering_thread ();
242 Glib::Thread* m_meter_thread;
243 mutable gint m_meter_exit;
246 }; /* namespace ARDOUR */
248 #endif /* __ardour_audioengine_h__ */