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("")
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;
401 m.push_back (_("-None-"));
402 std::map<std::string, std::string> devices;
403 get_alsa_rawmidi_device_names(devices);
405 for (std::map<std::string, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
406 m.push_back (i->first);
409 m.push_back (_("-All-"));
412 m.push_back (_("None"));
413 m.push_back (_("ALSA raw devices"));
418 std::vector<AudioBackend::DeviceStatus>
419 AlsaAudioBackend::enumerate_midi_devices () const
421 std::vector<AudioBackend::DeviceStatus> s;
423 std::map<std::string, std::string> devices;
424 get_alsa_rawmidi_device_names(devices);
426 for (std::map<std::string, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
427 s.push_back (DeviceStatus (i->first, true));
433 AlsaAudioBackend::set_midi_option (const std::string& opt)
435 _midi_driver_option = opt;
440 AlsaAudioBackend::midi_option () const
442 return _midi_driver_option;
446 AlsaAudioBackend::set_midi_device_enabled (std::string const device, bool enable)
448 struct AlsaMidiDeviceInfo * nfo = midi_device_info(device);
450 nfo->enabled = enable;
455 AlsaAudioBackend::midi_device_enabled (std::string const device) const
457 struct AlsaMidiDeviceInfo * nfo = midi_device_info(device);
458 if (!nfo) return false;
464 static void * pthread_process (void *arg)
466 AlsaAudioBackend *d = static_cast<AlsaAudioBackend *>(arg);
467 d->main_process_thread ();
473 AlsaAudioBackend::_start (bool for_latency_measurement)
475 if (!_active && _run) {
476 // recover from 'halted', reap threads
480 if (_active || _run) {
481 PBD::error << _("AlsaAudioBackend: already active.") << endmsg;
486 PBD::warning << _("AlsaAudioBackend: recovering from unclean shutdown, port registry is not empty.") << endmsg;
487 _system_inputs.clear();
488 _system_outputs.clear();
489 _system_midi_in.clear();
490 _system_midi_out.clear();
496 assert(_rmidi_in.size() == 0);
497 assert(_rmidi_out.size() == 0);
500 std::string alsa_device;
501 std::map<std::string, std::string> devices;
502 get_alsa_audio_device_names(devices);
503 for (std::map<std::string, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
504 if (i->first == _audio_device) {
505 alsa_device = i->second;
510 acquire_device(alsa_device.c_str());
511 _pcmi = new Alsa_pcmi (alsa_device.c_str(), alsa_device.c_str(), 0, _samplerate, _samples_per_period, _periods_per_cycle, 0);
512 switch (_pcmi->state ()) {
513 case 0: /* OK */ break;
514 case -1: PBD::error << _("AlsaAudioBackend: failed to open device.") << endmsg; break;
515 case -2: PBD::error << _("AlsaAudioBackend: failed to allocate parameters.") << endmsg; break;
516 case -3: PBD::error << _("AlsaAudioBackend: cannot set requested sample rate.") << endmsg; break;
517 case -4: PBD::error << _("AlsaAudioBackend: cannot set requested period size.") << endmsg; break;
518 case -5: PBD::error << _("AlsaAudioBackend: cannot set requested number of periods.") << endmsg; break;
519 case -6: PBD::error << _("AlsaAudioBackend: unsupported sample format.") << endmsg; break;
520 default: PBD::error << _("AlsaAudioBackend: initialization failed.") << endmsg; break;
522 if (_pcmi->state ()) {
523 delete _pcmi; _pcmi = 0;
532 if (_n_outputs != _pcmi->nplay ()) {
533 if (_n_outputs == 0) {
534 _n_outputs = _pcmi->nplay ();
536 _n_outputs = std::min (_n_outputs, _pcmi->nplay ());
538 PBD::warning << _("AlsaAudioBackend: adjusted output channel count to match device.") << endmsg;
541 if (_n_inputs != _pcmi->ncapt ()) {
542 if (_n_inputs == 0) {
543 _n_inputs = _pcmi->ncapt ();
545 _n_inputs = std::min (_n_inputs, _pcmi->ncapt ());
547 PBD::warning << _("AlsaAudioBackend: adjusted input channel count to match device.") << endmsg;
550 if (_pcmi->fsize() != _samples_per_period) {
551 _samples_per_period = _pcmi->fsize();
552 PBD::warning << _("AlsaAudioBackend: samples per period does not match.") << endmsg;
555 if (_pcmi->fsamp() != _samplerate) {
556 _samplerate = _pcmi->fsamp();
557 engine.sample_rate_change (_samplerate);
558 PBD::warning << _("AlsaAudioBackend: sample rate does not match.") << endmsg;
561 _measure_latency = for_latency_measurement;
563 register_system_midi_ports();
565 if (register_system_audio_ports()) {
566 PBD::error << _("AlsaAudioBackend: failed to register system ports.") << endmsg;
567 delete _pcmi; _pcmi = 0;
572 engine.sample_rate_change (_samplerate);
573 engine.buffer_size_change (_samples_per_period);
575 if (engine.reestablish_ports ()) {
576 PBD::error << _("AlsaAudioBackend: Could not re-establish ports.") << endmsg;
577 delete _pcmi; _pcmi = 0;
582 engine.reconnect_ports ();
584 _port_change_flag = false;
586 if (_realtime_pthread_create (SCHED_FIFO, -20, 100000,
587 &_main_thread, pthread_process, this))
589 if (pthread_create (&_main_thread, NULL, pthread_process, this))
591 PBD::error << _("AlsaAudioBackend: failed to create process thread.") << endmsg;
592 delete _pcmi; _pcmi = 0;
597 PBD::warning << _("AlsaAudioBackend: cannot acquire realtime permissions.") << endmsg;
602 while (!_active && --timeout > 0) { Glib::usleep (1000); }
604 if (timeout == 0 || !_active) {
605 PBD::error << _("AlsaAudioBackend: failed to start process thread.") << endmsg;
606 delete _pcmi; _pcmi = 0;
616 AlsaAudioBackend::stop ()
624 if (pthread_join (_main_thread, &status)) {
625 PBD::error << _("AlsaAudioBackend: failed to terminate.") << endmsg;
629 while (!_rmidi_out.empty ()) {
630 AlsaRawMidiIO *m = _rmidi_out.back ();
632 _rmidi_out.pop_back ();
635 while (!_rmidi_in.empty ()) {
636 AlsaRawMidiIO *m = _rmidi_in.back ();
638 _rmidi_in.pop_back ();
642 unregister_system_ports();
643 delete _pcmi; _pcmi = 0;
646 return (_active == false) ? 0 : -1;
650 AlsaAudioBackend::freewheel (bool onoff)
652 if (onoff == _freewheeling) {
655 _freewheeling = onoff;
656 engine.freewheel_callback (onoff);
661 AlsaAudioBackend::dsp_load () const
663 return 100.f * _dsp_load;
667 AlsaAudioBackend::raw_buffer_size (DataType t)
670 case DataType::AUDIO:
671 return _samples_per_period * sizeof(Sample);
673 return _max_buffer_size; // XXX not really limited
680 AlsaAudioBackend::sample_time ()
682 return _processed_samples;
686 AlsaAudioBackend::sample_time_at_cycle_start ()
688 return _processed_samples;
692 AlsaAudioBackend::samples_since_cycle_start ()
699 AlsaAudioBackend::alsa_process_thread (void *arg)
701 ThreadData* td = reinterpret_cast<ThreadData*> (arg);
702 boost::function<void ()> f = td->f;
709 AlsaAudioBackend::create_process_thread (boost::function<void()> func)
713 size_t stacksize = 100000;
715 ThreadData* td = new ThreadData (this, func, stacksize);
717 if (_realtime_pthread_create (SCHED_FIFO, -21, stacksize,
718 &thread_id, alsa_process_thread, td)) {
719 pthread_attr_init (&attr);
720 pthread_attr_setstacksize (&attr, stacksize);
721 if (pthread_create (&thread_id, &attr, alsa_process_thread, td)) {
722 PBD::error << _("AudioEngine: cannot create process thread.") << endmsg;
723 pthread_attr_destroy (&attr);
726 pthread_attr_destroy (&attr);
729 _threads.push_back (thread_id);
734 AlsaAudioBackend::join_process_threads ()
738 for (std::vector<pthread_t>::const_iterator i = _threads.begin (); i != _threads.end (); ++i)
741 if (pthread_join (*i, &status)) {
742 PBD::error << _("AudioEngine: cannot terminate process thread.") << endmsg;
751 AlsaAudioBackend::in_process_thread ()
753 for (std::vector<pthread_t>::const_iterator i = _threads.begin (); i != _threads.end (); ++i)
755 if (pthread_equal (*i, pthread_self ()) != 0) {
763 AlsaAudioBackend::process_thread_count ()
765 return _threads.size ();
769 AlsaAudioBackend::update_latencies ()
771 // trigger latency callback in RT thread (locked graph)
772 port_connect_add_remove_callback();
778 AlsaAudioBackend::private_handle () const
784 AlsaAudioBackend::my_name () const
786 return _instance_name;
790 AlsaAudioBackend::available () const
792 return _run && _active;
796 AlsaAudioBackend::port_name_size () const
802 AlsaAudioBackend::set_port_name (PortEngine::PortHandle port, const std::string& name)
804 if (!valid_port (port)) {
805 PBD::error << _("AlsaBackend::set_port_name: Invalid Port(s)") << endmsg;
808 return static_cast<AlsaPort*>(port)->set_name (_instance_name + ":" + name);
812 AlsaAudioBackend::get_port_name (PortEngine::PortHandle port) const
814 if (!valid_port (port)) {
815 PBD::error << _("AlsaBackend::get_port_name: Invalid Port(s)") << endmsg;
816 return std::string ();
818 return static_cast<AlsaPort*>(port)->name ();
821 PortEngine::PortHandle
822 AlsaAudioBackend::get_port_by_name (const std::string& name) const
824 PortHandle port = (PortHandle) find_port (name);
829 AlsaAudioBackend::get_ports (
830 const std::string& port_name_pattern,
831 DataType type, PortFlags flags,
832 std::vector<std::string>& port_names) const
836 bool use_regexp = false;
837 if (port_name_pattern.size () > 0) {
838 if (!regcomp (&port_regex, port_name_pattern.c_str (), REG_EXTENDED|REG_NOSUB)) {
842 for (size_t i = 0; i < _ports.size (); ++i) {
843 AlsaPort* port = _ports[i];
844 if ((port->type () == type) && (port->flags () & flags)) {
845 if (!use_regexp || !regexec (&port_regex, port->name ().c_str (), 0, NULL, 0)) {
846 port_names.push_back (port->name ());
852 regfree (&port_regex);
858 AlsaAudioBackend::port_data_type (PortEngine::PortHandle port) const
860 if (!valid_port (port)) {
861 return DataType::NIL;
863 return static_cast<AlsaPort*>(port)->type ();
866 PortEngine::PortHandle
867 AlsaAudioBackend::register_port (
868 const std::string& name,
869 ARDOUR::DataType type,
870 ARDOUR::PortFlags flags)
872 if (name.size () == 0) { return 0; }
873 if (flags & IsPhysical) { return 0; }
874 return add_port (_instance_name + ":" + name, type, flags);
877 PortEngine::PortHandle
878 AlsaAudioBackend::add_port (
879 const std::string& name,
880 ARDOUR::DataType type,
881 ARDOUR::PortFlags flags)
883 assert(name.size ());
884 if (find_port (name)) {
885 PBD::error << _("AlsaBackend::register_port: Port already exists:")
886 << " (" << name << ")" << endmsg;
889 AlsaPort* port = NULL;
891 case DataType::AUDIO:
892 port = new AlsaAudioPort (*this, name, flags);
895 port = new AlsaMidiPort (*this, name, flags);
898 PBD::error << _("AlsaBackend::register_port: Invalid Data Type.") << endmsg;
902 _ports.push_back (port);
908 AlsaAudioBackend::unregister_port (PortEngine::PortHandle port_handle)
910 if (!valid_port (port_handle)) {
911 PBD::error << _("AlsaBackend::unregister_port: Invalid Port.") << endmsg;
913 AlsaPort* port = static_cast<AlsaPort*>(port_handle);
914 std::vector<AlsaPort*>::iterator i = std::find (_ports.begin (), _ports.end (), static_cast<AlsaPort*>(port_handle));
915 if (i == _ports.end ()) {
916 PBD::error << _("AlsaBackend::unregister_port: Failed to find port") << endmsg;
919 disconnect_all(port_handle);
925 AlsaAudioBackend::register_system_audio_ports()
929 const int a_ins = _n_inputs > 0 ? _n_inputs : 2;
930 const int a_out = _n_outputs > 0 ? _n_outputs : 2;
933 lr.min = lr.max = _samples_per_period + _measure_latency ? 0 : _systemic_audio_input_latency;
934 for (int i = 1; i <= a_ins; ++i) {
936 snprintf(tmp, sizeof(tmp), "system:capture_%d", i);
937 PortHandle p = add_port(std::string(tmp), DataType::AUDIO, static_cast<PortFlags>(IsOutput | IsPhysical | IsTerminal));
939 set_latency_range (p, false, lr);
940 _system_inputs.push_back(static_cast<AlsaPort*>(p));
943 lr.min = lr.max = _samples_per_period + _measure_latency ? 0 : _systemic_audio_output_latency;
944 for (int i = 1; i <= a_out; ++i) {
946 snprintf(tmp, sizeof(tmp), "system:playback_%d", i);
947 PortHandle p = add_port(std::string(tmp), DataType::AUDIO, static_cast<PortFlags>(IsInput | IsPhysical | IsTerminal));
949 set_latency_range (p, true, lr);
950 _system_outputs.push_back(static_cast<AlsaPort*>(p));
956 AlsaAudioBackend::register_system_midi_ports()
959 std::vector<std::string> devices;
961 // TODO new API use midi_device_info();
962 if (_midi_driver_option == _("-None-")) {
965 else if (_midi_driver_option == _("-All-")) {
966 std::map<std::string, std::string> devmap;
967 get_alsa_rawmidi_device_names(devmap);
968 for (std::map<std::string, std::string>::const_iterator i = devmap.begin (); i != devmap.end(); ++i) {
969 devices.push_back (i->second);
972 std::map<std::string, std::string> devmap;
973 get_alsa_rawmidi_device_names(devmap);
974 for (std::map<std::string, std::string>::const_iterator i = devmap.begin (); i != devmap.end(); ++i) {
975 if (i->first == _midi_driver_option) {
976 devices.push_back (i->second);
982 for (std::vector<std::string>::const_iterator i = devices.begin (); i != devices.end (); ++i) {
984 AlsaRawMidiOut *mout = new AlsaRawMidiOut (i->c_str());
985 if (mout->state ()) {
986 PBD::warning << string_compose (
987 _("AlsaRawMidiOut: failed to open midi device '%1'."), *i)
991 mout->setup_timing(_samples_per_period, _samplerate);
992 mout->sync_time (g_get_monotonic_time());
993 if (mout->start ()) {
994 PBD::warning << string_compose (
995 _("AlsaRawMidiOut: failed to start midi device '%1'."), *i)
999 _rmidi_out.push_back (mout);
1003 AlsaRawMidiIn *midin = new AlsaRawMidiIn (i->c_str());
1004 if (midin->state ()) {
1005 PBD::warning << string_compose (
1006 _("AlsaRawMidiIn: failed to open midi device '%1'."), *i)
1010 midin->setup_timing(_samples_per_period, _samplerate);
1011 midin->sync_time (g_get_monotonic_time());
1012 if (midin->start ()) {
1013 PBD::warning << string_compose (
1014 _("AlsaRawMidiIn: failed to start midi device '%1'."), *i)
1018 _rmidi_in.push_back (midin);
1023 const int m_ins = _rmidi_in.size();
1024 const int m_out = _rmidi_out.size();
1026 lr.min = lr.max = _samples_per_period; // + _systemic_midi_input_latency;
1027 for (int i = 1; i <= m_ins; ++i) {
1029 snprintf(tmp, sizeof(tmp), "system:midi_capture_%d", i);
1030 PortHandle p = add_port(std::string(tmp), DataType::MIDI, static_cast<PortFlags>(IsOutput | IsPhysical | IsTerminal));
1032 set_latency_range (p, false, lr);
1033 _system_midi_in.push_back(static_cast<AlsaPort*>(p));
1036 lr.min = lr.max = _samples_per_period; // + _systemic_midi_output_latency;
1037 for (int i = 1; i <= m_out; ++i) {
1039 snprintf(tmp, sizeof(tmp), "system:midi_playback_%d", i);
1040 PortHandle p = add_port(std::string(tmp), DataType::MIDI, static_cast<PortFlags>(IsInput | IsPhysical | IsTerminal));
1042 set_latency_range (p, true, lr);
1043 _system_midi_out.push_back(static_cast<AlsaPort*>(p));
1050 AlsaAudioBackend::unregister_system_ports()
1053 _system_inputs.clear();
1054 _system_outputs.clear();
1055 _system_midi_in.clear();
1056 _system_midi_out.clear();
1057 while (i < _ports.size ()) {
1058 AlsaPort* port = _ports[i];
1059 if (port->is_physical () && port->is_terminal ()) {
1060 port->disconnect_all ();
1061 _ports.erase (_ports.begin() + i);
1069 AlsaAudioBackend::connect (const std::string& src, const std::string& dst)
1071 AlsaPort* src_port = find_port (src);
1072 AlsaPort* dst_port = find_port (dst);
1075 PBD::error << _("AlsaBackend::connect: Invalid Source port:")
1076 << " (" << src <<")" << endmsg;
1080 PBD::error << _("AlsaBackend::connect: Invalid Destination port:")
1081 << " (" << dst <<")" << endmsg;
1084 return src_port->connect (dst_port);
1088 AlsaAudioBackend::disconnect (const std::string& src, const std::string& dst)
1090 AlsaPort* src_port = find_port (src);
1091 AlsaPort* dst_port = find_port (dst);
1093 if (!src_port || !dst_port) {
1094 PBD::error << _("AlsaBackend::disconnect: Invalid Port(s)") << endmsg;
1097 return src_port->disconnect (dst_port);
1101 AlsaAudioBackend::connect (PortEngine::PortHandle src, const std::string& dst)
1103 AlsaPort* dst_port = find_port (dst);
1104 if (!valid_port (src)) {
1105 PBD::error << _("AlsaBackend::connect: Invalid Source Port Handle") << endmsg;
1109 PBD::error << _("AlsaBackend::connect: Invalid Destination Port")
1110 << " (" << dst << ")" << endmsg;
1113 return static_cast<AlsaPort*>(src)->connect (dst_port);
1117 AlsaAudioBackend::disconnect (PortEngine::PortHandle src, const std::string& dst)
1119 AlsaPort* dst_port = find_port (dst);
1120 if (!valid_port (src) || !dst_port) {
1121 PBD::error << _("AlsaBackend::disconnect: Invalid Port(s)") << endmsg;
1124 return static_cast<AlsaPort*>(src)->disconnect (dst_port);
1128 AlsaAudioBackend::disconnect_all (PortEngine::PortHandle port)
1130 if (!valid_port (port)) {
1131 PBD::error << _("AlsaBackend::disconnect_all: Invalid Port") << endmsg;
1134 static_cast<AlsaPort*>(port)->disconnect_all ();
1139 AlsaAudioBackend::connected (PortEngine::PortHandle port, bool /* process_callback_safe*/)
1141 if (!valid_port (port)) {
1142 PBD::error << _("AlsaBackend::disconnect_all: Invalid Port") << endmsg;
1145 return static_cast<AlsaPort*>(port)->is_connected ();
1149 AlsaAudioBackend::connected_to (PortEngine::PortHandle src, const std::string& dst, bool /*process_callback_safe*/)
1151 AlsaPort* dst_port = find_port (dst);
1152 if (!valid_port (src) || !dst_port) {
1153 PBD::error << _("AlsaBackend::connected_to: Invalid Port") << endmsg;
1156 return static_cast<AlsaPort*>(src)->is_connected (dst_port);
1160 AlsaAudioBackend::physically_connected (PortEngine::PortHandle port, bool /*process_callback_safe*/)
1162 if (!valid_port (port)) {
1163 PBD::error << _("AlsaBackend::physically_connected: Invalid Port") << endmsg;
1166 return static_cast<AlsaPort*>(port)->is_physically_connected ();
1170 AlsaAudioBackend::get_connections (PortEngine::PortHandle port, std::vector<std::string>& names, bool /*process_callback_safe*/)
1172 if (!valid_port (port)) {
1173 PBD::error << _("AlsaBackend::get_connections: Invalid Port") << endmsg;
1177 assert (0 == names.size ());
1179 const std::vector<AlsaPort*>& connected_ports = static_cast<AlsaPort*>(port)->get_connections ();
1181 for (std::vector<AlsaPort*>::const_iterator i = connected_ports.begin (); i != connected_ports.end (); ++i) {
1182 names.push_back ((*i)->name ());
1185 return (int)names.size ();
1190 AlsaAudioBackend::midi_event_get (
1191 pframes_t& timestamp,
1192 size_t& size, uint8_t** buf, void* port_buffer,
1193 uint32_t event_index)
1195 assert (buf && port_buffer);
1196 AlsaMidiBuffer& source = * static_cast<AlsaMidiBuffer*>(port_buffer);
1197 if (event_index >= source.size ()) {
1200 AlsaMidiEvent * const event = source[event_index].get ();
1202 timestamp = event->timestamp ();
1203 size = event->size ();
1204 *buf = event->data ();
1209 AlsaAudioBackend::midi_event_put (
1211 pframes_t timestamp,
1212 const uint8_t* buffer, size_t size)
1214 assert (buffer && port_buffer);
1215 AlsaMidiBuffer& dst = * static_cast<AlsaMidiBuffer*>(port_buffer);
1216 if (dst.size () && (pframes_t)dst.back ()->timestamp () > timestamp) {
1217 fprintf (stderr, "AlsaMidiBuffer: it's too late for this event. %d > %d\n",
1218 (pframes_t)dst.back ()->timestamp (), timestamp);
1221 dst.push_back (boost::shared_ptr<AlsaMidiEvent>(new AlsaMidiEvent (timestamp, buffer, size)));
1226 AlsaAudioBackend::get_midi_event_count (void* port_buffer)
1228 assert (port_buffer);
1229 return static_cast<AlsaMidiBuffer*>(port_buffer)->size ();
1233 AlsaAudioBackend::midi_clear (void* port_buffer)
1235 assert (port_buffer);
1236 AlsaMidiBuffer * buf = static_cast<AlsaMidiBuffer*>(port_buffer);
1244 AlsaAudioBackend::can_monitor_input () const
1250 AlsaAudioBackend::request_input_monitoring (PortEngine::PortHandle, bool)
1256 AlsaAudioBackend::ensure_input_monitoring (PortEngine::PortHandle, bool)
1262 AlsaAudioBackend::monitoring_input (PortEngine::PortHandle)
1267 /* Latency management */
1270 AlsaAudioBackend::set_latency_range (PortEngine::PortHandle port, bool for_playback, LatencyRange latency_range)
1272 if (!valid_port (port)) {
1273 PBD::error << _("AlsaPort::set_latency_range (): invalid port.") << endmsg;
1275 static_cast<AlsaPort*>(port)->set_latency_range (latency_range, for_playback);
1279 AlsaAudioBackend::get_latency_range (PortEngine::PortHandle port, bool for_playback)
1281 if (!valid_port (port)) {
1282 PBD::error << _("AlsaPort::get_latency_range (): invalid port.") << endmsg;
1288 return static_cast<AlsaPort*>(port)->latency_range (for_playback);
1291 /* Discovering physical ports */
1294 AlsaAudioBackend::port_is_physical (PortEngine::PortHandle port) const
1296 if (!valid_port (port)) {
1297 PBD::error << _("AlsaPort::port_is_physical (): invalid port.") << endmsg;
1300 return static_cast<AlsaPort*>(port)->is_physical ();
1304 AlsaAudioBackend::get_physical_outputs (DataType type, std::vector<std::string>& port_names)
1306 for (size_t i = 0; i < _ports.size (); ++i) {
1307 AlsaPort* port = _ports[i];
1308 if ((port->type () == type) && port->is_input () && port->is_physical ()) {
1309 port_names.push_back (port->name ());
1315 AlsaAudioBackend::get_physical_inputs (DataType type, std::vector<std::string>& port_names)
1317 for (size_t i = 0; i < _ports.size (); ++i) {
1318 AlsaPort* port = _ports[i];
1319 if ((port->type () == type) && port->is_output () && port->is_physical ()) {
1320 port_names.push_back (port->name ());
1326 AlsaAudioBackend::n_physical_outputs () const
1330 for (size_t i = 0; i < _ports.size (); ++i) {
1331 AlsaPort* port = _ports[i];
1332 if (port->is_output () && port->is_physical ()) {
1333 switch (port->type ()) {
1334 case DataType::AUDIO: ++n_audio; break;
1335 case DataType::MIDI: ++n_midi; break;
1341 cc.set (DataType::AUDIO, n_audio);
1342 cc.set (DataType::MIDI, n_midi);
1347 AlsaAudioBackend::n_physical_inputs () const
1351 for (size_t i = 0; i < _ports.size (); ++i) {
1352 AlsaPort* port = _ports[i];
1353 if (port->is_input () && port->is_physical ()) {
1354 switch (port->type ()) {
1355 case DataType::AUDIO: ++n_audio; break;
1356 case DataType::MIDI: ++n_midi; break;
1362 cc.set (DataType::AUDIO, n_audio);
1363 cc.set (DataType::MIDI, n_midi);
1367 /* Getting access to the data buffer for a port */
1370 AlsaAudioBackend::get_buffer (PortEngine::PortHandle port, pframes_t nframes)
1373 assert (valid_port (port));
1374 return static_cast<AlsaPort*>(port)->get_buffer (nframes);
1377 /* Engine Process */
1379 AlsaAudioBackend::main_process_thread ()
1381 AudioEngine::thread_init_callback (this);
1383 _processed_samples = 0;
1385 uint64_t clock1, clock2;
1386 clock1 = g_get_monotonic_time();
1387 _pcmi->pcm_start ();
1388 int no_proc_errors = 0;
1389 const int bailout = 2 * _samplerate / _samples_per_period;
1390 const int64_t nomial_time = 1e6 * _samples_per_period / _samplerate;
1392 manager.registration_callback();
1393 manager.graph_order_callback();
1398 if (!_freewheeling) {
1399 nr = _pcmi->pcm_wait ();
1401 if (_pcmi->state () > 0) {
1405 if (_pcmi->state () < 0 || no_proc_errors > bailout) {
1406 PBD::error << _("AlsaAudioBackend: I/O error. Audio Process Terminated.") << endmsg;
1409 while (nr >= (long)_samples_per_period) {
1411 clock1 = g_get_monotonic_time();
1414 _pcmi->capt_init (_samples_per_period);
1415 for (std::vector<AlsaPort*>::const_iterator it = _system_inputs.begin (); it != _system_inputs.end (); ++it, ++i) {
1416 _pcmi->capt_chan (i, (float*)((*it)->get_buffer(_samples_per_period)), _samples_per_period);
1418 _pcmi->capt_done (_samples_per_period);
1422 for (std::vector<AlsaPort*>::const_iterator it = _system_midi_in.begin (); it != _system_midi_in.end (); ++it, ++i) {
1423 assert (_rmidi_in.size() > i);
1424 AlsaRawMidiIn *rm = static_cast<AlsaRawMidiIn*>(_rmidi_in.at(i));
1425 void *bptr = (*it)->get_buffer(0);
1427 uint8_t data[64]; // match MaxAlsaRawEventSize in alsa_rawmidi.cc
1428 size_t size = sizeof(data);
1430 while (rm->recv_event (time, data, size)) {
1431 midi_event_put(bptr, time, data, size);
1432 size = sizeof(data);
1434 rm->sync_time (clock1);
1437 for (std::vector<AlsaPort*>::const_iterator it = _system_outputs.begin (); it != _system_outputs.end (); ++it) {
1438 memset ((*it)->get_buffer (_samples_per_period), 0, _samples_per_period * sizeof (Sample));
1441 if (engine.process_callback (_samples_per_period)) {
1448 for (std::vector<AlsaPort*>::iterator it = _system_midi_out.begin (); it != _system_midi_out.end (); ++it, ++i) {
1449 static_cast<AlsaMidiPort*>(*it)->next_period();
1454 for (std::vector<AlsaPort*>::const_iterator it = _system_midi_out.begin (); it != _system_midi_out.end (); ++it, ++i) {
1455 assert (_rmidi_out.size() > i);
1456 const AlsaMidiBuffer src = static_cast<const AlsaMidiPort*>(*it)->const_buffer();
1457 AlsaRawMidiOut *rm = static_cast<AlsaRawMidiOut*>(_rmidi_out.at(i));
1458 rm->sync_time (clock1);
1459 for (AlsaMidiBuffer::const_iterator mit = src.begin (); mit != src.end (); ++mit) {
1460 rm->send_event ((*mit)->timestamp(), (*mit)->data(), (*mit)->size());
1464 /* write back audio */
1466 _pcmi->play_init (_samples_per_period);
1467 for (std::vector<AlsaPort*>::const_iterator it = _system_outputs.begin (); it != _system_outputs.end (); ++it, ++i) {
1468 _pcmi->play_chan (i, (const float*)(*it)->get_buffer (_samples_per_period), _samples_per_period);
1470 for (; i < _pcmi->nplay (); ++i) {
1471 _pcmi->clear_chan (i, _samples_per_period);
1473 _pcmi->play_done (_samples_per_period);
1474 nr -= _samples_per_period;
1475 _processed_samples += _samples_per_period;
1477 /* calculate DSP load */
1478 clock2 = g_get_monotonic_time();
1479 const int64_t elapsed_time = clock2 - clock1;
1480 _dsp_load = elapsed_time / (float) nomial_time;
1483 if (xrun && (_pcmi->capt_xrun() > 0 || _pcmi->play_xrun() > 0)) {
1486 fprintf(stderr, "ALSA x-run read: %.1f ms, write: %.1f ms\n",
1487 _pcmi->capt_xrun() * 1000.0, _pcmi->play_xrun() * 1000.0);
1492 for (std::vector<AlsaPort*>::const_iterator it = _system_inputs.begin (); it != _system_inputs.end (); ++it) {
1493 memset ((*it)->get_buffer (_samples_per_period), 0, _samples_per_period * sizeof (Sample));
1495 for (std::vector<AlsaPort*>::const_iterator it = _system_midi_in.begin (); it != _system_midi_in.end (); ++it) {
1496 static_cast<AlsaMidiBuffer*>((*it)->get_buffer(0))->clear ();
1499 if (engine.process_callback (_samples_per_period)) {
1504 Glib::usleep (100); // don't hog cpu
1507 bool connections_changed = false;
1508 bool ports_changed = false;
1509 if (!pthread_mutex_trylock (&_port_callback_mutex)) {
1510 if (_port_change_flag) {
1511 ports_changed = true;
1512 _port_change_flag = false;
1514 if (!_port_connection_queue.empty ()) {
1515 connections_changed = true;
1517 while (!_port_connection_queue.empty ()) {
1518 PortConnectData *c = _port_connection_queue.back ();
1519 manager.connect_callback (c->a, c->b, c->c);
1520 _port_connection_queue.pop_back ();
1523 pthread_mutex_unlock (&_port_callback_mutex);
1525 if (ports_changed) {
1526 manager.registration_callback();
1528 if (connections_changed) {
1529 manager.graph_order_callback();
1531 if (connections_changed || ports_changed) {
1532 engine.latency_callback(false);
1533 engine.latency_callback(true);
1540 engine.halted_callback("ALSA I/O error.");
1546 /******************************************************************************/
1548 static boost::shared_ptr<AlsaAudioBackend> _instance;
1550 static boost::shared_ptr<AudioBackend> backend_factory (AudioEngine& e);
1551 static int instantiate (const std::string& arg1, const std::string& /* arg2 */);
1552 static int deinstantiate ();
1553 static bool already_configured ();
1555 static ARDOUR::AudioBackendInfo _descriptor = {
1563 static boost::shared_ptr<AudioBackend>
1564 backend_factory (AudioEngine& e)
1567 _instance.reset (new AlsaAudioBackend (e, _descriptor));
1573 instantiate (const std::string& arg1, const std::string& /* arg2 */)
1575 s_instance_name = arg1;
1587 already_configured ()
1592 extern "C" ARDOURBACKEND_API ARDOUR::AudioBackendInfo* descriptor ()
1594 return &_descriptor;
1598 /******************************************************************************/
1599 AlsaPort::AlsaPort (AlsaAudioBackend &b, const std::string& name, PortFlags flags)
1604 _capture_latency_range.min = 0;
1605 _capture_latency_range.max = 0;
1606 _playback_latency_range.min = 0;
1607 _playback_latency_range.max = 0;
1610 AlsaPort::~AlsaPort () {
1615 int AlsaPort::connect (AlsaPort *port)
1618 PBD::error << _("AlsaPort::connect (): invalid (null) port") << endmsg;
1622 if (type () != port->type ()) {
1623 PBD::error << _("AlsaPort::connect (): wrong port-type") << endmsg;
1627 if (is_output () && port->is_output ()) {
1628 PBD::error << _("AlsaPort::connect (): cannot inter-connect output ports.") << endmsg;
1632 if (is_input () && port->is_input ()) {
1633 PBD::error << _("AlsaPort::connect (): cannot inter-connect input ports.") << endmsg;
1638 PBD::error << _("AlsaPort::connect (): cannot self-connect ports.") << endmsg;
1642 if (is_connected (port)) {
1643 #if 0 // don't bother to warn about this for now. just ignore it
1644 PBD::error << _("AlsaPort::connect (): ports are already connected:")
1645 << " (" << name () << ") -> (" << port->name () << ")"
1651 _connect (port, true);
1656 void AlsaPort::_connect (AlsaPort *port, bool callback)
1658 _connections.push_back (port);
1660 port->_connect (this, false);
1661 _alsa_backend.port_connect_callback (name(), port->name(), true);
1665 int AlsaPort::disconnect (AlsaPort *port)
1668 PBD::error << _("AlsaPort::disconnect (): invalid (null) port") << endmsg;
1672 if (!is_connected (port)) {
1673 PBD::error << _("AlsaPort::disconnect (): ports are not connected:")
1674 << " (" << name () << ") -> (" << port->name () << ")"
1678 _disconnect (port, true);
1682 void AlsaPort::_disconnect (AlsaPort *port, bool callback)
1684 std::vector<AlsaPort*>::iterator it = std::find (_connections.begin (), _connections.end (), port);
1686 assert (it != _connections.end ());
1688 _connections.erase (it);
1691 port->_disconnect (this, false);
1692 _alsa_backend.port_connect_callback (name(), port->name(), false);
1697 void AlsaPort::disconnect_all ()
1699 while (!_connections.empty ()) {
1700 _connections.back ()->_disconnect (this, false);
1701 _alsa_backend.port_connect_callback (name(), _connections.back ()->name(), false);
1702 _connections.pop_back ();
1707 AlsaPort::is_connected (const AlsaPort *port) const
1709 return std::find (_connections.begin (), _connections.end (), port) != _connections.end ();
1712 bool AlsaPort::is_physically_connected () const
1714 for (std::vector<AlsaPort*>::const_iterator it = _connections.begin (); it != _connections.end (); ++it) {
1715 if ((*it)->is_physical ()) {
1722 /******************************************************************************/
1724 AlsaAudioPort::AlsaAudioPort (AlsaAudioBackend &b, const std::string& name, PortFlags flags)
1725 : AlsaPort (b, name, flags)
1727 memset (_buffer, 0, sizeof (_buffer));
1728 mlock(_buffer, sizeof (_buffer));
1731 AlsaAudioPort::~AlsaAudioPort () { }
1733 void* AlsaAudioPort::get_buffer (pframes_t n_samples)
1736 std::vector<AlsaPort*>::const_iterator it = get_connections ().begin ();
1737 if (it == get_connections ().end ()) {
1738 memset (_buffer, 0, n_samples * sizeof (Sample));
1740 AlsaAudioPort const * source = static_cast<const AlsaAudioPort*>(*it);
1741 assert (source && source->is_output ());
1742 memcpy (_buffer, source->const_buffer (), n_samples * sizeof (Sample));
1743 while (++it != get_connections ().end ()) {
1744 source = static_cast<const AlsaAudioPort*>(*it);
1745 assert (source && source->is_output ());
1746 Sample* dst = buffer ();
1747 const Sample* src = source->const_buffer ();
1748 for (uint32_t s = 0; s < n_samples; ++s, ++dst, ++src) {
1758 AlsaMidiPort::AlsaMidiPort (AlsaAudioBackend &b, const std::string& name, PortFlags flags)
1759 : AlsaPort (b, name, flags)
1762 _buffer[0].clear ();
1763 _buffer[1].clear ();
1766 AlsaMidiPort::~AlsaMidiPort () { }
1768 struct MidiEventSorter {
1769 bool operator() (const boost::shared_ptr<AlsaMidiEvent>& a, const boost::shared_ptr<AlsaMidiEvent>& b) {
1774 void* AlsaMidiPort::get_buffer (pframes_t /* nframes */)
1777 (_buffer[_bufperiod]).clear ();
1778 for (std::vector<AlsaPort*>::const_iterator i = get_connections ().begin ();
1779 i != get_connections ().end ();
1781 const AlsaMidiBuffer src = static_cast<const AlsaMidiPort*>(*i)->const_buffer ();
1782 for (AlsaMidiBuffer::const_iterator it = src.begin (); it != src.end (); ++it) {
1783 (_buffer[_bufperiod]).push_back (boost::shared_ptr<AlsaMidiEvent>(new AlsaMidiEvent (**it)));
1786 std::sort ((_buffer[_bufperiod]).begin (), (_buffer[_bufperiod]).end (), MidiEventSorter());
1788 return &(_buffer[_bufperiod]);
1791 AlsaMidiEvent::AlsaMidiEvent (const pframes_t timestamp, const uint8_t* data, size_t size)
1793 , _timestamp (timestamp)
1797 _data = (uint8_t*) malloc (size);
1798 memcpy (_data, data, size);
1802 AlsaMidiEvent::AlsaMidiEvent (const AlsaMidiEvent& other)
1803 : _size (other.size ())
1804 , _timestamp (other.timestamp ())
1807 if (other.size () && other.const_data ()) {
1808 _data = (uint8_t*) malloc (other.size ());
1809 memcpy (_data, other.const_data (), other.size ());
1813 AlsaMidiEvent::~AlsaMidiEvent () {