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::_audio_device_status;
46 PortAudioBackend::PortAudioBackend (AudioEngine& e, AudioBackendInfo& info)
47 : AudioBackend (e, info)
52 , _measure_latency (false)
53 , _last_process_start (0)
55 , _midi_driver_option(_("None"))
57 , _samples_per_period (1024)
60 , _systemic_audio_input_latency (0)
61 , _systemic_audio_output_latency (0)
63 , _processed_samples (0)
64 , _port_change_flag (false)
66 _instance_name = s_instance_name;
67 pthread_mutex_init (&_port_callback_mutex, 0);
69 _pcmio = new PortAudioIO ();
72 PortAudioBackend::~PortAudioBackend ()
74 delete _pcmio; _pcmio = 0;
75 pthread_mutex_destroy (&_port_callback_mutex);
78 /* AUDIOBACKEND API */
81 PortAudioBackend::name () const
83 return X_("PortAudio");
87 PortAudioBackend::is_realtime () const
92 std::vector<AudioBackend::DeviceStatus>
93 PortAudioBackend::enumerate_devices () const
96 _audio_device_status.clear();
97 std::map<int, std::string> devices;
98 _pcmio->device_list(devices);
100 for (std::map<int, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
101 if (_audio_device == "") _audio_device = i->second;
102 _audio_device_status.push_back (DeviceStatus (i->second, true));
104 return _audio_device_status;
108 PortAudioBackend::available_sample_rates (const std::string&) const
110 std::vector<float> sr;
111 _pcmio->available_sample_rates(name_to_id(_audio_device), sr);
115 std::vector<uint32_t>
116 PortAudioBackend::available_buffer_sizes (const std::string&) const
118 std::vector<uint32_t> bs;
119 _pcmio->available_buffer_sizes(name_to_id(_audio_device), bs);
124 PortAudioBackend::available_input_channel_count (const std::string&) const
126 return 128; // TODO query current device
130 PortAudioBackend::available_output_channel_count (const std::string&) const
132 return 128; // TODO query current device
136 PortAudioBackend::can_change_sample_rate_when_running () const
142 PortAudioBackend::can_change_buffer_size_when_running () const
144 return false; // TODO
148 PortAudioBackend::set_device_name (const std::string& d)
155 PortAudioBackend::set_sample_rate (float sr)
157 if (sr <= 0) { return -1; }
158 // TODO check if it's in the list of valid SR
160 engine.sample_rate_change (sr);
165 PortAudioBackend::set_buffer_size (uint32_t bs)
167 if (bs <= 0 || bs >= _max_buffer_size) {
170 _samples_per_period = bs;
171 engine.buffer_size_change (bs);
176 PortAudioBackend::set_interleaved (bool yn)
178 if (!yn) { return 0; }
183 PortAudioBackend::set_input_channels (uint32_t cc)
190 PortAudioBackend::set_output_channels (uint32_t cc)
197 PortAudioBackend::set_systemic_input_latency (uint32_t sl)
199 _systemic_audio_input_latency = sl;
204 PortAudioBackend::set_systemic_output_latency (uint32_t sl)
206 _systemic_audio_output_latency = sl;
210 /* Retrieving parameters */
212 PortAudioBackend::device_name () const
214 return _audio_device;
218 PortAudioBackend::sample_rate () const
224 PortAudioBackend::buffer_size () const
226 return _samples_per_period;
230 PortAudioBackend::interleaved () const
236 PortAudioBackend::input_channels () const
242 PortAudioBackend::output_channels () const
248 PortAudioBackend::systemic_input_latency () const
250 return _systemic_audio_input_latency;
254 PortAudioBackend::systemic_output_latency () const
256 return _systemic_audio_output_latency;
261 std::vector<std::string>
262 PortAudioBackend::enumerate_midi_options () const
264 if (_midi_options.empty()) {
265 //_midi_options.push_back (_("PortMidi"));
266 _midi_options.push_back (_("None"));
268 return _midi_options;
272 PortAudioBackend::set_midi_option (const std::string& opt)
274 if (opt != _("None") /* && opt != _("PortMidi")*/) {
277 _midi_driver_option = opt;
282 PortAudioBackend::midi_option () const
284 return _midi_driver_option;
289 static void * pthread_process (void *arg)
291 PortAudioBackend *d = static_cast<PortAudioBackend *>(arg);
292 d->main_process_thread ();
298 PortAudioBackend::_start (bool for_latency_measurement)
300 if (!_active && _run) {
301 // recover from 'halted', reap threads
305 if (_active || _run) {
306 PBD::error << _("PortAudioBackend: already active.") << endmsg;
311 PBD::warning << _("PortAudioBackend: recovering from unclean shutdown, port registry is not empty.") << endmsg;
312 _system_inputs.clear();
313 _system_outputs.clear();
314 _system_midi_in.clear();
315 _system_midi_out.clear();
319 /* reset internal state */
321 _freewheeling = false;
323 _last_process_start = 0;
325 _pcmio->pcm_setup (name_to_id(_audio_device), name_to_id(_audio_device), _samplerate, _samples_per_period);
327 switch (_pcmio->state ()) {
328 case 0: /* OK */ break;
329 case -1: PBD::error << _("PortAudioBackend: failed to open device.") << endmsg; break;
330 default: PBD::error << _("PortAudioBackend: initialization failed.") << endmsg; break;
332 if (_pcmio->state ()) {
336 if (_n_outputs != _pcmio->n_playback_channels ()) {
337 _n_outputs = _pcmio->n_playback_channels ();
338 PBD::info << _("PortAudioBackend: adjusted output channel count to match device.") << endmsg;
341 if (_n_inputs != _pcmio->n_capture_channels ()) {
342 _n_inputs = _pcmio->n_capture_channels ();
343 PBD::info << _("PortAudioBackend: adjusted input channel count to match device.") << endmsg;
346 if (_pcmio->samples_per_period() != _samples_per_period) {
347 _samples_per_period = _pcmio->samples_per_period();
348 PBD::warning << _("PortAudioBackend: samples per period does not match.") << endmsg;
352 if (_pcmio->sample_rate() != _samplerate) {
353 _samplerate = _pcmio->sample_rate();
354 engine.sample_rate_change (_samplerate);
355 PBD::warning << _("PortAudioBackend: sample rate does not match.") << endmsg;
358 _measure_latency = for_latency_measurement;
361 _port_change_flag = false;
365 if (register_system_audio_ports()) {
366 PBD::error << _("PortAudioBackend: failed to register system ports.") << endmsg;
371 engine.sample_rate_change (_samplerate);
372 engine.buffer_size_change (_samples_per_period);
374 if (engine.reestablish_ports ()) {
375 PBD::error << _("PortAudioBackend: Could not re-establish ports.") << endmsg;
380 engine.reconnect_ports ();
382 _port_change_flag = false;
384 if (_realtime_pthread_create (SCHED_FIFO, -20, 100000,
385 &_main_thread, pthread_process, this))
387 if (pthread_create (&_main_thread, NULL, pthread_process, this))
389 PBD::error << _("PortAudioBackend: failed to create process thread.") << endmsg;
393 PBD::warning << _("PortAudioBackend: cannot acquire realtime permissions.") << endmsg;
398 while (!_active && --timeout > 0) { Glib::usleep (1000); }
400 if (timeout == 0 || !_active) {
401 PBD::error << _("PortAudioBackend: failed to start.") << endmsg;
413 PortAudioBackend::stop ()
421 if (pthread_join (_main_thread, &status)) {
422 PBD::error << _("PortAudioBackend: failed to terminate.") << endmsg;
429 return (_active == false) ? 0 : -1;
433 PortAudioBackend::freewheel (bool onoff)
435 if (onoff == _freewheeling) {
438 _freewheeling = onoff;
443 PortAudioBackend::dsp_load () const
445 return 100.f * _dsp_load;
449 PortAudioBackend::raw_buffer_size (DataType t)
452 case DataType::AUDIO:
453 return _samples_per_period * sizeof(Sample);
455 return _max_buffer_size; // XXX not really limited
462 PortAudioBackend::sample_time ()
464 return _processed_samples;
468 PortAudioBackend::sample_time_at_cycle_start ()
470 return _processed_samples;
474 PortAudioBackend::samples_since_cycle_start ()
476 if (!_active || !_run || _freewheeling || _freewheel) {
479 if (_last_process_start == 0) {
483 const int64_t elapsed_time_us = g_get_monotonic_time() - _last_process_start;
484 return std::max((pframes_t)0, (pframes_t)rint(1e-6 * elapsed_time_us * _samplerate));
488 PortAudioBackend::name_to_id(std::string device_name) const {
489 uint32_t device_id = UINT32_MAX;
490 std::map<int, std::string> devices;
491 _pcmio->device_list(devices);
493 for (std::map<int, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
494 if (i->second == device_name) {
495 device_id = i->first;
503 PortAudioBackend::portaudio_process_thread (void *arg)
505 ThreadData* td = reinterpret_cast<ThreadData*> (arg);
506 boost::function<void ()> f = td->f;
513 PortAudioBackend::create_process_thread (boost::function<void()> func)
517 size_t stacksize = 100000;
519 ThreadData* td = new ThreadData (this, func, stacksize);
521 if (_realtime_pthread_create (SCHED_FIFO, -21, stacksize,
522 &thread_id, portaudio_process_thread, td)) {
523 pthread_attr_init (&attr);
524 pthread_attr_setstacksize (&attr, stacksize);
525 if (pthread_create (&thread_id, &attr, portaudio_process_thread, td)) {
526 PBD::error << _("AudioEngine: cannot create process thread.") << endmsg;
527 pthread_attr_destroy (&attr);
530 pthread_attr_destroy (&attr);
533 _threads.push_back (thread_id);
538 PortAudioBackend::join_process_threads ()
542 for (std::vector<pthread_t>::const_iterator i = _threads.begin (); i != _threads.end (); ++i)
545 if (pthread_join (*i, &status)) {
546 PBD::error << _("AudioEngine: cannot terminate process thread.") << endmsg;
555 PortAudioBackend::in_process_thread ()
557 if (pthread_equal (_main_thread, pthread_self()) != 0) {
561 for (std::vector<pthread_t>::const_iterator i = _threads.begin (); i != _threads.end (); ++i)
563 if (pthread_equal (*i, pthread_self ()) != 0) {
571 PortAudioBackend::process_thread_count ()
573 return _threads.size ();
577 PortAudioBackend::update_latencies ()
579 // trigger latency callback in RT thread (locked graph)
580 port_connect_add_remove_callback();
586 PortAudioBackend::private_handle () const
592 PortAudioBackend::my_name () const
594 return _instance_name;
598 PortAudioBackend::available () const
600 return _run && _active;
604 PortAudioBackend::port_name_size () const
610 PortAudioBackend::set_port_name (PortEngine::PortHandle port, const std::string& name)
612 if (!valid_port (port)) {
613 PBD::error << _("PortAudioBackend::set_port_name: Invalid Port(s)") << endmsg;
616 return static_cast<PamPort*>(port)->set_name (_instance_name + ":" + name);
620 PortAudioBackend::get_port_name (PortEngine::PortHandle port) const
622 if (!valid_port (port)) {
623 PBD::error << _("PortAudioBackend::get_port_name: Invalid Port(s)") << endmsg;
624 return std::string ();
626 return static_cast<PamPort*>(port)->name ();
629 PortEngine::PortHandle
630 PortAudioBackend::get_port_by_name (const std::string& name) const
632 PortHandle port = (PortHandle) find_port (name);
637 PortAudioBackend::get_ports (
638 const std::string& port_name_pattern,
639 DataType type, PortFlags flags,
640 std::vector<std::string>& port_names) const
644 bool use_regexp = false;
645 if (port_name_pattern.size () > 0) {
646 if (!regcomp (&port_regex, port_name_pattern.c_str (), REG_EXTENDED|REG_NOSUB)) {
650 for (size_t i = 0; i < _ports.size (); ++i) {
651 PamPort* port = _ports[i];
652 if ((port->type () == type) && flags == (port->flags () & flags)) {
653 if (!use_regexp || !regexec (&port_regex, port->name ().c_str (), 0, NULL, 0)) {
654 port_names.push_back (port->name ());
660 regfree (&port_regex);
666 PortAudioBackend::port_data_type (PortEngine::PortHandle port) const
668 if (!valid_port (port)) {
669 return DataType::NIL;
671 return static_cast<PamPort*>(port)->type ();
674 PortEngine::PortHandle
675 PortAudioBackend::register_port (
676 const std::string& name,
677 ARDOUR::DataType type,
678 ARDOUR::PortFlags flags)
680 if (name.size () == 0) { return 0; }
681 if (flags & IsPhysical) { return 0; }
682 return add_port (_instance_name + ":" + name, type, flags);
685 PortEngine::PortHandle
686 PortAudioBackend::add_port (
687 const std::string& name,
688 ARDOUR::DataType type,
689 ARDOUR::PortFlags flags)
691 assert(name.size ());
692 if (find_port (name)) {
693 PBD::error << _("PortAudioBackend::register_port: Port already exists:")
694 << " (" << name << ")" << endmsg;
697 PamPort* port = NULL;
699 case DataType::AUDIO:
700 port = new PortAudioPort (*this, name, flags);
703 port = new PortMidiPort (*this, name, flags);
706 PBD::error << _("PortAudioBackend::register_port: Invalid Data Type.") << endmsg;
710 _ports.push_back (port);
716 PortAudioBackend::unregister_port (PortEngine::PortHandle port_handle)
721 PamPort* port = static_cast<PamPort*>(port_handle);
722 std::vector<PamPort*>::iterator i = std::find (_ports.begin (), _ports.end (), static_cast<PamPort*>(port_handle));
723 if (i == _ports.end ()) {
724 PBD::error << _("PortAudioBackend::unregister_port: Failed to find port") << endmsg;
727 disconnect_all(port_handle);
733 PortAudioBackend::register_system_audio_ports()
737 const uint32_t a_ins = _n_inputs;
738 const uint32_t a_out = _n_outputs;
740 // XXX PA reported stream latencies don't match measurements
741 const uint32_t portaudio_reported_input_latency = _samples_per_period ; // _pcmio->capture_latency();
742 const uint32_t portaudio_reported_output_latency = /* _samples_per_period + */ _pcmio->playback_latency();
745 lr.min = lr.max = portaudio_reported_input_latency + (_measure_latency ? 0 : _systemic_audio_input_latency);
746 for (uint32_t i = 0; i < a_ins; ++i) {
748 snprintf(tmp, sizeof(tmp), "system:capture_%d", i+1);
749 PortHandle p = add_port(std::string(tmp), DataType::AUDIO, static_cast<PortFlags>(IsOutput | IsPhysical | IsTerminal));
751 set_latency_range (p, false, lr);
752 _system_inputs.push_back(static_cast<PortAudioPort*>(p));
755 lr.min = lr.max = portaudio_reported_output_latency + (_measure_latency ? 0 : _systemic_audio_output_latency);
756 for (uint32_t i = 0; i < a_out; ++i) {
758 snprintf(tmp, sizeof(tmp), "system:playback_%d", i+1);
759 PortHandle p = add_port(std::string(tmp), DataType::AUDIO, static_cast<PortFlags>(IsInput | IsPhysical | IsTerminal));
761 set_latency_range (p, true, lr);
762 _system_outputs.push_back(static_cast<PamPort*>(p));
768 PortAudioBackend::unregister_ports (bool system_only)
771 _system_inputs.clear();
772 _system_outputs.clear();
773 _system_midi_in.clear();
774 _system_midi_out.clear();
775 while (i < _ports.size ()) {
776 PamPort* port = _ports[i];
777 if (! system_only || (port->is_physical () && port->is_terminal ())) {
778 port->disconnect_all ();
780 _ports.erase (_ports.begin() + i);
788 PortAudioBackend::connect (const std::string& src, const std::string& dst)
790 PamPort* src_port = find_port (src);
791 PamPort* dst_port = find_port (dst);
794 PBD::error << _("PortAudioBackend::connect: Invalid Source port:")
795 << " (" << src <<")" << endmsg;
799 PBD::error << _("PortAudioBackend::connect: Invalid Destination port:")
800 << " (" << dst <<")" << endmsg;
803 return src_port->connect (dst_port);
807 PortAudioBackend::disconnect (const std::string& src, const std::string& dst)
809 PamPort* src_port = find_port (src);
810 PamPort* dst_port = find_port (dst);
812 if (!src_port || !dst_port) {
813 PBD::error << _("PortAudioBackend::disconnect: Invalid Port(s)") << endmsg;
816 return src_port->disconnect (dst_port);
820 PortAudioBackend::connect (PortEngine::PortHandle src, const std::string& dst)
822 PamPort* dst_port = find_port (dst);
823 if (!valid_port (src)) {
824 PBD::error << _("PortAudioBackend::connect: Invalid Source Port Handle") << endmsg;
828 PBD::error << _("PortAudioBackend::connect: Invalid Destination Port")
829 << " (" << dst << ")" << endmsg;
832 return static_cast<PamPort*>(src)->connect (dst_port);
836 PortAudioBackend::disconnect (PortEngine::PortHandle src, const std::string& dst)
838 PamPort* dst_port = find_port (dst);
839 if (!valid_port (src) || !dst_port) {
840 PBD::error << _("PortAudioBackend::disconnect: Invalid Port(s)") << endmsg;
843 return static_cast<PamPort*>(src)->disconnect (dst_port);
847 PortAudioBackend::disconnect_all (PortEngine::PortHandle port)
849 if (!valid_port (port)) {
850 PBD::error << _("PortAudioBackend::disconnect_all: Invalid Port") << endmsg;
853 static_cast<PamPort*>(port)->disconnect_all ();
858 PortAudioBackend::connected (PortEngine::PortHandle port, bool /* process_callback_safe*/)
860 if (!valid_port (port)) {
861 PBD::error << _("PortAudioBackend::disconnect_all: Invalid Port") << endmsg;
864 return static_cast<PamPort*>(port)->is_connected ();
868 PortAudioBackend::connected_to (PortEngine::PortHandle src, const std::string& dst, bool /*process_callback_safe*/)
870 PamPort* dst_port = find_port (dst);
871 if (!valid_port (src) || !dst_port) {
872 PBD::error << _("PortAudioBackend::connected_to: Invalid Port") << endmsg;
875 return static_cast<PamPort*>(src)->is_connected (dst_port);
879 PortAudioBackend::physically_connected (PortEngine::PortHandle port, bool /*process_callback_safe*/)
881 if (!valid_port (port)) {
882 PBD::error << _("PortAudioBackend::physically_connected: Invalid Port") << endmsg;
885 return static_cast<PamPort*>(port)->is_physically_connected ();
889 PortAudioBackend::get_connections (PortEngine::PortHandle port, std::vector<std::string>& names, bool /*process_callback_safe*/)
891 if (!valid_port (port)) {
892 PBD::error << _("PortAudioBackend::get_connections: Invalid Port") << endmsg;
896 assert (0 == names.size ());
898 const std::vector<PamPort*>& connected_ports = static_cast<PamPort*>(port)->get_connections ();
900 for (std::vector<PamPort*>::const_iterator i = connected_ports.begin (); i != connected_ports.end (); ++i) {
901 names.push_back ((*i)->name ());
904 return (int)names.size ();
909 PortAudioBackend::midi_event_get (
910 pframes_t& timestamp,
911 size_t& size, uint8_t** buf, void* port_buffer,
912 uint32_t event_index)
914 if (!buf || !port_buffer) return -1;
915 PortMidiBuffer& source = * static_cast<PortMidiBuffer*>(port_buffer);
916 if (event_index >= source.size ()) {
919 PortMidiEvent * const event = source[event_index].get ();
921 timestamp = event->timestamp ();
922 size = event->size ();
923 *buf = event->data ();
928 PortAudioBackend::midi_event_put (
931 const uint8_t* buffer, size_t size)
933 if (!buffer || !port_buffer) return -1;
934 PortMidiBuffer& dst = * static_cast<PortMidiBuffer*>(port_buffer);
935 if (dst.size () && (pframes_t)dst.back ()->timestamp () > timestamp) {
937 // nevermind, ::get_buffer() sorts events
938 fprintf (stderr, "PortMidiBuffer: unordered event: %d > %d\n",
939 (pframes_t)dst.back ()->timestamp (), timestamp);
942 dst.push_back (boost::shared_ptr<PortMidiEvent>(new PortMidiEvent (timestamp, buffer, size)));
947 PortAudioBackend::get_midi_event_count (void* port_buffer)
949 if (!port_buffer) return 0;
950 return static_cast<PortMidiBuffer*>(port_buffer)->size ();
954 PortAudioBackend::midi_clear (void* port_buffer)
956 if (!port_buffer) return;
957 PortMidiBuffer * buf = static_cast<PortMidiBuffer*>(port_buffer);
965 PortAudioBackend::can_monitor_input () const
971 PortAudioBackend::request_input_monitoring (PortEngine::PortHandle, bool)
977 PortAudioBackend::ensure_input_monitoring (PortEngine::PortHandle, bool)
983 PortAudioBackend::monitoring_input (PortEngine::PortHandle)
988 /* Latency management */
991 PortAudioBackend::set_latency_range (PortEngine::PortHandle port, bool for_playback, LatencyRange latency_range)
993 if (!valid_port (port)) {
994 PBD::error << _("PamPort::set_latency_range (): invalid port.") << endmsg;
996 static_cast<PamPort*>(port)->set_latency_range (latency_range, for_playback);
1000 PortAudioBackend::get_latency_range (PortEngine::PortHandle port, bool for_playback)
1003 if (!valid_port (port)) {
1004 PBD::error << _("PamPort::get_latency_range (): invalid port.") << endmsg;
1009 PamPort* p = static_cast<PamPort*>(port);
1012 r = p->latency_range (for_playback);
1014 if (p->is_physical() && p->is_terminal() && p->type() == DataType::AUDIO) {
1015 if (p->is_input() && for_playback) {
1016 r.min += _samples_per_period;
1017 r.max += _samples_per_period;
1019 if (p->is_output() && !for_playback) {
1020 r.min += _samples_per_period;
1021 r.max += _samples_per_period;
1027 /* Discovering physical ports */
1030 PortAudioBackend::port_is_physical (PortEngine::PortHandle port) const
1032 if (!valid_port (port)) {
1033 PBD::error << _("PamPort::port_is_physical (): invalid port.") << endmsg;
1036 return static_cast<PamPort*>(port)->is_physical ();
1040 PortAudioBackend::get_physical_outputs (DataType type, std::vector<std::string>& port_names)
1042 for (size_t i = 0; i < _ports.size (); ++i) {
1043 PamPort* port = _ports[i];
1044 if ((port->type () == type) && port->is_input () && port->is_physical ()) {
1045 port_names.push_back (port->name ());
1051 PortAudioBackend::get_physical_inputs (DataType type, std::vector<std::string>& port_names)
1053 for (size_t i = 0; i < _ports.size (); ++i) {
1054 PamPort* port = _ports[i];
1055 if ((port->type () == type) && port->is_output () && port->is_physical ()) {
1056 port_names.push_back (port->name ());
1062 PortAudioBackend::n_physical_outputs () const
1066 for (size_t i = 0; i < _ports.size (); ++i) {
1067 PamPort* port = _ports[i];
1068 if (port->is_output () && port->is_physical ()) {
1069 switch (port->type ()) {
1070 case DataType::AUDIO: ++n_audio; break;
1071 case DataType::MIDI: ++n_midi; break;
1077 cc.set (DataType::AUDIO, n_audio);
1078 cc.set (DataType::MIDI, n_midi);
1083 PortAudioBackend::n_physical_inputs () const
1087 for (size_t i = 0; i < _ports.size (); ++i) {
1088 PamPort* port = _ports[i];
1089 if (port->is_input () && port->is_physical ()) {
1090 switch (port->type ()) {
1091 case DataType::AUDIO: ++n_audio; break;
1092 case DataType::MIDI: ++n_midi; break;
1098 cc.set (DataType::AUDIO, n_audio);
1099 cc.set (DataType::MIDI, n_midi);
1103 /* Getting access to the data buffer for a port */
1106 PortAudioBackend::get_buffer (PortEngine::PortHandle port, pframes_t nframes)
1108 if (!port || !valid_port (port)) return NULL;
1109 return static_cast<PamPort*>(port)->get_buffer (nframes);
1114 PortAudioBackend::main_process_thread ()
1116 AudioEngine::thread_init_callback (this);
1118 _processed_samples = 0;
1120 uint64_t clock1, clock2;
1121 const int64_t nomial_time = 1e6 * _samples_per_period / _samplerate;
1123 manager.registration_callback();
1124 manager.graph_order_callback();
1126 if (_pcmio->pcm_start()) {
1127 _pcmio->pcm_stop ();
1129 engine.halted_callback("PortAudio I/O error.");
1134 if (_freewheeling != _freewheel) {
1135 _freewheel = _freewheeling;
1136 engine.freewheel_callback (_freewheel);
1141 switch (_pcmio->next_cycle (_samples_per_period)) {
1146 printf("PortAudio: Xrun\n");
1151 PBD::error << _("PortAudioBackend: I/O error. Audio Process Terminated.") << endmsg;
1156 clock1 = g_get_monotonic_time();
1160 for (std::vector<PamPort*>::const_iterator it = _system_inputs.begin (); it != _system_inputs.end (); ++it, ++i) {
1161 _pcmio->get_capture_channel (i, (float*)((*it)->get_buffer(_samples_per_period)), _samples_per_period);
1164 /* de-queue incoming midi*/
1166 for (std::vector<PamPort*>::const_iterator it = _system_midi_in.begin (); it != _system_midi_in.end (); ++it, ++i) {
1167 PortMidiBuffer* mbuf = static_cast<PortMidiBuffer*>((*it)->get_buffer(0));
1171 /* clear output buffers */
1172 for (std::vector<PamPort*>::const_iterator it = _system_outputs.begin (); it != _system_outputs.end (); ++it) {
1173 memset ((*it)->get_buffer (_samples_per_period), 0, _samples_per_period * sizeof (Sample));
1176 /* call engine process callback */
1177 _last_process_start = g_get_monotonic_time();
1178 if (engine.process_callback (_samples_per_period)) {
1179 _pcmio->pcm_stop ();
1185 for (std::vector<PamPort*>::iterator it = _system_midi_out.begin (); it != _system_midi_out.end (); ++it) {
1186 static_cast<PortBackendMidiPort*>(*it)->next_period();
1189 /* queue outgoing midi */
1191 for (std::vector<PamPort*>::const_iterator it = _system_midi_out.begin (); it != _system_midi_out.end (); ++it, ++i) {
1196 /* write back audio */
1198 for (std::vector<PamPort*>::const_iterator it = _system_outputs.begin (); it != _system_outputs.end (); ++it, ++i) {
1199 _pcmio->set_playback_channel (i, (float const*)(*it)->get_buffer (_samples_per_period), _samples_per_period);
1202 _processed_samples += _samples_per_period;
1204 /* calculate DSP load */
1205 clock2 = g_get_monotonic_time();
1206 const int64_t elapsed_time = clock2 - clock1;
1207 _dsp_load = elapsed_time / (float) nomial_time;
1212 // zero audio input buffers
1213 for (std::vector<PamPort*>::const_iterator it = _system_inputs.begin (); it != _system_inputs.end (); ++it) {
1214 memset ((*it)->get_buffer (_samples_per_period), 0, _samples_per_period * sizeof (Sample));
1217 clock1 = g_get_monotonic_time();
1219 // TODO clear midi or stop midi recv when entering fwheelin'
1221 _last_process_start = 0;
1222 if (engine.process_callback (_samples_per_period)) {
1223 _pcmio->pcm_stop ();
1228 // drop all outgoing MIDI messages
1229 for (std::vector<PamPort*>::const_iterator it = _system_midi_out.begin (); it != _system_midi_out.end (); ++it) {
1230 void *bptr = (*it)->get_buffer(0);
1235 Glib::usleep (100); // don't hog cpu
1238 bool connections_changed = false;
1239 bool ports_changed = false;
1240 if (!pthread_mutex_trylock (&_port_callback_mutex)) {
1241 if (_port_change_flag) {
1242 ports_changed = true;
1243 _port_change_flag = false;
1245 if (!_port_connection_queue.empty ()) {
1246 connections_changed = true;
1248 while (!_port_connection_queue.empty ()) {
1249 PortConnectData *c = _port_connection_queue.back ();
1250 manager.connect_callback (c->a, c->b, c->c);
1251 _port_connection_queue.pop_back ();
1254 pthread_mutex_unlock (&_port_callback_mutex);
1256 if (ports_changed) {
1257 manager.registration_callback();
1259 if (connections_changed) {
1260 manager.graph_order_callback();
1262 if (connections_changed || ports_changed) {
1263 engine.latency_callback(false);
1264 engine.latency_callback(true);
1268 _pcmio->pcm_stop ();
1271 engine.halted_callback("PortAudio I/O error.");
1277 /******************************************************************************/
1279 static boost::shared_ptr<PortAudioBackend> _instance;
1281 static boost::shared_ptr<AudioBackend> backend_factory (AudioEngine& e);
1282 static int instantiate (const std::string& arg1, const std::string& /* arg2 */);
1283 static int deinstantiate ();
1284 static bool already_configured ();
1285 static bool available ();
1287 static ARDOUR::AudioBackendInfo _descriptor = {
1296 static boost::shared_ptr<AudioBackend>
1297 backend_factory (AudioEngine& e)
1300 _instance.reset (new PortAudioBackend (e, _descriptor));
1306 instantiate (const std::string& arg1, const std::string& /* arg2 */)
1308 s_instance_name = arg1;
1320 already_configured ()
1331 extern "C" ARDOURBACKEND_API ARDOUR::AudioBackendInfo* descriptor ()
1333 return &_descriptor;
1337 /******************************************************************************/
1338 PamPort::PamPort (PortAudioBackend &b, const std::string& name, PortFlags flags)
1343 _capture_latency_range.min = 0;
1344 _capture_latency_range.max = 0;
1345 _playback_latency_range.min = 0;
1346 _playback_latency_range.max = 0;
1349 PamPort::~PamPort () {
1354 int PamPort::connect (PamPort *port)
1357 PBD::error << _("PamPort::connect (): invalid (null) port") << endmsg;
1361 if (type () != port->type ()) {
1362 PBD::error << _("PamPort::connect (): wrong port-type") << endmsg;
1366 if (is_output () && port->is_output ()) {
1367 PBD::error << _("PamPort::connect (): cannot inter-connect output ports.") << endmsg;
1371 if (is_input () && port->is_input ()) {
1372 PBD::error << _("PamPort::connect (): cannot inter-connect input ports.") << endmsg;
1377 PBD::error << _("PamPort::connect (): cannot self-connect ports.") << endmsg;
1381 if (is_connected (port)) {
1382 #if 0 // don't bother to warn about this for now. just ignore it
1383 PBD::error << _("PamPort::connect (): ports are already connected:")
1384 << " (" << name () << ") -> (" << port->name () << ")"
1390 _connect (port, true);
1395 void PamPort::_connect (PamPort *port, bool callback)
1397 _connections.push_back (port);
1399 port->_connect (this, false);
1400 _osx_backend.port_connect_callback (name(), port->name(), true);
1404 int PamPort::disconnect (PamPort *port)
1407 PBD::error << _("PamPort::disconnect (): invalid (null) port") << endmsg;
1411 if (!is_connected (port)) {
1412 PBD::error << _("PamPort::disconnect (): ports are not connected:")
1413 << " (" << name () << ") -> (" << port->name () << ")"
1417 _disconnect (port, true);
1421 void PamPort::_disconnect (PamPort *port, bool callback)
1423 std::vector<PamPort*>::iterator it = std::find (_connections.begin (), _connections.end (), port);
1425 assert (it != _connections.end ());
1427 _connections.erase (it);
1430 port->_disconnect (this, false);
1431 _osx_backend.port_connect_callback (name(), port->name(), false);
1436 void PamPort::disconnect_all ()
1438 while (!_connections.empty ()) {
1439 _connections.back ()->_disconnect (this, false);
1440 _osx_backend.port_connect_callback (name(), _connections.back ()->name(), false);
1441 _connections.pop_back ();
1446 PamPort::is_connected (const PamPort *port) const
1448 return std::find (_connections.begin (), _connections.end (), port) != _connections.end ();
1451 bool PamPort::is_physically_connected () const
1453 for (std::vector<PamPort*>::const_iterator it = _connections.begin (); it != _connections.end (); ++it) {
1454 if ((*it)->is_physical ()) {
1461 /******************************************************************************/
1463 PortAudioPort::PortAudioPort (PortAudioBackend &b, const std::string& name, PortFlags flags)
1464 : PamPort (b, name, flags)
1466 memset (_buffer, 0, sizeof (_buffer));
1467 #ifndef PLATFORM_WINDOWS
1468 mlock(_buffer, sizeof (_buffer));
1472 PortAudioPort::~PortAudioPort () { }
1474 void* PortAudioPort::get_buffer (pframes_t n_samples)
1477 std::vector<PamPort*>::const_iterator it = get_connections ().begin ();
1478 if (it == get_connections ().end ()) {
1479 memset (_buffer, 0, n_samples * sizeof (Sample));
1481 PortAudioPort const * source = static_cast<const PortAudioPort*>(*it);
1482 assert (source && source->is_output ());
1483 memcpy (_buffer, source->const_buffer (), n_samples * sizeof (Sample));
1484 while (++it != get_connections ().end ()) {
1485 source = static_cast<const PortAudioPort*>(*it);
1486 assert (source && source->is_output ());
1487 Sample* dst = buffer ();
1488 const Sample* src = source->const_buffer ();
1489 for (uint32_t s = 0; s < n_samples; ++s, ++dst, ++src) {
1499 PortMidiPort::PortMidiPort (PortAudioBackend &b, const std::string& name, PortFlags flags)
1500 : PamPort (b, name, flags)
1504 _buffer[0].clear ();
1505 _buffer[1].clear ();
1508 PortMidiPort::~PortMidiPort () { }
1510 struct MidiEventSorter {
1511 bool operator() (const boost::shared_ptr<PortMidiEvent>& a, const boost::shared_ptr<PortMidiEvent>& b) {
1516 void* PortMidiPort::get_buffer (pframes_t /* nframes */)
1519 (_buffer[_bufperiod]).clear ();
1520 for (std::vector<PamPort*>::const_iterator i = get_connections ().begin ();
1521 i != get_connections ().end ();
1523 const PortMidiBuffer * src = static_cast<const PortMidiPort*>(*i)->const_buffer ();
1524 for (PortMidiBuffer::const_iterator it = src->begin (); it != src->end (); ++it) {
1525 (_buffer[_bufperiod]).push_back (boost::shared_ptr<PortMidiEvent>(new PortMidiEvent (**it)));
1528 std::sort ((_buffer[_bufperiod]).begin (), (_buffer[_bufperiod]).end (), MidiEventSorter());
1530 return &(_buffer[_bufperiod]);
1533 PortMidiEvent::PortMidiEvent (const pframes_t timestamp, const uint8_t* data, size_t size)
1535 , _timestamp (timestamp)
1539 _data = (uint8_t*) malloc (size);
1540 memcpy (_data, data, size);
1544 PortMidiEvent::PortMidiEvent (const PortMidiEvent& other)
1545 : _size (other.size ())
1546 , _timestamp (other.timestamp ())
1549 if (other.size () && other.const_data ()) {
1550 _data = (uint8_t*) malloc (other.size ());
1551 memcpy (_data, other.const_data (), other.size ());
1555 PortMidiEvent::~PortMidiEvent () {