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/system_exec.h"
35 #include "ardour/types.h"
37 #include "zita-alsa-pcmi.h"
38 #include "alsa_rawmidi.h"
39 #include "alsa_sequencer.h"
43 class AlsaAudioBackend;
47 AlsaMidiEvent (const pframes_t timestamp, const uint8_t* data, size_t size);
48 AlsaMidiEvent (const AlsaMidiEvent& other);
50 size_t size () const { return _size; };
51 pframes_t timestamp () const { return _timestamp; };
52 const unsigned char* const_data () const { return _data; };
53 unsigned char* data () { return _data; };
54 bool operator< (const AlsaMidiEvent &other) const { return timestamp () < other.timestamp (); };
61 typedef std::vector<boost::shared_ptr<AlsaMidiEvent> > AlsaMidiBuffer;
65 AlsaPort (AlsaAudioBackend &b, const std::string&, PortFlags);
69 const std::string& name () const { return _name; }
70 PortFlags flags () const { return _flags; }
72 int set_name (const std::string &name) { _name = name; return 0; }
74 virtual DataType type () const = 0;
76 bool is_input () const { return flags () & IsInput; }
77 bool is_output () const { return flags () & IsOutput; }
78 bool is_physical () const { return flags () & IsPhysical; }
79 bool is_terminal () const { return flags () & IsTerminal; }
80 bool is_connected () const { return _connections.size () != 0; }
81 bool is_connected (const AlsaPort *port) const;
82 bool is_physically_connected () const;
84 const std::vector<AlsaPort *>& get_connections () const { return _connections; }
86 int connect (AlsaPort *port);
87 int disconnect (AlsaPort *port);
88 void disconnect_all ();
90 virtual void* get_buffer (pframes_t nframes) = 0;
92 const LatencyRange latency_range (bool for_playback) const
94 return for_playback ? _playback_latency_range : _capture_latency_range;
97 void set_latency_range (const LatencyRange &latency_range, bool for_playback)
101 _playback_latency_range = latency_range;
105 _capture_latency_range = latency_range;
110 AlsaAudioBackend &_alsa_backend;
112 const PortFlags _flags;
113 LatencyRange _capture_latency_range;
114 LatencyRange _playback_latency_range;
115 std::vector<AlsaPort*> _connections;
117 void _connect (AlsaPort* , bool);
118 void _disconnect (AlsaPort* , bool);
122 class AlsaAudioPort : public AlsaPort {
124 AlsaAudioPort (AlsaAudioBackend &b, const std::string&, PortFlags);
127 DataType type () const { return DataType::AUDIO; };
129 Sample* buffer () { return _buffer; }
130 const Sample* const_buffer () const { return _buffer; }
131 void* get_buffer (pframes_t nframes);
134 Sample _buffer[8192];
135 }; // class AlsaAudioPort
137 class AlsaMidiPort : public AlsaPort {
139 AlsaMidiPort (AlsaAudioBackend &b, const std::string&, PortFlags);
142 DataType type () const { return DataType::MIDI; };
144 void* get_buffer (pframes_t nframes);
145 const AlsaMidiBuffer * const_buffer () const { return & _buffer[_bufperiod]; }
147 void next_period() { if (_n_periods > 1) { get_buffer(0); _bufperiod = (_bufperiod + 1) % _n_periods; } }
148 void set_n_periods(int n) { if (n > 0 && n < 3) { _n_periods = n; } }
151 AlsaMidiBuffer _buffer[2];
154 }; // class AlsaMidiPort
156 class AlsaAudioBackend : public AudioBackend {
157 friend class AlsaPort;
159 AlsaAudioBackend (AudioEngine& e, AudioBackendInfo& info);
160 ~AlsaAudioBackend ();
162 /* AUDIOBACKEND API */
164 std::string name () const;
165 bool is_realtime () const;
167 std::vector<DeviceStatus> enumerate_devices () const;
168 std::vector<float> available_sample_rates (const std::string& device) const;
169 std::vector<uint32_t> available_buffer_sizes (const std::string& device) const;
170 uint32_t available_input_channel_count (const std::string& device) const;
171 uint32_t available_output_channel_count (const std::string& device) const;
173 bool can_change_sample_rate_when_running () const;
174 bool can_change_buffer_size_when_running () const;
176 int set_device_name (const std::string&);
177 int set_sample_rate (float);
178 int set_buffer_size (uint32_t);
179 int set_interleaved (bool yn);
180 int set_input_channels (uint32_t);
181 int set_output_channels (uint32_t);
182 int set_systemic_input_latency (uint32_t);
183 int set_systemic_output_latency (uint32_t);
184 int set_systemic_midi_input_latency (std::string const, uint32_t);
185 int set_systemic_midi_output_latency (std::string const, uint32_t);
187 int reset_device () { return 0; };
189 /* Retrieving parameters */
190 std::string device_name () const;
191 float sample_rate () const;
192 uint32_t buffer_size () const;
193 bool interleaved () const;
194 uint32_t input_channels () const;
195 uint32_t output_channels () const;
196 uint32_t systemic_input_latency () const;
197 uint32_t systemic_output_latency () const;
198 uint32_t systemic_midi_input_latency (std::string const) const;
199 uint32_t systemic_midi_output_latency (std::string const) const;
201 bool can_set_systemic_midi_latencies () const { return true; }
203 /* External control app */
204 std::string control_app_name () const { return std::string (); }
205 void launch_control_app () {}
208 std::vector<std::string> enumerate_midi_options () const;
209 int set_midi_option (const std::string&);
210 std::string midi_option () const;
212 std::vector<DeviceStatus> enumerate_midi_devices () const;
213 int set_midi_device_enabled (std::string const, bool);
214 bool midi_device_enabled (std::string const) const;
218 int _start (bool for_latency_measurement);
221 int freewheel (bool);
222 float dsp_load () const;
223 size_t raw_buffer_size (DataType t);
226 framepos_t sample_time ();
227 framepos_t sample_time_at_cycle_start ();
228 pframes_t samples_since_cycle_start ();
230 int create_process_thread (boost::function<void()> func);
231 int join_process_threads ();
232 bool in_process_thread ();
233 uint32_t process_thread_count ();
235 void update_latencies ();
239 void* private_handle () const;
240 const std::string& my_name () const;
241 bool available () const;
242 uint32_t port_name_size () const;
244 int set_port_name (PortHandle, const std::string&);
245 std::string get_port_name (PortHandle) const;
246 PortHandle get_port_by_name (const std::string&) const;
248 int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&) const;
250 DataType port_data_type (PortHandle) const;
252 PortHandle register_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
253 void unregister_port (PortHandle);
255 int connect (const std::string& src, const std::string& dst);
256 int disconnect (const std::string& src, const std::string& dst);
257 int connect (PortHandle, const std::string&);
258 int disconnect (PortHandle, const std::string&);
259 int disconnect_all (PortHandle);
261 bool connected (PortHandle, bool process_callback_safe);
262 bool connected_to (PortHandle, const std::string&, bool process_callback_safe);
263 bool physically_connected (PortHandle, bool process_callback_safe);
264 int get_connections (PortHandle, std::vector<std::string>&, bool process_callback_safe);
267 int midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index);
268 int midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
269 uint32_t get_midi_event_count (void* port_buffer);
270 void midi_clear (void* port_buffer);
274 bool can_monitor_input () const;
275 int request_input_monitoring (PortHandle, bool);
276 int ensure_input_monitoring (PortHandle, bool);
277 bool monitoring_input (PortHandle);
279 /* Latency management */
281 void set_latency_range (PortHandle, bool for_playback, LatencyRange);
282 LatencyRange get_latency_range (PortHandle, bool for_playback);
284 /* Discovering physical ports */
286 bool port_is_physical (PortHandle) const;
287 void get_physical_outputs (DataType type, std::vector<std::string>&);
288 void get_physical_inputs (DataType type, std::vector<std::string>&);
289 ChanCount n_physical_outputs () const;
290 ChanCount n_physical_inputs () const;
292 /* Getting access to the data buffer for a port */
294 void* get_buffer (PortHandle, pframes_t);
296 void* main_process_thread ();
299 std::string _instance_name;
302 bool _run; /* keep going or stop, ardour thread */
303 bool _active; /* is running, process thread */
306 bool _measure_latency;
308 uint64_t _last_process_start;
310 static std::vector<std::string> _midi_options;
311 static std::vector<AudioBackend::DeviceStatus> _audio_device_status;
312 static std::vector<AudioBackend::DeviceStatus> _midi_device_status;
314 mutable std::string _audio_device;
315 std::string _midi_driver_option;
317 /* audio device reservation */
318 ARDOUR::SystemExec *_device_reservation;
319 PBD::ScopedConnectionList _reservation_connection;
320 void reservation_stdout (std::string, size_t);
321 bool acquire_device(const char* device_name);
322 void release_device();
323 bool _reservation_succeeded;
327 size_t _samples_per_period;
328 size_t _periods_per_cycle;
329 static size_t _max_buffer_size;
334 uint32_t _systemic_audio_input_latency;
335 uint32_t _systemic_audio_output_latency;
338 struct AlsaMidiDeviceInfo {
340 uint32_t systemic_input_latency;
341 uint32_t systemic_output_latency;
344 , systemic_input_latency (0)
345 , systemic_output_latency (0)
349 mutable std::map<std::string, struct AlsaMidiDeviceInfo *> _midi_devices;
350 struct AlsaMidiDeviceInfo * midi_device_info(std::string const) const;
354 framecnt_t _processed_samples;
355 pthread_t _main_thread;
357 /* process threads */
358 static void* alsa_process_thread (void *);
359 std::vector<pthread_t> _threads;
362 AlsaAudioBackend* engine;
363 boost::function<void ()> f;
366 ThreadData (AlsaAudioBackend* e, boost::function<void ()> fp, size_t stacksz)
367 : engine (e) , f (fp) , stacksize (stacksz) {}
371 PortHandle add_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
372 int register_system_audio_ports ();
373 int register_system_midi_ports ();
374 void unregister_ports (bool system_only = false);
376 std::vector<AlsaPort *> _ports;
377 std::vector<AlsaPort *> _system_inputs;
378 std::vector<AlsaPort *> _system_outputs;
379 std::vector<AlsaPort *> _system_midi_in;
380 std::vector<AlsaPort *> _system_midi_out;
382 std::vector<AlsaMidiOut *> _rmidi_out;
383 std::vector<AlsaMidiIn *> _rmidi_in;
385 struct PortConnectData {
390 PortConnectData (const std::string& a, const std::string& b, bool c)
391 : a (a) , b (b) , c (c) {}
394 std::vector<PortConnectData *> _port_connection_queue;
395 pthread_mutex_t _port_callback_mutex;
396 bool _port_change_flag;
398 void port_connect_callback (const std::string& a, const std::string& b, bool conn) {
399 pthread_mutex_lock (&_port_callback_mutex);
400 _port_connection_queue.push_back(new PortConnectData(a, b, conn));
401 pthread_mutex_unlock (&_port_callback_mutex);
404 void port_connect_add_remove_callback () {
405 pthread_mutex_lock (&_port_callback_mutex);
406 _port_change_flag = true;
407 pthread_mutex_unlock (&_port_callback_mutex);
410 bool valid_port (PortHandle port) const {
411 return std::find (_ports.begin (), _ports.end (), (AlsaPort*)port) != _ports.end ();
414 AlsaPort * find_port (const std::string& port_name) const {
415 for (std::vector<AlsaPort*>::const_iterator it = _ports.begin (); it != _ports.end (); ++it) {
416 if ((*it)->name () == port_name) {
423 }; // class AlsaAudioBackend
427 #endif /* __libbackend_alsa_audiobackend_h__ */