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