libs/backends/dummy/dummy_audiobackend.h

   1 /*
   2  * Copyright (C) 2014 Robin Gareus <robin@gareus.org>
   3  * Copyright (C) 2013 Paul Davis
   4  *
   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.
   9  *
  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.
  14  *
  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.
  18  */
  19
  20 #ifndef __libbackend_dummy_audiobackend_h__
  21 #define __libbackend_dummy_audiobackend_h__
  22
  23 #include <string>
  24 #include <vector>
  25 #include <map>
  26 #include <set>
  27
  28 #include <stdint.h>
  29 #include <pthread.h>
  30
  31 #include <boost/shared_ptr.hpp>
  32
  33 #include "ardour/types.h"
  34 #include "ardour/audio_backend.h"
  35
  36 namespace ARDOUR {
  37
  38 class DummyAudioBackend;
  39
  40 namespace DummyMidiData {
  41         typedef struct _MIDISequence {
  42                 float   beat_time;
  43                 uint8_t event[3];
  44         } MIDISequence;
  45 };
  46
  47 class DummyMidiEvent {
  48         public:
  49                 DummyMidiEvent (const pframes_t timestamp, const uint8_t* data, size_t size);
  50                 DummyMidiEvent (const DummyMidiEvent& other);
  51                 ~DummyMidiEvent ();
  52                 size_t size () const { return _size; };
  53                 pframes_t timestamp () const { return _timestamp; };
  54                 const unsigned char* const_data () const { return _data; };
  55                 unsigned char* data () { return _data; };
  56                 bool operator< (const DummyMidiEvent &other) const { return timestamp () < other.timestamp (); };
  57         private:
  58                 size_t _size;
  59                 pframes_t _timestamp;
  60                 uint8_t *_data;
  61 };
  62
  63 typedef std::vector<boost::shared_ptr<DummyMidiEvent> > DummyMidiBuffer;
  64
  65 class DummyPort {
  66         protected:
  67                 DummyPort (DummyAudioBackend &b, const std::string&, PortFlags);
  68         public:
  69                 virtual ~DummyPort ();
  70
  71                 const std::string& name () const { return _name; }
  72                 PortFlags flags () const { return _flags; }
  73
  74                 int set_name (const std::string &name) { _name = name; return 0; }
  75
  76                 virtual DataType type () const = 0;
  77
  78                 bool is_input ()     const { return flags () & IsInput; }
  79                 bool is_output ()    const { return flags () & IsOutput; }
  80                 bool is_physical ()  const { return flags () & IsPhysical; }
  81                 bool is_terminal ()  const { return flags () & IsTerminal; }
  82                 bool is_connected () const { return _connections.size () != 0; }
  83                 bool is_connected (const DummyPort *port) const;
  84                 bool is_physically_connected () const;
  85
  86                 const std::vector<DummyPort *>& get_connections () const { return _connections; }
  87
  88                 int connect (DummyPort *port);
  89                 int disconnect (DummyPort *port);
  90                 void disconnect_all ();
  91
  92                 virtual void* get_buffer (pframes_t nframes) = 0;
  93                 void next_period () { _gen_cycle = false; }
  94
  95                 const LatencyRange& latency_range (bool for_playback) const
  96                 {
  97                         return for_playback ? _playback_latency_range : _capture_latency_range;
  98                 }
  99
 100                 void set_latency_range (const LatencyRange &latency_range, bool for_playback)
 101                 {
 102                         if (for_playback)
 103                         {
 104                                 _playback_latency_range = latency_range;
 105                         }
 106                         else
 107                         {
 108                                 _capture_latency_range = latency_range;
 109                         }
 110                 }
 111
 112         private:
 113                 DummyAudioBackend &_dummy_backend;
 114                 std::string _name;
 115                 const PortFlags _flags;
 116                 LatencyRange _capture_latency_range;
 117                 LatencyRange _playback_latency_range;
 118                 std::vector<DummyPort*> _connections;
 119
 120                 void _connect (DummyPort* , bool);
 121                 void _disconnect (DummyPort* , bool);
 122
 123         protected:
 124                 // random number generator
 125                 void setup_random_number_generator ();
 126                 inline float    randf ();
 127                 inline uint32_t randi ();
 128                 uint32_t _rseed;
 129
 130                 // signal generator
 131                 volatile bool _gen_cycle;
 132                 Glib::Threads::Mutex generator_lock;
 133
 134 }; // class DummyPort
 135
 136 class DummyAudioPort : public DummyPort {
 137         public:
 138                 DummyAudioPort (DummyAudioBackend &b, const std::string&, PortFlags);
 139                 ~DummyAudioPort ();
 140
 141                 DataType type () const { return DataType::AUDIO; };
 142
 143                 Sample* buffer () { return _buffer; }
 144                 const Sample* const_buffer () const { return _buffer; }
 145                 void* get_buffer (pframes_t nframes);
 146
 147                 enum GeneratorType {
 148                         Silence,
 149                         UniformWhiteNoise,
 150                         GaussianWhiteNoise,
 151                         PinkNoise,
 152                         PonyNoise,
 153                         SineWave,
 154                         SquareWave,
 155                         KronekerDelta,
 156                         SineSweep,
 157                         SineSweepSwell,
 158                 };
 159                 void setup_generator (GeneratorType const, float const);
 160
 161         private:
 162                 Sample _buffer[8192];
 163
 164                 // signal generator ('fake' physical inputs)
 165                 void generate (const pframes_t n_samples);
 166                 GeneratorType _gen_type;
 167
 168                 // generator buffers
 169                 // pink-noise filters
 170                 float _b0, _b1, _b2, _b3, _b4, _b5, _b6;
 171                 // generated sinf() samples
 172                 Sample * _wavetable;
 173                 uint32_t _gen_period;
 174                 uint32_t _gen_offset;
 175                 uint32_t _gen_perio2;
 176                 uint32_t _gen_count2;
 177
 178                 // gaussian noise generator
 179                 float grandf ();
 180                 bool _pass;
 181                 float _rn1;
 182
 183 }; // class DummyAudioPort
 184
 185 class DummyMidiPort : public DummyPort {
 186         public:
 187                 DummyMidiPort (DummyAudioBackend &b, const std::string&, PortFlags);
 188                 ~DummyMidiPort ();
 189
 190                 DataType type () const { return DataType::MIDI; };
 191
 192                 void* get_buffer (pframes_t nframes);
 193                 const DummyMidiBuffer const_buffer () const { return _buffer; }
 194
 195                 void setup_generator (int, float const);
 196
 197         private:
 198                 DummyMidiBuffer _buffer;
 199
 200                 // midi event generator ('fake' physical inputs)
 201                 void midi_generate (const pframes_t n_samples);
 202                 float   _midi_seq_spb; // samples per beat
 203                 int32_t _midi_seq_time;
 204                 uint32_t _midi_seq_pos;
 205                 DummyMidiData::MIDISequence const * _midi_seq_dat;
 206 }; // class DummyMidiPort
 207
 208 class DummyAudioBackend : public AudioBackend {
 209         friend class DummyPort;
 210         public:
 211                  DummyAudioBackend (AudioEngine& e, AudioBackendInfo& info);
 212                 ~DummyAudioBackend ();
 213
 214                 /* AUDIOBACKEND API */
 215
 216                 std::string name () const;
 217                 bool is_realtime () const;
 218
 219                 std::vector<DeviceStatus> enumerate_devices () const;
 220                 std::vector<float> available_sample_rates (const std::string& device) const;
 221                 std::vector<uint32_t> available_buffer_sizes (const std::string& device) const;
 222                 uint32_t available_input_channel_count (const std::string& device) const;
 223                 uint32_t available_output_channel_count (const std::string& device) const;
 224
 225                 bool can_change_sample_rate_when_running () const;
 226                 bool can_change_buffer_size_when_running () const;
 227
 228                 int set_device_name (const std::string&);
 229                 int set_sample_rate (float);
 230                 int set_buffer_size (uint32_t);
 231                 int set_interleaved (bool yn);
 232                 int set_input_channels (uint32_t);
 233                 int set_output_channels (uint32_t);
 234                 int set_systemic_input_latency (uint32_t);
 235                 int set_systemic_output_latency (uint32_t);
 236                 int set_systemic_midi_input_latency (std::string const, uint32_t) { return 0; }
 237                 int set_systemic_midi_output_latency (std::string const, uint32_t) { return 0; }
 238
 239                 /* Retrieving parameters */
 240                 std::string  device_name () const;
 241                 float        sample_rate () const;
 242                 uint32_t     buffer_size () const;
 243                 bool         interleaved () const;
 244                 uint32_t     input_channels () const;
 245                 uint32_t     output_channels () const;
 246                 uint32_t     systemic_input_latency () const;
 247                 uint32_t     systemic_output_latency () const;
 248                 uint32_t     systemic_midi_input_latency (std::string const) const { return 0; }
 249                 uint32_t     systemic_midi_output_latency (std::string const) const { return 0; }
 250
 251                 /* External control app */
 252                 std::string control_app_name () const { return std::string (); }
 253                 void launch_control_app () {}
 254
 255                 /* MIDI */
 256                 std::vector<std::string> enumerate_midi_options () const;
 257                 int set_midi_option (const std::string&);
 258                 std::string midi_option () const;
 259
 260                 std::vector<DeviceStatus> enumerate_midi_devices () const {
 261                         return std::vector<AudioBackend::DeviceStatus> ();
 262                 }
 263                 int set_midi_device_enabled (std::string const, bool) {
 264                         return 0;
 265                 }
 266                 bool midi_device_enabled (std::string const) const {
 267                         return true;
 268                 }
 269                 bool can_set_systemic_midi_latencies () const {
 270                         return false;
 271                 }
 272
 273                 /* State Control */
 274         protected:
 275                 int _start (bool for_latency_measurement);
 276         public:
 277                 int stop ();
 278                 int freewheel (bool);
 279                 float dsp_load () const;
 280                 size_t raw_buffer_size (DataType t);
 281
 282                 /* Process time */
 283                 pframes_t sample_time ();
 284                 pframes_t sample_time_at_cycle_start ();
 285                 pframes_t samples_since_cycle_start ();
 286
 287                 int create_process_thread (boost::function<void()> func);
 288                 int join_process_threads ();
 289                 bool in_process_thread ();
 290                 uint32_t process_thread_count ();
 291
 292                 void update_latencies ();
 293
 294                 /* PORTENGINE API */
 295
 296                 void* private_handle () const;
 297                 const std::string& my_name () const;
 298                 bool available () const;
 299                 uint32_t port_name_size () const;
 300
 301                 int         set_port_name (PortHandle, const std::string&);
 302                 std::string get_port_name (PortHandle) const;
 303                 PortHandle  get_port_by_name (const std::string&) const;
 304
 305                 int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&) const;
 306
 307                 DataType port_data_type (PortHandle) const;
 308
 309                 PortHandle register_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
 310                 void unregister_port (PortHandle);
 311
 312                 int  connect (const std::string& src, const std::string& dst);
 313                 int  disconnect (const std::string& src, const std::string& dst);
 314                 int  connect (PortHandle, const std::string&);
 315                 int  disconnect (PortHandle, const std::string&);
 316                 int  disconnect_all (PortHandle);
 317
 318                 bool connected (PortHandle, bool process_callback_safe);
 319                 bool connected_to (PortHandle, const std::string&, bool process_callback_safe);
 320                 bool physically_connected (PortHandle, bool process_callback_safe);
 321                 int  get_connections (PortHandle, std::vector<std::string>&, bool process_callback_safe);
 322
 323                 /* MIDI */
 324                 int midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index);
 325                 int midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
 326                 uint32_t get_midi_event_count (void* port_buffer);
 327                 void     midi_clear (void* port_buffer);
 328
 329                 /* Monitoring */
 330
 331                 bool can_monitor_input () const;
 332                 int  request_input_monitoring (PortHandle, bool);
 333                 int  ensure_input_monitoring (PortHandle, bool);
 334                 bool monitoring_input (PortHandle);
 335
 336                 /* Latency management */
 337
 338                 void         set_latency_range (PortHandle, bool for_playback, LatencyRange);
 339                 LatencyRange get_latency_range (PortHandle, bool for_playback);
 340
 341                 /* Discovering physical ports */
 342
 343                 bool      port_is_physical (PortHandle) const;
 344                 void      get_physical_outputs (DataType type, std::vector<std::string>&);
 345                 void      get_physical_inputs (DataType type, std::vector<std::string>&);
 346                 ChanCount n_physical_outputs () const;
 347                 ChanCount n_physical_inputs () const;
 348
 349                 /* Getting access to the data buffer for a port */
 350
 351                 void* get_buffer (PortHandle, pframes_t);
 352
 353                 void* main_process_thread ();
 354
 355         private:
 356                 std::string _instance_name;
 357                 static std::vector<std::string> _midi_options;
 358                 static std::vector<AudioBackend::DeviceStatus> _device_status;
 359
 360                 bool  _running;
 361                 bool  _freewheeling;
 362
 363                 std::string _device;
 364
 365                 float  _samplerate;
 366                 size_t _samples_per_period;
 367                 float  _dsp_load;
 368                 static size_t _max_buffer_size;
 369
 370                 uint32_t _n_inputs;
 371                 uint32_t _n_outputs;
 372
 373                 uint32_t _n_midi_inputs;
 374                 uint32_t _n_midi_outputs;
 375                 bool     _enable_midi_generators;
 376
 377                 uint32_t _systemic_input_latency;
 378                 uint32_t _systemic_output_latency;
 379
 380                 uint64_t _processed_samples;
 381
 382                 pthread_t _main_thread;
 383
 384                 /* process threads */
 385                 static void* dummy_process_thread (void *);
 386                 std::vector<pthread_t> _threads;
 387
 388                 struct ThreadData {
 389                         DummyAudioBackend* engine;
 390                         boost::function<void ()> f;
 391                         size_t stacksize;
 392
 393                         ThreadData (DummyAudioBackend* e, boost::function<void ()> fp, size_t stacksz)
 394                                 : engine (e) , f (fp) , stacksize (stacksz) {}
 395                 };
 396
 397                 /* port engine */
 398                 PortHandle add_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
 399                 int register_system_ports ();
 400                 void unregister_ports (bool system_only = false);
 401
 402                 std::vector<DummyAudioPort *> _system_inputs;
 403                 std::vector<DummyMidiPort *> _system_midi_in;
 404                 std::vector<DummyPort *> _ports;
 405
 406                 struct PortConnectData {
 407                         std::string a;
 408                         std::string b;
 409                         bool c;
 410
 411                         PortConnectData (const std::string& a, const std::string& b, bool c)
 412                                 : a (a) , b (b) , c (c) {}
 413                 };
 414
 415                 std::vector<PortConnectData *> _port_connection_queue;
 416                 pthread_mutex_t _port_callback_mutex;
 417                 bool _port_change_flag;
 418
 419                 void port_connect_callback (const std::string& a, const std::string& b, bool conn) {
 420                         pthread_mutex_lock (&_port_callback_mutex);
 421                         _port_connection_queue.push_back(new PortConnectData(a, b, conn));
 422                         pthread_mutex_unlock (&_port_callback_mutex);
 423                 }
 424
 425                 void port_connect_add_remove_callback () {
 426                         pthread_mutex_lock (&_port_callback_mutex);
 427                         _port_change_flag = true;
 428                         pthread_mutex_unlock (&_port_callback_mutex);
 429                 }
 430
 431                 bool valid_port (PortHandle port) const {
 432                         return std::find (_ports.begin (), _ports.end (), (DummyPort*)port) != _ports.end ();
 433                 }
 434
 435                 DummyPort * find_port (const std::string& port_name) const {
 436                         for (std::vector<DummyPort*>::const_iterator it = _ports.begin (); it != _ports.end (); ++it) {
 437                                 if ((*it)->name () == port_name) {
 438                                         return *it;
 439                                 }
 440                         }
 441                         return NULL;
 442                 }
 443
 444 }; // class DummyAudioBackend
 445
 446 } // namespace
 447
 448 #endif /* __libbackend_dummy_audiobackend_h__ */