2 Copyright (C) 2013 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 __libardour_jack_audiobackend_h__
21 #define __libardour_jack_audiobackend_h__
30 #include <boost/shared_ptr.hpp>
32 #include <jack/jack.h>
33 #include <jack/session.h>
35 #include "ardour/audio_backend.h"
42 class JACKAudioBackend : public AudioBackend {
44 JACKAudioBackend (AudioEngine& e, boost::shared_ptr<JackConnection>);
47 /* AUDIOBACKEND API */
49 std::string name() const;
50 void* private_handle() const;
51 bool available() const;
52 bool is_realtime () const;
54 bool requires_driver_selection() const;
55 std::vector<std::string> enumerate_drivers () const;
56 int set_driver (const std::string&);
58 std::vector<DeviceStatus> enumerate_devices () const;
60 std::vector<float> available_sample_rates (const std::string& device) const;
61 std::vector<uint32_t> available_buffer_sizes (const std::string& device) const;
62 uint32_t available_input_channel_count (const std::string& device) const;
63 uint32_t available_output_channel_count (const std::string& device) const;
65 bool can_change_sample_rate_when_running() const;
66 bool can_change_buffer_size_when_running() const;
68 int set_device_name (const std::string&);
69 int set_sample_rate (float);
70 int set_buffer_size (uint32_t);
71 int set_sample_format (SampleFormat);
72 int set_interleaved (bool yn);
73 int set_input_channels (uint32_t);
74 int set_output_channels (uint32_t);
75 int set_systemic_input_latency (uint32_t);
76 int set_systemic_output_latency (uint32_t);
78 std::string device_name () const;
79 float sample_rate () const;
80 uint32_t buffer_size () const;
81 SampleFormat sample_format () const;
82 bool interleaved () const;
83 uint32_t input_channels () const;
84 uint32_t output_channels () const;
85 uint32_t systemic_input_latency () const;
86 uint32_t systemic_output_latency () const;
87 std::string driver_name() const;
89 std::string control_app_name () const;
90 void launch_control_app ();
95 float dsp_load() const;
97 pframes_t sample_time ();
98 pframes_t sample_time_at_cycle_start ();
99 pframes_t samples_since_cycle_start ();
101 size_t raw_buffer_size (DataType t);
103 int create_process_thread (boost::function<void()> func);
104 int join_process_threads ();
105 bool in_process_thread ();
106 uint32_t process_thread_count ();
108 void transport_start ();
109 void transport_stop ();
110 void transport_locate (framepos_t /*pos*/);
111 TransportState transport_state () const;
112 framepos_t transport_frame() const;
114 int set_time_master (bool /*yn*/);
115 bool get_sync_offset (pframes_t& /*offset*/) const;
117 void update_latencies ();
119 static bool already_configured();
123 const std::string& my_name() const;
124 uint32_t port_name_size() const;
126 int set_port_name (PortHandle, const std::string&);
127 std::string get_port_name (PortHandle) const;
128 PortHandle get_port_by_name (const std::string&) const;
130 int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&) const;
132 DataType port_data_type (PortHandle) const;
134 PortHandle register_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
135 void unregister_port (PortHandle);
137 bool connected (PortHandle, bool process_callback_safe);
138 bool connected_to (PortHandle, const std::string&, bool process_callback_safe);
139 bool physically_connected (PortHandle, bool process_callback_safe);
140 int get_connections (PortHandle, std::vector<std::string>&, bool process_callback_safe);
141 int connect (PortHandle, const std::string&);
143 int disconnect (PortHandle, const std::string&);
144 int disconnect_all (PortHandle);
145 int connect (const std::string& src, const std::string& dst);
146 int disconnect (const std::string& src, const std::string& dst);
150 std::vector<std::string> enumerate_midi_options () const;
151 int set_midi_option (const std::string&);
152 std::string midi_option () const;
154 int midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index);
155 int midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
156 uint32_t get_midi_event_count (void* port_buffer);
157 void midi_clear (void* port_buffer);
161 bool can_monitor_input() const;
162 int request_input_monitoring (PortHandle, bool);
163 int ensure_input_monitoring (PortHandle, bool);
164 bool monitoring_input (PortHandle);
166 /* Latency management
169 void set_latency_range (PortHandle, bool for_playback, LatencyRange);
170 LatencyRange get_latency_range (PortHandle, bool for_playback);
174 bool port_is_physical (PortHandle) const;
175 void get_physical_outputs (DataType type, std::vector<std::string>&);
176 void get_physical_inputs (DataType type, std::vector<std::string>&);
177 ChanCount n_physical_outputs () const;
178 ChanCount n_physical_inputs () const;
180 /* Getting access to the data buffer for a port */
182 void* get_buffer (PortHandle, pframes_t);
186 bool speed_and_position (double& sp, framepos_t& pos);
189 boost::shared_ptr<JackConnection> _jack_connection;
192 std::map<DataType,size_t> _raw_buffer_sizes;
194 std::vector<jack_native_thread_t> _jack_threads;
196 static int _xrun_callback (void *arg);
197 static void* _process_thread (void *arg);
198 static int _sample_rate_callback (pframes_t nframes, void *arg);
199 static int _bufsize_callback (pframes_t nframes, void *arg);
200 static void _jack_timebase_callback (jack_transport_state_t, pframes_t, jack_position_t*, int, void*);
201 static int _jack_sync_callback (jack_transport_state_t, jack_position_t*, void *arg);
202 static void _freewheel_callback (int , void *arg);
203 static void _latency_callback (jack_latency_callback_mode_t, void*);
204 static void _session_callback (jack_session_event_t *event, void *arg);
206 void jack_timebase_callback (jack_transport_state_t, pframes_t, jack_position_t*, int);
207 int jack_sync_callback (jack_transport_state_t, jack_position_t*);
208 int jack_bufsize_callback (pframes_t);
209 int jack_sample_rate_callback (pframes_t);
210 void freewheel_callback (int);
211 int process_callback (pframes_t nframes);
212 void jack_latency_callback (jack_latency_callback_mode_t);
213 void disconnected (const char*);
215 void set_jack_callbacks ();
216 int reconnect_to_jack ();
219 JACKAudioBackend* engine;
220 boost::function<void()> f;
223 ThreadData (JACKAudioBackend* e, boost::function<void()> fp, size_t stacksz)
224 : engine (e) , f (fp) , stacksize (stacksz) {}
227 void* process_thread ();
228 static void* _start_process_thread (void*);
230 void setup_jack_startup_command (bool for_latency_measurement);
234 std::string _target_driver;
235 std::string _target_device;
236 float _target_sample_rate;
237 uint32_t _target_buffer_size;
238 SampleFormat _target_sample_format;
239 bool _target_interleaved;
240 uint32_t _target_input_channels;
241 uint32_t _target_output_channels;
242 uint32_t _target_systemic_input_latency;
243 uint32_t _target_systemic_output_latency;
244 uint32_t _current_sample_rate;
245 uint32_t _current_buffer_size;
246 std::string _target_midi_option;
248 typedef std::set<std::string> DeviceList;
249 typedef std::map<std::string,DeviceList> DriverDeviceMap;
251 mutable DriverDeviceMap all_devices;
253 PBD::ScopedConnection disconnect_connection;
255 /* PORTENGINE RELATED */
257 static int _graph_order_callback (void *arg);
258 static void _registration_callback (jack_port_id_t, int, void *);
259 static void _connect_callback (jack_port_id_t, jack_port_id_t, int, void *);
261 void connect_callback (jack_port_id_t, jack_port_id_t, int);
263 ChanCount n_physical (unsigned long flags) const;
264 void get_physical (DataType type, unsigned long flags, std::vector<std::string>& phy) const;
266 void when_connected_to_jack ();
267 PBD::ScopedConnection jack_connection_connection;
269 /* Object to manage interactions with Session in a way that
270 keeps JACK out of libardour directly
273 JACKSession* _session;
276 int _start (bool for_latency_measurement);
281 #endif /* __ardour_audiobackend_h__ */