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