2 * Copyright (C) 2015-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.
22 #ifndef PLATFORM_WINDOWS
33 #include "portaudio_backend.h"
35 #include "pbd/compose.h"
36 #include "pbd/error.h"
37 #include "pbd/file_utils.h"
38 #include "pbd/pthread_utils.h"
39 #include "pbd/windows_timer_utils.h"
40 #include "pbd/windows_mmcss.h"
42 #include "ardour/filesystem_paths.h"
43 #include "ardour/port_manager.h"
46 #include "audio_utils.h"
50 using namespace ARDOUR;
54 const char * const winmme_driver_name = X_("WinMME");
58 static std::string s_instance_name;
59 size_t PortAudioBackend::_max_buffer_size = 8192;
60 std::vector<std::string> PortAudioBackend::_midi_options;
61 std::vector<AudioBackend::DeviceStatus> PortAudioBackend::_input_audio_device_status;
62 std::vector<AudioBackend::DeviceStatus> PortAudioBackend::_output_audio_device_status;
64 PortAudioBackend::PortAudioBackend (AudioEngine& e, AudioBackendInfo& info)
65 : AudioBackend (e, info)
69 , _use_blocking_api(false)
71 , _freewheeling (false)
72 , _freewheel_ack (false)
73 , _reinit_thread_callback (false)
74 , _measure_latency (false)
76 , _total_deviation_us(0)
77 , _max_deviation_us(0)
78 , _input_audio_device("")
79 , _output_audio_device("")
80 , _midi_driver_option(get_standard_device_name(DeviceNone))
82 , _samples_per_period (1024)
85 , _systemic_audio_input_latency (0)
86 , _systemic_audio_output_latency (0)
88 , _processed_samples (0)
89 , _port_change_flag (false)
91 _instance_name = s_instance_name;
92 pthread_mutex_init (&_port_callback_mutex, 0);
93 pthread_mutex_init (&_freewheel_mutex, 0);
94 pthread_cond_init (&_freewheel_signal, 0);
96 _port_connection_queue.reserve (128);
98 _pcmio = new PortAudioIO ();
99 _midiio = new WinMMEMidiIO ();
102 PortAudioBackend::~PortAudioBackend ()
104 delete _pcmio; _pcmio = 0;
105 delete _midiio; _midiio = 0;
107 pthread_mutex_destroy (&_port_callback_mutex);
108 pthread_mutex_destroy (&_freewheel_mutex);
109 pthread_cond_destroy (&_freewheel_signal);
112 /* AUDIOBACKEND API */
115 PortAudioBackend::name () const
117 return X_("PortAudio");
121 PortAudioBackend::is_realtime () const
127 PortAudioBackend::requires_driver_selection() const
129 // we could do this but implementation would need changing
131 if (enumerate_drivers().size() == 1) {
138 std::vector<std::string>
139 PortAudioBackend::enumerate_drivers () const
141 DEBUG_AUDIO ("Portaudio: enumerate_drivers\n");
142 std::vector<std::string> currently_available;
143 _pcmio->host_api_list (currently_available);
144 return currently_available;
148 PortAudioBackend::set_driver (const std::string& name)
150 DEBUG_AUDIO (string_compose ("Portaudio: set_driver %1 \n", name));
151 if (!_pcmio->set_host_api (name)) {
152 DEBUG_AUDIO (string_compose ("Portaudio: Unable to set_driver %1 \n", name));
155 _pcmio->update_devices();
160 PortAudioBackend::update_devices ()
162 // update midi device info?
163 return _pcmio->update_devices();
167 PortAudioBackend::set_use_buffered_io (bool use_buffered_io)
169 DEBUG_AUDIO (string_compose ("Portaudio: use_buffered_io %1 \n", use_buffered_io));
175 _use_blocking_api = use_buffered_io;
179 PortAudioBackend::driver_name () const
181 std::string driver_name = _pcmio->get_host_api ();
182 DEBUG_AUDIO (string_compose ("Portaudio: driver_name %1 \n", driver_name));
187 PortAudioBackend::use_separate_input_and_output_devices () const
192 std::vector<AudioBackend::DeviceStatus>
193 PortAudioBackend::enumerate_devices () const
195 DEBUG_AUDIO ("Portaudio: ERROR enumerate devices should not be called \n");
196 return std::vector<AudioBackend::DeviceStatus>();
199 std::vector<AudioBackend::DeviceStatus>
200 PortAudioBackend::enumerate_input_devices () const
202 _input_audio_device_status.clear();
203 std::map<int, std::string> input_devices;
204 _pcmio->input_device_list(input_devices);
206 for (std::map<int, std::string>::const_iterator i = input_devices.begin (); i != input_devices.end(); ++i) {
207 if (_input_audio_device == "") _input_audio_device = i->second;
208 _input_audio_device_status.push_back (DeviceStatus (i->second, true));
210 return _input_audio_device_status;
213 std::vector<AudioBackend::DeviceStatus>
214 PortAudioBackend::enumerate_output_devices () const
216 _output_audio_device_status.clear();
217 std::map<int, std::string> output_devices;
218 _pcmio->output_device_list(output_devices);
220 for (std::map<int, std::string>::const_iterator i = output_devices.begin (); i != output_devices.end(); ++i) {
221 if (_output_audio_device == "") _output_audio_device = i->second;
222 _output_audio_device_status.push_back (DeviceStatus (i->second, true));
224 return _output_audio_device_status;
228 PortAudioBackend::available_sample_rates (const std::string&) const
230 DEBUG_AUDIO ("Portaudio: available_sample_rates\n");
231 std::vector<float> sr;
232 _pcmio->available_sample_rates(name_to_id(_input_audio_device), sr);
236 std::vector<uint32_t>
237 PortAudioBackend::available_buffer_sizes (const std::string&) const
239 DEBUG_AUDIO ("Portaudio: available_buffer_sizes\n");
240 std::vector<uint32_t> bs;
241 _pcmio->available_buffer_sizes(name_to_id(_input_audio_device), bs);
246 PortAudioBackend::available_input_channel_count (const std::string&) const
248 return 128; // TODO query current device
252 PortAudioBackend::available_output_channel_count (const std::string&) const
254 return 128; // TODO query current device
258 PortAudioBackend::can_change_sample_rate_when_running () const
264 PortAudioBackend::can_change_buffer_size_when_running () const
266 return false; // TODO
270 PortAudioBackend::set_device_name (const std::string& d)
272 DEBUG_AUDIO ("Portaudio: set_device_name should not be called\n");
277 PortAudioBackend::set_input_device_name (const std::string& d)
279 DEBUG_AUDIO (string_compose ("Portaudio: set_input_device_name %1\n", d));
280 _input_audio_device = d;
285 PortAudioBackend::set_output_device_name (const std::string& d)
287 DEBUG_AUDIO (string_compose ("Portaudio: set_output_device_name %1\n", d));
288 _output_audio_device = d;
293 PortAudioBackend::set_sample_rate (float sr)
295 if (sr <= 0) { return -1; }
296 // TODO check if it's in the list of valid SR
298 engine.sample_rate_change (sr);
303 PortAudioBackend::set_buffer_size (uint32_t bs)
305 if (bs <= 0 || bs >= _max_buffer_size) {
308 _samples_per_period = bs;
309 engine.buffer_size_change (bs);
314 PortAudioBackend::set_interleaved (bool yn)
316 if (!yn) { return 0; }
321 PortAudioBackend::set_input_channels (uint32_t cc)
328 PortAudioBackend::set_output_channels (uint32_t cc)
335 PortAudioBackend::set_systemic_input_latency (uint32_t sl)
337 _systemic_audio_input_latency = sl;
342 PortAudioBackend::set_systemic_output_latency (uint32_t sl)
344 _systemic_audio_output_latency = sl;
349 PortAudioBackend::set_systemic_midi_input_latency (std::string const device, uint32_t sl)
351 MidiDeviceInfo* nfo = midi_device_info (device);
353 nfo->systemic_input_latency = sl;
358 PortAudioBackend::set_systemic_midi_output_latency (std::string const device, uint32_t sl)
360 MidiDeviceInfo* nfo = midi_device_info (device);
362 nfo->systemic_output_latency = sl;
366 /* Retrieving parameters */
368 PortAudioBackend::device_name () const
374 PortAudioBackend::input_device_name () const
376 return _input_audio_device;
380 PortAudioBackend::output_device_name () const
382 return _output_audio_device;
386 PortAudioBackend::sample_rate () const
392 PortAudioBackend::buffer_size () const
394 return _samples_per_period;
398 PortAudioBackend::interleaved () const
404 PortAudioBackend::input_channels () const
410 PortAudioBackend::output_channels () const
416 PortAudioBackend::systemic_input_latency () const
418 return _systemic_audio_input_latency;
422 PortAudioBackend::systemic_output_latency () const
424 return _systemic_audio_output_latency;
428 PortAudioBackend::systemic_midi_input_latency (std::string const device) const
430 MidiDeviceInfo* nfo = midi_device_info (device);
432 return nfo->systemic_input_latency;
436 PortAudioBackend::systemic_midi_output_latency (std::string const device) const
438 MidiDeviceInfo* nfo = midi_device_info (device);
440 return nfo->systemic_output_latency;
444 PortAudioBackend::control_app_name () const
446 return _pcmio->control_app_name (name_to_id (_input_audio_device));
450 PortAudioBackend::launch_control_app ()
452 return _pcmio->launch_control_app (name_to_id(_input_audio_device));
457 std::vector<std::string>
458 PortAudioBackend::enumerate_midi_options () const
460 if (_midi_options.empty()) {
461 _midi_options.push_back (winmme_driver_name);
462 _midi_options.push_back (get_standard_device_name(DeviceNone));
464 return _midi_options;
468 PortAudioBackend::set_midi_option (const std::string& opt)
470 if (opt != get_standard_device_name(DeviceNone) && opt != winmme_driver_name) {
473 DEBUG_MIDI (string_compose ("Setting midi option to %1\n", opt));
474 _midi_driver_option = opt;
479 PortAudioBackend::midi_option () const
481 return _midi_driver_option;
484 std::vector<AudioBackend::DeviceStatus>
485 PortAudioBackend::enumerate_midi_devices () const
487 std::vector<AudioBackend::DeviceStatus> midi_device_status;
488 std::vector<MidiDeviceInfo*> device_info;
490 if (_midi_driver_option == winmme_driver_name) {
491 _midiio->update_device_info ();
492 device_info = _midiio->get_device_info ();
495 for (std::vector<MidiDeviceInfo*>::const_iterator i = device_info.begin();
496 i != device_info.end();
498 midi_device_status.push_back(DeviceStatus((*i)->device_name, true));
500 return midi_device_status;
504 PortAudioBackend::midi_device_info (const std::string& device_name) const
506 std::vector<MidiDeviceInfo*> dev_info;
508 if (_midi_driver_option == winmme_driver_name) {
509 dev_info = _midiio->get_device_info();
511 for (std::vector<MidiDeviceInfo*>::const_iterator i = dev_info.begin();
514 if ((*i)->device_name == device_name) {
523 PortAudioBackend::set_midi_device_enabled (std::string const device, bool enable)
525 MidiDeviceInfo* nfo = midi_device_info(device);
527 nfo->enable = enable;
532 PortAudioBackend::midi_device_enabled (std::string const device) const
534 MidiDeviceInfo* nfo = midi_device_info(device);
535 if (!nfo) return false;
541 static void * blocking_thread_func (void *arg)
543 PortAudioBackend *d = static_cast<PortAudioBackend *>(arg);
544 d->blocking_process_thread ();
550 PortAudioBackend::engine_halted ()
552 return !_active && _run;
556 PortAudioBackend::running ()
558 return _active || _run;
562 PortAudioBackend::_start (bool for_latency_measurement)
564 if (engine_halted()) {
569 DEBUG_AUDIO("Already started.\n");
570 return BackendReinitializationError;
575 "Recovering from unclean shutdown, port registry is not empty.\n");
576 _system_inputs.clear();
577 _system_outputs.clear();
578 _system_midi_in.clear();
579 _system_midi_out.clear();
583 /* reset internal state */
584 assert (_run == false);
587 _freewheeling = false;
590 PaErrorCode err = paNoError;
592 if (_use_blocking_api) {
593 DEBUG_AUDIO("Opening blocking audio stream\n");
594 err = _pcmio->open_blocking_stream(name_to_id(_input_audio_device),
595 name_to_id(_output_audio_device),
597 _samples_per_period);
599 DEBUG_AUDIO("Opening callback audio stream\n");
600 err = _pcmio->open_callback_stream(name_to_id(_input_audio_device),
601 name_to_id(_output_audio_device),
608 // reintepret Portaudio error messages
612 case paBadIODeviceCombination:
613 return DeviceConfigurationNotSupportedError;
614 case paInvalidChannelCount:
615 return ChannelCountNotSupportedError;
616 case paInvalidSampleRate:
617 return SampleRateNotSupportedError;
619 return AudioDeviceOpenError;
622 if (_n_outputs != _pcmio->n_playback_channels ()) {
623 _n_outputs = _pcmio->n_playback_channels ();
624 PBD::info << get_error_string(OutputChannelCountNotSupportedError) << endmsg;
627 if (_n_inputs != _pcmio->n_capture_channels ()) {
628 _n_inputs = _pcmio->n_capture_channels ();
629 PBD::info << get_error_string(InputChannelCountNotSupportedError) << endmsg;
632 if (_pcmio->samples_per_period() != _samples_per_period) {
633 _samples_per_period = _pcmio->samples_per_period();
634 PBD::warning << _("PortAudioBackend: samples per period does not match.") << endmsg;
638 if (_pcmio->sample_rate() != _samplerate) {
639 _samplerate = _pcmio->sample_rate();
640 engine.sample_rate_change (_samplerate);
641 PBD::warning << get_error_string(SampleRateNotSupportedError) << endmsg;
644 _measure_latency = for_latency_measurement;
646 _port_change_flag = false;
648 if (_midi_driver_option == winmme_driver_name) {
649 _midiio->set_enabled(true);
650 //_midiio->set_port_changed_callback(midi_port_change, this);
651 _midiio->start(); // triggers port discovery, callback coremidi_rediscover()
654 _cycle_timer.set_samplerate(_samplerate);
655 _cycle_timer.set_samples_per_cycle(_samples_per_period);
657 _dsp_calc.set_max_time_us (_cycle_timer.get_length_us());
659 DEBUG_MIDI ("Registering MIDI ports\n");
661 if (register_system_midi_ports () != 0) {
662 DEBUG_PORTS("Failed to register system midi ports.\n")
663 return PortRegistrationError;
666 DEBUG_AUDIO ("Registering Audio ports\n");
668 if (register_system_audio_ports()) {
669 DEBUG_PORTS("Failed to register system audio ports.\n");
670 return PortRegistrationError;
673 engine.sample_rate_change (_samplerate);
674 engine.buffer_size_change (_samples_per_period);
676 if (engine.reestablish_ports ()) {
677 DEBUG_PORTS("Could not re-establish ports.\n");
678 return PortReconnectError;
683 engine.reconnect_ports ();
684 _port_change_flag = false;
686 if (_use_blocking_api) {
687 if (!start_blocking_process_thread()) {
688 return ProcessThreadStartError;
691 if (_pcmio->start_stream() != paNoError) {
692 DEBUG_AUDIO("Unable to start stream\n");
693 return AudioDeviceOpenError;
696 if (!start_freewheel_process_thread()) {
697 DEBUG_AUDIO("Unable to start freewheel thread\n");
699 return ProcessThreadStartError;
702 /* wait for backend to become active */
704 while (!_active && --timeout > 0) { Glib::usleep (1000); }
706 if (timeout == 0 || !_active) {
707 PBD::error << _("PortAudio:: failed to start device.") << endmsg;
709 return ProcessThreadStartError;
717 PortAudioBackend::portaudio_callback(const void* input,
719 unsigned long sample_count,
720 const PaStreamCallbackTimeInfo* time_info,
721 PaStreamCallbackFlags status_flags,
724 PortAudioBackend* pa_backend = static_cast<PortAudioBackend*>(user_data);
726 if (!pa_backend->process_callback((const float*)input,
738 PortAudioBackend::process_callback(const float* input,
740 uint32_t sample_count,
741 const PaStreamCallbackTimeInfo* timeInfo,
742 PaStreamCallbackFlags statusFlags)
746 _dsp_calc.set_start_timestamp_us (PBD::get_microseconds());
748 if (_run && _freewheel && !_freewheel_ack) {
749 // acknowledge freewheeling; hand-over thread ID
750 pthread_mutex_lock (&_freewheel_mutex);
752 DEBUG_AUDIO("Setting _freewheel_ack = true;\n");
753 _freewheel_ack = true;
755 DEBUG_AUDIO("Signalling freewheel thread\n");
756 pthread_cond_signal (&_freewheel_signal);
757 pthread_mutex_unlock (&_freewheel_mutex);
760 if (statusFlags & paInputUnderflow ||
761 statusFlags & paInputOverflow ||
762 statusFlags & paOutputUnderflow ||
763 statusFlags & paOutputOverflow ) {
764 DEBUG_AUDIO("PortAudio: Xrun\n");
769 if (!_run || _freewheel) {
770 memset(output, 0, sample_count * sizeof(float) * _system_outputs.size());
774 bool in_main_thread = pthread_equal(_main_thread, pthread_self());
776 if (_reinit_thread_callback || !in_main_thread) {
777 _reinit_thread_callback = false;
778 _main_thread = pthread_self();
779 AudioEngine::thread_init_callback (this);
782 process_port_connection_changes();
784 return blocking_process_main (input, output);
788 PortAudioBackend::start_blocking_process_thread ()
790 if (pbd_realtime_pthread_create (PBD_SCHED_FIFO, -20, 100000,
791 &_main_blocking_thread, blocking_thread_func, this))
793 if (pthread_create (&_main_blocking_thread, NULL, blocking_thread_func, this))
795 DEBUG_AUDIO("Failed to create main audio thread\n");
799 PBD::warning << get_error_string(AquireRealtimePermissionError) << endmsg;
804 while (!_active && --timeout > 0) { Glib::usleep (1000); }
806 if (timeout == 0 || !_active) {
807 DEBUG_AUDIO("Failed to start main audio thread\n");
808 _pcmio->close_stream();
818 PortAudioBackend::stop_blocking_process_thread ()
822 if (pthread_join (_main_blocking_thread, &status)) {
823 DEBUG_AUDIO("Failed to stop main audio thread\n");
831 PortAudioBackend::stop ()
841 if (_use_blocking_api) {
842 if (!stop_blocking_process_thread()) {
846 _pcmio->close_stream();
849 if (!stop_freewheel_process_thread()) {
856 return (_active == false) ? 0 : -1;
859 static void* freewheel_thread(void* arg)
861 PortAudioBackend* d = static_cast<PortAudioBackend*>(arg);
862 d->freewheel_process_thread ();
868 PortAudioBackend::start_freewheel_process_thread ()
870 if (pthread_create(&_pthread_freewheel, NULL, freewheel_thread, this)) {
871 DEBUG_AUDIO("Failed to create main audio thread\n");
876 while (!_freewheel_thread_active && --timeout > 0) { Glib::usleep (1000); }
878 if (timeout == 0 || !_freewheel_thread_active) {
879 DEBUG_AUDIO("Failed to start freewheel thread\n");
886 PortAudioBackend::stop_freewheel_process_thread ()
890 if (!_freewheel_thread_active) {
894 DEBUG_AUDIO("Signaling freewheel thread to stop\n");
896 pthread_mutex_lock (&_freewheel_mutex);
897 pthread_cond_signal (&_freewheel_signal);
898 pthread_mutex_unlock (&_freewheel_mutex);
900 if (pthread_join (_pthread_freewheel, &status) != 0) {
901 DEBUG_AUDIO("Failed to stop freewheel thread\n");
909 PortAudioBackend::freewheel_process_thread()
911 _freewheel_thread_active = true;
913 bool first_run = false;
915 pthread_mutex_lock (&_freewheel_mutex);
918 // check if we should run,
919 if (_freewheeling != _freewheel) {
920 if (!_freewheeling) {
921 DEBUG_AUDIO("Leaving freewheel\n");
922 _freewheel = false; // first mark as disabled
923 _reinit_thread_callback = true; // hand over _main_thread
924 _freewheel_ack = false; // prepare next handshake
925 _midiio->set_enabled(true);
926 engine.freewheel_callback (_freewheeling);
933 if (!_freewheel || !_freewheel_ack) {
934 // wait for a change, we use a timed wait to
935 // terminate early in case some error sets _run = 0
938 gettimeofday (&tv, NULL);
939 ts.tv_sec = tv.tv_sec + 3;
941 DEBUG_AUDIO("Waiting for freewheel change\n");
942 pthread_cond_timedwait (&_freewheel_signal, &_freewheel_mutex, &ts);
947 // tell the engine we're ready to GO.
948 engine.freewheel_callback (_freewheeling);
950 _main_thread = pthread_self();
951 AudioEngine::thread_init_callback (this);
952 _midiio->set_enabled(false);
955 if (!blocking_process_freewheel()) {
959 process_port_connection_changes();
962 pthread_mutex_unlock (&_freewheel_mutex);
964 _freewheel_thread_active = false;
967 // engine.process_callback() returner error
968 engine.halted_callback("CoreAudio Freehweeling aborted.");
974 PortAudioBackend::freewheel (bool onoff)
976 if (onoff == _freewheeling) {
979 _freewheeling = onoff;
981 if (0 == pthread_mutex_trylock (&_freewheel_mutex)) {
982 pthread_cond_signal (&_freewheel_signal);
983 pthread_mutex_unlock (&_freewheel_mutex);
989 PortAudioBackend::dsp_load () const
991 return 100.f * _dsp_load;
995 PortAudioBackend::raw_buffer_size (DataType t)
998 case DataType::AUDIO:
999 return _samples_per_period * sizeof(Sample);
1000 case DataType::MIDI:
1001 return _max_buffer_size; // XXX not really limited
1008 PortAudioBackend::sample_time ()
1010 return _processed_samples;
1014 PortAudioBackend::sample_time_at_cycle_start ()
1016 return _processed_samples;
1020 PortAudioBackend::samples_since_cycle_start ()
1022 if (!_active || !_run || _freewheeling || _freewheel) {
1025 if (!_cycle_timer.valid()) {
1029 return _cycle_timer.samples_since_cycle_start (PBD::get_microseconds());
1033 PortAudioBackend::name_to_id(std::string device_name) const {
1034 uint32_t device_id = UINT32_MAX;
1035 std::map<int, std::string> devices;
1036 _pcmio->input_device_list(devices);
1037 _pcmio->output_device_list(devices);
1039 for (std::map<int, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
1040 if (i->second == device_name) {
1041 device_id = i->first;
1049 PortAudioBackend::set_mmcss_pro_audio (HANDLE* task_handle)
1051 bool mmcss_success = PBD::MMCSS::set_thread_characteristics ("Pro Audio", task_handle);
1053 if (!mmcss_success) {
1054 PBD::warning << get_error_string(SettingAudioThreadPriorityError) << endmsg;
1057 DEBUG_THREADS("Thread characteristics set to Pro Audio\n");
1060 bool mmcss_priority =
1061 PBD::MMCSS::set_thread_priority(*task_handle, PBD::MMCSS::AVRT_PRIORITY_NORMAL);
1063 if (!mmcss_priority) {
1064 PBD::warning << get_error_string(SettingAudioThreadPriorityError) << endmsg;
1067 DEBUG_THREADS("Thread priority set to AVRT_PRIORITY_NORMAL\n");
1074 PortAudioBackend::reset_mmcss (HANDLE task_handle)
1076 if (!PBD::MMCSS::revert_thread_characteristics(task_handle)) {
1077 DEBUG_THREADS("Unable to reset process thread characteristics\n");
1084 PortAudioBackend::portaudio_process_thread (void *arg)
1086 ThreadData* td = reinterpret_cast<ThreadData*> (arg);
1087 boost::function<void ()> f = td->f;
1090 #ifdef USE_MMCSS_THREAD_PRIORITIES
1092 bool mmcss_success = set_mmcss_pro_audio (&task_handle);
1095 DWORD tid = GetCurrentThreadId ();
1096 DEBUG_THREADS (string_compose ("Process Thread Child ID: %1\n", tid));
1100 #ifdef USE_MMCSS_THREAD_PRIORITIES
1101 if (mmcss_success) {
1102 reset_mmcss (task_handle);
1110 PortAudioBackend::create_process_thread (boost::function<void()> func)
1112 pthread_t thread_id;
1113 pthread_attr_t attr;
1114 size_t stacksize = 100000;
1116 ThreadData* td = new ThreadData (this, func, stacksize);
1118 if (pbd_realtime_pthread_create (PBD_SCHED_FIFO, -22, stacksize,
1119 &thread_id, portaudio_process_thread, td)) {
1120 pthread_attr_init (&attr);
1121 pthread_attr_setstacksize (&attr, stacksize);
1122 if (pthread_create (&thread_id, &attr, portaudio_process_thread, td)) {
1123 DEBUG_AUDIO("Cannot create process thread.");
1124 pthread_attr_destroy (&attr);
1127 pthread_attr_destroy (&attr);
1130 _threads.push_back (thread_id);
1135 PortAudioBackend::join_process_threads ()
1139 for (std::vector<pthread_t>::const_iterator i = _threads.begin (); i != _threads.end (); ++i)
1142 if (pthread_join (*i, &status)) {
1143 DEBUG_AUDIO("Cannot terminate process thread.");
1152 PortAudioBackend::in_process_thread ()
1154 if (_use_blocking_api) {
1155 if (pthread_equal(_main_blocking_thread, pthread_self()) != 0) {
1159 if (pthread_equal(_main_thread, pthread_self()) != 0) {
1163 for (std::vector<pthread_t>::const_iterator i = _threads.begin (); i != _threads.end (); ++i)
1165 if (pthread_equal (*i, pthread_self ()) != 0) {
1173 PortAudioBackend::process_thread_count ()
1175 return _threads.size ();
1179 PortAudioBackend::update_latencies ()
1181 // trigger latency callback in RT thread (locked graph)
1182 port_connect_add_remove_callback();
1185 /* PORTENGINE API */
1188 PortAudioBackend::private_handle () const
1194 PortAudioBackend::my_name () const
1196 return _instance_name;
1200 PortAudioBackend::port_name_size () const
1206 PortAudioBackend::set_port_name (PortEngine::PortHandle port, const std::string& name)
1208 if (!valid_port (port)) {
1209 DEBUG_PORTS("set_port_name: Invalid Port(s)\n");
1212 return static_cast<PamPort*>(port)->set_name (_instance_name + ":" + name);
1216 PortAudioBackend::get_port_name (PortEngine::PortHandle port) const
1218 if (!valid_port (port)) {
1219 DEBUG_PORTS("get_port_name: Invalid Port(s)\n");
1220 return std::string ();
1222 return static_cast<PamPort*>(port)->name ();
1226 PortAudioBackend::get_port_flags (PortEngine::PortHandle port) const
1228 if (!valid_port (port)) {
1229 DEBUG_PORTS("get_port_flags: Invalid Port(s)\n");
1230 return PortFlags (0);
1232 return static_cast<PamPort*>(port)->flags ();
1236 PortAudioBackend::get_port_property (PortHandle port,
1237 const std::string& key,
1239 std::string& type) const
1241 if (!valid_port (port)) {
1242 DEBUG_PORTS("get_port_name: Invalid Port(s)\n");
1246 if (key == "http://jackaudio.org/metadata/pretty-name") {
1248 value = static_cast<PamPort*>(port)->pretty_name ();
1249 if (!value.empty()) {
1257 PortAudioBackend::set_port_property (PortHandle port,
1258 const std::string& key,
1259 const std::string& value,
1260 const std::string& type)
1262 if (!valid_port (port)) {
1263 DEBUG_PORTS("get_port_name: Invalid Port(s)\n");
1267 if (key == "http://jackaudio.org/metadata/pretty-name" && type.empty ()) {
1268 static_cast<PamPort*>(port)->set_pretty_name (value);
1274 PortEngine::PortHandle
1275 PortAudioBackend::get_port_by_name (const std::string& name) const
1277 PortHandle port = (PortHandle) find_port (name);
1282 PortAudioBackend::get_ports (
1283 const std::string& port_name_pattern,
1284 DataType type, PortFlags flags,
1285 std::vector<std::string>& port_names) const
1289 bool use_regexp = false;
1290 if (port_name_pattern.size () > 0) {
1291 if (!regcomp (&port_regex, port_name_pattern.c_str (), REG_EXTENDED|REG_NOSUB)) {
1295 for (size_t i = 0; i < _ports.size (); ++i) {
1296 PamPort* port = _ports[i];
1297 if ((port->type () == type) && flags == (port->flags () & flags)) {
1298 if (!use_regexp || !regexec (&port_regex, port->name ().c_str (), 0, NULL, 0)) {
1299 port_names.push_back (port->name ());
1305 regfree (&port_regex);
1311 PortAudioBackend::port_data_type (PortEngine::PortHandle port) const
1313 if (!valid_port (port)) {
1314 return DataType::NIL;
1316 return static_cast<PamPort*>(port)->type ();
1319 PortEngine::PortHandle
1320 PortAudioBackend::register_port (
1321 const std::string& name,
1322 ARDOUR::DataType type,
1323 ARDOUR::PortFlags flags)
1325 if (name.size () == 0) { return 0; }
1326 if (flags & IsPhysical) { return 0; }
1327 return add_port (_instance_name + ":" + name, type, flags);
1330 PortEngine::PortHandle
1331 PortAudioBackend::add_port (
1332 const std::string& name,
1333 ARDOUR::DataType type,
1334 ARDOUR::PortFlags flags)
1336 assert(name.size ());
1337 if (find_port (name)) {
1339 string_compose("register_port: Port already exists: (%1)\n", name));
1342 PamPort* port = NULL;
1344 case DataType::AUDIO:
1345 port = new PortAudioPort(*this, name, flags);
1347 case DataType::MIDI:
1348 port = new PortMidiPort(*this, name, flags);
1351 DEBUG_PORTS("register_port: Invalid Data Type.\n");
1355 _ports.push_back (port);
1361 PortAudioBackend::unregister_port (PortEngine::PortHandle port_handle)
1366 PamPort* port = static_cast<PamPort*>(port_handle);
1367 std::vector<PamPort*>::iterator i = std::find (_ports.begin (), _ports.end (), static_cast<PamPort*>(port_handle));
1368 if (i == _ports.end ()) {
1369 DEBUG_PORTS("unregister_port: Failed to find port\n");
1372 disconnect_all(port_handle);
1378 PortAudioBackend::register_system_audio_ports()
1382 const uint32_t a_ins = _n_inputs;
1383 const uint32_t a_out = _n_outputs;
1385 uint32_t capture_latency = 0;
1386 uint32_t playback_latency = 0;
1388 // guard against erroneous latency values
1389 if (_pcmio->capture_latency() > _samples_per_period) {
1390 capture_latency = _pcmio->capture_latency() - _samples_per_period;
1392 if (_pcmio->playback_latency() > _samples_per_period) {
1393 playback_latency = _pcmio->playback_latency() - _samples_per_period;
1397 lr.min = lr.max = capture_latency + (_measure_latency ? 0 : _systemic_audio_input_latency);
1398 for (uint32_t i = 0; i < a_ins; ++i) {
1400 snprintf(tmp, sizeof(tmp), "system:capture_%d", i+1);
1401 PortHandle p = add_port(std::string(tmp), DataType::AUDIO, static_cast<PortFlags>(IsOutput | IsPhysical | IsTerminal));
1403 set_latency_range (p, false, lr);
1404 PortAudioPort* audio_port = static_cast<PortAudioPort*>(p);
1405 audio_port->set_pretty_name (
1406 _pcmio->get_input_channel_name (name_to_id (_input_audio_device), i));
1407 _system_inputs.push_back (audio_port);
1410 lr.min = lr.max = playback_latency + (_measure_latency ? 0 : _systemic_audio_output_latency);
1411 for (uint32_t i = 0; i < a_out; ++i) {
1413 snprintf(tmp, sizeof(tmp), "system:playback_%d", i+1);
1414 PortHandle p = add_port(std::string(tmp), DataType::AUDIO, static_cast<PortFlags>(IsInput | IsPhysical | IsTerminal));
1416 set_latency_range (p, true, lr);
1417 PortAudioPort* audio_port = static_cast<PortAudioPort*>(p);
1418 audio_port->set_pretty_name (
1419 _pcmio->get_output_channel_name (name_to_id (_output_audio_device), i));
1420 _system_outputs.push_back(audio_port);
1426 PortAudioBackend::register_system_midi_ports()
1428 if (_midi_driver_option == get_standard_device_name(DeviceNone)) {
1429 DEBUG_MIDI("No MIDI backend selected, not system midi ports available\n");
1434 lr.min = lr.max = _samples_per_period;
1436 const std::vector<WinMMEMidiInputDevice*> inputs = _midiio->get_inputs();
1438 for (std::vector<WinMMEMidiInputDevice*>::const_iterator i = inputs.begin ();
1441 std::string port_name = "system:midi_capture_" + (*i)->name();
1443 add_port (port_name,
1445 static_cast<PortFlags>(IsOutput | IsPhysical | IsTerminal));
1448 MidiDeviceInfo* info = _midiio->get_device_info((*i)->name());
1449 if (info) { // assert?
1450 lr.min = lr.max = _samples_per_period + info->systemic_input_latency;
1452 set_latency_range (p, false, lr);
1454 PortMidiPort* midi_port = static_cast<PortMidiPort*>(p);
1455 midi_port->set_pretty_name ((*i)->name());
1456 _system_midi_in.push_back (midi_port);
1457 DEBUG_MIDI (string_compose ("Registered MIDI input port: %1\n", port_name));
1460 const std::vector<WinMMEMidiOutputDevice*> outputs = _midiio->get_outputs();
1462 for (std::vector<WinMMEMidiOutputDevice*>::const_iterator i = outputs.begin ();
1463 i != outputs.end ();
1465 std::string port_name = "system:midi_playback_" + (*i)->name();
1467 add_port (port_name,
1469 static_cast<PortFlags>(IsInput | IsPhysical | IsTerminal));
1472 MidiDeviceInfo* info = _midiio->get_device_info((*i)->name());
1473 if (info) { // assert?
1474 lr.min = lr.max = _samples_per_period + info->systemic_output_latency;
1476 set_latency_range (p, false, lr);
1478 PortMidiPort* midi_port = static_cast<PortMidiPort*>(p);
1479 midi_port->set_n_periods(2);
1480 midi_port->set_pretty_name ((*i)->name());
1481 _system_midi_out.push_back (midi_port);
1482 DEBUG_MIDI (string_compose ("Registered MIDI output port: %1\n", port_name));
1488 PortAudioBackend::unregister_ports (bool system_only)
1491 _system_inputs.clear();
1492 _system_outputs.clear();
1493 _system_midi_in.clear();
1494 _system_midi_out.clear();
1495 while (i < _ports.size ()) {
1496 PamPort* port = _ports[i];
1497 if (! system_only || (port->is_physical () && port->is_terminal ())) {
1498 port->disconnect_all ();
1500 _ports.erase (_ports.begin() + i);
1508 PortAudioBackend::update_system_port_latecies ()
1510 for (std::vector<PamPort*>::const_iterator it = _system_inputs.begin (); it != _system_inputs.end (); ++it) {
1511 (*it)->update_connected_latency (true);
1513 for (std::vector<PamPort*>::const_iterator it = _system_outputs.begin (); it != _system_outputs.end (); ++it) {
1514 (*it)->update_connected_latency (false);
1517 for (std::vector<PamPort*>::const_iterator it = _system_midi_in.begin (); it != _system_midi_in.end (); ++it) {
1518 (*it)->update_connected_latency (true);
1520 for (std::vector<PamPort*>::const_iterator it = _system_midi_out.begin (); it != _system_midi_out.end (); ++it) {
1521 (*it)->update_connected_latency (false);
1526 PortAudioBackend::connect (const std::string& src, const std::string& dst)
1528 PamPort* src_port = find_port (src);
1529 PamPort* dst_port = find_port (dst);
1532 DEBUG_PORTS(string_compose("connect: Invalid Source port: (%1)\n", src));
1536 DEBUG_PORTS(string_compose("connect: Invalid Destination port: (%1)\n", dst));
1539 return src_port->connect (dst_port);
1543 PortAudioBackend::disconnect (const std::string& src, const std::string& dst)
1545 PamPort* src_port = find_port (src);
1546 PamPort* dst_port = find_port (dst);
1548 if (!src_port || !dst_port) {
1549 DEBUG_PORTS("disconnect: Invalid Port(s)\n");
1552 return src_port->disconnect (dst_port);
1556 PortAudioBackend::connect (PortEngine::PortHandle src, const std::string& dst)
1558 PamPort* dst_port = find_port (dst);
1559 if (!valid_port (src)) {
1560 DEBUG_PORTS("connect: Invalid Source Port Handle\n");
1564 DEBUG_PORTS(string_compose("connect: Invalid Destination Port (%1)\n", dst));
1567 return static_cast<PamPort*>(src)->connect (dst_port);
1571 PortAudioBackend::disconnect (PortEngine::PortHandle src, const std::string& dst)
1573 PamPort* dst_port = find_port (dst);
1574 if (!valid_port (src) || !dst_port) {
1575 DEBUG_PORTS("disconnect: Invalid Port(s)\n");
1578 return static_cast<PamPort*>(src)->disconnect (dst_port);
1582 PortAudioBackend::disconnect_all (PortEngine::PortHandle port)
1584 if (!valid_port (port)) {
1585 DEBUG_PORTS("disconnect_all: Invalid Port\n");
1588 static_cast<PamPort*>(port)->disconnect_all ();
1593 PortAudioBackend::connected (PortEngine::PortHandle port, bool /* process_callback_safe*/)
1595 if (!valid_port (port)) {
1596 DEBUG_PORTS("disconnect_all: Invalid Port\n");
1599 return static_cast<PamPort*>(port)->is_connected ();
1603 PortAudioBackend::connected_to (PortEngine::PortHandle src, const std::string& dst, bool /*process_callback_safe*/)
1605 PamPort* dst_port = find_port (dst);
1606 if (!valid_port (src) || !dst_port) {
1607 DEBUG_PORTS("connected_to: Invalid Port\n");
1610 return static_cast<PamPort*>(src)->is_connected (dst_port);
1614 PortAudioBackend::physically_connected (PortEngine::PortHandle port, bool /*process_callback_safe*/)
1616 if (!valid_port (port)) {
1617 DEBUG_PORTS("physically_connected: Invalid Port\n");
1620 return static_cast<PamPort*>(port)->is_physically_connected ();
1624 PortAudioBackend::get_connections (PortEngine::PortHandle port, std::vector<std::string>& names, bool /*process_callback_safe*/)
1626 if (!valid_port (port)) {
1627 DEBUG_PORTS("get_connections: Invalid Port\n");
1631 assert (0 == names.size ());
1633 const std::vector<PamPort*>& connected_ports = static_cast<PamPort*>(port)->get_connections ();
1635 for (std::vector<PamPort*>::const_iterator i = connected_ports.begin (); i != connected_ports.end (); ++i) {
1636 names.push_back ((*i)->name ());
1639 return (int)names.size ();
1644 PortAudioBackend::midi_event_get (
1645 pframes_t& timestamp,
1646 size_t& size, uint8_t const** buf, void* port_buffer,
1647 uint32_t event_index)
1649 if (!buf || !port_buffer) return -1;
1650 PortMidiBuffer& source = * static_cast<PortMidiBuffer*>(port_buffer);
1651 if (event_index >= source.size ()) {
1654 PortMidiEvent const& event = source[event_index];
1656 timestamp = event.timestamp ();
1657 size = event.size ();
1658 *buf = event.data ();
1663 PortAudioBackend::midi_event_put (
1665 pframes_t timestamp,
1666 const uint8_t* buffer, size_t size)
1668 if (!buffer || !port_buffer) return -1;
1669 PortMidiBuffer& dst = * static_cast<PortMidiBuffer*>(port_buffer);
1671 if (dst.size () && (pframes_t)dst.back ().timestamp () > timestamp) {
1672 // nevermind, ::get_buffer() sorts events
1673 DEBUG_MIDI (string_compose ("PortMidiBuffer: unordered event: %1 > %2\n",
1674 (pframes_t)dst.back ().timestamp (),
1678 dst.push_back (PortMidiEvent (timestamp, buffer, size));
1683 PortAudioBackend::get_midi_event_count (void* port_buffer)
1685 if (!port_buffer) return 0;
1686 return static_cast<PortMidiBuffer*>(port_buffer)->size ();
1690 PortAudioBackend::midi_clear (void* port_buffer)
1692 if (!port_buffer) return;
1693 PortMidiBuffer * buf = static_cast<PortMidiBuffer*>(port_buffer);
1701 PortAudioBackend::can_monitor_input () const
1707 PortAudioBackend::request_input_monitoring (PortEngine::PortHandle, bool)
1713 PortAudioBackend::ensure_input_monitoring (PortEngine::PortHandle, bool)
1719 PortAudioBackend::monitoring_input (PortEngine::PortHandle)
1724 /* Latency management */
1727 PortAudioBackend::set_latency_range (PortEngine::PortHandle port, bool for_playback, LatencyRange latency_range)
1729 if (!valid_port (port)) {
1730 DEBUG_PORTS("PamPort::set_latency_range (): invalid port.\n");
1732 static_cast<PamPort*>(port)->set_latency_range (latency_range, for_playback);
1736 PortAudioBackend::get_latency_range (PortEngine::PortHandle port, bool for_playback)
1739 if (!valid_port (port)) {
1740 DEBUG_PORTS("PamPort::get_latency_range (): invalid port.\n");
1745 PamPort* p = static_cast<PamPort*>(port);
1748 r = p->latency_range (for_playback);
1750 if (p->is_physical() && p->is_terminal() && p->type() == DataType::AUDIO) {
1751 if (p->is_input() && for_playback) {
1752 r.min += _samples_per_period;
1753 r.max += _samples_per_period;
1755 if (p->is_output() && !for_playback) {
1756 r.min += _samples_per_period;
1757 r.max += _samples_per_period;
1763 /* Discovering physical ports */
1766 PortAudioBackend::port_is_physical (PortEngine::PortHandle port) const
1768 if (!valid_port (port)) {
1769 DEBUG_PORTS("PamPort::port_is_physical (): invalid port.\n");
1772 return static_cast<PamPort*>(port)->is_physical ();
1776 PortAudioBackend::get_physical_outputs (DataType type, std::vector<std::string>& port_names)
1778 for (size_t i = 0; i < _ports.size (); ++i) {
1779 PamPort* port = _ports[i];
1780 if ((port->type () == type) && port->is_input () && port->is_physical ()) {
1781 port_names.push_back (port->name ());
1787 PortAudioBackend::get_physical_inputs (DataType type, std::vector<std::string>& port_names)
1789 for (size_t i = 0; i < _ports.size (); ++i) {
1790 PamPort* port = _ports[i];
1791 if ((port->type () == type) && port->is_output () && port->is_physical ()) {
1792 port_names.push_back (port->name ());
1798 PortAudioBackend::n_physical_outputs () const
1802 for (size_t i = 0; i < _ports.size (); ++i) {
1803 PamPort* port = _ports[i];
1804 if (port->is_output () && port->is_physical ()) {
1805 switch (port->type ()) {
1806 case DataType::AUDIO:
1809 case DataType::MIDI:
1818 cc.set (DataType::AUDIO, n_audio);
1819 cc.set (DataType::MIDI, n_midi);
1824 PortAudioBackend::n_physical_inputs () const
1828 for (size_t i = 0; i < _ports.size (); ++i) {
1829 PamPort* port = _ports[i];
1830 if (port->is_input () && port->is_physical ()) {
1831 switch (port->type ()) {
1832 case DataType::AUDIO:
1835 case DataType::MIDI:
1844 cc.set (DataType::AUDIO, n_audio);
1845 cc.set (DataType::MIDI, n_midi);
1849 /* Getting access to the data buffer for a port */
1852 PortAudioBackend::get_buffer (PortEngine::PortHandle port, pframes_t nframes)
1855 assert (valid_port (port));
1856 if (!port || !valid_port (port)) return NULL; // XXX remove me
1857 return static_cast<PamPort*>(port)->get_buffer (nframes);
1862 PortAudioBackend::blocking_process_thread ()
1864 AudioEngine::thread_init_callback (this);
1866 _processed_samples = 0;
1868 manager.registration_callback();
1869 manager.graph_order_callback();
1871 if (_pcmio->start_stream() != paNoError) {
1872 _pcmio->close_stream ();
1874 engine.halted_callback(get_error_string(AudioDeviceIOError).c_str());
1877 #ifdef USE_MMCSS_THREAD_PRIORITIES
1879 bool mmcss_success = set_mmcss_pro_audio (&task_handle);
1882 DWORD tid = GetCurrentThreadId ();
1883 DEBUG_THREADS (string_compose ("Process Thread Master ID: %1\n", tid));
1887 if (_freewheeling != _freewheel) {
1888 _freewheel = _freewheeling;
1889 engine.freewheel_callback (_freewheel);
1894 switch (_pcmio->next_cycle (_samples_per_period)) {
1898 DEBUG_AUDIO("PortAudio: Xrun\n");
1902 PBD::error << get_error_string(AudioDeviceIOError) << endmsg;
1906 if (!blocking_process_main(_pcmio->get_capture_buffer(),
1907 _pcmio->get_playback_buffer())) {
1912 if (!blocking_process_freewheel()) {
1917 process_port_connection_changes();
1919 _pcmio->close_stream();
1922 engine.halted_callback(get_error_string(AudioDeviceIOError).c_str());
1925 #ifdef USE_MMCSS_THREAD_PRIORITIES
1926 if (mmcss_success) {
1927 reset_mmcss(task_handle);
1935 PortAudioBackend::blocking_process_main(const float* interleaved_input_data,
1936 float* interleaved_output_data)
1939 int64_t min_elapsed_us = 1000000;
1940 int64_t max_elapsed_us = 0;
1942 _dsp_calc.set_start_timestamp_us (PBD::get_microseconds());
1945 /* Copy input audio data into input port buffers */
1946 for (std::vector<PamPort*>::const_iterator it = _system_inputs.begin();
1947 it != _system_inputs.end();
1949 assert(_system_inputs.size() == _pcmio->n_capture_channels());
1950 uint32_t channels = _system_inputs.size();
1951 float* input_port_buffer = (float*)(*it)->get_buffer(_samples_per_period);
1952 deinterleave_audio_data(
1953 interleaved_input_data, input_port_buffer, _samples_per_period, i, channels);
1956 process_incoming_midi ();
1958 /* clear output buffers */
1959 for (std::vector<PamPort*>::const_iterator it = _system_outputs.begin();
1960 it != _system_outputs.end();
1962 memset((*it)->get_buffer(_samples_per_period),
1964 _samples_per_period * sizeof(Sample));
1967 _last_cycle_start = _cycle_timer.get_start();
1968 _cycle_timer.reset_start(PBD::get_microseconds());
1971 uint64_t cycle_diff_us = (_cycle_timer.get_start() - _last_cycle_start);
1972 int64_t deviation_us = (cycle_diff_us - _cycle_timer.get_length_us());
1973 _total_deviation_us += ::llabs(deviation_us);
1975 std::max(_max_deviation_us, (uint64_t)::llabs(deviation_us));
1977 if ((_cycle_count % 1000) == 0) {
1978 uint64_t mean_deviation_us = _total_deviation_us / _cycle_count;
1979 DEBUG_TIMING(string_compose("Mean avg cycle deviation: %1(ms), max %2(ms)\n",
1980 mean_deviation_us * 1e-3,
1981 _max_deviation_us * 1e-3));
1984 if (::llabs(deviation_us) > _cycle_timer.get_length_us()) {
1986 string_compose("time between process(ms): %1, Est(ms): %2, Dev(ms): %3\n",
1987 cycle_diff_us * 1e-3,
1988 _cycle_timer.get_length_us() * 1e-3,
1989 deviation_us * 1e-3));
1992 /* call engine process callback */
1993 if (engine.process_callback(_samples_per_period)) {
1994 _pcmio->close_stream();
1999 process_outgoing_midi ();
2001 /* write back audio */
2003 for (std::vector<PamPort*>::const_iterator it = _system_outputs.begin();
2004 it != _system_outputs.end();
2006 assert(_system_outputs.size() == _pcmio->n_playback_channels());
2007 const uint32_t channels = _system_outputs.size();
2008 float* output_port_buffer = (float*)(*it)->get_buffer(_samples_per_period);
2009 interleave_audio_data(
2010 output_port_buffer, interleaved_output_data, _samples_per_period, i, channels);
2013 _processed_samples += _samples_per_period;
2015 /* calculate DSP load */
2016 _dsp_calc.set_stop_timestamp_us (PBD::get_microseconds());
2017 _dsp_load = _dsp_calc.get_dsp_load();
2019 DEBUG_TIMING(string_compose("DSP Load: %1\n", _dsp_load));
2021 max_elapsed_us = std::max(_dsp_calc.elapsed_time_us(), max_elapsed_us);
2022 min_elapsed_us = std::min(_dsp_calc.elapsed_time_us(), min_elapsed_us);
2023 if ((_cycle_count % 1000) == 0) {
2024 DEBUG_TIMING(string_compose("Elapsed process time(usecs) max: %1, min: %2\n",
2033 PortAudioBackend::blocking_process_freewheel()
2035 // zero audio input buffers
2036 for (std::vector<PamPort*>::const_iterator it = _system_inputs.begin();
2037 it != _system_inputs.end();
2039 memset((*it)->get_buffer(_samples_per_period),
2041 _samples_per_period * sizeof(Sample));
2044 // TODO clear midi or stop midi recv when entering fwheelin'
2046 if (engine.process_callback(_samples_per_period)) {
2047 _pcmio->close_stream();
2052 // drop all outgoing MIDI messages
2053 for (std::vector<PamPort*>::const_iterator it = _system_midi_out.begin();
2054 it != _system_midi_out.end();
2056 void* bptr = (*it)->get_buffer(0);
2061 Glib::usleep(100); // don't hog cpu
2066 PortAudioBackend::process_incoming_midi ()
2069 for (std::vector<PamPort*>::const_iterator it = _system_midi_in.begin();
2070 it != _system_midi_in.end();
2072 PortMidiBuffer* mbuf = static_cast<PortMidiBuffer*>((*it)->get_buffer(0));
2075 pframes_t sample_offset;
2076 uint8_t data[MaxWinMidiEventSize];
2077 size_t size = sizeof(data);
2078 while (_midiio->dequeue_input_event(i,
2079 _cycle_timer.get_start(),
2080 _cycle_timer.get_next_start(),
2084 sample_offset = _cycle_timer.samples_since_cycle_start(timestamp);
2085 midi_event_put(mbuf, sample_offset, data, size);
2086 DEBUG_MIDI(string_compose("Dequeuing incoming MIDI data for device: %1 "
2087 "sample_offset: %2 timestamp: %3, size: %4\n",
2088 _midiio->get_inputs()[i]->name(),
2092 size = sizeof(data);
2098 PortAudioBackend::process_outgoing_midi ()
2101 for (std::vector<PamPort*>::iterator it = _system_midi_out.begin();
2102 it != _system_midi_out.end();
2104 static_cast<PortMidiPort*>(*it)->next_period();
2106 /* queue outgoing midi */
2108 for (std::vector<PamPort*>::const_iterator it = _system_midi_out.begin();
2109 it != _system_midi_out.end();
2111 const PortMidiBuffer* src =
2112 static_cast<const PortMidiPort*>(*it)->const_buffer();
2114 for (PortMidiBuffer::const_iterator mit = src->begin(); mit != src->end();
2116 uint64_t timestamp =
2117 _cycle_timer.timestamp_from_sample_offset(mit->timestamp());
2118 DEBUG_MIDI(string_compose("Queuing outgoing MIDI data for device: "
2119 "%1 sample_offset: %2 timestamp: %3, size: %4\n",
2120 _midiio->get_outputs()[i]->name(),
2124 _midiio->enqueue_output_event(i, timestamp, mit->data(), mit->size());
2130 PortAudioBackend::process_port_connection_changes ()
2132 bool connections_changed = false;
2133 bool ports_changed = false;
2134 if (!pthread_mutex_trylock (&_port_callback_mutex)) {
2135 if (_port_change_flag) {
2136 ports_changed = true;
2137 _port_change_flag = false;
2139 if (!_port_connection_queue.empty ()) {
2140 connections_changed = true;
2142 while (!_port_connection_queue.empty ()) {
2143 PortConnectData *c = _port_connection_queue.back ();
2144 manager.connect_callback (c->a, c->b, c->c);
2145 _port_connection_queue.pop_back ();
2148 pthread_mutex_unlock (&_port_callback_mutex);
2150 if (ports_changed) {
2151 manager.registration_callback();
2153 if (connections_changed) {
2154 manager.graph_order_callback();
2156 if (connections_changed || ports_changed) {
2157 update_system_port_latecies ();
2158 engine.latency_callback(false);
2159 engine.latency_callback(true);
2163 /******************************************************************************/
2165 static boost::shared_ptr<PortAudioBackend> _instance;
2167 static boost::shared_ptr<AudioBackend> backend_factory (AudioEngine& e);
2168 static int instantiate (const std::string& arg1, const std::string& /* arg2 */);
2169 static int deinstantiate ();
2170 static bool already_configured ();
2171 static bool available ();
2173 static ARDOUR::AudioBackendInfo _descriptor = {
2182 static boost::shared_ptr<AudioBackend>
2183 backend_factory (AudioEngine& e)
2186 _instance.reset (new PortAudioBackend (e, _descriptor));
2192 instantiate (const std::string& arg1, const std::string& /* arg2 */)
2194 s_instance_name = arg1;
2206 already_configured ()
2217 extern "C" ARDOURBACKEND_API ARDOUR::AudioBackendInfo* descriptor ()
2219 return &_descriptor;
2223 /******************************************************************************/
2224 PamPort::PamPort (PortAudioBackend &b, const std::string& name, PortFlags flags)
2229 _capture_latency_range.min = 0;
2230 _capture_latency_range.max = 0;
2231 _playback_latency_range.min = 0;
2232 _playback_latency_range.max = 0;
2235 PamPort::~PamPort () {
2240 int PamPort::connect (PamPort *port)
2243 DEBUG_PORTS("PamPort::connect (): invalid (null) port\n");
2247 if (type () != port->type ()) {
2248 DEBUG_PORTS("PamPort::connect (): wrong port-type\n");
2252 if (is_output () && port->is_output ()) {
2253 DEBUG_PORTS("PamPort::connect (): cannot inter-connect output ports.\n");
2257 if (is_input () && port->is_input ()) {
2258 DEBUG_PORTS("PamPort::connect (): cannot inter-connect input ports.\n");
2263 DEBUG_PORTS("PamPort::connect (): cannot self-connect ports.\n");
2267 if (is_connected (port)) {
2268 #if 0 // don't bother to warn about this for now. just ignore it
2269 PBD::error << _("PamPort::connect (): ports are already connected:")
2270 << " (" << name () << ") -> (" << port->name () << ")"
2276 _connect (port, true);
2281 void PamPort::_connect (PamPort *port, bool callback)
2283 _connections.push_back (port);
2285 port->_connect (this, false);
2286 _osx_backend.port_connect_callback (name(), port->name(), true);
2290 int PamPort::disconnect (PamPort *port)
2293 DEBUG_PORTS("PamPort::disconnect (): invalid (null) port\n");
2297 if (!is_connected (port)) {
2298 DEBUG_PORTS(string_compose(
2299 "PamPort::disconnect (): ports are not connected: (%1) -> (%2)\n",
2304 _disconnect (port, true);
2308 void PamPort::_disconnect (PamPort *port, bool callback)
2310 std::vector<PamPort*>::iterator it = std::find (_connections.begin (), _connections.end (), port);
2312 assert (it != _connections.end ());
2314 _connections.erase (it);
2317 port->_disconnect (this, false);
2318 _osx_backend.port_connect_callback (name(), port->name(), false);
2323 void PamPort::disconnect_all ()
2325 while (!_connections.empty ()) {
2326 _connections.back ()->_disconnect (this, false);
2327 _osx_backend.port_connect_callback (name(), _connections.back ()->name(), false);
2328 _connections.pop_back ();
2333 PamPort::is_connected (const PamPort *port) const
2335 return std::find (_connections.begin (), _connections.end (), port) != _connections.end ();
2338 bool PamPort::is_physically_connected () const
2340 for (std::vector<PamPort*>::const_iterator it = _connections.begin (); it != _connections.end (); ++it) {
2341 if ((*it)->is_physical ()) {
2349 PamPort::set_latency_range (const LatencyRange &latency_range, bool for_playback)
2352 _playback_latency_range = latency_range;
2354 _capture_latency_range = latency_range;
2357 for (std::vector<PamPort*>::const_iterator it = _connections.begin (); it != _connections.end (); ++it) {
2358 if ((*it)->is_physical ()) {
2359 (*it)->update_connected_latency (is_input ());
2365 PamPort::update_connected_latency (bool for_playback)
2368 lr.min = lr.max = 0;
2369 for (std::vector<PamPort*>::const_iterator it = _connections.begin (); it != _connections.end (); ++it) {
2371 l = (*it)->latency_range (for_playback);
2372 lr.min = std::max (lr.min, l.min);
2373 lr.max = std::max (lr.max, l.max);
2375 set_latency_range (lr, for_playback);
2378 /******************************************************************************/
2380 PortAudioPort::PortAudioPort (PortAudioBackend &b, const std::string& name, PortFlags flags)
2381 : PamPort (b, name, flags)
2383 memset (_buffer, 0, sizeof (_buffer));
2384 #ifndef PLATFORM_WINDOWS
2385 mlock(_buffer, sizeof (_buffer));
2389 PortAudioPort::~PortAudioPort () { }
2391 void* PortAudioPort::get_buffer (pframes_t n_samples)
2394 std::vector<PamPort*>::const_iterator it = get_connections ().begin ();
2395 if (it == get_connections ().end ()) {
2396 memset (_buffer, 0, n_samples * sizeof (Sample));
2398 PortAudioPort const * source = static_cast<const PortAudioPort*>(*it);
2399 assert (source && source->is_output ());
2400 memcpy (_buffer, source->const_buffer (), n_samples * sizeof (Sample));
2401 while (++it != get_connections ().end ()) {
2402 source = static_cast<const PortAudioPort*>(*it);
2403 assert (source && source->is_output ());
2404 Sample* dst = buffer ();
2405 const Sample* src = source->const_buffer ();
2406 for (uint32_t s = 0; s < n_samples; ++s, ++dst, ++src) {
2416 PortMidiPort::PortMidiPort (PortAudioBackend &b, const std::string& name, PortFlags flags)
2417 : PamPort (b, name, flags)
2421 _buffer[0].clear ();
2422 _buffer[1].clear ();
2424 _buffer[0].reserve (256);
2425 _buffer[1].reserve (256);
2428 PortMidiPort::~PortMidiPort () { }
2430 struct MidiEventSorter {
2431 bool operator() (PortMidiEvent const& a, PortMidiEvent const& b) {
2436 void* PortMidiPort::get_buffer (pframes_t /* nframes */)
2439 (_buffer[_bufperiod]).clear ();
2440 for (std::vector<PamPort*>::const_iterator i = get_connections ().begin ();
2441 i != get_connections ().end ();
2443 const PortMidiBuffer * src = static_cast<const PortMidiPort*>(*i)->const_buffer ();
2444 for (PortMidiBuffer::const_iterator it = src->begin (); it != src->end (); ++it) {
2445 (_buffer[_bufperiod]).push_back (*it);
2448 std::stable_sort ((_buffer[_bufperiod]).begin (), (_buffer[_bufperiod]).end (), MidiEventSorter());
2450 return &(_buffer[_bufperiod]);
2453 PortMidiEvent::PortMidiEvent (const pframes_t timestamp, const uint8_t* data, size_t size)
2455 , _timestamp (timestamp)
2457 if (size > 0 && size < MaxWinMidiEventSize) {
2458 memcpy (_data, data, size);
2462 PortMidiEvent::PortMidiEvent (const PortMidiEvent& other)
2463 : _size (other.size ())
2464 , _timestamp (other.timestamp ())
2466 if (other._size > 0) {
2467 assert (other._size < MaxWinMidiEventSize);
2468 memcpy (_data, other._data, other._size);