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