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 "ardour/audio_backend.h"
34 #include "ardour/dsp_load_calculator.h"
35 #include "ardour/system_exec.h"
36 #include "ardour/types.h"
38 #include "ardouralsautil/deviceinfo.h"
40 #include "zita-alsa-pcmi.h"
41 #include "alsa_rawmidi.h"
42 #include "alsa_sequencer.h"
46 class AlsaAudioBackend;
50 AlsaMidiEvent (const pframes_t timestamp, const uint8_t* data, size_t size);
51 AlsaMidiEvent (const AlsaMidiEvent& other);
53 size_t size () const { return _size; };
54 pframes_t timestamp () const { return _timestamp; };
55 const unsigned char* const_data () const { return _data; };
56 unsigned char* data () { return _data; };
57 bool operator< (const AlsaMidiEvent &other) const { return timestamp () < other.timestamp (); };
64 typedef std::vector<boost::shared_ptr<AlsaMidiEvent> > AlsaMidiBuffer;
68 AlsaPort (AlsaAudioBackend &b, const std::string&, PortFlags);
72 const std::string& name () const { return _name; }
73 PortFlags flags () const { return _flags; }
75 int set_name (const std::string &name) { _name = name; return 0; }
77 virtual DataType type () const = 0;
79 bool is_input () const { return flags () & IsInput; }
80 bool is_output () const { return flags () & IsOutput; }
81 bool is_physical () const { return flags () & IsPhysical; }
82 bool is_terminal () const { return flags () & IsTerminal; }
83 bool is_connected () const { return _connections.size () != 0; }
84 bool is_connected (const AlsaPort *port) const;
85 bool is_physically_connected () const;
87 const std::vector<AlsaPort *>& get_connections () const { return _connections; }
89 int connect (AlsaPort *port);
90 int disconnect (AlsaPort *port);
91 void disconnect_all ();
93 virtual void* get_buffer (pframes_t nframes) = 0;
95 const LatencyRange latency_range (bool for_playback) const
97 return for_playback ? _playback_latency_range : _capture_latency_range;
100 void set_latency_range (const LatencyRange &latency_range, bool for_playback)
104 _playback_latency_range = latency_range;
108 _capture_latency_range = latency_range;
113 AlsaAudioBackend &_alsa_backend;
115 const PortFlags _flags;
116 LatencyRange _capture_latency_range;
117 LatencyRange _playback_latency_range;
118 std::vector<AlsaPort*> _connections;
120 void _connect (AlsaPort* , bool);
121 void _disconnect (AlsaPort* , bool);
125 class AlsaAudioPort : public AlsaPort {
127 AlsaAudioPort (AlsaAudioBackend &b, const std::string&, PortFlags);
130 DataType type () const { return DataType::AUDIO; };
132 Sample* buffer () { return _buffer; }
133 const Sample* const_buffer () const { return _buffer; }
134 void* get_buffer (pframes_t nframes);
137 Sample _buffer[8192];
138 }; // class AlsaAudioPort
140 class AlsaMidiPort : public AlsaPort {
142 AlsaMidiPort (AlsaAudioBackend &b, const std::string&, PortFlags);
145 DataType type () const { return DataType::MIDI; };
147 void* get_buffer (pframes_t nframes);
148 const AlsaMidiBuffer * const_buffer () const { return & _buffer[_bufperiod]; }
150 void next_period() { if (_n_periods > 1) { get_buffer(0); _bufperiod = (_bufperiod + 1) % _n_periods; } }
151 void set_n_periods(int n) { if (n > 0 && n < 4) { _n_periods = n; } }
154 AlsaMidiBuffer _buffer[3];
157 }; // class AlsaMidiPort
159 class AlsaAudioBackend : public AudioBackend {
160 friend class AlsaPort;
162 AlsaAudioBackend (AudioEngine& e, AudioBackendInfo& info);
163 ~AlsaAudioBackend ();
165 /* AUDIOBACKEND API */
167 std::string name () const;
168 bool is_realtime () const;
170 bool use_separate_input_and_output_devices () const { return true; }
171 bool can_set_period_size () const { return true; }
173 std::vector<DeviceStatus> enumerate_devices () const;
174 std::vector<DeviceStatus> enumerate_input_devices () const;
175 std::vector<DeviceStatus> enumerate_output_devices () const;
176 std::vector<float> available_sample_rates (const std::string& device) const;
177 std::vector<float> available_sample_rates2 (const std::string&, const std::string&) const;
178 std::vector<uint32_t> available_buffer_sizes (const std::string& device) const;
179 std::vector<uint32_t> available_buffer_sizes2 (const std::string&, const std::string&) const;
180 std::vector<uint32_t> available_period_sizes (const std::string& driver) const;
181 uint32_t available_input_channel_count (const std::string& device) const;
182 uint32_t available_output_channel_count (const std::string& device) const;
184 bool can_change_sample_rate_when_running () const;
185 bool can_change_buffer_size_when_running () const;
187 bool can_change_systemic_latency_when_running () const { return true; }
189 int set_device_name (const std::string&);
190 int set_input_device_name (const std::string&);
191 int set_output_device_name (const std::string&);
192 int set_sample_rate (float);
193 int set_buffer_size (uint32_t);
194 int set_peridod_size (uint32_t);
195 int set_interleaved (bool yn);
196 int set_input_channels (uint32_t);
197 int set_output_channels (uint32_t);
198 int set_systemic_input_latency (uint32_t);
199 int set_systemic_output_latency (uint32_t);
200 int set_systemic_midi_input_latency (std::string const, uint32_t);
201 int set_systemic_midi_output_latency (std::string const, uint32_t);
203 int reset_device () { return 0; };
205 /* Retrieving parameters */
206 std::string device_name () const;
207 std::string input_device_name () const;
208 std::string output_device_name () const;
209 float sample_rate () const;
210 uint32_t buffer_size () const;
211 uint32_t period_size () const;
212 bool interleaved () const;
213 uint32_t input_channels () const;
214 uint32_t output_channels () const;
215 uint32_t systemic_input_latency () const;
216 uint32_t systemic_output_latency () const;
217 uint32_t systemic_midi_input_latency (std::string const) const;
218 uint32_t systemic_midi_output_latency (std::string const) const;
220 bool can_set_systemic_midi_latencies () const { return true; }
222 /* External control app */
223 std::string control_app_name () const { return std::string (); }
224 void launch_control_app () {}
227 std::vector<std::string> enumerate_midi_options () const;
228 int set_midi_option (const std::string&);
229 std::string midi_option () const;
231 std::vector<DeviceStatus> enumerate_midi_devices () const;
232 int set_midi_device_enabled (std::string const, bool);
233 bool midi_device_enabled (std::string const) const;
237 int _start (bool for_latency_measurement);
240 int freewheel (bool);
241 float dsp_load () const;
242 size_t raw_buffer_size (DataType t);
245 framepos_t sample_time ();
246 framepos_t sample_time_at_cycle_start ();
247 pframes_t samples_since_cycle_start ();
249 int create_process_thread (boost::function<void()> func);
250 int join_process_threads ();
251 bool in_process_thread ();
252 uint32_t process_thread_count ();
254 void update_latencies ();
258 void* private_handle () const;
259 const std::string& my_name () const;
260 bool available () const;
261 uint32_t port_name_size () const;
263 int set_port_name (PortHandle, const std::string&);
264 std::string get_port_name (PortHandle) const;
265 PortHandle get_port_by_name (const std::string&) const;
267 int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&) const;
269 DataType port_data_type (PortHandle) const;
271 PortHandle register_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
272 void unregister_port (PortHandle);
274 int connect (const std::string& src, const std::string& dst);
275 int disconnect (const std::string& src, const std::string& dst);
276 int connect (PortHandle, const std::string&);
277 int disconnect (PortHandle, const std::string&);
278 int disconnect_all (PortHandle);
280 bool connected (PortHandle, bool process_callback_safe);
281 bool connected_to (PortHandle, const std::string&, bool process_callback_safe);
282 bool physically_connected (PortHandle, bool process_callback_safe);
283 int get_connections (PortHandle, std::vector<std::string>&, bool process_callback_safe);
286 int midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index);
287 int midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
288 uint32_t get_midi_event_count (void* port_buffer);
289 void midi_clear (void* port_buffer);
293 bool can_monitor_input () const;
294 int request_input_monitoring (PortHandle, bool);
295 int ensure_input_monitoring (PortHandle, bool);
296 bool monitoring_input (PortHandle);
298 /* Latency management */
300 void set_latency_range (PortHandle, bool for_playback, LatencyRange);
301 LatencyRange get_latency_range (PortHandle, bool for_playback);
303 /* Discovering physical ports */
305 bool port_is_physical (PortHandle) const;
306 void get_physical_outputs (DataType type, std::vector<std::string>&);
307 void get_physical_inputs (DataType type, std::vector<std::string>&);
308 ChanCount n_physical_outputs () const;
309 ChanCount n_physical_inputs () const;
311 /* Getting access to the data buffer for a port */
313 void* get_buffer (PortHandle, pframes_t);
315 void* main_process_thread ();
318 std::string _instance_name;
321 bool _run; /* keep going or stop, ardour thread */
322 bool _active; /* is running, process thread */
325 bool _measure_latency;
327 uint64_t _last_process_start;
329 static std::vector<std::string> _midi_options;
330 static std::vector<AudioBackend::DeviceStatus> _input_audio_device_status;
331 static std::vector<AudioBackend::DeviceStatus> _output_audio_device_status;
332 static std::vector<AudioBackend::DeviceStatus> _duplex_audio_device_status;
333 static std::vector<AudioBackend::DeviceStatus> _midi_device_status;
334 static ARDOUR::ALSADeviceInfo _input_audio_device_info;
335 static ARDOUR::ALSADeviceInfo _output_audio_device_info;
337 mutable std::string _input_audio_device;
338 mutable std::string _output_audio_device;
339 std::string _midi_driver_option;
341 /* audio device reservation */
342 ARDOUR::SystemExec *_device_reservation;
343 PBD::ScopedConnectionList _reservation_connection;
344 void reservation_stdout (std::string, size_t);
345 bool acquire_device(const char* device_name);
346 void release_device();
347 bool _reservation_succeeded;
351 size_t _samples_per_period;
352 size_t _periods_per_cycle;
353 static size_t _max_buffer_size;
358 uint32_t _systemic_audio_input_latency;
359 uint32_t _systemic_audio_output_latency;
362 struct AlsaMidiDeviceInfo {
364 uint32_t systemic_input_latency;
365 uint32_t systemic_output_latency;
368 , systemic_input_latency (0)
369 , systemic_output_latency (0)
373 mutable std::map<std::string, struct AlsaMidiDeviceInfo *> _midi_devices;
374 struct AlsaMidiDeviceInfo * midi_device_info(std::string const) const;
378 ARDOUR::DSPLoadCalculator _dsp_load_calc;
379 framecnt_t _processed_samples;
380 pthread_t _main_thread;
382 /* process threads */
383 static void* alsa_process_thread (void *);
384 std::vector<pthread_t> _threads;
387 AlsaAudioBackend* engine;
388 boost::function<void ()> f;
391 ThreadData (AlsaAudioBackend* e, boost::function<void ()> fp, size_t stacksz)
392 : engine (e) , f (fp) , stacksize (stacksz) {}
396 PortHandle add_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
397 int register_system_audio_ports ();
398 int register_system_midi_ports (const std::string device = "");
399 void unregister_ports (bool system_only = false);
401 std::vector<AlsaPort *> _ports;
402 std::vector<AlsaPort *> _system_inputs;
403 std::vector<AlsaPort *> _system_outputs;
404 std::vector<AlsaPort *> _system_midi_in;
405 std::vector<AlsaPort *> _system_midi_out;
407 std::vector<AlsaMidiOut *> _rmidi_out;
408 std::vector<AlsaMidiIn *> _rmidi_in;
413 struct PortConnectData {
418 PortConnectData (const std::string& a, const std::string& b, bool c)
419 : a (a) , b (b) , c (c) {}
422 std::vector<PortConnectData *> _port_connection_queue;
423 pthread_mutex_t _port_callback_mutex;
424 bool _port_change_flag;
426 void port_connect_callback (const std::string& a, const std::string& b, bool conn) {
427 pthread_mutex_lock (&_port_callback_mutex);
428 _port_connection_queue.push_back(new PortConnectData(a, b, conn));
429 pthread_mutex_unlock (&_port_callback_mutex);
432 void port_connect_add_remove_callback () {
433 pthread_mutex_lock (&_port_callback_mutex);
434 _port_change_flag = true;
435 pthread_mutex_unlock (&_port_callback_mutex);
438 bool valid_port (PortHandle port) const {
439 return std::find (_ports.begin (), _ports.end (), (AlsaPort*)port) != _ports.end ();
442 AlsaPort * find_port (const std::string& port_name) const {
443 for (std::vector<AlsaPort*>::const_iterator it = _ports.begin (); it != _ports.end (); ++it) {
444 if ((*it)->name () == port_name) {
451 void update_systemic_audio_latencies ();
452 void update_systemic_midi_latencies ();
454 }; // class AlsaAudioBackend
458 #endif /* __libbackend_alsa_audiobackend_h__ */