2 * Copyright (C) 2014-2015 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_portaudio_backend_h__
21 #define __libbackend_portaudio_backend_h__
30 #include <boost/shared_ptr.hpp>
32 #include "ardour/audio_backend.h"
33 #include "ardour/types.h"
35 #include "portaudio_io.h"
39 class PortAudioBackend;
43 PortMidiEvent (const pframes_t timestamp, const uint8_t* data, size_t size);
44 PortMidiEvent (const PortMidiEvent& other);
46 size_t size () const { return _size; };
47 pframes_t timestamp () const { return _timestamp; };
48 const unsigned char* const_data () const { return _data; };
49 unsigned char* data () { return _data; };
50 bool operator< (const PortMidiEvent &other) const { return timestamp () < other.timestamp (); };
57 typedef std::vector<boost::shared_ptr<PortMidiEvent> > PortMidiBuffer;
59 class PamPort { // PortAudio / PortMidi Backend Port
61 PamPort (PortAudioBackend &b, const std::string&, PortFlags);
65 const std::string& name () const { return _name; }
66 PortFlags flags () const { return _flags; }
68 int set_name (const std::string &name) { _name = name; return 0; }
70 virtual DataType type () const = 0;
72 bool is_input () const { return flags () & IsInput; }
73 bool is_output () const { return flags () & IsOutput; }
74 bool is_physical () const { return flags () & IsPhysical; }
75 bool is_terminal () const { return flags () & IsTerminal; }
76 bool is_connected () const { return _connections.size () != 0; }
77 bool is_connected (const PamPort *port) const;
78 bool is_physically_connected () const;
80 const std::vector<PamPort *>& get_connections () const { return _connections; }
82 int connect (PamPort *port);
83 int disconnect (PamPort *port);
84 void disconnect_all ();
86 virtual void* get_buffer (pframes_t nframes) = 0;
88 const LatencyRange latency_range (bool for_playback) const
90 return for_playback ? _playback_latency_range : _capture_latency_range;
93 void set_latency_range (const LatencyRange &latency_range, bool for_playback)
97 _playback_latency_range = latency_range;
101 _capture_latency_range = latency_range;
106 PortAudioBackend &_osx_backend;
108 const PortFlags _flags;
109 LatencyRange _capture_latency_range;
110 LatencyRange _playback_latency_range;
111 std::vector<PamPort*> _connections;
113 void _connect (PamPort* , bool);
114 void _disconnect (PamPort* , bool);
118 class PortAudioPort : public PamPort {
120 PortAudioPort (PortAudioBackend &b, const std::string&, PortFlags);
123 DataType type () const { return DataType::AUDIO; };
125 Sample* buffer () { return _buffer; }
126 const Sample* const_buffer () const { return _buffer; }
127 void* get_buffer (pframes_t nframes);
130 Sample _buffer[8192];
131 }; // class PortAudioPort
133 class PortMidiPort : public PamPort {
135 PortMidiPort (PortAudioBackend &b, const std::string&, PortFlags);
138 DataType type () const { return DataType::MIDI; };
140 void* get_buffer (pframes_t nframes);
141 const PortMidiBuffer * const_buffer () const { return & _buffer[_bufperiod]; }
143 void next_period() { if (_n_periods > 1) { get_buffer(0); _bufperiod = (_bufperiod + 1) % _n_periods; } }
144 void set_n_periods(int n) { if (n > 0 && n < 3) { _n_periods = n; } }
147 PortMidiBuffer _buffer[2];
150 }; // class PortMidiPort
152 class PortAudioBackend : public AudioBackend {
153 friend class PamPort;
155 PortAudioBackend (AudioEngine& e, AudioBackendInfo& info);
156 ~PortAudioBackend ();
158 /* AUDIOBACKEND API */
160 std::string name () const;
161 bool is_realtime () const;
163 bool requires_driver_selection() const;
164 std::vector<std::string> enumerate_drivers () const;
165 int set_driver (const std::string&);
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) { return 0; }
185 int set_systemic_midi_output_latency (std::string const, uint32_t) { return 0; }
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 { return 0; }
199 uint32_t systemic_midi_output_latency (std::string const) const { return 0; }
201 bool can_set_systemic_midi_latencies () const { return false; }
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 return std::vector<AudioBackend::DeviceStatus> ();
215 int set_midi_device_enabled (std::string const, bool) {
218 bool midi_device_enabled (std::string const) const {
224 int _start (bool for_latency_measurement);
227 int freewheel (bool);
228 float dsp_load () const;
229 size_t raw_buffer_size (DataType t);
232 framepos_t sample_time ();
233 framepos_t sample_time_at_cycle_start ();
234 pframes_t samples_since_cycle_start ();
236 int create_process_thread (boost::function<void()> func);
237 int join_process_threads ();
238 bool in_process_thread ();
239 uint32_t process_thread_count ();
241 void update_latencies ();
245 void* private_handle () const;
246 const std::string& my_name () const;
247 bool available () const;
248 uint32_t port_name_size () const;
250 int set_port_name (PortHandle, const std::string&);
251 std::string get_port_name (PortHandle) const;
252 PortHandle get_port_by_name (const std::string&) const;
254 int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&) const;
256 DataType port_data_type (PortHandle) const;
258 PortHandle register_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
259 void unregister_port (PortHandle);
261 int connect (const std::string& src, const std::string& dst);
262 int disconnect (const std::string& src, const std::string& dst);
263 int connect (PortHandle, const std::string&);
264 int disconnect (PortHandle, const std::string&);
265 int disconnect_all (PortHandle);
267 bool connected (PortHandle, bool process_callback_safe);
268 bool connected_to (PortHandle, const std::string&, bool process_callback_safe);
269 bool physically_connected (PortHandle, bool process_callback_safe);
270 int get_connections (PortHandle, std::vector<std::string>&, bool process_callback_safe);
273 int midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index);
274 int midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
275 uint32_t get_midi_event_count (void* port_buffer);
276 void midi_clear (void* port_buffer);
280 bool can_monitor_input () const;
281 int request_input_monitoring (PortHandle, bool);
282 int ensure_input_monitoring (PortHandle, bool);
283 bool monitoring_input (PortHandle);
285 /* Latency management */
287 void set_latency_range (PortHandle, bool for_playback, LatencyRange);
288 LatencyRange get_latency_range (PortHandle, bool for_playback);
290 /* Discovering physical ports */
292 bool port_is_physical (PortHandle) const;
293 void get_physical_outputs (DataType type, std::vector<std::string>&);
294 void get_physical_inputs (DataType type, std::vector<std::string>&);
295 ChanCount n_physical_outputs () const;
296 ChanCount n_physical_inputs () const;
298 /* Getting access to the data buffer for a port */
300 void* get_buffer (PortHandle, pframes_t);
302 void* main_process_thread ();
305 std::string _instance_name;
308 bool _run; /* keep going or stop, ardour thread */
309 bool _active; /* is running, process thread */
312 bool _measure_latency;
314 uint64_t _last_process_start;
316 static std::vector<std::string> _midi_options;
317 static std::vector<AudioBackend::DeviceStatus> _audio_device_status;
318 static std::vector<AudioBackend::DeviceStatus> _midi_device_status;
320 std::string _target_driver;
321 mutable std::string _audio_device;
322 std::string _midi_driver_option;
326 size_t _samples_per_period;
327 static size_t _max_buffer_size;
332 uint32_t _systemic_audio_input_latency;
333 uint32_t _systemic_audio_output_latency;
335 /* portaudio specific */
336 int name_to_id(std::string) const;
340 framecnt_t _processed_samples;
341 pthread_t _main_thread;
343 /* process threads */
344 static void* portaudio_process_thread (void *);
345 std::vector<pthread_t> _threads;
348 PortAudioBackend* engine;
349 boost::function<void ()> f;
352 ThreadData (PortAudioBackend* e, boost::function<void ()> fp, size_t stacksz)
353 : engine (e) , f (fp) , stacksize (stacksz) {}
357 PortHandle add_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
358 int register_system_audio_ports ();
359 void unregister_ports (bool system_only = false);
361 std::vector<PamPort *> _ports;
362 std::vector<PamPort *> _system_inputs;
363 std::vector<PamPort *> _system_outputs;
364 std::vector<PamPort *> _system_midi_in;
365 std::vector<PamPort *> _system_midi_out;
367 struct PortConnectData {
372 PortConnectData (const std::string& a, const std::string& b, bool c)
373 : a (a) , b (b) , c (c) {}
376 std::vector<PortConnectData *> _port_connection_queue;
377 pthread_mutex_t _port_callback_mutex;
378 bool _port_change_flag;
380 void port_connect_callback (const std::string& a, const std::string& b, bool conn) {
381 pthread_mutex_lock (&_port_callback_mutex);
382 _port_connection_queue.push_back(new PortConnectData(a, b, conn));
383 pthread_mutex_unlock (&_port_callback_mutex);
386 void port_connect_add_remove_callback () {
387 pthread_mutex_lock (&_port_callback_mutex);
388 _port_change_flag = true;
389 pthread_mutex_unlock (&_port_callback_mutex);
392 bool valid_port (PortHandle port) const {
393 return std::find (_ports.begin (), _ports.end (), (PamPort*)port) != _ports.end ();
396 PamPort * find_port (const std::string& port_name) const {
397 for (std::vector<PamPort*>::const_iterator it = _ports.begin (); it != _ports.end (); ++it) {
398 if ((*it)->name () == port_name) {
405 PamPort * find_port_in (std::vector<PamPort *> plist, const std::string& port_name) const {
406 for (std::vector<PamPort*>::const_iterator it = plist.begin (); it != plist.end (); ++it) {
407 if ((*it)->name () == port_name) {
414 }; // class PortAudioBackend
418 #endif /* __libbackend_portaudio_backend_h__ */