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