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 "dummy_audiobackend.h"
27 #include "dummy_midi_seq.h"
29 #include "pbd/error.h"
30 #include "ardour/port_manager.h"
33 using namespace ARDOUR;
35 static std::string s_instance_name;
36 size_t DummyAudioBackend::_max_buffer_size = 8192;
37 std::vector<std::string> DummyAudioBackend::_midi_options;
38 std::vector<AudioBackend::DeviceStatus> DummyAudioBackend::_device_status;
40 #ifdef PLATFORM_WINDOWS
41 static double _win_pc_rate = 0; // usec per tick
44 static int64_t _x_get_monotonic_usec() {
45 #ifdef PLATFORM_WINDOWS
46 if (_win_pc_rate > 0) {
48 // not very reliable, but the only realistic way for sub milli-seconds
49 if (QueryPerformanceCounter (&Count)) {
50 return (int64_t) (Count.QuadPart * _win_pc_rate);
55 return g_get_monotonic_time();
58 DummyAudioBackend::DummyAudioBackend (AudioEngine& e, AudioBackendInfo& info)
59 : AudioBackend (e, info)
61 , _freewheeling (false)
64 , _samples_per_period (1024)
70 , _enable_midi_generators (false)
71 , _systemic_input_latency (0)
72 , _systemic_output_latency (0)
73 , _processed_samples (0)
74 , _port_change_flag (false)
76 _instance_name = s_instance_name;
77 _device = _("Silence");
78 pthread_mutex_init (&_port_callback_mutex, 0);
81 DummyAudioBackend::~DummyAudioBackend ()
83 pthread_mutex_destroy (&_port_callback_mutex);
86 /* AUDIOBACKEND API */
89 DummyAudioBackend::name () const
95 DummyAudioBackend::is_realtime () const
100 std::vector<AudioBackend::DeviceStatus>
101 DummyAudioBackend::enumerate_devices () const
103 if (_device_status.empty()) {
104 _device_status.push_back (DeviceStatus (_("Silence"), true));
105 _device_status.push_back (DeviceStatus (_("Sine Wave"), true));
106 _device_status.push_back (DeviceStatus (_("Square Wave"), true));
107 _device_status.push_back (DeviceStatus (_("Impulses"), true));
108 _device_status.push_back (DeviceStatus (_("Uniform White Noise"), true));
109 _device_status.push_back (DeviceStatus (_("Gaussian White Noise"), true));
110 _device_status.push_back (DeviceStatus (_("Pink Noise"), true));
111 _device_status.push_back (DeviceStatus (_("Pink Noise (low CPU)"), true));
112 _device_status.push_back (DeviceStatus (_("Sine Sweep"), true));
113 _device_status.push_back (DeviceStatus (_("Sine Sweep Swell"), true));
114 _device_status.push_back (DeviceStatus (_("Loopback"), true));
116 return _device_status;
120 DummyAudioBackend::available_sample_rates (const std::string&) const
122 std::vector<float> sr;
123 sr.push_back (8000.0);
124 sr.push_back (22050.0);
125 sr.push_back (24000.0);
126 sr.push_back (44100.0);
127 sr.push_back (48000.0);
128 sr.push_back (88200.0);
129 sr.push_back (96000.0);
130 sr.push_back (176400.0);
131 sr.push_back (192000.0);
135 std::vector<uint32_t>
136 DummyAudioBackend::available_buffer_sizes (const std::string&) const
138 std::vector<uint32_t> bs;
155 DummyAudioBackend::available_input_channel_count (const std::string&) const
161 DummyAudioBackend::available_output_channel_count (const std::string&) const
167 DummyAudioBackend::can_change_sample_rate_when_running () const
173 DummyAudioBackend::can_change_buffer_size_when_running () const
179 DummyAudioBackend::set_device_name (const std::string& d)
186 DummyAudioBackend::set_sample_rate (float sr)
188 if (sr <= 0) { return -1; }
190 engine.sample_rate_change (sr);
195 DummyAudioBackend::set_buffer_size (uint32_t bs)
197 if (bs <= 0 || bs >= _max_buffer_size) {
200 _samples_per_period = bs;
202 /* update port latencies
203 * with 'Loopback' there is exactly once cycle latency,
204 * divide it between In + Out;
206 const size_t l_in = _samples_per_period * .25;
207 const size_t l_out = _samples_per_period - l_in;
209 lr.min = lr.max = l_in + _systemic_input_latency;
210 for (std::vector<DummyAudioPort*>::const_iterator it = _system_inputs.begin (); it != _system_inputs.end (); ++it) {
211 set_latency_range (*it, false, lr);
213 for (std::vector<DummyMidiPort*>::const_iterator it = _system_midi_in.begin (); it != _system_midi_in.end (); ++it) {
214 set_latency_range (*it, false, lr);
217 lr.min = lr.max = l_out + _systemic_output_latency;
218 for (std::vector<DummyAudioPort*>::const_iterator it = _system_outputs.begin (); it != _system_outputs.end (); ++it) {
219 set_latency_range (*it, true, lr);
221 for (std::vector<DummyMidiPort*>::const_iterator it = _system_midi_out.begin (); it != _system_midi_out.end (); ++it) {
222 set_latency_range (*it, true, lr);
225 engine.buffer_size_change (bs);
230 DummyAudioBackend::set_interleaved (bool yn)
232 if (!yn) { return 0; }
237 DummyAudioBackend::set_input_channels (uint32_t cc)
244 DummyAudioBackend::set_output_channels (uint32_t cc)
251 DummyAudioBackend::set_systemic_input_latency (uint32_t sl)
253 _systemic_input_latency = sl;
258 DummyAudioBackend::set_systemic_output_latency (uint32_t sl)
260 _systemic_output_latency = sl;
264 /* Retrieving parameters */
266 DummyAudioBackend::device_name () const
272 DummyAudioBackend::sample_rate () const
278 DummyAudioBackend::buffer_size () const
280 return _samples_per_period;
284 DummyAudioBackend::interleaved () const
290 DummyAudioBackend::input_channels () const
296 DummyAudioBackend::output_channels () const
302 DummyAudioBackend::systemic_input_latency () const
304 return _systemic_input_latency;
308 DummyAudioBackend::systemic_output_latency () const
310 return _systemic_output_latency;
315 std::vector<std::string>
316 DummyAudioBackend::enumerate_midi_options () const
318 if (_midi_options.empty()) {
319 _midi_options.push_back (_("No MIDI I/O"));
320 _midi_options.push_back (_("1 in, 1 out, Silence"));
321 _midi_options.push_back (_("2 in, 2 out, Silence"));
322 _midi_options.push_back (_("8 in, 8 out, Silence"));
323 _midi_options.push_back (_("Midi Event Generators"));
325 return _midi_options;
329 DummyAudioBackend::set_midi_option (const std::string& opt)
331 _enable_midi_generators = false;
332 if (opt == _("1 in, 1 out, Silence")) {
333 _n_midi_inputs = _n_midi_outputs = 1;
335 else if (opt == _("2 in, 2 out, Silence")) {
336 _n_midi_inputs = _n_midi_outputs = 2;
338 else if (opt == _("8 in, 8 out, Silence")) {
339 _n_midi_inputs = _n_midi_outputs = 8;
341 else if (opt == _("Midi Event Generators")) {
342 _n_midi_inputs = _n_midi_outputs = NUM_MIDI_EVENT_GENERATORS;
343 _enable_midi_generators = true;
346 _n_midi_inputs = _n_midi_outputs = 0;
352 DummyAudioBackend::midi_option () const
359 static void * pthread_process (void *arg)
361 DummyAudioBackend *d = static_cast<DummyAudioBackend *>(arg);
362 d->main_process_thread ();
368 DummyAudioBackend::_start (bool /*for_latency_measurement*/)
371 PBD::error << _("DummyAudioBackend: already active.") << endmsg;
376 PBD::warning << _("DummyAudioBackend: recovering from unclean shutdown, port registry is not empty.") << endmsg;
377 for (std::vector<DummyPort*>::const_iterator it = _ports.begin (); it != _ports.end (); ++it) {
378 PBD::info << _("DummyAudioBackend: port '") << (*it)->name () << "' exists." << endmsg;
380 _system_inputs.clear();
381 _system_outputs.clear();
382 _system_midi_in.clear();
383 _system_midi_out.clear();
387 if (register_system_ports()) {
388 PBD::error << _("DummyAudioBackend: failed to register system ports.") << endmsg;
392 engine.sample_rate_change (_samplerate);
393 engine.buffer_size_change (_samples_per_period);
395 if (engine.reestablish_ports ()) {
396 PBD::error << _("DummyAudioBackend: Could not re-establish ports.") << endmsg;
401 engine.reconnect_ports ();
402 _port_change_flag = false;
404 if (pthread_create (&_main_thread, NULL, pthread_process, this)) {
405 PBD::error << _("DummyAudioBackend: cannot start.") << endmsg;
409 while (!_running && --timeout > 0) { Glib::usleep (1000); }
411 if (timeout == 0 || !_running) {
412 PBD::error << _("DummyAudioBackend: failed to start process thread.") << endmsg;
420 DummyAudioBackend::stop ()
428 if (pthread_join (_main_thread, &status)) {
429 PBD::error << _("DummyAudioBackend: failed to terminate.") << endmsg;
437 DummyAudioBackend::freewheel (bool onoff)
439 if (onoff == _freewheeling) {
442 _freewheeling = onoff;
443 engine.freewheel_callback (onoff);
448 DummyAudioBackend::dsp_load () const
450 return 100.f * _dsp_load;
454 DummyAudioBackend::raw_buffer_size (DataType t)
457 case DataType::AUDIO:
458 return _samples_per_period * sizeof(Sample);
460 return _max_buffer_size; // XXX not really limited
467 DummyAudioBackend::sample_time ()
469 return _processed_samples;
473 DummyAudioBackend::sample_time_at_cycle_start ()
475 return _processed_samples;
479 DummyAudioBackend::samples_since_cycle_start ()
486 DummyAudioBackend::dummy_process_thread (void *arg)
488 ThreadData* td = reinterpret_cast<ThreadData*> (arg);
489 boost::function<void ()> f = td->f;
496 DummyAudioBackend::create_process_thread (boost::function<void()> func)
500 size_t stacksize = 100000;
502 pthread_attr_init (&attr);
503 pthread_attr_setstacksize (&attr, stacksize);
504 ThreadData* td = new ThreadData (this, func, stacksize);
506 if (pthread_create (&thread_id, &attr, dummy_process_thread, td)) {
507 PBD::error << _("AudioEngine: cannot create process thread.") << endmsg;
508 pthread_attr_destroy (&attr);
511 pthread_attr_destroy (&attr);
513 _threads.push_back (thread_id);
518 DummyAudioBackend::join_process_threads ()
522 for (std::vector<pthread_t>::const_iterator i = _threads.begin (); i != _threads.end (); ++i)
525 if (pthread_join (*i, &status)) {
526 PBD::error << _("AudioEngine: cannot terminate process thread.") << endmsg;
535 DummyAudioBackend::in_process_thread ()
537 if (pthread_equal (_main_thread, pthread_self()) != 0) {
541 for (std::vector<pthread_t>::const_iterator i = _threads.begin (); i != _threads.end (); ++i)
543 if (pthread_equal (*i, pthread_self ()) != 0) {
551 DummyAudioBackend::process_thread_count ()
553 return _threads.size ();
557 DummyAudioBackend::update_latencies ()
559 // trigger latency callback in RT thread (locked graph)
560 port_connect_add_remove_callback();
566 DummyAudioBackend::private_handle () const
572 DummyAudioBackend::my_name () const
574 return _instance_name;
578 DummyAudioBackend::available () const
584 DummyAudioBackend::port_name_size () const
590 DummyAudioBackend::set_port_name (PortEngine::PortHandle port, const std::string& name)
592 if (!valid_port (port)) {
593 PBD::error << _("DummyBackend::set_port_name: Invalid Port(s)") << endmsg;
596 return static_cast<DummyPort*>(port)->set_name (_instance_name + ":" + name);
600 DummyAudioBackend::get_port_name (PortEngine::PortHandle port) const
602 if (!valid_port (port)) {
603 PBD::error << _("DummyBackend::get_port_name: Invalid Port(s)") << endmsg;
604 return std::string ();
606 return static_cast<DummyPort*>(port)->name ();
609 PortEngine::PortHandle
610 DummyAudioBackend::get_port_by_name (const std::string& name) const
612 PortHandle port = (PortHandle) find_port (name);
617 DummyAudioBackend::get_ports (
618 const std::string& port_name_pattern,
619 DataType type, PortFlags flags,
620 std::vector<std::string>& port_names) const
624 bool use_regexp = false;
625 if (port_name_pattern.size () > 0) {
626 if (!regcomp (&port_regex, port_name_pattern.c_str (), REG_EXTENDED|REG_NOSUB)) {
630 for (size_t i = 0; i < _ports.size (); ++i) {
631 DummyPort* port = _ports[i];
632 if ((port->type () == type) && (port->flags () & flags)) {
633 if (!use_regexp || !regexec (&port_regex, port->name ().c_str (), 0, NULL, 0)) {
634 port_names.push_back (port->name ());
640 regfree (&port_regex);
646 DummyAudioBackend::port_data_type (PortEngine::PortHandle port) const
648 if (!valid_port (port)) {
649 return DataType::NIL;
651 return static_cast<DummyPort*>(port)->type ();
654 PortEngine::PortHandle
655 DummyAudioBackend::register_port (
656 const std::string& name,
657 ARDOUR::DataType type,
658 ARDOUR::PortFlags flags)
660 if (name.size () == 0) { return 0; }
661 if (flags & IsPhysical) { return 0; }
663 PBD::info << _("DummyBackend::register_port: Engine is not running.") << endmsg;
665 return add_port (_instance_name + ":" + name, type, flags);
668 PortEngine::PortHandle
669 DummyAudioBackend::add_port (
670 const std::string& name,
671 ARDOUR::DataType type,
672 ARDOUR::PortFlags flags)
674 assert(name.size ());
675 if (find_port (name)) {
676 PBD::error << _("DummyBackend::register_port: Port already exists:")
677 << " (" << name << ")" << endmsg;
680 DummyPort* port = NULL;
682 case DataType::AUDIO:
683 port = new DummyAudioPort (*this, name, flags);
686 port = new DummyMidiPort (*this, name, flags);
689 PBD::error << _("DummyBackend::register_port: Invalid Data Type.") << endmsg;
693 _ports.push_back (port);
699 DummyAudioBackend::unregister_port (PortEngine::PortHandle port_handle)
702 PBD::info << _("DummyBackend::unregister_port: Engine is not running.") << endmsg;
703 assert (!valid_port (port_handle));
706 DummyPort* port = static_cast<DummyPort*>(port_handle);
707 std::vector<DummyPort*>::iterator i = std::find (_ports.begin (), _ports.end (), static_cast<DummyPort*>(port_handle));
708 if (i == _ports.end ()) {
709 PBD::error << _("DummyBackend::unregister_port: Failed to find port") << endmsg;
712 disconnect_all(port_handle);
718 DummyAudioBackend::register_system_ports()
721 enum DummyAudioPort::GeneratorType gt;
722 if (_device == _("Uniform White Noise")) {
723 gt = DummyAudioPort::UniformWhiteNoise;
724 } else if (_device == _("Gaussian White Noise")) {
725 gt = DummyAudioPort::GaussianWhiteNoise;
726 } else if (_device == _("Pink Noise")) {
727 gt = DummyAudioPort::PinkNoise;
728 } else if (_device == _("Pink Noise (low CPU)")) {
729 gt = DummyAudioPort::PonyNoise;
730 } else if (_device == _("Sine Wave")) {
731 gt = DummyAudioPort::SineWave;
732 } else if (_device == _("Square Wave")) {
733 gt = DummyAudioPort::SquareWave;
734 } else if (_device == _("Impulses")) {
735 gt = DummyAudioPort::KronekerDelta;
736 } else if (_device == _("Sine Sweep")) {
737 gt = DummyAudioPort::SineSweep;
738 } else if (_device == _("Sine Sweep Swell")) {
739 gt = DummyAudioPort::SineSweepSwell;
740 } else if (_device == _("Loopback")) {
741 gt = DummyAudioPort::Loopback;
743 gt = DummyAudioPort::Silence;
746 const int a_ins = _n_inputs > 0 ? _n_inputs : 8;
747 const int a_out = _n_outputs > 0 ? _n_outputs : 8;
748 const int m_ins = _n_midi_inputs;
749 const int m_out = _n_midi_outputs;
751 /* with 'Loopback' there is exactly once cycle latency, divide it between In + Out; */
752 const size_t l_in = _samples_per_period * .25;
753 const size_t l_out = _samples_per_period - l_in;
756 lr.min = lr.max = l_in + _systemic_input_latency;
757 for (int i = 1; i <= a_ins; ++i) {
759 snprintf(tmp, sizeof(tmp), "system:capture_%d", i);
760 PortHandle p = add_port(std::string(tmp), DataType::AUDIO, static_cast<PortFlags>(IsOutput | IsPhysical | IsTerminal));
762 set_latency_range (p, false, lr);
763 _system_inputs.push_back (static_cast<DummyAudioPort*>(p));
764 static_cast<DummyAudioPort*>(p)->setup_generator (gt, _samplerate);
767 lr.min = lr.max = l_out + _systemic_output_latency;
768 for (int i = 1; i <= a_out; ++i) {
770 snprintf(tmp, sizeof(tmp), "system:playback_%d", i);
771 PortHandle p = add_port(std::string(tmp), DataType::AUDIO, static_cast<PortFlags>(IsInput | IsPhysical | IsTerminal));
773 set_latency_range (p, true, lr);
774 _system_outputs.push_back (static_cast<DummyAudioPort*>(p));
778 lr.min = lr.max = l_in + _systemic_input_latency;
779 for (int i = 1; i <= m_ins; ++i) {
781 snprintf(tmp, sizeof(tmp), "system:midi_capture_%d", i);
782 PortHandle p = add_port(std::string(tmp), DataType::MIDI, static_cast<PortFlags>(IsOutput | IsPhysical | IsTerminal));
784 set_latency_range (p, false, lr);
785 _system_midi_in.push_back (static_cast<DummyMidiPort*>(p));
786 if (_enable_midi_generators) {
787 static_cast<DummyMidiPort*>(p)->setup_generator (i % NUM_MIDI_EVENT_GENERATORS, _samplerate);
791 lr.min = lr.max = l_out + _systemic_output_latency;
792 for (int i = 1; i <= m_out; ++i) {
794 snprintf(tmp, sizeof(tmp), "system:midi_playback_%d", i);
795 PortHandle p = add_port(std::string(tmp), DataType::MIDI, static_cast<PortFlags>(IsInput | IsPhysical | IsTerminal));
797 set_latency_range (p, true, lr);
798 _system_midi_out.push_back (static_cast<DummyMidiPort*>(p));
804 DummyAudioBackend::unregister_ports (bool system_only)
807 _system_inputs.clear();
808 _system_outputs.clear();
809 _system_midi_in.clear();
810 _system_midi_out.clear();
811 while (i < _ports.size ()) {
812 DummyPort* port = _ports[i];
813 if (! system_only || (port->is_physical () && port->is_terminal ())) {
814 port->disconnect_all ();
816 _ports.erase (_ports.begin() + i);
824 DummyAudioBackend::connect (const std::string& src, const std::string& dst)
826 DummyPort* src_port = find_port (src);
827 DummyPort* dst_port = find_port (dst);
830 PBD::error << _("DummyBackend::connect: Invalid Source port:")
831 << " (" << src <<")" << endmsg;
835 PBD::error << _("DummyBackend::connect: Invalid Destination port:")
836 << " (" << dst <<")" << endmsg;
839 return src_port->connect (dst_port);
843 DummyAudioBackend::disconnect (const std::string& src, const std::string& dst)
845 DummyPort* src_port = find_port (src);
846 DummyPort* dst_port = find_port (dst);
848 if (!src_port || !dst_port) {
849 PBD::error << _("DummyBackend::disconnect: Invalid Port(s)") << endmsg;
852 return src_port->disconnect (dst_port);
856 DummyAudioBackend::connect (PortEngine::PortHandle src, const std::string& dst)
858 DummyPort* dst_port = find_port (dst);
859 if (!valid_port (src)) {
860 PBD::error << _("DummyBackend::connect: Invalid Source Port Handle") << endmsg;
864 PBD::error << _("DummyBackend::connect: Invalid Destination Port")
865 << " (" << dst << ")" << endmsg;
868 return static_cast<DummyPort*>(src)->connect (dst_port);
872 DummyAudioBackend::disconnect (PortEngine::PortHandle src, const std::string& dst)
874 DummyPort* dst_port = find_port (dst);
875 if (!valid_port (src) || !dst_port) {
876 PBD::error << _("DummyBackend::disconnect: Invalid Port(s)") << endmsg;
879 return static_cast<DummyPort*>(src)->disconnect (dst_port);
883 DummyAudioBackend::disconnect_all (PortEngine::PortHandle port)
885 if (!valid_port (port)) {
886 PBD::error << _("DummyBackend::disconnect_all: Invalid Port") << endmsg;
889 static_cast<DummyPort*>(port)->disconnect_all ();
894 DummyAudioBackend::connected (PortEngine::PortHandle port, bool /* process_callback_safe*/)
896 if (!valid_port (port)) {
897 PBD::error << _("DummyBackend::disconnect_all: Invalid Port") << endmsg;
900 return static_cast<DummyPort*>(port)->is_connected ();
904 DummyAudioBackend::connected_to (PortEngine::PortHandle src, const std::string& dst, bool /*process_callback_safe*/)
906 DummyPort* dst_port = find_port (dst);
907 if (!valid_port (src) || !dst_port) {
908 PBD::error << _("DummyBackend::connected_to: Invalid Port") << endmsg;
911 return static_cast<DummyPort*>(src)->is_connected (dst_port);
915 DummyAudioBackend::physically_connected (PortEngine::PortHandle port, bool /*process_callback_safe*/)
917 if (!valid_port (port)) {
918 PBD::error << _("DummyBackend::physically_connected: Invalid Port") << endmsg;
921 return static_cast<DummyPort*>(port)->is_physically_connected ();
925 DummyAudioBackend::get_connections (PortEngine::PortHandle port, std::vector<std::string>& names, bool /*process_callback_safe*/)
927 if (!valid_port (port)) {
928 PBD::error << _("DummyBackend::get_connections: Invalid Port") << endmsg;
932 assert (0 == names.size ());
934 const std::vector<DummyPort*>& connected_ports = static_cast<DummyPort*>(port)->get_connections ();
936 for (std::vector<DummyPort*>::const_iterator i = connected_ports.begin (); i != connected_ports.end (); ++i) {
937 names.push_back ((*i)->name ());
940 return (int)names.size ();
945 DummyAudioBackend::midi_event_get (
946 pframes_t& timestamp,
947 size_t& size, uint8_t** buf, void* port_buffer,
948 uint32_t event_index)
950 assert (buf && port_buffer);
951 DummyMidiBuffer& source = * static_cast<DummyMidiBuffer*>(port_buffer);
952 if (event_index >= source.size ()) {
955 DummyMidiEvent * const event = source[event_index].get ();
957 timestamp = event->timestamp ();
958 size = event->size ();
959 *buf = event->data ();
964 DummyAudioBackend::midi_event_put (
967 const uint8_t* buffer, size_t size)
969 assert (buffer && port_buffer);
970 DummyMidiBuffer& dst = * static_cast<DummyMidiBuffer*>(port_buffer);
971 if (dst.size () && (pframes_t)dst.back ()->timestamp () > timestamp) {
972 fprintf (stderr, "DummyMidiBuffer: it's too late for this event.\n");
975 dst.push_back (boost::shared_ptr<DummyMidiEvent>(new DummyMidiEvent (timestamp, buffer, size)));
980 DummyAudioBackend::get_midi_event_count (void* port_buffer)
982 assert (port_buffer);
983 return static_cast<DummyMidiBuffer*>(port_buffer)->size ();
987 DummyAudioBackend::midi_clear (void* port_buffer)
989 assert (port_buffer);
990 DummyMidiBuffer * buf = static_cast<DummyMidiBuffer*>(port_buffer);
998 DummyAudioBackend::can_monitor_input () const
1004 DummyAudioBackend::request_input_monitoring (PortEngine::PortHandle, bool)
1010 DummyAudioBackend::ensure_input_monitoring (PortEngine::PortHandle, bool)
1016 DummyAudioBackend::monitoring_input (PortEngine::PortHandle)
1021 /* Latency management */
1024 DummyAudioBackend::set_latency_range (PortEngine::PortHandle port, bool for_playback, LatencyRange latency_range)
1026 if (!valid_port (port)) {
1027 PBD::error << _("DummyPort::set_latency_range (): invalid port.") << endmsg;
1029 static_cast<DummyPort*>(port)->set_latency_range (latency_range, for_playback);
1033 DummyAudioBackend::get_latency_range (PortEngine::PortHandle port, bool for_playback)
1035 if (!valid_port (port)) {
1036 PBD::error << _("DummyPort::get_latency_range (): invalid port.") << endmsg;
1042 return static_cast<DummyPort*>(port)->latency_range (for_playback);
1045 /* Discovering physical ports */
1048 DummyAudioBackend::port_is_physical (PortEngine::PortHandle port) const
1050 if (!valid_port (port)) {
1051 PBD::error << _("DummyPort::port_is_physical (): invalid port.") << endmsg;
1054 return static_cast<DummyPort*>(port)->is_physical ();
1058 DummyAudioBackend::get_physical_outputs (DataType type, std::vector<std::string>& port_names)
1060 for (size_t i = 0; i < _ports.size (); ++i) {
1061 DummyPort* port = _ports[i];
1062 if ((port->type () == type) && port->is_input () && port->is_physical ()) {
1063 port_names.push_back (port->name ());
1069 DummyAudioBackend::get_physical_inputs (DataType type, std::vector<std::string>& port_names)
1071 for (size_t i = 0; i < _ports.size (); ++i) {
1072 DummyPort* port = _ports[i];
1073 if ((port->type () == type) && port->is_output () && port->is_physical ()) {
1074 port_names.push_back (port->name ());
1080 DummyAudioBackend::n_physical_outputs () const
1084 for (size_t i = 0; i < _ports.size (); ++i) {
1085 DummyPort* port = _ports[i];
1086 if (port->is_output () && port->is_physical ()) {
1087 switch (port->type ()) {
1088 case DataType::AUDIO: ++n_audio; break;
1089 case DataType::MIDI: ++n_midi; break;
1095 cc.set (DataType::AUDIO, n_audio);
1096 cc.set (DataType::MIDI, n_midi);
1101 DummyAudioBackend::n_physical_inputs () const
1105 for (size_t i = 0; i < _ports.size (); ++i) {
1106 DummyPort* port = _ports[i];
1107 if (port->is_input () && port->is_physical ()) {
1108 switch (port->type ()) {
1109 case DataType::AUDIO: ++n_audio; break;
1110 case DataType::MIDI: ++n_midi; break;
1116 cc.set (DataType::AUDIO, n_audio);
1117 cc.set (DataType::MIDI, n_midi);
1121 /* Getting access to the data buffer for a port */
1124 DummyAudioBackend::get_buffer (PortEngine::PortHandle port, pframes_t nframes)
1127 assert (valid_port (port));
1128 return static_cast<DummyPort*>(port)->get_buffer (nframes);
1131 /* Engine Process */
1133 DummyAudioBackend::main_process_thread ()
1135 AudioEngine::thread_init_callback (this);
1137 _processed_samples = 0;
1139 manager.registration_callback();
1140 manager.graph_order_callback();
1142 int64_t clock1, clock2;
1143 clock1 = _x_get_monotonic_usec();
1146 // re-set input buffers, generate on demand.
1147 for (std::vector<DummyAudioPort*>::const_iterator it = _system_inputs.begin (); it != _system_inputs.end (); ++it) {
1148 (*it)->next_period();
1150 for (std::vector<DummyMidiPort*>::const_iterator it = _system_midi_in.begin (); it != _system_midi_in.end (); ++it) {
1151 (*it)->next_period();
1154 if (engine.process_callback (_samples_per_period)) {
1157 _processed_samples += _samples_per_period;
1159 if (_device == _("Loopback")) {
1161 int opc = _system_outputs.size();
1162 for (std::vector<DummyAudioPort*>::const_iterator it = _system_inputs.begin (); it != _system_inputs.end (); ++it, ++opn) {
1163 DummyAudioPort* op = _system_outputs[(opn % opc)];
1164 (*it)->fill_wavetable ((const float*)op->get_buffer (_samples_per_period), _samples_per_period);
1169 if (!_freewheeling) {
1170 const int64_t nomial_time = 1e6 * _samples_per_period / _samplerate;
1171 clock2 = _x_get_monotonic_usec();
1172 #ifdef PLATFORM_WINDOWS
1173 bool win_timers_ok = true;
1174 /* querying the performance counter can fail occasionally (-1).
1175 * Also on some multi-core systems, timers are CPU specific and not
1176 * synchronized. We assume they differ more than a few milliseconds
1177 * (4 * nominal cycle time) and simply ignore cases where the
1178 * execution switches cores.
1180 if (clock1 < 0 || clock2 < 0 || (clock1 > clock2) || (clock2 - clock1) > 4 * nomial_time) {
1181 clock2 = clock1 = 0;
1182 win_timers_ok = false;
1185 const int64_t elapsed_time = clock2 - clock1;
1186 #ifdef PLATFORM_WINDOWS
1189 { // low pass filter
1190 _dsp_load = _dsp_load + .05 * ((elapsed_time / (float) nomial_time) - _dsp_load) + 1e-12;
1193 if (elapsed_time < nomial_time) {
1194 Glib::usleep (nomial_time - elapsed_time);
1196 Glib::usleep (100); // don't hog cpu
1200 Glib::usleep (100); // don't hog cpu
1203 /* beginning of netx cycle */
1204 clock1 = _x_get_monotonic_usec();
1206 bool connections_changed = false;
1207 bool ports_changed = false;
1208 if (!pthread_mutex_trylock (&_port_callback_mutex)) {
1209 if (_port_change_flag) {
1210 ports_changed = true;
1211 _port_change_flag = false;
1213 if (!_port_connection_queue.empty ()) {
1214 connections_changed = true;
1216 while (!_port_connection_queue.empty ()) {
1217 PortConnectData *c = _port_connection_queue.back ();
1218 manager.connect_callback (c->a, c->b, c->c);
1219 _port_connection_queue.pop_back ();
1222 pthread_mutex_unlock (&_port_callback_mutex);
1224 if (ports_changed) {
1225 manager.registration_callback();
1227 if (connections_changed) {
1228 manager.graph_order_callback();
1230 if (connections_changed || ports_changed) {
1231 engine.latency_callback(false);
1232 engine.latency_callback(true);
1241 /******************************************************************************/
1243 static boost::shared_ptr<DummyAudioBackend> _instance;
1245 static boost::shared_ptr<AudioBackend> backend_factory (AudioEngine& e);
1246 static int instantiate (const std::string& arg1, const std::string& /* arg2 */);
1247 static int deinstantiate ();
1248 static bool already_configured ();
1249 static bool available ();
1251 static ARDOUR::AudioBackendInfo _descriptor = {
1260 static boost::shared_ptr<AudioBackend>
1261 backend_factory (AudioEngine& e)
1264 _instance.reset (new DummyAudioBackend (e, _descriptor));
1270 instantiate (const std::string& arg1, const std::string& /* arg2 */)
1272 s_instance_name = arg1;
1273 #ifdef PLATFORM_WINDOWS
1274 LARGE_INTEGER Frequency;
1275 if (!QueryPerformanceFrequency(&Frequency) || Frequency.QuadPart < 1) {
1278 _win_pc_rate = 1000000.0 / Frequency.QuadPart;
1292 already_configured ()
1303 extern "C" ARDOURBACKEND_API ARDOUR::AudioBackendInfo* descriptor ()
1305 return &_descriptor;
1309 /******************************************************************************/
1310 DummyPort::DummyPort (DummyAudioBackend &b, const std::string& name, PortFlags flags)
1311 : _dummy_backend (b)
1315 , _gen_cycle (false)
1317 _capture_latency_range.min = 0;
1318 _capture_latency_range.max = 0;
1319 _playback_latency_range.min = 0;
1320 _playback_latency_range.max = 0;
1321 _dummy_backend.port_connect_add_remove_callback();
1324 DummyPort::~DummyPort () {
1326 _dummy_backend.port_connect_add_remove_callback();
1330 int DummyPort::connect (DummyPort *port)
1333 PBD::error << _("DummyPort::connect (): invalid (null) port") << endmsg;
1337 if (type () != port->type ()) {
1338 PBD::error << _("DummyPort::connect (): wrong port-type") << endmsg;
1342 if (is_output () && port->is_output ()) {
1343 PBD::error << _("DummyPort::connect (): cannot inter-connect output ports.") << endmsg;
1347 if (is_input () && port->is_input ()) {
1348 PBD::error << _("DummyPort::connect (): cannot inter-connect input ports.") << endmsg;
1353 PBD::error << _("DummyPort::connect (): cannot self-connect ports.") << endmsg;
1357 if (is_connected (port)) {
1358 #if 0 // don't bother to warn about this for now. just ignore it
1359 PBD::error << _("DummyPort::connect (): ports are already connected:")
1360 << " (" << name () << ") -> (" << port->name () << ")"
1366 _connect (port, true);
1371 void DummyPort::_connect (DummyPort *port, bool callback)
1373 _connections.push_back (port);
1375 port->_connect (this, false);
1376 _dummy_backend.port_connect_callback (name(), port->name(), true);
1380 int DummyPort::disconnect (DummyPort *port)
1383 PBD::error << _("DummyPort::disconnect (): invalid (null) port") << endmsg;
1387 if (!is_connected (port)) {
1388 PBD::error << _("DummyPort::disconnect (): ports are not connected:")
1389 << " (" << name () << ") -> (" << port->name () << ")"
1393 _disconnect (port, true);
1397 void DummyPort::_disconnect (DummyPort *port, bool callback)
1399 std::vector<DummyPort*>::iterator it = std::find (_connections.begin (), _connections.end (), port);
1401 assert (it != _connections.end ());
1403 _connections.erase (it);
1406 port->_disconnect (this, false);
1407 _dummy_backend.port_connect_callback (name(), port->name(), false);
1412 void DummyPort::disconnect_all ()
1414 while (!_connections.empty ()) {
1415 _connections.back ()->_disconnect (this, false);
1416 _dummy_backend.port_connect_callback (name(), _connections.back ()->name(), false);
1417 _connections.pop_back ();
1422 DummyPort::is_connected (const DummyPort *port) const
1424 return std::find (_connections.begin (), _connections.end (), port) != _connections.end ();
1427 bool DummyPort::is_physically_connected () const
1429 for (std::vector<DummyPort*>::const_iterator it = _connections.begin (); it != _connections.end (); ++it) {
1430 if ((*it)->is_physical ()) {
1437 void DummyPort::setup_random_number_generator ()
1439 #ifdef PLATFORM_WINDOWS
1440 LARGE_INTEGER Count;
1441 if (QueryPerformanceCounter (&Count)) {
1442 _rseed = Count.QuadPart % UINT_MAX;
1446 _rseed = g_get_monotonic_time() % UINT_MAX;
1448 _rseed = (_rseed + (uint64_t)this) % UINT_MAX;
1454 // 31bit Park-Miller-Carta Pseudo-Random Number Generator
1455 // http://www.firstpr.com.au/dsp/rand31/
1457 lo = 16807 * (_rseed & 0xffff);
1458 hi = 16807 * (_rseed >> 16);
1460 lo += (hi & 0x7fff) << 16;
1463 lo = (lo & 0x7fffffff) + (lo >> 31);
1465 if (lo > 0x7fffffff) { lo -= 0x7fffffff; }
1467 return (_rseed = lo);
1473 return (randi() / 1073741824.f) - 1.f;
1476 /******************************************************************************/
1478 DummyAudioPort::DummyAudioPort (DummyAudioBackend &b, const std::string& name, PortFlags flags)
1479 : DummyPort (b, name, flags)
1480 , _gen_type (Silence)
1496 memset (_buffer, 0, sizeof (_buffer));
1499 DummyAudioPort::~DummyAudioPort () {
1504 void DummyAudioPort::setup_generator (GeneratorType const g, float const samplerate)
1506 DummyPort::setup_random_number_generator();
1509 switch (_gen_type) {
1512 case UniformWhiteNoise:
1513 case GaussianWhiteNoise:
1517 _gen_period = (5 + randi() % (int)(samplerate / 20.f));
1520 _gen_period = (5 + randi() % (int)(samplerate / 20.f)) & ~1;
1523 _gen_period = 5 + randi() % (int)(samplerate / 20.f);
1524 _wavetable = (Sample*) malloc (_gen_period * sizeof(Sample));
1525 for (uint32_t i = 0 ; i < _gen_period; ++i) {
1526 _wavetable[i] = .12589f * sinf(2.0f * M_PI * (float)i / (float)_gen_period); // -18dBFS
1530 case SineSweepSwell:
1532 _gen_period = 5 * samplerate + randi() % (int)(samplerate * 10.f);
1534 _gen_perio2 = 1 | (int)ceilf (_gen_period * .89f); // Volume Swell period
1535 const double f_min = 20.;
1536 const double f_max = samplerate * .5;
1537 const double g_p2 = _gen_period * .5;
1539 const double b = (f_max - f_min) / (2. * samplerate * g_p2);
1540 const double a = f_min / samplerate;
1542 const double b = log (f_max / f_min) / g_p2;
1543 const double a = f_min / (b * samplerate);
1545 _wavetable = (Sample*) malloc (_gen_period * sizeof(Sample));
1546 for (uint32_t i = 0 ; i < g_p2; ++i) {
1548 const double phase = i * (a + b * i);
1550 const double phase = a * exp (b * i) - a;
1552 _wavetable[i] = (float)sin (2. * M_PI * (phase - floor (phase)));
1554 for (uint32_t i = g_p2; i < _gen_period; ++i) {
1555 const uint32_t j = _gen_period - i;
1557 const double phase = j * (a + b * j);
1559 const double phase = a * exp (b * j) - a;
1561 _wavetable[i] = (float)sin (2. * M_PI * (phase - floor (phase)));
1566 _wavetable = (Sample*) malloc (DummyAudioBackend::max_buffer_size() * sizeof(Sample));
1571 float DummyAudioPort::grandf ()
1573 // Gaussian White Noise
1574 // http://www.musicdsp.org/archive.php?classid=0#109
1585 r = x1 * x1 + x2 * x2;
1586 } while ((r >= 1.0f) || (r < 1e-22f));
1588 r = sqrtf (-2.f * logf (r) / r);
1595 void DummyAudioPort::generate (const pframes_t n_samples)
1597 Glib::Threads::Mutex::Lock lm (generator_lock);
1602 switch (_gen_type) {
1604 memset (_buffer, 0, n_samples * sizeof (Sample));
1607 assert(_gen_period > 0);
1608 for (pframes_t i = 0 ; i < n_samples; ++i) {
1609 if (_gen_offset < _gen_period * .5f) {
1610 _buffer[i] = .40709f; // -6dBFS
1612 _buffer[i] = -.40709f;
1614 _gen_offset = (_gen_offset + 1) % _gen_period;
1618 assert(_gen_period > 0);
1619 memset (_buffer, 0, n_samples * sizeof (Sample));
1620 for (pframes_t i = 0; i < n_samples; ++i) {
1621 if (_gen_offset == 0) {
1624 _gen_offset = (_gen_offset + 1) % _gen_period;
1627 case SineSweepSwell:
1628 assert(_wavetable && _gen_period > 0);
1630 const float vols = 2.f / (float)_gen_perio2;
1631 for (pframes_t i = 0; i < n_samples; ++i) {
1632 const float g = fabsf (_gen_count2 * vols - 1.0);
1633 _buffer[i] = g * _wavetable[_gen_offset];
1634 _gen_offset = (_gen_offset + 1) % _gen_period;
1635 _gen_count2 = (_gen_count2 + 1) % _gen_perio2;
1640 _gen_period = n_samples; // XXX DummyBackend::_samples_per_period;
1643 assert(_wavetable && _gen_period > 0);
1645 pframes_t written = 0;
1646 while (written < n_samples) {
1647 const uint32_t remain = n_samples - written;
1648 const uint32_t to_copy = std::min(remain, _gen_period - _gen_offset);
1649 memcpy((void*)&_buffer[written],
1650 (void*)&_wavetable[_gen_offset],
1651 to_copy * sizeof(Sample));
1653 _gen_offset = (_gen_offset + to_copy) % _gen_period;
1657 case UniformWhiteNoise:
1658 for (pframes_t i = 0 ; i < n_samples; ++i) {
1659 _buffer[i] = .158489f * randf();
1662 case GaussianWhiteNoise:
1663 for (pframes_t i = 0 ; i < n_samples; ++i) {
1664 _buffer[i] = .089125f * grandf();
1668 for (pframes_t i = 0 ; i < n_samples; ++i) {
1669 // Paul Kellet's refined method
1670 // http://www.musicdsp.org/files/pink.txt
1671 // NB. If 'white' consists of uniform random numbers,
1672 // the pink noise will have an almost gaussian distribution.
1673 const float white = .0498f * randf ();
1674 _b0 = .99886f * _b0 + white * .0555179f;
1675 _b1 = .99332f * _b1 + white * .0750759f;
1676 _b2 = .96900f * _b2 + white * .1538520f;
1677 _b3 = .86650f * _b3 + white * .3104856f;
1678 _b4 = .55000f * _b4 + white * .5329522f;
1679 _b5 = -.7616f * _b5 - white * .0168980f;
1680 _buffer[i] = _b0 + _b1 + _b2 + _b3 + _b4 + _b5 + _b6 + white * 0.5362f;
1681 _b6 = white * 0.115926f;
1685 for (pframes_t i = 0 ; i < n_samples; ++i) {
1686 const float white = 0.0498f * randf ();
1687 // Paul Kellet's economy method
1688 // http://www.musicdsp.org/files/pink.txt
1689 _b0 = 0.99765f * _b0 + white * 0.0990460f;
1690 _b1 = 0.96300f * _b1 + white * 0.2965164f;
1691 _b2 = 0.57000f * _b2 + white * 1.0526913f;
1692 _buffer[i] = _b0 + _b1 + _b2 + white * 0.1848f;
1699 void* DummyAudioPort::get_buffer (pframes_t n_samples)
1702 std::vector<DummyPort*>::const_iterator it = get_connections ().begin ();
1703 if (it == get_connections ().end ()) {
1704 memset (_buffer, 0, n_samples * sizeof (Sample));
1706 DummyAudioPort * source = static_cast<DummyAudioPort*>(*it);
1707 assert (source && source->is_output ());
1708 if (source->is_physical() && source->is_terminal()) {
1709 source->get_buffer(n_samples); // generate signal.
1711 memcpy (_buffer, source->const_buffer (), n_samples * sizeof (Sample));
1712 while (++it != get_connections ().end ()) {
1713 source = static_cast<DummyAudioPort*>(*it);
1714 assert (source && source->is_output ());
1715 Sample* dst = buffer ();
1716 if (source->is_physical() && source->is_terminal()) {
1717 source->get_buffer(n_samples); // generate signal.
1719 const Sample* src = source->const_buffer ();
1720 for (uint32_t s = 0; s < n_samples; ++s, ++dst, ++src) {
1725 } else if (is_output () && is_physical () && is_terminal()) {
1727 generate(n_samples);
1734 DummyMidiPort::DummyMidiPort (DummyAudioBackend &b, const std::string& name, PortFlags flags)
1735 : DummyPort (b, name, flags)
1737 , _midi_seq_time (0)
1743 DummyMidiPort::~DummyMidiPort () { }
1745 struct MidiEventSorter {
1746 bool operator() (const boost::shared_ptr<DummyMidiEvent>& a, const boost::shared_ptr<DummyMidiEvent>& b) {
1751 void DummyMidiPort::setup_generator (int seq_id, const float sr)
1753 DummyPort::setup_random_number_generator();
1756 _midi_seq_dat = DummyMidiData::s1;
1759 _midi_seq_dat = DummyMidiData::s2;
1762 _midi_seq_dat = DummyMidiData::s3;
1765 _midi_seq_dat = DummyMidiData::s0;
1768 _midi_seq_spb = sr * .5f; // 120 BPM, beat_time 1.0 per beat.
1773 void DummyMidiPort::midi_generate (const pframes_t n_samples)
1775 Glib::Threads::Mutex::Lock lm (generator_lock);
1783 if (_midi_seq_spb == 0 || !_midi_seq_dat) {
1788 const int32_t ev_beat_time = _midi_seq_dat[_midi_seq_pos].beat_time * _midi_seq_spb - _midi_seq_time;
1789 if (ev_beat_time < 0) {
1792 if ((pframes_t) ev_beat_time >= n_samples) {
1795 _buffer.push_back (boost::shared_ptr<DummyMidiEvent>(new DummyMidiEvent (
1796 ev_beat_time, _midi_seq_dat[_midi_seq_pos].event, 3
1800 if (_midi_seq_dat[_midi_seq_pos].event[0] == 0xff && _midi_seq_dat[_midi_seq_pos].event[1] == 0xff) {
1801 _midi_seq_time -= _midi_seq_dat[_midi_seq_pos].beat_time * _midi_seq_spb;
1805 _midi_seq_time += n_samples;
1809 void* DummyMidiPort::get_buffer (pframes_t n_samples)
1813 for (std::vector<DummyPort*>::const_iterator i = get_connections ().begin ();
1814 i != get_connections ().end ();
1816 DummyMidiPort * source = static_cast<DummyMidiPort*>(*i);
1817 if (source->is_physical() && source->is_terminal()) {
1818 source->get_buffer(n_samples); // generate signal.
1820 const DummyMidiBuffer src = static_cast<const DummyMidiPort*>(*i)->const_buffer ();
1821 for (DummyMidiBuffer::const_iterator it = src.begin (); it != src.end (); ++it) {
1822 _buffer.push_back (boost::shared_ptr<DummyMidiEvent>(new DummyMidiEvent (**it)));
1825 std::sort (_buffer.begin (), _buffer.end (), MidiEventSorter());
1826 } else if (is_output () && is_physical () && is_terminal()) {
1828 midi_generate(n_samples);
1834 DummyMidiEvent::DummyMidiEvent (const pframes_t timestamp, const uint8_t* data, size_t size)
1836 , _timestamp (timestamp)
1840 _data = (uint8_t*) malloc (size);
1841 memcpy (_data, data, size);
1845 DummyMidiEvent::DummyMidiEvent (const DummyMidiEvent& other)
1846 : _size (other.size ())
1847 , _timestamp (other.timestamp ())
1850 if (other.size () && other.const_data ()) {
1851 _data = (uint8_t*) malloc (other.size ());
1852 memcpy (_data, other.const_data (), other.size ());
1856 DummyMidiEvent::~DummyMidiEvent () {