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