enough with umpteen "i18n.h" files. Consolidate on pbd/i18n.h
[ardour.git] / libs / backends / dummy / dummy_audiobackend.cc
index d1fe378e9f9ce602144b0f45aeeb380754477b3c..6282518d9130506e04613529a27de6044f41dd86 100644 (file)
@@ -17,6 +17,7 @@
  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  */
 
+#include <math.h>
 #include <sys/time.h>
 #include <regex.h>
 #include <stdlib.h>
@@ -33,7 +34,7 @@
 
 #include "pbd/error.h"
 #include "ardour/port_manager.h"
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace ARDOUR;
 
@@ -112,7 +113,10 @@ DummyAudioBackend::enumerate_devices () const
 {
        if (_device_status.empty()) {
                _device_status.push_back (DeviceStatus (_("Silence"), true));
+               _device_status.push_back (DeviceStatus (_("DC -6dBFS (+.5)"), true));
+               _device_status.push_back (DeviceStatus (_("Demolition"), true));
                _device_status.push_back (DeviceStatus (_("Sine Wave"), true));
+               _device_status.push_back (DeviceStatus (_("Sine Wave 1K, 1/3 Oct"), true));
                _device_status.push_back (DeviceStatus (_("Square Wave"), true));
                _device_status.push_back (DeviceStatus (_("Impulses"), true));
                _device_status.push_back (DeviceStatus (_("Uniform White Noise"), true));
@@ -427,16 +431,20 @@ DummyAudioBackend::_start (bool /*for_latency_measurement*/)
                return BackendReinitializationError;
        }
 
-       if (_ports.size()) {
+       if (_ports.size () || _portmap.size ()) {
                PBD::warning << _("DummyAudioBackend: recovering from unclean shutdown, port registry is not empty.") << endmsg;
-               for (std::vector<DummyPort*>::const_iterator it = _ports.begin (); it != _ports.end (); ++it) {
+               for (PortIndex::const_iterator it = _ports.begin (); it != _ports.end (); ++it) {
                        PBD::info << _("DummyAudioBackend: port '") << (*it)->name () << "' exists." << endmsg;
                }
+               for (PortMap::const_iterator it = _portmap.begin (); it != _portmap.end (); ++it) {
+                       PBD::info << _("DummyAudioBackend: portmap '") << (*it).first << "' exists." << endmsg;
+               }
                _system_inputs.clear();
                _system_outputs.clear();
                _system_midi_in.clear();
                _system_midi_out.clear();
                _ports.clear();
+               _portmap.clear();
        }
 
        if (register_system_ports()) {
@@ -642,11 +650,22 @@ DummyAudioBackend::port_name_size () const
 int
 DummyAudioBackend::set_port_name (PortEngine::PortHandle port, const std::string& name)
 {
+       std::string newname (_instance_name + ":" + name);
+
        if (!valid_port (port)) {
                PBD::error << _("DummyBackend::set_port_name: Invalid Port(s)") << endmsg;
                return -1;
        }
-       return static_cast<DummyPort*>(port)->set_name (_instance_name + ":" + name);
+
+       if (find_port (newname)) {
+               PBD::error << _("DummyBackend::set_port_name: Port with given name already exists") << endmsg;
+               return -1;
+       }
+
+       DummyPort* p = static_cast<DummyPort*>(port);
+       _portmap.erase (p->name());
+       _portmap.insert (make_pair (newname, p));
+       return p->set_name (newname);
 }
 
 std::string
@@ -711,8 +730,9 @@ DummyAudioBackend::get_ports (
                        use_regexp = true;
                }
        }
-       for (size_t i = 0; i < _ports.size (); ++i) {
-               DummyPort* port = _ports[i];
+
+       for (PortIndex::const_iterator i = _ports.begin (); i != _ports.end (); ++i) {
+               DummyPort* port = *i;
                if ((port->type () == type) && flags == (port->flags () & flags)) {
                        if (!use_regexp || !regexec (&port_regex, port->name ().c_str (), 0, NULL, 0)) {
                                port_names.push_back (port->name ());
@@ -774,7 +794,8 @@ DummyAudioBackend::add_port (
                        return 0;
        }
 
-       _ports.push_back (port);
+       _ports.insert (port);
+       _portmap.insert (make_pair (name, port));
 
        return port;
 }
@@ -788,12 +809,13 @@ DummyAudioBackend::unregister_port (PortEngine::PortHandle port_handle)
                return;
        }
        DummyPort* port = static_cast<DummyPort*>(port_handle);
-       std::vector<DummyPort*>::iterator i = std::find (_ports.begin (), _ports.end (), static_cast<DummyPort*>(port_handle));
+       PortIndex::iterator i = std::find (_ports.begin(), _ports.end(), static_cast<DummyPort*>(port_handle));
        if (i == _ports.end ()) {
                PBD::error << _("DummyBackend::unregister_port: Failed to find port") << endmsg;
                return;
        }
        disconnect_all(port_handle);
+       _portmap.erase (port->name());
        _ports.erase (i);
        delete port;
 }
@@ -813,6 +835,8 @@ DummyAudioBackend::register_system_ports()
                gt = DummyAudioPort::PonyNoise;
        } else if (_device == _("Sine Wave")) {
                gt = DummyAudioPort::SineWave;
+       } else if (_device == _("Sine Wave 1K, 1/3 Oct")) {
+               gt = DummyAudioPort::SineWaveOctaves;
        } else if (_device == _("Square Wave")) {
                gt = DummyAudioPort::SquareWave;
        } else if (_device == _("Impulses")) {
@@ -827,6 +851,10 @@ DummyAudioBackend::register_system_ports()
                gt = DummyAudioPort::SquareSweepSwell;
        } else if (_device == _("Loopback")) {
                gt = DummyAudioPort::Loopback;
+       } else if (_device == _("Demolition")) {
+               gt = DummyAudioPort::Demolition;
+       } else if (_device == _("DC -6dBFS (+.5)")) {
+               gt = DummyAudioPort::DC05;
        } else {
                gt = DummyAudioPort::Silence;
        }
@@ -850,7 +878,10 @@ DummyAudioBackend::register_system_ports()
                if (!p) return -1;
                set_latency_range (p, false, lr);
                _system_inputs.push_back (static_cast<DummyAudioPort*>(p));
-               static_cast<DummyAudioPort*>(p)->setup_generator (gt, _samplerate);
+               std::string name = static_cast<DummyAudioPort*>(p)->setup_generator (gt, _samplerate, i - 1, a_ins);
+               if (!name.empty ()) {
+                       static_cast<DummyAudioPort*>(p)->set_pretty_name (name);
+               }
        }
 
        lr.min = lr.max = _systemic_output_latency;
@@ -873,8 +904,10 @@ DummyAudioBackend::register_system_ports()
                set_latency_range (p, false, lr);
                _system_midi_in.push_back (static_cast<DummyMidiPort*>(p));
                if (_midi_mode == MidiGenerator) {
-                       static_cast<DummyMidiPort*>(p)->setup_generator (i % NUM_MIDI_EVENT_GENERATORS, _samplerate);
-                       static_cast<DummyMidiPort*>(p)->set_pretty_name (DummyMidiData::sequence_names[i % NUM_MIDI_EVENT_GENERATORS]);
+                       std::string name = static_cast<DummyMidiPort*>(p)->setup_generator (i % NUM_MIDI_EVENT_GENERATORS, _samplerate);
+                       if (!name.empty ()) {
+                               static_cast<DummyMidiPort*>(p)->set_pretty_name (name);
+                       }
                }
        }
 
@@ -909,14 +942,14 @@ DummyAudioBackend::unregister_ports (bool system_only)
        _system_midi_in.clear();
        _system_midi_out.clear();
 
-       for (std::vector<DummyPort*>::iterator i = _ports.begin (); i != _ports.end ();) {
-               DummyPort* port = *i;
+       for (PortIndex::iterator i = _ports.begin (); i != _ports.end ();) {
+               PortIndex::iterator cur = i++;
+               DummyPort* port = *cur;
                if (! system_only || (port->is_physical () && port->is_terminal ())) {
                        port->disconnect_all ();
+                       _portmap.erase (port->name());
                        delete port;
-                       i = _ports.erase (i);
-               } else {
-                       ++i;
+                       _ports.erase (cur);
                }
        }
 }
@@ -1005,10 +1038,12 @@ bool
 DummyAudioBackend::connected_to (PortEngine::PortHandle src, const std::string& dst, bool /*process_callback_safe*/)
 {
        DummyPort* dst_port = find_port (dst);
+#ifndef NDEBUG
        if (!valid_port (src) || !dst_port) {
                PBD::error << _("DummyBackend::connected_to: Invalid Port") << endmsg;
                return false;
        }
+#endif
        return static_cast<DummyPort*>(src)->is_connected (dst_port);
 }
 
@@ -1032,9 +1067,9 @@ DummyAudioBackend::get_connections (PortEngine::PortHandle port, std::vector<std
 
        assert (0 == names.size ());
 
-       const std::vector<DummyPort*>& connected_ports = static_cast<DummyPort*>(port)->get_connections ();
+       const std::set<DummyPort*>& connected_ports = static_cast<DummyPort*>(port)->get_connections ();
 
-       for (std::vector<DummyPort*>::const_iterator i = connected_ports.begin (); i != connected_ports.end (); ++i) {
+       for (std::set<DummyPort*>::const_iterator i = connected_ports.begin (); i != connected_ports.end (); ++i) {
                names.push_back ((*i)->name ());
        }
 
@@ -1183,8 +1218,8 @@ DummyAudioBackend::port_is_physical (PortEngine::PortHandle port) const
 void
 DummyAudioBackend::get_physical_outputs (DataType type, std::vector<std::string>& port_names)
 {
-       for (size_t i = 0; i < _ports.size (); ++i) {
-               DummyPort* port = _ports[i];
+       for (PortIndex::iterator i = _ports.begin (); i != _ports.end (); ++i) {
+               DummyPort* port = *i;
                if ((port->type () == type) && port->is_input () && port->is_physical ()) {
                        port_names.push_back (port->name ());
                }
@@ -1194,8 +1229,8 @@ DummyAudioBackend::get_physical_outputs (DataType type, std::vector<std::string>
 void
 DummyAudioBackend::get_physical_inputs (DataType type, std::vector<std::string>& port_names)
 {
-       for (size_t i = 0; i < _ports.size (); ++i) {
-               DummyPort* port = _ports[i];
+       for (PortIndex::iterator i = _ports.begin (); i != _ports.end (); ++i) {
+               DummyPort* port = *i;
                if ((port->type () == type) && port->is_output () && port->is_physical ()) {
                        port_names.push_back (port->name ());
                }
@@ -1207,8 +1242,8 @@ DummyAudioBackend::n_physical_outputs () const
 {
        int n_midi = 0;
        int n_audio = 0;
-       for (size_t i = 0; i < _ports.size (); ++i) {
-               DummyPort* port = _ports[i];
+       for (PortIndex::const_iterator i = _ports.begin (); i != _ports.end (); ++i) {
+               DummyPort* port = *i;
                if (port->is_output () && port->is_physical ()) {
                        switch (port->type ()) {
                                case DataType::AUDIO: ++n_audio; break;
@@ -1228,8 +1263,8 @@ DummyAudioBackend::n_physical_inputs () const
 {
        int n_midi = 0;
        int n_audio = 0;
-       for (size_t i = 0; i < _ports.size (); ++i) {
-               DummyPort* port = _ports[i];
+       for (PortIndex::const_iterator i = _ports.begin (); i != _ports.end (); ++i) {
+               DummyPort* port = *i;
                if (port->is_input () && port->is_physical ()) {
                        switch (port->type ()) {
                                case DataType::AUDIO: ++n_audio; break;
@@ -1499,7 +1534,7 @@ int DummyPort::connect (DummyPort *port)
 
 void DummyPort::_connect (DummyPort *port, bool callback)
 {
-       _connections.push_back (port);
+       _connections.insert (port);
        if (callback) {
                port->_connect (this, false);
                _dummy_backend.port_connect_callback (name(),  port->name(), true);
@@ -1525,12 +1560,9 @@ int DummyPort::disconnect (DummyPort *port)
 
 void DummyPort::_disconnect (DummyPort *port, bool callback)
 {
-       std::vector<DummyPort*>::iterator it = std::find (_connections.begin (), _connections.end (), port);
-
+       std::set<DummyPort*>::iterator it = _connections.find (port);
        assert (it != _connections.end ());
-
        _connections.erase (it);
-
        if (callback) {
                port->_disconnect (this, false);
                _dummy_backend.port_connect_callback (name(),  port->name(), false);
@@ -1541,21 +1573,22 @@ void DummyPort::_disconnect (DummyPort *port, bool callback)
 void DummyPort::disconnect_all ()
 {
        while (!_connections.empty ()) {
-               _connections.back ()->_disconnect (this, false);
-               _dummy_backend.port_connect_callback (name(),  _connections.back ()->name(), false);
-               _connections.pop_back ();
+               std::set<DummyPort*>::iterator it = _connections.begin ();
+               (*it)->_disconnect (this, false);
+               _dummy_backend.port_connect_callback (name(), (*it)->name(), false);
+               _connections.erase (it);
        }
 }
 
 bool
 DummyPort::is_connected (const DummyPort *port) const
 {
-       return std::find (_connections.begin (), _connections.end (), port) != _connections.end ();
+       return _connections.find (const_cast<DummyPort *>(port)) != _connections.end ();
 }
 
 bool DummyPort::is_physically_connected () const
 {
-       for (std::vector<DummyPort*>::const_iterator it = _connections.begin (); it != _connections.end (); ++it) {
+       for (std::set<DummyPort*>::const_iterator it = _connections.begin (); it != _connections.end (); ++it) {
                if ((*it)->is_physical ()) {
                        return true;
                }
@@ -1631,8 +1664,42 @@ DummyAudioPort::~DummyAudioPort () {
        _wavetable = 0;
 }
 
-void DummyAudioPort::setup_generator (GeneratorType const g, float const samplerate)
+static std::string format_hz (float freq) {
+       std::stringstream ss;
+       if (freq >= 10000) {
+               ss <<  std::setprecision (1) << std::fixed << freq / 1000 << "KHz";
+       } else if (freq >= 1000) {
+               ss <<  std::setprecision (2) << std::fixed << freq / 1000 << "KHz";
+       } else {
+               ss <<  std::setprecision (1) << std::fixed << freq << "Hz";
+       }
+       return ss.str ();
+}
+
+static size_t fit_wave (float freq, float rate, float precision = 0.001) {
+       const size_t max_mult = floor (freq * rate);
+       float minErr = 2;
+       size_t fact = 1;
+       for (size_t i = 1; i < max_mult; ++i) {
+               const float isc = rate * (float)i / freq; // ideal sample count
+               const float rsc = rintf (isc); // rounded sample count
+               const float err = fabsf (isc - rsc);
+               if (err < minErr) {
+                       minErr = err;
+                       fact = i;
+               }
+               if (err < precision) {
+                       break;
+               }
+       }
+       //printf(" FIT %8.1f Hz / %8.1f Hz * %ld = %.0f (err: %e)\n", freq, rate, fact, fact * rate / freq, minErr);
+       return fact;
+}
+
+std::string
+DummyAudioPort::setup_generator (GeneratorType const g, float const samplerate, int c, int total)
 {
+       std::string name;
        DummyPort::setup_random_number_generator();
        _gen_type = g;
 
@@ -1641,16 +1708,37 @@ void DummyAudioPort::setup_generator (GeneratorType const g, float const sampler
                case PonyNoise:
                case UniformWhiteNoise:
                case GaussianWhiteNoise:
+               case DC05:
                case Silence:
                        break;
+               case Demolition:
+                       _gen_period = 3 * samplerate;
+                       break;
                case KronekerDelta:
                        _gen_period = (5 + randi() % (int)(samplerate / 20.f));
+                       name = "Delta " + format_hz (samplerate / _gen_period);
                        break;
                case SquareWave:
                        _gen_period = (5 + randi() % (int)(samplerate / 20.f)) & ~1;
+                       name = "Square " + format_hz (samplerate / _gen_period);
+                       break;
+               case SineWaveOctaves:
+                       {
+                               const int x = c - floor (((float)total / 2));
+                               float f = powf (2.f, x / 3.f) * 1000.f;
+                               f = std::max (10.f, std::min (samplerate *.5f, f));
+                               const size_t mult = fit_wave (f, samplerate);
+                               _gen_period = rintf ((float)mult * samplerate / f);
+                               name = "Sine " + format_hz (samplerate * mult / (float)_gen_period);
+                               _wavetable = (Sample*) malloc (_gen_period * sizeof(Sample));
+                               for (uint32_t i = 0 ; i < _gen_period; ++i) {
+                                       _wavetable[i] = .12589f * sinf(2.0f * M_PI * (float)mult * (float)i / (float)(_gen_period)); // -18dBFS
+                               }
+                       }
                        break;
                case SineWave:
                        _gen_period = 5 + randi() % (int)(samplerate / 20.f);
+                       name = "Sine " + format_hz (samplerate / _gen_period);
                        _wavetable = (Sample*) malloc (_gen_period * sizeof(Sample));
                        for (uint32_t i = 0 ; i < _gen_period; ++i) {
                                _wavetable[i] = .12589f * sinf(2.0f * M_PI * (float)i / (float)_gen_period); // -18dBFS
@@ -1709,6 +1797,7 @@ void DummyAudioPort::setup_generator (GeneratorType const g, float const sampler
                        _wavetable = (Sample*) malloc (DummyAudioBackend::max_buffer_size() * sizeof(Sample));
                        break;
        }
+       return name;
 }
 
 void DummyAudioPort::midi_to_wavetable (DummyMidiBuffer const * const src, size_t n_samples)
@@ -1763,6 +1852,23 @@ float DummyAudioPort::grandf ()
        return r * x1;
 }
 
+/* inspired by jack-demolition by Steve Harris */
+static const float _demolition[] = {
+        0.0f,           /* special case - 0dbFS white noise */
+        0.0f,           /* zero, may cause denomrals following a signal */
+        0.73 / 1e45,    /* very small - should be denormal when floated */
+        3.7f,           /* arbitrary number > 0dBFS */
+       -4.3f,           /* arbitrary negative number > 0dBFS */
+        4294967395.0f,  /* 2^16 + 100 */
+       -4294967395.0f,
+        HUGE,           /* Big, non-inf number */
+        INFINITY,       /* +inf */
+       -INFINITY,       /* -inf */
+       -NAN,            /* -nan */
+        NAN,            /*  nan */
+        0.0f,           /* some silence to check for recovery */
+};
+
 void DummyAudioPort::generate (const pframes_t n_samples)
 {
        Glib::Threads::Mutex::Lock lm (generator_lock);
@@ -1774,6 +1880,30 @@ void DummyAudioPort::generate (const pframes_t n_samples)
                case Silence:
                        memset (_buffer, 0, n_samples * sizeof (Sample));
                        break;
+               case DC05:
+                       for (pframes_t i = 0 ; i < n_samples; ++i) {
+                               _buffer[i] = 0.5f;
+                       }
+                       break;
+               case Demolition:
+                       switch (_gen_count2) {
+                               case 0: // noise
+                                       for (pframes_t i = 0 ; i < n_samples; ++i) {
+                                               _buffer[i] = randf();
+                                       }
+                                       break;
+                               default:
+                                       for (pframes_t i = 0 ; i < n_samples; ++i) {
+                                               _buffer[i] = _demolition [_gen_count2];
+                                       }
+                                       break;
+                       }
+                       _gen_offset += n_samples;
+                       if (_gen_offset > _gen_period) {
+                               _gen_offset = 0;
+                               _gen_count2 = (_gen_count2 + 1) % (sizeof (_demolition) / sizeof (float));
+                       }
+                       break;
                case SquareWave:
                        assert(_gen_period > 0);
                        for (pframes_t i = 0 ; i < n_samples; ++i) {
@@ -1811,6 +1941,7 @@ void DummyAudioPort::generate (const pframes_t n_samples)
                case Loopback:
                        _gen_period = n_samples; // XXX DummyBackend::_samples_per_period;
                case SineWave:
+               case SineWaveOctaves:
                case SineSweep:
                case SquareSweep:
                        assert(_wavetable && _gen_period > 0);
@@ -1872,8 +2003,9 @@ void DummyAudioPort::generate (const pframes_t n_samples)
 void* DummyAudioPort::get_buffer (pframes_t n_samples)
 {
        if (is_input ()) {
-               std::vector<DummyPort*>::const_iterator it = get_connections ().begin ();
-               if (it == get_connections ().end ()) {
+               const std::set<DummyPort *>& connections = get_connections ();
+               std::set<DummyPort*>::const_iterator it = connections.begin ();
+               if (it == connections.end ()) {
                        memset (_buffer, 0, n_samples * sizeof (Sample));
                } else {
                        DummyAudioPort * source = static_cast<DummyAudioPort*>(*it);
@@ -1882,7 +2014,7 @@ void* DummyAudioPort::get_buffer (pframes_t n_samples)
                                source->get_buffer(n_samples); // generate signal.
                        }
                        memcpy (_buffer, source->const_buffer (), n_samples * sizeof (Sample));
-                       while (++it != get_connections ().end ()) {
+                       while (++it != connections.end ()) {
                                source = static_cast<DummyAudioPort*>(*it);
                                assert (source && source->is_output ());
                                Sample* dst = buffer ();
@@ -1933,13 +2065,15 @@ void DummyMidiPort::set_loopback (DummyMidiBuffer const * const src)
        }
 }
 
-void DummyMidiPort::setup_generator (int seq_id, const float sr)
+std::string
+DummyMidiPort::setup_generator (int seq_id, const float sr)
 {
        DummyPort::setup_random_number_generator();
        _midi_seq_dat = DummyMidiData::sequences[seq_id % NUM_MIDI_EVENT_GENERATORS];
        _midi_seq_spb = sr * .5f; // 120 BPM, beat_time 1.0 per beat.
        _midi_seq_pos = 0;
        _midi_seq_time = 0;
+       return DummyMidiData::sequence_names[seq_id];
 }
 
 void DummyMidiPort::midi_generate (const pframes_t n_samples)
@@ -1987,8 +2121,9 @@ void* DummyMidiPort::get_buffer (pframes_t n_samples)
 {
        if (is_input ()) {
                _buffer.clear ();
-               for (std::vector<DummyPort*>::const_iterator i = get_connections ().begin ();
-                               i != get_connections ().end ();
+               const std::set<DummyPort*>& connections = get_connections ();
+               for (std::set<DummyPort*>::const_iterator i = connections.begin ();
+                               i != connections.end ();
                                ++i) {
                        DummyMidiPort * source = static_cast<DummyMidiPort*>(*i);
                        if (source->is_physical() && source->is_terminal()) {