2 * Copyright (C) 2015 Robin Gareus <robin@gareus.org>
3 * Copyright (C) 2015 Tim Mayberry <mojofunk@gmail.com>
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.
26 #include "portaudio_io.h"
32 #include "pbd/compose.h"
34 #include "ardour/audio_backend.h"
38 #define INTERLEAVED_INPUT
39 #define INTERLEAVED_OUTPUT
42 using namespace ARDOUR;
44 PortAudioIO::PortAudioIO ()
45 : _capture_channels (0)
46 , _playback_channels (0)
50 , _cur_sample_rate (0)
51 , _cur_input_latency (0)
52 , _cur_output_latency (0)
57 PortAudioIO::~PortAudioIO ()
62 clear_device_lists ();
64 free (_input_buffer); _input_buffer = NULL;
65 free (_output_buffer); _output_buffer = NULL;
69 PortAudioIO::control_app_name (int device_id) const
72 if (get_current_host_api_type() == paASIO) {
73 // is this used for anything, or just acts as a boolean?
74 return "PortaudioASIO";
82 PortAudioIO::launch_control_app (int device_id)
85 PaError err = PaAsio_ShowControlPanel (device_id, NULL);
87 if (err != paNoError) {
89 DEBUG_AUDIO (string_compose (
90 "Unable to show control panel for device with index %1\n", device_id));
96 PortAudioIO::get_default_sample_rates (std::vector<float>& rates)
98 rates.push_back(8000.0);
99 rates.push_back(22050.0);
100 rates.push_back(24000.0);
101 rates.push_back(44100.0);
102 rates.push_back(48000.0);
103 rates.push_back(88200.0);
104 rates.push_back(96000.0);
105 rates.push_back(176400.0);
106 rates.push_back(192000.0);
110 PortAudioIO::available_sample_rates(int device_id, std::vector<float>& sampleRates)
112 if (!pa_initialize()) return -1;
115 if (get_current_host_api_type() == paASIO) {
116 get_default_sample_rates(sampleRates);
121 // TODO use separate int device_input, int device_output ?!
122 if (device_id == DeviceDefault) {
123 device_id = get_default_input_device ();
127 string_compose ("Querying Samplerates for device %1\n", device_id));
130 const PaDeviceInfo* nfo = Pa_GetDeviceInfo(device_id);
133 PaStreamParameters inputParam;
134 PaStreamParameters outputParam;
136 inputParam.device = device_id;
137 inputParam.channelCount = nfo->maxInputChannels;
138 inputParam.sampleFormat = paFloat32;
139 inputParam.suggestedLatency = 0;
140 inputParam.hostApiSpecificStreamInfo = 0;
142 outputParam.device = device_id;
143 outputParam.channelCount = nfo->maxOutputChannels;
144 outputParam.sampleFormat = paFloat32;
145 outputParam.suggestedLatency = 0;
146 outputParam.hostApiSpecificStreamInfo = 0;
148 std::vector<float> rates;
149 get_default_sample_rates(rates);
151 for (std::vector<float>::const_iterator i = rates.begin(); i != rates.end();
153 if (paFormatIsSupported ==
154 Pa_IsFormatSupported(nfo->maxInputChannels > 0 ? &inputParam : NULL,
155 nfo->maxOutputChannels > 0 ? &outputParam : NULL,
157 sampleRates.push_back(*i);
162 if (sampleRates.empty()) {
163 // fill in something..
164 get_default_sample_rates(sampleRates);
172 PortAudioIO::get_asio_buffer_properties (int device_id,
173 long& min_size_frames,
174 long& max_size_frames,
175 long& preferred_size_frames,
178 // we shouldn't really need all these checks but it shouldn't hurt
179 const PaDeviceInfo* device_info = Pa_GetDeviceInfo(device_id);
182 DEBUG_AUDIO (string_compose (
183 "Unable to get device info from device index %1\n", device_id));
187 if (get_current_host_api_type() != paASIO) {
188 DEBUG_AUDIO (string_compose (
189 "ERROR device_id %1 is not an ASIO device\n", device_id));
193 PaError err = PaAsio_GetAvailableBufferSizes (device_id,
196 &preferred_size_frames,
199 if (err != paNoError) {
200 DEBUG_AUDIO (string_compose (
201 "Unable to determine available buffer sizes for device %1\n", device_id));
209 is_power_of_two (uint32_t v)
211 return ((v != 0) && !(v & (v - 1)));
215 PortAudioIO::get_asio_buffer_sizes(int device_id,
216 std::vector<uint32_t>& buffer_sizes,
219 long min_size_frames = 0;
220 long max_size_frames = 0;
221 long preferred_size_frames = 0;
222 long granularity = 0;
224 if (!get_asio_buffer_properties (device_id,
227 preferred_size_frames,
229 DEBUG_AUDIO (string_compose (
230 "Unable to get device buffer properties from device index %1\n", device_id));
234 DEBUG_AUDIO (string_compose ("ASIO buffer properties for device %1, "
235 "min_size_frames: %2, max_size_frames: %3, "
236 "preferred_size_frames: %4, granularity: %5\n",
240 preferred_size_frames,
243 bool driver_returns_one_size = (min_size_frames == max_size_frames) &&
244 (min_size_frames == preferred_size_frames);
246 if (preferred_only || driver_returns_one_size) {
247 buffer_sizes.push_back(preferred_size_frames);
251 long buffer_size = min_size_frames;
253 // If min size and granularity are power of two then just use values that
254 // are power of 2 even if the granularity allows for more values
255 bool use_power_of_two =
256 is_power_of_two(min_size_frames) && is_power_of_two(granularity);
258 if (granularity <= 0 || use_power_of_two) {
259 // driver uses buffer sizes that are power of 2
260 while (buffer_size <= max_size_frames) {
261 buffer_sizes.push_back(buffer_size);
265 if (min_size_frames == max_size_frames) {
266 // The devices I have tested either return the same values for
267 // min/max/preferred and changing buffer size is intended to only be
268 // done via the control dialog or they return a range where min != max
269 // but I guess min == max could happen if a driver only supports a single
271 buffer_sizes.push_back(min_size_frames);
275 // If min_size_frames is not power of 2 use at most 8 of the possible
276 // buffer sizes spread evenly between min and max
278 while (((max_size_frames - min_size_frames) / granularity) > max_values) {
282 while (buffer_size < max_size_frames) {
283 buffer_sizes.push_back(buffer_size);
284 buffer_size += granularity;
286 buffer_sizes.push_back(max_size_frames);
293 PortAudioIO::get_default_buffer_sizes(std::vector<uint32_t>& buffer_sizes)
295 buffer_sizes.push_back(64);
296 buffer_sizes.push_back(128);
297 buffer_sizes.push_back(256);
298 buffer_sizes.push_back(512);
299 buffer_sizes.push_back(1024);
300 buffer_sizes.push_back(2048);
301 buffer_sizes.push_back(4096);
305 PortAudioIO::available_buffer_sizes(int device_id, std::vector<uint32_t>& buffer_sizes)
308 if (get_current_host_api_type() == paASIO) {
309 if (get_asio_buffer_sizes (device_id, buffer_sizes, false)) {
315 get_default_buffer_sizes (buffer_sizes);
321 PortAudioIO::input_device_list(std::map<int, std::string> &devices) const
323 for (std::map<int, paDevice*>::const_iterator i = _input_devices.begin ();
324 i != _input_devices.end ();
326 devices.insert (std::pair<int, std::string>(i->first, Glib::locale_to_utf8(i->second->name)));
331 PortAudioIO::output_device_list(std::map<int, std::string> &devices) const
333 for (std::map<int, paDevice*>::const_iterator i = _output_devices.begin ();
334 i != _output_devices.end ();
336 devices.insert (std::pair<int, std::string>(i->first, Glib::locale_to_utf8(i->second->name)));
341 PortAudioIO::pa_initialized()
343 static bool s_initialized = false;
344 return s_initialized;
348 PortAudioIO::pa_initialize()
350 if (pa_initialized()) return true;
352 PaError err = Pa_Initialize();
353 if (err != paNoError) {
356 pa_initialized() = true;
362 PortAudioIO::pa_deinitialize()
364 if (!pa_initialized()) return true;
366 PaError err = Pa_Terminate();
367 if (err != paNoError) {
370 pa_initialized() = false;
375 PortAudioIO::host_api_list (std::vector<std::string>& api_list)
377 if (!pa_initialize()) return;
379 PaHostApiIndex count = Pa_GetHostApiCount();
381 if (count < 0) return;
383 for (int i = 0; i < count; ++i) {
384 const PaHostApiInfo* info = Pa_GetHostApiInfo (i);
385 if (info->name != NULL) { // possible?
386 api_list.push_back (info->name);
393 PortAudioIO::get_current_host_api_type () const
395 const PaHostApiInfo* info = Pa_GetHostApiInfo (_host_api_index);
398 DEBUG_AUDIO(string_compose(
399 "Unable to determine Host API type from index %1\n", _host_api_index));
400 return (PaHostApiTypeId)0;
407 PortAudioIO::get_host_api_name_from_index (PaHostApiIndex index)
409 std::vector<std::string> api_list;
410 host_api_list(api_list);
411 return api_list[index];
415 PortAudioIO::set_host_api (const std::string& host_api_name)
417 PaHostApiIndex new_index = get_host_api_index_from_name (host_api_name);
420 DEBUG_AUDIO ("Portaudio: Error setting host API\n");
423 _host_api_index = new_index;
424 _host_api_name = host_api_name;
429 PortAudioIO::get_host_api_index_from_name (const std::string& name)
431 if (!pa_initialize()) return -1;
433 PaHostApiIndex count = Pa_GetHostApiCount();
436 DEBUG_AUDIO ("Host API count < 0\n");
440 for (int i = 0; i < count; ++i) {
441 const PaHostApiInfo* info = Pa_GetHostApiInfo (i);
442 if (info != NULL && info->name != NULL) { // possible?
443 if (name == info->name) {
448 DEBUG_AUDIO (string_compose ("Unable to get host API from name: %1\n", name));
454 PortAudioIO::get_default_input_device () const
456 const PaHostApiInfo* info = Pa_GetHostApiInfo (_host_api_index);
457 if (info == NULL) return -1;
458 return info->defaultInputDevice;
462 PortAudioIO::get_default_output_device () const
464 const PaHostApiInfo* info = Pa_GetHostApiInfo (_host_api_index);
465 if (info == NULL) return -1;
466 return info->defaultOutputDevice;
470 PortAudioIO::clear_device_lists ()
472 for (std::map<int, paDevice*>::const_iterator i = _input_devices.begin (); i != _input_devices.end(); ++i) {
475 _input_devices.clear();
477 for (std::map<int, paDevice*>::const_iterator i = _output_devices.begin (); i != _output_devices.end(); ++i) {
480 _output_devices.clear();
484 PortAudioIO::add_none_devices ()
486 _input_devices.insert(std::pair<int, paDevice*>(
487 DeviceNone, new paDevice(AudioBackend::get_standard_device_name(AudioBackend::DeviceNone), 0, 0)));
488 _output_devices.insert(std::pair<int, paDevice*>(
489 DeviceNone, new paDevice(AudioBackend::get_standard_device_name(AudioBackend::DeviceNone), 0, 0)));
493 PortAudioIO::add_default_devices ()
495 const PaHostApiInfo* info = Pa_GetHostApiInfo (_host_api_index);
496 if (info == NULL) return;
498 const PaDeviceInfo* nfo_i = Pa_GetDeviceInfo(get_default_input_device());
499 const PaDeviceInfo* nfo_o = Pa_GetDeviceInfo(get_default_output_device());
500 if (nfo_i && nfo_o) {
501 _input_devices.insert (std::pair<int, paDevice*> (DeviceDefault,
502 new paDevice(AudioBackend::get_standard_device_name(AudioBackend::DeviceDefault),
503 nfo_i->maxInputChannels,
504 nfo_o->maxOutputChannels
506 _output_devices.insert (std::pair<int, paDevice*> (DeviceDefault,
507 new paDevice(AudioBackend::get_standard_device_name(AudioBackend::DeviceDefault),
508 nfo_i->maxInputChannels,
509 nfo_o->maxOutputChannels
515 PortAudioIO::add_devices ()
517 const PaHostApiInfo* info = Pa_GetHostApiInfo (_host_api_index);
518 if (info == NULL) return;
520 int n_devices = Pa_GetDeviceCount();
522 DEBUG_AUDIO (string_compose ("PortAudio found %1 devices\n", n_devices));
524 for (int i = 0 ; i < n_devices; ++i) {
525 const PaDeviceInfo* nfo = Pa_GetDeviceInfo(i);
528 if (nfo->hostApi != _host_api_index) continue;
530 DEBUG_AUDIO (string_compose (" (%1) '%2' '%3' in: %4 (lat: %5 .. %6) out: %7 "
531 "(lat: %8 .. %9) sr:%10\n",
535 nfo->maxInputChannels,
536 nfo->defaultLowInputLatency * 1e3,
537 nfo->defaultHighInputLatency * 1e3,
538 nfo->maxOutputChannels,
539 nfo->defaultLowOutputLatency * 1e3,
540 nfo->defaultHighOutputLatency * 1e3,
541 nfo->defaultSampleRate));
543 if ( nfo->maxInputChannels == 0 && nfo->maxOutputChannels == 0) {
547 if (nfo->maxInputChannels > 0) {
548 _input_devices.insert (std::pair<int, paDevice*> (i, new paDevice(
550 nfo->maxInputChannels,
551 nfo->maxOutputChannels
554 if (nfo->maxOutputChannels > 0) {
555 _output_devices.insert (std::pair<int, paDevice*> (i, new paDevice(
557 nfo->maxInputChannels,
558 nfo->maxOutputChannels
565 PortAudioIO::update_devices()
567 DEBUG_AUDIO ("Update devices\n");
568 if (_stream != NULL) return false;
570 if (!pa_initialize()) return false;
572 clear_device_lists ();
574 // ASIO doesn't support separate input/output devices so adding None
575 // doesn't make sense
576 if (get_current_host_api_type() != paASIO) {
584 PortAudioIO::reset_stream_dependents ()
586 _capture_channels = 0;
587 _playback_channels = 0;
588 _cur_sample_rate = 0;
589 _cur_input_latency = 0;
590 _cur_output_latency = 0;
594 PortAudioIO::close_stream()
596 if (!_stream) return paNoError;
598 PaError err = Pa_CloseStream (_stream);
600 if (err != paNoError) {
601 return (PaErrorCode)err;
605 reset_stream_dependents();
607 free (_input_buffer); _input_buffer = NULL;
608 free (_output_buffer); _output_buffer = NULL;
613 PortAudioIO::start_stream()
615 PaError err = Pa_StartStream (_stream);
617 if (err != paNoError) {
618 DEBUG_AUDIO(string_compose("PortAudio failed to start stream %1\n",
619 Pa_GetErrorText(err)));
620 return (PaErrorCode)err;
626 PortAudioIO::set_sample_rate_and_latency_from_stream ()
628 const PaStreamInfo* nfo_s = Pa_GetStreamInfo(_stream);
634 _cur_sample_rate = nfo_s->sampleRate;
635 _cur_input_latency = nfo_s->inputLatency * _cur_sample_rate;
636 _cur_output_latency = nfo_s->outputLatency * _cur_sample_rate;
638 DEBUG_AUDIO (string_compose ("PA Sample Rate %1 SPS\n", _cur_sample_rate));
640 DEBUG_AUDIO (string_compose ("PA Input Latency %1ms, %2 spl\n",
641 1e3 * nfo_s->inputLatency,
642 _cur_input_latency));
644 DEBUG_AUDIO (string_compose ("PA Output Latency %1ms, %2 spl\n",
645 1e3 * nfo_s->outputLatency,
646 _cur_output_latency));
651 PortAudioIO::allocate_buffers_for_blocking_api (uint32_t samples_per_period)
653 if (_capture_channels > 0) {
655 (float*)malloc(samples_per_period * _capture_channels * sizeof(float));
656 if (!_input_buffer) {
657 DEBUG_AUDIO("PortAudio failed to allocate input buffer.\n");
662 if (_playback_channels > 0) {
664 (float*)calloc(samples_per_period * _playback_channels, sizeof(float));
665 if (!_output_buffer) {
666 DEBUG_AUDIO("PortAudio failed to allocate output buffer.\n");
674 PortAudioIO::get_input_stream_params(int device_input,
675 PaStreamParameters& inputParam) const
677 const PaDeviceInfo *nfo_in = NULL;
679 if (device_input == DeviceDefault) {
680 device_input = get_default_input_device ();
683 if (device_input == DeviceNone) {
687 nfo_in = Pa_GetDeviceInfo(device_input);
689 if (nfo_in == NULL) {
690 DEBUG_AUDIO ("PortAudio Cannot Query Input Device Info\n");
694 inputParam.device = device_input;
695 inputParam.channelCount = nfo_in->maxInputChannels;
696 #ifdef INTERLEAVED_INPUT
697 inputParam.sampleFormat = paFloat32;
699 inputParam.sampleFormat = paFloat32 | paNonInterleaved;
701 inputParam.suggestedLatency = nfo_in->defaultLowInputLatency;
702 inputParam.hostApiSpecificStreamInfo = NULL;
708 PortAudioIO::get_output_stream_params(int device_output,
709 PaStreamParameters& outputParam) const
711 const PaDeviceInfo *nfo_out = NULL;
713 if (device_output == DeviceDefault) {
714 device_output = get_default_output_device ();
717 if (device_output == DeviceNone) {
721 nfo_out = Pa_GetDeviceInfo(device_output);
723 if (nfo_out == NULL) {
724 DEBUG_AUDIO ("PortAudio Cannot Query Output Device Info\n");
728 outputParam.device = device_output;
729 outputParam.channelCount = nfo_out->maxOutputChannels;
730 #ifdef INTERLEAVED_OUTPUT
731 outputParam.sampleFormat = paFloat32;
733 outputParam.sampleFormat = paFloat32 | paNonInterleaved;
735 outputParam.suggestedLatency = nfo_out->defaultLowOutputLatency;
736 outputParam.hostApiSpecificStreamInfo = NULL;
742 PortAudioIO::pre_stream_open(int device_input,
743 PaStreamParameters& inputParam,
745 PaStreamParameters& outputParam)
747 if (!pa_initialize()) {
748 DEBUG_AUDIO ("PortAudio Initialization Failed\n");
749 return paNotInitialized;
752 reset_stream_dependents ();
754 DEBUG_AUDIO (string_compose (
755 "PortAudio Device IDs: i:%1 o:%2\n", device_input, device_output));
757 if (device_input == DeviceNone && device_output == DeviceNone) {
758 return paBadIODeviceCombination;
761 if (get_input_stream_params(device_input, inputParam)) {
762 _capture_channels = inputParam.channelCount;
765 if (get_output_stream_params(device_output, outputParam)) {
766 _playback_channels = outputParam.channelCount;
769 if (_capture_channels == 0 && _playback_channels == 0) {
770 DEBUG_AUDIO("PortAudio no input or output channels.\n");
771 return paBadIODeviceCombination;
774 DEBUG_AUDIO (string_compose ("PortAudio Channels: in:%1 out:%2\n",
776 _playback_channels));
782 PortAudioIO::open_callback_stream(int device_input,
785 uint32_t samples_per_period,
786 PaStreamCallback* callback,
789 PaStreamParameters inputParam;
790 PaStreamParameters outputParam;
792 PaErrorCode error_code =
793 pre_stream_open(device_input, inputParam, device_output, outputParam);
795 if (error_code != paNoError) return error_code;
797 PaError err = paNoError;
799 DEBUG_AUDIO ("Open Callback Stream\n");
801 err = Pa_OpenStream(&_stream,
802 _capture_channels > 0 ? &inputParam : NULL,
803 _playback_channels > 0 ? &outputParam : NULL,
810 if (err != paNoError) {
811 DEBUG_AUDIO ("PortAudio failed to start stream.\n");
812 return paInternalError;
815 if (!set_sample_rate_and_latency_from_stream()) {
816 DEBUG_AUDIO ("PortAudio failed to query stream information.\n");
818 return paInternalError;
825 PortAudioIO::open_blocking_stream(int device_input,
828 uint32_t samples_per_period)
830 PaStreamParameters inputParam;
831 PaStreamParameters outputParam;
833 PaErrorCode error_code =
834 pre_stream_open(device_input, inputParam, device_output, outputParam);
836 if (error_code != paNoError) return error_code;
838 PaError err = paNoError;
840 err = Pa_OpenStream (
842 _capture_channels > 0 ? &inputParam: NULL,
843 _playback_channels > 0 ? &outputParam: NULL,
849 if (err != paNoError) {
850 DEBUG_AUDIO(string_compose("PortAudio failed to open stream %1\n",
851 Pa_GetErrorText(err)));
852 return (PaErrorCode)err;
855 if (!set_sample_rate_and_latency_from_stream()) {
856 DEBUG_AUDIO ("PortAudio failed to query stream information.\n");
858 return paInternalError;
861 if (!allocate_buffers_for_blocking_api(samples_per_period)) {
863 return paInternalError;
869 PortAudioIO::next_cycle (uint32_t n_samples)
873 err = Pa_IsStreamActive (_stream);
875 // 0: inactive / aborted
880 // TODO, check drift.. process part with larger capacity first.
881 // Pa_GetStreamReadAvailable(_stream) < Pa_GetStreamWriteAvailable(_stream)
883 if (_playback_channels > 0) {
884 err = Pa_WriteStream (_stream, _output_buffer, n_samples);
885 if (err) xrun = true;
888 if (_capture_channels > 0) {
889 err = Pa_ReadStream (_stream, _input_buffer, n_samples);
891 memset (_input_buffer, 0, sizeof(float) * n_samples * _capture_channels);
901 PortAudioIO::get_input_channel_name (int device_id, uint32_t channel) const
904 const char* channel_name;
906 // This will return an error for non-ASIO devices so no need to check if
907 // the device_id corresponds to an ASIO device.
908 PaError err = PaAsio_GetInputChannelName (device_id, channel, &channel_name);
910 if (err == paNoError) {
912 string_compose ("Input channel name for device %1, channel %2 is %3\n",
919 return std::string();
923 PortAudioIO::get_output_channel_name (int device_id, uint32_t channel) const
926 const char* channel_name;
928 PaError err = PaAsio_GetOutputChannelName (device_id, channel, &channel_name);
930 if (err == paNoError) {
932 string_compose ("Output channel name for device %1, channel %2 is %3\n",
939 return std::string();
942 #ifdef INTERLEAVED_INPUT
945 PortAudioIO::get_capture_channel (uint32_t chn, float *input, uint32_t n_samples)
947 assert(chn < _capture_channels);
948 const uint32_t stride = _capture_channels;
949 float *ptr = _input_buffer + chn;
950 while (n_samples-- > 0) {
960 PortAudioIO::get_capture_channel (uint32_t chn, float *input, uint32_t n_samples)
962 assert(chn < _capture_channels);
963 memcpy((void*)input, &(_input_buffer[chn * n_samples]), n_samples * sizeof(float));
970 #ifdef INTERLEAVED_OUTPUT
973 PortAudioIO::set_playback_channel (uint32_t chn, const float *output, uint32_t n_samples)
975 assert(chn < _playback_channels);
976 const uint32_t stride = _playback_channels;
977 float *ptr = _output_buffer + chn;
978 while (n_samples-- > 0) {
988 PortAudioIO::set_playback_channel (uint32_t chn, const float *output, uint32_t n_samples)
990 assert(chn < _playback_channels);
991 memcpy((void*)&(_output_buffer[chn * n_samples]), (void*)output, n_samples * sizeof(float));