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
 182                 /* Retrieving parameters */
 183                 std::string  device_name () const;
 184                 float        sample_rate () const;
 185                 uint32_t     buffer_size () const;
 186                 bool         interleaved () const;
 187                 uint32_t     input_channels () const;
 188                 uint32_t     output_channels () const;
 189                 uint32_t     systemic_input_latency () const;
 190                 uint32_t     systemic_output_latency () const;
 191
 192                 /* External control app */
 193                 std::string control_app_name () const { return std::string (); }
 194                 void launch_control_app () {}
 195
 196                 /* MIDI */
 197                 std::vector<std::string> enumerate_midi_options () const;
 198                 int set_midi_option (const std::string&);
 199                 std::string midi_option () const;
 200
 201                 /* State Control */
 202         protected:
 203                 int _start (bool for_latency_measurement);
 204         public:
 205                 int stop ();
 206                 int freewheel (bool);
 207                 float dsp_load () const;
 208                 size_t raw_buffer_size (DataType t);
 209
 210                 /* Process time */
 211                 pframes_t sample_time ();
 212                 pframes_t sample_time_at_cycle_start ();
 213                 pframes_t samples_since_cycle_start ();
 214
 215                 int create_process_thread (boost::function<void()> func);
 216                 int join_process_threads ();
 217                 bool in_process_thread ();
 218                 uint32_t process_thread_count ();
 219
 220                 void update_latencies ();
 221
 222                 /* PORTENGINE API */
 223
 224                 void* private_handle () const;
 225                 const std::string& my_name () const;
 226                 bool available () const;
 227                 uint32_t port_name_size () const;
 228
 229                 int         set_port_name (PortHandle, const std::string&);
 230                 std::string get_port_name (PortHandle) const;
 231                 PortHandle  get_port_by_name (const std::string&) const;
 232
 233                 int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&) const;
 234
 235                 DataType port_data_type (PortHandle) const;
 236
 237                 PortHandle register_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
 238                 void unregister_port (PortHandle);
 239
 240                 int  connect (const std::string& src, const std::string& dst);
 241                 int  disconnect (const std::string& src, const std::string& dst);
 242                 int  connect (PortHandle, const std::string&);
 243                 int  disconnect (PortHandle, const std::string&);
 244                 int  disconnect_all (PortHandle);
 245
 246                 bool connected (PortHandle, bool process_callback_safe);
 247                 bool connected_to (PortHandle, const std::string&, bool process_callback_safe);
 248                 bool physically_connected (PortHandle, bool process_callback_safe);
 249                 int  get_connections (PortHandle, std::vector<std::string>&, bool process_callback_safe);
 250
 251                 /* MIDI */
 252                 int midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index);
 253                 int midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
 254                 uint32_t get_midi_event_count (void* port_buffer);
 255                 void     midi_clear (void* port_buffer);
 256
 257                 /* Monitoring */
 258
 259                 bool can_monitor_input () const;
 260                 int  request_input_monitoring (PortHandle, bool);
 261                 int  ensure_input_monitoring (PortHandle, bool);
 262                 bool monitoring_input (PortHandle);
 263
 264                 /* Latency management */
 265
 266                 void         set_latency_range (PortHandle, bool for_playback, LatencyRange);
 267                 LatencyRange get_latency_range (PortHandle, bool for_playback);
 268
 269                 /* Discovering physical ports */
 270
 271                 bool      port_is_physical (PortHandle) const;
 272                 void      get_physical_outputs (DataType type, std::vector<std::string>&);
 273                 void      get_physical_inputs (DataType type, std::vector<std::string>&);
 274                 ChanCount n_physical_outputs () const;
 275                 ChanCount n_physical_inputs () const;
 276
 277                 /* Getting access to the data buffer for a port */
 278
 279                 void* get_buffer (PortHandle, pframes_t);
 280
 281                 void* main_process_thread ();
 282
 283         private:
 284                 std::string _instance_name;
 285                 Alsa_pcmi *_pcmi;
 286
 287                 bool  _run; /* keep going or stop, ardour thread */
 288                 bool  _active; /* is running, process thread */
 289                 bool  _freewheeling;
 290
 291                 void enumerate_midi_devices (std::vector<std::string> &) const;
 292                 std::string _audio_device;
 293                 std::string _midi_device;
 294
 295                 /* audio device reservation */
 296                 ARDOUR::SystemExec *_device_reservation;
 297                 PBD::ScopedConnectionList _reservation_connection;
 298                 void reservation_stdout (std::string, size_t);
 299                 bool acquire_device(const char* device_name);
 300                 void release_device();
 301                 bool _reservation_succeeded;
 302
 303                 float  _samplerate;
 304                 size_t _samples_per_period;
 305                 size_t _periods_per_cycle;
 306                 float  _dsp_load;
 307                 static size_t _max_buffer_size;
 308
 309                 uint32_t _n_inputs;
 310                 uint32_t _n_outputs;
 311
 312                 uint32_t _systemic_audio_input_latency;
 313                 uint32_t _systemic_audio_output_latency;
 314                 uint32_t _systemic_midi_input_latency;
 315                 uint32_t _systemic_midi_output_latency;
 316
 317                 uint64_t _processed_samples;
 318
 319                 pthread_t _main_thread;
 320
 321                 /* process threads */
 322                 static void* alsa_process_thread (void *);
 323                 std::vector<pthread_t> _threads;
 324
 325                 struct ThreadData {
 326                         AlsaAudioBackend* engine;
 327                         boost::function<void ()> f;
 328                         size_t stacksize;
 329
 330                         ThreadData (AlsaAudioBackend* e, boost::function<void ()> fp, size_t stacksz)
 331                                 : engine (e) , f (fp) , stacksize (stacksz) {}
 332                 };
 333
 334                 /* port engine */
 335                 PortHandle add_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
 336                 int register_system_audio_ports ();
 337                 int register_system_midi_ports ();
 338                 void unregister_system_ports ();
 339
 340                 std::vector<AlsaPort *> _ports;
 341                 std::vector<AlsaPort *> _system_inputs;
 342                 std::vector<AlsaPort *> _system_outputs;
 343                 std::vector<AlsaPort *> _system_midi_in;
 344                 std::vector<AlsaPort *> _system_midi_out;
 345
 346                 std::vector<AlsaRawMidiOut *> _rmidi_out;
 347                 std::vector<AlsaRawMidiIn  *> _rmidi_in;
 348
 349                 struct PortConnectData {
 350                         std::string a;
 351                         std::string b;
 352                         bool c;
 353
 354                         PortConnectData (const std::string& a, const std::string& b, bool c)
 355                                 : a (a) , b (b) , c (c) {}
 356                 };
 357
 358                 std::vector<PortConnectData *> _port_connection_queue;
 359                 pthread_mutex_t _port_callback_mutex;
 360                 bool _port_change_flag;
 361
 362                 void port_connect_callback (const std::string& a, const std::string& b, bool conn) {
 363                         pthread_mutex_lock (&_port_callback_mutex);
 364                         _port_connection_queue.push_back(new PortConnectData(a, b, conn));
 365                         pthread_mutex_unlock (&_port_callback_mutex);
 366                 }
 367
 368                 void port_connect_add_remove_callback () {
 369                         pthread_mutex_lock (&_port_callback_mutex);
 370                         _port_change_flag = true;
 371                         pthread_mutex_unlock (&_port_callback_mutex);
 372                 }
 373
 374                 bool valid_port (PortHandle port) const {
 375                         return std::find (_ports.begin (), _ports.end (), (AlsaPort*)port) != _ports.end ();
 376                 }
 377
 378                 AlsaPort * find_port (const std::string& port_name) const {
 379                         for (std::vector<AlsaPort*>::const_iterator it = _ports.begin (); it != _ports.end (); ++it) {
 380                                 if ((*it)->name () == port_name) {
 381                                         return *it;
 382                                 }
 383                         }
 384                         return NULL;
 385                 }
 386
 387 }; // class AlsaAudioBackend
 388
 389 } // namespace
 390
 391 #endif /* __libbackend_alsa_audiobackend_h__ */