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 class DummyMidiEvent {
  41         public:
  42                 DummyMidiEvent (const pframes_t timestamp, const uint8_t* data, size_t size);
  43                 DummyMidiEvent (const DummyMidiEvent& other);
  44                 ~DummyMidiEvent ();
  45                 size_t size () const { return _size; };
  46                 pframes_t timestamp () const { return _timestamp; };
  47                 const unsigned char* const_data () const { return _data; };
  48                 unsigned char* data () { return _data; };
  49                 bool operator< (const DummyMidiEvent &other) const { return timestamp () < other.timestamp (); };
  50         private:
  51                 size_t _size;
  52                 pframes_t _timestamp;
  53                 uint8_t *_data;
  54 };
  55
  56 typedef std::vector<boost::shared_ptr<DummyMidiEvent> > DummyMidiBuffer;
  57
  58 class DummyPort {
  59         protected:
  60                 DummyPort (DummyAudioBackend &b, const std::string&, PortFlags);
  61         public:
  62                 virtual ~DummyPort ();
  63
  64                 const std::string& name () const { return _name; }
  65                 PortFlags flags () const { return _flags; }
  66
  67                 int set_name (const std::string &name) { _name = name; return 0; }
  68
  69                 virtual DataType type () const = 0;
  70
  71                 bool is_input ()     const { return flags () & IsInput; }
  72                 bool is_output ()    const { return flags () & IsOutput; }
  73                 bool is_physical ()  const { return flags () & IsPhysical; }
  74                 bool is_terminal ()  const { return flags () & IsTerminal; }
  75                 bool is_connected () const { return _connections.size () != 0; }
  76                 bool is_connected (const DummyPort *port) const;
  77                 bool is_physically_connected () const;
  78
  79                 const std::vector<DummyPort *>& get_connections () const { return _connections; }
  80
  81                 int connect (DummyPort *port);
  82                 int disconnect (DummyPort *port);
  83                 void disconnect_all ();
  84
  85                 virtual void* get_buffer (pframes_t nframes) = 0;
  86
  87                 const LatencyRange& latency_range (bool for_playback) const
  88                 {
  89                         return for_playback ? _playback_latency_range : _capture_latency_range;
  90                 }
  91
  92                 void set_latency_range (const LatencyRange &latency_range, bool for_playback)
  93                 {
  94                         if (for_playback)
  95                         {
  96                                 _playback_latency_range = latency_range;
  97                         }
  98                         else
  99                         {
 100                                 _capture_latency_range = latency_range;
 101                         }
 102                 }
 103
 104         private:
 105                 DummyAudioBackend &_dummy_backend;
 106                 std::string _name;
 107                 const PortFlags _flags;
 108                 LatencyRange _capture_latency_range;
 109                 LatencyRange _playback_latency_range;
 110                 std::vector<DummyPort*> _connections;
 111
 112                 void _connect (DummyPort* , bool);
 113                 void _disconnect (DummyPort* , bool);
 114
 115 }; // class DummyPort
 116
 117 class DummyAudioPort : public DummyPort {
 118         public:
 119                 DummyAudioPort (DummyAudioBackend &b, const std::string&, PortFlags);
 120                 ~DummyAudioPort ();
 121
 122                 DataType type () const { return DataType::AUDIO; };
 123
 124                 Sample* buffer () { return _buffer; }
 125                 const Sample* const_buffer () const { return _buffer; }
 126                 void* get_buffer (pframes_t nframes);
 127
 128         private:
 129                 Sample _buffer[8192];
 130 }; // class DummyAudioPort
 131
 132 class DummyMidiPort : public DummyPort {
 133         public:
 134                 DummyMidiPort (DummyAudioBackend &b, const std::string&, PortFlags);
 135                 ~DummyMidiPort ();
 136
 137                 DataType type () const { return DataType::MIDI; };
 138
 139                 void* get_buffer (pframes_t nframes);
 140                 const DummyMidiBuffer const_buffer () const { return _buffer; }
 141
 142         private:
 143                 DummyMidiBuffer _buffer;
 144 }; // class DummyMidiPort
 145
 146 class DummyAudioBackend : public AudioBackend {
 147         friend class DummyPort;
 148         public:
 149                  DummyAudioBackend (AudioEngine& e, AudioBackendInfo& info);
 150                 ~DummyAudioBackend ();
 151
 152                 /* AUDIOBACKEND API */
 153
 154                 std::string name () const;
 155                 bool is_realtime () const;
 156
 157                 std::vector<DeviceStatus> enumerate_devices () const;
 158                 std::vector<float> available_sample_rates (const std::string& device) const;
 159                 std::vector<uint32_t> available_buffer_sizes (const std::string& device) const;
 160                 uint32_t available_input_channel_count (const std::string& device) const;
 161                 uint32_t available_output_channel_count (const std::string& device) const;
 162
 163                 bool can_change_sample_rate_when_running () const;
 164                 bool can_change_buffer_size_when_running () const;
 165
 166                 int set_device_name (const std::string&);
 167                 int set_sample_rate (float);
 168                 int set_buffer_size (uint32_t);
 169                 int set_interleaved (bool yn);
 170                 int set_input_channels (uint32_t);
 171                 int set_output_channels (uint32_t);
 172                 int set_systemic_input_latency (uint32_t);
 173                 int set_systemic_output_latency (uint32_t);
 174                 int set_systemic_midi_input_latency (std::string const, uint32_t) { return 0; }
 175                 int set_systemic_midi_output_latency (std::string const, uint32_t) { return 0; }
 176
 177                 /* Retrieving parameters */
 178                 std::string  device_name () const;
 179                 float        sample_rate () const;
 180                 uint32_t     buffer_size () const;
 181                 bool         interleaved () const;
 182                 uint32_t     input_channels () const;
 183                 uint32_t     output_channels () const;
 184                 uint32_t     systemic_input_latency () const;
 185                 uint32_t     systemic_output_latency () const;
 186                 uint32_t     systemic_midi_input_latency (std::string const) const { return 0; }
 187                 uint32_t     systemic_midi_output_latency (std::string const) const { return 0; }
 188
 189                 /* External control app */
 190                 std::string control_app_name () const { return std::string (); }
 191                 void launch_control_app () {}
 192
 193                 /* MIDI */
 194                 std::vector<std::string> enumerate_midi_options () const;
 195                 int set_midi_option (const std::string&);
 196                 std::string midi_option () const;
 197
 198                 std::vector<DeviceStatus> enumerate_midi_devices () const {
 199                         return std::vector<AudioBackend::DeviceStatus> ();
 200                 }
 201                 int set_midi_device_enabled (std::string const, bool) {
 202                         return 0;
 203                 }
 204                 bool midi_device_enabled (std::string const) const {
 205                         return true;
 206                 }
 207                 bool can_set_systemic_midi_latencies () const {
 208                         return false;
 209                 }
 210
 211                 /* State Control */
 212         protected:
 213                 int _start (bool for_latency_measurement);
 214         public:
 215                 int stop ();
 216                 int freewheel (bool);
 217                 float dsp_load () const;
 218                 size_t raw_buffer_size (DataType t);
 219
 220                 /* Process time */
 221                 pframes_t sample_time ();
 222                 pframes_t sample_time_at_cycle_start ();
 223                 pframes_t samples_since_cycle_start ();
 224
 225                 int create_process_thread (boost::function<void()> func);
 226                 int join_process_threads ();
 227                 bool in_process_thread ();
 228                 uint32_t process_thread_count ();
 229
 230                 void update_latencies ();
 231
 232                 /* PORTENGINE API */
 233
 234                 void* private_handle () const;
 235                 const std::string& my_name () const;
 236                 bool available () const;
 237                 uint32_t port_name_size () const;
 238
 239                 int         set_port_name (PortHandle, const std::string&);
 240                 std::string get_port_name (PortHandle) const;
 241                 PortHandle  get_port_by_name (const std::string&) const;
 242
 243                 int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&) const;
 244
 245                 DataType port_data_type (PortHandle) const;
 246
 247                 PortHandle register_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
 248                 void unregister_port (PortHandle);
 249
 250                 int  connect (const std::string& src, const std::string& dst);
 251                 int  disconnect (const std::string& src, const std::string& dst);
 252                 int  connect (PortHandle, const std::string&);
 253                 int  disconnect (PortHandle, const std::string&);
 254                 int  disconnect_all (PortHandle);
 255
 256                 bool connected (PortHandle, bool process_callback_safe);
 257                 bool connected_to (PortHandle, const std::string&, bool process_callback_safe);
 258                 bool physically_connected (PortHandle, bool process_callback_safe);
 259                 int  get_connections (PortHandle, std::vector<std::string>&, bool process_callback_safe);
 260
 261                 /* MIDI */
 262                 int midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index);
 263                 int midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
 264                 uint32_t get_midi_event_count (void* port_buffer);
 265                 void     midi_clear (void* port_buffer);
 266
 267                 /* Monitoring */
 268
 269                 bool can_monitor_input () const;
 270                 int  request_input_monitoring (PortHandle, bool);
 271                 int  ensure_input_monitoring (PortHandle, bool);
 272                 bool monitoring_input (PortHandle);
 273
 274                 /* Latency management */
 275
 276                 void         set_latency_range (PortHandle, bool for_playback, LatencyRange);
 277                 LatencyRange get_latency_range (PortHandle, bool for_playback);
 278
 279                 /* Discovering physical ports */
 280
 281                 bool      port_is_physical (PortHandle) const;
 282                 void      get_physical_outputs (DataType type, std::vector<std::string>&);
 283                 void      get_physical_inputs (DataType type, std::vector<std::string>&);
 284                 ChanCount n_physical_outputs () const;
 285                 ChanCount n_physical_inputs () const;
 286
 287                 /* Getting access to the data buffer for a port */
 288
 289                 void* get_buffer (PortHandle, pframes_t);
 290
 291                 void* main_process_thread ();
 292
 293         private:
 294                 std::string _instance_name;
 295                 static std::vector<std::string> _midi_options;
 296                 static std::vector<AudioBackend::DeviceStatus> _device_status;
 297
 298                 bool  _running;
 299                 bool  _freewheeling;
 300
 301                 float  _samplerate;
 302                 size_t _samples_per_period;
 303                 float  _dsp_load;
 304                 static size_t _max_buffer_size;
 305
 306                 uint32_t _n_inputs;
 307                 uint32_t _n_outputs;
 308
 309                 uint32_t _n_midi_inputs;
 310                 uint32_t _n_midi_outputs;
 311
 312                 uint32_t _systemic_input_latency;
 313                 uint32_t _systemic_output_latency;
 314
 315                 uint64_t _processed_samples;
 316
 317                 pthread_t _main_thread;
 318
 319                 /* process threads */
 320                 static void* dummy_process_thread (void *);
 321                 std::vector<pthread_t> _threads;
 322
 323                 struct ThreadData {
 324                         DummyAudioBackend* engine;
 325                         boost::function<void ()> f;
 326                         size_t stacksize;
 327
 328                         ThreadData (DummyAudioBackend* e, boost::function<void ()> fp, size_t stacksz)
 329                                 : engine (e) , f (fp) , stacksize (stacksz) {}
 330                 };
 331
 332                 /* port engine */
 333                 PortHandle add_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
 334                 int register_system_ports ();
 335                 void unregister_system_ports ();
 336
 337                 std::vector<DummyPort *> _ports;
 338
 339
 340                 struct PortConnectData {
 341                         std::string a;
 342                         std::string b;
 343                         bool c;
 344
 345                         PortConnectData (const std::string& a, const std::string& b, bool c)
 346                                 : a (a) , b (b) , c (c) {}
 347                 };
 348
 349                 std::vector<PortConnectData *> _port_connection_queue;
 350                 pthread_mutex_t _port_callback_mutex;
 351                 bool _port_change_flag;
 352
 353                 void port_connect_callback (const std::string& a, const std::string& b, bool conn) {
 354                         pthread_mutex_lock (&_port_callback_mutex);
 355                         _port_connection_queue.push_back(new PortConnectData(a, b, conn));
 356                         pthread_mutex_unlock (&_port_callback_mutex);
 357                 }
 358
 359                 void port_connect_add_remove_callback () {
 360                         pthread_mutex_lock (&_port_callback_mutex);
 361                         _port_change_flag = true;
 362                         pthread_mutex_unlock (&_port_callback_mutex);
 363                 }
 364
 365                 bool valid_port (PortHandle port) const {
 366                         return std::find (_ports.begin (), _ports.end (), (DummyPort*)port) != _ports.end ();
 367                 }
 368
 369                 DummyPort * find_port (const std::string& port_name) const {
 370                         for (std::vector<DummyPort*>::const_iterator it = _ports.begin (); it != _ports.end (); ++it) {
 371                                 if ((*it)->name () == port_name) {
 372                                         return *it;
 373                                 }
 374                         }
 375                         return NULL;
 376                 }
 377
 378 }; // class DummyAudioBackend
 379
 380 } // namespace
 381
 382 #endif /* __libbackend_dummy_audiobackend_h__ */