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 "weak_libjack.h"
34 #include "ardour/audio_backend.h"
41 class JACKAudioBackend : public AudioBackend {
43 JACKAudioBackend (AudioEngine& e, AudioBackendInfo& info, boost::shared_ptr<JackConnection>);
46 /* AUDIOBACKEND API */
48 std::string name() const;
49 void* private_handle() const;
50 bool available() const;
51 bool is_realtime () const;
53 bool requires_driver_selection() const;
54 std::vector<std::string> enumerate_drivers () const;
55 int set_driver (const std::string&);
57 std::vector<DeviceStatus> enumerate_devices () const;
59 std::vector<float> available_sample_rates (const std::string& device) const;
60 std::vector<uint32_t> available_buffer_sizes (const std::string& device) const;
61 uint32_t available_input_channel_count (const std::string& device) const;
62 uint32_t available_output_channel_count (const std::string& device) const;
64 bool can_change_sample_rate_when_running() const;
65 bool can_change_buffer_size_when_running() const;
67 int set_device_name (const std::string&);
68 int set_sample_rate (float);
69 int set_buffer_size (uint32_t);
70 int set_interleaved (bool yn);
71 int set_input_channels (uint32_t);
72 int set_output_channels (uint32_t);
73 int set_systemic_input_latency (uint32_t);
74 int set_systemic_output_latency (uint32_t);
75 int set_systemic_midi_input_latency (std::string const, uint32_t) { return 0; }
76 int set_systemic_midi_output_latency (std::string const, uint32_t) { return 0; }
80 std::string device_name () const;
81 float sample_rate () const;
82 uint32_t buffer_size () const;
83 bool interleaved () const;
84 uint32_t input_channels () const;
85 uint32_t output_channels () const;
86 uint32_t systemic_input_latency () const;
87 uint32_t systemic_output_latency () const;
88 uint32_t systemic_midi_input_latency (std::string const) const { return 0; }
89 uint32_t systemic_midi_output_latency (std::string const) const { return 0; }
90 std::string driver_name() const;
92 std::string control_app_name () const;
93 void launch_control_app ();
98 float dsp_load() const;
100 framepos_t sample_time ();
101 framepos_t sample_time_at_cycle_start ();
102 pframes_t samples_since_cycle_start ();
104 size_t raw_buffer_size (DataType t);
106 int create_process_thread (boost::function<void()> func);
107 int join_process_threads ();
108 bool in_process_thread ();
109 uint32_t process_thread_count ();
111 void transport_start ();
112 void transport_stop ();
113 void transport_locate (framepos_t /*pos*/);
114 TransportState transport_state () const;
115 framepos_t transport_frame() const;
117 int set_time_master (bool /*yn*/);
118 bool get_sync_offset (pframes_t& /*offset*/) const;
120 void update_latencies ();
122 static bool already_configured();
126 const std::string& my_name() const;
127 uint32_t port_name_size() const;
129 int set_port_name (PortHandle, const std::string&);
130 std::string get_port_name (PortHandle) const;
131 PortHandle get_port_by_name (const std::string&) const;
132 int get_port_property (PortHandle, const std::string& key, std::string& value, std::string& type) const;
134 int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&) const;
136 DataType port_data_type (PortHandle) const;
138 PortHandle register_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
139 void unregister_port (PortHandle);
141 bool connected (PortHandle, bool process_callback_safe);
142 bool connected_to (PortHandle, const std::string&, bool process_callback_safe);
143 bool physically_connected (PortHandle, bool process_callback_safe);
144 int get_connections (PortHandle, std::vector<std::string>&, bool process_callback_safe);
145 int connect (PortHandle, const std::string&);
147 int disconnect (PortHandle, const std::string&);
148 int disconnect_all (PortHandle);
149 int connect (const std::string& src, const std::string& dst);
150 int disconnect (const std::string& src, const std::string& dst);
154 std::vector<std::string> enumerate_midi_options () const;
155 int set_midi_option (const std::string&);
156 std::string midi_option () const;
158 std::vector<DeviceStatus> enumerate_midi_devices () const {
159 return std::vector<AudioBackend::DeviceStatus> ();
161 int set_midi_device_enabled (std::string const, bool) {
164 bool midi_device_enabled (std::string const) const {
167 bool can_set_systemic_midi_latencies () const {
171 int midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index);
172 int midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
173 uint32_t get_midi_event_count (void* port_buffer);
174 void midi_clear (void* port_buffer);
178 bool can_monitor_input() const;
179 int request_input_monitoring (PortHandle, bool);
180 int ensure_input_monitoring (PortHandle, bool);
181 bool monitoring_input (PortHandle);
183 /* Latency management
186 void set_latency_range (PortHandle, bool for_playback, LatencyRange);
187 LatencyRange get_latency_range (PortHandle, bool for_playback);
191 bool port_is_physical (PortHandle) const;
192 void get_physical_outputs (DataType type, std::vector<std::string>&);
193 void get_physical_inputs (DataType type, std::vector<std::string>&);
194 ChanCount n_physical_outputs () const;
195 ChanCount n_physical_inputs () const;
197 /* Getting access to the data buffer for a port */
199 void* get_buffer (PortHandle, pframes_t);
203 bool speed_and_position (double& sp, framepos_t& pos);
206 boost::shared_ptr<JackConnection> _jack_connection;
209 std::map<DataType,size_t> _raw_buffer_sizes;
211 std::vector<jack_native_thread_t> _jack_threads;
212 jack_native_thread_t _main_thread;
214 static int _xrun_callback (void *arg);
215 static void* _process_thread (void *arg);
216 static int _sample_rate_callback (pframes_t nframes, void *arg);
217 static int _bufsize_callback (pframes_t nframes, void *arg);
218 static void _jack_timebase_callback (jack_transport_state_t, pframes_t, jack_position_t*, int, void*);
219 static int _jack_sync_callback (jack_transport_state_t, jack_position_t*, void *arg);
220 static void _freewheel_callback (int , void *arg);
221 static void _latency_callback (jack_latency_callback_mode_t, void*);
222 static void _session_callback (jack_session_event_t *event, void *arg);
224 void jack_timebase_callback (jack_transport_state_t, pframes_t, jack_position_t*, int);
225 int jack_sync_callback (jack_transport_state_t, jack_position_t*);
226 int jack_bufsize_callback (pframes_t);
227 int jack_sample_rate_callback (pframes_t);
228 void freewheel_callback (int);
229 int process_callback (pframes_t nframes);
230 void jack_latency_callback (jack_latency_callback_mode_t);
231 void disconnected (const char*);
233 void set_jack_callbacks ();
234 int reconnect_to_jack ();
237 JACKAudioBackend* engine;
238 boost::function<void()> f;
241 ThreadData (JACKAudioBackend* e, boost::function<void()> fp, size_t stacksz)
242 : engine (e) , f (fp) , stacksize (stacksz) {}
245 void* process_thread ();
246 static void* _start_process_thread (void*);
248 void setup_jack_startup_command (bool for_latency_measurement);
252 std::string _target_driver;
253 std::string _target_device;
254 float _target_sample_rate;
255 uint32_t _target_buffer_size;
256 SampleFormat _target_sample_format;
257 bool _target_interleaved;
258 uint32_t _target_input_channels;
259 uint32_t _target_output_channels;
260 uint32_t _target_systemic_input_latency;
261 uint32_t _target_systemic_output_latency;
262 uint32_t _current_sample_rate;
263 uint32_t _current_buffer_size;
264 std::string _target_midi_option;
266 typedef std::set<std::string> DeviceList;
267 typedef std::map<std::string,DeviceList> DriverDeviceMap;
269 mutable DriverDeviceMap all_devices;
271 PBD::ScopedConnection disconnect_connection;
273 /* PORTENGINE RELATED */
275 static int _graph_order_callback (void *arg);
276 static void _registration_callback (jack_port_id_t, int, void *);
277 static void _connect_callback (jack_port_id_t, jack_port_id_t, int, void *);
279 void connect_callback (jack_port_id_t, jack_port_id_t, int);
281 ChanCount n_physical (unsigned long flags) const;
282 void get_physical (DataType type, unsigned long flags, std::vector<std::string>& phy) const;
284 void when_connected_to_jack ();
285 PBD::ScopedConnection jack_connection_connection;
287 /* Object to manage interactions with Session in a way that
288 keeps JACK out of libardour directly
291 JACKSession* _session;
294 int _start (bool for_latency_measurement);
299 #endif /* __ardour_audiobackend_h__ */