libs/backends/coreaudio/coreaudio_backend.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_coreaudio_backend_h__
  21 #define __libbackend_coreaudio_backend_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/audio_backend.h"
  34 #include "ardour/types.h"
  35
  36 #include "coreaudio_pcmio.h"
  37 #include "coremidi_io.h"
  38
  39 namespace ARDOUR {
  40
  41 class CoreAudioBackend;
  42
  43 class CoreMidiEvent {
  44         public:
  45                 CoreMidiEvent (const pframes_t timestamp, const uint8_t* data, size_t size);
  46                 CoreMidiEvent (const CoreMidiEvent& other);
  47                 ~CoreMidiEvent ();
  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 CoreMidiEvent &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<CoreMidiEvent> > CoreMidiBuffer;
  60
  61 class CoreBackendPort {
  62         protected:
  63                 CoreBackendPort (CoreAudioBackend &b, const std::string&, PortFlags);
  64         public:
  65                 virtual ~CoreBackendPort ();
  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 CoreBackendPort *port) const;
  82                 bool is_physically_connected () const;
  83
  84                 const std::vector<CoreBackendPort *>& get_connections () const { return _connections; }
  85
  86                 int connect (CoreBackendPort *port);
  87                 int disconnect (CoreBackendPort *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                 CoreAudioBackend &_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<CoreBackendPort*> _connections;
 117
 118                 void _connect (CoreBackendPort* , bool);
 119                 void _disconnect (CoreBackendPort* , bool);
 120
 121 }; // class CoreBackendPort
 122
 123 class CoreAudioPort : public CoreBackendPort {
 124         public:
 125                 CoreAudioPort (CoreAudioBackend &b, const std::string&, PortFlags);
 126                 ~CoreAudioPort ();
 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 CoreAudioPort
 137
 138 class CoreMidiPort : public CoreBackendPort {
 139         public:
 140                 CoreMidiPort (CoreAudioBackend &b, const std::string&, PortFlags);
 141                 ~CoreMidiPort ();
 142
 143                 DataType type () const { return DataType::MIDI; };
 144
 145                 void* get_buffer (pframes_t nframes);
 146                 const CoreMidiBuffer * 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                 CoreMidiBuffer _buffer[2];
 153                 int _n_periods;
 154                 int _bufperiod;
 155 }; // class CoreMidiPort
 156
 157 class CoreAudioBackend : public AudioBackend {
 158         friend class CoreBackendPort;
 159         public:
 160                 CoreAudioBackend (AudioEngine& e, AudioBackendInfo& info);
 161                 ~CoreAudioBackend ();
 162
 163                 /* AUDIOBACKEND API */
 164
 165                 std::string name () const;
 166                 bool is_realtime () const;
 167
 168                 bool use_separate_input_and_output_devices () const { return true; }
 169                 std::vector<DeviceStatus> enumerate_devices () const;
 170                 std::vector<DeviceStatus> enumerate_input_devices () const;
 171                 std::vector<DeviceStatus> enumerate_output_devices () const;
 172
 173                 std::vector<float> available_sample_rates (const std::string& device) const;
 174                 std::vector<float> available_sample_rates (const std::string&, const std::string&) const;
 175                 std::vector<uint32_t> available_buffer_sizes (const std::string& device) const;
 176                 std::vector<uint32_t> available_buffer_sizes (const std::string&, const std::string&) 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; /* XXX */}
 213
 214                 /* External control app */
 215                 std::string control_app_name () const { return std::string ("Apple"); }
 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 true;
 228                 }
 229                 bool midi_device_enabled (std::string const) const {
 230                         return false;
 231                 }
 232
 233                 // really private, but needing static access:
 234                 int process_callback(uint32_t, uint64_t);
 235                 void error_callback();
 236                 void xrun_callback();
 237                 void buffer_size_callback();
 238                 void sample_rate_callback();
 239                 void hw_changed_callback();
 240
 241         protected:
 242                 /* State Control */
 243                 int _start (bool for_latency_measurement);
 244         public:
 245                 int stop ();
 246                 int freewheel (bool);
 247                 float dsp_load () const;
 248                 size_t raw_buffer_size (DataType t);
 249
 250                 /* Process time */
 251                 framepos_t sample_time ();
 252                 framepos_t sample_time_at_cycle_start ();
 253                 pframes_t samples_since_cycle_start ();
 254
 255                 int create_process_thread (boost::function<void()> func);
 256                 int join_process_threads ();
 257                 bool in_process_thread ();
 258                 uint32_t process_thread_count ();
 259
 260                 void update_latencies ();
 261
 262                 /* PORTENGINE API */
 263
 264                 void* private_handle () const;
 265                 const std::string& my_name () const;
 266                 bool available () const;
 267                 uint32_t port_name_size () const;
 268
 269                 int         set_port_name (PortHandle, const std::string&);
 270                 std::string get_port_name (PortHandle) const;
 271                 PortHandle  get_port_by_name (const std::string&) const;
 272                 int get_port_property (PortHandle, const std::string& key, std::string& value, std::string& type) const;
 273
 274                 int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&) const;
 275
 276                 DataType port_data_type (PortHandle) const;
 277
 278                 PortHandle register_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
 279                 void unregister_port (PortHandle);
 280
 281                 int  connect (const std::string& src, const std::string& dst);
 282                 int  disconnect (const std::string& src, const std::string& dst);
 283                 int  connect (PortHandle, const std::string&);
 284                 int  disconnect (PortHandle, const std::string&);
 285                 int  disconnect_all (PortHandle);
 286
 287                 bool connected (PortHandle, bool process_callback_safe);
 288                 bool connected_to (PortHandle, const std::string&, bool process_callback_safe);
 289                 bool physically_connected (PortHandle, bool process_callback_safe);
 290                 int  get_connections (PortHandle, std::vector<std::string>&, bool process_callback_safe);
 291
 292                 /* MIDI */
 293                 int midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index);
 294                 int midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
 295                 uint32_t get_midi_event_count (void* port_buffer);
 296                 void     midi_clear (void* port_buffer);
 297
 298                 /* Monitoring */
 299
 300                 bool can_monitor_input () const;
 301                 int  request_input_monitoring (PortHandle, bool);
 302                 int  ensure_input_monitoring (PortHandle, bool);
 303                 bool monitoring_input (PortHandle);
 304
 305                 /* Latency management */
 306
 307                 void         set_latency_range (PortHandle, bool for_playback, LatencyRange);
 308                 LatencyRange get_latency_range (PortHandle, bool for_playback);
 309
 310                 /* Discovering physical ports */
 311
 312                 bool      port_is_physical (PortHandle) const;
 313                 void      get_physical_outputs (DataType type, std::vector<std::string>&);
 314                 void      get_physical_inputs (DataType type, std::vector<std::string>&);
 315                 ChanCount n_physical_outputs () const;
 316                 ChanCount n_physical_inputs () const;
 317
 318                 /* Getting access to the data buffer for a port */
 319
 320                 void* get_buffer (PortHandle, pframes_t);
 321
 322                 void* freewheel_thread ();
 323                 void pre_process ();
 324                 void coremidi_rediscover ();
 325
 326         private:
 327                 std::string _instance_name;
 328                 CoreAudioPCM *_pcmio;
 329                 CoreMidiIo *_midiio;
 330
 331                 bool  _run; /* keep going or stop, ardour thread */
 332                 bool  _active_ca; /* is running, process thread */
 333                 bool  _active_fw; /* is running, process thread */
 334                 bool  _preinit;
 335                 bool  _freewheeling;
 336                 bool  _freewheel;
 337                 bool  _freewheel_ack;
 338                 bool  _reinit_thread_callback;
 339                 bool  _measure_latency;
 340
 341                 uint64_t _last_process_start;
 342
 343                 pthread_mutex_t _process_callback_mutex;
 344
 345                 pthread_mutex_t _freewheel_mutex;
 346                 pthread_cond_t  _freewheel_signal;
 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> _duplex_audio_device_status;
 352                 static std::vector<AudioBackend::DeviceStatus> _midi_device_status;
 353
 354                 mutable std::string _input_audio_device;
 355                 mutable std::string _output_audio_device;
 356                 std::string _midi_driver_option;
 357
 358                 /* audio settings */
 359                 float  _samplerate;
 360                 size_t _samples_per_period;
 361                 static size_t _max_buffer_size;
 362
 363                 uint32_t _n_inputs;
 364                 uint32_t _n_outputs;
 365
 366                 uint32_t _systemic_audio_input_latency;
 367                 uint32_t _systemic_audio_output_latency;
 368
 369                 /* coreaudio specific  */
 370                 uint32_t name_to_id(std::string) const;
 371
 372                 /* processing */
 373                 float  _dsp_load;
 374                 uint64_t _processed_samples;
 375
 376                 pthread_t _main_thread;
 377                 pthread_t _freeewheel_thread;
 378
 379                 /* process threads */
 380                 static void* coreaudio_process_thread (void *);
 381                 std::vector<pthread_t> _threads;
 382
 383                 struct ThreadData {
 384                         CoreAudioBackend* engine;
 385                         boost::function<void ()> f;
 386                         size_t stacksize;
 387
 388                         ThreadData (CoreAudioBackend* e, boost::function<void ()> fp, size_t stacksz)
 389                                 : engine (e) , f (fp) , stacksize (stacksz) {}
 390                 };
 391
 392                 /* port engine */
 393                 PortHandle add_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
 394                 int register_system_audio_ports ();
 395                 void unregister_ports (bool system_only = false);
 396
 397                 std::vector<CoreBackendPort *> _ports;
 398                 std::vector<CoreBackendPort *> _system_inputs;
 399                 std::vector<CoreBackendPort *> _system_outputs;
 400                 std::vector<CoreBackendPort *> _system_midi_in;
 401                 std::vector<CoreBackendPort *> _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 (), (CoreBackendPort*)port) != _ports.end ();
 430                 }
 431
 432                 CoreBackendPort * find_port (const std::string& port_name) const {
 433                         for (std::vector<CoreBackendPort*>::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                 CoreBackendPort * find_port_in (std::vector<CoreBackendPort *> plist, const std::string& port_name) const {
 442                         for (std::vector<CoreBackendPort*>::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 #ifdef USE_MIDI_PARSER
 451
 452                 bool midi_process_byte (const uint8_t);
 453
 454                 void midi_record_byte (uint8_t byte) {
 455                         if (_total_bytes < sizeof (_parser_buffer)) {
 456                                 _parser_buffer[_total_bytes] = byte;
 457                         } else {
 458                                 ++_unbuffered_bytes;
 459                         }
 460                         ++_total_bytes;
 461                 }
 462
 463                 void midi_prepare_byte_event (const uint8_t byte) {
 464                         _parser_buffer[0] = byte;
 465                         _parser_bytes = 1;
 466                 }
 467
 468                 bool midi_prepare_buffered_event () {
 469                         const bool result = _unbuffered_bytes == 0;
 470                         if (result) {
 471                                 _parser_bytes = _total_bytes;
 472                         }
 473                         _total_bytes = 0;
 474                         _unbuffered_bytes = 0;
 475                         if (_status_byte >= 0xf0) {
 476                                 _expected_bytes = 0;
 477                                 _status_byte = 0;
 478                         }
 479                         return result;
 480                 }
 481
 482                 size_t  _unbuffered_bytes;
 483                 size_t  _total_bytes;
 484                 size_t  _expected_bytes;
 485                 uint8_t _status_byte;
 486                 uint8_t _parser_buffer[128];
 487                 uint8_t _parser_bytes;
 488 #endif
 489
 490 }; // class CoreAudioBackend
 491
 492 } // namespace
 493
 494 #endif /* __libbackend_coreaudio_backend_h__ */