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;
42 AlsaAudioBackend::AlsaAudioBackend (AudioEngine& e, AudioBackendInfo& info)
43 : AudioBackend (e, info)
47 , _freewheeling (false)
48 , _measure_latency (false)
50 , _midi_driver_option(_("None"))
51 , _device_reservation(0)
53 , _samples_per_period (1024)
54 , _periods_per_cycle (2)
57 , _systemic_audio_input_latency (0)
58 , _systemic_audio_output_latency (0)
60 , _processed_samples (0)
61 , _port_change_flag (false)
63 _instance_name = s_instance_name;
64 pthread_mutex_init (&_port_callback_mutex, 0);
67 AlsaAudioBackend::~AlsaAudioBackend ()
69 pthread_mutex_destroy (&_port_callback_mutex);
72 /* AUDIOBACKEND API */
75 AlsaAudioBackend::name () const
81 AlsaAudioBackend::is_realtime () const
86 std::vector<AudioBackend::DeviceStatus>
87 AlsaAudioBackend::enumerate_devices () const
89 std::vector<AudioBackend::DeviceStatus> s;
90 std::map<std::string, std::string> devices;
91 get_alsa_audio_device_names(devices);
92 for (std::map<std::string, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
93 s.push_back (DeviceStatus (i->first, true));
99 AlsaAudioBackend::reservation_stdout (std::string d, size_t /* s */)
101 if (d.substr(0, 19) == "Acquired audio-card") {
102 _reservation_succeeded = true;
107 AlsaAudioBackend::release_device()
109 _reservation_connection.drop_connections();
110 ARDOUR::SystemExec * tmp = _device_reservation;
111 _device_reservation = 0;
116 AlsaAudioBackend::acquire_device(const char* device_name)
118 /* This is quick hack, ideally we'll link against libdbus and implement a dbus-listener
119 * that owns the device. here we try to get away by just requesting it and then block it...
120 * (pulseaudio periodically checks anyway)
122 * dbus-send --session --print-reply --type=method_call --dest=org.freedesktop.ReserveDevice1.Audio2 /org/freedesktop/ReserveDevice1/Audio2 org.freedesktop.ReserveDevice1.RequestRelease int32:4
123 * -> should not return 'boolean false'
125 int device_number = card_to_num(device_name);
126 if (device_number < 0) return false;
128 assert(_device_reservation == 0);
129 _reservation_succeeded = false;
131 std::string request_device_exe;
132 if (!PBD::find_file_in_search_path (
133 PBD::Searchpath(Glib::build_filename(ARDOUR::ardour_dll_directory(), "ardouralsautil")
134 + G_SEARCHPATH_SEPARATOR_S + ARDOUR::ardour_dll_directory()),
135 "ardour-request-device", request_device_exe))
137 PBD::warning << "ardour-request-device binary was not found..'" << endmsg;
144 argp=(char**) calloc(5,sizeof(char*));
145 argp[0] = strdup(request_device_exe.c_str());
146 argp[1] = strdup("-P");
147 snprintf(tmp, sizeof(tmp), "%d", getpid());
148 argp[2] = strdup(tmp);
149 snprintf(tmp, sizeof(tmp), "Audio%d", device_number);
150 argp[3] = strdup(tmp);
153 _device_reservation = new ARDOUR::SystemExec(request_device_exe, argp);
154 _device_reservation->ReadStdout.connect_same_thread (_reservation_connection, boost::bind (&AlsaAudioBackend::reservation_stdout, this, _1 ,_2));
155 _device_reservation->Terminated.connect_same_thread (_reservation_connection, boost::bind (&AlsaAudioBackend::release_device, this));
156 if (_device_reservation->start(0)) {
157 PBD::warning << _("AlsaAudioBackend: Device Request failed.") << endmsg;
162 // wait to check if reservation suceeded.
163 int timeout = 500; // 5 sec
164 while (_device_reservation && !_reservation_succeeded && --timeout > 0) {
167 if (timeout == 0 || !_reservation_succeeded) {
168 PBD::warning << _("AlsaAudioBackend: Device Reservation failed.") << endmsg;
176 AlsaAudioBackend::available_sample_rates (const std::string&) const
178 std::vector<float> sr;
179 sr.push_back (8000.0);
180 sr.push_back (22050.0);
181 sr.push_back (24000.0);
182 sr.push_back (44100.0);
183 sr.push_back (48000.0);
184 sr.push_back (88200.0);
185 sr.push_back (96000.0);
186 sr.push_back (176400.0);
187 sr.push_back (192000.0);
191 std::vector<uint32_t>
192 AlsaAudioBackend::available_buffer_sizes (const std::string&) const
194 std::vector<uint32_t> bs;
208 AlsaAudioBackend::available_input_channel_count (const std::string&) const
210 return 128; // TODO query current device
214 AlsaAudioBackend::available_output_channel_count (const std::string&) const
216 return 128; // TODO query current device
220 AlsaAudioBackend::can_change_sample_rate_when_running () const
226 AlsaAudioBackend::can_change_buffer_size_when_running () const
232 AlsaAudioBackend::set_device_name (const std::string& d)
239 AlsaAudioBackend::set_sample_rate (float sr)
241 if (sr <= 0) { return -1; }
243 engine.sample_rate_change (sr);
248 AlsaAudioBackend::set_buffer_size (uint32_t bs)
250 if (bs <= 0 || bs >= _max_buffer_size) {
253 _samples_per_period = bs;
254 engine.buffer_size_change (bs);
259 AlsaAudioBackend::set_interleaved (bool yn)
261 if (!yn) { return 0; }
266 AlsaAudioBackend::set_input_channels (uint32_t cc)
273 AlsaAudioBackend::set_output_channels (uint32_t cc)
280 AlsaAudioBackend::set_systemic_input_latency (uint32_t sl)
282 _systemic_audio_input_latency = sl;
287 AlsaAudioBackend::set_systemic_output_latency (uint32_t sl)
289 _systemic_audio_output_latency = sl;
294 AlsaAudioBackend::set_systemic_midi_input_latency (std::string const device, uint32_t sl)
296 struct AlsaMidiDeviceInfo * nfo = midi_device_info(device);
298 nfo->systemic_input_latency = sl;
303 AlsaAudioBackend::set_systemic_midi_output_latency (std::string const device, uint32_t sl)
305 struct AlsaMidiDeviceInfo * nfo = midi_device_info(device);
307 nfo->systemic_output_latency = sl;
311 /* Retrieving parameters */
313 AlsaAudioBackend::device_name () const
315 return _audio_device;
319 AlsaAudioBackend::sample_rate () const
325 AlsaAudioBackend::buffer_size () const
327 return _samples_per_period;
331 AlsaAudioBackend::interleaved () const
337 AlsaAudioBackend::input_channels () const
343 AlsaAudioBackend::output_channels () const
349 AlsaAudioBackend::systemic_input_latency () const
351 return _systemic_audio_input_latency;
355 AlsaAudioBackend::systemic_output_latency () const
357 return _systemic_audio_output_latency;
361 AlsaAudioBackend::systemic_midi_input_latency (std::string const device) const
363 struct AlsaMidiDeviceInfo * nfo = midi_device_info(device);
365 return nfo->systemic_input_latency;
369 AlsaAudioBackend::systemic_midi_output_latency (std::string const device) const
371 struct AlsaMidiDeviceInfo * nfo = midi_device_info(device);
373 return nfo->systemic_output_latency;
377 struct AlsaAudioBackend::AlsaMidiDeviceInfo *
378 AlsaAudioBackend::midi_device_info(std::string const name) const {
379 for (std::map<std::string, struct AlsaMidiDeviceInfo*>::const_iterator i = _midi_devices.begin (); i != _midi_devices.end(); ++i) {
380 if (i->first == name) {
385 std::map<std::string, std::string> devices;
386 get_alsa_rawmidi_device_names(devices);
387 for (std::map<std::string, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
388 if (i->first == name) {
389 _midi_devices[name] = new AlsaMidiDeviceInfo();
390 return _midi_devices[name];
396 std::vector<std::string>
397 AlsaAudioBackend::enumerate_midi_options () const
399 std::vector<std::string> m;
400 m.push_back (_("None"));
401 m.push_back (_("ALSA raw devices"));
405 std::vector<AudioBackend::DeviceStatus>
406 AlsaAudioBackend::enumerate_midi_devices () const
408 std::vector<AudioBackend::DeviceStatus> s;
409 if (_midi_driver_option == _("None")) {
413 std::map<std::string, std::string> devices;
414 get_alsa_rawmidi_device_names(devices);
416 for (std::map<std::string, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
417 s.push_back (DeviceStatus (i->first, true));
423 AlsaAudioBackend::set_midi_option (const std::string& opt)
425 if (opt != _("None") && opt != _("ALSA raw devices")) {
428 _midi_driver_option = opt;
433 AlsaAudioBackend::midi_option () const
435 return _midi_driver_option;
439 AlsaAudioBackend::set_midi_device_enabled (std::string const device, bool enable)
441 struct AlsaMidiDeviceInfo * nfo = midi_device_info(device);
443 nfo->enabled = enable;
448 AlsaAudioBackend::midi_device_enabled (std::string const device) const
450 struct AlsaMidiDeviceInfo * nfo = midi_device_info(device);
451 if (!nfo) return false;
457 static void * pthread_process (void *arg)
459 AlsaAudioBackend *d = static_cast<AlsaAudioBackend *>(arg);
460 d->main_process_thread ();
466 AlsaAudioBackend::_start (bool for_latency_measurement)
468 if (!_active && _run) {
469 // recover from 'halted', reap threads
473 if (_active || _run) {
474 PBD::error << _("AlsaAudioBackend: already active.") << endmsg;
479 PBD::warning << _("AlsaAudioBackend: recovering from unclean shutdown, port registry is not empty.") << endmsg;
480 _system_inputs.clear();
481 _system_outputs.clear();
482 _system_midi_in.clear();
483 _system_midi_out.clear();
489 assert(_rmidi_in.size() == 0);
490 assert(_rmidi_out.size() == 0);
493 std::string alsa_device;
494 std::map<std::string, std::string> devices;
495 get_alsa_audio_device_names(devices);
496 for (std::map<std::string, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
497 if (i->first == _audio_device) {
498 alsa_device = i->second;
503 acquire_device(alsa_device.c_str());
504 _pcmi = new Alsa_pcmi (alsa_device.c_str(), alsa_device.c_str(), 0, _samplerate, _samples_per_period, _periods_per_cycle, 0);
505 switch (_pcmi->state ()) {
506 case 0: /* OK */ break;
507 case -1: PBD::error << _("AlsaAudioBackend: failed to open device.") << endmsg; break;
508 case -2: PBD::error << _("AlsaAudioBackend: failed to allocate parameters.") << endmsg; break;
509 case -3: PBD::error << _("AlsaAudioBackend: cannot set requested sample rate.") << endmsg; break;
510 case -4: PBD::error << _("AlsaAudioBackend: cannot set requested period size.") << endmsg; break;
511 case -5: PBD::error << _("AlsaAudioBackend: cannot set requested number of periods.") << endmsg; break;
512 case -6: PBD::error << _("AlsaAudioBackend: unsupported sample format.") << endmsg; break;
513 default: PBD::error << _("AlsaAudioBackend: initialization failed.") << endmsg; break;
515 if (_pcmi->state ()) {
516 delete _pcmi; _pcmi = 0;
525 if (_n_outputs != _pcmi->nplay ()) {
526 if (_n_outputs == 0) {
527 _n_outputs = _pcmi->nplay ();
529 _n_outputs = std::min (_n_outputs, _pcmi->nplay ());
531 PBD::warning << _("AlsaAudioBackend: adjusted output channel count to match device.") << endmsg;
534 if (_n_inputs != _pcmi->ncapt ()) {
535 if (_n_inputs == 0) {
536 _n_inputs = _pcmi->ncapt ();
538 _n_inputs = std::min (_n_inputs, _pcmi->ncapt ());
540 PBD::warning << _("AlsaAudioBackend: adjusted input channel count to match device.") << endmsg;
543 if (_pcmi->fsize() != _samples_per_period) {
544 _samples_per_period = _pcmi->fsize();
545 PBD::warning << _("AlsaAudioBackend: samples per period does not match.") << endmsg;
548 if (_pcmi->fsamp() != _samplerate) {
549 _samplerate = _pcmi->fsamp();
550 engine.sample_rate_change (_samplerate);
551 PBD::warning << _("AlsaAudioBackend: sample rate does not match.") << endmsg;
554 _measure_latency = for_latency_measurement;
556 register_system_midi_ports();
558 if (register_system_audio_ports()) {
559 PBD::error << _("AlsaAudioBackend: failed to register system ports.") << endmsg;
560 delete _pcmi; _pcmi = 0;
565 engine.sample_rate_change (_samplerate);
566 engine.buffer_size_change (_samples_per_period);
568 if (engine.reestablish_ports ()) {
569 PBD::error << _("AlsaAudioBackend: Could not re-establish ports.") << endmsg;
570 delete _pcmi; _pcmi = 0;
575 engine.reconnect_ports ();
577 _port_change_flag = false;
579 if (_realtime_pthread_create (SCHED_FIFO, -20, 100000,
580 &_main_thread, pthread_process, this))
582 if (pthread_create (&_main_thread, NULL, pthread_process, this))
584 PBD::error << _("AlsaAudioBackend: failed to create process thread.") << endmsg;
585 delete _pcmi; _pcmi = 0;
590 PBD::warning << _("AlsaAudioBackend: cannot acquire realtime permissions.") << endmsg;
595 while (!_active && --timeout > 0) { Glib::usleep (1000); }
597 if (timeout == 0 || !_active) {
598 PBD::error << _("AlsaAudioBackend: failed to start process thread.") << endmsg;
599 delete _pcmi; _pcmi = 0;
609 AlsaAudioBackend::stop ()
617 if (pthread_join (_main_thread, &status)) {
618 PBD::error << _("AlsaAudioBackend: failed to terminate.") << endmsg;
622 while (!_rmidi_out.empty ()) {
623 AlsaRawMidiIO *m = _rmidi_out.back ();
625 _rmidi_out.pop_back ();
628 while (!_rmidi_in.empty ()) {
629 AlsaRawMidiIO *m = _rmidi_in.back ();
631 _rmidi_in.pop_back ();
635 unregister_system_ports();
636 delete _pcmi; _pcmi = 0;
639 return (_active == false) ? 0 : -1;
643 AlsaAudioBackend::freewheel (bool onoff)
645 if (onoff == _freewheeling) {
648 _freewheeling = onoff;
649 engine.freewheel_callback (onoff);
654 AlsaAudioBackend::dsp_load () const
656 return 100.f * _dsp_load;
660 AlsaAudioBackend::raw_buffer_size (DataType t)
663 case DataType::AUDIO:
664 return _samples_per_period * sizeof(Sample);
666 return _max_buffer_size; // XXX not really limited
673 AlsaAudioBackend::sample_time ()
675 return _processed_samples;
679 AlsaAudioBackend::sample_time_at_cycle_start ()
681 return _processed_samples;
685 AlsaAudioBackend::samples_since_cycle_start ()
692 AlsaAudioBackend::alsa_process_thread (void *arg)
694 ThreadData* td = reinterpret_cast<ThreadData*> (arg);
695 boost::function<void ()> f = td->f;
702 AlsaAudioBackend::create_process_thread (boost::function<void()> func)
706 size_t stacksize = 100000;
708 ThreadData* td = new ThreadData (this, func, stacksize);
710 if (_realtime_pthread_create (SCHED_FIFO, -21, stacksize,
711 &thread_id, alsa_process_thread, td)) {
712 pthread_attr_init (&attr);
713 pthread_attr_setstacksize (&attr, stacksize);
714 if (pthread_create (&thread_id, &attr, alsa_process_thread, td)) {
715 PBD::error << _("AudioEngine: cannot create process thread.") << endmsg;
716 pthread_attr_destroy (&attr);
719 pthread_attr_destroy (&attr);
722 _threads.push_back (thread_id);
727 AlsaAudioBackend::join_process_threads ()
731 for (std::vector<pthread_t>::const_iterator i = _threads.begin (); i != _threads.end (); ++i)
734 if (pthread_join (*i, &status)) {
735 PBD::error << _("AudioEngine: cannot terminate process thread.") << endmsg;
744 AlsaAudioBackend::in_process_thread ()
746 for (std::vector<pthread_t>::const_iterator i = _threads.begin (); i != _threads.end (); ++i)
748 if (pthread_equal (*i, pthread_self ()) != 0) {
756 AlsaAudioBackend::process_thread_count ()
758 return _threads.size ();
762 AlsaAudioBackend::update_latencies ()
764 // trigger latency callback in RT thread (locked graph)
765 port_connect_add_remove_callback();
771 AlsaAudioBackend::private_handle () const
777 AlsaAudioBackend::my_name () const
779 return _instance_name;
783 AlsaAudioBackend::available () const
785 return _run && _active;
789 AlsaAudioBackend::port_name_size () const
795 AlsaAudioBackend::set_port_name (PortEngine::PortHandle port, const std::string& name)
797 if (!valid_port (port)) {
798 PBD::error << _("AlsaBackend::set_port_name: Invalid Port(s)") << endmsg;
801 return static_cast<AlsaPort*>(port)->set_name (_instance_name + ":" + name);
805 AlsaAudioBackend::get_port_name (PortEngine::PortHandle port) const
807 if (!valid_port (port)) {
808 PBD::error << _("AlsaBackend::get_port_name: Invalid Port(s)") << endmsg;
809 return std::string ();
811 return static_cast<AlsaPort*>(port)->name ();
814 PortEngine::PortHandle
815 AlsaAudioBackend::get_port_by_name (const std::string& name) const
817 PortHandle port = (PortHandle) find_port (name);
822 AlsaAudioBackend::get_ports (
823 const std::string& port_name_pattern,
824 DataType type, PortFlags flags,
825 std::vector<std::string>& port_names) const
829 bool use_regexp = false;
830 if (port_name_pattern.size () > 0) {
831 if (!regcomp (&port_regex, port_name_pattern.c_str (), REG_EXTENDED|REG_NOSUB)) {
835 for (size_t i = 0; i < _ports.size (); ++i) {
836 AlsaPort* port = _ports[i];
837 if ((port->type () == type) && (port->flags () & flags)) {
838 if (!use_regexp || !regexec (&port_regex, port->name ().c_str (), 0, NULL, 0)) {
839 port_names.push_back (port->name ());
845 regfree (&port_regex);
851 AlsaAudioBackend::port_data_type (PortEngine::PortHandle port) const
853 if (!valid_port (port)) {
854 return DataType::NIL;
856 return static_cast<AlsaPort*>(port)->type ();
859 PortEngine::PortHandle
860 AlsaAudioBackend::register_port (
861 const std::string& name,
862 ARDOUR::DataType type,
863 ARDOUR::PortFlags flags)
865 if (name.size () == 0) { return 0; }
866 if (flags & IsPhysical) { return 0; }
867 return add_port (_instance_name + ":" + name, type, flags);
870 PortEngine::PortHandle
871 AlsaAudioBackend::add_port (
872 const std::string& name,
873 ARDOUR::DataType type,
874 ARDOUR::PortFlags flags)
876 assert(name.size ());
877 if (find_port (name)) {
878 PBD::error << _("AlsaBackend::register_port: Port already exists:")
879 << " (" << name << ")" << endmsg;
882 AlsaPort* port = NULL;
884 case DataType::AUDIO:
885 port = new AlsaAudioPort (*this, name, flags);
888 port = new AlsaMidiPort (*this, name, flags);
891 PBD::error << _("AlsaBackend::register_port: Invalid Data Type.") << endmsg;
895 _ports.push_back (port);
901 AlsaAudioBackend::unregister_port (PortEngine::PortHandle port_handle)
903 if (!valid_port (port_handle)) {
904 PBD::error << _("AlsaBackend::unregister_port: Invalid Port.") << endmsg;
906 AlsaPort* port = static_cast<AlsaPort*>(port_handle);
907 std::vector<AlsaPort*>::iterator i = std::find (_ports.begin (), _ports.end (), static_cast<AlsaPort*>(port_handle));
908 if (i == _ports.end ()) {
909 PBD::error << _("AlsaBackend::unregister_port: Failed to find port") << endmsg;
912 disconnect_all(port_handle);
918 AlsaAudioBackend::register_system_audio_ports()
922 const int a_ins = _n_inputs > 0 ? _n_inputs : 2;
923 const int a_out = _n_outputs > 0 ? _n_outputs : 2;
926 lr.min = lr.max = _samples_per_period + (_measure_latency ? 0 : _systemic_audio_input_latency);
927 for (int i = 1; i <= a_ins; ++i) {
929 snprintf(tmp, sizeof(tmp), "system:capture_%d", i);
930 PortHandle p = add_port(std::string(tmp), DataType::AUDIO, static_cast<PortFlags>(IsOutput | IsPhysical | IsTerminal));
932 set_latency_range (p, false, lr);
933 _system_inputs.push_back(static_cast<AlsaPort*>(p));
936 lr.min = lr.max = _samples_per_period + (_measure_latency ? 0 : _systemic_audio_output_latency);
937 for (int i = 1; i <= a_out; ++i) {
939 snprintf(tmp, sizeof(tmp), "system:playback_%d", i);
940 PortHandle p = add_port(std::string(tmp), DataType::AUDIO, static_cast<PortFlags>(IsInput | IsPhysical | IsTerminal));
942 set_latency_range (p, true, lr);
943 _system_outputs.push_back(static_cast<AlsaPort*>(p));
949 AlsaAudioBackend::register_system_midi_ports()
951 std::map<std::string, std::string> devices;
955 if (_midi_driver_option == _("None")) {
958 get_alsa_rawmidi_device_names(devices);
960 for (std::map<std::string, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
961 struct AlsaMidiDeviceInfo * nfo = midi_device_info(i->first);
963 if (!nfo->enabled) continue;
965 AlsaRawMidiOut *mout = new AlsaRawMidiOut (i->second.c_str());
966 if (mout->state ()) {
967 PBD::warning << string_compose (
968 _("AlsaRawMidiOut: failed to open midi device '%1'."), i->second)
972 mout->setup_timing(_samples_per_period, _samplerate);
973 mout->sync_time (g_get_monotonic_time());
974 if (mout->start ()) {
975 PBD::warning << string_compose (
976 _("AlsaRawMidiOut: failed to start midi device '%1'."), i->second)
981 snprintf(tmp, sizeof(tmp), "system:midi_playback_%d", ++midi_ins);
982 PortHandle p = add_port(std::string(tmp), DataType::MIDI, static_cast<PortFlags>(IsInput | IsPhysical | IsTerminal));
988 lr.min = lr.max = _samples_per_period + (_measure_latency ? 0 : nfo->systemic_output_latency);
989 set_latency_range (p, false, lr);
990 _system_midi_out.push_back(static_cast<AlsaPort*>(p));
991 _rmidi_out.push_back (mout);
995 AlsaRawMidiIn *midin = new AlsaRawMidiIn (i->second.c_str());
996 if (midin->state ()) {
997 PBD::warning << string_compose (
998 _("AlsaRawMidiIn: failed to open midi device '%1'."), i->second)
1002 midin->setup_timing(_samples_per_period, _samplerate);
1003 midin->sync_time (g_get_monotonic_time());
1004 if (midin->start ()) {
1005 PBD::warning << string_compose (
1006 _("AlsaRawMidiIn: failed to start midi device '%1'."), i->second)
1011 snprintf(tmp, sizeof(tmp), "system:midi_capture_%d", ++midi_outs);
1012 PortHandle p = add_port(std::string(tmp), DataType::MIDI, static_cast<PortFlags>(IsOutput | IsPhysical | IsTerminal));
1019 lr.min = lr.max = _samples_per_period + (_measure_latency ? 0 : nfo->systemic_input_latency);
1020 set_latency_range (p, false, lr);
1021 _system_midi_in.push_back(static_cast<AlsaPort*>(p));
1022 _rmidi_in.push_back (midin);
1030 AlsaAudioBackend::unregister_system_ports()
1033 _system_inputs.clear();
1034 _system_outputs.clear();
1035 _system_midi_in.clear();
1036 _system_midi_out.clear();
1037 while (i < _ports.size ()) {
1038 AlsaPort* port = _ports[i];
1039 if (port->is_physical () && port->is_terminal ()) {
1040 port->disconnect_all ();
1041 _ports.erase (_ports.begin() + i);
1049 AlsaAudioBackend::connect (const std::string& src, const std::string& dst)
1051 AlsaPort* src_port = find_port (src);
1052 AlsaPort* dst_port = find_port (dst);
1055 PBD::error << _("AlsaBackend::connect: Invalid Source port:")
1056 << " (" << src <<")" << endmsg;
1060 PBD::error << _("AlsaBackend::connect: Invalid Destination port:")
1061 << " (" << dst <<")" << endmsg;
1064 return src_port->connect (dst_port);
1068 AlsaAudioBackend::disconnect (const std::string& src, const std::string& dst)
1070 AlsaPort* src_port = find_port (src);
1071 AlsaPort* dst_port = find_port (dst);
1073 if (!src_port || !dst_port) {
1074 PBD::error << _("AlsaBackend::disconnect: Invalid Port(s)") << endmsg;
1077 return src_port->disconnect (dst_port);
1081 AlsaAudioBackend::connect (PortEngine::PortHandle src, const std::string& dst)
1083 AlsaPort* dst_port = find_port (dst);
1084 if (!valid_port (src)) {
1085 PBD::error << _("AlsaBackend::connect: Invalid Source Port Handle") << endmsg;
1089 PBD::error << _("AlsaBackend::connect: Invalid Destination Port")
1090 << " (" << dst << ")" << endmsg;
1093 return static_cast<AlsaPort*>(src)->connect (dst_port);
1097 AlsaAudioBackend::disconnect (PortEngine::PortHandle src, const std::string& dst)
1099 AlsaPort* dst_port = find_port (dst);
1100 if (!valid_port (src) || !dst_port) {
1101 PBD::error << _("AlsaBackend::disconnect: Invalid Port(s)") << endmsg;
1104 return static_cast<AlsaPort*>(src)->disconnect (dst_port);
1108 AlsaAudioBackend::disconnect_all (PortEngine::PortHandle port)
1110 if (!valid_port (port)) {
1111 PBD::error << _("AlsaBackend::disconnect_all: Invalid Port") << endmsg;
1114 static_cast<AlsaPort*>(port)->disconnect_all ();
1119 AlsaAudioBackend::connected (PortEngine::PortHandle port, bool /* process_callback_safe*/)
1121 if (!valid_port (port)) {
1122 PBD::error << _("AlsaBackend::disconnect_all: Invalid Port") << endmsg;
1125 return static_cast<AlsaPort*>(port)->is_connected ();
1129 AlsaAudioBackend::connected_to (PortEngine::PortHandle src, const std::string& dst, bool /*process_callback_safe*/)
1131 AlsaPort* dst_port = find_port (dst);
1132 if (!valid_port (src) || !dst_port) {
1133 PBD::error << _("AlsaBackend::connected_to: Invalid Port") << endmsg;
1136 return static_cast<AlsaPort*>(src)->is_connected (dst_port);
1140 AlsaAudioBackend::physically_connected (PortEngine::PortHandle port, bool /*process_callback_safe*/)
1142 if (!valid_port (port)) {
1143 PBD::error << _("AlsaBackend::physically_connected: Invalid Port") << endmsg;
1146 return static_cast<AlsaPort*>(port)->is_physically_connected ();
1150 AlsaAudioBackend::get_connections (PortEngine::PortHandle port, std::vector<std::string>& names, bool /*process_callback_safe*/)
1152 if (!valid_port (port)) {
1153 PBD::error << _("AlsaBackend::get_connections: Invalid Port") << endmsg;
1157 assert (0 == names.size ());
1159 const std::vector<AlsaPort*>& connected_ports = static_cast<AlsaPort*>(port)->get_connections ();
1161 for (std::vector<AlsaPort*>::const_iterator i = connected_ports.begin (); i != connected_ports.end (); ++i) {
1162 names.push_back ((*i)->name ());
1165 return (int)names.size ();
1170 AlsaAudioBackend::midi_event_get (
1171 pframes_t& timestamp,
1172 size_t& size, uint8_t** buf, void* port_buffer,
1173 uint32_t event_index)
1175 assert (buf && port_buffer);
1176 AlsaMidiBuffer& source = * static_cast<AlsaMidiBuffer*>(port_buffer);
1177 if (event_index >= source.size ()) {
1180 AlsaMidiEvent * const event = source[event_index].get ();
1182 timestamp = event->timestamp ();
1183 size = event->size ();
1184 *buf = event->data ();
1189 AlsaAudioBackend::midi_event_put (
1191 pframes_t timestamp,
1192 const uint8_t* buffer, size_t size)
1194 assert (buffer && port_buffer);
1195 AlsaMidiBuffer& dst = * static_cast<AlsaMidiBuffer*>(port_buffer);
1196 if (dst.size () && (pframes_t)dst.back ()->timestamp () > timestamp) {
1197 fprintf (stderr, "AlsaMidiBuffer: it's too late for this event. %d > %d\n",
1198 (pframes_t)dst.back ()->timestamp (), timestamp);
1201 dst.push_back (boost::shared_ptr<AlsaMidiEvent>(new AlsaMidiEvent (timestamp, buffer, size)));
1206 AlsaAudioBackend::get_midi_event_count (void* port_buffer)
1208 assert (port_buffer);
1209 return static_cast<AlsaMidiBuffer*>(port_buffer)->size ();
1213 AlsaAudioBackend::midi_clear (void* port_buffer)
1215 assert (port_buffer);
1216 AlsaMidiBuffer * buf = static_cast<AlsaMidiBuffer*>(port_buffer);
1224 AlsaAudioBackend::can_monitor_input () const
1230 AlsaAudioBackend::request_input_monitoring (PortEngine::PortHandle, bool)
1236 AlsaAudioBackend::ensure_input_monitoring (PortEngine::PortHandle, bool)
1242 AlsaAudioBackend::monitoring_input (PortEngine::PortHandle)
1247 /* Latency management */
1250 AlsaAudioBackend::set_latency_range (PortEngine::PortHandle port, bool for_playback, LatencyRange latency_range)
1252 if (!valid_port (port)) {
1253 PBD::error << _("AlsaPort::set_latency_range (): invalid port.") << endmsg;
1255 static_cast<AlsaPort*>(port)->set_latency_range (latency_range, for_playback);
1259 AlsaAudioBackend::get_latency_range (PortEngine::PortHandle port, bool for_playback)
1261 if (!valid_port (port)) {
1262 PBD::error << _("AlsaPort::get_latency_range (): invalid port.") << endmsg;
1268 return static_cast<AlsaPort*>(port)->latency_range (for_playback);
1271 /* Discovering physical ports */
1274 AlsaAudioBackend::port_is_physical (PortEngine::PortHandle port) const
1276 if (!valid_port (port)) {
1277 PBD::error << _("AlsaPort::port_is_physical (): invalid port.") << endmsg;
1280 return static_cast<AlsaPort*>(port)->is_physical ();
1284 AlsaAudioBackend::get_physical_outputs (DataType type, std::vector<std::string>& port_names)
1286 for (size_t i = 0; i < _ports.size (); ++i) {
1287 AlsaPort* port = _ports[i];
1288 if ((port->type () == type) && port->is_input () && port->is_physical ()) {
1289 port_names.push_back (port->name ());
1295 AlsaAudioBackend::get_physical_inputs (DataType type, std::vector<std::string>& port_names)
1297 for (size_t i = 0; i < _ports.size (); ++i) {
1298 AlsaPort* port = _ports[i];
1299 if ((port->type () == type) && port->is_output () && port->is_physical ()) {
1300 port_names.push_back (port->name ());
1306 AlsaAudioBackend::n_physical_outputs () const
1310 for (size_t i = 0; i < _ports.size (); ++i) {
1311 AlsaPort* port = _ports[i];
1312 if (port->is_output () && port->is_physical ()) {
1313 switch (port->type ()) {
1314 case DataType::AUDIO: ++n_audio; break;
1315 case DataType::MIDI: ++n_midi; break;
1321 cc.set (DataType::AUDIO, n_audio);
1322 cc.set (DataType::MIDI, n_midi);
1327 AlsaAudioBackend::n_physical_inputs () const
1331 for (size_t i = 0; i < _ports.size (); ++i) {
1332 AlsaPort* port = _ports[i];
1333 if (port->is_input () && port->is_physical ()) {
1334 switch (port->type ()) {
1335 case DataType::AUDIO: ++n_audio; break;
1336 case DataType::MIDI: ++n_midi; break;
1342 cc.set (DataType::AUDIO, n_audio);
1343 cc.set (DataType::MIDI, n_midi);
1347 /* Getting access to the data buffer for a port */
1350 AlsaAudioBackend::get_buffer (PortEngine::PortHandle port, pframes_t nframes)
1353 assert (valid_port (port));
1354 return static_cast<AlsaPort*>(port)->get_buffer (nframes);
1357 /* Engine Process */
1359 AlsaAudioBackend::main_process_thread ()
1361 AudioEngine::thread_init_callback (this);
1363 _processed_samples = 0;
1365 uint64_t clock1, clock2;
1366 clock1 = g_get_monotonic_time();
1367 _pcmi->pcm_start ();
1368 int no_proc_errors = 0;
1369 const int bailout = 2 * _samplerate / _samples_per_period;
1370 const int64_t nomial_time = 1e6 * _samples_per_period / _samplerate;
1372 manager.registration_callback();
1373 manager.graph_order_callback();
1378 if (!_freewheeling) {
1379 nr = _pcmi->pcm_wait ();
1381 if (_pcmi->state () > 0) {
1385 if (_pcmi->state () < 0 || no_proc_errors > bailout) {
1386 PBD::error << _("AlsaAudioBackend: I/O error. Audio Process Terminated.") << endmsg;
1390 while (nr >= (long)_samples_per_period) {
1392 clock1 = g_get_monotonic_time();
1395 _pcmi->capt_init (_samples_per_period);
1396 for (std::vector<AlsaPort*>::const_iterator it = _system_inputs.begin (); it != _system_inputs.end (); ++it, ++i) {
1397 _pcmi->capt_chan (i, (float*)((*it)->get_buffer(_samples_per_period)), _samples_per_period);
1399 _pcmi->capt_done (_samples_per_period);
1403 for (std::vector<AlsaPort*>::const_iterator it = _system_midi_in.begin (); it != _system_midi_in.end (); ++it, ++i) {
1404 assert (_rmidi_in.size() > i);
1405 AlsaRawMidiIn *rm = static_cast<AlsaRawMidiIn*>(_rmidi_in.at(i));
1406 void *bptr = (*it)->get_buffer(0);
1408 uint8_t data[64]; // match MaxAlsaRawEventSize in alsa_rawmidi.cc
1409 size_t size = sizeof(data);
1411 while (rm->recv_event (time, data, size)) {
1412 midi_event_put(bptr, time, data, size);
1413 size = sizeof(data);
1415 rm->sync_time (clock1);
1418 for (std::vector<AlsaPort*>::const_iterator it = _system_outputs.begin (); it != _system_outputs.end (); ++it) {
1419 memset ((*it)->get_buffer (_samples_per_period), 0, _samples_per_period * sizeof (Sample));
1422 if (engine.process_callback (_samples_per_period)) {
1429 for (std::vector<AlsaPort*>::iterator it = _system_midi_out.begin (); it != _system_midi_out.end (); ++it, ++i) {
1430 static_cast<AlsaMidiPort*>(*it)->next_period();
1435 for (std::vector<AlsaPort*>::const_iterator it = _system_midi_out.begin (); it != _system_midi_out.end (); ++it, ++i) {
1436 assert (_rmidi_out.size() > i);
1437 const AlsaMidiBuffer src = static_cast<const AlsaMidiPort*>(*it)->const_buffer();
1438 AlsaRawMidiOut *rm = static_cast<AlsaRawMidiOut*>(_rmidi_out.at(i));
1439 rm->sync_time (clock1);
1440 for (AlsaMidiBuffer::const_iterator mit = src.begin (); mit != src.end (); ++mit) {
1441 rm->send_event ((*mit)->timestamp(), (*mit)->data(), (*mit)->size());
1445 /* write back audio */
1447 _pcmi->play_init (_samples_per_period);
1448 for (std::vector<AlsaPort*>::const_iterator it = _system_outputs.begin (); it != _system_outputs.end (); ++it, ++i) {
1449 _pcmi->play_chan (i, (const float*)(*it)->get_buffer (_samples_per_period), _samples_per_period);
1451 for (; i < _pcmi->nplay (); ++i) {
1452 _pcmi->clear_chan (i, _samples_per_period);
1454 _pcmi->play_done (_samples_per_period);
1455 nr -= _samples_per_period;
1456 _processed_samples += _samples_per_period;
1458 /* calculate DSP load */
1459 clock2 = g_get_monotonic_time();
1460 const int64_t elapsed_time = clock2 - clock1;
1461 _dsp_load = elapsed_time / (float) nomial_time;
1465 fprintf(stderr, "grouped audio periods %d != 1\n", gop);
1468 if (xrun && (_pcmi->capt_xrun() > 0 || _pcmi->play_xrun() > 0)) {
1471 fprintf(stderr, "ALSA x-run read: %.1f ms, write: %.1f ms\n",
1472 _pcmi->capt_xrun() * 1000.0, _pcmi->play_xrun() * 1000.0);
1477 for (std::vector<AlsaPort*>::const_iterator it = _system_inputs.begin (); it != _system_inputs.end (); ++it) {
1478 memset ((*it)->get_buffer (_samples_per_period), 0, _samples_per_period * sizeof (Sample));
1480 for (std::vector<AlsaPort*>::const_iterator it = _system_midi_in.begin (); it != _system_midi_in.end (); ++it) {
1481 static_cast<AlsaMidiBuffer*>((*it)->get_buffer(0))->clear ();
1484 if (engine.process_callback (_samples_per_period)) {
1489 Glib::usleep (100); // don't hog cpu
1492 bool connections_changed = false;
1493 bool ports_changed = false;
1494 if (!pthread_mutex_trylock (&_port_callback_mutex)) {
1495 if (_port_change_flag) {
1496 ports_changed = true;
1497 _port_change_flag = false;
1499 if (!_port_connection_queue.empty ()) {
1500 connections_changed = true;
1502 while (!_port_connection_queue.empty ()) {
1503 PortConnectData *c = _port_connection_queue.back ();
1504 manager.connect_callback (c->a, c->b, c->c);
1505 _port_connection_queue.pop_back ();
1508 pthread_mutex_unlock (&_port_callback_mutex);
1510 if (ports_changed) {
1511 manager.registration_callback();
1513 if (connections_changed) {
1514 manager.graph_order_callback();
1516 if (connections_changed || ports_changed) {
1517 engine.latency_callback(false);
1518 engine.latency_callback(true);
1525 engine.halted_callback("ALSA I/O error.");
1531 /******************************************************************************/
1533 static boost::shared_ptr<AlsaAudioBackend> _instance;
1535 static boost::shared_ptr<AudioBackend> backend_factory (AudioEngine& e);
1536 static int instantiate (const std::string& arg1, const std::string& /* arg2 */);
1537 static int deinstantiate ();
1538 static bool already_configured ();
1540 static ARDOUR::AudioBackendInfo _descriptor = {
1548 static boost::shared_ptr<AudioBackend>
1549 backend_factory (AudioEngine& e)
1552 _instance.reset (new AlsaAudioBackend (e, _descriptor));
1558 instantiate (const std::string& arg1, const std::string& /* arg2 */)
1560 s_instance_name = arg1;
1572 already_configured ()
1577 extern "C" ARDOURBACKEND_API ARDOUR::AudioBackendInfo* descriptor ()
1579 return &_descriptor;
1583 /******************************************************************************/
1584 AlsaPort::AlsaPort (AlsaAudioBackend &b, const std::string& name, PortFlags flags)
1589 _capture_latency_range.min = 0;
1590 _capture_latency_range.max = 0;
1591 _playback_latency_range.min = 0;
1592 _playback_latency_range.max = 0;
1595 AlsaPort::~AlsaPort () {
1600 int AlsaPort::connect (AlsaPort *port)
1603 PBD::error << _("AlsaPort::connect (): invalid (null) port") << endmsg;
1607 if (type () != port->type ()) {
1608 PBD::error << _("AlsaPort::connect (): wrong port-type") << endmsg;
1612 if (is_output () && port->is_output ()) {
1613 PBD::error << _("AlsaPort::connect (): cannot inter-connect output ports.") << endmsg;
1617 if (is_input () && port->is_input ()) {
1618 PBD::error << _("AlsaPort::connect (): cannot inter-connect input ports.") << endmsg;
1623 PBD::error << _("AlsaPort::connect (): cannot self-connect ports.") << endmsg;
1627 if (is_connected (port)) {
1628 #if 0 // don't bother to warn about this for now. just ignore it
1629 PBD::error << _("AlsaPort::connect (): ports are already connected:")
1630 << " (" << name () << ") -> (" << port->name () << ")"
1636 _connect (port, true);
1641 void AlsaPort::_connect (AlsaPort *port, bool callback)
1643 _connections.push_back (port);
1645 port->_connect (this, false);
1646 _alsa_backend.port_connect_callback (name(), port->name(), true);
1650 int AlsaPort::disconnect (AlsaPort *port)
1653 PBD::error << _("AlsaPort::disconnect (): invalid (null) port") << endmsg;
1657 if (!is_connected (port)) {
1658 PBD::error << _("AlsaPort::disconnect (): ports are not connected:")
1659 << " (" << name () << ") -> (" << port->name () << ")"
1663 _disconnect (port, true);
1667 void AlsaPort::_disconnect (AlsaPort *port, bool callback)
1669 std::vector<AlsaPort*>::iterator it = std::find (_connections.begin (), _connections.end (), port);
1671 assert (it != _connections.end ());
1673 _connections.erase (it);
1676 port->_disconnect (this, false);
1677 _alsa_backend.port_connect_callback (name(), port->name(), false);
1682 void AlsaPort::disconnect_all ()
1684 while (!_connections.empty ()) {
1685 _connections.back ()->_disconnect (this, false);
1686 _alsa_backend.port_connect_callback (name(), _connections.back ()->name(), false);
1687 _connections.pop_back ();
1692 AlsaPort::is_connected (const AlsaPort *port) const
1694 return std::find (_connections.begin (), _connections.end (), port) != _connections.end ();
1697 bool AlsaPort::is_physically_connected () const
1699 for (std::vector<AlsaPort*>::const_iterator it = _connections.begin (); it != _connections.end (); ++it) {
1700 if ((*it)->is_physical ()) {
1707 /******************************************************************************/
1709 AlsaAudioPort::AlsaAudioPort (AlsaAudioBackend &b, const std::string& name, PortFlags flags)
1710 : AlsaPort (b, name, flags)
1712 memset (_buffer, 0, sizeof (_buffer));
1713 mlock(_buffer, sizeof (_buffer));
1716 AlsaAudioPort::~AlsaAudioPort () { }
1718 void* AlsaAudioPort::get_buffer (pframes_t n_samples)
1721 std::vector<AlsaPort*>::const_iterator it = get_connections ().begin ();
1722 if (it == get_connections ().end ()) {
1723 memset (_buffer, 0, n_samples * sizeof (Sample));
1725 AlsaAudioPort const * source = static_cast<const AlsaAudioPort*>(*it);
1726 assert (source && source->is_output ());
1727 memcpy (_buffer, source->const_buffer (), n_samples * sizeof (Sample));
1728 while (++it != get_connections ().end ()) {
1729 source = static_cast<const AlsaAudioPort*>(*it);
1730 assert (source && source->is_output ());
1731 Sample* dst = buffer ();
1732 const Sample* src = source->const_buffer ();
1733 for (uint32_t s = 0; s < n_samples; ++s, ++dst, ++src) {
1743 AlsaMidiPort::AlsaMidiPort (AlsaAudioBackend &b, const std::string& name, PortFlags flags)
1744 : AlsaPort (b, name, flags)
1747 _buffer[0].clear ();
1748 _buffer[1].clear ();
1751 AlsaMidiPort::~AlsaMidiPort () { }
1753 struct MidiEventSorter {
1754 bool operator() (const boost::shared_ptr<AlsaMidiEvent>& a, const boost::shared_ptr<AlsaMidiEvent>& b) {
1759 void* AlsaMidiPort::get_buffer (pframes_t /* nframes */)
1762 (_buffer[_bufperiod]).clear ();
1763 for (std::vector<AlsaPort*>::const_iterator i = get_connections ().begin ();
1764 i != get_connections ().end ();
1766 const AlsaMidiBuffer src = static_cast<const AlsaMidiPort*>(*i)->const_buffer ();
1767 for (AlsaMidiBuffer::const_iterator it = src.begin (); it != src.end (); ++it) {
1768 (_buffer[_bufperiod]).push_back (boost::shared_ptr<AlsaMidiEvent>(new AlsaMidiEvent (**it)));
1771 std::sort ((_buffer[_bufperiod]).begin (), (_buffer[_bufperiod]).end (), MidiEventSorter());
1773 return &(_buffer[_bufperiod]);
1776 AlsaMidiEvent::AlsaMidiEvent (const pframes_t timestamp, const uint8_t* data, size_t size)
1778 , _timestamp (timestamp)
1782 _data = (uint8_t*) malloc (size);
1783 memcpy (_data, data, size);
1787 AlsaMidiEvent::AlsaMidiEvent (const AlsaMidiEvent& other)
1788 : _size (other.size ())
1789 , _timestamp (other.timestamp ())
1792 if (other.size () && other.const_data ()) {
1793 _data = (uint8_t*) malloc (other.size ());
1794 memcpy (_data, other.const_data (), other.size ());
1798 AlsaMidiEvent::~AlsaMidiEvent () {