libs/backends/wavesaudio/waves_audiobackend.h

   1 /*
   2     Copyright (C) 2014 Waves Audio Ltd.
   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_waves_audiobackend_h__
  21 #define __libardour_waves_audiobackend_h__
  22
  23 #include <string>
  24 #include <vector>
  25 #include <list>
  26
  27 #include <stdint.h>
  28 #include <stdlib.h>
  29
  30 #include <boost/function.hpp>
  31
  32 #include "ardour/types.h"
  33 #include "ardour/audio_backend.h"
  34
  35 #include "waves_midi_device_manager.h"
  36
  37 #ifdef __MACOS__
  38
  39 #include <WCMRCoreAudioDeviceManager.h>
  40
  41 class ArdourAudioDeviceManager : public WCMRCoreAudioDeviceManager
  42 {
  43   public:
  44     ArdourAudioDeviceManager (WCMRAudioDeviceManagerClient *client) : WCMRCoreAudioDeviceManager (client, eFullDuplexDevices, true, eCABS_Simple, false) {};
  45 };
  46
  47 #elif defined (_WINDOWS)
  48
  49 #include <WCMRPortAudioDeviceManager.h>
  50
  51 class ArdourAudioDeviceManager : public WCMRPortAudioDeviceManager
  52 {
  53   public:
  54     ArdourAudioDeviceManager (WCMRAudioDeviceManagerClient *client) : WCMRPortAudioDeviceManager (client, eFullDuplexDevices, paASIO) {};
  55 };
  56
  57 #endif
  58
  59 namespace ARDOUR {
  60
  61 class AudioEngine;
  62 class PortEngine;
  63 class PortManager;
  64 class WavesAudioBackend;
  65 class WavesDataPort;
  66 class WavesAudioPort;
  67 class WavesMidiPort;
  68
  69
  70     class WavesAudioBackend : public AudioBackend, WCMRAudioDeviceManagerClient
  71 {
  72   public:
  73     WavesAudioBackend (AudioEngine& e);
  74     virtual ~WavesAudioBackend ();
  75
  76     /* AUDIOBACKEND API */
  77
  78     virtual std::string name () const;
  79
  80     virtual bool is_realtime () const;
  81
  82     virtual bool requires_driver_selection () const;
  83
  84     virtual std::vector<std::string> enumerate_drivers () const;
  85
  86     virtual int set_driver (const std::string& /*drivername*/);
  87
  88     virtual std::vector<DeviceStatus> enumerate_devices () const;
  89
  90     virtual std::vector<float> available_sample_rates (const std::string& device) const;
  91
  92     virtual float default_sample_rate () const;
  93
  94     virtual std::vector<uint32_t> available_buffer_sizes (const std::string& device) const;
  95
  96     virtual uint32_t available_input_channel_count (const std::string& device) const;
  97
  98     virtual uint32_t available_output_channel_count (const std::string& device) const;
  99
 100     virtual bool can_change_sample_rate_when_running () const;
 101
 102     virtual bool can_change_buffer_size_when_running () const;
 103
 104     virtual int set_device_name (const std::string& name);
 105
 106     virtual int set_sample_rate (float);
 107
 108     virtual int set_buffer_size (uint32_t);
 109
 110     virtual int set_sample_format (SampleFormat);
 111
 112     virtual int set_interleaved (bool yn);
 113
 114     virtual int set_input_channels (uint32_t);
 115
 116     virtual int set_output_channels (uint32_t);
 117
 118     virtual int set_systemic_input_latency (uint32_t);
 119
 120     virtual int set_systemic_output_latency (uint32_t);
 121
 122     virtual std::string device_name () const;
 123
 124     virtual float sample_rate () const;
 125
 126     virtual uint32_t buffer_size () const;
 127
 128     virtual SampleFormat sample_format () const;
 129
 130     virtual bool interleaved () const;
 131
 132     virtual uint32_t input_channels () const;
 133
 134     virtual uint32_t output_channels () const;
 135
 136     virtual uint32_t systemic_input_latency () const;
 137
 138     virtual uint32_t systemic_output_latency () const;
 139
 140     virtual std::string control_app_name () const;
 141
 142     virtual void launch_control_app ();
 143
 144     virtual std::vector<std::string> enumerate_midi_options () const;
 145
 146     virtual int set_midi_option (const std::string& option);
 147
 148     virtual std::string midi_option () const;
 149
 150     virtual int _start (bool for_latency_measurement);
 151
 152     virtual int stop ();
 153
 154     virtual int freewheel (bool start_stop);
 155
 156     virtual float dsp_load () const ;
 157
 158     virtual void transport_start ();
 159
 160     virtual void transport_stop ();
 161
 162     virtual TransportState transport_state () const;
 163
 164     virtual void transport_locate (framepos_t pos);
 165
 166     virtual framepos_t transport_frame () const;
 167
 168     virtual int set_time_master (bool yn);
 169
 170     virtual int usecs_per_cycle () const;
 171
 172     virtual size_t raw_buffer_size (DataType data_type);
 173
 174     virtual pframes_t sample_time ();
 175
 176     virtual pframes_t sample_time_at_cycle_start ();
 177
 178     virtual pframes_t samples_since_cycle_start ();
 179
 180     virtual bool get_sync_offset (pframes_t& offset) const;
 181
 182     virtual int create_process_thread (boost::function<void ()> func);
 183
 184     virtual int join_process_threads ();
 185
 186     virtual bool in_process_thread ();
 187
 188     virtual uint32_t process_thread_count ();
 189
 190     virtual void update_latencies ();
 191
 192     virtual bool speed_and_position (double& speed, framepos_t& position) {
 193         speed = 0.0;
 194         position = 0;
 195         return false;
 196     }
 197
 198     /* PORTENGINE API */
 199
 200     virtual void* private_handle () const;
 201
 202     virtual const std::string& my_name () const;
 203
 204     virtual bool available () const;
 205
 206     virtual uint32_t port_name_size () const;
 207
 208     virtual int set_port_name (PortHandle port_handle, const std::string& port_name);
 209
 210     virtual std::string get_port_name (PortHandle port_handle ) const;
 211
 212     virtual PortHandle get_port_by_name (const std::string& port_name) const;
 213
 214     virtual int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>& port_handles) const;
 215
 216     virtual DataType port_data_type (PortHandle port_handle) const;
 217
 218     virtual PortHandle register_port (const std::string& shortname, ARDOUR::DataType type, ARDOUR::PortFlags flags);
 219
 220     virtual void unregister_port (PortHandle port_handle);
 221
 222     virtual int connect (const std::string& src, const std::string& dst);
 223
 224     virtual int disconnect (const std::string& src, const std::string& dst);
 225
 226     virtual int connect (PortHandle port_handle, const std::string& port_name);
 227
 228     virtual int disconnect (PortHandle port_handle, const std::string& port_name);
 229
 230     virtual int disconnect_all (PortHandle port_handle);
 231
 232     virtual bool connected (PortHandle port_handle, bool process_callback_safe);
 233
 234     virtual bool connected_to (PortHandle port_handle, const std::string& port_name, bool process_callback_safe);
 235
 236     virtual bool physically_connected (PortHandle port_handle, bool process_callback_safe);
 237
 238     virtual int get_connections (PortHandle port_handle, std::vector<std::string>&, bool process_callback_safe);
 239
 240     virtual int midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index);
 241
 242     virtual int midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
 243
 244     virtual uint32_t get_midi_event_count (void* port_buffer);
 245
 246     virtual void midi_clear (void* port_buffer);
 247
 248     virtual bool can_monitor_input () const;
 249
 250     virtual int request_input_monitoring (PortHandle port_handle, bool);
 251
 252     virtual int ensure_input_monitoring (PortHandle port_handle, bool);
 253
 254     virtual bool monitoring_input (PortHandle port_handle);
 255
 256     virtual void set_latency_range (PortHandle port_handle, bool for_playback, LatencyRange);
 257
 258     virtual LatencyRange get_latency_range (PortHandle port_handle, bool for_playback);
 259
 260     virtual bool port_is_physical (PortHandle port_handle) const;
 261
 262     virtual void get_physical_outputs (DataType type, std::vector<std::string>& port_names);
 263
 264     virtual void get_physical_inputs (DataType type, std::vector<std::string>& port_names);
 265
 266     virtual ChanCount n_physical_outputs () const;
 267
 268     virtual ChanCount n_physical_inputs () const;
 269
 270     virtual void* get_buffer (PortHandle port_handle, pframes_t frames);
 271
 272     static AudioBackendInfo& backend_info () { return __backend_info; }
 273
 274     virtual void AudioDeviceManagerNotification (NotificationReason reason, void* pParam);
 275
 276   private:
 277     //ArdourAudioDeviceManagerClient _audio_device_manager_client;
 278     ArdourAudioDeviceManager _audio_device_manager;
 279     WavesMidiDeviceManager _midi_device_manager;
 280
 281     WCMRAudioDevice *_device;
 282     SampleFormat _sample_format;
 283     bool _interleaved;
 284     static std::string __instantiated_name;
 285     uint32_t _input_channels;
 286     uint32_t _max_input_channels;
 287     uint32_t _output_channels;
 288     uint32_t _max_output_channels;
 289     float _sample_rate;
 290     uint32_t _buffer_size;
 291     uint32_t _systemic_input_latency;
 292     uint32_t _systemic_output_latency;
 293     bool _call_thread_init_callback;
 294     std::vector<pthread_t> _backend_threads;
 295     static const size_t __max_raw_midi_buffer_size;
 296
 297     static const std::vector<std::string> __available_midi_options;
 298     bool  _use_midi;
 299
 300     struct ThreadData {
 301         WavesAudioBackend* engine;
 302         boost::function<void ()> f;
 303         size_t stacksize;
 304
 305         ThreadData (WavesAudioBackend* e, boost::function<void ()> fp, size_t stacksz)
 306             : engine (e) , f (fp) , stacksize (stacksz) {}
 307     };
 308
 309     static boost::shared_ptr<AudioBackend>    __waves_backend_factory (AudioEngine& e);
 310     static int __instantiate (const std::string& arg1, const std::string& arg2);
 311     static int __deinstantiate ();
 312     static bool __already_configured ();
 313
 314     static void* __start_process_thread (void*);
 315     static uint64_t __get_time_nanos ();
 316
 317     static size_t __thread_stack_size ();
 318
 319     void _audio_device_callback (const float* input_audio_buffer,
 320                                  float* output_buffer,
 321                                  unsigned long nframes,
 322                                  pframes_t sample_time,
 323                                  uint64_t cycle_start_time_nanos);
 324
 325     void _changed_midi_devices ();
 326
 327     int _register_system_audio_ports ();
 328     int _register_system_midi_ports ();
 329
 330     int _read_midi_data_from_devices ();
 331     int _write_midi_data_to_devices (pframes_t);
 332
 333     pframes_t _ms_to_sample_time (int32_t time_ms) const;
 334     int32_t _sample_time_to_ms (pframes_t sample_time) const ;
 335
 336     void _read_audio_data_from_device (const float* input_buffer, pframes_t nframes);
 337     void _write_audio_data_to_device (float* output_buffer, pframes_t nframes);
 338
 339     void _unregister_system_audio_ports ();
 340     void _unregister_system_midi_ports ();
 341
 342     WavesDataPort* _register_port (const std::string& port_name, ARDOUR::DataType type, ARDOUR::PortFlags flags);
 343     inline bool _registered (PortHandle  port_handle) const
 344     {
 345         return std::find (_ports.begin (), _ports.end (), (WavesDataPort*)port_handle) != _ports.end ();
 346     }
 347
 348     WavesDataPort* _find_port (const std::string& port_name) const;
 349     void _freewheel_thread ();
 350
 351     std::vector<WavesAudioPort*> _physical_audio_inputs;
 352     std::vector<WavesAudioPort*> _physical_audio_outputs;
 353     std::vector<WavesMidiPort*> _physical_midi_inputs;
 354     std::vector<WavesMidiPort*> _physical_midi_outputs;
 355     std::vector<WavesDataPort*> _ports;
 356     static AudioBackendInfo __backend_info;
 357
 358 #if defined (_WINDOWS)
 359         static uint64_t __performance_counter_frequency;
 360 #endif
 361         uint64_t _cycle_start_time_nanos;
 362     pframes_t _sample_time_at_cycle_start;
 363
 364     bool _freewheeling;
 365     bool _freewheel_thread_active;
 366
 367     friend class WavesMidiDeviceManager;
 368
 369     std::list<uint64_t> _dsp_load_history;
 370     size_t _dsp_load_history_length;
 371     uint64_t _dsp_load_accumulator;
 372     float _audio_cycle_period_nanos;
 373     void _init_dsp_load_history();
 374 };
 375
 376 } // namespace
 377
 378 #endif /* __libardour_waves_audiobackend_h__ */
 379