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