libs/backends/jack/jack_audiobackend.h

   1 /*
   2     Copyright (C) 2013 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __libardour_jack_audiobackend_h__
  21 #define __libardour_jack_audiobackend_h__
  22
  23 #include <string>
  24 #include <vector>
  25 #include <map>
  26 #include <set>
  27
  28 #include <stdint.h>
  29
  30 #include <boost/shared_ptr.hpp>
  31
  32 #include "weak_libjack.h"
  33
  34 #include "ardour/audio_backend.h"
  35
  36 namespace ARDOUR {
  37
  38 class JackConnection;
  39 class JACKSession;
  40
  41 class JACKAudioBackend : public AudioBackend {
  42   public:
  43     JACKAudioBackend (AudioEngine& e, AudioBackendInfo& info, boost::shared_ptr<JackConnection>);
  44     ~JACKAudioBackend ();
  45
  46     /* AUDIOBACKEND API */
  47
  48     std::string name() const;
  49     void* private_handle() const;
  50     bool available() const;
  51     bool is_realtime () const;
  52
  53     bool requires_driver_selection() const;
  54     std::vector<std::string> enumerate_drivers () const;
  55     int set_driver (const std::string&);
  56
  57     std::vector<DeviceStatus> enumerate_devices () const;
  58
  59     std::vector<float> available_sample_rates (const std::string& device) const;
  60     std::vector<uint32_t> available_buffer_sizes (const std::string& device) const;
  61     std::vector<uint32_t> available_period_sizes (const std::string& driver) const;
  62     uint32_t available_input_channel_count (const std::string& device) const;
  63     uint32_t available_output_channel_count (const std::string& device) const;
  64
  65     bool can_change_sample_rate_when_running() const;
  66     bool can_change_buffer_size_when_running() const;
  67
  68     int set_device_name (const std::string&);
  69     int set_sample_rate (float);
  70     int set_buffer_size (uint32_t);
  71     int set_peridod_size (uint32_t);
  72     int set_interleaved (bool yn);
  73     int set_input_channels (uint32_t);
  74     int set_output_channels (uint32_t);
  75     int set_systemic_input_latency (uint32_t);
  76     int set_systemic_output_latency (uint32_t);
  77     int set_systemic_midi_input_latency (std::string const, uint32_t) { return 0; }
  78     int set_systemic_midi_output_latency (std::string const, uint32_t) { return 0; }
  79
  80     int reset_device ();
  81
  82     std::string  device_name () const;
  83     float        sample_rate () const;
  84     uint32_t     buffer_size () const;
  85     uint32_t     period_size () const;
  86     bool         interleaved () const;
  87     uint32_t     input_channels () const;
  88     uint32_t     output_channels () const;
  89     uint32_t     systemic_input_latency () const;
  90     uint32_t     systemic_output_latency () const;
  91     uint32_t     systemic_midi_input_latency (std::string const) const { return 0; }
  92     uint32_t     systemic_midi_output_latency (std::string const) const { return 0; }
  93     std::string  driver_name() const;
  94
  95     std::string control_app_name () const;
  96     void launch_control_app ();
  97
  98     int stop ();
  99     int freewheel (bool);
 100
 101     float dsp_load() const;
 102
 103     framepos_t sample_time ();
 104     framepos_t sample_time_at_cycle_start ();
 105     pframes_t samples_since_cycle_start ();
 106
 107     size_t raw_buffer_size (DataType t);
 108
 109     int create_process_thread (boost::function<void()> func);
 110     int join_process_threads ();
 111     bool in_process_thread ();
 112     uint32_t process_thread_count ();
 113
 114     void transport_start ();
 115     void transport_stop ();
 116     void transport_locate (framepos_t /*pos*/);
 117     TransportState transport_state () const;
 118     framepos_t transport_frame() const;
 119
 120     int set_time_master (bool /*yn*/);
 121     bool get_sync_offset (pframes_t& /*offset*/) const;
 122
 123     void update_latencies ();
 124
 125     static bool already_configured();
 126
 127     /* PORTENGINE API */
 128
 129     const std::string& my_name() const;
 130     uint32_t port_name_size() const;
 131
 132     int         set_port_name (PortHandle, const std::string&);
 133     std::string get_port_name (PortHandle) const;
 134     PortHandle  get_port_by_name (const std::string&) const;
 135     int get_port_property (PortHandle, const std::string& key, std::string& value, std::string& type) const;
 136     int set_port_property (PortHandle, const std::string& key, const std::string& value, const std::string& type);
 137
 138     int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&) const;
 139
 140     DataType port_data_type (PortHandle) const;
 141
 142     PortHandle register_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
 143     void  unregister_port (PortHandle);
 144
 145     bool  connected (PortHandle, bool process_callback_safe);
 146     bool  connected_to (PortHandle, const std::string&, bool process_callback_safe);
 147     bool  physically_connected (PortHandle, bool process_callback_safe);
 148     int   get_connections (PortHandle, std::vector<std::string>&, bool process_callback_safe);
 149     int   connect (PortHandle, const std::string&);
 150
 151     int   disconnect (PortHandle, const std::string&);
 152     int   disconnect_all (PortHandle);
 153     int   connect (const std::string& src, const std::string& dst);
 154     int   disconnect (const std::string& src, const std::string& dst);
 155
 156     /* MIDI */
 157
 158     std::vector<std::string> enumerate_midi_options () const;
 159     int set_midi_option (const std::string&);
 160     std::string midi_option () const;
 161
 162     std::vector<DeviceStatus> enumerate_midi_devices () const {
 163         return std::vector<AudioBackend::DeviceStatus> ();
 164     }
 165     int set_midi_device_enabled (std::string const, bool) {
 166         return 0;
 167     }
 168     bool midi_device_enabled (std::string const) const {
 169         return true;
 170     }
 171     bool can_set_systemic_midi_latencies () const {
 172         return false;
 173     }
 174     bool can_set_period_size () const {
 175         return true;
 176     }
 177
 178     int      midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index);
 179     int      midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
 180     uint32_t get_midi_event_count (void* port_buffer);
 181     void     midi_clear (void* port_buffer);
 182
 183     /* Monitoring */
 184
 185     bool  can_monitor_input() const;
 186     int   request_input_monitoring (PortHandle, bool);
 187     int   ensure_input_monitoring (PortHandle, bool);
 188     bool  monitoring_input (PortHandle);
 189
 190     /* Latency management
 191      */
 192
 193     void          set_latency_range (PortHandle, bool for_playback, LatencyRange);
 194     LatencyRange  get_latency_range (PortHandle, bool for_playback);
 195
 196     /* Physical ports */
 197
 198     bool      port_is_physical (PortHandle) const;
 199     void      get_physical_outputs (DataType type, std::vector<std::string>&);
 200     void      get_physical_inputs (DataType type, std::vector<std::string>&);
 201     ChanCount n_physical_outputs () const;
 202     ChanCount n_physical_inputs () const;
 203
 204     /* Getting access to the data buffer for a port */
 205
 206     void* get_buffer (PortHandle, pframes_t);
 207
 208     /* transport sync */
 209
 210     bool speed_and_position (double& sp, framepos_t& pos);
 211
 212   private:
 213     boost::shared_ptr<JackConnection>  _jack_connection;
 214     bool            _running;
 215     bool            _freewheeling;
 216     std::map<DataType,size_t> _raw_buffer_sizes;
 217
 218     std::vector<jack_native_thread_t> _jack_threads;
 219     jack_native_thread_t _main_thread;
 220
 221     static int  _xrun_callback (void *arg);
 222     static void* _process_thread (void *arg);
 223     static int  _sample_rate_callback (pframes_t nframes, void *arg);
 224     static int  _bufsize_callback (pframes_t nframes, void *arg);
 225     static void _jack_timebase_callback (jack_transport_state_t, pframes_t, jack_position_t*, int, void*);
 226     static int  _jack_sync_callback (jack_transport_state_t, jack_position_t*, void *arg);
 227     static void _freewheel_callback (int , void *arg);
 228     static void _latency_callback (jack_latency_callback_mode_t, void*);
 229     static void _session_callback (jack_session_event_t *event, void *arg);
 230
 231     void jack_timebase_callback (jack_transport_state_t, pframes_t, jack_position_t*, int);
 232     int  jack_sync_callback (jack_transport_state_t, jack_position_t*);
 233     int  jack_bufsize_callback (pframes_t);
 234     int  jack_sample_rate_callback (pframes_t);
 235     void freewheel_callback (int);
 236     int  process_callback (pframes_t nframes);
 237     void jack_latency_callback (jack_latency_callback_mode_t);
 238     void disconnected (const char*);
 239
 240     void set_jack_callbacks ();
 241     int reconnect_to_jack ();
 242
 243     struct ThreadData {
 244         JACKAudioBackend* engine;
 245         boost::function<void()> f;
 246         size_t stacksize;
 247
 248         ThreadData (JACKAudioBackend* e, boost::function<void()> fp, size_t stacksz)
 249                 : engine (e) , f (fp) , stacksize (stacksz) {}
 250     };
 251
 252     void*  process_thread ();
 253     static void* _start_process_thread (void*);
 254
 255     void setup_jack_startup_command (bool for_latency_measurement);
 256
 257     /* pffooo */
 258
 259     std::string  _target_driver;
 260     std::string  _target_device;
 261     float        _target_sample_rate;
 262     uint32_t     _target_buffer_size;
 263     uint32_t     _target_num_periods;
 264     SampleFormat _target_sample_format;
 265     bool         _target_interleaved;
 266     uint32_t     _target_input_channels;
 267     uint32_t     _target_output_channels;
 268     uint32_t     _target_systemic_input_latency;
 269     uint32_t     _target_systemic_output_latency;
 270     uint32_t     _current_sample_rate;
 271     uint32_t     _current_buffer_size;
 272     std::string  _target_midi_option;
 273
 274     typedef std::set<std::string> DeviceList;
 275     typedef std::map<std::string,DeviceList> DriverDeviceMap;
 276
 277     mutable DriverDeviceMap all_devices;
 278
 279     PBD::ScopedConnection disconnect_connection;
 280
 281     /* PORTENGINE RELATED */
 282
 283     static int  _graph_order_callback (void *arg);
 284     static void _registration_callback (jack_port_id_t, int, void *);
 285     static void _connect_callback (jack_port_id_t, jack_port_id_t, int, void *);
 286
 287     void connect_callback (jack_port_id_t, jack_port_id_t, int);
 288
 289     ChanCount n_physical (unsigned long flags) const;
 290     void get_physical (DataType type, unsigned long flags, std::vector<std::string>& phy) const;
 291
 292     void when_connected_to_jack ();
 293     PBD::ScopedConnection jack_connection_connection;
 294
 295     /* Object to manage interactions with Session in a way that
 296        keeps JACK out of libardour directly
 297     */
 298
 299     JACKSession* _session;
 300
 301   protected:
 302     int _start (bool for_latency_measurement);
 303 };
 304
 305 } // namespace
 306
 307 #endif /* __ardour_audiobackend_h__ */
 308