libs/backends/alsa/alsa_audiobackend.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_alsa_audiobackend_h__
  21 #define __libbackend_alsa_audiobackend_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/system_exec.h"
  36 #include "ardour/types.h"
  37
  38 #include "ardouralsautil/deviceinfo.h"
  39
  40 #include "zita-alsa-pcmi.h"
  41 #include "alsa_rawmidi.h"
  42 #include "alsa_sequencer.h"
  43
  44 namespace ARDOUR {
  45
  46 class AlsaAudioBackend;
  47
  48 class AlsaMidiEvent {
  49         public:
  50                 AlsaMidiEvent (const pframes_t timestamp, const uint8_t* data, size_t size);
  51                 AlsaMidiEvent (const AlsaMidiEvent& other);
  52                 ~AlsaMidiEvent ();
  53                 size_t size () const { return _size; };
  54                 pframes_t timestamp () const { return _timestamp; };
  55                 const unsigned char* const_data () const { return _data; };
  56                 unsigned char* data () { return _data; };
  57                 bool operator< (const AlsaMidiEvent &other) const { return timestamp () < other.timestamp (); };
  58         private:
  59                 size_t _size;
  60                 pframes_t _timestamp;
  61                 uint8_t *_data;
  62 };
  63
  64 typedef std::vector<boost::shared_ptr<AlsaMidiEvent> > AlsaMidiBuffer;
  65
  66 class AlsaPort {
  67         protected:
  68                 AlsaPort (AlsaAudioBackend &b, const std::string&, PortFlags);
  69         public:
  70                 virtual ~AlsaPort ();
  71
  72                 const std::string& name () const { return _name; }
  73                 PortFlags flags () const { return _flags; }
  74
  75                 int set_name (const std::string &name) { _name = name; return 0; }
  76
  77                 virtual DataType type () const = 0;
  78
  79                 bool is_input ()     const { return flags () & IsInput; }
  80                 bool is_output ()    const { return flags () & IsOutput; }
  81                 bool is_physical ()  const { return flags () & IsPhysical; }
  82                 bool is_terminal ()  const { return flags () & IsTerminal; }
  83                 bool is_connected () const { return _connections.size () != 0; }
  84                 bool is_connected (const AlsaPort *port) const;
  85                 bool is_physically_connected () const;
  86
  87                 const std::vector<AlsaPort *>& get_connections () const { return _connections; }
  88
  89                 int connect (AlsaPort *port);
  90                 int disconnect (AlsaPort *port);
  91                 void disconnect_all ();
  92
  93                 virtual void* get_buffer (pframes_t nframes) = 0;
  94
  95                 const LatencyRange latency_range (bool for_playback) const
  96                 {
  97                         return for_playback ? _playback_latency_range : _capture_latency_range;
  98                 }
  99
 100                 void set_latency_range (const LatencyRange &latency_range, bool for_playback)
 101                 {
 102                         if (for_playback)
 103                         {
 104                                 _playback_latency_range = latency_range;
 105                         }
 106                         else
 107                         {
 108                                 _capture_latency_range = latency_range;
 109                         }
 110                 }
 111
 112         private:
 113                 AlsaAudioBackend &_alsa_backend;
 114                 std::string _name;
 115                 const PortFlags _flags;
 116                 LatencyRange _capture_latency_range;
 117                 LatencyRange _playback_latency_range;
 118                 std::vector<AlsaPort*> _connections;
 119
 120                 void _connect (AlsaPort* , bool);
 121                 void _disconnect (AlsaPort* , bool);
 122
 123 }; // class AlsaPort
 124
 125 class AlsaAudioPort : public AlsaPort {
 126         public:
 127                 AlsaAudioPort (AlsaAudioBackend &b, const std::string&, PortFlags);
 128                 ~AlsaAudioPort ();
 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 AlsaAudioPort
 139
 140 class AlsaMidiPort : public AlsaPort {
 141         public:
 142                 AlsaMidiPort (AlsaAudioBackend &b, const std::string&, PortFlags);
 143                 ~AlsaMidiPort ();
 144
 145                 DataType type () const { return DataType::MIDI; };
 146
 147                 void* get_buffer (pframes_t nframes);
 148                 const AlsaMidiBuffer * 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         private:
 154                 AlsaMidiBuffer _buffer[2];
 155                 int _n_periods;
 156                 int _bufperiod;
 157 }; // class AlsaMidiPort
 158
 159 class AlsaAudioBackend : public AudioBackend {
 160         friend class AlsaPort;
 161         public:
 162                 AlsaAudioBackend (AudioEngine& e, AudioBackendInfo& info);
 163                 ~AlsaAudioBackend ();
 164
 165                 /* AUDIOBACKEND API */
 166
 167                 std::string name () const;
 168                 bool is_realtime () const;
 169
 170                 bool use_separate_input_and_output_devices () const { return true; }
 171                 std::vector<DeviceStatus> enumerate_devices () const;
 172                 std::vector<DeviceStatus> enumerate_input_devices () const;
 173                 std::vector<DeviceStatus> enumerate_output_devices () const;
 174                 std::vector<float> available_sample_rates (const std::string& device) const;
 175                 std::vector<float> available_sample_rates2 (const std::string&, const std::string&) const;
 176                 std::vector<uint32_t> available_buffer_sizes (const std::string& device) const;
 177                 std::vector<uint32_t> available_buffer_sizes2 (const std::string&, const std::string&) const;
 178                 uint32_t available_input_channel_count (const std::string& device) const;
 179                 uint32_t available_output_channel_count (const std::string& device) const;
 180
 181                 bool can_change_sample_rate_when_running () const;
 182                 bool can_change_buffer_size_when_running () const;
 183
 184                 int set_device_name (const std::string&);
 185                 int set_input_device_name (const std::string&);
 186                 int set_output_device_name (const std::string&);
 187                 int set_sample_rate (float);
 188                 int set_buffer_size (uint32_t);
 189                 int set_interleaved (bool yn);
 190                 int set_input_channels (uint32_t);
 191                 int set_output_channels (uint32_t);
 192                 int set_systemic_input_latency (uint32_t);
 193                 int set_systemic_output_latency (uint32_t);
 194                 int set_systemic_midi_input_latency (std::string const, uint32_t);
 195                 int set_systemic_midi_output_latency (std::string const, uint32_t);
 196
 197                 int reset_device () { return 0; };
 198
 199                 /* Retrieving parameters */
 200                 std::string  device_name () const;
 201                 std::string  input_device_name () const;
 202                 std::string  output_device_name () const;
 203                 float        sample_rate () const;
 204                 uint32_t     buffer_size () const;
 205                 bool         interleaved () const;
 206                 uint32_t     input_channels () const;
 207                 uint32_t     output_channels () const;
 208                 uint32_t     systemic_input_latency () const;
 209                 uint32_t     systemic_output_latency () const;
 210                 uint32_t     systemic_midi_input_latency (std::string const) const;
 211                 uint32_t     systemic_midi_output_latency (std::string const) const;
 212
 213                 bool can_set_systemic_midi_latencies () const { return true; }
 214
 215                 /* External control app */
 216                 std::string control_app_name () const { return std::string (); }
 217                 void launch_control_app () {}
 218
 219                 /* MIDI */
 220                 std::vector<std::string> enumerate_midi_options () const;
 221                 int set_midi_option (const std::string&);
 222                 std::string midi_option () const;
 223
 224                 std::vector<DeviceStatus> enumerate_midi_devices () const;
 225                 int set_midi_device_enabled (std::string const, bool);
 226                 bool midi_device_enabled (std::string const) const;
 227
 228                 /* State Control */
 229         protected:
 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
 260                 int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&) const;
 261
 262                 DataType port_data_type (PortHandle) const;
 263
 264                 PortHandle register_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
 265                 void unregister_port (PortHandle);
 266
 267                 int  connect (const std::string& src, const std::string& dst);
 268                 int  disconnect (const std::string& src, const std::string& dst);
 269                 int  connect (PortHandle, const std::string&);
 270                 int  disconnect (PortHandle, const std::string&);
 271                 int  disconnect_all (PortHandle);
 272
 273                 bool connected (PortHandle, bool process_callback_safe);
 274                 bool connected_to (PortHandle, const std::string&, bool process_callback_safe);
 275                 bool physically_connected (PortHandle, bool process_callback_safe);
 276                 int  get_connections (PortHandle, std::vector<std::string>&, bool process_callback_safe);
 277
 278                 /* MIDI */
 279                 int midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index);
 280                 int midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
 281                 uint32_t get_midi_event_count (void* port_buffer);
 282                 void     midi_clear (void* port_buffer);
 283
 284                 /* Monitoring */
 285
 286                 bool can_monitor_input () const;
 287                 int  request_input_monitoring (PortHandle, bool);
 288                 int  ensure_input_monitoring (PortHandle, bool);
 289                 bool monitoring_input (PortHandle);
 290
 291                 /* Latency management */
 292
 293                 void         set_latency_range (PortHandle, bool for_playback, LatencyRange);
 294                 LatencyRange get_latency_range (PortHandle, bool for_playback);
 295
 296                 /* Discovering physical ports */
 297
 298                 bool      port_is_physical (PortHandle) const;
 299                 void      get_physical_outputs (DataType type, std::vector<std::string>&);
 300                 void      get_physical_inputs (DataType type, std::vector<std::string>&);
 301                 ChanCount n_physical_outputs () const;
 302                 ChanCount n_physical_inputs () const;
 303
 304                 /* Getting access to the data buffer for a port */
 305
 306                 void* get_buffer (PortHandle, pframes_t);
 307
 308                 void* main_process_thread ();
 309
 310         private:
 311                 std::string _instance_name;
 312                 Alsa_pcmi *_pcmi;
 313
 314                 bool  _run; /* keep going or stop, ardour thread */
 315                 bool  _active; /* is running, process thread */
 316                 bool  _freewheel;
 317                 bool  _freewheeling;
 318                 bool  _measure_latency;
 319
 320                 uint64_t _last_process_start;
 321
 322                 static std::vector<std::string> _midi_options;
 323                 static std::vector<AudioBackend::DeviceStatus> _input_audio_device_status;
 324                 static std::vector<AudioBackend::DeviceStatus> _output_audio_device_status;
 325                 static std::vector<AudioBackend::DeviceStatus> _duplex_audio_device_status;
 326                 static std::vector<AudioBackend::DeviceStatus> _midi_device_status;
 327                 static ARDOUR::ALSADeviceInfo _input_audio_device_info;
 328                 static ARDOUR::ALSADeviceInfo _output_audio_device_info;
 329
 330                 mutable std::string _input_audio_device;
 331                 mutable std::string _output_audio_device;
 332                 std::string _midi_driver_option;
 333
 334                 /* audio device reservation */
 335                 ARDOUR::SystemExec *_device_reservation;
 336                 PBD::ScopedConnectionList _reservation_connection;
 337                 void reservation_stdout (std::string, size_t);
 338                 bool acquire_device(const char* device_name);
 339                 void release_device();
 340                 bool _reservation_succeeded;
 341
 342                 /* audio settings */
 343                 float  _samplerate;
 344                 size_t _samples_per_period;
 345                 size_t _periods_per_cycle;
 346                 static size_t _max_buffer_size;
 347
 348                 uint32_t _n_inputs;
 349                 uint32_t _n_outputs;
 350
 351                 uint32_t _systemic_audio_input_latency;
 352                 uint32_t _systemic_audio_output_latency;
 353
 354                 /* midi settings */
 355                 struct AlsaMidiDeviceInfo {
 356                         bool     enabled;
 357                         uint32_t systemic_input_latency;
 358                         uint32_t systemic_output_latency;
 359                         AlsaMidiDeviceInfo()
 360                                 : enabled (true)
 361                                 , systemic_input_latency (0)
 362                                 , systemic_output_latency (0)
 363                         {}
 364                 };
 365
 366                 mutable std::map<std::string, struct AlsaMidiDeviceInfo *> _midi_devices;
 367                 struct AlsaMidiDeviceInfo * midi_device_info(std::string const) const;
 368
 369                 /* processing */
 370                 float  _dsp_load;
 371                 ARDOUR::DSPLoadCalculator  _dsp_load_calc;
 372                 framecnt_t _processed_samples;
 373                 pthread_t _main_thread;
 374
 375                 /* process threads */
 376                 static void* alsa_process_thread (void *);
 377                 std::vector<pthread_t> _threads;
 378
 379                 struct ThreadData {
 380                         AlsaAudioBackend* engine;
 381                         boost::function<void ()> f;
 382                         size_t stacksize;
 383
 384                         ThreadData (AlsaAudioBackend* e, boost::function<void ()> fp, size_t stacksz)
 385                                 : engine (e) , f (fp) , stacksize (stacksz) {}
 386                 };
 387
 388                 /* port engine */
 389                 PortHandle add_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
 390                 int register_system_audio_ports ();
 391                 int register_system_midi_ports ();
 392                 void unregister_ports (bool system_only = false);
 393
 394                 std::vector<AlsaPort *> _ports;
 395                 std::vector<AlsaPort *> _system_inputs;
 396                 std::vector<AlsaPort *> _system_outputs;
 397                 std::vector<AlsaPort *> _system_midi_in;
 398                 std::vector<AlsaPort *> _system_midi_out;
 399
 400                 std::vector<AlsaMidiOut *> _rmidi_out;
 401                 std::vector<AlsaMidiIn  *> _rmidi_in;
 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 (), (AlsaPort*)port) != _ports.end ();
 430                 }
 431
 432                 AlsaPort * find_port (const std::string& port_name) const {
 433                         for (std::vector<AlsaPort*>::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 }; // class AlsaAudioBackend
 442
 443 } // namespace
 444
 445 #endif /* __libbackend_alsa_audiobackend_h__ */