2 * Copyright (C) 2014 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.
26 #include "alsa_audiobackend.h"
27 #include "rt_thread.h"
29 #include "pbd/compose.h"
30 #include "pbd/error.h"
31 #include "pbd/file_utils.h"
32 #include "ardour/filesystem_paths.h"
33 #include "ardour/port_manager.h"
34 #include "ardouralsautil/devicelist.h"
37 using namespace ARDOUR;
39 static std::string s_instance_name;
40 size_t AlsaAudioBackend::_max_buffer_size = 8192;
41 std::vector<std::string> AlsaAudioBackend::_midi_options;
42 std::vector<AudioBackend::DeviceStatus> AlsaAudioBackend::_audio_device_status;
43 std::vector<AudioBackend::DeviceStatus> AlsaAudioBackend::_midi_device_status;
45 AlsaAudioBackend::AlsaAudioBackend (AudioEngine& e, AudioBackendInfo& info)
46 : AudioBackend (e, info)
50 , _freewheeling (false)
51 , _measure_latency (false)
53 , _midi_driver_option(_("None"))
54 , _device_reservation(0)
56 , _samples_per_period (1024)
57 , _periods_per_cycle (2)
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);
70 AlsaAudioBackend::~AlsaAudioBackend ()
72 pthread_mutex_destroy (&_port_callback_mutex);
75 /* AUDIOBACKEND API */
78 AlsaAudioBackend::name () const
84 AlsaAudioBackend::is_realtime () const
89 std::vector<AudioBackend::DeviceStatus>
90 AlsaAudioBackend::enumerate_devices () const
92 _audio_device_status.clear();
93 std::map<std::string, std::string> devices;
94 get_alsa_audio_device_names(devices);
95 for (std::map<std::string, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
96 if (_audio_device == "") _audio_device = i->first;
97 _audio_device_status.push_back (DeviceStatus (i->first, true));
99 return _audio_device_status;
103 AlsaAudioBackend::reservation_stdout (std::string d, size_t /* s */)
105 if (d.substr(0, 19) == "Acquired audio-card") {
106 _reservation_succeeded = true;
111 AlsaAudioBackend::release_device()
113 _reservation_connection.drop_connections();
114 ARDOUR::SystemExec * tmp = _device_reservation;
115 _device_reservation = 0;
120 AlsaAudioBackend::acquire_device(const char* device_name)
122 /* This is quick hack, ideally we'll link against libdbus and implement a dbus-listener
123 * that owns the device. here we try to get away by just requesting it and then block it...
124 * (pulseaudio periodically checks anyway)
126 * dbus-send --session --print-reply --type=method_call --dest=org.freedesktop.ReserveDevice1.Audio2 /org/freedesktop/ReserveDevice1/Audio2 org.freedesktop.ReserveDevice1.RequestRelease int32:4
127 * -> should not return 'boolean false'
129 int device_number = card_to_num(device_name);
130 if (device_number < 0) return false;
132 assert(_device_reservation == 0);
133 _reservation_succeeded = false;
135 std::string request_device_exe;
136 if (!PBD::find_file (
137 PBD::Searchpath(Glib::build_filename(ARDOUR::ardour_dll_directory(), "ardouralsautil")
138 + G_SEARCHPATH_SEPARATOR_S + ARDOUR::ardour_dll_directory()),
139 "ardour-request-device", request_device_exe))
141 PBD::warning << "ardour-request-device binary was not found..'" << endmsg;
148 argp=(char**) calloc(5,sizeof(char*));
149 argp[0] = strdup(request_device_exe.c_str());
150 argp[1] = strdup("-P");
151 snprintf(tmp, sizeof(tmp), "%d", getpid());
152 argp[2] = strdup(tmp);
153 snprintf(tmp, sizeof(tmp), "Audio%d", device_number);
154 argp[3] = strdup(tmp);
157 _device_reservation = new ARDOUR::SystemExec(request_device_exe, argp);
158 _device_reservation->ReadStdout.connect_same_thread (_reservation_connection, boost::bind (&AlsaAudioBackend::reservation_stdout, this, _1 ,_2));
159 _device_reservation->Terminated.connect_same_thread (_reservation_connection, boost::bind (&AlsaAudioBackend::release_device, this));
160 if (_device_reservation->start(0)) {
161 PBD::warning << _("AlsaAudioBackend: Device Request failed.") << endmsg;
166 // wait to check if reservation suceeded.
167 int timeout = 500; // 5 sec
168 while (_device_reservation && !_reservation_succeeded && --timeout > 0) {
171 if (timeout == 0 || !_reservation_succeeded) {
172 PBD::warning << _("AlsaAudioBackend: Device Reservation failed.") << endmsg;
180 AlsaAudioBackend::available_sample_rates (const std::string&) const
182 std::vector<float> sr;
183 sr.push_back (8000.0);
184 sr.push_back (22050.0);
185 sr.push_back (24000.0);
186 sr.push_back (44100.0);
187 sr.push_back (48000.0);
188 sr.push_back (88200.0);
189 sr.push_back (96000.0);
190 sr.push_back (176400.0);
191 sr.push_back (192000.0);
195 std::vector<uint32_t>
196 AlsaAudioBackend::available_buffer_sizes (const std::string&) const
198 std::vector<uint32_t> bs;
212 AlsaAudioBackend::available_input_channel_count (const std::string&) const
214 return 128; // TODO query current device
218 AlsaAudioBackend::available_output_channel_count (const std::string&) const
220 return 128; // TODO query current device
224 AlsaAudioBackend::can_change_sample_rate_when_running () const
230 AlsaAudioBackend::can_change_buffer_size_when_running () const
236 AlsaAudioBackend::set_device_name (const std::string& d)
243 AlsaAudioBackend::set_sample_rate (float sr)
245 if (sr <= 0) { return -1; }
247 engine.sample_rate_change (sr);
252 AlsaAudioBackend::set_buffer_size (uint32_t bs)
254 if (bs <= 0 || bs >= _max_buffer_size) {
257 _samples_per_period = bs;
258 engine.buffer_size_change (bs);
263 AlsaAudioBackend::set_interleaved (bool yn)
265 if (!yn) { return 0; }
270 AlsaAudioBackend::set_input_channels (uint32_t cc)
277 AlsaAudioBackend::set_output_channels (uint32_t cc)
284 AlsaAudioBackend::set_systemic_input_latency (uint32_t sl)
286 _systemic_audio_input_latency = sl;
291 AlsaAudioBackend::set_systemic_output_latency (uint32_t sl)
293 _systemic_audio_output_latency = sl;
298 AlsaAudioBackend::set_systemic_midi_input_latency (std::string const device, uint32_t sl)
300 struct AlsaMidiDeviceInfo * nfo = midi_device_info(device);
302 nfo->systemic_input_latency = sl;
307 AlsaAudioBackend::set_systemic_midi_output_latency (std::string const device, uint32_t sl)
309 struct AlsaMidiDeviceInfo * nfo = midi_device_info(device);
311 nfo->systemic_output_latency = sl;
315 /* Retrieving parameters */
317 AlsaAudioBackend::device_name () const
319 return _audio_device;
323 AlsaAudioBackend::sample_rate () const
329 AlsaAudioBackend::buffer_size () const
331 return _samples_per_period;
335 AlsaAudioBackend::interleaved () const
341 AlsaAudioBackend::input_channels () const
347 AlsaAudioBackend::output_channels () const
353 AlsaAudioBackend::systemic_input_latency () const
355 return _systemic_audio_input_latency;
359 AlsaAudioBackend::systemic_output_latency () const
361 return _systemic_audio_output_latency;
365 AlsaAudioBackend::systemic_midi_input_latency (std::string const device) const
367 struct AlsaMidiDeviceInfo * nfo = midi_device_info(device);
369 return nfo->systemic_input_latency;
373 AlsaAudioBackend::systemic_midi_output_latency (std::string const device) const
375 struct AlsaMidiDeviceInfo * nfo = midi_device_info(device);
377 return nfo->systemic_output_latency;
381 struct AlsaAudioBackend::AlsaMidiDeviceInfo *
382 AlsaAudioBackend::midi_device_info(std::string const name) const {
383 for (std::map<std::string, struct AlsaMidiDeviceInfo*>::const_iterator i = _midi_devices.begin (); i != _midi_devices.end(); ++i) {
384 if (i->first == name) {
389 assert(_midi_driver_option != _("None"));
391 std::map<std::string, std::string> devices;
392 if (_midi_driver_option == _("ALSA raw devices")) {
393 get_alsa_rawmidi_device_names(devices);
395 get_alsa_sequencer_names (devices);
398 for (std::map<std::string, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
399 if (i->first == name) {
400 _midi_devices[name] = new AlsaMidiDeviceInfo();
401 return _midi_devices[name];
407 std::vector<std::string>
408 AlsaAudioBackend::enumerate_midi_options () const
410 if (_midi_options.empty()) {
411 _midi_options.push_back (_("None"));
412 _midi_options.push_back (_("ALSA raw devices"));
413 _midi_options.push_back (_("ALSA sequencer"));
415 return _midi_options;
418 std::vector<AudioBackend::DeviceStatus>
419 AlsaAudioBackend::enumerate_midi_devices () const
421 _midi_device_status.clear();
422 std::map<std::string, std::string> devices;
424 if (_midi_driver_option == _("ALSA raw devices")) {
425 get_alsa_rawmidi_device_names (devices);
427 else if (_midi_driver_option == _("ALSA sequencer")) {
428 get_alsa_sequencer_names (devices);
431 for (std::map<std::string, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
432 _midi_device_status.push_back (DeviceStatus (i->first, true));
434 return _midi_device_status;
438 AlsaAudioBackend::set_midi_option (const std::string& opt)
440 if (opt != _("None") && opt != _("ALSA raw devices") && opt != _("ALSA sequencer")) {
443 _midi_driver_option = opt;
448 AlsaAudioBackend::midi_option () const
450 return _midi_driver_option;
454 AlsaAudioBackend::set_midi_device_enabled (std::string const device, bool enable)
456 struct AlsaMidiDeviceInfo * nfo = midi_device_info(device);
458 nfo->enabled = enable;
463 AlsaAudioBackend::midi_device_enabled (std::string const device) const
465 struct AlsaMidiDeviceInfo * nfo = midi_device_info(device);
466 if (!nfo) return false;
472 static void * pthread_process (void *arg)
474 AlsaAudioBackend *d = static_cast<AlsaAudioBackend *>(arg);
475 d->main_process_thread ();
481 AlsaAudioBackend::_start (bool for_latency_measurement)
483 if (!_active && _run) {
484 // recover from 'halted', reap threads
488 if (_active || _run) {
489 PBD::error << _("AlsaAudioBackend: already active.") << endmsg;
494 PBD::warning << _("AlsaAudioBackend: recovering from unclean shutdown, port registry is not empty.") << endmsg;
495 _system_inputs.clear();
496 _system_outputs.clear();
497 _system_midi_in.clear();
498 _system_midi_out.clear();
504 assert(_rmidi_in.size() == 0);
505 assert(_rmidi_out.size() == 0);
508 std::string alsa_device;
509 std::map<std::string, std::string> devices;
510 get_alsa_audio_device_names(devices);
511 for (std::map<std::string, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
512 if (i->first == _audio_device) {
513 alsa_device = i->second;
518 acquire_device(alsa_device.c_str());
519 _pcmi = new Alsa_pcmi (alsa_device.c_str(), alsa_device.c_str(), 0, _samplerate, _samples_per_period, _periods_per_cycle, 0);
520 switch (_pcmi->state ()) {
521 case 0: /* OK */ break;
522 case -1: PBD::error << _("AlsaAudioBackend: failed to open device.") << endmsg; break;
523 case -2: PBD::error << _("AlsaAudioBackend: failed to allocate parameters.") << endmsg; break;
524 case -3: PBD::error << _("AlsaAudioBackend: cannot set requested sample rate.") << endmsg; break;
525 case -4: PBD::error << _("AlsaAudioBackend: cannot set requested period size.") << endmsg; break;
526 case -5: PBD::error << _("AlsaAudioBackend: cannot set requested number of periods.") << endmsg; break;
527 case -6: PBD::error << _("AlsaAudioBackend: unsupported sample format.") << endmsg; break;
528 default: PBD::error << _("AlsaAudioBackend: initialization failed.") << endmsg; break;
530 if (_pcmi->state ()) {
531 delete _pcmi; _pcmi = 0;
540 if (_n_outputs != _pcmi->nplay ()) {
541 if (_n_outputs == 0) {
542 _n_outputs = _pcmi->nplay ();
544 _n_outputs = std::min (_n_outputs, _pcmi->nplay ());
546 PBD::warning << _("AlsaAudioBackend: adjusted output channel count to match device.") << endmsg;
549 if (_n_inputs != _pcmi->ncapt ()) {
550 if (_n_inputs == 0) {
551 _n_inputs = _pcmi->ncapt ();
553 _n_inputs = std::min (_n_inputs, _pcmi->ncapt ());
555 PBD::warning << _("AlsaAudioBackend: adjusted input channel count to match device.") << endmsg;
558 if (_pcmi->fsize() != _samples_per_period) {
559 _samples_per_period = _pcmi->fsize();
560 PBD::warning << _("AlsaAudioBackend: samples per period does not match.") << endmsg;
563 if (_pcmi->fsamp() != _samplerate) {
564 _samplerate = _pcmi->fsamp();
565 engine.sample_rate_change (_samplerate);
566 PBD::warning << _("AlsaAudioBackend: sample rate does not match.") << endmsg;
569 _measure_latency = for_latency_measurement;
571 register_system_midi_ports();
573 if (register_system_audio_ports()) {
574 PBD::error << _("AlsaAudioBackend: failed to register system ports.") << endmsg;
575 delete _pcmi; _pcmi = 0;
580 engine.sample_rate_change (_samplerate);
581 engine.buffer_size_change (_samples_per_period);
583 if (engine.reestablish_ports ()) {
584 PBD::error << _("AlsaAudioBackend: Could not re-establish ports.") << endmsg;
585 delete _pcmi; _pcmi = 0;
590 engine.reconnect_ports ();
592 _port_change_flag = false;
594 if (_realtime_pthread_create (SCHED_FIFO, -20, 100000,
595 &_main_thread, pthread_process, this))
597 if (pthread_create (&_main_thread, NULL, pthread_process, this))
599 PBD::error << _("AlsaAudioBackend: failed to create process thread.") << endmsg;
600 delete _pcmi; _pcmi = 0;
605 PBD::warning << _("AlsaAudioBackend: cannot acquire realtime permissions.") << endmsg;
610 while (!_active && --timeout > 0) { Glib::usleep (1000); }
612 if (timeout == 0 || !_active) {
613 PBD::error << _("AlsaAudioBackend: failed to start process thread.") << endmsg;
614 delete _pcmi; _pcmi = 0;
624 AlsaAudioBackend::stop ()
632 if (pthread_join (_main_thread, &status)) {
633 PBD::error << _("AlsaAudioBackend: failed to terminate.") << endmsg;
637 while (!_rmidi_out.empty ()) {
638 AlsaMidiIO *m = _rmidi_out.back ();
640 _rmidi_out.pop_back ();
643 while (!_rmidi_in.empty ()) {
644 AlsaMidiIO *m = _rmidi_in.back ();
646 _rmidi_in.pop_back ();
651 delete _pcmi; _pcmi = 0;
654 return (_active == false) ? 0 : -1;
658 AlsaAudioBackend::freewheel (bool onoff)
660 if (onoff == _freewheeling) {
663 _freewheeling = onoff;
664 engine.freewheel_callback (onoff);
669 AlsaAudioBackend::dsp_load () const
671 return 100.f * _dsp_load;
675 AlsaAudioBackend::raw_buffer_size (DataType t)
678 case DataType::AUDIO:
679 return _samples_per_period * sizeof(Sample);
681 return _max_buffer_size; // XXX not really limited
688 AlsaAudioBackend::sample_time ()
690 return _processed_samples;
694 AlsaAudioBackend::sample_time_at_cycle_start ()
696 return _processed_samples;
700 AlsaAudioBackend::samples_since_cycle_start ()
707 AlsaAudioBackend::alsa_process_thread (void *arg)
709 ThreadData* td = reinterpret_cast<ThreadData*> (arg);
710 boost::function<void ()> f = td->f;
717 AlsaAudioBackend::create_process_thread (boost::function<void()> func)
721 size_t stacksize = 100000;
723 ThreadData* td = new ThreadData (this, func, stacksize);
725 if (_realtime_pthread_create (SCHED_FIFO, -21, stacksize,
726 &thread_id, alsa_process_thread, td)) {
727 pthread_attr_init (&attr);
728 pthread_attr_setstacksize (&attr, stacksize);
729 if (pthread_create (&thread_id, &attr, alsa_process_thread, td)) {
730 PBD::error << _("AudioEngine: cannot create process thread.") << endmsg;
731 pthread_attr_destroy (&attr);
734 pthread_attr_destroy (&attr);
737 _threads.push_back (thread_id);
742 AlsaAudioBackend::join_process_threads ()
746 for (std::vector<pthread_t>::const_iterator i = _threads.begin (); i != _threads.end (); ++i)
749 if (pthread_join (*i, &status)) {
750 PBD::error << _("AudioEngine: cannot terminate process thread.") << endmsg;
759 AlsaAudioBackend::in_process_thread ()
761 if (pthread_equal (_main_thread, pthread_self()) != 0) {
765 for (std::vector<pthread_t>::const_iterator i = _threads.begin (); i != _threads.end (); ++i)
767 if (pthread_equal (*i, pthread_self ()) != 0) {
775 AlsaAudioBackend::process_thread_count ()
777 return _threads.size ();
781 AlsaAudioBackend::update_latencies ()
783 // trigger latency callback in RT thread (locked graph)
784 port_connect_add_remove_callback();
790 AlsaAudioBackend::private_handle () const
796 AlsaAudioBackend::my_name () const
798 return _instance_name;
802 AlsaAudioBackend::available () const
804 return _run && _active;
808 AlsaAudioBackend::port_name_size () const
814 AlsaAudioBackend::set_port_name (PortEngine::PortHandle port, const std::string& name)
816 if (!valid_port (port)) {
817 PBD::error << _("AlsaBackend::set_port_name: Invalid Port(s)") << endmsg;
820 return static_cast<AlsaPort*>(port)->set_name (_instance_name + ":" + name);
824 AlsaAudioBackend::get_port_name (PortEngine::PortHandle port) const
826 if (!valid_port (port)) {
827 PBD::error << _("AlsaBackend::get_port_name: Invalid Port(s)") << endmsg;
828 return std::string ();
830 return static_cast<AlsaPort*>(port)->name ();
833 PortEngine::PortHandle
834 AlsaAudioBackend::get_port_by_name (const std::string& name) const
836 PortHandle port = (PortHandle) find_port (name);
841 AlsaAudioBackend::get_ports (
842 const std::string& port_name_pattern,
843 DataType type, PortFlags flags,
844 std::vector<std::string>& port_names) const
848 bool use_regexp = false;
849 if (port_name_pattern.size () > 0) {
850 if (!regcomp (&port_regex, port_name_pattern.c_str (), REG_EXTENDED|REG_NOSUB)) {
854 for (size_t i = 0; i < _ports.size (); ++i) {
855 AlsaPort* port = _ports[i];
856 if ((port->type () == type) && (port->flags () & flags)) {
857 if (!use_regexp || !regexec (&port_regex, port->name ().c_str (), 0, NULL, 0)) {
858 port_names.push_back (port->name ());
864 regfree (&port_regex);
870 AlsaAudioBackend::port_data_type (PortEngine::PortHandle port) const
872 if (!valid_port (port)) {
873 return DataType::NIL;
875 return static_cast<AlsaPort*>(port)->type ();
878 PortEngine::PortHandle
879 AlsaAudioBackend::register_port (
880 const std::string& name,
881 ARDOUR::DataType type,
882 ARDOUR::PortFlags flags)
884 if (name.size () == 0) { return 0; }
885 if (flags & IsPhysical) { return 0; }
886 return add_port (_instance_name + ":" + name, type, flags);
889 PortEngine::PortHandle
890 AlsaAudioBackend::add_port (
891 const std::string& name,
892 ARDOUR::DataType type,
893 ARDOUR::PortFlags flags)
895 assert(name.size ());
896 if (find_port (name)) {
897 PBD::error << _("AlsaBackend::register_port: Port already exists:")
898 << " (" << name << ")" << endmsg;
901 AlsaPort* port = NULL;
903 case DataType::AUDIO:
904 port = new AlsaAudioPort (*this, name, flags);
907 port = new AlsaMidiPort (*this, name, flags);
910 PBD::error << _("AlsaBackend::register_port: Invalid Data Type.") << endmsg;
914 _ports.push_back (port);
920 AlsaAudioBackend::unregister_port (PortEngine::PortHandle port_handle)
925 AlsaPort* port = static_cast<AlsaPort*>(port_handle);
926 std::vector<AlsaPort*>::iterator i = std::find (_ports.begin (), _ports.end (), static_cast<AlsaPort*>(port_handle));
927 if (i == _ports.end ()) {
928 PBD::error << _("AlsaBackend::unregister_port: Failed to find port") << endmsg;
931 disconnect_all(port_handle);
937 AlsaAudioBackend::register_system_audio_ports()
941 const int a_ins = _n_inputs > 0 ? _n_inputs : 2;
942 const int a_out = _n_outputs > 0 ? _n_outputs : 2;
945 lr.min = lr.max = _samples_per_period + (_measure_latency ? 0 : _systemic_audio_input_latency);
946 for (int i = 1; i <= a_ins; ++i) {
948 snprintf(tmp, sizeof(tmp), "system:capture_%d", i);
949 PortHandle p = add_port(std::string(tmp), DataType::AUDIO, static_cast<PortFlags>(IsOutput | IsPhysical | IsTerminal));
951 set_latency_range (p, false, lr);
952 _system_inputs.push_back(static_cast<AlsaPort*>(p));
955 lr.min = lr.max = _samples_per_period + (_measure_latency ? 0 : _systemic_audio_output_latency);
956 for (int i = 1; i <= a_out; ++i) {
958 snprintf(tmp, sizeof(tmp), "system:playback_%d", i);
959 PortHandle p = add_port(std::string(tmp), DataType::AUDIO, static_cast<PortFlags>(IsInput | IsPhysical | IsTerminal));
961 set_latency_range (p, true, lr);
962 _system_outputs.push_back(static_cast<AlsaPort*>(p));
968 AlsaAudioBackend::register_system_midi_ports()
970 std::map<std::string, std::string> devices;
974 if (_midi_driver_option == _("None")) {
976 } else if (_midi_driver_option == _("ALSA raw devices")) {
977 get_alsa_rawmidi_device_names(devices);
979 get_alsa_sequencer_names (devices);
982 for (std::map<std::string, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
983 struct AlsaMidiDeviceInfo * nfo = midi_device_info(i->first);
985 if (!nfo->enabled) continue;
988 if (_midi_driver_option == _("ALSA raw devices")) {
989 mout = new AlsaRawMidiOut (i->second.c_str());
991 mout = new AlsaSeqMidiOut (i->second.c_str());
994 if (mout->state ()) {
995 PBD::warning << string_compose (
996 _("AlsaMidiOut: failed to open midi device '%1'."), i->second)
1000 mout->setup_timing(_samples_per_period, _samplerate);
1001 mout->sync_time (g_get_monotonic_time());
1002 if (mout->start ()) {
1003 PBD::warning << string_compose (
1004 _("AlsaMidiOut: failed to start midi device '%1'."), i->second)
1009 snprintf(tmp, sizeof(tmp), "system:midi_playback_%d", ++midi_ins);
1010 PortHandle p = add_port(std::string(tmp), DataType::MIDI, static_cast<PortFlags>(IsInput | IsPhysical | IsTerminal));
1016 lr.min = lr.max = _samples_per_period + (_measure_latency ? 0 : nfo->systemic_output_latency);
1017 set_latency_range (p, false, lr);
1018 static_cast<AlsaMidiPort*>(p)->set_n_periods(2);
1019 _system_midi_out.push_back(static_cast<AlsaPort*>(p));
1020 _rmidi_out.push_back (mout);
1025 if (_midi_driver_option == _("ALSA raw devices")) {
1026 midin = new AlsaRawMidiIn (i->second.c_str());
1028 midin = new AlsaSeqMidiIn (i->second.c_str());
1031 if (midin->state ()) {
1032 PBD::warning << string_compose (
1033 _("AlsaMidiIn: failed to open midi device '%1'."), i->second)
1037 midin->setup_timing(_samples_per_period, _samplerate);
1038 midin->sync_time (g_get_monotonic_time());
1039 if (midin->start ()) {
1040 PBD::warning << string_compose (
1041 _("AlsaMidiIn: failed to start midi device '%1'."), i->second)
1046 snprintf(tmp, sizeof(tmp), "system:midi_capture_%d", ++midi_outs);
1047 PortHandle p = add_port(std::string(tmp), DataType::MIDI, static_cast<PortFlags>(IsOutput | IsPhysical | IsTerminal));
1054 lr.min = lr.max = _samples_per_period + (_measure_latency ? 0 : nfo->systemic_input_latency);
1055 set_latency_range (p, false, lr);
1056 _system_midi_in.push_back(static_cast<AlsaPort*>(p));
1057 _rmidi_in.push_back (midin);
1065 AlsaAudioBackend::unregister_ports (bool system_only)
1068 _system_inputs.clear();
1069 _system_outputs.clear();
1070 _system_midi_in.clear();
1071 _system_midi_out.clear();
1072 while (i < _ports.size ()) {
1073 AlsaPort* port = _ports[i];
1074 if (! system_only || (port->is_physical () && port->is_terminal ())) {
1075 port->disconnect_all ();
1077 _ports.erase (_ports.begin() + i);
1085 AlsaAudioBackend::connect (const std::string& src, const std::string& dst)
1087 AlsaPort* src_port = find_port (src);
1088 AlsaPort* dst_port = find_port (dst);
1091 PBD::error << _("AlsaBackend::connect: Invalid Source port:")
1092 << " (" << src <<")" << endmsg;
1096 PBD::error << _("AlsaBackend::connect: Invalid Destination port:")
1097 << " (" << dst <<")" << endmsg;
1100 return src_port->connect (dst_port);
1104 AlsaAudioBackend::disconnect (const std::string& src, const std::string& dst)
1106 AlsaPort* src_port = find_port (src);
1107 AlsaPort* dst_port = find_port (dst);
1109 if (!src_port || !dst_port) {
1110 PBD::error << _("AlsaBackend::disconnect: Invalid Port(s)") << endmsg;
1113 return src_port->disconnect (dst_port);
1117 AlsaAudioBackend::connect (PortEngine::PortHandle src, const std::string& dst)
1119 AlsaPort* dst_port = find_port (dst);
1120 if (!valid_port (src)) {
1121 PBD::error << _("AlsaBackend::connect: Invalid Source Port Handle") << endmsg;
1125 PBD::error << _("AlsaBackend::connect: Invalid Destination Port")
1126 << " (" << dst << ")" << endmsg;
1129 return static_cast<AlsaPort*>(src)->connect (dst_port);
1133 AlsaAudioBackend::disconnect (PortEngine::PortHandle src, const std::string& dst)
1135 AlsaPort* dst_port = find_port (dst);
1136 if (!valid_port (src) || !dst_port) {
1137 PBD::error << _("AlsaBackend::disconnect: Invalid Port(s)") << endmsg;
1140 return static_cast<AlsaPort*>(src)->disconnect (dst_port);
1144 AlsaAudioBackend::disconnect_all (PortEngine::PortHandle port)
1146 if (!valid_port (port)) {
1147 PBD::error << _("AlsaBackend::disconnect_all: Invalid Port") << endmsg;
1150 static_cast<AlsaPort*>(port)->disconnect_all ();
1155 AlsaAudioBackend::connected (PortEngine::PortHandle port, bool /* process_callback_safe*/)
1157 if (!valid_port (port)) {
1158 PBD::error << _("AlsaBackend::disconnect_all: Invalid Port") << endmsg;
1161 return static_cast<AlsaPort*>(port)->is_connected ();
1165 AlsaAudioBackend::connected_to (PortEngine::PortHandle src, const std::string& dst, bool /*process_callback_safe*/)
1167 AlsaPort* dst_port = find_port (dst);
1168 if (!valid_port (src) || !dst_port) {
1169 PBD::error << _("AlsaBackend::connected_to: Invalid Port") << endmsg;
1172 return static_cast<AlsaPort*>(src)->is_connected (dst_port);
1176 AlsaAudioBackend::physically_connected (PortEngine::PortHandle port, bool /*process_callback_safe*/)
1178 if (!valid_port (port)) {
1179 PBD::error << _("AlsaBackend::physically_connected: Invalid Port") << endmsg;
1182 return static_cast<AlsaPort*>(port)->is_physically_connected ();
1186 AlsaAudioBackend::get_connections (PortEngine::PortHandle port, std::vector<std::string>& names, bool /*process_callback_safe*/)
1188 if (!valid_port (port)) {
1189 PBD::error << _("AlsaBackend::get_connections: Invalid Port") << endmsg;
1193 assert (0 == names.size ());
1195 const std::vector<AlsaPort*>& connected_ports = static_cast<AlsaPort*>(port)->get_connections ();
1197 for (std::vector<AlsaPort*>::const_iterator i = connected_ports.begin (); i != connected_ports.end (); ++i) {
1198 names.push_back ((*i)->name ());
1201 return (int)names.size ();
1206 AlsaAudioBackend::midi_event_get (
1207 pframes_t& timestamp,
1208 size_t& size, uint8_t** buf, void* port_buffer,
1209 uint32_t event_index)
1211 assert (buf && port_buffer);
1212 AlsaMidiBuffer& source = * static_cast<AlsaMidiBuffer*>(port_buffer);
1213 if (event_index >= source.size ()) {
1216 AlsaMidiEvent * const event = source[event_index].get ();
1218 timestamp = event->timestamp ();
1219 size = event->size ();
1220 *buf = event->data ();
1225 AlsaAudioBackend::midi_event_put (
1227 pframes_t timestamp,
1228 const uint8_t* buffer, size_t size)
1230 assert (buffer && port_buffer);
1231 AlsaMidiBuffer& dst = * static_cast<AlsaMidiBuffer*>(port_buffer);
1232 if (dst.size () && (pframes_t)dst.back ()->timestamp () > timestamp) {
1233 fprintf (stderr, "AlsaMidiBuffer: it's too late for this event. %d > %d\n",
1234 (pframes_t)dst.back ()->timestamp (), timestamp);
1237 dst.push_back (boost::shared_ptr<AlsaMidiEvent>(new AlsaMidiEvent (timestamp, buffer, size)));
1242 AlsaAudioBackend::get_midi_event_count (void* port_buffer)
1244 assert (port_buffer);
1245 return static_cast<AlsaMidiBuffer*>(port_buffer)->size ();
1249 AlsaAudioBackend::midi_clear (void* port_buffer)
1251 assert (port_buffer);
1252 AlsaMidiBuffer * buf = static_cast<AlsaMidiBuffer*>(port_buffer);
1260 AlsaAudioBackend::can_monitor_input () const
1266 AlsaAudioBackend::request_input_monitoring (PortEngine::PortHandle, bool)
1272 AlsaAudioBackend::ensure_input_monitoring (PortEngine::PortHandle, bool)
1278 AlsaAudioBackend::monitoring_input (PortEngine::PortHandle)
1283 /* Latency management */
1286 AlsaAudioBackend::set_latency_range (PortEngine::PortHandle port, bool for_playback, LatencyRange latency_range)
1288 if (!valid_port (port)) {
1289 PBD::error << _("AlsaPort::set_latency_range (): invalid port.") << endmsg;
1291 static_cast<AlsaPort*>(port)->set_latency_range (latency_range, for_playback);
1295 AlsaAudioBackend::get_latency_range (PortEngine::PortHandle port, bool for_playback)
1297 if (!valid_port (port)) {
1298 PBD::error << _("AlsaPort::get_latency_range (): invalid port.") << endmsg;
1304 return static_cast<AlsaPort*>(port)->latency_range (for_playback);
1307 /* Discovering physical ports */
1310 AlsaAudioBackend::port_is_physical (PortEngine::PortHandle port) const
1312 if (!valid_port (port)) {
1313 PBD::error << _("AlsaPort::port_is_physical (): invalid port.") << endmsg;
1316 return static_cast<AlsaPort*>(port)->is_physical ();
1320 AlsaAudioBackend::get_physical_outputs (DataType type, std::vector<std::string>& port_names)
1322 for (size_t i = 0; i < _ports.size (); ++i) {
1323 AlsaPort* port = _ports[i];
1324 if ((port->type () == type) && port->is_input () && port->is_physical ()) {
1325 port_names.push_back (port->name ());
1331 AlsaAudioBackend::get_physical_inputs (DataType type, std::vector<std::string>& port_names)
1333 for (size_t i = 0; i < _ports.size (); ++i) {
1334 AlsaPort* port = _ports[i];
1335 if ((port->type () == type) && port->is_output () && port->is_physical ()) {
1336 port_names.push_back (port->name ());
1342 AlsaAudioBackend::n_physical_outputs () const
1346 for (size_t i = 0; i < _ports.size (); ++i) {
1347 AlsaPort* port = _ports[i];
1348 if (port->is_output () && port->is_physical ()) {
1349 switch (port->type ()) {
1350 case DataType::AUDIO: ++n_audio; break;
1351 case DataType::MIDI: ++n_midi; break;
1357 cc.set (DataType::AUDIO, n_audio);
1358 cc.set (DataType::MIDI, n_midi);
1363 AlsaAudioBackend::n_physical_inputs () const
1367 for (size_t i = 0; i < _ports.size (); ++i) {
1368 AlsaPort* port = _ports[i];
1369 if (port->is_input () && port->is_physical ()) {
1370 switch (port->type ()) {
1371 case DataType::AUDIO: ++n_audio; break;
1372 case DataType::MIDI: ++n_midi; break;
1378 cc.set (DataType::AUDIO, n_audio);
1379 cc.set (DataType::MIDI, n_midi);
1383 /* Getting access to the data buffer for a port */
1386 AlsaAudioBackend::get_buffer (PortEngine::PortHandle port, pframes_t nframes)
1389 assert (valid_port (port));
1390 return static_cast<AlsaPort*>(port)->get_buffer (nframes);
1393 /* Engine Process */
1395 AlsaAudioBackend::main_process_thread ()
1397 AudioEngine::thread_init_callback (this);
1399 _processed_samples = 0;
1401 uint64_t clock1, clock2;
1402 _pcmi->pcm_start ();
1403 int no_proc_errors = 0;
1404 const int bailout = 2 * _samplerate / _samples_per_period;
1405 const int64_t nomial_time = 1e6 * _samples_per_period / _samplerate;
1407 manager.registration_callback();
1408 manager.graph_order_callback();
1413 if (!_freewheeling) {
1414 nr = _pcmi->pcm_wait ();
1416 if (_pcmi->state () > 0) {
1420 if (_pcmi->state () < 0 || no_proc_errors > bailout) {
1421 PBD::error << _("AlsaAudioBackend: I/O error. Audio Process Terminated.") << endmsg;
1424 while (nr >= (long)_samples_per_period) {
1426 clock1 = g_get_monotonic_time();
1429 _pcmi->capt_init (_samples_per_period);
1430 for (std::vector<AlsaPort*>::const_iterator it = _system_inputs.begin (); it != _system_inputs.end (); ++it, ++i) {
1431 _pcmi->capt_chan (i, (float*)((*it)->get_buffer(_samples_per_period)), _samples_per_period);
1433 _pcmi->capt_done (_samples_per_period);
1435 /* de-queue incoming midi*/
1437 for (std::vector<AlsaPort*>::const_iterator it = _system_midi_in.begin (); it != _system_midi_in.end (); ++it, ++i) {
1438 assert (_rmidi_in.size() > i);
1439 AlsaMidiIn *rm = _rmidi_in.at(i);
1440 void *bptr = (*it)->get_buffer(0);
1442 uint8_t data[64]; // match MaxAlsaEventSize in alsa_rawmidi.cc
1443 size_t size = sizeof(data);
1445 while (rm->recv_event (time, data, size)) {
1446 midi_event_put(bptr, time, data, size);
1447 size = sizeof(data);
1449 rm->sync_time (clock1);
1452 for (std::vector<AlsaPort*>::const_iterator it = _system_outputs.begin (); it != _system_outputs.end (); ++it) {
1453 memset ((*it)->get_buffer (_samples_per_period), 0, _samples_per_period * sizeof (Sample));
1456 if (engine.process_callback (_samples_per_period)) {
1462 for (std::vector<AlsaPort*>::iterator it = _system_midi_out.begin (); it != _system_midi_out.end (); ++it) {
1463 static_cast<AlsaMidiPort*>(*it)->next_period();
1466 /* queue outgoing midi */
1468 for (std::vector<AlsaPort*>::const_iterator it = _system_midi_out.begin (); it != _system_midi_out.end (); ++it, ++i) {
1469 assert (_rmidi_out.size() > i);
1470 const AlsaMidiBuffer src = static_cast<const AlsaMidiPort*>(*it)->const_buffer();
1471 AlsaMidiOut *rm = _rmidi_out.at(i);
1472 rm->sync_time (clock1);
1473 for (AlsaMidiBuffer::const_iterator mit = src.begin (); mit != src.end (); ++mit) {
1474 rm->send_event ((*mit)->timestamp(), (*mit)->data(), (*mit)->size());
1478 /* write back audio */
1480 _pcmi->play_init (_samples_per_period);
1481 for (std::vector<AlsaPort*>::const_iterator it = _system_outputs.begin (); it != _system_outputs.end (); ++it, ++i) {
1482 _pcmi->play_chan (i, (const float*)(*it)->get_buffer (_samples_per_period), _samples_per_period);
1484 for (; i < _pcmi->nplay (); ++i) {
1485 _pcmi->clear_chan (i, _samples_per_period);
1487 _pcmi->play_done (_samples_per_period);
1488 nr -= _samples_per_period;
1489 _processed_samples += _samples_per_period;
1491 /* calculate DSP load */
1492 clock2 = g_get_monotonic_time();
1493 const int64_t elapsed_time = clock2 - clock1;
1494 _dsp_load = elapsed_time / (float) nomial_time;
1497 if (xrun && (_pcmi->capt_xrun() > 0 || _pcmi->play_xrun() > 0)) {
1500 fprintf(stderr, "ALSA x-run read: %.1f ms, write: %.1f ms\n",
1501 _pcmi->capt_xrun() * 1000.0, _pcmi->play_xrun() * 1000.0);
1507 // zero audio input buffers
1508 for (std::vector<AlsaPort*>::const_iterator it = _system_inputs.begin (); it != _system_inputs.end (); ++it) {
1509 memset ((*it)->get_buffer (_samples_per_period), 0, _samples_per_period * sizeof (Sample));
1512 clock1 = g_get_monotonic_time();
1514 for (std::vector<AlsaPort*>::const_iterator it = _system_midi_in.begin (); it != _system_midi_in.end (); ++it, ++i) {
1515 static_cast<AlsaMidiBuffer*>((*it)->get_buffer(0))->clear ();
1516 AlsaMidiIn *rm = _rmidi_in.at(i);
1517 void *bptr = (*it)->get_buffer(0);
1518 midi_clear(bptr); // zero midi buffer
1520 // TODO add an API call for this.
1522 uint8_t data[64]; // match MaxAlsaEventSize in alsa_rawmidi.cc
1523 size_t size = sizeof(data);
1524 while (rm->recv_event (time, data, size)) {
1525 ; // discard midi-data from HW.
1527 rm->sync_time (clock1);
1530 if (engine.process_callback (_samples_per_period)) {
1536 // drop all outgoing MIDI messages
1537 for (std::vector<AlsaPort*>::const_iterator it = _system_midi_out.begin (); it != _system_midi_out.end (); ++it) {
1538 void *bptr = (*it)->get_buffer(0);
1543 Glib::usleep (100); // don't hog cpu
1546 bool connections_changed = false;
1547 bool ports_changed = false;
1548 if (!pthread_mutex_trylock (&_port_callback_mutex)) {
1549 if (_port_change_flag) {
1550 ports_changed = true;
1551 _port_change_flag = false;
1553 if (!_port_connection_queue.empty ()) {
1554 connections_changed = true;
1556 while (!_port_connection_queue.empty ()) {
1557 PortConnectData *c = _port_connection_queue.back ();
1558 manager.connect_callback (c->a, c->b, c->c);
1559 _port_connection_queue.pop_back ();
1562 pthread_mutex_unlock (&_port_callback_mutex);
1564 if (ports_changed) {
1565 manager.registration_callback();
1567 if (connections_changed) {
1568 manager.graph_order_callback();
1570 if (connections_changed || ports_changed) {
1571 engine.latency_callback(false);
1572 engine.latency_callback(true);
1579 engine.halted_callback("ALSA I/O error.");
1585 /******************************************************************************/
1587 static boost::shared_ptr<AlsaAudioBackend> _instance;
1589 static boost::shared_ptr<AudioBackend> backend_factory (AudioEngine& e);
1590 static int instantiate (const std::string& arg1, const std::string& /* arg2 */);
1591 static int deinstantiate ();
1592 static bool already_configured ();
1593 static bool available ();
1595 static ARDOUR::AudioBackendInfo _descriptor = {
1604 static boost::shared_ptr<AudioBackend>
1605 backend_factory (AudioEngine& e)
1608 _instance.reset (new AlsaAudioBackend (e, _descriptor));
1614 instantiate (const std::string& arg1, const std::string& /* arg2 */)
1616 s_instance_name = arg1;
1628 already_configured ()
1639 extern "C" ARDOURBACKEND_API ARDOUR::AudioBackendInfo* descriptor ()
1641 return &_descriptor;
1645 /******************************************************************************/
1646 AlsaPort::AlsaPort (AlsaAudioBackend &b, const std::string& name, PortFlags flags)
1651 _capture_latency_range.min = 0;
1652 _capture_latency_range.max = 0;
1653 _playback_latency_range.min = 0;
1654 _playback_latency_range.max = 0;
1657 AlsaPort::~AlsaPort () {
1662 int AlsaPort::connect (AlsaPort *port)
1665 PBD::error << _("AlsaPort::connect (): invalid (null) port") << endmsg;
1669 if (type () != port->type ()) {
1670 PBD::error << _("AlsaPort::connect (): wrong port-type") << endmsg;
1674 if (is_output () && port->is_output ()) {
1675 PBD::error << _("AlsaPort::connect (): cannot inter-connect output ports.") << endmsg;
1679 if (is_input () && port->is_input ()) {
1680 PBD::error << _("AlsaPort::connect (): cannot inter-connect input ports.") << endmsg;
1685 PBD::error << _("AlsaPort::connect (): cannot self-connect ports.") << endmsg;
1689 if (is_connected (port)) {
1690 #if 0 // don't bother to warn about this for now. just ignore it
1691 PBD::error << _("AlsaPort::connect (): ports are already connected:")
1692 << " (" << name () << ") -> (" << port->name () << ")"
1698 _connect (port, true);
1703 void AlsaPort::_connect (AlsaPort *port, bool callback)
1705 _connections.push_back (port);
1707 port->_connect (this, false);
1708 _alsa_backend.port_connect_callback (name(), port->name(), true);
1712 int AlsaPort::disconnect (AlsaPort *port)
1715 PBD::error << _("AlsaPort::disconnect (): invalid (null) port") << endmsg;
1719 if (!is_connected (port)) {
1720 PBD::error << _("AlsaPort::disconnect (): ports are not connected:")
1721 << " (" << name () << ") -> (" << port->name () << ")"
1725 _disconnect (port, true);
1729 void AlsaPort::_disconnect (AlsaPort *port, bool callback)
1731 std::vector<AlsaPort*>::iterator it = std::find (_connections.begin (), _connections.end (), port);
1733 assert (it != _connections.end ());
1735 _connections.erase (it);
1738 port->_disconnect (this, false);
1739 _alsa_backend.port_connect_callback (name(), port->name(), false);
1744 void AlsaPort::disconnect_all ()
1746 while (!_connections.empty ()) {
1747 _connections.back ()->_disconnect (this, false);
1748 _alsa_backend.port_connect_callback (name(), _connections.back ()->name(), false);
1749 _connections.pop_back ();
1754 AlsaPort::is_connected (const AlsaPort *port) const
1756 return std::find (_connections.begin (), _connections.end (), port) != _connections.end ();
1759 bool AlsaPort::is_physically_connected () const
1761 for (std::vector<AlsaPort*>::const_iterator it = _connections.begin (); it != _connections.end (); ++it) {
1762 if ((*it)->is_physical ()) {
1769 /******************************************************************************/
1771 AlsaAudioPort::AlsaAudioPort (AlsaAudioBackend &b, const std::string& name, PortFlags flags)
1772 : AlsaPort (b, name, flags)
1774 memset (_buffer, 0, sizeof (_buffer));
1775 mlock(_buffer, sizeof (_buffer));
1778 AlsaAudioPort::~AlsaAudioPort () { }
1780 void* AlsaAudioPort::get_buffer (pframes_t n_samples)
1783 std::vector<AlsaPort*>::const_iterator it = get_connections ().begin ();
1784 if (it == get_connections ().end ()) {
1785 memset (_buffer, 0, n_samples * sizeof (Sample));
1787 AlsaAudioPort const * source = static_cast<const AlsaAudioPort*>(*it);
1788 assert (source && source->is_output ());
1789 memcpy (_buffer, source->const_buffer (), n_samples * sizeof (Sample));
1790 while (++it != get_connections ().end ()) {
1791 source = static_cast<const AlsaAudioPort*>(*it);
1792 assert (source && source->is_output ());
1793 Sample* dst = buffer ();
1794 const Sample* src = source->const_buffer ();
1795 for (uint32_t s = 0; s < n_samples; ++s, ++dst, ++src) {
1805 AlsaMidiPort::AlsaMidiPort (AlsaAudioBackend &b, const std::string& name, PortFlags flags)
1806 : AlsaPort (b, name, flags)
1810 _buffer[0].clear ();
1811 _buffer[1].clear ();
1814 AlsaMidiPort::~AlsaMidiPort () { }
1816 struct MidiEventSorter {
1817 bool operator() (const boost::shared_ptr<AlsaMidiEvent>& a, const boost::shared_ptr<AlsaMidiEvent>& b) {
1822 void* AlsaMidiPort::get_buffer (pframes_t /* nframes */)
1825 (_buffer[_bufperiod]).clear ();
1826 for (std::vector<AlsaPort*>::const_iterator i = get_connections ().begin ();
1827 i != get_connections ().end ();
1829 const AlsaMidiBuffer src = static_cast<const AlsaMidiPort*>(*i)->const_buffer ();
1830 for (AlsaMidiBuffer::const_iterator it = src.begin (); it != src.end (); ++it) {
1831 (_buffer[_bufperiod]).push_back (boost::shared_ptr<AlsaMidiEvent>(new AlsaMidiEvent (**it)));
1834 std::sort ((_buffer[_bufperiod]).begin (), (_buffer[_bufperiod]).end (), MidiEventSorter());
1836 return &(_buffer[_bufperiod]);
1839 AlsaMidiEvent::AlsaMidiEvent (const pframes_t timestamp, const uint8_t* data, size_t size)
1841 , _timestamp (timestamp)
1845 _data = (uint8_t*) malloc (size);
1846 memcpy (_data, data, size);
1850 AlsaMidiEvent::AlsaMidiEvent (const AlsaMidiEvent& other)
1851 : _size (other.size ())
1852 , _timestamp (other.timestamp ())
1855 if (other.size () && other.const_data ()) {
1856 _data = (uint8_t*) malloc (other.size ());
1857 memcpy (_data, other.const_data (), other.size ());
1861 AlsaMidiEvent::~AlsaMidiEvent () {