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__
29 #include <sigc++/signal.h>
31 #include <glibmm/thread.h>
35 #include <ardour/ardour.h>
36 #include <jack/jack.h>
37 #include <jack/transport.h>
38 #include <ardour/types.h>
39 #include <ardour/data_type.h>
46 class AudioEngine : public sigc::trackable
49 AudioEngine (std::string client_name);
50 virtual ~AudioEngine ();
52 jack_client_t* jack() const { return _jack; }
53 bool connected() const { return _jack != 0; }
55 bool is_realtime () const;
57 std::string client_name() const { return jack_client_name; }
59 int reconnect_to_jack ();
60 int disconnect_from_jack();
62 bool will_reconnect_at_halt ();
63 void set_reconnect_at_halt (bool);
65 int stop (bool forever = false);
67 bool running() const { return _running; }
69 Glib::Mutex& process_lock() { return _process_lock; }
71 nframes_t frame_rate();
72 nframes_t frames_per_cycle();
74 int usecs_per_cycle () const { return _usecs_per_cycle; }
76 bool get_sync_offset (nframes_t& offset) const;
78 nframes_t frames_since_cycle_start () {
79 if (!_running || !_jack) return 0;
80 return jack_frames_since_cycle_start (_jack);
82 nframes_t frame_time () {
83 if (!_running || !_jack) return 0;
84 return jack_frame_time (_jack);
87 nframes_t transport_frame () const {
88 if (!_running || !_jack) return 0;
89 return jack_get_current_transport_frame (_jack);
92 int request_buffer_size (nframes_t);
94 nframes_t set_monitor_check_interval (nframes_t);
96 float get_cpu_load() {
97 if (!_running || !_jack) return 0;
98 return jack_cpu_load (_jack);
101 void set_session (Session *);
102 void remove_session ();
104 class PortRegistrationFailure : public std::exception {
106 virtual const char *what() const throw() { return "failed port registration"; }
109 class NoBackendAvailable : public std::exception {
111 virtual const char *what() const throw() { return "could not connect to engine backend"; }
114 Port *register_input_port (DataType type, const std::string& portname);
115 Port *register_output_port (DataType type, const std::string& portname);
116 int unregister_port (Port &);
118 int connect (const std::string& source, const std::string& destination);
119 int disconnect (const std::string& source, const std::string& destination);
120 int disconnect (Port &);
122 const char ** get_ports (const std::string& port_name_pattern, const std::string& type_name_pattern, uint32_t flags);
124 uint32_t n_physical_outputs () const;
125 uint32_t n_physical_inputs () const;
127 void get_physical_outputs (std::vector<std::string>&);
128 void get_physical_inputs (std::vector<std::string>&);
130 std::string get_nth_physical_output (DataType type, uint32_t n) {
131 return get_nth_physical (type, n, JackPortIsInput);
134 std::string get_nth_physical_input (DataType type, uint32_t n) {
135 return get_nth_physical (type, n, JackPortIsOutput);
138 nframes_t get_port_total_latency (const Port&);
139 void update_total_latencies ();
141 /** Caller may not delete the object pointed to by the return value
143 Port *get_port_by_name (const std::string& name, bool keep = true);
145 enum TransportState {
146 TransportStopped = JackTransportStopped,
147 TransportRolling = JackTransportRolling,
148 TransportLooping = JackTransportLooping,
149 TransportStarting = JackTransportStarting
152 void transport_start ();
153 void transport_stop ();
154 void transport_locate (nframes_t);
155 TransportState transport_state ();
157 int reset_timebase ();
159 /* start/stop freewheeling */
161 int freewheel (bool onoff);
162 bool freewheeling() const { return _freewheeling; }
164 /* this signal is sent for every process() cycle while freewheeling.
165 the regular process() call to session->process() is not made.
168 sigc::signal<int,nframes_t> Freewheel;
170 sigc::signal<void> Xrun;
172 /* this signal is if JACK notifies us of a graph order event */
174 sigc::signal<void> GraphReordered;
176 /* this signal is emitted if the sample rate changes */
178 sigc::signal<void,nframes_t> SampleRateChanged;
180 /* this signal is sent if JACK ever disconnects us */
182 sigc::signal<void> Halted;
184 /* these two are emitted when the engine itself is
188 sigc::signal<void> Running;
189 sigc::signal<void> Stopped;
191 std::string make_port_name_relative (std::string);
192 std::string make_port_name_non_relative (std::string);
195 ARDOUR::Session *session;
196 jack_client_t *_jack;
197 std::string jack_client_name;
198 Glib::Mutex _process_lock;
199 Glib::Cond session_removed;
200 bool session_remove_pending;
203 nframes_t _buffer_size;
204 nframes_t _frame_rate;
205 nframes_t monitor_check_interval;
206 nframes_t last_monitor_check;
207 nframes_t _processed_frames;
209 bool _freewheel_thread_registered;
210 sigc::slot<int,nframes_t> freewheel_action;
211 bool reconnect_on_halt;
212 int _usecs_per_cycle;
214 typedef std::set<Port*> Ports;
215 SerializedRCUManager<Ports> ports;
217 int process_callback (nframes_t nframes);
218 void remove_all_ports ();
220 typedef std::pair<std::string,std::string> PortConnection;
221 typedef std::list<PortConnection> PortConnections;
223 PortConnections port_connections;
224 void remove_connections_for (Port&);
226 std::string get_nth_physical (DataType type, uint32_t n, int flags);
228 static int _xrun_callback (void *arg);
229 static int _graph_order_callback (void *arg);
230 static int _process_callback (nframes_t nframes, void *arg);
231 static int _sample_rate_callback (nframes_t nframes, void *arg);
232 static int _bufsize_callback (nframes_t nframes, void *arg);
233 static void _jack_timebase_callback (jack_transport_state_t, nframes_t, jack_position_t*, int, void*);
234 static int _jack_sync_callback (jack_transport_state_t, jack_position_t*, void *arg);
235 static void _freewheel_callback (int , void *arg);
237 void jack_timebase_callback (jack_transport_state_t, nframes_t, jack_position_t*, int);
238 int jack_sync_callback (jack_transport_state_t, jack_position_t*);
239 int jack_bufsize_callback (nframes_t);
240 int jack_sample_rate_callback (nframes_t);
242 static void halted (void *);
244 int connect_to_jack (std::string client_name);
246 void meter_thread ();
247 void start_metering_thread ();
248 void stop_metering_thread ();
250 Glib::Thread* m_meter_thread;
251 static gint m_meter_exit;
254 } // namespace ARDOUR
256 #endif /* __ardour_audioengine_h__ */