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
29 #include "portaudio_backend.h"
30 #include "rt_thread.h"
32 #include "pbd/compose.h"
33 #include "pbd/error.h"
34 #include "pbd/file_utils.h"
35 #include "ardour/filesystem_paths.h"
36 #include "ardour/port_manager.h"
39 using namespace ARDOUR;
41 static std::string s_instance_name;
42 size_t PortAudioBackend::_max_buffer_size = 8192;
43 std::vector<std::string> PortAudioBackend::_midi_options;
44 std::vector<AudioBackend::DeviceStatus> PortAudioBackend::_input_audio_device_status;
45 std::vector<AudioBackend::DeviceStatus> PortAudioBackend::_output_audio_device_status;
47 PortAudioBackend::PortAudioBackend (AudioEngine& e, AudioBackendInfo& info)
48 : AudioBackend (e, info)
53 , _measure_latency (false)
54 , _last_process_start (0)
55 , _input_audio_device("")
56 , _output_audio_device("")
57 , _midi_driver_option(_("None"))
59 , _samples_per_period (1024)
62 , _systemic_audio_input_latency (0)
63 , _systemic_audio_output_latency (0)
65 , _processed_samples (0)
66 , _port_change_flag (false)
68 _instance_name = s_instance_name;
69 pthread_mutex_init (&_port_callback_mutex, 0);
71 _pcmio = new PortAudioIO ();
74 PortAudioBackend::~PortAudioBackend ()
76 delete _pcmio; _pcmio = 0;
77 pthread_mutex_destroy (&_port_callback_mutex);
80 /* AUDIOBACKEND API */
83 PortAudioBackend::name () const
85 return X_("PortAudio");
89 PortAudioBackend::is_realtime () const
95 PortAudioBackend::requires_driver_selection() const
97 // we could do this but implementation would need changing
99 if (enumerate_drivers().size() == 1) {
106 std::vector<std::string>
107 PortAudioBackend::enumerate_drivers () const
109 std::vector<std::string> currently_available;
110 _pcmio->host_api_list (currently_available);
111 return currently_available;
115 PortAudioBackend::set_driver (const std::string& name)
117 _pcmio->set_host_api (name);
122 PortAudioBackend::use_separate_input_and_output_devices () const
127 std::vector<AudioBackend::DeviceStatus>
128 PortAudioBackend::enumerate_devices () const
130 return std::vector<AudioBackend::DeviceStatus>();
133 std::vector<AudioBackend::DeviceStatus>
134 PortAudioBackend::enumerate_input_devices () const
137 _input_audio_device_status.clear();
138 std::map<int, std::string> input_devices;
139 _pcmio->input_device_list(input_devices);
141 for (std::map<int, std::string>::const_iterator i = input_devices.begin (); i != input_devices.end(); ++i) {
142 if (_input_audio_device == "") _input_audio_device = i->second;
143 _input_audio_device_status.push_back (DeviceStatus (i->second, true));
145 return _input_audio_device_status;
148 std::vector<AudioBackend::DeviceStatus>
149 PortAudioBackend::enumerate_output_devices () const
152 _output_audio_device_status.clear();
153 std::map<int, std::string> output_devices;
154 _pcmio->output_device_list(output_devices);
156 for (std::map<int, std::string>::const_iterator i = output_devices.begin (); i != output_devices.end(); ++i) {
157 if (_output_audio_device == "") _output_audio_device = i->second;
158 _output_audio_device_status.push_back (DeviceStatus (i->second, true));
160 return _output_audio_device_status;
164 PortAudioBackend::available_sample_rates (const std::string&) const
166 std::vector<float> sr;
167 _pcmio->available_sample_rates(name_to_id(_input_audio_device), sr);
171 std::vector<uint32_t>
172 PortAudioBackend::available_buffer_sizes (const std::string&) const
174 std::vector<uint32_t> bs;
175 _pcmio->available_buffer_sizes(name_to_id(_input_audio_device), bs);
180 PortAudioBackend::available_input_channel_count (const std::string&) const
182 return 128; // TODO query current device
186 PortAudioBackend::available_output_channel_count (const std::string&) const
188 return 128; // TODO query current device
192 PortAudioBackend::can_change_sample_rate_when_running () const
198 PortAudioBackend::can_change_buffer_size_when_running () const
200 return false; // TODO
204 PortAudioBackend::set_device_name (const std::string& d)
210 PortAudioBackend::set_input_device_name (const std::string& d)
212 _input_audio_device = d;
217 PortAudioBackend::set_output_device_name (const std::string& d)
219 _output_audio_device = d;
224 PortAudioBackend::set_sample_rate (float sr)
226 if (sr <= 0) { return -1; }
227 // TODO check if it's in the list of valid SR
229 engine.sample_rate_change (sr);
234 PortAudioBackend::set_buffer_size (uint32_t bs)
236 if (bs <= 0 || bs >= _max_buffer_size) {
239 _samples_per_period = bs;
240 engine.buffer_size_change (bs);
245 PortAudioBackend::set_interleaved (bool yn)
247 if (!yn) { return 0; }
252 PortAudioBackend::set_input_channels (uint32_t cc)
259 PortAudioBackend::set_output_channels (uint32_t cc)
266 PortAudioBackend::set_systemic_input_latency (uint32_t sl)
268 _systemic_audio_input_latency = sl;
273 PortAudioBackend::set_systemic_output_latency (uint32_t sl)
275 _systemic_audio_output_latency = sl;
279 /* Retrieving parameters */
281 PortAudioBackend::device_name () const
287 PortAudioBackend::input_device_name () const
289 return _input_audio_device;
293 PortAudioBackend::output_device_name () const
295 return _output_audio_device;
299 PortAudioBackend::sample_rate () const
305 PortAudioBackend::buffer_size () const
307 return _samples_per_period;
311 PortAudioBackend::interleaved () const
317 PortAudioBackend::input_channels () const
323 PortAudioBackend::output_channels () const
329 PortAudioBackend::systemic_input_latency () const
331 return _systemic_audio_input_latency;
335 PortAudioBackend::systemic_output_latency () const
337 return _systemic_audio_output_latency;
342 std::vector<std::string>
343 PortAudioBackend::enumerate_midi_options () const
345 if (_midi_options.empty()) {
346 //_midi_options.push_back (_("PortMidi"));
347 _midi_options.push_back (_("None"));
349 return _midi_options;
353 PortAudioBackend::set_midi_option (const std::string& opt)
355 if (opt != _("None") /* && opt != _("PortMidi")*/) {
358 _midi_driver_option = opt;
363 PortAudioBackend::midi_option () const
365 return _midi_driver_option;
370 static void * pthread_process (void *arg)
372 PortAudioBackend *d = static_cast<PortAudioBackend *>(arg);
373 d->main_process_thread ();
379 PortAudioBackend::_start (bool for_latency_measurement)
381 if (!_active && _run) {
382 // recover from 'halted', reap threads
386 if (_active || _run) {
387 PBD::error << _("PortAudioBackend: already active.") << endmsg;
392 PBD::warning << _("PortAudioBackend: recovering from unclean shutdown, port registry is not empty.") << endmsg;
393 _system_inputs.clear();
394 _system_outputs.clear();
395 _system_midi_in.clear();
396 _system_midi_out.clear();
400 /* reset internal state */
402 _freewheeling = false;
404 _last_process_start = 0;
406 _pcmio->pcm_setup (name_to_id(_input_audio_device), name_to_id(_output_audio_device), _samplerate, _samples_per_period);
408 switch (_pcmio->state ()) {
409 case 0: /* OK */ break;
410 case -1: PBD::error << _("PortAudioBackend: failed to open device.") << endmsg; break;
411 default: PBD::error << _("PortAudioBackend: initialization failed.") << endmsg; break;
413 if (_pcmio->state ()) {
417 if (_n_outputs != _pcmio->n_playback_channels ()) {
418 _n_outputs = _pcmio->n_playback_channels ();
419 PBD::info << _("PortAudioBackend: adjusted output channel count to match device.") << endmsg;
422 if (_n_inputs != _pcmio->n_capture_channels ()) {
423 _n_inputs = _pcmio->n_capture_channels ();
424 PBD::info << _("PortAudioBackend: adjusted input channel count to match device.") << endmsg;
427 if (_pcmio->samples_per_period() != _samples_per_period) {
428 _samples_per_period = _pcmio->samples_per_period();
429 PBD::warning << _("PortAudioBackend: samples per period does not match.") << endmsg;
433 if (_pcmio->sample_rate() != _samplerate) {
434 _samplerate = _pcmio->sample_rate();
435 engine.sample_rate_change (_samplerate);
436 PBD::warning << _("PortAudioBackend: sample rate does not match.") << endmsg;
439 _measure_latency = for_latency_measurement;
442 _port_change_flag = false;
446 if (register_system_audio_ports()) {
447 PBD::error << _("PortAudioBackend: failed to register system ports.") << endmsg;
452 engine.sample_rate_change (_samplerate);
453 engine.buffer_size_change (_samples_per_period);
455 if (engine.reestablish_ports ()) {
456 PBD::error << _("PortAudioBackend: Could not re-establish ports.") << endmsg;
461 engine.reconnect_ports ();
463 _port_change_flag = false;
465 if (_realtime_pthread_create (SCHED_FIFO, -20, 100000,
466 &_main_thread, pthread_process, this))
468 if (pthread_create (&_main_thread, NULL, pthread_process, this))
470 PBD::error << _("PortAudioBackend: failed to create process thread.") << endmsg;
474 PBD::warning << _("PortAudioBackend: cannot acquire realtime permissions.") << endmsg;
479 while (!_active && --timeout > 0) { Glib::usleep (1000); }
481 if (timeout == 0 || !_active) {
482 PBD::error << _("PortAudioBackend: failed to start.") << endmsg;
494 PortAudioBackend::stop ()
502 if (pthread_join (_main_thread, &status)) {
503 PBD::error << _("PortAudioBackend: failed to terminate.") << endmsg;
510 return (_active == false) ? 0 : -1;
514 PortAudioBackend::freewheel (bool onoff)
516 if (onoff == _freewheeling) {
519 _freewheeling = onoff;
524 PortAudioBackend::dsp_load () const
526 return 100.f * _dsp_load;
530 PortAudioBackend::raw_buffer_size (DataType t)
533 case DataType::AUDIO:
534 return _samples_per_period * sizeof(Sample);
536 return _max_buffer_size; // XXX not really limited
543 PortAudioBackend::sample_time ()
545 return _processed_samples;
549 PortAudioBackend::sample_time_at_cycle_start ()
551 return _processed_samples;
555 PortAudioBackend::samples_since_cycle_start ()
557 if (!_active || !_run || _freewheeling || _freewheel) {
560 if (_last_process_start == 0) {
564 const int64_t elapsed_time_us = g_get_monotonic_time() - _last_process_start;
565 return std::max((pframes_t)0, (pframes_t)rint(1e-6 * elapsed_time_us * _samplerate));
569 PortAudioBackend::name_to_id(std::string device_name) const {
570 uint32_t device_id = UINT32_MAX;
571 std::map<int, std::string> devices;
572 _pcmio->input_device_list(devices);
573 _pcmio->output_device_list(devices);
575 for (std::map<int, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
576 if (i->second == device_name) {
577 device_id = i->first;
585 PortAudioBackend::portaudio_process_thread (void *arg)
587 ThreadData* td = reinterpret_cast<ThreadData*> (arg);
588 boost::function<void ()> f = td->f;
595 PortAudioBackend::create_process_thread (boost::function<void()> func)
599 size_t stacksize = 100000;
601 ThreadData* td = new ThreadData (this, func, stacksize);
603 if (_realtime_pthread_create (SCHED_FIFO, -21, stacksize,
604 &thread_id, portaudio_process_thread, td)) {
605 pthread_attr_init (&attr);
606 pthread_attr_setstacksize (&attr, stacksize);
607 if (pthread_create (&thread_id, &attr, portaudio_process_thread, td)) {
608 PBD::error << _("AudioEngine: cannot create process thread.") << endmsg;
609 pthread_attr_destroy (&attr);
612 pthread_attr_destroy (&attr);
615 _threads.push_back (thread_id);
620 PortAudioBackend::join_process_threads ()
624 for (std::vector<pthread_t>::const_iterator i = _threads.begin (); i != _threads.end (); ++i)
627 if (pthread_join (*i, &status)) {
628 PBD::error << _("AudioEngine: cannot terminate process thread.") << endmsg;
637 PortAudioBackend::in_process_thread ()
639 if (pthread_equal (_main_thread, pthread_self()) != 0) {
643 for (std::vector<pthread_t>::const_iterator i = _threads.begin (); i != _threads.end (); ++i)
645 if (pthread_equal (*i, pthread_self ()) != 0) {
653 PortAudioBackend::process_thread_count ()
655 return _threads.size ();
659 PortAudioBackend::update_latencies ()
661 // trigger latency callback in RT thread (locked graph)
662 port_connect_add_remove_callback();
668 PortAudioBackend::private_handle () const
674 PortAudioBackend::my_name () const
676 return _instance_name;
680 PortAudioBackend::available () const
682 return _run && _active;
686 PortAudioBackend::port_name_size () const
692 PortAudioBackend::set_port_name (PortEngine::PortHandle port, const std::string& name)
694 if (!valid_port (port)) {
695 PBD::error << _("PortAudioBackend::set_port_name: Invalid Port(s)") << endmsg;
698 return static_cast<PamPort*>(port)->set_name (_instance_name + ":" + name);
702 PortAudioBackend::get_port_name (PortEngine::PortHandle port) const
704 if (!valid_port (port)) {
705 PBD::error << _("PortAudioBackend::get_port_name: Invalid Port(s)") << endmsg;
706 return std::string ();
708 return static_cast<PamPort*>(port)->name ();
711 PortEngine::PortHandle
712 PortAudioBackend::get_port_by_name (const std::string& name) const
714 PortHandle port = (PortHandle) find_port (name);
719 PortAudioBackend::get_ports (
720 const std::string& port_name_pattern,
721 DataType type, PortFlags flags,
722 std::vector<std::string>& port_names) const
726 bool use_regexp = false;
727 if (port_name_pattern.size () > 0) {
728 if (!regcomp (&port_regex, port_name_pattern.c_str (), REG_EXTENDED|REG_NOSUB)) {
732 for (size_t i = 0; i < _ports.size (); ++i) {
733 PamPort* port = _ports[i];
734 if ((port->type () == type) && flags == (port->flags () & flags)) {
735 if (!use_regexp || !regexec (&port_regex, port->name ().c_str (), 0, NULL, 0)) {
736 port_names.push_back (port->name ());
742 regfree (&port_regex);
748 PortAudioBackend::port_data_type (PortEngine::PortHandle port) const
750 if (!valid_port (port)) {
751 return DataType::NIL;
753 return static_cast<PamPort*>(port)->type ();
756 PortEngine::PortHandle
757 PortAudioBackend::register_port (
758 const std::string& name,
759 ARDOUR::DataType type,
760 ARDOUR::PortFlags flags)
762 if (name.size () == 0) { return 0; }
763 if (flags & IsPhysical) { return 0; }
764 return add_port (_instance_name + ":" + name, type, flags);
767 PortEngine::PortHandle
768 PortAudioBackend::add_port (
769 const std::string& name,
770 ARDOUR::DataType type,
771 ARDOUR::PortFlags flags)
773 assert(name.size ());
774 if (find_port (name)) {
775 PBD::error << _("PortAudioBackend::register_port: Port already exists:")
776 << " (" << name << ")" << endmsg;
779 PamPort* port = NULL;
781 case DataType::AUDIO:
782 port = new PortAudioPort (*this, name, flags);
785 port = new PortMidiPort (*this, name, flags);
788 PBD::error << _("PortAudioBackend::register_port: Invalid Data Type.") << endmsg;
792 _ports.push_back (port);
798 PortAudioBackend::unregister_port (PortEngine::PortHandle port_handle)
803 PamPort* port = static_cast<PamPort*>(port_handle);
804 std::vector<PamPort*>::iterator i = std::find (_ports.begin (), _ports.end (), static_cast<PamPort*>(port_handle));
805 if (i == _ports.end ()) {
806 PBD::error << _("PortAudioBackend::unregister_port: Failed to find port") << endmsg;
809 disconnect_all(port_handle);
815 PortAudioBackend::register_system_audio_ports()
819 const uint32_t a_ins = _n_inputs;
820 const uint32_t a_out = _n_outputs;
822 // XXX PA reported stream latencies don't match measurements
823 const uint32_t portaudio_reported_input_latency = _samples_per_period ; // _pcmio->capture_latency();
824 const uint32_t portaudio_reported_output_latency = /* _samples_per_period + */ _pcmio->playback_latency();
827 lr.min = lr.max = portaudio_reported_input_latency + (_measure_latency ? 0 : _systemic_audio_input_latency);
828 for (uint32_t i = 0; i < a_ins; ++i) {
830 snprintf(tmp, sizeof(tmp), "system:capture_%d", i+1);
831 PortHandle p = add_port(std::string(tmp), DataType::AUDIO, static_cast<PortFlags>(IsOutput | IsPhysical | IsTerminal));
833 set_latency_range (p, false, lr);
834 _system_inputs.push_back(static_cast<PortAudioPort*>(p));
837 lr.min = lr.max = portaudio_reported_output_latency + (_measure_latency ? 0 : _systemic_audio_output_latency);
838 for (uint32_t i = 0; i < a_out; ++i) {
840 snprintf(tmp, sizeof(tmp), "system:playback_%d", i+1);
841 PortHandle p = add_port(std::string(tmp), DataType::AUDIO, static_cast<PortFlags>(IsInput | IsPhysical | IsTerminal));
843 set_latency_range (p, true, lr);
844 _system_outputs.push_back(static_cast<PamPort*>(p));
850 PortAudioBackend::unregister_ports (bool system_only)
853 _system_inputs.clear();
854 _system_outputs.clear();
855 _system_midi_in.clear();
856 _system_midi_out.clear();
857 while (i < _ports.size ()) {
858 PamPort* port = _ports[i];
859 if (! system_only || (port->is_physical () && port->is_terminal ())) {
860 port->disconnect_all ();
862 _ports.erase (_ports.begin() + i);
870 PortAudioBackend::connect (const std::string& src, const std::string& dst)
872 PamPort* src_port = find_port (src);
873 PamPort* dst_port = find_port (dst);
876 PBD::error << _("PortAudioBackend::connect: Invalid Source port:")
877 << " (" << src <<")" << endmsg;
881 PBD::error << _("PortAudioBackend::connect: Invalid Destination port:")
882 << " (" << dst <<")" << endmsg;
885 return src_port->connect (dst_port);
889 PortAudioBackend::disconnect (const std::string& src, const std::string& dst)
891 PamPort* src_port = find_port (src);
892 PamPort* dst_port = find_port (dst);
894 if (!src_port || !dst_port) {
895 PBD::error << _("PortAudioBackend::disconnect: Invalid Port(s)") << endmsg;
898 return src_port->disconnect (dst_port);
902 PortAudioBackend::connect (PortEngine::PortHandle src, const std::string& dst)
904 PamPort* dst_port = find_port (dst);
905 if (!valid_port (src)) {
906 PBD::error << _("PortAudioBackend::connect: Invalid Source Port Handle") << endmsg;
910 PBD::error << _("PortAudioBackend::connect: Invalid Destination Port")
911 << " (" << dst << ")" << endmsg;
914 return static_cast<PamPort*>(src)->connect (dst_port);
918 PortAudioBackend::disconnect (PortEngine::PortHandle src, const std::string& dst)
920 PamPort* dst_port = find_port (dst);
921 if (!valid_port (src) || !dst_port) {
922 PBD::error << _("PortAudioBackend::disconnect: Invalid Port(s)") << endmsg;
925 return static_cast<PamPort*>(src)->disconnect (dst_port);
929 PortAudioBackend::disconnect_all (PortEngine::PortHandle port)
931 if (!valid_port (port)) {
932 PBD::error << _("PortAudioBackend::disconnect_all: Invalid Port") << endmsg;
935 static_cast<PamPort*>(port)->disconnect_all ();
940 PortAudioBackend::connected (PortEngine::PortHandle port, bool /* process_callback_safe*/)
942 if (!valid_port (port)) {
943 PBD::error << _("PortAudioBackend::disconnect_all: Invalid Port") << endmsg;
946 return static_cast<PamPort*>(port)->is_connected ();
950 PortAudioBackend::connected_to (PortEngine::PortHandle src, const std::string& dst, bool /*process_callback_safe*/)
952 PamPort* dst_port = find_port (dst);
953 if (!valid_port (src) || !dst_port) {
954 PBD::error << _("PortAudioBackend::connected_to: Invalid Port") << endmsg;
957 return static_cast<PamPort*>(src)->is_connected (dst_port);
961 PortAudioBackend::physically_connected (PortEngine::PortHandle port, bool /*process_callback_safe*/)
963 if (!valid_port (port)) {
964 PBD::error << _("PortAudioBackend::physically_connected: Invalid Port") << endmsg;
967 return static_cast<PamPort*>(port)->is_physically_connected ();
971 PortAudioBackend::get_connections (PortEngine::PortHandle port, std::vector<std::string>& names, bool /*process_callback_safe*/)
973 if (!valid_port (port)) {
974 PBD::error << _("PortAudioBackend::get_connections: Invalid Port") << endmsg;
978 assert (0 == names.size ());
980 const std::vector<PamPort*>& connected_ports = static_cast<PamPort*>(port)->get_connections ();
982 for (std::vector<PamPort*>::const_iterator i = connected_ports.begin (); i != connected_ports.end (); ++i) {
983 names.push_back ((*i)->name ());
986 return (int)names.size ();
991 PortAudioBackend::midi_event_get (
992 pframes_t& timestamp,
993 size_t& size, uint8_t** buf, void* port_buffer,
994 uint32_t event_index)
996 if (!buf || !port_buffer) return -1;
997 PortMidiBuffer& source = * static_cast<PortMidiBuffer*>(port_buffer);
998 if (event_index >= source.size ()) {
1001 PortMidiEvent * const event = source[event_index].get ();
1003 timestamp = event->timestamp ();
1004 size = event->size ();
1005 *buf = event->data ();
1010 PortAudioBackend::midi_event_put (
1012 pframes_t timestamp,
1013 const uint8_t* buffer, size_t size)
1015 if (!buffer || !port_buffer) return -1;
1016 PortMidiBuffer& dst = * static_cast<PortMidiBuffer*>(port_buffer);
1017 if (dst.size () && (pframes_t)dst.back ()->timestamp () > timestamp) {
1019 // nevermind, ::get_buffer() sorts events
1020 fprintf (stderr, "PortMidiBuffer: unordered event: %d > %d\n",
1021 (pframes_t)dst.back ()->timestamp (), timestamp);
1024 dst.push_back (boost::shared_ptr<PortMidiEvent>(new PortMidiEvent (timestamp, buffer, size)));
1029 PortAudioBackend::get_midi_event_count (void* port_buffer)
1031 if (!port_buffer) return 0;
1032 return static_cast<PortMidiBuffer*>(port_buffer)->size ();
1036 PortAudioBackend::midi_clear (void* port_buffer)
1038 if (!port_buffer) return;
1039 PortMidiBuffer * buf = static_cast<PortMidiBuffer*>(port_buffer);
1047 PortAudioBackend::can_monitor_input () const
1053 PortAudioBackend::request_input_monitoring (PortEngine::PortHandle, bool)
1059 PortAudioBackend::ensure_input_monitoring (PortEngine::PortHandle, bool)
1065 PortAudioBackend::monitoring_input (PortEngine::PortHandle)
1070 /* Latency management */
1073 PortAudioBackend::set_latency_range (PortEngine::PortHandle port, bool for_playback, LatencyRange latency_range)
1075 if (!valid_port (port)) {
1076 PBD::error << _("PamPort::set_latency_range (): invalid port.") << endmsg;
1078 static_cast<PamPort*>(port)->set_latency_range (latency_range, for_playback);
1082 PortAudioBackend::get_latency_range (PortEngine::PortHandle port, bool for_playback)
1085 if (!valid_port (port)) {
1086 PBD::error << _("PamPort::get_latency_range (): invalid port.") << endmsg;
1091 PamPort* p = static_cast<PamPort*>(port);
1094 r = p->latency_range (for_playback);
1096 if (p->is_physical() && p->is_terminal() && p->type() == DataType::AUDIO) {
1097 if (p->is_input() && for_playback) {
1098 r.min += _samples_per_period;
1099 r.max += _samples_per_period;
1101 if (p->is_output() && !for_playback) {
1102 r.min += _samples_per_period;
1103 r.max += _samples_per_period;
1109 /* Discovering physical ports */
1112 PortAudioBackend::port_is_physical (PortEngine::PortHandle port) const
1114 if (!valid_port (port)) {
1115 PBD::error << _("PamPort::port_is_physical (): invalid port.") << endmsg;
1118 return static_cast<PamPort*>(port)->is_physical ();
1122 PortAudioBackend::get_physical_outputs (DataType type, std::vector<std::string>& port_names)
1124 for (size_t i = 0; i < _ports.size (); ++i) {
1125 PamPort* port = _ports[i];
1126 if ((port->type () == type) && port->is_input () && port->is_physical ()) {
1127 port_names.push_back (port->name ());
1133 PortAudioBackend::get_physical_inputs (DataType type, std::vector<std::string>& port_names)
1135 for (size_t i = 0; i < _ports.size (); ++i) {
1136 PamPort* port = _ports[i];
1137 if ((port->type () == type) && port->is_output () && port->is_physical ()) {
1138 port_names.push_back (port->name ());
1144 PortAudioBackend::n_physical_outputs () const
1148 for (size_t i = 0; i < _ports.size (); ++i) {
1149 PamPort* port = _ports[i];
1150 if (port->is_output () && port->is_physical ()) {
1151 switch (port->type ()) {
1152 case DataType::AUDIO: ++n_audio; break;
1153 case DataType::MIDI: ++n_midi; break;
1159 cc.set (DataType::AUDIO, n_audio);
1160 cc.set (DataType::MIDI, n_midi);
1165 PortAudioBackend::n_physical_inputs () const
1169 for (size_t i = 0; i < _ports.size (); ++i) {
1170 PamPort* port = _ports[i];
1171 if (port->is_input () && port->is_physical ()) {
1172 switch (port->type ()) {
1173 case DataType::AUDIO: ++n_audio; break;
1174 case DataType::MIDI: ++n_midi; break;
1180 cc.set (DataType::AUDIO, n_audio);
1181 cc.set (DataType::MIDI, n_midi);
1185 /* Getting access to the data buffer for a port */
1188 PortAudioBackend::get_buffer (PortEngine::PortHandle port, pframes_t nframes)
1190 if (!port || !valid_port (port)) return NULL;
1191 return static_cast<PamPort*>(port)->get_buffer (nframes);
1196 PortAudioBackend::main_process_thread ()
1198 AudioEngine::thread_init_callback (this);
1200 _processed_samples = 0;
1202 uint64_t clock1, clock2;
1203 const int64_t nomial_time = 1e6 * _samples_per_period / _samplerate;
1205 manager.registration_callback();
1206 manager.graph_order_callback();
1208 if (_pcmio->pcm_start()) {
1209 _pcmio->pcm_stop ();
1211 engine.halted_callback("PortAudio I/O error.");
1216 if (_freewheeling != _freewheel) {
1217 _freewheel = _freewheeling;
1218 engine.freewheel_callback (_freewheel);
1223 switch (_pcmio->next_cycle (_samples_per_period)) {
1228 printf("PortAudio: Xrun\n");
1233 PBD::error << _("PortAudioBackend: I/O error. Audio Process Terminated.") << endmsg;
1238 clock1 = g_get_monotonic_time();
1242 for (std::vector<PamPort*>::const_iterator it = _system_inputs.begin (); it != _system_inputs.end (); ++it, ++i) {
1243 _pcmio->get_capture_channel (i, (float*)((*it)->get_buffer(_samples_per_period)), _samples_per_period);
1246 /* de-queue incoming midi*/
1248 for (std::vector<PamPort*>::const_iterator it = _system_midi_in.begin (); it != _system_midi_in.end (); ++it, ++i) {
1249 PortMidiBuffer* mbuf = static_cast<PortMidiBuffer*>((*it)->get_buffer(0));
1253 /* clear output buffers */
1254 for (std::vector<PamPort*>::const_iterator it = _system_outputs.begin (); it != _system_outputs.end (); ++it) {
1255 memset ((*it)->get_buffer (_samples_per_period), 0, _samples_per_period * sizeof (Sample));
1258 /* call engine process callback */
1259 _last_process_start = g_get_monotonic_time();
1260 if (engine.process_callback (_samples_per_period)) {
1261 _pcmio->pcm_stop ();
1267 for (std::vector<PamPort*>::iterator it = _system_midi_out.begin (); it != _system_midi_out.end (); ++it) {
1268 static_cast<PortBackendMidiPort*>(*it)->next_period();
1271 /* queue outgoing midi */
1273 for (std::vector<PamPort*>::const_iterator it = _system_midi_out.begin (); it != _system_midi_out.end (); ++it, ++i) {
1278 /* write back audio */
1280 for (std::vector<PamPort*>::const_iterator it = _system_outputs.begin (); it != _system_outputs.end (); ++it, ++i) {
1281 _pcmio->set_playback_channel (i, (float const*)(*it)->get_buffer (_samples_per_period), _samples_per_period);
1284 _processed_samples += _samples_per_period;
1286 /* calculate DSP load */
1287 clock2 = g_get_monotonic_time();
1288 const int64_t elapsed_time = clock2 - clock1;
1289 _dsp_load = elapsed_time / (float) nomial_time;
1294 // zero audio input buffers
1295 for (std::vector<PamPort*>::const_iterator it = _system_inputs.begin (); it != _system_inputs.end (); ++it) {
1296 memset ((*it)->get_buffer (_samples_per_period), 0, _samples_per_period * sizeof (Sample));
1299 clock1 = g_get_monotonic_time();
1301 // TODO clear midi or stop midi recv when entering fwheelin'
1303 _last_process_start = 0;
1304 if (engine.process_callback (_samples_per_period)) {
1305 _pcmio->pcm_stop ();
1310 // drop all outgoing MIDI messages
1311 for (std::vector<PamPort*>::const_iterator it = _system_midi_out.begin (); it != _system_midi_out.end (); ++it) {
1312 void *bptr = (*it)->get_buffer(0);
1317 Glib::usleep (100); // don't hog cpu
1320 bool connections_changed = false;
1321 bool ports_changed = false;
1322 if (!pthread_mutex_trylock (&_port_callback_mutex)) {
1323 if (_port_change_flag) {
1324 ports_changed = true;
1325 _port_change_flag = false;
1327 if (!_port_connection_queue.empty ()) {
1328 connections_changed = true;
1330 while (!_port_connection_queue.empty ()) {
1331 PortConnectData *c = _port_connection_queue.back ();
1332 manager.connect_callback (c->a, c->b, c->c);
1333 _port_connection_queue.pop_back ();
1336 pthread_mutex_unlock (&_port_callback_mutex);
1338 if (ports_changed) {
1339 manager.registration_callback();
1341 if (connections_changed) {
1342 manager.graph_order_callback();
1344 if (connections_changed || ports_changed) {
1345 engine.latency_callback(false);
1346 engine.latency_callback(true);
1350 _pcmio->pcm_stop ();
1353 engine.halted_callback("PortAudio I/O error.");
1359 /******************************************************************************/
1361 static boost::shared_ptr<PortAudioBackend> _instance;
1363 static boost::shared_ptr<AudioBackend> backend_factory (AudioEngine& e);
1364 static int instantiate (const std::string& arg1, const std::string& /* arg2 */);
1365 static int deinstantiate ();
1366 static bool already_configured ();
1367 static bool available ();
1369 static ARDOUR::AudioBackendInfo _descriptor = {
1378 static boost::shared_ptr<AudioBackend>
1379 backend_factory (AudioEngine& e)
1382 _instance.reset (new PortAudioBackend (e, _descriptor));
1388 instantiate (const std::string& arg1, const std::string& /* arg2 */)
1390 s_instance_name = arg1;
1402 already_configured ()
1413 extern "C" ARDOURBACKEND_API ARDOUR::AudioBackendInfo* descriptor ()
1415 return &_descriptor;
1419 /******************************************************************************/
1420 PamPort::PamPort (PortAudioBackend &b, const std::string& name, PortFlags flags)
1425 _capture_latency_range.min = 0;
1426 _capture_latency_range.max = 0;
1427 _playback_latency_range.min = 0;
1428 _playback_latency_range.max = 0;
1431 PamPort::~PamPort () {
1436 int PamPort::connect (PamPort *port)
1439 PBD::error << _("PamPort::connect (): invalid (null) port") << endmsg;
1443 if (type () != port->type ()) {
1444 PBD::error << _("PamPort::connect (): wrong port-type") << endmsg;
1448 if (is_output () && port->is_output ()) {
1449 PBD::error << _("PamPort::connect (): cannot inter-connect output ports.") << endmsg;
1453 if (is_input () && port->is_input ()) {
1454 PBD::error << _("PamPort::connect (): cannot inter-connect input ports.") << endmsg;
1459 PBD::error << _("PamPort::connect (): cannot self-connect ports.") << endmsg;
1463 if (is_connected (port)) {
1464 #if 0 // don't bother to warn about this for now. just ignore it
1465 PBD::error << _("PamPort::connect (): ports are already connected:")
1466 << " (" << name () << ") -> (" << port->name () << ")"
1472 _connect (port, true);
1477 void PamPort::_connect (PamPort *port, bool callback)
1479 _connections.push_back (port);
1481 port->_connect (this, false);
1482 _osx_backend.port_connect_callback (name(), port->name(), true);
1486 int PamPort::disconnect (PamPort *port)
1489 PBD::error << _("PamPort::disconnect (): invalid (null) port") << endmsg;
1493 if (!is_connected (port)) {
1494 PBD::error << _("PamPort::disconnect (): ports are not connected:")
1495 << " (" << name () << ") -> (" << port->name () << ")"
1499 _disconnect (port, true);
1503 void PamPort::_disconnect (PamPort *port, bool callback)
1505 std::vector<PamPort*>::iterator it = std::find (_connections.begin (), _connections.end (), port);
1507 assert (it != _connections.end ());
1509 _connections.erase (it);
1512 port->_disconnect (this, false);
1513 _osx_backend.port_connect_callback (name(), port->name(), false);
1518 void PamPort::disconnect_all ()
1520 while (!_connections.empty ()) {
1521 _connections.back ()->_disconnect (this, false);
1522 _osx_backend.port_connect_callback (name(), _connections.back ()->name(), false);
1523 _connections.pop_back ();
1528 PamPort::is_connected (const PamPort *port) const
1530 return std::find (_connections.begin (), _connections.end (), port) != _connections.end ();
1533 bool PamPort::is_physically_connected () const
1535 for (std::vector<PamPort*>::const_iterator it = _connections.begin (); it != _connections.end (); ++it) {
1536 if ((*it)->is_physical ()) {
1543 /******************************************************************************/
1545 PortAudioPort::PortAudioPort (PortAudioBackend &b, const std::string& name, PortFlags flags)
1546 : PamPort (b, name, flags)
1548 memset (_buffer, 0, sizeof (_buffer));
1549 #ifndef PLATFORM_WINDOWS
1550 mlock(_buffer, sizeof (_buffer));
1554 PortAudioPort::~PortAudioPort () { }
1556 void* PortAudioPort::get_buffer (pframes_t n_samples)
1559 std::vector<PamPort*>::const_iterator it = get_connections ().begin ();
1560 if (it == get_connections ().end ()) {
1561 memset (_buffer, 0, n_samples * sizeof (Sample));
1563 PortAudioPort const * source = static_cast<const PortAudioPort*>(*it);
1564 assert (source && source->is_output ());
1565 memcpy (_buffer, source->const_buffer (), n_samples * sizeof (Sample));
1566 while (++it != get_connections ().end ()) {
1567 source = static_cast<const PortAudioPort*>(*it);
1568 assert (source && source->is_output ());
1569 Sample* dst = buffer ();
1570 const Sample* src = source->const_buffer ();
1571 for (uint32_t s = 0; s < n_samples; ++s, ++dst, ++src) {
1581 PortMidiPort::PortMidiPort (PortAudioBackend &b, const std::string& name, PortFlags flags)
1582 : PamPort (b, name, flags)
1586 _buffer[0].clear ();
1587 _buffer[1].clear ();
1590 PortMidiPort::~PortMidiPort () { }
1592 struct MidiEventSorter {
1593 bool operator() (const boost::shared_ptr<PortMidiEvent>& a, const boost::shared_ptr<PortMidiEvent>& b) {
1598 void* PortMidiPort::get_buffer (pframes_t /* nframes */)
1601 (_buffer[_bufperiod]).clear ();
1602 for (std::vector<PamPort*>::const_iterator i = get_connections ().begin ();
1603 i != get_connections ().end ();
1605 const PortMidiBuffer * src = static_cast<const PortMidiPort*>(*i)->const_buffer ();
1606 for (PortMidiBuffer::const_iterator it = src->begin (); it != src->end (); ++it) {
1607 (_buffer[_bufperiod]).push_back (boost::shared_ptr<PortMidiEvent>(new PortMidiEvent (**it)));
1610 std::sort ((_buffer[_bufperiod]).begin (), (_buffer[_bufperiod]).end (), MidiEventSorter());
1612 return &(_buffer[_bufperiod]);
1615 PortMidiEvent::PortMidiEvent (const pframes_t timestamp, const uint8_t* data, size_t size)
1617 , _timestamp (timestamp)
1621 _data = (uint8_t*) malloc (size);
1622 memcpy (_data, data, size);
1626 PortMidiEvent::PortMidiEvent (const PortMidiEvent& other)
1627 : _size (other.size ())
1628 , _timestamp (other.timestamp ())
1631 if (other.size () && other.const_data ()) {
1632 _data = (uint8_t*) malloc (other.size ());
1633 memcpy (_data, other.const_data (), other.size ());
1637 PortMidiEvent::~PortMidiEvent () {