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)
50 , _device_reservation(0)
52 , _samples_per_period (1024)
53 , _periods_per_cycle (2)
57 , _systemic_input_latency (0)
58 , _systemic_output_latency (0)
59 , _processed_samples (0)
61 _instance_name = s_instance_name;
62 pthread_mutex_init (&_port_callback_mutex, 0);
65 AlsaAudioBackend::~AlsaAudioBackend ()
67 pthread_mutex_destroy (&_port_callback_mutex);
70 /* AUDIOBACKEND API */
73 AlsaAudioBackend::name () const
79 AlsaAudioBackend::is_realtime () const
84 std::vector<AudioBackend::DeviceStatus>
85 AlsaAudioBackend::enumerate_devices () const
87 std::vector<AudioBackend::DeviceStatus> s;
88 std::map<std::string, std::string> devices;
89 get_alsa_audio_device_names(devices);
90 for (std::map<std::string, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
91 s.push_back (DeviceStatus (i->first, true));
97 AlsaAudioBackend::reservation_stdout (std::string d, size_t /* s */)
99 if (d.substr(0, 19) == "Acquired audio-card") {
100 _reservation_succeeded = true;
105 AlsaAudioBackend::release_device()
107 _reservation_connection.drop_connections();
108 delete _device_reservation;
109 _device_reservation = 0;
113 AlsaAudioBackend::acquire_device(const char* device_name)
115 /* This is quick hack, ideally we'll link against libdbus and implement a dbus-listener
116 * that owns the device. here we try to get away by just requesting it and then block it...
117 * (pulseaudio periodically checks anyway)
119 * dbus-send --session --print-reply --type=method_call --dest=org.freedesktop.ReserveDevice1.Audio2 /org/freedesktop/ReserveDevice1/Audio2 org.freedesktop.ReserveDevice1.RequestRelease int32:4
120 * -> should not return 'boolean false'
122 int device_number = card_to_num(device_name);
123 if (device_number < 0) return false;
125 assert(_device_reservation == 0);
126 _reservation_succeeded = false;
128 std::string request_device_exe;
129 if (!PBD::find_file_in_search_path (
130 PBD::Searchpath(Glib::build_filename(ARDOUR::ardour_dll_directory(), "ardouralsautil")
131 + G_SEARCHPATH_SEPARATOR_S + ARDOUR::ardour_dll_directory()),
132 "ardour-request-device", request_device_exe))
134 PBD::warning << "ardour-request-device binary was not found..'" << endmsg;
141 argp=(char**) calloc(5,sizeof(char*));
142 argp[0] = strdup(request_device_exe.c_str());
143 argp[1] = strdup("-P");
144 snprintf(tmp, sizeof(tmp), "%d", getpid());
145 argp[2] = strdup(tmp);
146 snprintf(tmp, sizeof(tmp), "Audio%d", device_number);
147 argp[3] = strdup(tmp);
150 _device_reservation = new ARDOUR::SystemExec(request_device_exe, argp);
151 _device_reservation->ReadStdout.connect_same_thread (_reservation_connection, boost::bind (&AlsaAudioBackend::reservation_stdout, this, _1 ,_2));
152 _device_reservation->Terminated.connect_same_thread (_reservation_connection, boost::bind (&AlsaAudioBackend::release_device, this));
153 if (_device_reservation->start(0)) {
154 PBD::warning << _("AlsaAudioBackend: Device Request failed.") << endmsg;
159 // wait to check if reservation suceeded.
160 int timeout = 500; // 5 sec
161 while (_device_reservation && !_reservation_succeeded && --timeout > 0) {
164 if (timeout == 0 || !_reservation_succeeded) {
165 PBD::warning << _("AlsaAudioBackend: Device Reservation failed.") << endmsg;
173 AlsaAudioBackend::available_sample_rates (const std::string&) const
175 std::vector<float> sr;
176 sr.push_back (8000.0);
177 sr.push_back (22050.0);
178 sr.push_back (24000.0);
179 sr.push_back (44100.0);
180 sr.push_back (48000.0);
181 sr.push_back (88200.0);
182 sr.push_back (96000.0);
183 sr.push_back (176400.0);
184 sr.push_back (192000.0);
188 std::vector<uint32_t>
189 AlsaAudioBackend::available_buffer_sizes (const std::string&) const
191 std::vector<uint32_t> bs;
205 AlsaAudioBackend::available_input_channel_count (const std::string&) const
207 return 128; // TODO query current device
211 AlsaAudioBackend::available_output_channel_count (const std::string&) const
213 return 128; // TODO query current device
217 AlsaAudioBackend::can_change_sample_rate_when_running () const
223 AlsaAudioBackend::can_change_buffer_size_when_running () const
229 AlsaAudioBackend::set_device_name (const std::string& d)
236 AlsaAudioBackend::set_sample_rate (float sr)
238 if (sr <= 0) { return -1; }
240 engine.sample_rate_change (sr);
245 AlsaAudioBackend::set_buffer_size (uint32_t bs)
247 if (bs <= 0 || bs >= _max_buffer_size) {
250 _samples_per_period = bs;
251 engine.buffer_size_change (bs);
256 AlsaAudioBackend::set_interleaved (bool yn)
258 if (!yn) { return 0; }
263 AlsaAudioBackend::set_input_channels (uint32_t cc)
270 AlsaAudioBackend::set_output_channels (uint32_t cc)
277 AlsaAudioBackend::set_systemic_input_latency (uint32_t sl)
279 _systemic_input_latency = sl;
284 AlsaAudioBackend::set_systemic_output_latency (uint32_t sl)
286 _systemic_output_latency = sl;
290 /* Retrieving parameters */
292 AlsaAudioBackend::device_name () const
294 return _audio_device;
298 AlsaAudioBackend::sample_rate () const
304 AlsaAudioBackend::buffer_size () const
306 return _samples_per_period;
310 AlsaAudioBackend::interleaved () const
316 AlsaAudioBackend::input_channels () const
322 AlsaAudioBackend::output_channels () const
328 AlsaAudioBackend::systemic_input_latency () const
330 return _systemic_input_latency;
334 AlsaAudioBackend::systemic_output_latency () const
336 return _systemic_output_latency;
340 std::vector<std::string>
341 AlsaAudioBackend::enumerate_midi_options () const
343 std::vector<std::string> m;
344 m.push_back (_("-None-"));
345 std::map<std::string, std::string> devices;
346 get_alsa_rawmidi_device_names(devices);
348 for (std::map<std::string, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
349 m.push_back (i->first);
352 m.push_back (_("-All-"));
358 AlsaAudioBackend::set_midi_option (const std::string& opt)
365 AlsaAudioBackend::midi_option () const
372 static void * pthread_process (void *arg)
374 AlsaAudioBackend *d = static_cast<AlsaAudioBackend *>(arg);
375 d->main_process_thread ();
381 AlsaAudioBackend::_start (bool for_latency_measurement)
383 if (_active || _run) {
384 PBD::error << _("AlsaAudioBackend: already active.") << endmsg;
389 PBD::warning << _("AlsaAudioBackend: recovering from unclean shutdown, port registry is not empty.") << endmsg;
390 _system_inputs.clear();
391 _system_outputs.clear();
392 _system_midi_in.clear();
393 _system_midi_out.clear();
399 assert(_rmidi_in.size() == 0);
400 assert(_rmidi_out.size() == 0);
403 std::string alsa_device;
404 std::map<std::string, std::string> devices;
405 get_alsa_audio_device_names(devices);
406 for (std::map<std::string, std::string>::const_iterator i = devices.begin (); i != devices.end(); ++i) {
407 if (i->first == _audio_device) {
408 alsa_device = i->second;
413 acquire_device(alsa_device.c_str());
414 _pcmi = new Alsa_pcmi (alsa_device.c_str(), alsa_device.c_str(), 0, _samplerate, _samples_per_period, _periods_per_cycle, 0);
415 switch (_pcmi->state ()) {
416 case 0: /* OK */ break;
417 case -1: PBD::error << _("AlsaAudioBackend: failed to open device.") << endmsg; break;
418 case -2: PBD::error << _("AlsaAudioBackend: failed to allocate parameters.") << endmsg; break;
419 case -3: PBD::error << _("AlsaAudioBackend: cannot set requested sample rate.") << endmsg; break;
420 case -4: PBD::error << _("AlsaAudioBackend: cannot set requested period size.") << endmsg; break;
421 case -5: PBD::error << _("AlsaAudioBackend: cannot set requested number of periods.") << endmsg; break;
422 case -6: PBD::error << _("AlsaAudioBackend: unsupported sample format.") << endmsg; break;
423 default: PBD::error << _("AlsaAudioBackend: initialization failed.") << endmsg; break;
425 if (_pcmi->state ()) {
426 delete _pcmi; _pcmi = 0;
435 if (_n_outputs != _pcmi->nplay ()) {
436 if (_n_outputs == 0) {
437 _n_outputs = _pcmi->nplay ();
439 _n_outputs = std::min (_n_outputs, _pcmi->nplay ());
441 PBD::warning << _("AlsaAudioBackend: adjusted output channel count to match device.") << endmsg;
444 if (_n_inputs != _pcmi->ncapt ()) {
445 if (_n_inputs == 0) {
446 _n_inputs = _pcmi->ncapt ();
448 _n_inputs = std::min (_n_inputs, _pcmi->ncapt ());
450 PBD::warning << _("AlsaAudioBackend: adjusted input channel count to match device.") << endmsg;
453 if (_pcmi->fsize() != _samples_per_period) {
454 _samples_per_period = _pcmi->fsize();
455 PBD::warning << _("AlsaAudioBackend: samples per period does not match.") << endmsg;
458 if (_pcmi->fsamp() != _samplerate) {
459 _samplerate = _pcmi->fsamp();
460 engine.sample_rate_change (_samplerate);
461 PBD::warning << _("AlsaAudioBackend: sample rate does not match.") << endmsg;
464 if (for_latency_measurement) {
465 _systemic_input_latency = 0;
466 _systemic_output_latency = 0;
469 register_system_midi_ports();
471 if (register_system_audio_ports()) {
472 PBD::error << _("AlsaAudioBackend: failed to register system ports.") << endmsg;
473 delete _pcmi; _pcmi = 0;
478 engine.sample_rate_change (_samplerate);
479 engine.buffer_size_change (_samples_per_period);
481 if (engine.reestablish_ports ()) {
482 PBD::error << _("AlsaAudioBackend: Could not re-establish ports.") << endmsg;
483 delete _pcmi; _pcmi = 0;
488 engine.reconnect_ports ();
491 if (_realtime_pthread_create (SCHED_FIFO, -20,
492 &_main_thread, pthread_process, this))
494 if (pthread_create (&_main_thread, NULL, pthread_process, this))
496 PBD::error << _("AlsaAudioBackend: failed to create process thread.") << endmsg;
497 delete _pcmi; _pcmi = 0;
502 PBD::warning << _("AlsaAudioBackend: cannot acquire realtime permissions.") << endmsg;
507 while (!_active && --timeout > 0) { Glib::usleep (1000); }
509 if (timeout == 0 || !_active) {
510 PBD::error << _("AlsaAudioBackend: failed to start process thread.") << endmsg;
511 delete _pcmi; _pcmi = 0;
521 AlsaAudioBackend::stop ()
529 if (pthread_join (_main_thread, &status)) {
530 PBD::error << _("AlsaAudioBackend: failed to terminate.") << endmsg;
534 while (!_rmidi_out.empty ()) {
535 AlsaRawMidiIO *m = _rmidi_out.back ();
537 _rmidi_out.pop_back ();
540 while (!_rmidi_in.empty ()) {
541 AlsaRawMidiIO *m = _rmidi_in.back ();
543 _rmidi_in.pop_back ();
547 unregister_system_ports();
548 delete _pcmi; _pcmi = 0;
551 return (_active == false) ? 0 : -1;
555 AlsaAudioBackend::freewheel (bool onoff)
557 if (onoff == _freewheeling) {
560 _freewheeling = onoff;
561 engine.freewheel_callback (onoff);
566 AlsaAudioBackend::dsp_load () const
568 return 100.f * _dsp_load;
572 AlsaAudioBackend::raw_buffer_size (DataType t)
575 case DataType::AUDIO:
576 return _samples_per_period * sizeof(Sample);
578 return _max_buffer_size; // XXX not really limited
585 AlsaAudioBackend::sample_time ()
587 return _processed_samples;
591 AlsaAudioBackend::sample_time_at_cycle_start ()
593 return _processed_samples;
597 AlsaAudioBackend::samples_since_cycle_start ()
604 AlsaAudioBackend::alsa_process_thread (void *arg)
606 ThreadData* td = reinterpret_cast<ThreadData*> (arg);
607 boost::function<void ()> f = td->f;
614 AlsaAudioBackend::create_process_thread (boost::function<void()> func)
618 size_t stacksize = 100000;
620 pthread_attr_init (&attr);
621 pthread_attr_setstacksize (&attr, stacksize);
622 ThreadData* td = new ThreadData (this, func, stacksize);
624 if (pthread_create (&thread_id, &attr, alsa_process_thread, td)) {
625 PBD::error << _("AudioEngine: cannot create process thread.") << endmsg;
626 pthread_attr_destroy (&attr);
629 pthread_attr_destroy (&attr);
631 _threads.push_back (thread_id);
636 AlsaAudioBackend::join_process_threads ()
640 for (std::vector<pthread_t>::const_iterator i = _threads.begin (); i != _threads.end (); ++i)
643 if (pthread_join (*i, &status)) {
644 PBD::error << _("AudioEngine: cannot terminate process thread.") << endmsg;
653 AlsaAudioBackend::in_process_thread ()
655 for (std::vector<pthread_t>::const_iterator i = _threads.begin (); i != _threads.end (); ++i)
657 if (pthread_equal (*i, pthread_self ()) != 0) {
665 AlsaAudioBackend::process_thread_count ()
667 return _threads.size ();
671 AlsaAudioBackend::update_latencies ()
678 AlsaAudioBackend::private_handle () const
684 AlsaAudioBackend::my_name () const
686 return _instance_name;
690 AlsaAudioBackend::available () const
692 return _run && _active;
696 AlsaAudioBackend::port_name_size () const
702 AlsaAudioBackend::set_port_name (PortEngine::PortHandle port, const std::string& name)
704 if (!valid_port (port)) {
705 PBD::error << _("AlsaBackend::set_port_name: Invalid Port(s)") << endmsg;
708 return static_cast<AlsaPort*>(port)->set_name (_instance_name + ":" + name);
712 AlsaAudioBackend::get_port_name (PortEngine::PortHandle port) const
714 if (!valid_port (port)) {
715 PBD::error << _("AlsaBackend::get_port_name: Invalid Port(s)") << endmsg;
716 return std::string ();
718 return static_cast<AlsaPort*>(port)->name ();
721 PortEngine::PortHandle
722 AlsaAudioBackend::get_port_by_name (const std::string& name) const
724 PortHandle port = (PortHandle) find_port (name);
729 AlsaAudioBackend::get_ports (
730 const std::string& port_name_pattern,
731 DataType type, PortFlags flags,
732 std::vector<std::string>& port_names) const
736 bool use_regexp = false;
737 if (port_name_pattern.size () > 0) {
738 if (!regcomp (&port_regex, port_name_pattern.c_str (), REG_EXTENDED|REG_NOSUB)) {
742 for (size_t i = 0; i < _ports.size (); ++i) {
743 AlsaPort* port = _ports[i];
744 if ((port->type () == type) && (port->flags () & flags)) {
745 if (!use_regexp || !regexec (&port_regex, port->name ().c_str (), 0, NULL, 0)) {
746 port_names.push_back (port->name ());
752 regfree (&port_regex);
758 AlsaAudioBackend::port_data_type (PortEngine::PortHandle port) const
760 if (!valid_port (port)) {
761 return DataType::NIL;
763 return static_cast<AlsaPort*>(port)->type ();
766 PortEngine::PortHandle
767 AlsaAudioBackend::register_port (
768 const std::string& name,
769 ARDOUR::DataType type,
770 ARDOUR::PortFlags flags)
772 if (name.size () == 0) { return 0; }
773 if (flags & IsPhysical) { return 0; }
774 return add_port (_instance_name + ":" + name, type, flags);
777 PortEngine::PortHandle
778 AlsaAudioBackend::add_port (
779 const std::string& name,
780 ARDOUR::DataType type,
781 ARDOUR::PortFlags flags)
783 assert(name.size ());
784 if (find_port (name)) {
785 PBD::error << _("AlsaBackend::register_port: Port already exists:")
786 << " (" << name << ")" << endmsg;
789 AlsaPort* port = NULL;
791 case DataType::AUDIO:
792 port = new AlsaAudioPort (*this, name, flags);
795 port = new AlsaMidiPort (*this, name, flags);
798 PBD::error << _("AlsaBackend::register_port: Invalid Data Type.") << endmsg;
802 _ports.push_back (port);
808 AlsaAudioBackend::unregister_port (PortEngine::PortHandle port_handle)
810 if (!valid_port (port_handle)) {
811 PBD::error << _("AlsaBackend::unregister_port: Invalid Port.") << endmsg;
813 AlsaPort* port = static_cast<AlsaPort*>(port_handle);
814 std::vector<AlsaPort*>::iterator i = std::find (_ports.begin (), _ports.end (), static_cast<AlsaPort*>(port_handle));
815 if (i == _ports.end ()) {
816 PBD::error << _("AlsaBackend::unregister_port: Failed to find port") << endmsg;
819 disconnect_all(port_handle);
825 AlsaAudioBackend::register_system_audio_ports()
829 const int a_ins = _n_inputs > 0 ? _n_inputs : 2;
830 const int a_out = _n_outputs > 0 ? _n_outputs : 2;
833 lr.min = lr.max = _samples_per_period * _periods_per_cycle + _systemic_input_latency;
834 for (int i = 1; i <= a_ins; ++i) {
836 snprintf(tmp, sizeof(tmp), "system:capture_%d", i);
837 PortHandle p = add_port(std::string(tmp), DataType::AUDIO, static_cast<PortFlags>(IsOutput | IsPhysical | IsTerminal));
839 set_latency_range (p, false, lr);
840 _system_inputs.push_back(static_cast<AlsaPort*>(p));
843 lr.min = lr.max = _samples_per_period * _periods_per_cycle + _systemic_output_latency;
844 for (int i = 1; i <= a_out; ++i) {
846 snprintf(tmp, sizeof(tmp), "system:playback_%d", i);
847 PortHandle p = add_port(std::string(tmp), DataType::AUDIO, static_cast<PortFlags>(IsInput | IsPhysical | IsTerminal));
849 set_latency_range (p, true, lr);
850 _system_outputs.push_back(static_cast<AlsaPort*>(p));
856 AlsaAudioBackend::register_system_midi_ports()
859 std::vector<std::string> devices;
861 if (_midi_device == _("-None-")) {
864 else if (_midi_device == _("-All-")) {
865 std::map<std::string, std::string> devmap;
866 get_alsa_rawmidi_device_names(devmap);
867 for (std::map<std::string, std::string>::const_iterator i = devmap.begin (); i != devmap.end(); ++i) {
868 devices.push_back (i->second);
871 std::map<std::string, std::string> devmap;
872 get_alsa_rawmidi_device_names(devmap);
873 for (std::map<std::string, std::string>::const_iterator i = devmap.begin (); i != devmap.end(); ++i) {
874 if (i->first == _midi_device) {
875 devices.push_back (i->second);
881 for (std::vector<std::string>::const_iterator i = devices.begin (); i != devices.end (); ++i) {
883 AlsaRawMidiOut *mout = new AlsaRawMidiOut (i->c_str());
884 if (mout->state ()) {
885 PBD::warning << string_compose (
886 _("AlsaRawMidiOut: failed to open midi device '%1'."), *i)
890 mout->setup_timing(_samples_per_period, _samplerate);
891 mout->sync_time (g_get_monotonic_time());
892 if (mout->start ()) {
893 PBD::warning << string_compose (
894 _("AlsaRawMidiOut: failed to start midi device '%1'."), *i)
898 _rmidi_out.push_back (mout);
902 AlsaRawMidiIn *midin = new AlsaRawMidiIn (i->c_str());
903 if (midin->state ()) {
904 PBD::warning << string_compose (
905 _("AlsaRawMidiIn: failed to open midi device '%1'."), *i)
909 midin->setup_timing(_samples_per_period, _samplerate);
910 midin->sync_time (g_get_monotonic_time());
911 if (midin->start ()) {
912 PBD::warning << string_compose (
913 _("AlsaRawMidiIn: failed to start midi device '%1'."), *i)
917 _rmidi_in.push_back (midin);
922 const int m_ins = _rmidi_in.size();
923 const int m_out = _rmidi_out.size();
925 lr.min = lr.max = _samples_per_period + _systemic_input_latency;
926 for (int i = 1; i <= m_ins; ++i) {
928 snprintf(tmp, sizeof(tmp), "system:midi_capture_%d", i);
929 PortHandle p = add_port(std::string(tmp), DataType::MIDI, static_cast<PortFlags>(IsOutput | IsPhysical | IsTerminal));
931 set_latency_range (p, false, lr);
932 _system_midi_in.push_back(static_cast<AlsaPort*>(p));
935 lr.min = lr.max = _samples_per_period + _systemic_output_latency;
936 for (int i = 1; i <= m_out; ++i) {
938 snprintf(tmp, sizeof(tmp), "system:midi_playback_%d", i);
939 PortHandle p = add_port(std::string(tmp), DataType::MIDI, static_cast<PortFlags>(IsInput | IsPhysical | IsTerminal));
941 set_latency_range (p, true, lr);
942 _system_midi_out.push_back(static_cast<AlsaPort*>(p));
949 AlsaAudioBackend::unregister_system_ports()
952 _system_inputs.clear();
953 _system_outputs.clear();
954 _system_midi_in.clear();
955 _system_midi_out.clear();
956 while (i < _ports.size ()) {
957 AlsaPort* port = _ports[i];
958 if (port->is_physical () && port->is_terminal ()) {
959 port->disconnect_all ();
960 _ports.erase (_ports.begin() + i);
968 AlsaAudioBackend::connect (const std::string& src, const std::string& dst)
970 AlsaPort* src_port = find_port (src);
971 AlsaPort* dst_port = find_port (dst);
974 PBD::error << _("AlsaBackend::connect: Invalid Source port:")
975 << " (" << src <<")" << endmsg;
979 PBD::error << _("AlsaBackend::connect: Invalid Destination port:")
980 << " (" << dst <<")" << endmsg;
983 return src_port->connect (dst_port);
987 AlsaAudioBackend::disconnect (const std::string& src, const std::string& dst)
989 AlsaPort* src_port = find_port (src);
990 AlsaPort* dst_port = find_port (dst);
992 if (!src_port || !dst_port) {
993 PBD::error << _("AlsaBackend::disconnect: Invalid Port(s)") << endmsg;
996 return src_port->disconnect (dst_port);
1000 AlsaAudioBackend::connect (PortEngine::PortHandle src, const std::string& dst)
1002 AlsaPort* dst_port = find_port (dst);
1003 if (!valid_port (src)) {
1004 PBD::error << _("AlsaBackend::connect: Invalid Source Port Handle") << endmsg;
1008 PBD::error << _("AlsaBackend::connect: Invalid Destination Port")
1009 << " (" << dst << ")" << endmsg;
1012 return static_cast<AlsaPort*>(src)->connect (dst_port);
1016 AlsaAudioBackend::disconnect (PortEngine::PortHandle src, const std::string& dst)
1018 AlsaPort* dst_port = find_port (dst);
1019 if (!valid_port (src) || !dst_port) {
1020 PBD::error << _("AlsaBackend::disconnect: Invalid Port(s)") << endmsg;
1023 return static_cast<AlsaPort*>(src)->disconnect (dst_port);
1027 AlsaAudioBackend::disconnect_all (PortEngine::PortHandle port)
1029 if (!valid_port (port)) {
1030 PBD::error << _("AlsaBackend::disconnect_all: Invalid Port") << endmsg;
1033 static_cast<AlsaPort*>(port)->disconnect_all ();
1038 AlsaAudioBackend::connected (PortEngine::PortHandle port, bool /* process_callback_safe*/)
1040 if (!valid_port (port)) {
1041 PBD::error << _("AlsaBackend::disconnect_all: Invalid Port") << endmsg;
1044 return static_cast<AlsaPort*>(port)->is_connected ();
1048 AlsaAudioBackend::connected_to (PortEngine::PortHandle src, const std::string& dst, bool /*process_callback_safe*/)
1050 AlsaPort* dst_port = find_port (dst);
1051 if (!valid_port (src) || !dst_port) {
1052 PBD::error << _("AlsaBackend::connected_to: Invalid Port") << endmsg;
1055 return static_cast<AlsaPort*>(src)->is_connected (dst_port);
1059 AlsaAudioBackend::physically_connected (PortEngine::PortHandle port, bool /*process_callback_safe*/)
1061 if (!valid_port (port)) {
1062 PBD::error << _("AlsaBackend::physically_connected: Invalid Port") << endmsg;
1065 return static_cast<AlsaPort*>(port)->is_physically_connected ();
1069 AlsaAudioBackend::get_connections (PortEngine::PortHandle port, std::vector<std::string>& names, bool /*process_callback_safe*/)
1071 if (!valid_port (port)) {
1072 PBD::error << _("AlsaBackend::get_connections: Invalid Port") << endmsg;
1076 assert (0 == names.size ());
1078 const std::vector<AlsaPort*>& connected_ports = static_cast<AlsaPort*>(port)->get_connections ();
1080 for (std::vector<AlsaPort*>::const_iterator i = connected_ports.begin (); i != connected_ports.end (); ++i) {
1081 names.push_back ((*i)->name ());
1084 return (int)names.size ();
1089 AlsaAudioBackend::midi_event_get (
1090 pframes_t& timestamp,
1091 size_t& size, uint8_t** buf, void* port_buffer,
1092 uint32_t event_index)
1094 assert (buf && port_buffer);
1095 AlsaMidiBuffer& source = * static_cast<AlsaMidiBuffer*>(port_buffer);
1096 if (event_index >= source.size ()) {
1099 AlsaMidiEvent * const event = source[event_index].get ();
1101 timestamp = event->timestamp ();
1102 size = event->size ();
1103 *buf = event->data ();
1108 AlsaAudioBackend::midi_event_put (
1110 pframes_t timestamp,
1111 const uint8_t* buffer, size_t size)
1113 assert (buffer && port_buffer);
1114 AlsaMidiBuffer& dst = * static_cast<AlsaMidiBuffer*>(port_buffer);
1115 if (dst.size () && (pframes_t)dst.back ()->timestamp () > timestamp) {
1116 fprintf (stderr, "AlsaMidiBuffer: it's too late for this event. %d > %d\n",
1117 (pframes_t)dst.back ()->timestamp (), timestamp);
1120 dst.push_back (boost::shared_ptr<AlsaMidiEvent>(new AlsaMidiEvent (timestamp, buffer, size)));
1125 AlsaAudioBackend::get_midi_event_count (void* port_buffer)
1127 assert (port_buffer);
1128 return static_cast<AlsaMidiBuffer*>(port_buffer)->size ();
1132 AlsaAudioBackend::midi_clear (void* port_buffer)
1134 assert (port_buffer);
1135 AlsaMidiBuffer * buf = static_cast<AlsaMidiBuffer*>(port_buffer);
1143 AlsaAudioBackend::can_monitor_input () const
1149 AlsaAudioBackend::request_input_monitoring (PortEngine::PortHandle, bool)
1155 AlsaAudioBackend::ensure_input_monitoring (PortEngine::PortHandle, bool)
1161 AlsaAudioBackend::monitoring_input (PortEngine::PortHandle)
1166 /* Latency management */
1169 AlsaAudioBackend::set_latency_range (PortEngine::PortHandle port, bool for_playback, LatencyRange latency_range)
1171 if (!valid_port (port)) {
1172 PBD::error << _("AlsaPort::set_latency_range (): invalid port.") << endmsg;
1174 static_cast<AlsaPort*>(port)->set_latency_range (latency_range, for_playback);
1178 AlsaAudioBackend::get_latency_range (PortEngine::PortHandle port, bool for_playback)
1180 if (!valid_port (port)) {
1181 PBD::error << _("AlsaPort::get_latency_range (): invalid port.") << endmsg;
1187 return static_cast<AlsaPort*>(port)->latency_range (for_playback);
1190 /* Discovering physical ports */
1193 AlsaAudioBackend::port_is_physical (PortEngine::PortHandle port) const
1195 if (!valid_port (port)) {
1196 PBD::error << _("AlsaPort::port_is_physical (): invalid port.") << endmsg;
1199 return static_cast<AlsaPort*>(port)->is_physical ();
1203 AlsaAudioBackend::get_physical_outputs (DataType type, std::vector<std::string>& port_names)
1205 for (size_t i = 0; i < _ports.size (); ++i) {
1206 AlsaPort* port = _ports[i];
1207 if ((port->type () == type) && port->is_input () && port->is_physical ()) {
1208 port_names.push_back (port->name ());
1214 AlsaAudioBackend::get_physical_inputs (DataType type, std::vector<std::string>& port_names)
1216 for (size_t i = 0; i < _ports.size (); ++i) {
1217 AlsaPort* port = _ports[i];
1218 if ((port->type () == type) && port->is_output () && port->is_physical ()) {
1219 port_names.push_back (port->name ());
1225 AlsaAudioBackend::n_physical_outputs () const
1229 for (size_t i = 0; i < _ports.size (); ++i) {
1230 AlsaPort* port = _ports[i];
1231 if (port->is_output () && port->is_physical ()) {
1232 switch (port->type ()) {
1233 case DataType::AUDIO: ++n_audio; break;
1234 case DataType::MIDI: ++n_midi; break;
1240 cc.set (DataType::AUDIO, n_audio);
1241 cc.set (DataType::MIDI, n_midi);
1246 AlsaAudioBackend::n_physical_inputs () const
1250 for (size_t i = 0; i < _ports.size (); ++i) {
1251 AlsaPort* port = _ports[i];
1252 if (port->is_input () && port->is_physical ()) {
1253 switch (port->type ()) {
1254 case DataType::AUDIO: ++n_audio; break;
1255 case DataType::MIDI: ++n_midi; break;
1261 cc.set (DataType::AUDIO, n_audio);
1262 cc.set (DataType::MIDI, n_midi);
1266 /* Getting access to the data buffer for a port */
1269 AlsaAudioBackend::get_buffer (PortEngine::PortHandle port, pframes_t nframes)
1272 assert (valid_port (port));
1273 return static_cast<AlsaPort*>(port)->get_buffer (nframes);
1276 /* Engine Process */
1278 AlsaAudioBackend::main_process_thread ()
1280 AudioEngine::thread_init_callback (this);
1282 _processed_samples = 0;
1284 uint64_t clock1, clock2;
1285 clock1 = g_get_monotonic_time();
1286 _pcmi->pcm_start ();
1287 int no_proc_errors = 0;
1289 manager.graph_order_callback();
1294 if (!_freewheeling) {
1295 nr = _pcmi->pcm_wait ();
1297 if (_pcmi->state () > 0) {
1301 if (_pcmi->state () < 0 || no_proc_errors > 50) {
1302 PBD::error << _("AlsaAudioBackend: I/O error. Audio Process Terminated.") << endmsg;
1305 while (nr >= (long)_samples_per_period) {
1307 clock1 = g_get_monotonic_time();
1310 _pcmi->capt_init (_samples_per_period);
1311 for (std::vector<AlsaPort*>::const_iterator it = _system_inputs.begin (); it != _system_inputs.end (); ++it, ++i) {
1312 _pcmi->capt_chan (i, (float*)((*it)->get_buffer(_samples_per_period)), _samples_per_period);
1314 _pcmi->capt_done (_samples_per_period);
1318 for (std::vector<AlsaPort*>::const_iterator it = _system_midi_in.begin (); it != _system_midi_in.end (); ++it, ++i) {
1319 assert (_rmidi_in.size() > i);
1320 AlsaRawMidiIn *rm = static_cast<AlsaRawMidiIn*>(_rmidi_in.at(i));
1321 void *bptr = (*it)->get_buffer(0);
1323 uint8_t data[64]; // match MaxAlsaRawEventSize in alsa_rawmidi.cc
1324 size_t size = sizeof(data);
1326 while (rm->recv_event (time, data, size)) {
1327 midi_event_put(bptr, time, data, size);
1328 size = sizeof(data);
1330 rm->sync_time (clock1);
1333 for (std::vector<AlsaPort*>::const_iterator it = _system_outputs.begin (); it != _system_outputs.end (); ++it) {
1334 memset ((*it)->get_buffer (_samples_per_period), 0, _samples_per_period * sizeof (Sample));
1337 if (engine.process_callback (_samples_per_period)) {
1345 for (std::vector<AlsaPort*>::const_iterator it = _system_midi_out.begin (); it != _system_midi_out.end (); ++it, ++i) {
1346 assert (_rmidi_out.size() > i);
1347 AlsaRawMidiOut *rm = static_cast<AlsaRawMidiOut*>(_rmidi_out.at(i));
1348 const AlsaMidiBuffer *src = static_cast<const AlsaMidiBuffer*>((*it)->get_buffer(0));
1349 rm->sync_time (clock1); // ?? use clock pre DSP load?
1350 for (AlsaMidiBuffer::const_iterator mit = src->begin (); mit != src->end (); ++mit) {
1351 rm->send_event ((*mit)->timestamp(), (*mit)->data(), (*mit)->size());
1355 /* write back audio */
1357 _pcmi->play_init (_samples_per_period);
1358 for (std::vector<AlsaPort*>::const_iterator it = _system_outputs.begin (); it != _system_outputs.end (); ++it, ++i) {
1359 _pcmi->play_chan (i, (const float*)(*it)->get_buffer (_samples_per_period), _samples_per_period);
1361 for (; i < _pcmi->nplay (); ++i) {
1362 _pcmi->clear_chan (i, _samples_per_period);
1364 _pcmi->play_done (_samples_per_period);
1365 nr -= _samples_per_period;
1366 _processed_samples += _samples_per_period;
1368 /* calculate DSP load */
1369 clock2 = g_get_monotonic_time();
1370 const int64_t elapsed_time = clock2 - clock1;
1371 const int64_t nomial_time = 1e6 * _samples_per_period / _samplerate;
1372 _dsp_load = elapsed_time / (float) nomial_time;
1375 if (xrun && (_pcmi->capt_xrun() > 0 || _pcmi->play_xrun() > 0)) {
1378 fprintf(stderr, "ALSA x-run read: %.1f ms, write: %.1f ms\n",
1379 _pcmi->capt_xrun() * 1000.0, _pcmi->play_xrun() * 1000.0);
1384 for (std::vector<AlsaPort*>::const_iterator it = _system_inputs.begin (); it != _system_inputs.end (); ++it) {
1385 memset ((*it)->get_buffer (_samples_per_period), 0, _samples_per_period * sizeof (Sample));
1387 for (std::vector<AlsaPort*>::const_iterator it = _system_midi_in.begin (); it != _system_midi_in.end (); ++it) {
1388 static_cast<AlsaMidiBuffer*>((*it)->get_buffer(0))->clear ();
1391 if (engine.process_callback (_samples_per_period)) {
1396 Glib::usleep (100); // don't hog cpu
1399 if (!pthread_mutex_trylock (&_port_callback_mutex)) {
1400 while (!_port_connection_queue.empty ()) {
1401 PortConnectData *c = _port_connection_queue.back ();
1402 manager.connect_callback (c->a, c->b, c->c);
1403 _port_connection_queue.pop_back ();
1406 pthread_mutex_unlock (&_port_callback_mutex);
1413 engine.halted_callback("ALSA I/O error.");
1419 /******************************************************************************/
1421 static boost::shared_ptr<AlsaAudioBackend> _instance;
1423 static boost::shared_ptr<AudioBackend> backend_factory (AudioEngine& e);
1424 static int instantiate (const std::string& arg1, const std::string& /* arg2 */);
1425 static int deinstantiate ();
1426 static bool already_configured ();
1428 static ARDOUR::AudioBackendInfo _descriptor = {
1436 static boost::shared_ptr<AudioBackend>
1437 backend_factory (AudioEngine& e)
1440 _instance.reset (new AlsaAudioBackend (e, _descriptor));
1446 instantiate (const std::string& arg1, const std::string& /* arg2 */)
1448 s_instance_name = arg1;
1460 already_configured ()
1465 extern "C" ARDOURBACKEND_API ARDOUR::AudioBackendInfo* descriptor ()
1467 return &_descriptor;
1471 /******************************************************************************/
1472 AlsaPort::AlsaPort (AlsaAudioBackend &b, const std::string& name, PortFlags flags)
1477 _capture_latency_range.min = 0;
1478 _capture_latency_range.max = 0;
1479 _playback_latency_range.min = 0;
1480 _playback_latency_range.max = 0;
1483 AlsaPort::~AlsaPort () {
1488 int AlsaPort::connect (AlsaPort *port)
1491 PBD::error << _("AlsaPort::connect (): invalid (null) port") << endmsg;
1495 if (type () != port->type ()) {
1496 PBD::error << _("AlsaPort::connect (): wrong port-type") << endmsg;
1500 if (is_output () && port->is_output ()) {
1501 PBD::error << _("AlsaPort::connect (): cannot inter-connect output ports.") << endmsg;
1505 if (is_input () && port->is_input ()) {
1506 PBD::error << _("AlsaPort::connect (): cannot inter-connect input ports.") << endmsg;
1511 PBD::error << _("AlsaPort::connect (): cannot self-connect ports.") << endmsg;
1515 if (is_connected (port)) {
1516 #if 0 // don't bother to warn about this for now. just ignore it
1517 PBD::error << _("AlsaPort::connect (): ports are already connected:")
1518 << " (" << name () << ") -> (" << port->name () << ")"
1524 _connect (port, true);
1529 void AlsaPort::_connect (AlsaPort *port, bool callback)
1531 _connections.push_back (port);
1533 port->_connect (this, false);
1534 _alsa_backend.port_connect_callback (name(), port->name(), true);
1538 int AlsaPort::disconnect (AlsaPort *port)
1541 PBD::error << _("AlsaPort::disconnect (): invalid (null) port") << endmsg;
1545 if (!is_connected (port)) {
1546 PBD::error << _("AlsaPort::disconnect (): ports are not connected:")
1547 << " (" << name () << ") -> (" << port->name () << ")"
1551 _disconnect (port, true);
1555 void AlsaPort::_disconnect (AlsaPort *port, bool callback)
1557 std::vector<AlsaPort*>::iterator it = std::find (_connections.begin (), _connections.end (), port);
1559 assert (it != _connections.end ());
1561 _connections.erase (it);
1564 port->_disconnect (this, false);
1565 _alsa_backend.port_connect_callback (name(), port->name(), false);
1570 void AlsaPort::disconnect_all ()
1572 while (!_connections.empty ()) {
1573 _connections.back ()->_disconnect (this, false);
1574 _alsa_backend.port_connect_callback (name(), _connections.back ()->name(), false);
1575 _connections.pop_back ();
1580 AlsaPort::is_connected (const AlsaPort *port) const
1582 return std::find (_connections.begin (), _connections.end (), port) != _connections.end ();
1585 bool AlsaPort::is_physically_connected () const
1587 for (std::vector<AlsaPort*>::const_iterator it = _connections.begin (); it != _connections.end (); ++it) {
1588 if ((*it)->is_physical ()) {
1595 /******************************************************************************/
1597 AlsaAudioPort::AlsaAudioPort (AlsaAudioBackend &b, const std::string& name, PortFlags flags)
1598 : AlsaPort (b, name, flags)
1600 memset (_buffer, 0, sizeof (_buffer));
1601 mlock(_buffer, sizeof (_buffer));
1604 AlsaAudioPort::~AlsaAudioPort () { }
1606 void* AlsaAudioPort::get_buffer (pframes_t n_samples)
1609 std::vector<AlsaPort*>::const_iterator it = get_connections ().begin ();
1610 if (it == get_connections ().end ()) {
1611 memset (_buffer, 0, n_samples * sizeof (Sample));
1613 AlsaAudioPort const * source = static_cast<const AlsaAudioPort*>(*it);
1614 assert (source && source->is_output ());
1615 memcpy (_buffer, source->const_buffer (), n_samples * sizeof (Sample));
1616 while (++it != get_connections ().end ()) {
1617 source = static_cast<const AlsaAudioPort*>(*it);
1618 assert (source && source->is_output ());
1619 Sample* dst = buffer ();
1620 const Sample* src = source->const_buffer ();
1621 for (uint32_t s = 0; s < n_samples; ++s, ++dst, ++src) {
1631 AlsaMidiPort::AlsaMidiPort (AlsaAudioBackend &b, const std::string& name, PortFlags flags)
1632 : AlsaPort (b, name, flags)
1637 AlsaMidiPort::~AlsaMidiPort () { }
1639 struct MidiEventSorter {
1640 bool operator() (const boost::shared_ptr<AlsaMidiEvent>& a, const boost::shared_ptr<AlsaMidiEvent>& b) {
1645 void* AlsaMidiPort::get_buffer (pframes_t /* nframes */)
1649 for (std::vector<AlsaPort*>::const_iterator i = get_connections ().begin ();
1650 i != get_connections ().end ();
1652 const AlsaMidiBuffer src = static_cast<const AlsaMidiPort*>(*i)->const_buffer ();
1653 for (AlsaMidiBuffer::const_iterator it = src.begin (); it != src.end (); ++it) {
1654 _buffer.push_back (boost::shared_ptr<AlsaMidiEvent>(new AlsaMidiEvent (**it)));
1657 std::sort (_buffer.begin (), _buffer.end (), MidiEventSorter());
1662 AlsaMidiEvent::AlsaMidiEvent (const pframes_t timestamp, const uint8_t* data, size_t size)
1664 , _timestamp (timestamp)
1668 _data = (uint8_t*) malloc (size);
1669 memcpy (_data, data, size);
1673 AlsaMidiEvent::AlsaMidiEvent (const AlsaMidiEvent& other)
1674 : _size (other.size ())
1675 , _timestamp (other.timestamp ())
1678 if (other.size () && other.const_data ()) {
1679 _data = (uint8_t*) malloc (other.size ());
1680 memcpy (_data, other.const_data (), other.size ());
1684 AlsaMidiEvent::~AlsaMidiEvent () {