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