2 * Copyright (C) 2014 Robin Gareus <robin@gareus.org>
3 * Copyright (C) 2013 Paul Davis
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 #include "alsa_audiobackend.h"
27 #include "rt_thread.h"
29 #include "pbd/compose.h"
30 #include "pbd/error.h"
31 #include "pbd/file_utils.h"
32 #include "ardour/filesystem_paths.h"
33 #include "ardour/port_manager.h"
34 #include "ardouralsautil/devicelist.h"
37 using namespace ARDOUR;
39 static std::string s_instance_name;
40 size_t AlsaAudioBackend::_max_buffer_size = 8192;
41 std::vector<std::string> AlsaAudioBackend::_midi_options;
42 std::vector<AudioBackend::DeviceStatus> AlsaAudioBackend::_audio_device_status;
43 std::vector<AudioBackend::DeviceStatus> AlsaAudioBackend::_midi_device_status;
45 AlsaAudioBackend::AlsaAudioBackend (AudioEngine& e, AudioBackendInfo& info)
46 : AudioBackend (e, info)
50 , _freewheeling (false)
51 , _measure_latency (false)
53 , _midi_driver_option(_("None"))
54 , _device_reservation(0)
56 , _samples_per_period (1024)
57 , _periods_per_cycle (2)
60 , _systemic_audio_input_latency (0)
61 , _systemic_audio_output_latency (0)
63 , _processed_samples (0)
64 , _port_change_flag (false)
66 _instance_name = s_instance_name;
67 pthread_mutex_init (&_port_callback_mutex, 0);
70 AlsaAudioBackend::~AlsaAudioBackend ()
72 pthread_mutex_destroy (&_port_callback_mutex);
75 /* AUDIOBACKEND API */
78 AlsaAudioBackend::name () const
84 AlsaAudioBackend::is_realtime () const
89 std::vector<AudioBackend::DeviceStatus>
90 AlsaAudioBackend::enumerate_devices () const
92 _audio_device_status.clear();
93 std::map<std::string, std::string> devices;
94 get_alsa_audio_device_names(devices);
95 for (std::map<std::string, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
96 _audio_device_status.push_back (DeviceStatus (i->first, true));
98 return _audio_device_status;
102 AlsaAudioBackend::reservation_stdout (std::string d, size_t /* s */)
104 if (d.substr(0, 19) == "Acquired audio-card") {
105 _reservation_succeeded = true;
110 AlsaAudioBackend::release_device()
112 _reservation_connection.drop_connections();
113 ARDOUR::SystemExec * tmp = _device_reservation;
114 _device_reservation = 0;
119 AlsaAudioBackend::acquire_device(const char* device_name)
121 /* This is quick hack, ideally we'll link against libdbus and implement a dbus-listener
122 * that owns the device. here we try to get away by just requesting it and then block it...
123 * (pulseaudio periodically checks anyway)
125 * dbus-send --session --print-reply --type=method_call --dest=org.freedesktop.ReserveDevice1.Audio2 /org/freedesktop/ReserveDevice1/Audio2 org.freedesktop.ReserveDevice1.RequestRelease int32:4
126 * -> should not return 'boolean false'
128 int device_number = card_to_num(device_name);
129 if (device_number < 0) return false;
131 assert(_device_reservation == 0);
132 _reservation_succeeded = false;
134 std::string request_device_exe;
135 if (!PBD::find_file (
136 PBD::Searchpath(Glib::build_filename(ARDOUR::ardour_dll_directory(), "ardouralsautil")
137 + G_SEARCHPATH_SEPARATOR_S + ARDOUR::ardour_dll_directory()),
138 "ardour-request-device", request_device_exe))
140 PBD::warning << "ardour-request-device binary was not found..'" << endmsg;
147 argp=(char**) calloc(5,sizeof(char*));
148 argp[0] = strdup(request_device_exe.c_str());
149 argp[1] = strdup("-P");
150 snprintf(tmp, sizeof(tmp), "%d", getpid());
151 argp[2] = strdup(tmp);
152 snprintf(tmp, sizeof(tmp), "Audio%d", device_number);
153 argp[3] = strdup(tmp);
156 _device_reservation = new ARDOUR::SystemExec(request_device_exe, argp);
157 _device_reservation->ReadStdout.connect_same_thread (_reservation_connection, boost::bind (&AlsaAudioBackend::reservation_stdout, this, _1 ,_2));
158 _device_reservation->Terminated.connect_same_thread (_reservation_connection, boost::bind (&AlsaAudioBackend::release_device, this));
159 if (_device_reservation->start(0)) {
160 PBD::warning << _("AlsaAudioBackend: Device Request failed.") << endmsg;
165 // wait to check if reservation suceeded.
166 int timeout = 500; // 5 sec
167 while (_device_reservation && !_reservation_succeeded && --timeout > 0) {
170 if (timeout == 0 || !_reservation_succeeded) {
171 PBD::warning << _("AlsaAudioBackend: Device Reservation failed.") << endmsg;
179 AlsaAudioBackend::available_sample_rates (const std::string&) const
181 std::vector<float> sr;
182 sr.push_back (8000.0);
183 sr.push_back (22050.0);
184 sr.push_back (24000.0);
185 sr.push_back (44100.0);
186 sr.push_back (48000.0);
187 sr.push_back (88200.0);
188 sr.push_back (96000.0);
189 sr.push_back (176400.0);
190 sr.push_back (192000.0);
194 std::vector<uint32_t>
195 AlsaAudioBackend::available_buffer_sizes (const std::string&) const
197 std::vector<uint32_t> bs;
211 AlsaAudioBackend::available_input_channel_count (const std::string&) const
213 return 128; // TODO query current device
217 AlsaAudioBackend::available_output_channel_count (const std::string&) const
219 return 128; // TODO query current device
223 AlsaAudioBackend::can_change_sample_rate_when_running () const
229 AlsaAudioBackend::can_change_buffer_size_when_running () const
235 AlsaAudioBackend::set_device_name (const std::string& d)
242 AlsaAudioBackend::set_sample_rate (float sr)
244 if (sr <= 0) { return -1; }
246 engine.sample_rate_change (sr);
251 AlsaAudioBackend::set_buffer_size (uint32_t bs)
253 if (bs <= 0 || bs >= _max_buffer_size) {
256 _samples_per_period = bs;
257 engine.buffer_size_change (bs);
262 AlsaAudioBackend::set_interleaved (bool yn)
264 if (!yn) { return 0; }
269 AlsaAudioBackend::set_input_channels (uint32_t cc)
276 AlsaAudioBackend::set_output_channels (uint32_t cc)
283 AlsaAudioBackend::set_systemic_input_latency (uint32_t sl)
285 _systemic_audio_input_latency = sl;
290 AlsaAudioBackend::set_systemic_output_latency (uint32_t sl)
292 _systemic_audio_output_latency = sl;
297 AlsaAudioBackend::set_systemic_midi_input_latency (std::string const device, uint32_t sl)
299 struct AlsaMidiDeviceInfo * nfo = midi_device_info(device);
301 nfo->systemic_input_latency = sl;
306 AlsaAudioBackend::set_systemic_midi_output_latency (std::string const device, uint32_t sl)
308 struct AlsaMidiDeviceInfo * nfo = midi_device_info(device);
310 nfo->systemic_output_latency = sl;
314 /* Retrieving parameters */
316 AlsaAudioBackend::device_name () const
318 return _audio_device;
322 AlsaAudioBackend::sample_rate () const
328 AlsaAudioBackend::buffer_size () const
330 return _samples_per_period;
334 AlsaAudioBackend::interleaved () const
340 AlsaAudioBackend::input_channels () const
346 AlsaAudioBackend::output_channels () const
352 AlsaAudioBackend::systemic_input_latency () const
354 return _systemic_audio_input_latency;
358 AlsaAudioBackend::systemic_output_latency () const
360 return _systemic_audio_output_latency;
364 AlsaAudioBackend::systemic_midi_input_latency (std::string const device) const
366 struct AlsaMidiDeviceInfo * nfo = midi_device_info(device);
368 return nfo->systemic_input_latency;
372 AlsaAudioBackend::systemic_midi_output_latency (std::string const device) const
374 struct AlsaMidiDeviceInfo * nfo = midi_device_info(device);
376 return nfo->systemic_output_latency;
380 struct AlsaAudioBackend::AlsaMidiDeviceInfo *
381 AlsaAudioBackend::midi_device_info(std::string const name) const {
382 for (std::map<std::string, struct AlsaMidiDeviceInfo*>::const_iterator i = _midi_devices.begin (); i != _midi_devices.end(); ++i) {
383 if (i->first == name) {
388 assert(_midi_driver_option != _("None"));
390 std::map<std::string, std::string> devices;
391 if (_midi_driver_option == _("ALSA raw devices")) {
392 get_alsa_rawmidi_device_names(devices);
394 get_alsa_sequencer_names (devices);
397 for (std::map<std::string, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
398 if (i->first == name) {
399 _midi_devices[name] = new AlsaMidiDeviceInfo();
400 return _midi_devices[name];
406 std::vector<std::string>
407 AlsaAudioBackend::enumerate_midi_options () const
409 if (_midi_options.empty()) {
410 _midi_options.push_back (_("None"));
411 _midi_options.push_back (_("ALSA raw devices"));
412 _midi_options.push_back (_("ALSA sequencer"));
414 return _midi_options;
417 std::vector<AudioBackend::DeviceStatus>
418 AlsaAudioBackend::enumerate_midi_devices () const
420 _midi_device_status.clear();
421 std::map<std::string, std::string> devices;
423 if (_midi_driver_option == _("ALSA raw devices")) {
424 get_alsa_rawmidi_device_names (devices);
426 else if (_midi_driver_option == _("ALSA sequencer")) {
427 get_alsa_sequencer_names (devices);
430 for (std::map<std::string, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
431 _midi_device_status.push_back (DeviceStatus (i->first, true));
433 return _midi_device_status;
437 AlsaAudioBackend::set_midi_option (const std::string& opt)
439 if (opt != _("None") && opt != _("ALSA raw devices") && opt != _("ALSA sequencer")) {
442 _midi_driver_option = opt;
447 AlsaAudioBackend::midi_option () const
449 return _midi_driver_option;
453 AlsaAudioBackend::set_midi_device_enabled (std::string const device, bool enable)
455 struct AlsaMidiDeviceInfo * nfo = midi_device_info(device);
457 nfo->enabled = enable;
462 AlsaAudioBackend::midi_device_enabled (std::string const device) const
464 struct AlsaMidiDeviceInfo * nfo = midi_device_info(device);
465 if (!nfo) return false;
471 static void * pthread_process (void *arg)
473 AlsaAudioBackend *d = static_cast<AlsaAudioBackend *>(arg);
474 d->main_process_thread ();
480 AlsaAudioBackend::_start (bool for_latency_measurement)
482 if (!_active && _run) {
483 // recover from 'halted', reap threads
487 if (_active || _run) {
488 PBD::error << _("AlsaAudioBackend: already active.") << endmsg;
493 PBD::warning << _("AlsaAudioBackend: recovering from unclean shutdown, port registry is not empty.") << endmsg;
494 _system_inputs.clear();
495 _system_outputs.clear();
496 _system_midi_in.clear();
497 _system_midi_out.clear();
503 assert(_rmidi_in.size() == 0);
504 assert(_rmidi_out.size() == 0);
507 std::string alsa_device;
508 std::map<std::string, std::string> devices;
509 get_alsa_audio_device_names(devices);
510 for (std::map<std::string, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
511 if (i->first == _audio_device) {
512 alsa_device = i->second;
517 acquire_device(alsa_device.c_str());
518 _pcmi = new Alsa_pcmi (alsa_device.c_str(), alsa_device.c_str(), 0, _samplerate, _samples_per_period, _periods_per_cycle, 0);
519 switch (_pcmi->state ()) {
520 case 0: /* OK */ break;
521 case -1: PBD::error << _("AlsaAudioBackend: failed to open device.") << endmsg; break;
522 case -2: PBD::error << _("AlsaAudioBackend: failed to allocate parameters.") << endmsg; break;
523 case -3: PBD::error << _("AlsaAudioBackend: cannot set requested sample rate.") << endmsg; break;
524 case -4: PBD::error << _("AlsaAudioBackend: cannot set requested period size.") << endmsg; break;
525 case -5: PBD::error << _("AlsaAudioBackend: cannot set requested number of periods.") << endmsg; break;
526 case -6: PBD::error << _("AlsaAudioBackend: unsupported sample format.") << endmsg; break;
527 default: PBD::error << _("AlsaAudioBackend: initialization failed.") << endmsg; break;
529 if (_pcmi->state ()) {
530 delete _pcmi; _pcmi = 0;
539 if (_n_outputs != _pcmi->nplay ()) {
540 if (_n_outputs == 0) {
541 _n_outputs = _pcmi->nplay ();
543 _n_outputs = std::min (_n_outputs, _pcmi->nplay ());
545 PBD::warning << _("AlsaAudioBackend: adjusted output channel count to match device.") << endmsg;
548 if (_n_inputs != _pcmi->ncapt ()) {
549 if (_n_inputs == 0) {
550 _n_inputs = _pcmi->ncapt ();
552 _n_inputs = std::min (_n_inputs, _pcmi->ncapt ());
554 PBD::warning << _("AlsaAudioBackend: adjusted input channel count to match device.") << endmsg;
557 if (_pcmi->fsize() != _samples_per_period) {
558 _samples_per_period = _pcmi->fsize();
559 PBD::warning << _("AlsaAudioBackend: samples per period does not match.") << endmsg;
562 if (_pcmi->fsamp() != _samplerate) {
563 _samplerate = _pcmi->fsamp();
564 engine.sample_rate_change (_samplerate);
565 PBD::warning << _("AlsaAudioBackend: sample rate does not match.") << endmsg;
568 _measure_latency = for_latency_measurement;
570 register_system_midi_ports();
572 if (register_system_audio_ports()) {
573 PBD::error << _("AlsaAudioBackend: failed to register system ports.") << endmsg;
574 delete _pcmi; _pcmi = 0;
579 engine.sample_rate_change (_samplerate);
580 engine.buffer_size_change (_samples_per_period);
582 if (engine.reestablish_ports ()) {
583 PBD::error << _("AlsaAudioBackend: Could not re-establish ports.") << endmsg;
584 delete _pcmi; _pcmi = 0;
589 engine.reconnect_ports ();
591 _port_change_flag = false;
593 if (_realtime_pthread_create (SCHED_FIFO, -20, 100000,
594 &_main_thread, pthread_process, this))
596 if (pthread_create (&_main_thread, NULL, pthread_process, this))
598 PBD::error << _("AlsaAudioBackend: failed to create process thread.") << endmsg;
599 delete _pcmi; _pcmi = 0;
604 PBD::warning << _("AlsaAudioBackend: cannot acquire realtime permissions.") << endmsg;
609 while (!_active && --timeout > 0) { Glib::usleep (1000); }
611 if (timeout == 0 || !_active) {
612 PBD::error << _("AlsaAudioBackend: failed to start process thread.") << endmsg;
613 delete _pcmi; _pcmi = 0;
623 AlsaAudioBackend::stop ()
631 if (pthread_join (_main_thread, &status)) {
632 PBD::error << _("AlsaAudioBackend: failed to terminate.") << endmsg;
636 while (!_rmidi_out.empty ()) {
637 AlsaMidiIO *m = _rmidi_out.back ();
639 _rmidi_out.pop_back ();
642 while (!_rmidi_in.empty ()) {
643 AlsaMidiIO *m = _rmidi_in.back ();
645 _rmidi_in.pop_back ();
649 unregister_system_ports();
650 delete _pcmi; _pcmi = 0;
653 return (_active == false) ? 0 : -1;
657 AlsaAudioBackend::freewheel (bool onoff)
659 if (onoff == _freewheeling) {
662 _freewheeling = onoff;
663 engine.freewheel_callback (onoff);
668 AlsaAudioBackend::dsp_load () const
670 return 100.f * _dsp_load;
674 AlsaAudioBackend::raw_buffer_size (DataType t)
677 case DataType::AUDIO:
678 return _samples_per_period * sizeof(Sample);
680 return _max_buffer_size; // XXX not really limited
687 AlsaAudioBackend::sample_time ()
689 return _processed_samples;
693 AlsaAudioBackend::sample_time_at_cycle_start ()
695 return _processed_samples;
699 AlsaAudioBackend::samples_since_cycle_start ()
706 AlsaAudioBackend::alsa_process_thread (void *arg)
708 ThreadData* td = reinterpret_cast<ThreadData*> (arg);
709 boost::function<void ()> f = td->f;
716 AlsaAudioBackend::create_process_thread (boost::function<void()> func)
720 size_t stacksize = 100000;
722 ThreadData* td = new ThreadData (this, func, stacksize);
724 if (_realtime_pthread_create (SCHED_FIFO, -21, stacksize,
725 &thread_id, alsa_process_thread, td)) {
726 pthread_attr_init (&attr);
727 pthread_attr_setstacksize (&attr, stacksize);
728 if (pthread_create (&thread_id, &attr, alsa_process_thread, td)) {
729 PBD::error << _("AudioEngine: cannot create process thread.") << endmsg;
730 pthread_attr_destroy (&attr);
733 pthread_attr_destroy (&attr);
736 _threads.push_back (thread_id);
741 AlsaAudioBackend::join_process_threads ()
745 for (std::vector<pthread_t>::const_iterator i = _threads.begin (); i != _threads.end (); ++i)
748 if (pthread_join (*i, &status)) {
749 PBD::error << _("AudioEngine: cannot terminate process thread.") << endmsg;
758 AlsaAudioBackend::in_process_thread ()
760 for (std::vector<pthread_t>::const_iterator i = _threads.begin (); i != _threads.end (); ++i)
762 if (pthread_equal (*i, pthread_self ()) != 0) {
770 AlsaAudioBackend::process_thread_count ()
772 return _threads.size ();
776 AlsaAudioBackend::update_latencies ()
778 // trigger latency callback in RT thread (locked graph)
779 port_connect_add_remove_callback();
785 AlsaAudioBackend::private_handle () const
791 AlsaAudioBackend::my_name () const
793 return _instance_name;
797 AlsaAudioBackend::available () const
799 return _run && _active;
803 AlsaAudioBackend::port_name_size () const
809 AlsaAudioBackend::set_port_name (PortEngine::PortHandle port, const std::string& name)
811 if (!valid_port (port)) {
812 PBD::error << _("AlsaBackend::set_port_name: Invalid Port(s)") << endmsg;
815 return static_cast<AlsaPort*>(port)->set_name (_instance_name + ":" + name);
819 AlsaAudioBackend::get_port_name (PortEngine::PortHandle port) const
821 if (!valid_port (port)) {
822 PBD::error << _("AlsaBackend::get_port_name: Invalid Port(s)") << endmsg;
823 return std::string ();
825 return static_cast<AlsaPort*>(port)->name ();
828 PortEngine::PortHandle
829 AlsaAudioBackend::get_port_by_name (const std::string& name) const
831 PortHandle port = (PortHandle) find_port (name);
836 AlsaAudioBackend::get_ports (
837 const std::string& port_name_pattern,
838 DataType type, PortFlags flags,
839 std::vector<std::string>& port_names) const
843 bool use_regexp = false;
844 if (port_name_pattern.size () > 0) {
845 if (!regcomp (&port_regex, port_name_pattern.c_str (), REG_EXTENDED|REG_NOSUB)) {
849 for (size_t i = 0; i < _ports.size (); ++i) {
850 AlsaPort* port = _ports[i];
851 if ((port->type () == type) && (port->flags () & flags)) {
852 if (!use_regexp || !regexec (&port_regex, port->name ().c_str (), 0, NULL, 0)) {
853 port_names.push_back (port->name ());
859 regfree (&port_regex);
865 AlsaAudioBackend::port_data_type (PortEngine::PortHandle port) const
867 if (!valid_port (port)) {
868 return DataType::NIL;
870 return static_cast<AlsaPort*>(port)->type ();
873 PortEngine::PortHandle
874 AlsaAudioBackend::register_port (
875 const std::string& name,
876 ARDOUR::DataType type,
877 ARDOUR::PortFlags flags)
879 if (name.size () == 0) { return 0; }
880 if (flags & IsPhysical) { return 0; }
881 return add_port (_instance_name + ":" + name, type, flags);
884 PortEngine::PortHandle
885 AlsaAudioBackend::add_port (
886 const std::string& name,
887 ARDOUR::DataType type,
888 ARDOUR::PortFlags flags)
890 assert(name.size ());
891 if (find_port (name)) {
892 PBD::error << _("AlsaBackend::register_port: Port already exists:")
893 << " (" << name << ")" << endmsg;
896 AlsaPort* port = NULL;
898 case DataType::AUDIO:
899 port = new AlsaAudioPort (*this, name, flags);
902 port = new AlsaMidiPort (*this, name, flags);
905 PBD::error << _("AlsaBackend::register_port: Invalid Data Type.") << endmsg;
909 _ports.push_back (port);
915 AlsaAudioBackend::unregister_port (PortEngine::PortHandle port_handle)
917 if (!valid_port (port_handle)) {
918 PBD::error << _("AlsaBackend::unregister_port: Invalid Port.") << endmsg;
920 AlsaPort* port = static_cast<AlsaPort*>(port_handle);
921 std::vector<AlsaPort*>::iterator i = std::find (_ports.begin (), _ports.end (), static_cast<AlsaPort*>(port_handle));
922 if (i == _ports.end ()) {
923 PBD::error << _("AlsaBackend::unregister_port: Failed to find port") << endmsg;
926 disconnect_all(port_handle);
932 AlsaAudioBackend::register_system_audio_ports()
936 const int a_ins = _n_inputs > 0 ? _n_inputs : 2;
937 const int a_out = _n_outputs > 0 ? _n_outputs : 2;
940 lr.min = lr.max = _samples_per_period + (_measure_latency ? 0 : _systemic_audio_input_latency);
941 for (int i = 1; i <= a_ins; ++i) {
943 snprintf(tmp, sizeof(tmp), "system:capture_%d", i);
944 PortHandle p = add_port(std::string(tmp), DataType::AUDIO, static_cast<PortFlags>(IsOutput | IsPhysical | IsTerminal));
946 set_latency_range (p, false, lr);
947 _system_inputs.push_back(static_cast<AlsaPort*>(p));
950 lr.min = lr.max = _samples_per_period + (_measure_latency ? 0 : _systemic_audio_output_latency);
951 for (int i = 1; i <= a_out; ++i) {
953 snprintf(tmp, sizeof(tmp), "system:playback_%d", i);
954 PortHandle p = add_port(std::string(tmp), DataType::AUDIO, static_cast<PortFlags>(IsInput | IsPhysical | IsTerminal));
956 set_latency_range (p, true, lr);
957 _system_outputs.push_back(static_cast<AlsaPort*>(p));
963 AlsaAudioBackend::register_system_midi_ports()
965 std::map<std::string, std::string> devices;
969 if (_midi_driver_option == _("None")) {
971 } else if (_midi_driver_option == _("ALSA raw devices")) {
972 get_alsa_rawmidi_device_names(devices);
974 get_alsa_sequencer_names (devices);
977 for (std::map<std::string, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
978 struct AlsaMidiDeviceInfo * nfo = midi_device_info(i->first);
980 if (!nfo->enabled) continue;
983 if (_midi_driver_option == _("ALSA raw devices")) {
984 mout = new AlsaRawMidiOut (i->second.c_str());
986 mout = new AlsaSeqMidiOut (i->second.c_str());
989 if (mout->state ()) {
990 PBD::warning << string_compose (
991 _("AlsaMidiOut: failed to open midi device '%1'."), i->second)
995 mout->setup_timing(_samples_per_period, _samplerate);
996 mout->sync_time (g_get_monotonic_time());
997 if (mout->start ()) {
998 PBD::warning << string_compose (
999 _("AlsaMidiOut: failed to start midi device '%1'."), i->second)
1004 snprintf(tmp, sizeof(tmp), "system:midi_playback_%d", ++midi_ins);
1005 PortHandle p = add_port(std::string(tmp), DataType::MIDI, static_cast<PortFlags>(IsInput | IsPhysical | IsTerminal));
1011 lr.min = lr.max = _samples_per_period + (_measure_latency ? 0 : nfo->systemic_output_latency);
1012 set_latency_range (p, false, lr);
1013 static_cast<AlsaMidiPort*>(p)->set_n_periods(2);
1014 _system_midi_out.push_back(static_cast<AlsaPort*>(p));
1015 _rmidi_out.push_back (mout);
1020 if (_midi_driver_option == _("ALSA raw devices")) {
1021 midin = new AlsaRawMidiIn (i->second.c_str());
1023 midin = new AlsaSeqMidiIn (i->second.c_str());
1026 if (midin->state ()) {
1027 PBD::warning << string_compose (
1028 _("AlsaMidiIn: failed to open midi device '%1'."), i->second)
1032 midin->setup_timing(_samples_per_period, _samplerate);
1033 midin->sync_time (g_get_monotonic_time());
1034 if (midin->start ()) {
1035 PBD::warning << string_compose (
1036 _("AlsaMidiIn: failed to start midi device '%1'."), i->second)
1041 snprintf(tmp, sizeof(tmp), "system:midi_capture_%d", ++midi_outs);
1042 PortHandle p = add_port(std::string(tmp), DataType::MIDI, static_cast<PortFlags>(IsOutput | IsPhysical | IsTerminal));
1049 lr.min = lr.max = _samples_per_period + (_measure_latency ? 0 : nfo->systemic_input_latency);
1050 set_latency_range (p, false, lr);
1051 _system_midi_in.push_back(static_cast<AlsaPort*>(p));
1052 _rmidi_in.push_back (midin);
1060 AlsaAudioBackend::unregister_system_ports()
1063 _system_inputs.clear();
1064 _system_outputs.clear();
1065 _system_midi_in.clear();
1066 _system_midi_out.clear();
1067 while (i < _ports.size ()) {
1068 AlsaPort* port = _ports[i];
1069 if (port->is_physical () && port->is_terminal ()) {
1070 port->disconnect_all ();
1071 _ports.erase (_ports.begin() + i);
1079 AlsaAudioBackend::connect (const std::string& src, const std::string& dst)
1081 AlsaPort* src_port = find_port (src);
1082 AlsaPort* dst_port = find_port (dst);
1085 PBD::error << _("AlsaBackend::connect: Invalid Source port:")
1086 << " (" << src <<")" << endmsg;
1090 PBD::error << _("AlsaBackend::connect: Invalid Destination port:")
1091 << " (" << dst <<")" << endmsg;
1094 return src_port->connect (dst_port);
1098 AlsaAudioBackend::disconnect (const std::string& src, const std::string& dst)
1100 AlsaPort* src_port = find_port (src);
1101 AlsaPort* dst_port = find_port (dst);
1103 if (!src_port || !dst_port) {
1104 PBD::error << _("AlsaBackend::disconnect: Invalid Port(s)") << endmsg;
1107 return src_port->disconnect (dst_port);
1111 AlsaAudioBackend::connect (PortEngine::PortHandle src, const std::string& dst)
1113 AlsaPort* dst_port = find_port (dst);
1114 if (!valid_port (src)) {
1115 PBD::error << _("AlsaBackend::connect: Invalid Source Port Handle") << endmsg;
1119 PBD::error << _("AlsaBackend::connect: Invalid Destination Port")
1120 << " (" << dst << ")" << endmsg;
1123 return static_cast<AlsaPort*>(src)->connect (dst_port);
1127 AlsaAudioBackend::disconnect (PortEngine::PortHandle src, const std::string& dst)
1129 AlsaPort* dst_port = find_port (dst);
1130 if (!valid_port (src) || !dst_port) {
1131 PBD::error << _("AlsaBackend::disconnect: Invalid Port(s)") << endmsg;
1134 return static_cast<AlsaPort*>(src)->disconnect (dst_port);
1138 AlsaAudioBackend::disconnect_all (PortEngine::PortHandle port)
1140 if (!valid_port (port)) {
1141 PBD::error << _("AlsaBackend::disconnect_all: Invalid Port") << endmsg;
1144 static_cast<AlsaPort*>(port)->disconnect_all ();
1149 AlsaAudioBackend::connected (PortEngine::PortHandle port, bool /* process_callback_safe*/)
1151 if (!valid_port (port)) {
1152 PBD::error << _("AlsaBackend::disconnect_all: Invalid Port") << endmsg;
1155 return static_cast<AlsaPort*>(port)->is_connected ();
1159 AlsaAudioBackend::connected_to (PortEngine::PortHandle src, const std::string& dst, bool /*process_callback_safe*/)
1161 AlsaPort* dst_port = find_port (dst);
1162 if (!valid_port (src) || !dst_port) {
1163 PBD::error << _("AlsaBackend::connected_to: Invalid Port") << endmsg;
1166 return static_cast<AlsaPort*>(src)->is_connected (dst_port);
1170 AlsaAudioBackend::physically_connected (PortEngine::PortHandle port, bool /*process_callback_safe*/)
1172 if (!valid_port (port)) {
1173 PBD::error << _("AlsaBackend::physically_connected: Invalid Port") << endmsg;
1176 return static_cast<AlsaPort*>(port)->is_physically_connected ();
1180 AlsaAudioBackend::get_connections (PortEngine::PortHandle port, std::vector<std::string>& names, bool /*process_callback_safe*/)
1182 if (!valid_port (port)) {
1183 PBD::error << _("AlsaBackend::get_connections: Invalid Port") << endmsg;
1187 assert (0 == names.size ());
1189 const std::vector<AlsaPort*>& connected_ports = static_cast<AlsaPort*>(port)->get_connections ();
1191 for (std::vector<AlsaPort*>::const_iterator i = connected_ports.begin (); i != connected_ports.end (); ++i) {
1192 names.push_back ((*i)->name ());
1195 return (int)names.size ();
1200 AlsaAudioBackend::midi_event_get (
1201 pframes_t& timestamp,
1202 size_t& size, uint8_t** buf, void* port_buffer,
1203 uint32_t event_index)
1205 assert (buf && port_buffer);
1206 AlsaMidiBuffer& source = * static_cast<AlsaMidiBuffer*>(port_buffer);
1207 if (event_index >= source.size ()) {
1210 AlsaMidiEvent * const event = source[event_index].get ();
1212 timestamp = event->timestamp ();
1213 size = event->size ();
1214 *buf = event->data ();
1219 AlsaAudioBackend::midi_event_put (
1221 pframes_t timestamp,
1222 const uint8_t* buffer, size_t size)
1224 assert (buffer && port_buffer);
1225 AlsaMidiBuffer& dst = * static_cast<AlsaMidiBuffer*>(port_buffer);
1226 if (dst.size () && (pframes_t)dst.back ()->timestamp () > timestamp) {
1227 fprintf (stderr, "AlsaMidiBuffer: it's too late for this event. %d > %d\n",
1228 (pframes_t)dst.back ()->timestamp (), timestamp);
1231 dst.push_back (boost::shared_ptr<AlsaMidiEvent>(new AlsaMidiEvent (timestamp, buffer, size)));
1236 AlsaAudioBackend::get_midi_event_count (void* port_buffer)
1238 assert (port_buffer);
1239 return static_cast<AlsaMidiBuffer*>(port_buffer)->size ();
1243 AlsaAudioBackend::midi_clear (void* port_buffer)
1245 assert (port_buffer);
1246 AlsaMidiBuffer * buf = static_cast<AlsaMidiBuffer*>(port_buffer);
1254 AlsaAudioBackend::can_monitor_input () const
1260 AlsaAudioBackend::request_input_monitoring (PortEngine::PortHandle, bool)
1266 AlsaAudioBackend::ensure_input_monitoring (PortEngine::PortHandle, bool)
1272 AlsaAudioBackend::monitoring_input (PortEngine::PortHandle)
1277 /* Latency management */
1280 AlsaAudioBackend::set_latency_range (PortEngine::PortHandle port, bool for_playback, LatencyRange latency_range)
1282 if (!valid_port (port)) {
1283 PBD::error << _("AlsaPort::set_latency_range (): invalid port.") << endmsg;
1285 static_cast<AlsaPort*>(port)->set_latency_range (latency_range, for_playback);
1289 AlsaAudioBackend::get_latency_range (PortEngine::PortHandle port, bool for_playback)
1291 if (!valid_port (port)) {
1292 PBD::error << _("AlsaPort::get_latency_range (): invalid port.") << endmsg;
1298 return static_cast<AlsaPort*>(port)->latency_range (for_playback);
1301 /* Discovering physical ports */
1304 AlsaAudioBackend::port_is_physical (PortEngine::PortHandle port) const
1306 if (!valid_port (port)) {
1307 PBD::error << _("AlsaPort::port_is_physical (): invalid port.") << endmsg;
1310 return static_cast<AlsaPort*>(port)->is_physical ();
1314 AlsaAudioBackend::get_physical_outputs (DataType type, std::vector<std::string>& port_names)
1316 for (size_t i = 0; i < _ports.size (); ++i) {
1317 AlsaPort* port = _ports[i];
1318 if ((port->type () == type) && port->is_input () && port->is_physical ()) {
1319 port_names.push_back (port->name ());
1325 AlsaAudioBackend::get_physical_inputs (DataType type, std::vector<std::string>& port_names)
1327 for (size_t i = 0; i < _ports.size (); ++i) {
1328 AlsaPort* port = _ports[i];
1329 if ((port->type () == type) && port->is_output () && port->is_physical ()) {
1330 port_names.push_back (port->name ());
1336 AlsaAudioBackend::n_physical_outputs () const
1340 for (size_t i = 0; i < _ports.size (); ++i) {
1341 AlsaPort* port = _ports[i];
1342 if (port->is_output () && port->is_physical ()) {
1343 switch (port->type ()) {
1344 case DataType::AUDIO: ++n_audio; break;
1345 case DataType::MIDI: ++n_midi; break;
1351 cc.set (DataType::AUDIO, n_audio);
1352 cc.set (DataType::MIDI, n_midi);
1357 AlsaAudioBackend::n_physical_inputs () const
1361 for (size_t i = 0; i < _ports.size (); ++i) {
1362 AlsaPort* port = _ports[i];
1363 if (port->is_input () && port->is_physical ()) {
1364 switch (port->type ()) {
1365 case DataType::AUDIO: ++n_audio; break;
1366 case DataType::MIDI: ++n_midi; break;
1372 cc.set (DataType::AUDIO, n_audio);
1373 cc.set (DataType::MIDI, n_midi);
1377 /* Getting access to the data buffer for a port */
1380 AlsaAudioBackend::get_buffer (PortEngine::PortHandle port, pframes_t nframes)
1383 assert (valid_port (port));
1384 return static_cast<AlsaPort*>(port)->get_buffer (nframes);
1387 /* Engine Process */
1389 AlsaAudioBackend::main_process_thread ()
1391 AudioEngine::thread_init_callback (this);
1393 _processed_samples = 0;
1395 uint64_t clock1, clock2;
1396 clock1 = g_get_monotonic_time();
1397 _pcmi->pcm_start ();
1398 int no_proc_errors = 0;
1399 const int bailout = 2 * _samplerate / _samples_per_period;
1400 const int64_t nomial_time = 1e6 * _samples_per_period / _samplerate;
1402 manager.registration_callback();
1403 manager.graph_order_callback();
1408 if (!_freewheeling) {
1409 nr = _pcmi->pcm_wait ();
1411 if (_pcmi->state () > 0) {
1415 if (_pcmi->state () < 0 || no_proc_errors > bailout) {
1416 PBD::error << _("AlsaAudioBackend: I/O error. Audio Process Terminated.") << endmsg;
1419 while (nr >= (long)_samples_per_period) {
1421 clock1 = g_get_monotonic_time();
1424 _pcmi->capt_init (_samples_per_period);
1425 for (std::vector<AlsaPort*>::const_iterator it = _system_inputs.begin (); it != _system_inputs.end (); ++it, ++i) {
1426 _pcmi->capt_chan (i, (float*)((*it)->get_buffer(_samples_per_period)), _samples_per_period);
1428 _pcmi->capt_done (_samples_per_period);
1432 for (std::vector<AlsaPort*>::const_iterator it = _system_midi_in.begin (); it != _system_midi_in.end (); ++it, ++i) {
1433 assert (_rmidi_in.size() > i);
1434 AlsaMidiIn *rm = _rmidi_in.at(i);
1435 void *bptr = (*it)->get_buffer(0);
1437 uint8_t data[64]; // match MaxAlsaEventSize in alsa_rawmidi.cc
1438 size_t size = sizeof(data);
1440 while (rm->recv_event (time, data, size)) {
1441 midi_event_put(bptr, time, data, size);
1442 size = sizeof(data);
1444 rm->sync_time (clock1);
1447 for (std::vector<AlsaPort*>::const_iterator it = _system_outputs.begin (); it != _system_outputs.end (); ++it) {
1448 memset ((*it)->get_buffer (_samples_per_period), 0, _samples_per_period * sizeof (Sample));
1451 if (engine.process_callback (_samples_per_period)) {
1458 for (std::vector<AlsaPort*>::iterator it = _system_midi_out.begin (); it != _system_midi_out.end (); ++it, ++i) {
1459 static_cast<AlsaMidiPort*>(*it)->next_period();
1464 for (std::vector<AlsaPort*>::const_iterator it = _system_midi_out.begin (); it != _system_midi_out.end (); ++it, ++i) {
1465 assert (_rmidi_out.size() > i);
1466 const AlsaMidiBuffer src = static_cast<const AlsaMidiPort*>(*it)->const_buffer();
1467 AlsaMidiOut *rm = _rmidi_out.at(i);
1468 rm->sync_time (clock1);
1469 for (AlsaMidiBuffer::const_iterator mit = src.begin (); mit != src.end (); ++mit) {
1470 rm->send_event ((*mit)->timestamp(), (*mit)->data(), (*mit)->size());
1474 /* write back audio */
1476 _pcmi->play_init (_samples_per_period);
1477 for (std::vector<AlsaPort*>::const_iterator it = _system_outputs.begin (); it != _system_outputs.end (); ++it, ++i) {
1478 _pcmi->play_chan (i, (const float*)(*it)->get_buffer (_samples_per_period), _samples_per_period);
1480 for (; i < _pcmi->nplay (); ++i) {
1481 _pcmi->clear_chan (i, _samples_per_period);
1483 _pcmi->play_done (_samples_per_period);
1484 nr -= _samples_per_period;
1485 _processed_samples += _samples_per_period;
1487 /* calculate DSP load */
1488 clock2 = g_get_monotonic_time();
1489 const int64_t elapsed_time = clock2 - clock1;
1490 _dsp_load = elapsed_time / (float) nomial_time;
1493 if (xrun && (_pcmi->capt_xrun() > 0 || _pcmi->play_xrun() > 0)) {
1496 fprintf(stderr, "ALSA x-run read: %.1f ms, write: %.1f ms\n",
1497 _pcmi->capt_xrun() * 1000.0, _pcmi->play_xrun() * 1000.0);
1502 for (std::vector<AlsaPort*>::const_iterator it = _system_inputs.begin (); it != _system_inputs.end (); ++it) {
1503 memset ((*it)->get_buffer (_samples_per_period), 0, _samples_per_period * sizeof (Sample));
1505 for (std::vector<AlsaPort*>::const_iterator it = _system_midi_in.begin (); it != _system_midi_in.end (); ++it) {
1506 static_cast<AlsaMidiBuffer*>((*it)->get_buffer(0))->clear ();
1509 if (engine.process_callback (_samples_per_period)) {
1514 Glib::usleep (100); // don't hog cpu
1517 bool connections_changed = false;
1518 bool ports_changed = false;
1519 if (!pthread_mutex_trylock (&_port_callback_mutex)) {
1520 if (_port_change_flag) {
1521 ports_changed = true;
1522 _port_change_flag = false;
1524 if (!_port_connection_queue.empty ()) {
1525 connections_changed = true;
1527 while (!_port_connection_queue.empty ()) {
1528 PortConnectData *c = _port_connection_queue.back ();
1529 manager.connect_callback (c->a, c->b, c->c);
1530 _port_connection_queue.pop_back ();
1533 pthread_mutex_unlock (&_port_callback_mutex);
1535 if (ports_changed) {
1536 manager.registration_callback();
1538 if (connections_changed) {
1539 manager.graph_order_callback();
1541 if (connections_changed || ports_changed) {
1542 engine.latency_callback(false);
1543 engine.latency_callback(true);
1550 engine.halted_callback("ALSA I/O error.");
1556 /******************************************************************************/
1558 static boost::shared_ptr<AlsaAudioBackend> _instance;
1560 static boost::shared_ptr<AudioBackend> backend_factory (AudioEngine& e);
1561 static int instantiate (const std::string& arg1, const std::string& /* arg2 */);
1562 static int deinstantiate ();
1563 static bool already_configured ();
1565 static ARDOUR::AudioBackendInfo _descriptor = {
1573 static boost::shared_ptr<AudioBackend>
1574 backend_factory (AudioEngine& e)
1577 _instance.reset (new AlsaAudioBackend (e, _descriptor));
1583 instantiate (const std::string& arg1, const std::string& /* arg2 */)
1585 s_instance_name = arg1;
1597 already_configured ()
1602 extern "C" ARDOURBACKEND_API ARDOUR::AudioBackendInfo* descriptor ()
1604 return &_descriptor;
1608 /******************************************************************************/
1609 AlsaPort::AlsaPort (AlsaAudioBackend &b, const std::string& name, PortFlags flags)
1614 _capture_latency_range.min = 0;
1615 _capture_latency_range.max = 0;
1616 _playback_latency_range.min = 0;
1617 _playback_latency_range.max = 0;
1620 AlsaPort::~AlsaPort () {
1625 int AlsaPort::connect (AlsaPort *port)
1628 PBD::error << _("AlsaPort::connect (): invalid (null) port") << endmsg;
1632 if (type () != port->type ()) {
1633 PBD::error << _("AlsaPort::connect (): wrong port-type") << endmsg;
1637 if (is_output () && port->is_output ()) {
1638 PBD::error << _("AlsaPort::connect (): cannot inter-connect output ports.") << endmsg;
1642 if (is_input () && port->is_input ()) {
1643 PBD::error << _("AlsaPort::connect (): cannot inter-connect input ports.") << endmsg;
1648 PBD::error << _("AlsaPort::connect (): cannot self-connect ports.") << endmsg;
1652 if (is_connected (port)) {
1653 #if 0 // don't bother to warn about this for now. just ignore it
1654 PBD::error << _("AlsaPort::connect (): ports are already connected:")
1655 << " (" << name () << ") -> (" << port->name () << ")"
1661 _connect (port, true);
1666 void AlsaPort::_connect (AlsaPort *port, bool callback)
1668 _connections.push_back (port);
1670 port->_connect (this, false);
1671 _alsa_backend.port_connect_callback (name(), port->name(), true);
1675 int AlsaPort::disconnect (AlsaPort *port)
1678 PBD::error << _("AlsaPort::disconnect (): invalid (null) port") << endmsg;
1682 if (!is_connected (port)) {
1683 PBD::error << _("AlsaPort::disconnect (): ports are not connected:")
1684 << " (" << name () << ") -> (" << port->name () << ")"
1688 _disconnect (port, true);
1692 void AlsaPort::_disconnect (AlsaPort *port, bool callback)
1694 std::vector<AlsaPort*>::iterator it = std::find (_connections.begin (), _connections.end (), port);
1696 assert (it != _connections.end ());
1698 _connections.erase (it);
1701 port->_disconnect (this, false);
1702 _alsa_backend.port_connect_callback (name(), port->name(), false);
1707 void AlsaPort::disconnect_all ()
1709 while (!_connections.empty ()) {
1710 _connections.back ()->_disconnect (this, false);
1711 _alsa_backend.port_connect_callback (name(), _connections.back ()->name(), false);
1712 _connections.pop_back ();
1717 AlsaPort::is_connected (const AlsaPort *port) const
1719 return std::find (_connections.begin (), _connections.end (), port) != _connections.end ();
1722 bool AlsaPort::is_physically_connected () const
1724 for (std::vector<AlsaPort*>::const_iterator it = _connections.begin (); it != _connections.end (); ++it) {
1725 if ((*it)->is_physical ()) {
1732 /******************************************************************************/
1734 AlsaAudioPort::AlsaAudioPort (AlsaAudioBackend &b, const std::string& name, PortFlags flags)
1735 : AlsaPort (b, name, flags)
1737 memset (_buffer, 0, sizeof (_buffer));
1738 mlock(_buffer, sizeof (_buffer));
1741 AlsaAudioPort::~AlsaAudioPort () { }
1743 void* AlsaAudioPort::get_buffer (pframes_t n_samples)
1746 std::vector<AlsaPort*>::const_iterator it = get_connections ().begin ();
1747 if (it == get_connections ().end ()) {
1748 memset (_buffer, 0, n_samples * sizeof (Sample));
1750 AlsaAudioPort const * source = static_cast<const AlsaAudioPort*>(*it);
1751 assert (source && source->is_output ());
1752 memcpy (_buffer, source->const_buffer (), n_samples * sizeof (Sample));
1753 while (++it != get_connections ().end ()) {
1754 source = static_cast<const AlsaAudioPort*>(*it);
1755 assert (source && source->is_output ());
1756 Sample* dst = buffer ();
1757 const Sample* src = source->const_buffer ();
1758 for (uint32_t s = 0; s < n_samples; ++s, ++dst, ++src) {
1768 AlsaMidiPort::AlsaMidiPort (AlsaAudioBackend &b, const std::string& name, PortFlags flags)
1769 : AlsaPort (b, name, flags)
1773 _buffer[0].clear ();
1774 _buffer[1].clear ();
1777 AlsaMidiPort::~AlsaMidiPort () { }
1779 struct MidiEventSorter {
1780 bool operator() (const boost::shared_ptr<AlsaMidiEvent>& a, const boost::shared_ptr<AlsaMidiEvent>& b) {
1785 void* AlsaMidiPort::get_buffer (pframes_t /* nframes */)
1788 (_buffer[_bufperiod]).clear ();
1789 for (std::vector<AlsaPort*>::const_iterator i = get_connections ().begin ();
1790 i != get_connections ().end ();
1792 const AlsaMidiBuffer src = static_cast<const AlsaMidiPort*>(*i)->const_buffer ();
1793 for (AlsaMidiBuffer::const_iterator it = src.begin (); it != src.end (); ++it) {
1794 (_buffer[_bufperiod]).push_back (boost::shared_ptr<AlsaMidiEvent>(new AlsaMidiEvent (**it)));
1797 std::sort ((_buffer[_bufperiod]).begin (), (_buffer[_bufperiod]).end (), MidiEventSorter());
1799 return &(_buffer[_bufperiod]);
1802 AlsaMidiEvent::AlsaMidiEvent (const pframes_t timestamp, const uint8_t* data, size_t size)
1804 , _timestamp (timestamp)
1808 _data = (uint8_t*) malloc (size);
1809 memcpy (_data, data, size);
1813 AlsaMidiEvent::AlsaMidiEvent (const AlsaMidiEvent& other)
1814 : _size (other.size ())
1815 , _timestamp (other.timestamp ())
1818 if (other.size () && other.const_data ()) {
1819 _data = (uint8_t*) malloc (other.size ());
1820 memcpy (_data, other.const_data (), other.size ());
1824 AlsaMidiEvent::~AlsaMidiEvent () {