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 <jack/jack.h>
  33 #include <jack/session.h>
  34
  35 #include "ardour/audio_backend.h"
  36
  37 namespace ARDOUR {
  38
  39 class JackConnection;
  40 class JACKSession;
  41
  42 class JACKAudioBackend : public AudioBackend {
  43   public:
  44     JACKAudioBackend (AudioEngine& e, AudioBackendInfo& info, boost::shared_ptr<JackConnection>);
  45     ~JACKAudioBackend ();
  46
  47     /* AUDIOBACKEND API */
  48
  49     std::string name() const;
  50     void* private_handle() const;
  51     bool available() const;
  52     bool is_realtime () const;
  53
  54     bool requires_driver_selection() const;
  55     std::vector<std::string> enumerate_drivers () const;
  56     int set_driver (const std::string&);
  57
  58     std::vector<DeviceStatus> enumerate_devices () const;
  59
  60     std::vector<float> available_sample_rates (const std::string& device) const;
  61     std::vector<uint32_t> available_buffer_sizes (const std::string& device) 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_interleaved (bool yn);
  72     int set_input_channels (uint32_t);
  73     int set_output_channels (uint32_t);
  74     int set_systemic_input_latency (uint32_t);
  75     int set_systemic_output_latency (uint32_t);
  76     int set_systemic_midi_input_latency (std::string const, uint32_t) { return 0; }
  77     int set_systemic_midi_output_latency (std::string const, uint32_t) { return 0; }
  78
  79     int reset_device ();
  80
  81     std::string  device_name () const;
  82     float        sample_rate () const;
  83     uint32_t     buffer_size () const;
  84     bool         interleaved () const;
  85     uint32_t     input_channels () const;
  86     uint32_t     output_channels () const;
  87     uint32_t     systemic_input_latency () const;
  88     uint32_t     systemic_output_latency () const;
  89     uint32_t     systemic_midi_input_latency (std::string const) const { return 0; }
  90     uint32_t     systemic_midi_output_latency (std::string const) const { return 0; }
  91     std::string  driver_name() const;
  92
  93     std::string control_app_name () const;
  94     void launch_control_app ();
  95
  96     int stop ();
  97     int freewheel (bool);
  98
  99     float dsp_load() const;
 100
 101     pframes_t sample_time ();
 102     pframes_t sample_time_at_cycle_start ();
 103     pframes_t samples_since_cycle_start ();
 104
 105     size_t raw_buffer_size (DataType t);
 106
 107     int create_process_thread (boost::function<void()> func);
 108     int join_process_threads ();
 109     bool in_process_thread ();
 110     uint32_t process_thread_count ();
 111
 112     void transport_start ();
 113     void transport_stop ();
 114     void transport_locate (framepos_t /*pos*/);
 115     TransportState transport_state () const;
 116     framepos_t transport_frame() const;
 117
 118     int set_time_master (bool /*yn*/);
 119     bool get_sync_offset (pframes_t& /*offset*/) const;
 120
 121     void update_latencies ();
 122
 123     static bool already_configured();
 124
 125     /* PORTENGINE API */
 126
 127     const std::string& my_name() const;
 128     uint32_t port_name_size() const;
 129
 130     int         set_port_name (PortHandle, const std::string&);
 131     std::string get_port_name (PortHandle) const;
 132     PortHandle  get_port_by_name (const std::string&) const;
 133
 134     int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&) const;
 135
 136     DataType port_data_type (PortHandle) const;
 137
 138     PortHandle register_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
 139     void  unregister_port (PortHandle);
 140
 141     bool  connected (PortHandle, bool process_callback_safe);
 142     bool  connected_to (PortHandle, const std::string&, bool process_callback_safe);
 143     bool  physically_connected (PortHandle, bool process_callback_safe);
 144     int   get_connections (PortHandle, std::vector<std::string>&, bool process_callback_safe);
 145     int   connect (PortHandle, const std::string&);
 146
 147     int   disconnect (PortHandle, const std::string&);
 148     int   disconnect_all (PortHandle);
 149     int   connect (const std::string& src, const std::string& dst);
 150     int   disconnect (const std::string& src, const std::string& dst);
 151
 152     /* MIDI */
 153
 154     std::vector<std::string> enumerate_midi_options () const;
 155     int set_midi_option (const std::string&);
 156     std::string midi_option () const;
 157
 158     std::vector<DeviceStatus> enumerate_midi_devices () const {
 159         return std::vector<AudioBackend::DeviceStatus> ();
 160     }
 161     int set_midi_device_enabled (std::string const, bool) {
 162         return 0;
 163     }
 164     bool midi_device_enabled (std::string const) const {
 165         return true;
 166     }
 167     bool can_set_systemic_midi_latencies () const {
 168         return false;
 169     }
 170
 171     int      midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index);
 172     int      midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
 173     uint32_t get_midi_event_count (void* port_buffer);
 174     void     midi_clear (void* port_buffer);
 175
 176     /* Monitoring */
 177
 178     bool  can_monitor_input() const;
 179     int   request_input_monitoring (PortHandle, bool);
 180     int   ensure_input_monitoring (PortHandle, bool);
 181     bool  monitoring_input (PortHandle);
 182
 183     /* Latency management
 184      */
 185
 186     void          set_latency_range (PortHandle, bool for_playback, LatencyRange);
 187     LatencyRange  get_latency_range (PortHandle, bool for_playback);
 188
 189     /* Physical ports */
 190
 191     bool      port_is_physical (PortHandle) const;
 192     void      get_physical_outputs (DataType type, std::vector<std::string>&);
 193     void      get_physical_inputs (DataType type, std::vector<std::string>&);
 194     ChanCount n_physical_outputs () const;
 195     ChanCount n_physical_inputs () const;
 196
 197     /* Getting access to the data buffer for a port */
 198
 199     void* get_buffer (PortHandle, pframes_t);
 200
 201     /* transport sync */
 202
 203     bool speed_and_position (double& sp, framepos_t& pos);
 204
 205   private:
 206     boost::shared_ptr<JackConnection>  _jack_connection;
 207     bool            _running;
 208     bool            _freewheeling;
 209     std::map<DataType,size_t> _raw_buffer_sizes;
 210
 211     std::vector<jack_native_thread_t> _jack_threads;
 212
 213     static int  _xrun_callback (void *arg);
 214     static void* _process_thread (void *arg);
 215     static int  _sample_rate_callback (pframes_t nframes, void *arg);
 216     static int  _bufsize_callback (pframes_t nframes, void *arg);
 217     static void _jack_timebase_callback (jack_transport_state_t, pframes_t, jack_position_t*, int, void*);
 218     static int  _jack_sync_callback (jack_transport_state_t, jack_position_t*, void *arg);
 219     static void _freewheel_callback (int , void *arg);
 220     static void _latency_callback (jack_latency_callback_mode_t, void*);
 221     static void _session_callback (jack_session_event_t *event, void *arg);
 222
 223     void jack_timebase_callback (jack_transport_state_t, pframes_t, jack_position_t*, int);
 224     int  jack_sync_callback (jack_transport_state_t, jack_position_t*);
 225     int  jack_bufsize_callback (pframes_t);
 226     int  jack_sample_rate_callback (pframes_t);
 227     void freewheel_callback (int);
 228     int  process_callback (pframes_t nframes);
 229     void jack_latency_callback (jack_latency_callback_mode_t);
 230     void disconnected (const char*);
 231
 232     void set_jack_callbacks ();
 233     int reconnect_to_jack ();
 234
 235     struct ThreadData {
 236         JACKAudioBackend* engine;
 237         boost::function<void()> f;
 238         size_t stacksize;
 239
 240         ThreadData (JACKAudioBackend* e, boost::function<void()> fp, size_t stacksz)
 241                 : engine (e) , f (fp) , stacksize (stacksz) {}
 242     };
 243
 244     void*  process_thread ();
 245     static void* _start_process_thread (void*);
 246
 247     void setup_jack_startup_command (bool for_latency_measurement);
 248
 249     /* pffooo */
 250
 251     std::string  _target_driver;
 252     std::string  _target_device;
 253     float        _target_sample_rate;
 254     uint32_t     _target_buffer_size;
 255     SampleFormat _target_sample_format;
 256     bool         _target_interleaved;
 257     uint32_t     _target_input_channels;
 258     uint32_t     _target_output_channels;
 259     uint32_t     _target_systemic_input_latency;
 260     uint32_t     _target_systemic_output_latency;
 261     uint32_t     _current_sample_rate;
 262     uint32_t     _current_buffer_size;
 263     std::string  _target_midi_option;
 264
 265     typedef std::set<std::string> DeviceList;
 266     typedef std::map<std::string,DeviceList> DriverDeviceMap;
 267
 268     mutable DriverDeviceMap all_devices;
 269
 270     PBD::ScopedConnection disconnect_connection;
 271
 272     /* PORTENGINE RELATED */
 273
 274     static int  _graph_order_callback (void *arg);
 275     static void _registration_callback (jack_port_id_t, int, void *);
 276     static void _connect_callback (jack_port_id_t, jack_port_id_t, int, void *);
 277
 278     void connect_callback (jack_port_id_t, jack_port_id_t, int);
 279
 280     ChanCount n_physical (unsigned long flags) const;
 281     void get_physical (DataType type, unsigned long flags, std::vector<std::string>& phy) const;
 282
 283     void when_connected_to_jack ();
 284     PBD::ScopedConnection jack_connection_connection;
 285
 286     /* Object to manage interactions with Session in a way that
 287        keeps JACK out of libardour directly
 288     */
 289
 290     JACKSession* _session;
 291
 292   protected:
 293     int _start (bool for_latency_measurement);
 294 };
 295
 296 } // namespace
 297
 298 #endif /* __ardour_audiobackend_h__ */
 299