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/dsp_load_calculator.h"
  35 #include "ardour/types.h"
  36
  37 #include "coreaudio_pcmio.h"
  38 #include "coremidi_io.h"
  39
  40 namespace ARDOUR {
  41
  42 class CoreAudioBackend;
  43
  44 class CoreMidiEvent {
  45         public:
  46                 CoreMidiEvent (const pframes_t timestamp, const uint8_t* data, size_t size);
  47                 CoreMidiEvent (const CoreMidiEvent& other);
  48                 ~CoreMidiEvent ();
  49                 size_t size () const { return _size; };
  50                 pframes_t timestamp () const { return _timestamp; };
  51                 const unsigned char* const_data () const { return _data; };
  52                 unsigned char* data () { return _data; };
  53                 bool operator< (const CoreMidiEvent &other) const { return timestamp () < other.timestamp (); };
  54         private:
  55                 size_t _size;
  56                 pframes_t _timestamp;
  57                 uint8_t *_data;
  58 };
  59
  60 typedef std::vector<boost::shared_ptr<CoreMidiEvent> > CoreMidiBuffer;
  61
  62 class CoreBackendPort {
  63         protected:
  64                 CoreBackendPort (CoreAudioBackend &b, const std::string&, PortFlags);
  65         public:
  66                 virtual ~CoreBackendPort ();
  67
  68                 const std::string& name () const { return _name; }
  69                 const std::string& pretty_name () const { return _pretty_name; }
  70                 PortFlags flags () const { return _flags; }
  71
  72                 int set_name (const std::string &name) { _name = name; return 0; }
  73                 int set_pretty_name (const std::string &name) { _pretty_name = name; return 0; }
  74
  75                 virtual DataType type () const = 0;
  76
  77                 bool is_input ()     const { return flags () & IsInput; }
  78                 bool is_output ()    const { return flags () & IsOutput; }
  79                 bool is_physical ()  const { return flags () & IsPhysical; }
  80                 bool is_terminal ()  const { return flags () & IsTerminal; }
  81                 bool is_connected () const { return _connections.size () != 0; }
  82                 bool is_connected (const CoreBackendPort *port) const;
  83                 bool is_physically_connected () const;
  84
  85                 const std::vector<CoreBackendPort *>& get_connections () const { return _connections; }
  86
  87                 int connect (CoreBackendPort *port);
  88                 int disconnect (CoreBackendPort *port);
  89                 void disconnect_all ();
  90
  91                 virtual void* get_buffer (pframes_t nframes) = 0;
  92
  93                 const LatencyRange latency_range (bool for_playback) const
  94                 {
  95                         return for_playback ? _playback_latency_range : _capture_latency_range;
  96                 }
  97
  98                 void set_latency_range (const LatencyRange &latency_range, bool for_playback)
  99                 {
 100                         if (for_playback)
 101                         {
 102                                 _playback_latency_range = latency_range;
 103                         }
 104                         else
 105                         {
 106                                 _capture_latency_range = latency_range;
 107                         }
 108                 }
 109
 110         private:
 111                 CoreAudioBackend &_osx_backend;
 112                 std::string _name;
 113                 std::string _pretty_name;
 114                 const PortFlags _flags;
 115                 LatencyRange _capture_latency_range;
 116                 LatencyRange _playback_latency_range;
 117                 std::vector<CoreBackendPort*> _connections;
 118
 119                 void _connect (CoreBackendPort* , bool);
 120                 void _disconnect (CoreBackendPort* , bool);
 121
 122 }; // class CoreBackendPort
 123
 124 class CoreAudioPort : public CoreBackendPort {
 125         public:
 126                 CoreAudioPort (CoreAudioBackend &b, const std::string&, PortFlags);
 127                 ~CoreAudioPort ();
 128
 129                 DataType type () const { return DataType::AUDIO; };
 130
 131                 Sample* buffer () { return _buffer; }
 132                 const Sample* const_buffer () const { return _buffer; }
 133                 void* get_buffer (pframes_t nframes);
 134
 135         private:
 136                 Sample _buffer[8192];
 137 }; // class CoreAudioPort
 138
 139 class CoreMidiPort : public CoreBackendPort {
 140         public:
 141                 CoreMidiPort (CoreAudioBackend &b, const std::string&, PortFlags);
 142                 ~CoreMidiPort ();
 143
 144                 DataType type () const { return DataType::MIDI; };
 145
 146                 void* get_buffer (pframes_t nframes);
 147                 const CoreMidiBuffer * const_buffer () const { return & _buffer[_bufperiod]; }
 148
 149                 void next_period() { if (_n_periods > 1) { get_buffer(0); _bufperiod = (_bufperiod + 1) % _n_periods; } }
 150                 void set_n_periods(int n) { if (n > 0 && n < 3) { _n_periods = n; } }
 151
 152         void parse_events (const uint64_t time, const uint8_t *data, const size_t size);
 153         void clear_events ();
 154         void reset_parser ();
 155
 156         private:
 157                 CoreMidiBuffer _buffer[2];
 158                 int _n_periods;
 159                 int _bufperiod;
 160
 161         int queue_event (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
 162         bool process_byte (const uint64_t, const uint8_t);
 163
 164         void record_byte(uint8_t byte) {
 165                 if (_total_bytes < sizeof(_parser_buffer)) {
 166                         _parser_buffer[_total_bytes] = byte;
 167                 } else {
 168                         ++_unbuffered_bytes;
 169                 }
 170                 ++_total_bytes;
 171         }
 172
 173         void prepare_byte_event(const uint64_t time, const uint8_t byte) {
 174                 _parser_buffer[0] = byte;
 175                 _event.prepare(time, 1);
 176         }
 177
 178         bool prepare_buffered_event(const uint64_t time) {
 179                 const bool result = _unbuffered_bytes == 0;
 180                 if (result) {
 181                         _event.prepare(time, _total_bytes);
 182                 }
 183                 _total_bytes = 0;
 184                 _unbuffered_bytes = 0;
 185                 if (_status_byte >= 0xf0) {
 186                         _expected_bytes = 0;
 187                         _status_byte = 0;
 188                 }
 189                 return result;
 190         }
 191
 192         struct ParserEvent {
 193                 uint64_t _time;
 194                 size_t _size;
 195                 bool _pending;
 196                 ParserEvent (const uint64_t time, const size_t size)
 197                         : _time(time)
 198                         , _size(size)
 199                         , _pending(false) {}
 200
 201                 void prepare(const uint64_t time, const size_t size) {
 202                         _time = time;
 203                         _size = size;
 204                         _pending = true;
 205                 }
 206         } _event;
 207
 208         bool    _first_time;
 209         size_t  _unbuffered_bytes;
 210         size_t  _total_bytes;
 211         size_t  _expected_bytes;
 212         uint8_t _status_byte;
 213         uint8_t _parser_buffer[1024];
 214
 215 }; // class CoreMidiPort
 216
 217 class CoreAudioBackend : public AudioBackend {
 218         friend class CoreBackendPort;
 219         public:
 220                 CoreAudioBackend (AudioEngine& e, AudioBackendInfo& info);
 221                 ~CoreAudioBackend ();
 222
 223                 /* AUDIOBACKEND API */
 224
 225                 std::string name () const;
 226                 bool is_realtime () const;
 227
 228                 bool use_separate_input_and_output_devices () const { return true; }
 229                 std::vector<DeviceStatus> enumerate_devices () const;
 230                 std::vector<DeviceStatus> enumerate_input_devices () const;
 231                 std::vector<DeviceStatus> enumerate_output_devices () const;
 232
 233                 std::vector<float> available_sample_rates (const std::string& device) const;
 234                 std::vector<float> available_sample_rates2 (const std::string&, const std::string&) const;
 235                 std::vector<uint32_t> available_buffer_sizes (const std::string& device) const;
 236                 std::vector<uint32_t> available_buffer_sizes2 (const std::string&, const std::string&) const;
 237                 uint32_t available_input_channel_count (const std::string& device) const;
 238                 uint32_t available_output_channel_count (const std::string& device) const;
 239
 240                 bool can_change_sample_rate_when_running () const;
 241                 bool can_change_buffer_size_when_running () const;
 242
 243                 int set_device_name (const std::string&);
 244                 int set_input_device_name (const std::string&);
 245                 int set_output_device_name (const std::string&);
 246                 int set_sample_rate (float);
 247                 int set_buffer_size (uint32_t);
 248                 int set_interleaved (bool yn);
 249                 int set_input_channels (uint32_t);
 250                 int set_output_channels (uint32_t);
 251                 int set_systemic_input_latency (uint32_t);
 252                 int set_systemic_output_latency (uint32_t);
 253                 int set_systemic_midi_input_latency (std::string const, uint32_t) { return 0; }
 254                 int set_systemic_midi_output_latency (std::string const, uint32_t) { return 0; }
 255
 256                 int reset_device () { return 0; };
 257
 258                 /* Retrieving parameters */
 259                 std::string  device_name () const;
 260                 std::string  input_device_name () const;
 261                 std::string  output_device_name () const;
 262                 float        sample_rate () const;
 263                 uint32_t     buffer_size () const;
 264                 bool         interleaved () const;
 265                 uint32_t     input_channels () const;
 266                 uint32_t     output_channels () const;
 267                 uint32_t     systemic_input_latency () const;
 268                 uint32_t     systemic_output_latency () const;
 269                 uint32_t     systemic_midi_input_latency (std::string const) const { return 0; }
 270                 uint32_t     systemic_midi_output_latency (std::string const) const { return 0; }
 271
 272                 bool can_set_systemic_midi_latencies () const { return false; /* XXX */}
 273
 274                 /* External control app */
 275                 std::string control_app_name () const { return std::string ("Apple"); }
 276                 void launch_control_app ();
 277
 278                 /* MIDI */
 279                 std::vector<std::string> enumerate_midi_options () const;
 280                 int set_midi_option (const std::string&);
 281                 std::string midi_option () const;
 282
 283                 std::vector<DeviceStatus> enumerate_midi_devices () const {
 284                         return std::vector<AudioBackend::DeviceStatus> ();
 285                 }
 286                 int set_midi_device_enabled (std::string const, bool) {
 287                         return true;
 288                 }
 289                 bool midi_device_enabled (std::string const) const {
 290                         return false;
 291                 }
 292
 293                 // really private, but needing static access:
 294                 int process_callback(uint32_t, uint64_t);
 295                 void error_callback();
 296                 void xrun_callback();
 297                 void buffer_size_callback();
 298                 void sample_rate_callback();
 299                 void hw_changed_callback();
 300
 301         protected:
 302                 /* State Control */
 303                 int _start (bool for_latency_measurement);
 304         public:
 305                 int stop ();
 306                 int freewheel (bool);
 307                 float dsp_load () const;
 308                 size_t raw_buffer_size (DataType t);
 309
 310                 /* Process time */
 311                 framepos_t sample_time ();
 312                 framepos_t sample_time_at_cycle_start ();
 313                 pframes_t samples_since_cycle_start ();
 314
 315                 int create_process_thread (boost::function<void()> func);
 316                 int join_process_threads ();
 317                 bool in_process_thread ();
 318                 uint32_t process_thread_count ();
 319
 320                 void update_latencies ();
 321
 322                 /* PORTENGINE API */
 323
 324                 void* private_handle () const;
 325                 const std::string& my_name () const;
 326                 bool available () const;
 327                 uint32_t port_name_size () const;
 328
 329                 int         set_port_name (PortHandle, const std::string&);
 330                 std::string get_port_name (PortHandle) const;
 331                 PortHandle  get_port_by_name (const std::string&) const;
 332                 int get_port_property (PortHandle, const std::string& key, std::string& value, std::string& type) const;
 333
 334                 int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&) const;
 335
 336                 DataType port_data_type (PortHandle) const;
 337
 338                 PortHandle register_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
 339                 void unregister_port (PortHandle);
 340
 341                 int  connect (const std::string& src, const std::string& dst);
 342                 int  disconnect (const std::string& src, const std::string& dst);
 343                 int  connect (PortHandle, const std::string&);
 344                 int  disconnect (PortHandle, const std::string&);
 345                 int  disconnect_all (PortHandle);
 346
 347                 bool connected (PortHandle, bool process_callback_safe);
 348                 bool connected_to (PortHandle, const std::string&, bool process_callback_safe);
 349                 bool physically_connected (PortHandle, bool process_callback_safe);
 350                 int  get_connections (PortHandle, std::vector<std::string>&, bool process_callback_safe);
 351
 352                 /* MIDI */
 353                 int midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index);
 354                 int midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size) {
 355                         return _midi_event_put (port_buffer, timestamp, buffer, size);
 356                 }
 357
 358                 uint32_t get_midi_event_count (void* port_buffer);
 359                 void     midi_clear (void* port_buffer);
 360
 361                 /* Monitoring */
 362
 363                 bool can_monitor_input () const;
 364                 int  request_input_monitoring (PortHandle, bool);
 365                 int  ensure_input_monitoring (PortHandle, bool);
 366                 bool monitoring_input (PortHandle);
 367
 368                 /* Latency management */
 369
 370                 void         set_latency_range (PortHandle, bool for_playback, LatencyRange);
 371                 LatencyRange get_latency_range (PortHandle, bool for_playback);
 372
 373                 /* Discovering physical ports */
 374
 375                 bool      port_is_physical (PortHandle) const;
 376                 void      get_physical_outputs (DataType type, std::vector<std::string>&);
 377                 void      get_physical_inputs (DataType type, std::vector<std::string>&);
 378                 ChanCount n_physical_outputs () const;
 379                 ChanCount n_physical_inputs () const;
 380
 381                 /* Getting access to the data buffer for a port */
 382
 383                 void* get_buffer (PortHandle, pframes_t);
 384
 385                 void* freewheel_thread ();
 386                 void pre_process ();
 387                 void coremidi_rediscover ();
 388
 389                 static int _midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
 390
 391         private:
 392                 std::string _instance_name;
 393                 CoreAudioPCM *_pcmio;
 394                 CoreMidiIo *_midiio;
 395
 396                 bool  _run; /* keep going or stop, ardour thread */
 397                 bool  _active_ca; /* is running, process thread */
 398                 bool  _active_fw; /* is running, process thread */
 399                 bool  _preinit;
 400                 bool  _freewheeling;
 401                 bool  _freewheel;
 402                 bool  _freewheel_ack;
 403                 bool  _reinit_thread_callback;
 404                 bool  _measure_latency;
 405
 406                 uint64_t _last_process_start;
 407
 408                 pthread_mutex_t _process_callback_mutex;
 409
 410                 pthread_mutex_t _freewheel_mutex;
 411                 pthread_cond_t  _freewheel_signal;
 412
 413                 static std::vector<std::string> _midi_options;
 414                 static std::vector<AudioBackend::DeviceStatus> _input_audio_device_status;
 415                 static std::vector<AudioBackend::DeviceStatus> _output_audio_device_status;
 416                 static std::vector<AudioBackend::DeviceStatus> _duplex_audio_device_status;
 417                 static std::vector<AudioBackend::DeviceStatus> _midi_device_status;
 418
 419                 mutable std::string _input_audio_device;
 420                 mutable std::string _output_audio_device;
 421                 std::string _midi_driver_option;
 422
 423                 /* audio settings */
 424                 float  _samplerate;
 425                 size_t _samples_per_period;
 426                 static size_t _max_buffer_size;
 427
 428                 uint32_t _n_inputs;
 429                 uint32_t _n_outputs;
 430
 431                 uint32_t _systemic_audio_input_latency;
 432                 uint32_t _systemic_audio_output_latency;
 433
 434                 /* coreaudio specific  */
 435                 uint32_t name_to_id(std::string) const;
 436
 437                 /* processing */
 438                 float  _dsp_load;
 439                 ARDOUR::DSPLoadCalculator  _dsp_load_calc;
 440                 uint64_t _processed_samples;
 441
 442                 pthread_t _main_thread;
 443                 pthread_t _freeewheel_thread;
 444
 445                 /* process threads */
 446                 static void* coreaudio_process_thread (void *);
 447                 std::vector<pthread_t> _threads;
 448
 449                 struct ThreadData {
 450                         CoreAudioBackend* engine;
 451                         boost::function<void ()> f;
 452                         size_t stacksize;
 453
 454                         ThreadData (CoreAudioBackend* e, boost::function<void ()> fp, size_t stacksz)
 455                                 : engine (e) , f (fp) , stacksize (stacksz) {}
 456                 };
 457
 458                 /* port engine */
 459                 PortHandle add_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
 460                 int register_system_audio_ports ();
 461                 void unregister_ports (bool system_only = false);
 462
 463                 std::vector<CoreBackendPort *> _ports;
 464                 std::vector<CoreBackendPort *> _system_inputs;
 465                 std::vector<CoreBackendPort *> _system_outputs;
 466                 std::vector<CoreBackendPort *> _system_midi_in;
 467                 std::vector<CoreBackendPort *> _system_midi_out;
 468
 469                 struct PortConnectData {
 470                         std::string a;
 471                         std::string b;
 472                         bool c;
 473
 474                         PortConnectData (const std::string& a, const std::string& b, bool c)
 475                                 : a (a) , b (b) , c (c) {}
 476                 };
 477
 478                 std::vector<PortConnectData *> _port_connection_queue;
 479                 pthread_mutex_t _port_callback_mutex;
 480                 bool _port_change_flag;
 481
 482                 void port_connect_callback (const std::string& a, const std::string& b, bool conn) {
 483                         pthread_mutex_lock (&_port_callback_mutex);
 484                         _port_connection_queue.push_back(new PortConnectData(a, b, conn));
 485                         pthread_mutex_unlock (&_port_callback_mutex);
 486                 }
 487
 488                 void port_connect_add_remove_callback () {
 489                         pthread_mutex_lock (&_port_callback_mutex);
 490                         _port_change_flag = true;
 491                         pthread_mutex_unlock (&_port_callback_mutex);
 492                 }
 493
 494                 bool valid_port (PortHandle port) const {
 495                         return std::find (_ports.begin (), _ports.end (), (CoreBackendPort*)port) != _ports.end ();
 496                 }
 497
 498                 CoreBackendPort * find_port (const std::string& port_name) const {
 499                         for (std::vector<CoreBackendPort*>::const_iterator it = _ports.begin (); it != _ports.end (); ++it) {
 500                                 if ((*it)->name () == port_name) {
 501                                         return *it;
 502                                 }
 503                         }
 504                         return NULL;
 505                 }
 506
 507                 CoreBackendPort * find_port_in (std::vector<CoreBackendPort *> plist, const std::string& port_name) const {
 508                         for (std::vector<CoreBackendPort*>::const_iterator it = plist.begin (); it != plist.end (); ++it) {
 509                                 if ((*it)->name () == port_name) {
 510                                         return *it;
 511                                 }
 512                         }
 513                         return NULL;
 514                 }
 515
 516         void reset_midi_parsers ();
 517
 518 }; // class CoreAudioBackend
 519
 520 } // namespace
 521
 522 #endif /* __libbackend_coreaudio_backend_h__ */