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                 std::vector<DeviceStatus> enumerate_devices () const;
 169                 std::vector<float> available_sample_rates (const std::string& device) const;
 170                 std::vector<uint32_t> available_buffer_sizes (const std::string& device) const;
 171                 uint32_t available_input_channel_count (const std::string& device) const;
 172                 uint32_t available_output_channel_count (const std::string& device) const;
 173
 174                 bool can_change_sample_rate_when_running () const;
 175                 bool can_change_buffer_size_when_running () const;
 176
 177                 int set_device_name (const std::string&);
 178                 int set_sample_rate (float);
 179                 int set_buffer_size (uint32_t);
 180                 int set_interleaved (bool yn);
 181                 int set_input_channels (uint32_t);
 182                 int set_output_channels (uint32_t);
 183                 int set_systemic_input_latency (uint32_t);
 184                 int set_systemic_output_latency (uint32_t);
 185                 int set_systemic_midi_input_latency (std::string const, uint32_t);
 186                 int set_systemic_midi_output_latency (std::string const, uint32_t);
 187
 188                 int reset_device () { return 0; };
 189
 190                 /* Retrieving parameters */
 191                 std::string  device_name () const;
 192                 float        sample_rate () const;
 193                 uint32_t     buffer_size () const;
 194                 bool         interleaved () const;
 195                 uint32_t     input_channels () const;
 196                 uint32_t     output_channels () const;
 197                 uint32_t     systemic_input_latency () const;
 198                 uint32_t     systemic_output_latency () const;
 199                 uint32_t     systemic_midi_input_latency (std::string const) const;
 200                 uint32_t     systemic_midi_output_latency (std::string const) const;
 201
 202                 bool can_set_systemic_midi_latencies () const { return false; /* XXX */}
 203
 204                 /* External control app */
 205                 std::string control_app_name () const { return std::string ("Apple"); }
 206                 void launch_control_app ();
 207
 208                 /* MIDI */
 209                 std::vector<std::string> enumerate_midi_options () const;
 210                 int set_midi_option (const std::string&);
 211                 std::string midi_option () const;
 212
 213                 std::vector<DeviceStatus> enumerate_midi_devices () const;
 214                 int set_midi_device_enabled (std::string const, bool);
 215                 bool midi_device_enabled (std::string const) const;
 216
 217                 // really private, but needing static access:
 218                 int process_callback();
 219                 void error_callback();
 220                 void xrun_callback();
 221                 void buffer_size_callback();
 222                 void sample_rate_callback();
 223                 void hw_changed_callback();
 224
 225         protected:
 226                 /* State Control */
 227                 int _start (bool for_latency_measurement);
 228         public:
 229                 int stop ();
 230                 int freewheel (bool);
 231                 float dsp_load () const;
 232                 size_t raw_buffer_size (DataType t);
 233
 234                 /* Process time */
 235                 framepos_t sample_time ();
 236                 framepos_t sample_time_at_cycle_start ();
 237                 pframes_t samples_since_cycle_start ();
 238
 239                 int create_process_thread (boost::function<void()> func);
 240                 int join_process_threads ();
 241                 bool in_process_thread ();
 242                 uint32_t process_thread_count ();
 243
 244                 void update_latencies ();
 245
 246                 /* PORTENGINE API */
 247
 248                 void* private_handle () const;
 249                 const std::string& my_name () const;
 250                 bool available () const;
 251                 uint32_t port_name_size () const;
 252
 253                 int         set_port_name (PortHandle, const std::string&);
 254                 std::string get_port_name (PortHandle) const;
 255                 PortHandle  get_port_by_name (const std::string&) const;
 256                 int get_port_property (PortHandle, const std::string& key, std::string& value, std::string& type) const;
 257
 258                 int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&) const;
 259
 260                 DataType port_data_type (PortHandle) const;
 261
 262                 PortHandle register_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
 263                 void unregister_port (PortHandle);
 264
 265                 int  connect (const std::string& src, const std::string& dst);
 266                 int  disconnect (const std::string& src, const std::string& dst);
 267                 int  connect (PortHandle, const std::string&);
 268                 int  disconnect (PortHandle, const std::string&);
 269                 int  disconnect_all (PortHandle);
 270
 271                 bool connected (PortHandle, bool process_callback_safe);
 272                 bool connected_to (PortHandle, const std::string&, bool process_callback_safe);
 273                 bool physically_connected (PortHandle, bool process_callback_safe);
 274                 int  get_connections (PortHandle, std::vector<std::string>&, bool process_callback_safe);
 275
 276                 /* MIDI */
 277                 int midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index);
 278                 int midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
 279                 uint32_t get_midi_event_count (void* port_buffer);
 280                 void     midi_clear (void* port_buffer);
 281
 282                 /* Monitoring */
 283
 284                 bool can_monitor_input () const;
 285                 int  request_input_monitoring (PortHandle, bool);
 286                 int  ensure_input_monitoring (PortHandle, bool);
 287                 bool monitoring_input (PortHandle);
 288
 289                 /* Latency management */
 290
 291                 void         set_latency_range (PortHandle, bool for_playback, LatencyRange);
 292                 LatencyRange get_latency_range (PortHandle, bool for_playback);
 293
 294                 /* Discovering physical ports */
 295
 296                 bool      port_is_physical (PortHandle) const;
 297                 void      get_physical_outputs (DataType type, std::vector<std::string>&);
 298                 void      get_physical_inputs (DataType type, std::vector<std::string>&);
 299                 ChanCount n_physical_outputs () const;
 300                 ChanCount n_physical_inputs () const;
 301
 302                 /* Getting access to the data buffer for a port */
 303
 304                 void* get_buffer (PortHandle, pframes_t);
 305
 306                 void* freewheel_thread ();
 307                 void pre_process ();
 308                 void coremidi_rediscover ();
 309
 310         private:
 311                 std::string _instance_name;
 312                 CoreAudioPCM *_pcmio;
 313                 CoreMidiIo *_midiio;
 314
 315                 bool  _run; /* keep going or stop, ardour thread */
 316                 bool  _active_ca; /* is running, process thread */
 317                 bool  _active_fw; /* is running, process thread */
 318                 bool  _preinit;
 319                 bool  _freewheeling;
 320                 bool  _freewheel;
 321                 bool  _freewheel_ack;
 322                 bool  _reinit_thread_callback;
 323                 bool  _measure_latency;
 324
 325                 pthread_mutex_t _process_callback_mutex;
 326
 327                 pthread_mutex_t _freewheel_mutex;
 328                 pthread_cond_t  _freewheel_signal;
 329
 330                 static std::vector<std::string> _midi_options;
 331                 static std::vector<AudioBackend::DeviceStatus> _audio_device_status;
 332                 static std::vector<AudioBackend::DeviceStatus> _midi_device_status;
 333
 334                 mutable std::string _audio_device;
 335                 std::string _midi_driver_option;
 336
 337                 /* audio settings */
 338                 float  _samplerate;
 339                 size_t _samples_per_period;
 340                 static size_t _max_buffer_size;
 341
 342                 uint32_t _n_inputs;
 343                 uint32_t _n_outputs;
 344
 345                 uint32_t _systemic_audio_input_latency;
 346                 uint32_t _systemic_audio_output_latency;
 347
 348                 /* coreaudio specific  */
 349                 uint32_t name_to_id(std::string) const;
 350
 351                 /* midi settings */
 352                 struct CoreMidiDeviceInfo {
 353                         bool     enabled;
 354                         uint32_t systemic_input_latency;
 355                         uint32_t systemic_output_latency;
 356                         CoreMidiDeviceInfo()
 357                                 : enabled (true)
 358                                 , systemic_input_latency (0)
 359                                 , systemic_output_latency (0)
 360                         {}
 361                 };
 362
 363                 mutable std::map<std::string, struct CoreMidiDeviceInfo *> _midi_devices;
 364                 struct CoreMidiDeviceInfo * midi_device_info(std::string const) const;
 365
 366                 /* processing */
 367                 float  _dsp_load;
 368                 uint64_t _processed_samples;
 369
 370                 pthread_t _main_thread;
 371                 pthread_t _freeewheel_thread;
 372
 373                 /* process threads */
 374                 static void* coreaudio_process_thread (void *);
 375                 std::vector<pthread_t> _threads;
 376
 377                 struct ThreadData {
 378                         CoreAudioBackend* engine;
 379                         boost::function<void ()> f;
 380                         size_t stacksize;
 381
 382                         ThreadData (CoreAudioBackend* e, boost::function<void ()> fp, size_t stacksz)
 383                                 : engine (e) , f (fp) , stacksize (stacksz) {}
 384                 };
 385
 386                 /* port engine */
 387                 PortHandle add_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
 388                 int register_system_audio_ports ();
 389                 void unregister_ports (bool system_only = false);
 390
 391                 std::vector<CoreBackendPort *> _ports;
 392                 std::vector<CoreBackendPort *> _system_inputs;
 393                 std::vector<CoreBackendPort *> _system_outputs;
 394                 std::vector<CoreBackendPort *> _system_midi_in;
 395                 std::vector<CoreBackendPort *> _system_midi_out;
 396
 397                 struct PortConnectData {
 398                         std::string a;
 399                         std::string b;
 400                         bool c;
 401
 402                         PortConnectData (const std::string& a, const std::string& b, bool c)
 403                                 : a (a) , b (b) , c (c) {}
 404                 };
 405
 406                 std::vector<PortConnectData *> _port_connection_queue;
 407                 pthread_mutex_t _port_callback_mutex;
 408                 bool _port_change_flag;
 409
 410                 void port_connect_callback (const std::string& a, const std::string& b, bool conn) {
 411                         pthread_mutex_lock (&_port_callback_mutex);
 412                         _port_connection_queue.push_back(new PortConnectData(a, b, conn));
 413                         pthread_mutex_unlock (&_port_callback_mutex);
 414                 }
 415
 416                 void port_connect_add_remove_callback () {
 417                         pthread_mutex_lock (&_port_callback_mutex);
 418                         _port_change_flag = true;
 419                         pthread_mutex_unlock (&_port_callback_mutex);
 420                 }
 421
 422                 bool valid_port (PortHandle port) const {
 423                         return std::find (_ports.begin (), _ports.end (), (CoreBackendPort*)port) != _ports.end ();
 424                 }
 425
 426                 CoreBackendPort * find_port (const std::string& port_name) const {
 427                         for (std::vector<CoreBackendPort*>::const_iterator it = _ports.begin (); it != _ports.end (); ++it) {
 428                                 if ((*it)->name () == port_name) {
 429                                         return *it;
 430                                 }
 431                         }
 432                         return NULL;
 433                 }
 434
 435                 CoreBackendPort * find_port_in (std::vector<CoreBackendPort *> plist, const std::string& port_name) const {
 436                         for (std::vector<CoreBackendPort*>::const_iterator it = plist.begin (); it != plist.end (); ++it) {
 437                                 if ((*it)->name () == port_name) {
 438                                         return *it;
 439                                 }
 440                         }
 441                         return NULL;
 442                 }
 443
 444 }; // class CoreAudioBackend
 445
 446 } // namespace
 447
 448 #endif /* __libbackend_coreaudio_backend_h__ */