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/dsp_load_calculator.h"
34 #include "ardour/types.h"
36 #include "portaudio_io.h"
37 #include "winmmemidi_io.h"
38 #include "cycle_timer.h"
42 class PortAudioBackend;
46 PortMidiEvent (const pframes_t timestamp, const uint8_t* data, size_t size);
47 PortMidiEvent (const PortMidiEvent& other);
49 size_t size () const { return _size; };
50 pframes_t timestamp () const { return _timestamp; };
51 const unsigned char* const_data () const { return _data; };
52 unsigned char* data () { return _data; };
53 bool operator< (const PortMidiEvent &other) const { return timestamp () < other.timestamp (); };
60 typedef std::vector<boost::shared_ptr<PortMidiEvent> > PortMidiBuffer;
62 class PamPort { // PortAudio / PortMidi Backend Port
64 PamPort (PortAudioBackend &b, const std::string&, PortFlags);
68 const std::string& name () const { return _name; }
69 const std::string& pretty_name () const { return _pretty_name; }
70 PortFlags flags () const { return _flags; }
72 int set_name (const std::string &name) { _name = name; return 0; }
73 int set_pretty_name (const std::string& name) { _pretty_name = name; return 0;}
75 virtual DataType type () const = 0;
77 bool is_input () const { return flags () & IsInput; }
78 bool is_output () const { return flags () & IsOutput; }
79 bool is_physical () const { return flags () & IsPhysical; }
80 bool is_terminal () const { return flags () & IsTerminal; }
81 bool is_connected () const { return _connections.size () != 0; }
82 bool is_connected (const PamPort *port) const;
83 bool is_physically_connected () const;
85 const std::vector<PamPort *>& get_connections () const { return _connections; }
87 int connect (PamPort *port);
88 int disconnect (PamPort *port);
89 void disconnect_all ();
91 virtual void* get_buffer (pframes_t nframes) = 0;
93 const LatencyRange latency_range (bool for_playback) const
95 return for_playback ? _playback_latency_range : _capture_latency_range;
98 void set_latency_range (const LatencyRange &latency_range, bool for_playback)
102 _playback_latency_range = latency_range;
106 _capture_latency_range = latency_range;
111 PortAudioBackend &_osx_backend;
113 std::string _pretty_name;
114 const PortFlags _flags;
115 LatencyRange _capture_latency_range;
116 LatencyRange _playback_latency_range;
117 std::vector<PamPort*> _connections;
119 void _connect (PamPort* , bool);
120 void _disconnect (PamPort* , bool);
124 class PortAudioPort : public PamPort {
126 PortAudioPort (PortAudioBackend &b, const std::string&, PortFlags);
129 DataType type () const { return DataType::AUDIO; };
131 Sample* buffer () { return _buffer; }
132 const Sample* const_buffer () const { return _buffer; }
133 void* get_buffer (pframes_t nframes);
136 Sample _buffer[8192];
137 }; // class PortAudioPort
139 class PortMidiPort : public PamPort {
141 PortMidiPort (PortAudioBackend &b, const std::string&, PortFlags);
144 DataType type () const { return DataType::MIDI; };
146 void* get_buffer (pframes_t nframes);
147 const PortMidiBuffer * const_buffer () const { return & _buffer[_bufperiod]; }
149 void next_period() { if (_n_periods > 1) { get_buffer(0); _bufperiod = (_bufperiod + 1) % _n_periods; } }
150 void set_n_periods(int n) { if (n > 0 && n < 3) { _n_periods = n; } }
153 PortMidiBuffer _buffer[2];
156 }; // class PortMidiPort
158 class PortAudioBackend : public AudioBackend {
159 friend class PamPort;
161 PortAudioBackend (AudioEngine& e, AudioBackendInfo& info);
162 ~PortAudioBackend ();
164 /* AUDIOBACKEND API */
166 std::string name () const;
167 bool is_realtime () const;
169 bool requires_driver_selection() const;
170 std::string driver_name () const;
171 std::vector<std::string> enumerate_drivers () const;
172 int set_driver (const std::string&);
174 bool can_request_update_devices () { return true; }
175 bool update_devices ();
177 bool can_use_buffered_io () { return true; }
178 void set_use_buffered_io (bool);
179 bool get_use_buffered_io () { return _use_blocking_api; }
181 bool use_separate_input_and_output_devices () const;
182 std::vector<DeviceStatus> enumerate_devices () const;
183 std::vector<DeviceStatus> enumerate_input_devices () const;
184 std::vector<DeviceStatus> enumerate_output_devices () const;
186 std::vector<float> available_sample_rates (const std::string& device) const;
187 std::vector<uint32_t> available_buffer_sizes (const std::string& device) const;
188 uint32_t available_input_channel_count (const std::string& device) const;
189 uint32_t available_output_channel_count (const std::string& device) const;
191 bool can_change_sample_rate_when_running () const;
192 bool can_change_buffer_size_when_running () const;
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_interleaved (bool yn);
200 int set_input_channels (uint32_t);
201 int set_output_channels (uint32_t);
202 int set_systemic_input_latency (uint32_t);
203 int set_systemic_output_latency (uint32_t);
204 int set_systemic_midi_input_latency (std::string const, uint32_t);
205 int set_systemic_midi_output_latency (std::string const, uint32_t);
207 int reset_device () { return 0; };
209 /* Retrieving parameters */
210 std::string device_name () const;
211 std::string input_device_name () const;
212 std::string output_device_name () const;
213 float sample_rate () const;
214 uint32_t buffer_size () const;
215 bool interleaved () const;
216 uint32_t input_channels () const;
217 uint32_t output_channels () const;
218 uint32_t systemic_input_latency () const;
219 uint32_t systemic_output_latency () const;
220 uint32_t systemic_midi_input_latency (std::string const) const;
221 uint32_t systemic_midi_output_latency (std::string const) const;
223 bool can_set_systemic_midi_latencies () const { return true; }
225 /* External control app */
226 std::string control_app_name () const;
227 void launch_control_app ();
230 std::vector<std::string> enumerate_midi_options () const;
231 int set_midi_option (const std::string&);
232 std::string midi_option () const;
234 std::vector<DeviceStatus> enumerate_midi_devices () const;
235 int set_midi_device_enabled (std::string const, bool);
236 bool midi_device_enabled (std::string const) const;
240 int _start (bool for_latency_measurement);
243 int freewheel (bool);
244 float dsp_load () const;
245 size_t raw_buffer_size (DataType t);
248 framepos_t sample_time ();
249 framepos_t sample_time_at_cycle_start ();
250 pframes_t samples_since_cycle_start ();
252 int create_process_thread (boost::function<void()> func);
253 int join_process_threads ();
254 bool in_process_thread ();
255 uint32_t process_thread_count ();
257 void update_latencies ();
261 void* private_handle () const;
262 const std::string& my_name () const;
263 bool available () const;
264 uint32_t port_name_size () const;
266 int set_port_name (PortHandle, const std::string&);
267 std::string get_port_name (PortHandle) const;
268 PortHandle get_port_by_name (const std::string&) const;
269 int get_port_property (PortHandle, const std::string& key, std::string& value, std::string& type) const;
270 int set_port_property (PortHandle, const std::string& key, const std::string& value, const std::string& type);
272 int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&) const;
274 DataType port_data_type (PortHandle) const;
276 PortHandle register_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
277 void unregister_port (PortHandle);
279 int connect (const std::string& src, const std::string& dst);
280 int disconnect (const std::string& src, const std::string& dst);
281 int connect (PortHandle, const std::string&);
282 int disconnect (PortHandle, const std::string&);
283 int disconnect_all (PortHandle);
285 bool connected (PortHandle, bool process_callback_safe);
286 bool connected_to (PortHandle, const std::string&, bool process_callback_safe);
287 bool physically_connected (PortHandle, bool process_callback_safe);
288 int get_connections (PortHandle, std::vector<std::string>&, bool process_callback_safe);
291 int midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index);
292 int midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
293 uint32_t get_midi_event_count (void* port_buffer);
294 void midi_clear (void* port_buffer);
298 bool can_monitor_input () const;
299 int request_input_monitoring (PortHandle, bool);
300 int ensure_input_monitoring (PortHandle, bool);
301 bool monitoring_input (PortHandle);
303 /* Latency management */
305 void set_latency_range (PortHandle, bool for_playback, LatencyRange);
306 LatencyRange get_latency_range (PortHandle, bool for_playback);
308 /* Discovering physical ports */
310 bool port_is_physical (PortHandle) const;
311 void get_physical_outputs (DataType type, std::vector<std::string>&);
312 void get_physical_inputs (DataType type, std::vector<std::string>&);
313 ChanCount n_physical_outputs () const;
314 ChanCount n_physical_inputs () const;
316 /* Getting access to the data buffer for a port */
318 void* get_buffer (PortHandle, pframes_t);
320 void* blocking_process_thread ();
322 void* freewheel_process_thread ();
325 bool start_blocking_process_thread ();
326 bool stop_blocking_process_thread ();
327 bool blocking_process_freewheel ();
328 bool blocking_process_main (const float* interleaved_input_data,
329 float* interleaved_output_data);
331 void process_port_connection_changes ();
332 void process_incoming_midi ();
333 void process_outgoing_midi ();
335 bool engine_halted ();
338 static int portaudio_callback(const void* input,
340 unsigned long frameCount,
341 const PaStreamCallbackTimeInfo* timeInfo,
342 PaStreamCallbackFlags statusFlags,
345 bool process_callback(const float* input,
347 uint32_t frame_count,
348 const PaStreamCallbackTimeInfo* timeInfo,
349 PaStreamCallbackFlags statusFlags);
351 bool start_freewheel_process_thread ();
352 bool stop_freewheel_process_thread ();
354 static bool set_mmcss_pro_audio (HANDLE* task_handle);
355 static bool reset_mmcss (HANDLE task_handle);
358 std::string _instance_name;
360 WinMMEMidiIO *_midiio;
362 bool _run; /* keep going or stop, ardour thread */
363 bool _active; /* is running, process thread */
364 bool _use_blocking_api;
368 bool _reinit_thread_callback;
369 bool _measure_latency;
371 ARDOUR::DSPLoadCalculator _dsp_calc;
373 bool _freewheel_thread_active;
375 pthread_mutex_t _freewheel_mutex;
376 pthread_cond_t _freewheel_signal;
378 uint64_t _cycle_count;
379 uint64_t _total_deviation_us;
380 uint64_t _max_deviation_us;
382 CycleTimer _cycle_timer;
383 uint64_t _last_cycle_start;
385 static std::vector<std::string> _midi_options;
386 static std::vector<AudioBackend::DeviceStatus> _input_audio_device_status;
387 static std::vector<AudioBackend::DeviceStatus> _output_audio_device_status;
388 static std::vector<AudioBackend::DeviceStatus> _midi_device_status;
390 mutable std::string _input_audio_device;
391 mutable std::string _output_audio_device;
392 std::string _midi_driver_option;
396 size_t _samples_per_period;
397 static size_t _max_buffer_size;
402 uint32_t _systemic_audio_input_latency;
403 uint32_t _systemic_audio_output_latency;
405 MidiDeviceInfo* midi_device_info(const std::string&) const;
407 /* portaudio specific */
408 int name_to_id(std::string) const;
412 framecnt_t _processed_samples;
414 /* blocking thread */
415 pthread_t _main_blocking_thread;
417 /* main thread in callback mode(or fw thread when running) */
418 pthread_t _main_thread;
420 /* freewheel thread in callback mode */
421 pthread_t _pthread_freewheel;
423 /* process threads */
424 static void* portaudio_process_thread (void *);
425 std::vector<pthread_t> _threads;
428 PortAudioBackend* engine;
429 boost::function<void ()> f;
432 ThreadData (PortAudioBackend* e, boost::function<void ()> fp, size_t stacksz)
433 : engine (e) , f (fp) , stacksize (stacksz) {}
437 PortHandle add_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
438 int register_system_audio_ports ();
439 int register_system_midi_ports ();
440 void unregister_ports (bool system_only = false);
442 std::vector<PamPort *> _ports;
443 std::vector<PamPort *> _system_inputs;
444 std::vector<PamPort *> _system_outputs;
445 std::vector<PamPort *> _system_midi_in;
446 std::vector<PamPort *> _system_midi_out;
448 struct PortConnectData {
453 PortConnectData (const std::string& a, const std::string& b, bool c)
454 : a (a) , b (b) , c (c) {}
457 std::vector<PortConnectData *> _port_connection_queue;
458 pthread_mutex_t _port_callback_mutex;
459 bool _port_change_flag;
461 void port_connect_callback (const std::string& a, const std::string& b, bool conn) {
462 pthread_mutex_lock (&_port_callback_mutex);
463 _port_connection_queue.push_back(new PortConnectData(a, b, conn));
464 pthread_mutex_unlock (&_port_callback_mutex);
467 void port_connect_add_remove_callback () {
468 pthread_mutex_lock (&_port_callback_mutex);
469 _port_change_flag = true;
470 pthread_mutex_unlock (&_port_callback_mutex);
473 bool valid_port (PortHandle port) const {
474 return std::find (_ports.begin (), _ports.end (), (PamPort*)port) != _ports.end ();
477 PamPort * find_port (const std::string& port_name) const {
478 for (std::vector<PamPort*>::const_iterator it = _ports.begin (); it != _ports.end (); ++it) {
479 if ((*it)->name () == port_name) {
486 PamPort * find_port_in (std::vector<PamPort *> plist, const std::string& port_name) const {
487 for (std::vector<PamPort*>::const_iterator it = plist.begin (); it != plist.end (); ++it) {
488 if ((*it)->name () == port_name) {
495 }; // class PortAudioBackend
499 #endif /* __libbackend_portaudio_backend_h__ */