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 assert(_midi_driver_option != _("None"));
387 std::map<std::string, std::string> devices;
388 if (_midi_driver_option == _("ALSA raw devices")) {
389 get_alsa_rawmidi_device_names(devices);
391 get_alsa_sequencer_names (devices);
394 for (std::map<std::string, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
395 if (i->first == name) {
396 _midi_devices[name] = new AlsaMidiDeviceInfo();
397 return _midi_devices[name];
403 std::vector<std::string>
404 AlsaAudioBackend::enumerate_midi_options () const
406 std::vector<std::string> m;
407 m.push_back (_("None"));
408 m.push_back (_("ALSA raw devices"));
409 m.push_back (_("ALSA sequencer"));
413 std::vector<AudioBackend::DeviceStatus>
414 AlsaAudioBackend::enumerate_midi_devices () const
416 std::vector<AudioBackend::DeviceStatus> s;
417 std::map<std::string, std::string> devices;
419 if (_midi_driver_option == _("ALSA raw devices")) {
420 get_alsa_rawmidi_device_names (devices);
422 else if (_midi_driver_option == _("ALSA sequencer")) {
423 get_alsa_sequencer_names (devices);
428 for (std::map<std::string, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
429 s.push_back (DeviceStatus (i->first, true));
435 AlsaAudioBackend::set_midi_option (const std::string& opt)
437 if (opt != _("None") && opt != _("ALSA raw devices") && opt != _("ALSA sequencer")) {
440 _midi_driver_option = opt;
445 AlsaAudioBackend::midi_option () const
447 return _midi_driver_option;
451 AlsaAudioBackend::set_midi_device_enabled (std::string const device, bool enable)
453 struct AlsaMidiDeviceInfo * nfo = midi_device_info(device);
455 nfo->enabled = enable;
460 AlsaAudioBackend::midi_device_enabled (std::string const device) const
462 struct AlsaMidiDeviceInfo * nfo = midi_device_info(device);
463 if (!nfo) return false;
469 static void * pthread_process (void *arg)
471 AlsaAudioBackend *d = static_cast<AlsaAudioBackend *>(arg);
472 d->main_process_thread ();
478 AlsaAudioBackend::_start (bool for_latency_measurement)
480 if (!_active && _run) {
481 // recover from 'halted', reap threads
485 if (_active || _run) {
486 PBD::error << _("AlsaAudioBackend: already active.") << endmsg;
491 PBD::warning << _("AlsaAudioBackend: recovering from unclean shutdown, port registry is not empty.") << endmsg;
492 _system_inputs.clear();
493 _system_outputs.clear();
494 _system_midi_in.clear();
495 _system_midi_out.clear();
501 assert(_rmidi_in.size() == 0);
502 assert(_rmidi_out.size() == 0);
505 std::string alsa_device;
506 std::map<std::string, std::string> devices;
507 get_alsa_audio_device_names(devices);
508 for (std::map<std::string, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
509 if (i->first == _audio_device) {
510 alsa_device = i->second;
515 acquire_device(alsa_device.c_str());
516 _pcmi = new Alsa_pcmi (alsa_device.c_str(), alsa_device.c_str(), 0, _samplerate, _samples_per_period, _periods_per_cycle, 0);
517 switch (_pcmi->state ()) {
518 case 0: /* OK */ break;
519 case -1: PBD::error << _("AlsaAudioBackend: failed to open device.") << endmsg; break;
520 case -2: PBD::error << _("AlsaAudioBackend: failed to allocate parameters.") << endmsg; break;
521 case -3: PBD::error << _("AlsaAudioBackend: cannot set requested sample rate.") << endmsg; break;
522 case -4: PBD::error << _("AlsaAudioBackend: cannot set requested period size.") << endmsg; break;
523 case -5: PBD::error << _("AlsaAudioBackend: cannot set requested number of periods.") << endmsg; break;
524 case -6: PBD::error << _("AlsaAudioBackend: unsupported sample format.") << endmsg; break;
525 default: PBD::error << _("AlsaAudioBackend: initialization failed.") << endmsg; break;
527 if (_pcmi->state ()) {
528 delete _pcmi; _pcmi = 0;
537 if (_n_outputs != _pcmi->nplay ()) {
538 if (_n_outputs == 0) {
539 _n_outputs = _pcmi->nplay ();
541 _n_outputs = std::min (_n_outputs, _pcmi->nplay ());
543 PBD::warning << _("AlsaAudioBackend: adjusted output channel count to match device.") << endmsg;
546 if (_n_inputs != _pcmi->ncapt ()) {
547 if (_n_inputs == 0) {
548 _n_inputs = _pcmi->ncapt ();
550 _n_inputs = std::min (_n_inputs, _pcmi->ncapt ());
552 PBD::warning << _("AlsaAudioBackend: adjusted input channel count to match device.") << endmsg;
555 if (_pcmi->fsize() != _samples_per_period) {
556 _samples_per_period = _pcmi->fsize();
557 PBD::warning << _("AlsaAudioBackend: samples per period does not match.") << endmsg;
560 if (_pcmi->fsamp() != _samplerate) {
561 _samplerate = _pcmi->fsamp();
562 engine.sample_rate_change (_samplerate);
563 PBD::warning << _("AlsaAudioBackend: sample rate does not match.") << endmsg;
566 _measure_latency = for_latency_measurement;
568 register_system_midi_ports();
570 if (register_system_audio_ports()) {
571 PBD::error << _("AlsaAudioBackend: failed to register system ports.") << endmsg;
572 delete _pcmi; _pcmi = 0;
577 engine.sample_rate_change (_samplerate);
578 engine.buffer_size_change (_samples_per_period);
580 if (engine.reestablish_ports ()) {
581 PBD::error << _("AlsaAudioBackend: Could not re-establish ports.") << endmsg;
582 delete _pcmi; _pcmi = 0;
587 engine.reconnect_ports ();
589 _port_change_flag = false;
591 if (_realtime_pthread_create (SCHED_FIFO, -20, 100000,
592 &_main_thread, pthread_process, this))
594 if (pthread_create (&_main_thread, NULL, pthread_process, this))
596 PBD::error << _("AlsaAudioBackend: failed to create process thread.") << endmsg;
597 delete _pcmi; _pcmi = 0;
602 PBD::warning << _("AlsaAudioBackend: cannot acquire realtime permissions.") << endmsg;
607 while (!_active && --timeout > 0) { Glib::usleep (1000); }
609 if (timeout == 0 || !_active) {
610 PBD::error << _("AlsaAudioBackend: failed to start process thread.") << endmsg;
611 delete _pcmi; _pcmi = 0;
621 AlsaAudioBackend::stop ()
629 if (pthread_join (_main_thread, &status)) {
630 PBD::error << _("AlsaAudioBackend: failed to terminate.") << endmsg;
634 while (!_rmidi_out.empty ()) {
635 AlsaMidiIO *m = _rmidi_out.back ();
637 _rmidi_out.pop_back ();
640 while (!_rmidi_in.empty ()) {
641 AlsaMidiIO *m = _rmidi_in.back ();
643 _rmidi_in.pop_back ();
647 unregister_system_ports();
648 delete _pcmi; _pcmi = 0;
651 return (_active == false) ? 0 : -1;
655 AlsaAudioBackend::freewheel (bool onoff)
657 if (onoff == _freewheeling) {
660 _freewheeling = onoff;
661 engine.freewheel_callback (onoff);
666 AlsaAudioBackend::dsp_load () const
668 return 100.f * _dsp_load;
672 AlsaAudioBackend::raw_buffer_size (DataType t)
675 case DataType::AUDIO:
676 return _samples_per_period * sizeof(Sample);
678 return _max_buffer_size; // XXX not really limited
685 AlsaAudioBackend::sample_time ()
687 return _processed_samples;
691 AlsaAudioBackend::sample_time_at_cycle_start ()
693 return _processed_samples;
697 AlsaAudioBackend::samples_since_cycle_start ()
704 AlsaAudioBackend::alsa_process_thread (void *arg)
706 ThreadData* td = reinterpret_cast<ThreadData*> (arg);
707 boost::function<void ()> f = td->f;
714 AlsaAudioBackend::create_process_thread (boost::function<void()> func)
718 size_t stacksize = 100000;
720 ThreadData* td = new ThreadData (this, func, stacksize);
722 if (_realtime_pthread_create (SCHED_FIFO, -21, stacksize,
723 &thread_id, alsa_process_thread, td)) {
724 pthread_attr_init (&attr);
725 pthread_attr_setstacksize (&attr, stacksize);
726 if (pthread_create (&thread_id, &attr, alsa_process_thread, td)) {
727 PBD::error << _("AudioEngine: cannot create process thread.") << endmsg;
728 pthread_attr_destroy (&attr);
731 pthread_attr_destroy (&attr);
734 _threads.push_back (thread_id);
739 AlsaAudioBackend::join_process_threads ()
743 for (std::vector<pthread_t>::const_iterator i = _threads.begin (); i != _threads.end (); ++i)
746 if (pthread_join (*i, &status)) {
747 PBD::error << _("AudioEngine: cannot terminate process thread.") << endmsg;
756 AlsaAudioBackend::in_process_thread ()
758 for (std::vector<pthread_t>::const_iterator i = _threads.begin (); i != _threads.end (); ++i)
760 if (pthread_equal (*i, pthread_self ()) != 0) {
768 AlsaAudioBackend::process_thread_count ()
770 return _threads.size ();
774 AlsaAudioBackend::update_latencies ()
776 // trigger latency callback in RT thread (locked graph)
777 port_connect_add_remove_callback();
783 AlsaAudioBackend::private_handle () const
789 AlsaAudioBackend::my_name () const
791 return _instance_name;
795 AlsaAudioBackend::available () const
797 return _run && _active;
801 AlsaAudioBackend::port_name_size () const
807 AlsaAudioBackend::set_port_name (PortEngine::PortHandle port, const std::string& name)
809 if (!valid_port (port)) {
810 PBD::error << _("AlsaBackend::set_port_name: Invalid Port(s)") << endmsg;
813 return static_cast<AlsaPort*>(port)->set_name (_instance_name + ":" + name);
817 AlsaAudioBackend::get_port_name (PortEngine::PortHandle port) const
819 if (!valid_port (port)) {
820 PBD::error << _("AlsaBackend::get_port_name: Invalid Port(s)") << endmsg;
821 return std::string ();
823 return static_cast<AlsaPort*>(port)->name ();
826 PortEngine::PortHandle
827 AlsaAudioBackend::get_port_by_name (const std::string& name) const
829 PortHandle port = (PortHandle) find_port (name);
834 AlsaAudioBackend::get_ports (
835 const std::string& port_name_pattern,
836 DataType type, PortFlags flags,
837 std::vector<std::string>& port_names) const
841 bool use_regexp = false;
842 if (port_name_pattern.size () > 0) {
843 if (!regcomp (&port_regex, port_name_pattern.c_str (), REG_EXTENDED|REG_NOSUB)) {
847 for (size_t i = 0; i < _ports.size (); ++i) {
848 AlsaPort* port = _ports[i];
849 if ((port->type () == type) && (port->flags () & flags)) {
850 if (!use_regexp || !regexec (&port_regex, port->name ().c_str (), 0, NULL, 0)) {
851 port_names.push_back (port->name ());
857 regfree (&port_regex);
863 AlsaAudioBackend::port_data_type (PortEngine::PortHandle port) const
865 if (!valid_port (port)) {
866 return DataType::NIL;
868 return static_cast<AlsaPort*>(port)->type ();
871 PortEngine::PortHandle
872 AlsaAudioBackend::register_port (
873 const std::string& name,
874 ARDOUR::DataType type,
875 ARDOUR::PortFlags flags)
877 if (name.size () == 0) { return 0; }
878 if (flags & IsPhysical) { return 0; }
879 return add_port (_instance_name + ":" + name, type, flags);
882 PortEngine::PortHandle
883 AlsaAudioBackend::add_port (
884 const std::string& name,
885 ARDOUR::DataType type,
886 ARDOUR::PortFlags flags)
888 assert(name.size ());
889 if (find_port (name)) {
890 PBD::error << _("AlsaBackend::register_port: Port already exists:")
891 << " (" << name << ")" << endmsg;
894 AlsaPort* port = NULL;
896 case DataType::AUDIO:
897 port = new AlsaAudioPort (*this, name, flags);
900 port = new AlsaMidiPort (*this, name, flags);
903 PBD::error << _("AlsaBackend::register_port: Invalid Data Type.") << endmsg;
907 _ports.push_back (port);
913 AlsaAudioBackend::unregister_port (PortEngine::PortHandle port_handle)
915 if (!valid_port (port_handle)) {
916 PBD::error << _("AlsaBackend::unregister_port: Invalid Port.") << endmsg;
918 AlsaPort* port = static_cast<AlsaPort*>(port_handle);
919 std::vector<AlsaPort*>::iterator i = std::find (_ports.begin (), _ports.end (), static_cast<AlsaPort*>(port_handle));
920 if (i == _ports.end ()) {
921 PBD::error << _("AlsaBackend::unregister_port: Failed to find port") << endmsg;
924 disconnect_all(port_handle);
930 AlsaAudioBackend::register_system_audio_ports()
934 const int a_ins = _n_inputs > 0 ? _n_inputs : 2;
935 const int a_out = _n_outputs > 0 ? _n_outputs : 2;
938 lr.min = lr.max = _samples_per_period + (_measure_latency ? 0 : _systemic_audio_input_latency);
939 for (int i = 1; i <= a_ins; ++i) {
941 snprintf(tmp, sizeof(tmp), "system:capture_%d", i);
942 PortHandle p = add_port(std::string(tmp), DataType::AUDIO, static_cast<PortFlags>(IsOutput | IsPhysical | IsTerminal));
944 set_latency_range (p, false, lr);
945 _system_inputs.push_back(static_cast<AlsaPort*>(p));
948 lr.min = lr.max = _samples_per_period + (_measure_latency ? 0 : _systemic_audio_output_latency);
949 for (int i = 1; i <= a_out; ++i) {
951 snprintf(tmp, sizeof(tmp), "system:playback_%d", i);
952 PortHandle p = add_port(std::string(tmp), DataType::AUDIO, static_cast<PortFlags>(IsInput | IsPhysical | IsTerminal));
954 set_latency_range (p, true, lr);
955 _system_outputs.push_back(static_cast<AlsaPort*>(p));
961 AlsaAudioBackend::register_system_midi_ports()
963 std::map<std::string, std::string> devices;
967 if (_midi_driver_option == _("None")) {
969 } else if (_midi_driver_option == _("ALSA raw devices")) {
970 get_alsa_rawmidi_device_names(devices);
972 get_alsa_sequencer_names (devices);
975 for (std::map<std::string, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
976 struct AlsaMidiDeviceInfo * nfo = midi_device_info(i->first);
978 if (!nfo->enabled) continue;
981 if (_midi_driver_option == _("ALSA raw devices")) {
982 mout = new AlsaRawMidiOut (i->second.c_str());
984 mout = new AlsaSeqMidiOut (i->second.c_str());
987 if (mout->state ()) {
988 PBD::warning << string_compose (
989 _("AlsaMidiOut: failed to open midi device '%1'."), i->second)
993 mout->setup_timing(_samples_per_period, _samplerate);
994 mout->sync_time (g_get_monotonic_time());
995 if (mout->start ()) {
996 PBD::warning << string_compose (
997 _("AlsaMidiOut: failed to start midi device '%1'."), i->second)
1002 snprintf(tmp, sizeof(tmp), "system:midi_playback_%d", ++midi_ins);
1003 PortHandle p = add_port(std::string(tmp), DataType::MIDI, static_cast<PortFlags>(IsInput | IsPhysical | IsTerminal));
1009 lr.min = lr.max = _samples_per_period + (_measure_latency ? 0 : nfo->systemic_output_latency);
1010 set_latency_range (p, false, lr);
1011 static_cast<AlsaMidiPort*>(p)->set_n_periods(2);
1012 _system_midi_out.push_back(static_cast<AlsaPort*>(p));
1013 _rmidi_out.push_back (mout);
1018 if (_midi_driver_option == _("ALSA raw devices")) {
1019 midin = new AlsaRawMidiIn (i->second.c_str());
1021 midin = new AlsaSeqMidiIn (i->second.c_str());
1024 if (midin->state ()) {
1025 PBD::warning << string_compose (
1026 _("AlsaMidiIn: failed to open midi device '%1'."), i->second)
1030 midin->setup_timing(_samples_per_period, _samplerate);
1031 midin->sync_time (g_get_monotonic_time());
1032 if (midin->start ()) {
1033 PBD::warning << string_compose (
1034 _("AlsaMidiIn: failed to start midi device '%1'."), i->second)
1039 snprintf(tmp, sizeof(tmp), "system:midi_capture_%d", ++midi_outs);
1040 PortHandle p = add_port(std::string(tmp), DataType::MIDI, static_cast<PortFlags>(IsOutput | IsPhysical | IsTerminal));
1047 lr.min = lr.max = _samples_per_period + (_measure_latency ? 0 : nfo->systemic_input_latency);
1048 set_latency_range (p, false, lr);
1049 _system_midi_in.push_back(static_cast<AlsaPort*>(p));
1050 _rmidi_in.push_back (midin);
1058 AlsaAudioBackend::unregister_system_ports()
1061 _system_inputs.clear();
1062 _system_outputs.clear();
1063 _system_midi_in.clear();
1064 _system_midi_out.clear();
1065 while (i < _ports.size ()) {
1066 AlsaPort* port = _ports[i];
1067 if (port->is_physical () && port->is_terminal ()) {
1068 port->disconnect_all ();
1069 _ports.erase (_ports.begin() + i);
1077 AlsaAudioBackend::connect (const std::string& src, const std::string& dst)
1079 AlsaPort* src_port = find_port (src);
1080 AlsaPort* dst_port = find_port (dst);
1083 PBD::error << _("AlsaBackend::connect: Invalid Source port:")
1084 << " (" << src <<")" << endmsg;
1088 PBD::error << _("AlsaBackend::connect: Invalid Destination port:")
1089 << " (" << dst <<")" << endmsg;
1092 return src_port->connect (dst_port);
1096 AlsaAudioBackend::disconnect (const std::string& src, const std::string& dst)
1098 AlsaPort* src_port = find_port (src);
1099 AlsaPort* dst_port = find_port (dst);
1101 if (!src_port || !dst_port) {
1102 PBD::error << _("AlsaBackend::disconnect: Invalid Port(s)") << endmsg;
1105 return src_port->disconnect (dst_port);
1109 AlsaAudioBackend::connect (PortEngine::PortHandle src, const std::string& dst)
1111 AlsaPort* dst_port = find_port (dst);
1112 if (!valid_port (src)) {
1113 PBD::error << _("AlsaBackend::connect: Invalid Source Port Handle") << endmsg;
1117 PBD::error << _("AlsaBackend::connect: Invalid Destination Port")
1118 << " (" << dst << ")" << endmsg;
1121 return static_cast<AlsaPort*>(src)->connect (dst_port);
1125 AlsaAudioBackend::disconnect (PortEngine::PortHandle src, const std::string& dst)
1127 AlsaPort* dst_port = find_port (dst);
1128 if (!valid_port (src) || !dst_port) {
1129 PBD::error << _("AlsaBackend::disconnect: Invalid Port(s)") << endmsg;
1132 return static_cast<AlsaPort*>(src)->disconnect (dst_port);
1136 AlsaAudioBackend::disconnect_all (PortEngine::PortHandle port)
1138 if (!valid_port (port)) {
1139 PBD::error << _("AlsaBackend::disconnect_all: Invalid Port") << endmsg;
1142 static_cast<AlsaPort*>(port)->disconnect_all ();
1147 AlsaAudioBackend::connected (PortEngine::PortHandle port, bool /* process_callback_safe*/)
1149 if (!valid_port (port)) {
1150 PBD::error << _("AlsaBackend::disconnect_all: Invalid Port") << endmsg;
1153 return static_cast<AlsaPort*>(port)->is_connected ();
1157 AlsaAudioBackend::connected_to (PortEngine::PortHandle src, const std::string& dst, bool /*process_callback_safe*/)
1159 AlsaPort* dst_port = find_port (dst);
1160 if (!valid_port (src) || !dst_port) {
1161 PBD::error << _("AlsaBackend::connected_to: Invalid Port") << endmsg;
1164 return static_cast<AlsaPort*>(src)->is_connected (dst_port);
1168 AlsaAudioBackend::physically_connected (PortEngine::PortHandle port, bool /*process_callback_safe*/)
1170 if (!valid_port (port)) {
1171 PBD::error << _("AlsaBackend::physically_connected: Invalid Port") << endmsg;
1174 return static_cast<AlsaPort*>(port)->is_physically_connected ();
1178 AlsaAudioBackend::get_connections (PortEngine::PortHandle port, std::vector<std::string>& names, bool /*process_callback_safe*/)
1180 if (!valid_port (port)) {
1181 PBD::error << _("AlsaBackend::get_connections: Invalid Port") << endmsg;
1185 assert (0 == names.size ());
1187 const std::vector<AlsaPort*>& connected_ports = static_cast<AlsaPort*>(port)->get_connections ();
1189 for (std::vector<AlsaPort*>::const_iterator i = connected_ports.begin (); i != connected_ports.end (); ++i) {
1190 names.push_back ((*i)->name ());
1193 return (int)names.size ();
1198 AlsaAudioBackend::midi_event_get (
1199 pframes_t& timestamp,
1200 size_t& size, uint8_t** buf, void* port_buffer,
1201 uint32_t event_index)
1203 assert (buf && port_buffer);
1204 AlsaMidiBuffer& source = * static_cast<AlsaMidiBuffer*>(port_buffer);
1205 if (event_index >= source.size ()) {
1208 AlsaMidiEvent * const event = source[event_index].get ();
1210 timestamp = event->timestamp ();
1211 size = event->size ();
1212 *buf = event->data ();
1217 AlsaAudioBackend::midi_event_put (
1219 pframes_t timestamp,
1220 const uint8_t* buffer, size_t size)
1222 assert (buffer && port_buffer);
1223 AlsaMidiBuffer& dst = * static_cast<AlsaMidiBuffer*>(port_buffer);
1224 if (dst.size () && (pframes_t)dst.back ()->timestamp () > timestamp) {
1225 fprintf (stderr, "AlsaMidiBuffer: it's too late for this event. %d > %d\n",
1226 (pframes_t)dst.back ()->timestamp (), timestamp);
1229 dst.push_back (boost::shared_ptr<AlsaMidiEvent>(new AlsaMidiEvent (timestamp, buffer, size)));
1234 AlsaAudioBackend::get_midi_event_count (void* port_buffer)
1236 assert (port_buffer);
1237 return static_cast<AlsaMidiBuffer*>(port_buffer)->size ();
1241 AlsaAudioBackend::midi_clear (void* port_buffer)
1243 assert (port_buffer);
1244 AlsaMidiBuffer * buf = static_cast<AlsaMidiBuffer*>(port_buffer);
1252 AlsaAudioBackend::can_monitor_input () const
1258 AlsaAudioBackend::request_input_monitoring (PortEngine::PortHandle, bool)
1264 AlsaAudioBackend::ensure_input_monitoring (PortEngine::PortHandle, bool)
1270 AlsaAudioBackend::monitoring_input (PortEngine::PortHandle)
1275 /* Latency management */
1278 AlsaAudioBackend::set_latency_range (PortEngine::PortHandle port, bool for_playback, LatencyRange latency_range)
1280 if (!valid_port (port)) {
1281 PBD::error << _("AlsaPort::set_latency_range (): invalid port.") << endmsg;
1283 static_cast<AlsaPort*>(port)->set_latency_range (latency_range, for_playback);
1287 AlsaAudioBackend::get_latency_range (PortEngine::PortHandle port, bool for_playback)
1289 if (!valid_port (port)) {
1290 PBD::error << _("AlsaPort::get_latency_range (): invalid port.") << endmsg;
1296 return static_cast<AlsaPort*>(port)->latency_range (for_playback);
1299 /* Discovering physical ports */
1302 AlsaAudioBackend::port_is_physical (PortEngine::PortHandle port) const
1304 if (!valid_port (port)) {
1305 PBD::error << _("AlsaPort::port_is_physical (): invalid port.") << endmsg;
1308 return static_cast<AlsaPort*>(port)->is_physical ();
1312 AlsaAudioBackend::get_physical_outputs (DataType type, std::vector<std::string>& port_names)
1314 for (size_t i = 0; i < _ports.size (); ++i) {
1315 AlsaPort* port = _ports[i];
1316 if ((port->type () == type) && port->is_input () && port->is_physical ()) {
1317 port_names.push_back (port->name ());
1323 AlsaAudioBackend::get_physical_inputs (DataType type, std::vector<std::string>& port_names)
1325 for (size_t i = 0; i < _ports.size (); ++i) {
1326 AlsaPort* port = _ports[i];
1327 if ((port->type () == type) && port->is_output () && port->is_physical ()) {
1328 port_names.push_back (port->name ());
1334 AlsaAudioBackend::n_physical_outputs () const
1338 for (size_t i = 0; i < _ports.size (); ++i) {
1339 AlsaPort* port = _ports[i];
1340 if (port->is_output () && port->is_physical ()) {
1341 switch (port->type ()) {
1342 case DataType::AUDIO: ++n_audio; break;
1343 case DataType::MIDI: ++n_midi; break;
1349 cc.set (DataType::AUDIO, n_audio);
1350 cc.set (DataType::MIDI, n_midi);
1355 AlsaAudioBackend::n_physical_inputs () const
1359 for (size_t i = 0; i < _ports.size (); ++i) {
1360 AlsaPort* port = _ports[i];
1361 if (port->is_input () && port->is_physical ()) {
1362 switch (port->type ()) {
1363 case DataType::AUDIO: ++n_audio; break;
1364 case DataType::MIDI: ++n_midi; break;
1370 cc.set (DataType::AUDIO, n_audio);
1371 cc.set (DataType::MIDI, n_midi);
1375 /* Getting access to the data buffer for a port */
1378 AlsaAudioBackend::get_buffer (PortEngine::PortHandle port, pframes_t nframes)
1381 assert (valid_port (port));
1382 return static_cast<AlsaPort*>(port)->get_buffer (nframes);
1385 /* Engine Process */
1387 AlsaAudioBackend::main_process_thread ()
1389 AudioEngine::thread_init_callback (this);
1391 _processed_samples = 0;
1393 uint64_t clock1, clock2;
1394 clock1 = g_get_monotonic_time();
1395 _pcmi->pcm_start ();
1396 int no_proc_errors = 0;
1397 const int bailout = 2 * _samplerate / _samples_per_period;
1398 const int64_t nomial_time = 1e6 * _samples_per_period / _samplerate;
1400 manager.registration_callback();
1401 manager.graph_order_callback();
1406 if (!_freewheeling) {
1407 nr = _pcmi->pcm_wait ();
1409 if (_pcmi->state () > 0) {
1413 if (_pcmi->state () < 0 || no_proc_errors > bailout) {
1414 PBD::error << _("AlsaAudioBackend: I/O error. Audio Process Terminated.") << endmsg;
1417 while (nr >= (long)_samples_per_period) {
1419 clock1 = g_get_monotonic_time();
1422 _pcmi->capt_init (_samples_per_period);
1423 for (std::vector<AlsaPort*>::const_iterator it = _system_inputs.begin (); it != _system_inputs.end (); ++it, ++i) {
1424 _pcmi->capt_chan (i, (float*)((*it)->get_buffer(_samples_per_period)), _samples_per_period);
1426 _pcmi->capt_done (_samples_per_period);
1430 for (std::vector<AlsaPort*>::const_iterator it = _system_midi_in.begin (); it != _system_midi_in.end (); ++it, ++i) {
1431 assert (_rmidi_in.size() > i);
1432 AlsaMidiIn *rm = _rmidi_in.at(i);
1433 void *bptr = (*it)->get_buffer(0);
1435 uint8_t data[64]; // match MaxAlsaEventSize in alsa_rawmidi.cc
1436 size_t size = sizeof(data);
1438 while (rm->recv_event (time, data, size)) {
1439 midi_event_put(bptr, time, data, size);
1440 size = sizeof(data);
1442 rm->sync_time (clock1);
1445 for (std::vector<AlsaPort*>::const_iterator it = _system_outputs.begin (); it != _system_outputs.end (); ++it) {
1446 memset ((*it)->get_buffer (_samples_per_period), 0, _samples_per_period * sizeof (Sample));
1449 if (engine.process_callback (_samples_per_period)) {
1456 for (std::vector<AlsaPort*>::iterator it = _system_midi_out.begin (); it != _system_midi_out.end (); ++it, ++i) {
1457 static_cast<AlsaMidiPort*>(*it)->next_period();
1462 for (std::vector<AlsaPort*>::const_iterator it = _system_midi_out.begin (); it != _system_midi_out.end (); ++it, ++i) {
1463 assert (_rmidi_out.size() > i);
1464 const AlsaMidiBuffer src = static_cast<const AlsaMidiPort*>(*it)->const_buffer();
1465 AlsaMidiOut *rm = _rmidi_out.at(i);
1466 rm->sync_time (clock1);
1467 for (AlsaMidiBuffer::const_iterator mit = src.begin (); mit != src.end (); ++mit) {
1468 rm->send_event ((*mit)->timestamp(), (*mit)->data(), (*mit)->size());
1472 /* write back audio */
1474 _pcmi->play_init (_samples_per_period);
1475 for (std::vector<AlsaPort*>::const_iterator it = _system_outputs.begin (); it != _system_outputs.end (); ++it, ++i) {
1476 _pcmi->play_chan (i, (const float*)(*it)->get_buffer (_samples_per_period), _samples_per_period);
1478 for (; i < _pcmi->nplay (); ++i) {
1479 _pcmi->clear_chan (i, _samples_per_period);
1481 _pcmi->play_done (_samples_per_period);
1482 nr -= _samples_per_period;
1483 _processed_samples += _samples_per_period;
1485 /* calculate DSP load */
1486 clock2 = g_get_monotonic_time();
1487 const int64_t elapsed_time = clock2 - clock1;
1488 _dsp_load = elapsed_time / (float) nomial_time;
1491 if (xrun && (_pcmi->capt_xrun() > 0 || _pcmi->play_xrun() > 0)) {
1494 fprintf(stderr, "ALSA x-run read: %.1f ms, write: %.1f ms\n",
1495 _pcmi->capt_xrun() * 1000.0, _pcmi->play_xrun() * 1000.0);
1500 for (std::vector<AlsaPort*>::const_iterator it = _system_inputs.begin (); it != _system_inputs.end (); ++it) {
1501 memset ((*it)->get_buffer (_samples_per_period), 0, _samples_per_period * sizeof (Sample));
1503 for (std::vector<AlsaPort*>::const_iterator it = _system_midi_in.begin (); it != _system_midi_in.end (); ++it) {
1504 static_cast<AlsaMidiBuffer*>((*it)->get_buffer(0))->clear ();
1507 if (engine.process_callback (_samples_per_period)) {
1512 Glib::usleep (100); // don't hog cpu
1515 bool connections_changed = false;
1516 bool ports_changed = false;
1517 if (!pthread_mutex_trylock (&_port_callback_mutex)) {
1518 if (_port_change_flag) {
1519 ports_changed = true;
1520 _port_change_flag = false;
1522 if (!_port_connection_queue.empty ()) {
1523 connections_changed = true;
1525 while (!_port_connection_queue.empty ()) {
1526 PortConnectData *c = _port_connection_queue.back ();
1527 manager.connect_callback (c->a, c->b, c->c);
1528 _port_connection_queue.pop_back ();
1531 pthread_mutex_unlock (&_port_callback_mutex);
1533 if (ports_changed) {
1534 manager.registration_callback();
1536 if (connections_changed) {
1537 manager.graph_order_callback();
1539 if (connections_changed || ports_changed) {
1540 engine.latency_callback(false);
1541 engine.latency_callback(true);
1548 engine.halted_callback("ALSA I/O error.");
1554 /******************************************************************************/
1556 static boost::shared_ptr<AlsaAudioBackend> _instance;
1558 static boost::shared_ptr<AudioBackend> backend_factory (AudioEngine& e);
1559 static int instantiate (const std::string& arg1, const std::string& /* arg2 */);
1560 static int deinstantiate ();
1561 static bool already_configured ();
1563 static ARDOUR::AudioBackendInfo _descriptor = {
1571 static boost::shared_ptr<AudioBackend>
1572 backend_factory (AudioEngine& e)
1575 _instance.reset (new AlsaAudioBackend (e, _descriptor));
1581 instantiate (const std::string& arg1, const std::string& /* arg2 */)
1583 s_instance_name = arg1;
1595 already_configured ()
1600 extern "C" ARDOURBACKEND_API ARDOUR::AudioBackendInfo* descriptor ()
1602 return &_descriptor;
1606 /******************************************************************************/
1607 AlsaPort::AlsaPort (AlsaAudioBackend &b, const std::string& name, PortFlags flags)
1612 _capture_latency_range.min = 0;
1613 _capture_latency_range.max = 0;
1614 _playback_latency_range.min = 0;
1615 _playback_latency_range.max = 0;
1618 AlsaPort::~AlsaPort () {
1623 int AlsaPort::connect (AlsaPort *port)
1626 PBD::error << _("AlsaPort::connect (): invalid (null) port") << endmsg;
1630 if (type () != port->type ()) {
1631 PBD::error << _("AlsaPort::connect (): wrong port-type") << endmsg;
1635 if (is_output () && port->is_output ()) {
1636 PBD::error << _("AlsaPort::connect (): cannot inter-connect output ports.") << endmsg;
1640 if (is_input () && port->is_input ()) {
1641 PBD::error << _("AlsaPort::connect (): cannot inter-connect input ports.") << endmsg;
1646 PBD::error << _("AlsaPort::connect (): cannot self-connect ports.") << endmsg;
1650 if (is_connected (port)) {
1651 #if 0 // don't bother to warn about this for now. just ignore it
1652 PBD::error << _("AlsaPort::connect (): ports are already connected:")
1653 << " (" << name () << ") -> (" << port->name () << ")"
1659 _connect (port, true);
1664 void AlsaPort::_connect (AlsaPort *port, bool callback)
1666 _connections.push_back (port);
1668 port->_connect (this, false);
1669 _alsa_backend.port_connect_callback (name(), port->name(), true);
1673 int AlsaPort::disconnect (AlsaPort *port)
1676 PBD::error << _("AlsaPort::disconnect (): invalid (null) port") << endmsg;
1680 if (!is_connected (port)) {
1681 PBD::error << _("AlsaPort::disconnect (): ports are not connected:")
1682 << " (" << name () << ") -> (" << port->name () << ")"
1686 _disconnect (port, true);
1690 void AlsaPort::_disconnect (AlsaPort *port, bool callback)
1692 std::vector<AlsaPort*>::iterator it = std::find (_connections.begin (), _connections.end (), port);
1694 assert (it != _connections.end ());
1696 _connections.erase (it);
1699 port->_disconnect (this, false);
1700 _alsa_backend.port_connect_callback (name(), port->name(), false);
1705 void AlsaPort::disconnect_all ()
1707 while (!_connections.empty ()) {
1708 _connections.back ()->_disconnect (this, false);
1709 _alsa_backend.port_connect_callback (name(), _connections.back ()->name(), false);
1710 _connections.pop_back ();
1715 AlsaPort::is_connected (const AlsaPort *port) const
1717 return std::find (_connections.begin (), _connections.end (), port) != _connections.end ();
1720 bool AlsaPort::is_physically_connected () const
1722 for (std::vector<AlsaPort*>::const_iterator it = _connections.begin (); it != _connections.end (); ++it) {
1723 if ((*it)->is_physical ()) {
1730 /******************************************************************************/
1732 AlsaAudioPort::AlsaAudioPort (AlsaAudioBackend &b, const std::string& name, PortFlags flags)
1733 : AlsaPort (b, name, flags)
1735 memset (_buffer, 0, sizeof (_buffer));
1736 mlock(_buffer, sizeof (_buffer));
1739 AlsaAudioPort::~AlsaAudioPort () { }
1741 void* AlsaAudioPort::get_buffer (pframes_t n_samples)
1744 std::vector<AlsaPort*>::const_iterator it = get_connections ().begin ();
1745 if (it == get_connections ().end ()) {
1746 memset (_buffer, 0, n_samples * sizeof (Sample));
1748 AlsaAudioPort const * source = static_cast<const AlsaAudioPort*>(*it);
1749 assert (source && source->is_output ());
1750 memcpy (_buffer, source->const_buffer (), n_samples * sizeof (Sample));
1751 while (++it != get_connections ().end ()) {
1752 source = static_cast<const AlsaAudioPort*>(*it);
1753 assert (source && source->is_output ());
1754 Sample* dst = buffer ();
1755 const Sample* src = source->const_buffer ();
1756 for (uint32_t s = 0; s < n_samples; ++s, ++dst, ++src) {
1766 AlsaMidiPort::AlsaMidiPort (AlsaAudioBackend &b, const std::string& name, PortFlags flags)
1767 : AlsaPort (b, name, flags)
1771 _buffer[0].clear ();
1772 _buffer[1].clear ();
1775 AlsaMidiPort::~AlsaMidiPort () { }
1777 struct MidiEventSorter {
1778 bool operator() (const boost::shared_ptr<AlsaMidiEvent>& a, const boost::shared_ptr<AlsaMidiEvent>& b) {
1783 void* AlsaMidiPort::get_buffer (pframes_t /* nframes */)
1786 (_buffer[_bufperiod]).clear ();
1787 for (std::vector<AlsaPort*>::const_iterator i = get_connections ().begin ();
1788 i != get_connections ().end ();
1790 const AlsaMidiBuffer src = static_cast<const AlsaMidiPort*>(*i)->const_buffer ();
1791 for (AlsaMidiBuffer::const_iterator it = src.begin (); it != src.end (); ++it) {
1792 (_buffer[_bufperiod]).push_back (boost::shared_ptr<AlsaMidiEvent>(new AlsaMidiEvent (**it)));
1795 std::sort ((_buffer[_bufperiod]).begin (), (_buffer[_bufperiod]).end (), MidiEventSorter());
1797 return &(_buffer[_bufperiod]);
1800 AlsaMidiEvent::AlsaMidiEvent (const pframes_t timestamp, const uint8_t* data, size_t size)
1802 , _timestamp (timestamp)
1806 _data = (uint8_t*) malloc (size);
1807 memcpy (_data, data, size);
1811 AlsaMidiEvent::AlsaMidiEvent (const AlsaMidiEvent& other)
1812 : _size (other.size ())
1813 , _timestamp (other.timestamp ())
1816 if (other.size () && other.const_data ()) {
1817 _data = (uint8_t*) malloc (other.size ());
1818 memcpy (_data, other.const_data (), other.size ());
1822 AlsaMidiEvent::~AlsaMidiEvent () {