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);
48 size_t size () const { return _size; };
49 pframes_t timestamp () const { return _timestamp; };
50 const uint8_t* data () const { return _data; };
51 bool operator< (const PortMidiEvent &other) const { return timestamp () < other.timestamp (); };
55 uint8_t _data[MaxWinMidiEventSize];
58 typedef std::vector<PortMidiEvent> PortMidiBuffer;
60 class PamPort { // PortAudio / PortMidi Backend Port
62 PamPort (PortAudioBackend &b, const std::string&, PortFlags);
66 const std::string& name () const { return _name; }
67 const std::string& pretty_name () const { return _pretty_name; }
68 PortFlags flags () const { return _flags; }
70 int set_name (const std::string &name) { _name = name; return 0; }
71 int set_pretty_name (const std::string& name) { _pretty_name = name; return 0;}
73 virtual DataType type () const = 0;
75 bool is_input () const { return flags () & IsInput; }
76 bool is_output () const { return flags () & IsOutput; }
77 bool is_physical () const { return flags () & IsPhysical; }
78 bool is_terminal () const { return flags () & IsTerminal; }
79 bool is_connected () const { return _connections.size () != 0; }
80 bool is_connected (const PamPort *port) const;
81 bool is_physically_connected () const;
83 const std::vector<PamPort *>& get_connections () const { return _connections; }
85 int connect (PamPort *port);
86 int disconnect (PamPort *port);
87 void disconnect_all ();
89 virtual void* get_buffer (pframes_t nframes) = 0;
91 const LatencyRange latency_range (bool for_playback) const
93 return for_playback ? _playback_latency_range : _capture_latency_range;
96 void set_latency_range (const LatencyRange &latency_range, bool for_playback);
98 void update_connected_latency (bool for_playback);
101 PortAudioBackend &_osx_backend;
103 std::string _pretty_name;
104 const PortFlags _flags;
105 LatencyRange _capture_latency_range;
106 LatencyRange _playback_latency_range;
107 std::vector<PamPort*> _connections;
109 void _connect (PamPort* , bool);
110 void _disconnect (PamPort* , bool);
114 class PortAudioPort : public PamPort {
116 PortAudioPort (PortAudioBackend &b, const std::string&, PortFlags);
119 DataType type () const { return DataType::AUDIO; };
121 Sample* buffer () { return _buffer; }
122 const Sample* const_buffer () const { return _buffer; }
123 void* get_buffer (pframes_t nframes);
126 Sample _buffer[8192];
127 }; // class PortAudioPort
129 class PortMidiPort : public PamPort {
131 PortMidiPort (PortAudioBackend &b, const std::string&, PortFlags);
134 DataType type () const { return DataType::MIDI; };
136 void* get_buffer (pframes_t nframes);
137 const PortMidiBuffer * const_buffer () const { return & _buffer[_bufperiod]; }
139 void next_period() { if (_n_periods > 1) { get_buffer(0); _bufperiod = (_bufperiod + 1) % _n_periods; } }
140 void set_n_periods(int n) { if (n > 0 && n < 3) { _n_periods = n; } }
143 PortMidiBuffer _buffer[2];
146 }; // class PortMidiPort
148 class PortAudioBackend : public AudioBackend {
149 friend class PamPort;
151 PortAudioBackend (AudioEngine& e, AudioBackendInfo& info);
152 ~PortAudioBackend ();
154 /* AUDIOBACKEND API */
156 std::string name () const;
157 bool is_realtime () const;
159 bool requires_driver_selection() const;
160 std::string driver_name () const;
161 std::vector<std::string> enumerate_drivers () const;
162 int set_driver (const std::string&);
164 bool can_request_update_devices () { return true; }
165 bool update_devices ();
167 bool can_use_buffered_io () { return true; }
168 void set_use_buffered_io (bool);
169 bool get_use_buffered_io () { return _use_blocking_api; }
171 bool use_separate_input_and_output_devices () const;
172 std::vector<DeviceStatus> enumerate_devices () const;
173 std::vector<DeviceStatus> enumerate_input_devices () const;
174 std::vector<DeviceStatus> enumerate_output_devices () const;
176 std::vector<float> available_sample_rates (const std::string& device) const;
177 std::vector<uint32_t> available_buffer_sizes (const std::string& device) const;
178 uint32_t available_input_channel_count (const std::string& device) const;
179 uint32_t available_output_channel_count (const std::string& device) const;
181 bool can_change_sample_rate_when_running () const;
182 bool can_change_buffer_size_when_running () const;
184 int set_device_name (const std::string&);
185 int set_input_device_name (const std::string&);
186 int set_output_device_name (const std::string&);
187 int set_sample_rate (float);
188 int set_buffer_size (uint32_t);
189 int set_interleaved (bool yn);
190 int set_input_channels (uint32_t);
191 int set_output_channels (uint32_t);
192 int set_systemic_input_latency (uint32_t);
193 int set_systemic_output_latency (uint32_t);
194 int set_systemic_midi_input_latency (std::string const, uint32_t);
195 int set_systemic_midi_output_latency (std::string const, uint32_t);
197 int reset_device () { return 0; };
199 /* Retrieving parameters */
200 std::string device_name () const;
201 std::string input_device_name () const;
202 std::string output_device_name () const;
203 float sample_rate () const;
204 uint32_t buffer_size () const;
205 bool interleaved () const;
206 uint32_t input_channels () const;
207 uint32_t output_channels () const;
208 uint32_t systemic_input_latency () const;
209 uint32_t systemic_output_latency () const;
210 uint32_t systemic_midi_input_latency (std::string const) const;
211 uint32_t systemic_midi_output_latency (std::string const) const;
213 bool can_set_systemic_midi_latencies () const { return true; }
215 /* External control app */
216 std::string control_app_name () const;
217 void launch_control_app ();
220 std::vector<std::string> enumerate_midi_options () const;
221 int set_midi_option (const std::string&);
222 std::string midi_option () const;
224 std::vector<DeviceStatus> enumerate_midi_devices () const;
225 int set_midi_device_enabled (std::string const, bool);
226 bool midi_device_enabled (std::string const) const;
230 int _start (bool for_latency_measurement);
233 int freewheel (bool);
234 float dsp_load () const;
235 size_t raw_buffer_size (DataType t);
238 samplepos_t sample_time ();
239 samplepos_t sample_time_at_cycle_start ();
240 pframes_t samples_since_cycle_start ();
242 int create_process_thread (boost::function<void()> func);
243 int join_process_threads ();
244 bool in_process_thread ();
245 uint32_t process_thread_count ();
247 void update_latencies ();
251 void* private_handle () const;
252 const std::string& my_name () const;
253 bool available () const;
254 uint32_t port_name_size () const;
256 int set_port_name (PortHandle, const std::string&);
257 std::string get_port_name (PortHandle) const;
258 PortHandle get_port_by_name (const std::string&) const;
259 int get_port_property (PortHandle, const std::string& key, std::string& value, std::string& type) const;
260 int set_port_property (PortHandle, const std::string& key, const std::string& value, const std::string& type);
262 int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&) const;
264 DataType port_data_type (PortHandle) const;
266 PortHandle register_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
267 void unregister_port (PortHandle);
269 int connect (const std::string& src, const std::string& dst);
270 int disconnect (const std::string& src, const std::string& dst);
271 int connect (PortHandle, const std::string&);
272 int disconnect (PortHandle, const std::string&);
273 int disconnect_all (PortHandle);
275 bool connected (PortHandle, bool process_callback_safe);
276 bool connected_to (PortHandle, const std::string&, bool process_callback_safe);
277 bool physically_connected (PortHandle, bool process_callback_safe);
278 int get_connections (PortHandle, std::vector<std::string>&, bool process_callback_safe);
281 int midi_event_get (pframes_t& timestamp, size_t& size, uint8_t const** buf, void* port_buffer, uint32_t event_index);
282 int midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
283 uint32_t get_midi_event_count (void* port_buffer);
284 void midi_clear (void* port_buffer);
288 bool can_monitor_input () const;
289 int request_input_monitoring (PortHandle, bool);
290 int ensure_input_monitoring (PortHandle, bool);
291 bool monitoring_input (PortHandle);
293 /* Latency management */
295 void set_latency_range (PortHandle, bool for_playback, LatencyRange);
296 LatencyRange get_latency_range (PortHandle, bool for_playback);
298 /* Discovering physical ports */
300 bool port_is_physical (PortHandle) const;
301 void get_physical_outputs (DataType type, std::vector<std::string>&);
302 void get_physical_inputs (DataType type, std::vector<std::string>&);
303 ChanCount n_physical_outputs () const;
304 ChanCount n_physical_inputs () const;
306 /* Getting access to the data buffer for a port */
308 void* get_buffer (PortHandle, pframes_t);
310 void* blocking_process_thread ();
312 void* freewheel_process_thread ();
315 bool start_blocking_process_thread ();
316 bool stop_blocking_process_thread ();
317 bool blocking_process_freewheel ();
318 bool blocking_process_main (const float* interleaved_input_data,
319 float* interleaved_output_data);
321 void process_port_connection_changes ();
322 void process_incoming_midi ();
323 void process_outgoing_midi ();
325 bool engine_halted ();
328 static int portaudio_callback(const void* input,
330 unsigned long frameCount,
331 const PaStreamCallbackTimeInfo* timeInfo,
332 PaStreamCallbackFlags statusFlags,
335 bool process_callback(const float* input,
337 uint32_t sample_count,
338 const PaStreamCallbackTimeInfo* timeInfo,
339 PaStreamCallbackFlags statusFlags);
341 bool start_freewheel_process_thread ();
342 bool stop_freewheel_process_thread ();
344 static bool set_mmcss_pro_audio (HANDLE* task_handle);
345 static bool reset_mmcss (HANDLE task_handle);
348 std::string _instance_name;
350 WinMMEMidiIO *_midiio;
352 bool _run; /* keep going or stop, ardour thread */
353 bool _active; /* is running, process thread */
354 bool _use_blocking_api;
358 bool _reinit_thread_callback;
359 bool _measure_latency;
361 ARDOUR::DSPLoadCalculator _dsp_calc;
363 bool _freewheel_thread_active;
365 pthread_mutex_t _freewheel_mutex;
366 pthread_cond_t _freewheel_signal;
368 uint64_t _cycle_count;
369 uint64_t _total_deviation_us;
370 uint64_t _max_deviation_us;
372 CycleTimer _cycle_timer;
373 uint64_t _last_cycle_start;
375 static std::vector<std::string> _midi_options;
376 static std::vector<AudioBackend::DeviceStatus> _input_audio_device_status;
377 static std::vector<AudioBackend::DeviceStatus> _output_audio_device_status;
378 static std::vector<AudioBackend::DeviceStatus> _midi_device_status;
380 mutable std::string _input_audio_device;
381 mutable std::string _output_audio_device;
382 std::string _midi_driver_option;
386 size_t _samples_per_period;
387 static size_t _max_buffer_size;
392 uint32_t _systemic_audio_input_latency;
393 uint32_t _systemic_audio_output_latency;
395 MidiDeviceInfo* midi_device_info(const std::string&) const;
397 /* portaudio specific */
398 int name_to_id(std::string) const;
402 samplecnt_t _processed_samples;
404 /* blocking thread */
405 pthread_t _main_blocking_thread;
407 /* main thread in callback mode(or fw thread when running) */
408 pthread_t _main_thread;
410 /* freewheel thread in callback mode */
411 pthread_t _pthread_freewheel;
413 /* process threads */
414 static void* portaudio_process_thread (void *);
415 std::vector<pthread_t> _threads;
418 PortAudioBackend* engine;
419 boost::function<void ()> f;
422 ThreadData (PortAudioBackend* e, boost::function<void ()> fp, size_t stacksz)
423 : engine (e) , f (fp) , stacksize (stacksz) {}
427 PortHandle add_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
428 int register_system_audio_ports ();
429 int register_system_midi_ports ();
430 void unregister_ports (bool system_only = false);
431 void update_system_port_latecies ();
433 std::vector<PamPort *> _ports;
434 std::vector<PamPort *> _system_inputs;
435 std::vector<PamPort *> _system_outputs;
436 std::vector<PamPort *> _system_midi_in;
437 std::vector<PamPort *> _system_midi_out;
439 struct PortConnectData {
444 PortConnectData (const std::string& a, const std::string& b, bool c)
445 : a (a) , b (b) , c (c) {}
448 std::vector<PortConnectData *> _port_connection_queue;
449 pthread_mutex_t _port_callback_mutex;
450 bool _port_change_flag;
452 void port_connect_callback (const std::string& a, const std::string& b, bool conn) {
453 pthread_mutex_lock (&_port_callback_mutex);
454 _port_connection_queue.push_back(new PortConnectData(a, b, conn));
455 pthread_mutex_unlock (&_port_callback_mutex);
458 void port_connect_add_remove_callback () {
459 pthread_mutex_lock (&_port_callback_mutex);
460 _port_change_flag = true;
461 pthread_mutex_unlock (&_port_callback_mutex);
464 bool valid_port (PortHandle port) const {
465 return std::find (_ports.begin (), _ports.end (), (PamPort*)port) != _ports.end ();
468 PamPort * find_port (const std::string& port_name) const {
469 for (std::vector<PamPort*>::const_iterator it = _ports.begin (); it != _ports.end (); ++it) {
470 if ((*it)->name () == port_name) {
477 PamPort * find_port_in (std::vector<PamPort *> plist, const std::string& port_name) const {
478 for (std::vector<PamPort*>::const_iterator it = plist.begin (); it != plist.end (); ++it) {
479 if ((*it)->name () == port_name) {
486 }; // class PortAudioBackend
490 #endif /* __libbackend_portaudio_backend_h__ */