libs/backends/portaudio/portaudio_backend.h

   1 /*
   2  * Copyright (C) 2014-2015 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_portaudio_backend_h__
  21 #define __libbackend_portaudio_backend_h__
  22
  23 #include <string>
  24 #include <vector>
  25 #include <set>
  26
  27 #include <stdint.h>
  28 #include <pthread.h>
  29
  30 #include <boost/shared_ptr.hpp>
  31
  32 #include "ardour/audio_backend.h"
  33 #include "ardour/types.h"
  34
  35 #include "portaudio_io.h"
  36 #include "winmmemidi_io.h"
  37 #include "cycle_timer.h"
  38
  39 namespace ARDOUR {
  40
  41 class PortAudioBackend;
  42
  43 class PortMidiEvent {
  44         public:
  45                 PortMidiEvent (const pframes_t timestamp, const uint8_t* data, size_t size);
  46                 PortMidiEvent (const PortMidiEvent& other);
  47                 ~PortMidiEvent ();
  48                 size_t size () const { return _size; };
  49                 pframes_t timestamp () const { return _timestamp; };
  50                 const unsigned char* const_data () const { return _data; };
  51                 unsigned char* data () { return _data; };
  52                 bool operator< (const PortMidiEvent &other) const { return timestamp () < other.timestamp (); };
  53         private:
  54                 size_t _size;
  55                 pframes_t _timestamp;
  56                 uint8_t *_data;
  57 };
  58
  59 typedef std::vector<boost::shared_ptr<PortMidiEvent> > PortMidiBuffer;
  60
  61 class PamPort { // PortAudio / PortMidi Backend Port
  62         protected:
  63                 PamPort (PortAudioBackend &b, const std::string&, PortFlags);
  64         public:
  65                 virtual ~PamPort ();
  66
  67                 const std::string& name () const { return _name; }
  68                 PortFlags flags () const { return _flags; }
  69
  70                 int set_name (const std::string &name) { _name = name; return 0; }
  71
  72                 virtual DataType type () const = 0;
  73
  74                 bool is_input ()     const { return flags () & IsInput; }
  75                 bool is_output ()    const { return flags () & IsOutput; }
  76                 bool is_physical ()  const { return flags () & IsPhysical; }
  77                 bool is_terminal ()  const { return flags () & IsTerminal; }
  78                 bool is_connected () const { return _connections.size () != 0; }
  79                 bool is_connected (const PamPort *port) const;
  80                 bool is_physically_connected () const;
  81
  82                 const std::vector<PamPort *>& get_connections () const { return _connections; }
  83
  84                 int connect (PamPort *port);
  85                 int disconnect (PamPort *port);
  86                 void disconnect_all ();
  87
  88                 virtual void* get_buffer (pframes_t nframes) = 0;
  89
  90                 const LatencyRange latency_range (bool for_playback) const
  91                 {
  92                         return for_playback ? _playback_latency_range : _capture_latency_range;
  93                 }
  94
  95                 void set_latency_range (const LatencyRange &latency_range, bool for_playback)
  96                 {
  97                         if (for_playback)
  98                         {
  99                                 _playback_latency_range = latency_range;
 100                         }
 101                         else
 102                         {
 103                                 _capture_latency_range = latency_range;
 104                         }
 105                 }
 106
 107         private:
 108                 PortAudioBackend &_osx_backend;
 109                 std::string _name;
 110                 const PortFlags _flags;
 111                 LatencyRange _capture_latency_range;
 112                 LatencyRange _playback_latency_range;
 113                 std::vector<PamPort*> _connections;
 114
 115                 void _connect (PamPort* , bool);
 116                 void _disconnect (PamPort* , bool);
 117
 118 }; // class PamPort
 119
 120 class PortAudioPort : public PamPort {
 121         public:
 122                 PortAudioPort (PortAudioBackend &b, const std::string&, PortFlags);
 123                 ~PortAudioPort ();
 124
 125                 DataType type () const { return DataType::AUDIO; };
 126
 127                 Sample* buffer () { return _buffer; }
 128                 const Sample* const_buffer () const { return _buffer; }
 129                 void* get_buffer (pframes_t nframes);
 130
 131         private:
 132                 Sample _buffer[8192];
 133 }; // class PortAudioPort
 134
 135 class PortMidiPort : public PamPort {
 136         public:
 137                 PortMidiPort (PortAudioBackend &b, const std::string&, PortFlags);
 138                 ~PortMidiPort ();
 139
 140                 DataType type () const { return DataType::MIDI; };
 141
 142                 void* get_buffer (pframes_t nframes);
 143                 const PortMidiBuffer * const_buffer () const { return & _buffer[_bufperiod]; }
 144
 145                 void next_period() { if (_n_periods > 1) { get_buffer(0); _bufperiod = (_bufperiod + 1) % _n_periods; } }
 146                 void set_n_periods(int n) { if (n > 0 && n < 3) { _n_periods = n; } }
 147
 148         private:
 149                 PortMidiBuffer _buffer[2];
 150                 int _n_periods;
 151                 int _bufperiod;
 152 }; // class PortMidiPort
 153
 154 class PortAudioBackend : public AudioBackend {
 155         friend class PamPort;
 156         public:
 157                 PortAudioBackend (AudioEngine& e, AudioBackendInfo& info);
 158                 ~PortAudioBackend ();
 159
 160                 /* AUDIOBACKEND API */
 161
 162                 std::string name () const;
 163                 bool is_realtime () const;
 164
 165                 bool requires_driver_selection() const;
 166                 std::string driver_name () const;
 167                 std::vector<std::string> enumerate_drivers () const;
 168                 int set_driver (const std::string&);
 169
 170                 bool use_separate_input_and_output_devices () const;
 171                 std::vector<DeviceStatus> enumerate_devices () const;
 172                 std::vector<DeviceStatus> enumerate_input_devices () const;
 173                 std::vector<DeviceStatus> enumerate_output_devices () const;
 174
 175                 std::vector<float> available_sample_rates (const std::string& device) const;
 176                 std::vector<uint32_t> available_buffer_sizes (const std::string& device) const;
 177                 uint32_t available_input_channel_count (const std::string& device) const;
 178                 uint32_t available_output_channel_count (const std::string& device) const;
 179
 180                 bool can_change_sample_rate_when_running () const;
 181                 bool can_change_buffer_size_when_running () const;
 182
 183                 int set_device_name (const std::string&);
 184                 int set_input_device_name (const std::string&);
 185                 int set_output_device_name (const std::string&);
 186                 int set_sample_rate (float);
 187                 int set_buffer_size (uint32_t);
 188                 int set_interleaved (bool yn);
 189                 int set_input_channels (uint32_t);
 190                 int set_output_channels (uint32_t);
 191                 int set_systemic_input_latency (uint32_t);
 192                 int set_systemic_output_latency (uint32_t);
 193                 int set_systemic_midi_input_latency (std::string const, uint32_t) { return 0; }
 194                 int set_systemic_midi_output_latency (std::string const, uint32_t) { return 0; }
 195
 196                 int reset_device () { return 0; };
 197
 198                 /* Retrieving parameters */
 199                 std::string  device_name () const;
 200                 std::string  input_device_name () const;
 201                 std::string  output_device_name () const;
 202                 float        sample_rate () const;
 203                 uint32_t     buffer_size () const;
 204                 bool         interleaved () const;
 205                 uint32_t     input_channels () const;
 206                 uint32_t     output_channels () const;
 207                 uint32_t     systemic_input_latency () const;
 208                 uint32_t     systemic_output_latency () const;
 209                 uint32_t     systemic_midi_input_latency (std::string const) const { return 0; }
 210                 uint32_t     systemic_midi_output_latency (std::string const) const { return 0; }
 211
 212                 bool can_set_systemic_midi_latencies () const { return false; }
 213
 214                 /* External control app */
 215                 std::string control_app_name () const { return std::string (); }
 216                 void launch_control_app () {}
 217
 218                 /* MIDI */
 219                 std::vector<std::string> enumerate_midi_options () const;
 220                 int set_midi_option (const std::string&);
 221                 std::string midi_option () const;
 222
 223                 std::vector<DeviceStatus> enumerate_midi_devices () const {
 224                         return std::vector<AudioBackend::DeviceStatus> ();
 225                 }
 226                 int set_midi_device_enabled (std::string const, bool) {
 227                         return 0;
 228                 }
 229                 bool midi_device_enabled (std::string const) const {
 230                         return true;
 231                 }
 232
 233         protected:
 234                 /* State Control */
 235                 int _start (bool for_latency_measurement);
 236         public:
 237                 int stop ();
 238                 int freewheel (bool);
 239                 float dsp_load () const;
 240                 size_t raw_buffer_size (DataType t);
 241
 242                 /* Process time */
 243                 framepos_t sample_time ();
 244                 framepos_t sample_time_at_cycle_start ();
 245                 pframes_t samples_since_cycle_start ();
 246
 247                 int create_process_thread (boost::function<void()> func);
 248                 int join_process_threads ();
 249                 bool in_process_thread ();
 250                 uint32_t process_thread_count ();
 251
 252                 void update_latencies ();
 253
 254                 /* PORTENGINE API */
 255
 256                 void* private_handle () const;
 257                 const std::string& my_name () const;
 258                 bool available () const;
 259                 uint32_t port_name_size () const;
 260
 261                 int         set_port_name (PortHandle, const std::string&);
 262                 std::string get_port_name (PortHandle) const;
 263                 PortHandle  get_port_by_name (const std::string&) const;
 264
 265                 int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&) const;
 266
 267                 DataType port_data_type (PortHandle) const;
 268
 269                 PortHandle register_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
 270                 void unregister_port (PortHandle);
 271
 272                 int  connect (const std::string& src, const std::string& dst);
 273                 int  disconnect (const std::string& src, const std::string& dst);
 274                 int  connect (PortHandle, const std::string&);
 275                 int  disconnect (PortHandle, const std::string&);
 276                 int  disconnect_all (PortHandle);
 277
 278                 bool connected (PortHandle, bool process_callback_safe);
 279                 bool connected_to (PortHandle, const std::string&, bool process_callback_safe);
 280                 bool physically_connected (PortHandle, bool process_callback_safe);
 281                 int  get_connections (PortHandle, std::vector<std::string>&, bool process_callback_safe);
 282
 283                 /* MIDI */
 284                 int midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index);
 285                 int midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
 286                 uint32_t get_midi_event_count (void* port_buffer);
 287                 void     midi_clear (void* port_buffer);
 288
 289                 /* Monitoring */
 290
 291                 bool can_monitor_input () const;
 292                 int  request_input_monitoring (PortHandle, bool);
 293                 int  ensure_input_monitoring (PortHandle, bool);
 294                 bool monitoring_input (PortHandle);
 295
 296                 /* Latency management */
 297
 298                 void         set_latency_range (PortHandle, bool for_playback, LatencyRange);
 299                 LatencyRange get_latency_range (PortHandle, bool for_playback);
 300
 301                 /* Discovering physical ports */
 302
 303                 bool      port_is_physical (PortHandle) const;
 304                 void      get_physical_outputs (DataType type, std::vector<std::string>&);
 305                 void      get_physical_inputs (DataType type, std::vector<std::string>&);
 306                 ChanCount n_physical_outputs () const;
 307                 ChanCount n_physical_inputs () const;
 308
 309                 /* Getting access to the data buffer for a port */
 310
 311                 void* get_buffer (PortHandle, pframes_t);
 312
 313                 void* main_process_thread ();
 314
 315         private:
 316                 std::string _instance_name;
 317                 PortAudioIO *_pcmio;
 318                 WinMMEMidiIO *_midiio;
 319
 320                 bool  _run; /* keep going or stop, ardour thread */
 321                 bool  _active; /* is running, process thread */
 322                 bool  _freewheel;
 323                 bool  _freewheeling;
 324                 bool  _measure_latency;
 325
 326                 uint64_t m_cycle_count;
 327                 uint64_t m_total_deviation_us;
 328                 uint64_t m_max_deviation_us;
 329
 330                 CycleTimer m_cycle_timer;
 331                 uint64_t m_last_cycle_start;
 332
 333                 static std::vector<std::string> _midi_options;
 334                 static std::vector<AudioBackend::DeviceStatus> _input_audio_device_status;
 335                 static std::vector<AudioBackend::DeviceStatus> _output_audio_device_status;
 336                 static std::vector<AudioBackend::DeviceStatus> _midi_device_status;
 337
 338                 mutable std::string _input_audio_device;
 339                 mutable std::string _output_audio_device;
 340                 std::string _midi_driver_option;
 341
 342                 /* audio settings */
 343                 float  _samplerate;
 344                 size_t _samples_per_period;
 345                 static size_t _max_buffer_size;
 346
 347                 uint32_t _n_inputs;
 348                 uint32_t _n_outputs;
 349
 350                 uint32_t _systemic_audio_input_latency;
 351                 uint32_t _systemic_audio_output_latency;
 352
 353                 /* portaudio specific  */
 354                 int name_to_id(std::string) const;
 355
 356                 /* processing */
 357                 float  _dsp_load;
 358                 framecnt_t _processed_samples;
 359                 pthread_t _main_thread;
 360
 361                 /* process threads */
 362                 static void* portaudio_process_thread (void *);
 363                 std::vector<pthread_t> _threads;
 364
 365                 struct ThreadData {
 366                         PortAudioBackend* engine;
 367                         boost::function<void ()> f;
 368                         size_t stacksize;
 369
 370                         ThreadData (PortAudioBackend* e, boost::function<void ()> fp, size_t stacksz)
 371                                 : engine (e) , f (fp) , stacksize (stacksz) {}
 372                 };
 373
 374                 /* port engine */
 375                 PortHandle add_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
 376                 int register_system_audio_ports ();
 377                 int register_system_midi_ports ();
 378                 void unregister_ports (bool system_only = false);
 379
 380                 std::vector<PamPort *> _ports;
 381                 std::vector<PamPort *> _system_inputs;
 382                 std::vector<PamPort *> _system_outputs;
 383                 std::vector<PamPort *> _system_midi_in;
 384                 std::vector<PamPort *> _system_midi_out;
 385
 386                 struct PortConnectData {
 387                         std::string a;
 388                         std::string b;
 389                         bool c;
 390
 391                         PortConnectData (const std::string& a, const std::string& b, bool c)
 392                                 : a (a) , b (b) , c (c) {}
 393                 };
 394
 395                 std::vector<PortConnectData *> _port_connection_queue;
 396                 pthread_mutex_t _port_callback_mutex;
 397                 bool _port_change_flag;
 398
 399                 void port_connect_callback (const std::string& a, const std::string& b, bool conn) {
 400                         pthread_mutex_lock (&_port_callback_mutex);
 401                         _port_connection_queue.push_back(new PortConnectData(a, b, conn));
 402                         pthread_mutex_unlock (&_port_callback_mutex);
 403                 }
 404
 405                 void port_connect_add_remove_callback () {
 406                         pthread_mutex_lock (&_port_callback_mutex);
 407                         _port_change_flag = true;
 408                         pthread_mutex_unlock (&_port_callback_mutex);
 409                 }
 410
 411                 bool valid_port (PortHandle port) const {
 412                         return std::find (_ports.begin (), _ports.end (), (PamPort*)port) != _ports.end ();
 413                 }
 414
 415                 PamPort * find_port (const std::string& port_name) const {
 416                         for (std::vector<PamPort*>::const_iterator it = _ports.begin (); it != _ports.end (); ++it) {
 417                                 if ((*it)->name () == port_name) {
 418                                         return *it;
 419                                 }
 420                         }
 421                         return NULL;
 422                 }
 423
 424                 PamPort * find_port_in (std::vector<PamPort *> plist, const std::string& port_name) const {
 425                         for (std::vector<PamPort*>::const_iterator it = plist.begin (); it != plist.end (); ++it) {
 426                                 if ((*it)->name () == port_name) {
 427                                         return *it;
 428                                 }
 429                         }
 430                         return NULL;
 431                 }
 432
 433 }; // class PortAudioBackend
 434
 435 } // namespace
 436
 437 #endif /* __libbackend_portaudio_backend_h__ */