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