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