2 * Copyright (C) 2014 Robin Gareus <robin@gareus.org>
3 * Copyright (C) 2013 Paul Davis
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef __libbackend_alsa_audiobackend_h__
21 #define __libbackend_alsa_audiobackend_h__
31 #include <boost/shared_ptr.hpp>
33 #include "pbd/natsort.h"
34 #include "ardour/audio_backend.h"
35 #include "ardour/dsp_load_calculator.h"
36 #include "ardour/system_exec.h"
37 #include "ardour/types.h"
39 #include "ardouralsautil/deviceinfo.h"
41 #include "zita-alsa-pcmi.h"
42 #include "alsa_rawmidi.h"
43 #include "alsa_sequencer.h"
47 class AlsaAudioBackend;
51 AlsaMidiEvent (const pframes_t timestamp, const uint8_t* data, size_t size);
52 AlsaMidiEvent (const AlsaMidiEvent& other);
54 size_t size () const { return _size; };
55 pframes_t timestamp () const { return _timestamp; };
56 const unsigned char* const_data () const { return _data; };
57 unsigned char* data () { return _data; };
58 bool operator< (const AlsaMidiEvent &other) const { return timestamp () < other.timestamp (); };
65 typedef std::vector<boost::shared_ptr<AlsaMidiEvent> > AlsaMidiBuffer;
69 AlsaPort (AlsaAudioBackend &b, const std::string&, PortFlags);
73 const std::string& name () const { return _name; }
74 const std::string& pretty_name () const { return _pretty_name; }
75 PortFlags flags () const { return _flags; }
77 int set_name (const std::string &name) { _name = name; return 0; }
78 int set_pretty_name (const std::string &name) { _pretty_name = name; return 0; }
80 virtual DataType type () const = 0;
82 bool is_input () const { return flags () & IsInput; }
83 bool is_output () const { return flags () & IsOutput; }
84 bool is_physical () const { return flags () & IsPhysical; }
85 bool is_terminal () const { return flags () & IsTerminal; }
86 bool is_connected () const { return _connections.size () != 0; }
87 bool is_connected (const AlsaPort *port) const;
88 bool is_physically_connected () const;
90 const std::set<AlsaPort *>& get_connections () const { return _connections; }
92 int connect (AlsaPort *port);
93 int disconnect (AlsaPort *port);
94 void disconnect_all ();
96 virtual void* get_buffer (pframes_t nframes) = 0;
98 const LatencyRange latency_range (bool for_playback) const
100 return for_playback ? _playback_latency_range : _capture_latency_range;
103 void set_latency_range (const LatencyRange &latency_range, bool for_playback)
107 _playback_latency_range = latency_range;
111 _capture_latency_range = latency_range;
116 AlsaAudioBackend &_alsa_backend;
118 std::string _pretty_name;
119 const PortFlags _flags;
120 LatencyRange _capture_latency_range;
121 LatencyRange _playback_latency_range;
122 std::set<AlsaPort*> _connections;
124 void _connect (AlsaPort* , bool);
125 void _disconnect (AlsaPort* , bool);
129 class AlsaAudioPort : public AlsaPort {
131 AlsaAudioPort (AlsaAudioBackend &b, const std::string&, PortFlags);
134 DataType type () const { return DataType::AUDIO; };
136 Sample* buffer () { return _buffer; }
137 const Sample* const_buffer () const { return _buffer; }
138 void* get_buffer (pframes_t nframes);
141 Sample _buffer[8192];
142 }; // class AlsaAudioPort
144 class AlsaMidiPort : public AlsaPort {
146 AlsaMidiPort (AlsaAudioBackend &b, const std::string&, PortFlags);
149 DataType type () const { return DataType::MIDI; };
151 void* get_buffer (pframes_t nframes);
152 const AlsaMidiBuffer * const_buffer () const { return & _buffer[_bufperiod]; }
154 void next_period() { if (_n_periods > 1) { get_buffer(0); _bufperiod = (_bufperiod + 1) % _n_periods; } }
155 void set_n_periods(int n) { if (n > 0 && n < 4) { _n_periods = n; } }
158 AlsaMidiBuffer _buffer[3];
161 }; // class AlsaMidiPort
163 class AlsaAudioBackend : public AudioBackend {
164 friend class AlsaPort;
166 AlsaAudioBackend (AudioEngine& e, AudioBackendInfo& info);
167 ~AlsaAudioBackend ();
169 /* AUDIOBACKEND API */
171 std::string name () const;
172 bool is_realtime () const;
174 bool use_separate_input_and_output_devices () const { return true; }
175 bool match_input_output_devices_or_none () const { return true; }
176 bool can_set_period_size () const { return true; }
178 std::vector<DeviceStatus> enumerate_devices () const;
179 std::vector<DeviceStatus> enumerate_input_devices () const;
180 std::vector<DeviceStatus> enumerate_output_devices () const;
181 std::vector<float> available_sample_rates (const std::string& device) const;
182 std::vector<float> available_sample_rates2 (const std::string&, const std::string&) const;
183 std::vector<uint32_t> available_buffer_sizes (const std::string& device) const;
184 std::vector<uint32_t> available_buffer_sizes2 (const std::string&, const std::string&) const;
185 std::vector<uint32_t> available_period_sizes (const std::string& driver) const;
186 uint32_t available_input_channel_count (const std::string& device) const;
187 uint32_t available_output_channel_count (const std::string& device) const;
189 bool can_change_sample_rate_when_running () const;
190 bool can_change_buffer_size_when_running () const;
192 bool can_change_systemic_latency_when_running () const { return true; }
194 int set_device_name (const std::string&);
195 int set_input_device_name (const std::string&);
196 int set_output_device_name (const std::string&);
197 int set_sample_rate (float);
198 int set_buffer_size (uint32_t);
199 int set_peridod_size (uint32_t);
200 int set_interleaved (bool yn);
201 int set_input_channels (uint32_t);
202 int set_output_channels (uint32_t);
203 int set_systemic_input_latency (uint32_t);
204 int set_systemic_output_latency (uint32_t);
205 int set_systemic_midi_input_latency (std::string const, uint32_t);
206 int set_systemic_midi_output_latency (std::string const, uint32_t);
208 int reset_device () { return 0; };
210 /* Retrieving parameters */
211 std::string device_name () const;
212 std::string input_device_name () const;
213 std::string output_device_name () const;
214 float sample_rate () const;
215 uint32_t buffer_size () const;
216 uint32_t period_size () const;
217 bool interleaved () const;
218 uint32_t input_channels () const;
219 uint32_t output_channels () const;
220 uint32_t systemic_input_latency () const;
221 uint32_t systemic_output_latency () const;
222 uint32_t systemic_midi_input_latency (std::string const) const;
223 uint32_t systemic_midi_output_latency (std::string const) const;
225 bool can_set_systemic_midi_latencies () const { return true; }
227 /* External control app */
228 std::string control_app_name () const { return std::string (); }
229 void launch_control_app () {}
232 std::vector<std::string> enumerate_midi_options () const;
233 int set_midi_option (const std::string&);
234 std::string midi_option () const;
236 std::vector<DeviceStatus> enumerate_midi_devices () const;
237 int set_midi_device_enabled (std::string const, bool);
238 bool midi_device_enabled (std::string const) const;
242 int _start (bool for_latency_measurement);
245 int freewheel (bool);
246 float dsp_load () const;
247 size_t raw_buffer_size (DataType t);
250 framepos_t sample_time ();
251 framepos_t sample_time_at_cycle_start ();
252 pframes_t samples_since_cycle_start ();
254 int create_process_thread (boost::function<void()> func);
255 int join_process_threads ();
256 bool in_process_thread ();
257 uint32_t process_thread_count ();
259 void update_latencies ();
263 void* private_handle () const;
264 const std::string& my_name () const;
265 bool available () const;
266 uint32_t port_name_size () const;
268 int set_port_name (PortHandle, const std::string&);
269 std::string get_port_name (PortHandle) const;
270 PortHandle get_port_by_name (const std::string&) const;
272 int get_port_property (PortHandle, const std::string& key, std::string& value, std::string& type) const;
273 int set_port_property (PortHandle, const std::string& key, const std::string& value, const std::string& type);
275 int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&) const;
277 DataType port_data_type (PortHandle) const;
279 PortHandle register_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
280 void unregister_port (PortHandle);
282 int connect (const std::string& src, const std::string& dst);
283 int disconnect (const std::string& src, const std::string& dst);
284 int connect (PortHandle, const std::string&);
285 int disconnect (PortHandle, const std::string&);
286 int disconnect_all (PortHandle);
288 bool connected (PortHandle, bool process_callback_safe);
289 bool connected_to (PortHandle, const std::string&, bool process_callback_safe);
290 bool physically_connected (PortHandle, bool process_callback_safe);
291 int get_connections (PortHandle, std::vector<std::string>&, bool process_callback_safe);
294 int midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index);
295 int midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
296 uint32_t get_midi_event_count (void* port_buffer);
297 void midi_clear (void* port_buffer);
301 bool can_monitor_input () const;
302 int request_input_monitoring (PortHandle, bool);
303 int ensure_input_monitoring (PortHandle, bool);
304 bool monitoring_input (PortHandle);
306 /* Latency management */
308 void set_latency_range (PortHandle, bool for_playback, LatencyRange);
309 LatencyRange get_latency_range (PortHandle, bool for_playback);
311 /* Discovering physical ports */
313 bool port_is_physical (PortHandle) const;
314 void get_physical_outputs (DataType type, std::vector<std::string>&);
315 void get_physical_inputs (DataType type, std::vector<std::string>&);
316 ChanCount n_physical_outputs () const;
317 ChanCount n_physical_inputs () const;
319 /* Getting access to the data buffer for a port */
321 void* get_buffer (PortHandle, pframes_t);
323 void* main_process_thread ();
326 std::string _instance_name;
329 bool _run; /* keep going or stop, ardour thread */
330 bool _active; /* is running, process thread */
333 bool _measure_latency;
335 uint64_t _last_process_start;
337 static std::vector<std::string> _midi_options;
338 static std::vector<AudioBackend::DeviceStatus> _input_audio_device_status;
339 static std::vector<AudioBackend::DeviceStatus> _output_audio_device_status;
340 static std::vector<AudioBackend::DeviceStatus> _duplex_audio_device_status;
341 static std::vector<AudioBackend::DeviceStatus> _midi_device_status;
342 static ARDOUR::ALSADeviceInfo _input_audio_device_info;
343 static ARDOUR::ALSADeviceInfo _output_audio_device_info;
345 mutable std::string _input_audio_device;
346 mutable std::string _output_audio_device;
347 std::string _midi_driver_option;
349 /* audio device reservation */
350 ARDOUR::SystemExec *_device_reservation;
351 PBD::ScopedConnectionList _reservation_connection;
352 void reservation_stdout (std::string, size_t);
353 bool acquire_device(const char* device_name);
354 void release_device();
355 bool _reservation_succeeded;
359 size_t _samples_per_period;
360 size_t _periods_per_cycle;
361 static size_t _max_buffer_size;
366 uint32_t _systemic_audio_input_latency;
367 uint32_t _systemic_audio_output_latency;
370 struct AlsaMidiDeviceInfo {
372 uint32_t systemic_input_latency;
373 uint32_t systemic_output_latency;
376 , systemic_input_latency (0)
377 , systemic_output_latency (0)
381 mutable std::map<std::string, struct AlsaMidiDeviceInfo *> _midi_devices;
382 struct AlsaMidiDeviceInfo * midi_device_info(std::string const) const;
386 ARDOUR::DSPLoadCalculator _dsp_load_calc;
387 framecnt_t _processed_samples;
388 pthread_t _main_thread;
390 /* process threads */
391 static void* alsa_process_thread (void *);
392 std::vector<pthread_t> _threads;
395 AlsaAudioBackend* engine;
396 boost::function<void ()> f;
399 ThreadData (AlsaAudioBackend* e, boost::function<void ()> fp, size_t stacksz)
400 : engine (e) , f (fp) , stacksize (stacksz) {}
404 PortHandle add_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
405 int register_system_audio_ports ();
406 int register_system_midi_ports (const std::string device = "");
407 void unregister_ports (bool system_only = false);
409 std::vector<AlsaPort *> _system_inputs;
410 std::vector<AlsaPort *> _system_outputs;
411 std::vector<AlsaPort *> _system_midi_in;
412 std::vector<AlsaPort *> _system_midi_out;
414 struct SortByPortName
416 bool operator ()(const AlsaPort* lhs, const AlsaPort* rhs) const
418 return PBD::naturally_less (lhs->name ().c_str (), rhs->name ().c_str ());
422 typedef std::map<std::string, AlsaPort *> PortMap; // fast lookup in _ports
423 typedef std::set<AlsaPort *, SortByPortName> PortIndex; // fast lookup in _ports
427 std::vector<AlsaMidiOut *> _rmidi_out;
428 std::vector<AlsaMidiIn *> _rmidi_in;
433 struct PortConnectData {
438 PortConnectData (const std::string& a, const std::string& b, bool c)
439 : a (a) , b (b) , c (c) {}
442 std::vector<PortConnectData *> _port_connection_queue;
443 pthread_mutex_t _port_callback_mutex;
444 bool _port_change_flag;
446 void port_connect_callback (const std::string& a, const std::string& b, bool conn) {
447 pthread_mutex_lock (&_port_callback_mutex);
448 _port_connection_queue.push_back(new PortConnectData(a, b, conn));
449 pthread_mutex_unlock (&_port_callback_mutex);
452 void port_connect_add_remove_callback () {
453 pthread_mutex_lock (&_port_callback_mutex);
454 _port_change_flag = true;
455 pthread_mutex_unlock (&_port_callback_mutex);
458 bool valid_port (PortHandle port) const {
459 return std::find (_ports.begin(), _ports.end(), static_cast<AlsaPort*>(port)) != _ports.end ();
462 AlsaPort* find_port (const std::string& port_name) const {
463 PortMap::const_iterator it = _portmap.find (port_name);
464 if (it == _portmap.end()) {
470 void update_systemic_audio_latencies ();
471 void update_systemic_midi_latencies ();
473 }; // class AlsaAudioBackend
477 #endif /* __libbackend_alsa_audiobackend_h__ */