Add API to enforce valid device selection.
[ardour.git] / libs / backends / alsa / alsa_audiobackend.h
index 98d3aaa13f9261e3e4ad6542817a889027aae9e8..bc2620ed9e6ce173c90967eb217c7a9fea5e8669 100644 (file)
 
 #include <boost/shared_ptr.hpp>
 
+#include "pbd/natsort.h"
 #include "ardour/audio_backend.h"
+#include "ardour/dsp_load_calculator.h"
 #include "ardour/system_exec.h"
 #include "ardour/types.h"
 
+#include "ardouralsautil/deviceinfo.h"
+
 #include "zita-alsa-pcmi.h"
 #include "alsa_rawmidi.h"
+#include "alsa_sequencer.h"
 
 namespace ARDOUR {
 
@@ -66,9 +71,11 @@ class AlsaPort {
                virtual ~AlsaPort ();
 
                const std::string& name () const { return _name; }
+               const std::string& pretty_name () const { return _pretty_name; }
                PortFlags flags () const { return _flags; }
 
                int set_name (const std::string &name) { _name = name; return 0; }
+               int set_pretty_name (const std::string &name) { _pretty_name = name; return 0; }
 
                virtual DataType type () const = 0;
 
@@ -80,7 +87,7 @@ class AlsaPort {
                bool is_connected (const AlsaPort *port) const;
                bool is_physically_connected () const;
 
-               const std::vector<AlsaPort *>& get_connections () const { return _connections; }
+               const std::set<AlsaPort *>& get_connections () const { return _connections; }
 
                int connect (AlsaPort *port);
                int disconnect (AlsaPort *port);
@@ -88,7 +95,7 @@ class AlsaPort {
 
                virtual void* get_buffer (pframes_t nframes) = 0;
 
-               const LatencyRange& latency_range (bool for_playback) const
+               const LatencyRange latency_range (bool for_playback) const
                {
                        return for_playback ? _playback_latency_range : _capture_latency_range;
                }
@@ -108,10 +115,11 @@ class AlsaPort {
        private:
                AlsaAudioBackend &_alsa_backend;
                std::string _name;
+               std::string _pretty_name;
                const PortFlags _flags;
                LatencyRange _capture_latency_range;
                LatencyRange _playback_latency_range;
-               std::vector<AlsaPort*> _connections;
+               std::set<AlsaPort*> _connections;
 
                void _connect (AlsaPort* , bool);
                void _disconnect (AlsaPort* , bool);
@@ -141,10 +149,15 @@ class AlsaMidiPort : public AlsaPort {
                DataType type () const { return DataType::MIDI; };
 
                void* get_buffer (pframes_t nframes);
-               const AlsaMidiBuffer const_buffer () const { return _buffer; }
+               const AlsaMidiBuffer * const_buffer () const { return & _buffer[_bufperiod]; }
+
+               void next_period() { if (_n_periods > 1) { get_buffer(0); _bufperiod = (_bufperiod + 1) % _n_periods; } }
+               void set_n_periods(int n) { if (n > 0 && n < 4) { _n_periods = n; } }
 
        private:
-               AlsaMidiBuffer _buffer;
+               AlsaMidiBuffer _buffer[3];
+               int _n_periods;
+               int _bufperiod;
 }; // class AlsaMidiPort
 
 class AlsaAudioBackend : public AudioBackend {
@@ -158,33 +171,58 @@ class AlsaAudioBackend : public AudioBackend {
                std::string name () const;
                bool is_realtime () const;
 
+               bool use_separate_input_and_output_devices () const { return true; }
+               bool match_input_output_devices_or_none () const { return true; }
+               bool can_set_period_size () const { return true; }
+
                std::vector<DeviceStatus> enumerate_devices () const;
+               std::vector<DeviceStatus> enumerate_input_devices () const;
+               std::vector<DeviceStatus> enumerate_output_devices () const;
                std::vector<float> available_sample_rates (const std::string& device) const;
+               std::vector<float> available_sample_rates2 (const std::string&, const std::string&) const;
                std::vector<uint32_t> available_buffer_sizes (const std::string& device) const;
+               std::vector<uint32_t> available_buffer_sizes2 (const std::string&, const std::string&) const;
+               std::vector<uint32_t> available_period_sizes (const std::string& driver) const;
                uint32_t available_input_channel_count (const std::string& device) const;
                uint32_t available_output_channel_count (const std::string& device) const;
 
                bool can_change_sample_rate_when_running () const;
                bool can_change_buffer_size_when_running () const;
 
+               bool can_change_systemic_latency_when_running () const { return true; }
+
                int set_device_name (const std::string&);
+               int set_input_device_name (const std::string&);
+               int set_output_device_name (const std::string&);
                int set_sample_rate (float);
                int set_buffer_size (uint32_t);
+               int set_peridod_size (uint32_t);
                int set_interleaved (bool yn);
                int set_input_channels (uint32_t);
                int set_output_channels (uint32_t);
                int set_systemic_input_latency (uint32_t);
                int set_systemic_output_latency (uint32_t);
+               int set_systemic_midi_input_latency (std::string const, uint32_t);
+               int set_systemic_midi_output_latency (std::string const, uint32_t);
+
+               int reset_device () { return 0; };
 
                /* Retrieving parameters */
                std::string  device_name () const;
+               std::string  input_device_name () const;
+               std::string  output_device_name () const;
                float        sample_rate () const;
                uint32_t     buffer_size () const;
+               uint32_t     period_size () const;
                bool         interleaved () const;
                uint32_t     input_channels () const;
                uint32_t     output_channels () const;
                uint32_t     systemic_input_latency () const;
                uint32_t     systemic_output_latency () const;
+               uint32_t     systemic_midi_input_latency (std::string const) const;
+               uint32_t     systemic_midi_output_latency (std::string const) const;
+
+               bool can_set_systemic_midi_latencies () const { return true; }
 
                /* External control app */
                std::string control_app_name () const { return std::string (); }
@@ -195,6 +233,10 @@ class AlsaAudioBackend : public AudioBackend {
                int set_midi_option (const std::string&);
                std::string midi_option () const;
 
+               std::vector<DeviceStatus> enumerate_midi_devices () const;
+               int set_midi_device_enabled (std::string const, bool);
+               bool midi_device_enabled (std::string const) const;
+
                /* State Control */
        protected:
                int _start (bool for_latency_measurement);
@@ -205,8 +247,8 @@ class AlsaAudioBackend : public AudioBackend {
                size_t raw_buffer_size (DataType t);
 
                /* Process time */
-               pframes_t sample_time ();
-               pframes_t sample_time_at_cycle_start ();
+               framepos_t sample_time ();
+               framepos_t sample_time_at_cycle_start ();
                pframes_t samples_since_cycle_start ();
 
                int create_process_thread (boost::function<void()> func);
@@ -227,6 +269,9 @@ class AlsaAudioBackend : public AudioBackend {
                std::string get_port_name (PortHandle) const;
                PortHandle  get_port_by_name (const std::string&) const;
 
+               int get_port_property (PortHandle, const std::string& key, std::string& value, std::string& type) const;
+               int set_port_property (PortHandle, const std::string& key, const std::string& value, const std::string& type);
+
                int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&) const;
 
                DataType port_data_type (PortHandle) const;
@@ -283,11 +328,23 @@ class AlsaAudioBackend : public AudioBackend {
 
                bool  _run; /* keep going or stop, ardour thread */
                bool  _active; /* is running, process thread */
+               bool  _freewheel;
                bool  _freewheeling;
+               bool  _measure_latency;
+
+               uint64_t _last_process_start;
 
-               void enumerate_midi_devices (std::vector<std::string> &) const;
-               std::string _audio_device;
-               std::string _midi_device;
+               static std::vector<std::string> _midi_options;
+               static std::vector<AudioBackend::DeviceStatus> _input_audio_device_status;
+               static std::vector<AudioBackend::DeviceStatus> _output_audio_device_status;
+               static std::vector<AudioBackend::DeviceStatus> _duplex_audio_device_status;
+               static std::vector<AudioBackend::DeviceStatus> _midi_device_status;
+               static ARDOUR::ALSADeviceInfo _input_audio_device_info;
+               static ARDOUR::ALSADeviceInfo _output_audio_device_info;
+
+               mutable std::string _input_audio_device;
+               mutable std::string _output_audio_device;
+               std::string _midi_driver_option;
 
                /* audio device reservation */
                ARDOUR::SystemExec *_device_reservation;
@@ -297,10 +354,10 @@ class AlsaAudioBackend : public AudioBackend {
                void release_device();
                bool _reservation_succeeded;
 
+               /* audio settings */
                float  _samplerate;
                size_t _samples_per_period;
                size_t _periods_per_cycle;
-               float  _dsp_load;
                static size_t _max_buffer_size;
 
                uint32_t _n_inputs;
@@ -308,11 +365,26 @@ class AlsaAudioBackend : public AudioBackend {
 
                uint32_t _systemic_audio_input_latency;
                uint32_t _systemic_audio_output_latency;
-               uint32_t _systemic_midi_input_latency;
-               uint32_t _systemic_midi_output_latency;
 
-               uint64_t _processed_samples;
+               /* midi settings */
+               struct AlsaMidiDeviceInfo {
+                       bool     enabled;
+                       uint32_t systemic_input_latency;
+                       uint32_t systemic_output_latency;
+                       AlsaMidiDeviceInfo()
+                               : enabled (true)
+                               , systemic_input_latency (0)
+                               , systemic_output_latency (0)
+                       {}
+               };
+
+               mutable std::map<std::string, struct AlsaMidiDeviceInfo *> _midi_devices;
+               struct AlsaMidiDeviceInfo * midi_device_info(std::string const) const;
 
+               /* processing */
+               float  _dsp_load;
+               ARDOUR::DSPLoadCalculator  _dsp_load_calc;
+               framecnt_t _processed_samples;
                pthread_t _main_thread;
 
                /* process threads */
@@ -331,17 +403,32 @@ class AlsaAudioBackend : public AudioBackend {
                /* port engine */
                PortHandle add_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
                int register_system_audio_ports ();
-               int register_system_midi_ports ();
-               void unregister_system_ports ();
+               int register_system_midi_ports (const std::string device = "");
+               void unregister_ports (bool system_only = false);
 
-               std::vector<AlsaPort *> _ports;
                std::vector<AlsaPort *> _system_inputs;
                std::vector<AlsaPort *> _system_outputs;
                std::vector<AlsaPort *> _system_midi_in;
                std::vector<AlsaPort *> _system_midi_out;
 
-               std::vector<AlsaRawMidiOut *> _rmidi_out;
-               std::vector<AlsaRawMidiIn  *> _rmidi_in;
+               struct SortByPortName
+               {
+                       bool operator ()(const AlsaPort* lhs, const AlsaPort* rhs) const
+                       {
+                               return PBD::naturally_less (lhs->name ().c_str (), rhs->name ().c_str ());
+                       }
+               };
+
+               typedef std::map<std::string, AlsaPort *> PortMap; // fast lookup in _ports
+               typedef std::set<AlsaPort *, SortByPortName> PortIndex; // fast lookup in _ports
+               PortMap _portmap;
+               PortIndex _ports;
+
+               std::vector<AlsaMidiOut *> _rmidi_out;
+               std::vector<AlsaMidiIn  *> _rmidi_in;
+
+               unsigned _midi_ins;
+               unsigned _midi_outs;
 
                struct PortConnectData {
                        std::string a;
@@ -369,18 +456,20 @@ class AlsaAudioBackend : public AudioBackend {
                }
 
                bool valid_port (PortHandle port) const {
-                       return std::find (_ports.begin (), _ports.end (), (AlsaPort*)port) != _ports.end ();
+                       return std::find (_ports.begin(), _ports.end(), static_cast<AlsaPort*>(port)) != _ports.end ();
                }
 
-               AlsaPort * find_port (const std::string& port_name) const {
-                       for (std::vector<AlsaPort*>::const_iterator it = _ports.begin (); it != _ports.end (); ++it) {
-                               if ((*it)->name () == port_name) {
-                                       return *it;
-                               }
+               AlsaPort* find_port (const std::string& port_name) const {
+                       PortMap::const_iterator it = _portmap.find (port_name);
+                       if (it == _portmap.end()) {
+                               return NULL;
                        }
-                       return NULL;
+                       return (*it).second;
                }
 
+               void update_systemic_audio_latencies ();
+               void update_systemic_midi_latencies ();
+
 }; // class AlsaAudioBackend
 
 } // namespace