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"
48 class AudioEngine : public sigc::trackable
51 typedef std::set<Port*> Ports;
53 AudioEngine (std::string client_name);
54 virtual ~AudioEngine ();
56 jack_client_t* jack() const;
57 bool connected() const { return _jack != 0; }
59 bool is_realtime () const;
61 std::string client_name() const { return jack_client_name; }
63 int reconnect_to_jack ();
64 int disconnect_from_jack();
66 bool will_reconnect_at_halt ();
67 void set_reconnect_at_halt (bool);
69 int stop (bool forever = false);
71 bool running() const { return _running; }
73 Glib::Mutex& process_lock() { return _process_lock; }
75 nframes_t frame_rate();
76 nframes_t frames_per_cycle();
78 size_t raw_buffer_size(DataType t);
80 int usecs_per_cycle () const { return _usecs_per_cycle; }
82 bool get_sync_offset (nframes_t& offset) const;
84 nframes_t frames_since_cycle_start () {
85 if (!_running || !_jack) return 0;
86 return jack_frames_since_cycle_start (_jack);
88 nframes_t frame_time () {
89 if (!_running || !_jack) return 0;
90 return jack_frame_time (_jack);
93 nframes_t transport_frame () const {
94 if (!_running || !_jack) return 0;
95 return jack_get_current_transport_frame (_jack);
98 int request_buffer_size (nframes_t);
100 nframes_t set_monitor_check_interval (nframes_t);
102 float get_cpu_load() {
103 if (!_running || !_jack) return 0;
104 return jack_cpu_load (_jack);
107 void set_session (Session *);
108 void remove_session ();
110 class PortRegistrationFailure : public std::exception {
112 PortRegistrationFailure (const char* why = "") {
115 virtual const char *what() const throw() { return reason; }
121 class NoBackendAvailable : public std::exception {
123 virtual const char *what() const throw() { return "could not connect to engine backend"; }
126 Port *register_input_port (DataType, const std::string& portname);
127 Port *register_output_port (DataType, const std::string& portname);
128 int unregister_port (Port &);
130 void split_cycle (nframes_t offset);
132 int connect (const std::string& source, const std::string& destination);
133 int disconnect (const std::string& source, const std::string& destination);
134 int disconnect (Port &);
136 const char ** get_ports (const std::string& port_name_pattern, const std::string& type_name_pattern, uint32_t flags);
138 bool can_request_hardware_monitoring ();
140 uint32_t n_physical_outputs (DataType type) const;
141 uint32_t n_physical_inputs (DataType type) const;
143 void get_physical_outputs (DataType type, std::vector<std::string>&);
144 void get_physical_inputs (DataType type, std::vector<std::string>&);
146 std::string get_nth_physical_output (DataType type, uint32_t n) {
147 return get_nth_physical (type, n, JackPortIsInput);
150 std::string get_nth_physical_input (DataType type, uint32_t n) {
151 return get_nth_physical (type, n, JackPortIsOutput);
154 void update_total_latencies ();
155 void update_total_latency (const Port&);
157 Port *get_port_by_name (const std::string &);
158 Port *get_port_by_name_locked (const std::string &);
160 enum TransportState {
161 TransportStopped = JackTransportStopped,
162 TransportRolling = JackTransportRolling,
163 TransportLooping = JackTransportLooping,
164 TransportStarting = JackTransportStarting
167 void transport_start ();
168 void transport_stop ();
169 void transport_locate (nframes_t);
170 TransportState transport_state ();
172 int reset_timebase ();
174 /* start/stop freewheeling */
176 int freewheel (bool onoff);
177 bool freewheeling() const { return _freewheeling; }
179 /* this signal is sent for every process() cycle while freewheeling.
180 the regular process() call to session->process() is not made.
183 sigc::signal<int,nframes_t> Freewheel;
185 sigc::signal<void> Xrun;
187 /* this signal is if JACK notifies us of a graph order event */
189 sigc::signal<void> GraphReordered;
191 /* this signal is emitted if the sample rate changes */
193 sigc::signal<void,nframes_t> SampleRateChanged;
195 /* this signal is sent if JACK ever disconnects us */
197 sigc::signal<void> Halted;
199 /* these two are emitted when the engine itself is
203 sigc::signal<void> Running;
204 sigc::signal<void> Stopped;
206 std::string make_port_name_relative (std::string);
207 std::string make_port_name_non_relative (std::string);
210 ARDOUR::Session* session;
211 jack_client_t* _jack;
212 std::string jack_client_name;
213 Glib::Mutex _process_lock;
214 Glib::Cond session_removed;
215 bool session_remove_pending;
218 nframes_t _buffer_size;
219 std::map<DataType,size_t> _raw_buffer_sizes;
220 nframes_t _frame_rate;
221 /// number of frames between each check for changes in monitor input
222 nframes_t monitor_check_interval;
223 /// time of the last monitor check in frames
224 nframes_t last_monitor_check;
225 /// the number of frames processed since start() was called
226 nframes_t _processed_frames;
228 bool _freewheel_pending;
229 bool _freewheel_thread_registered;
230 sigc::slot<int,nframes_t> freewheel_action;
231 bool reconnect_on_halt;
232 int _usecs_per_cycle;
234 SerializedRCUManager<Ports> ports;
236 Port *register_port (DataType type, const std::string& portname, bool input);
238 int process_callback (nframes_t nframes);
239 void remove_all_ports ();
241 typedef std::pair<std::string,std::string> PortConnection;
242 typedef std::list<PortConnection> PortConnections;
244 PortConnections port_connections;
245 void remove_connections_for (Port&);
247 std::string get_nth_physical (DataType type, uint32_t n, int flags);
249 void port_registration_failure (const std::string& portname);
251 static int _xrun_callback (void *arg);
252 static int _graph_order_callback (void *arg);
253 static int _process_callback (nframes_t nframes, void *arg);
254 static int _sample_rate_callback (nframes_t nframes, void *arg);
255 static int _bufsize_callback (nframes_t nframes, void *arg);
256 static void _jack_timebase_callback (jack_transport_state_t, nframes_t, jack_position_t*, int, void*);
257 static int _jack_sync_callback (jack_transport_state_t, jack_position_t*, void *arg);
258 static void _freewheel_callback (int , void *arg);
260 void jack_timebase_callback (jack_transport_state_t, nframes_t, jack_position_t*, int);
261 int jack_sync_callback (jack_transport_state_t, jack_position_t*);
262 int jack_bufsize_callback (nframes_t);
263 int jack_sample_rate_callback (nframes_t);
265 static void halted (void *);
267 int connect_to_jack (std::string client_name);
269 void meter_thread ();
270 void start_metering_thread ();
271 void stop_metering_thread ();
273 Glib::Thread* m_meter_thread;
274 static gint m_meter_exit;
277 } // namespace ARDOUR
279 #endif /* __ardour_audioengine_h__ */