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