libs/backends/wavesaudio/waves_audiobackend.h

   1 /*
   2     Copyright (C) 2013 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 __APPLE__
  38
  39 #include <WCMRCoreAudioDeviceManager.h>
  40
  41 class ArdourAudioDeviceManager : public WCMRCoreAudioDeviceManager
  42 {
  43   public:
  44     ArdourAudioDeviceManager (WCMRAudioDeviceManagerClient *client) : WCMRCoreAudioDeviceManager (client, eAllDevices) {};
  45 };
  46
  47 #elif defined (PLATFORM_WINDOWS)
  48
  49 #include <WCMRPortAudioDeviceManager.h>
  50
  51 class ArdourAudioDeviceManager : public WCMRPortAudioDeviceManager
  52 {
  53   public:
  54     ArdourAudioDeviceManager (WCMRAudioDeviceManagerClient *client) : WCMRPortAudioDeviceManager (client, eAllDevices) {};
  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 default_buffer_size (const std::string& device) const;
  97
  98     virtual uint32_t available_input_channel_count (const std::string& device) const;
  99
 100     virtual uint32_t available_output_channel_count (const std::string& device) const;
 101
 102     virtual bool can_change_sample_rate_when_running () const;
 103
 104     virtual bool can_change_buffer_size_when_running () const;
 105
 106     virtual int set_device_name (const std::string& name);
 107
 108         virtual int drop_device();
 109
 110     virtual int set_sample_rate (float);
 111
 112     virtual int set_buffer_size (uint32_t);
 113
 114     virtual int set_sample_format (SampleFormat);
 115
 116     virtual int set_interleaved (bool yn);
 117
 118     virtual int set_input_channels (uint32_t);
 119
 120     virtual int set_output_channels (uint32_t);
 121
 122     virtual int set_systemic_input_latency (uint32_t);
 123
 124     virtual int set_systemic_output_latency (uint32_t);
 125
 126     int set_systemic_midi_input_latency (std::string const, uint32_t) { return 0; }
 127     int set_systemic_midi_output_latency (std::string const, uint32_t) { return 0; }
 128
 129     virtual int reset_device ();
 130
 131     virtual std::string device_name () const;
 132
 133     virtual float sample_rate () const;
 134
 135     virtual uint32_t buffer_size () const;
 136
 137     virtual SampleFormat sample_format () const;
 138
 139     virtual bool interleaved () const;
 140
 141     virtual uint32_t input_channels () const;
 142
 143     virtual uint32_t output_channels () const;
 144
 145     virtual uint32_t systemic_input_latency () const;
 146
 147     virtual uint32_t systemic_output_latency () const;
 148
 149     uint32_t systemic_midi_input_latency (std::string const) const { return 0; }
 150
 151     uint32_t systemic_midi_output_latency (std::string const) const { return 0; }
 152
 153     virtual std::string control_app_name () const;
 154
 155     virtual void launch_control_app ();
 156
 157     virtual std::vector<std::string> enumerate_midi_options () const;
 158
 159     virtual int set_midi_option (const std::string& option);
 160
 161     virtual std::string midi_option () const;
 162
 163     std::vector<DeviceStatus> enumerate_midi_devices () const {
 164         return std::vector<AudioBackend::DeviceStatus> ();
 165     }
 166     int set_midi_device_enabled (std::string const, bool) {
 167         return 0;
 168     }
 169     bool midi_device_enabled (std::string const) const {
 170         return true;
 171     }
 172     bool can_set_systemic_midi_latencies () const {
 173         return false;
 174     }
 175
 176     virtual int _start (bool for_latency_measurement);
 177
 178     virtual int stop ();
 179
 180     virtual int freewheel (bool start_stop);
 181
 182     virtual float dsp_load () const ;
 183
 184     virtual void transport_start ();
 185
 186     virtual void transport_stop ();
 187
 188     virtual TransportState transport_state () const;
 189
 190     virtual void transport_locate (framepos_t pos);
 191
 192     virtual framepos_t transport_frame () const;
 193
 194     virtual int set_time_master (bool yn);
 195
 196     virtual int usecs_per_cycle () const;
 197
 198     virtual size_t raw_buffer_size (DataType data_type);
 199
 200     virtual framepos_t sample_time ();
 201
 202     virtual framepos_t sample_time_at_cycle_start ();
 203
 204     virtual pframes_t samples_since_cycle_start ();
 205
 206     virtual bool get_sync_offset (pframes_t& offset) const;
 207
 208     virtual int create_process_thread (boost::function<void ()> func);
 209
 210     virtual int join_process_threads ();
 211
 212     virtual bool in_process_thread ();
 213
 214     virtual uint32_t process_thread_count ();
 215
 216     virtual void update_latencies ();
 217
 218     virtual bool speed_and_position (double& speed, framepos_t& position) {
 219         speed = 0.0;
 220         position = 0;
 221         return false;
 222     }
 223
 224     /* PORTENGINE API */
 225
 226     virtual void* private_handle () const;
 227
 228     virtual const std::string& my_name () const;
 229
 230     virtual bool available () const;
 231
 232     virtual uint32_t port_name_size () const;
 233
 234     virtual int set_port_name (PortHandle port_handle, const std::string& port_name);
 235
 236     virtual std::string get_port_name (PortHandle port_handle ) const;
 237
 238     virtual PortHandle get_port_by_name (const std::string& port_name) const;
 239
 240     virtual int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>& port_handles) const;
 241
 242     virtual DataType port_data_type (PortHandle port_handle) const;
 243
 244     virtual PortHandle register_port (const std::string& shortname, ARDOUR::DataType type, ARDOUR::PortFlags flags);
 245
 246     virtual void unregister_port (PortHandle port_handle);
 247
 248     virtual int connect (const std::string& src, const std::string& dst);
 249
 250     virtual int disconnect (const std::string& src, const std::string& dst);
 251
 252     virtual int connect (PortHandle port_handle, const std::string& port_name);
 253
 254     virtual int disconnect (PortHandle port_handle, const std::string& port_name);
 255
 256     virtual int disconnect_all (PortHandle port_handle);
 257
 258     virtual bool connected (PortHandle port_handle, bool process_callback_safe);
 259
 260     virtual bool connected_to (PortHandle port_handle, const std::string& port_name, bool process_callback_safe);
 261
 262     virtual bool physically_connected (PortHandle port_handle, bool process_callback_safe);
 263
 264     virtual int get_connections (PortHandle port_handle, std::vector<std::string>&, bool process_callback_safe);
 265
 266     virtual int midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index);
 267
 268     virtual int midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
 269
 270     virtual uint32_t get_midi_event_count (void* port_buffer);
 271
 272     virtual void midi_clear (void* port_buffer);
 273
 274     virtual bool can_monitor_input () const;
 275
 276     virtual int request_input_monitoring (PortHandle port_handle, bool);
 277
 278     virtual int ensure_input_monitoring (PortHandle port_handle, bool);
 279
 280     virtual bool monitoring_input (PortHandle port_handle);
 281
 282     virtual void set_latency_range (PortHandle port_handle, bool for_playback, LatencyRange);
 283
 284     virtual LatencyRange get_latency_range (PortHandle port_handle, bool for_playback);
 285
 286     virtual bool port_is_physical (PortHandle port_handle) const;
 287
 288     virtual void get_physical_outputs (DataType type, std::vector<std::string>& port_names);
 289
 290     virtual void get_physical_inputs (DataType type, std::vector<std::string>& port_names);
 291
 292     virtual ChanCount n_physical_outputs () const;
 293
 294     virtual ChanCount n_physical_inputs () const;
 295
 296     virtual void* get_buffer (PortHandle port_handle, pframes_t frames);
 297
 298     static AudioBackendInfo& backend_info () { return __backend_info; }
 299
 300     virtual void AudioDeviceManagerNotification (NotificationReason reason, void* pParam);
 301
 302   private:
 303     //ArdourAudioDeviceManagerClient _audio_device_manager_client;
 304     ArdourAudioDeviceManager _audio_device_manager;
 305     WavesMidiDeviceManager _midi_device_manager;
 306
 307     WCMRAudioDevice *_device;
 308     SampleFormat _sample_format;
 309     bool _interleaved;
 310     static std::string __instantiated_name;
 311     uint32_t _input_channels;
 312     uint32_t _max_input_channels;
 313     uint32_t _output_channels;
 314     uint32_t _max_output_channels;
 315     float _sample_rate;
 316     uint32_t _buffer_size;
 317     uint32_t _systemic_input_latency;
 318     uint32_t _systemic_output_latency;
 319     bool _call_thread_init_callback;
 320     std::vector<pthread_t> _backend_threads;
 321     pthread_t _main_thread;
 322     static const size_t __max_raw_midi_buffer_size;
 323
 324     static const std::vector<std::string> __available_midi_options;
 325     bool  _use_midi;
 326
 327     struct ThreadData {
 328         WavesAudioBackend* engine;
 329         boost::function<void ()> f;
 330         size_t stacksize;
 331
 332         ThreadData (WavesAudioBackend* e, boost::function<void ()> fp, size_t stacksz)
 333             : engine (e) , f (fp) , stacksize (stacksz) {}
 334     };
 335
 336     static boost::shared_ptr<AudioBackend>    __waves_backend_factory (AudioEngine& e);
 337     static int __instantiate (const std::string& arg1, const std::string& arg2);
 338     static int __deinstantiate ();
 339     static bool __already_configured ();
 340     static bool __available ();
 341
 342     static void* __start_process_thread (void*);
 343     static uint64_t __get_time_nanos ();
 344
 345     static size_t __thread_stack_size ();
 346
 347     void _audio_device_callback (const float* input_audio_buffer,
 348                                  float* output_buffer,
 349                                  unsigned long nframes,
 350                                  framepos_t sample_time,
 351                                  uint64_t cycle_start_time_nanos);
 352
 353     void _changed_midi_devices ();
 354
 355         // DO change sample rate and buffer size
 356         int _buffer_size_change(uint32_t new_buffer_size);
 357         int _sample_rate_change(float new_sample_rate);
 358
 359     int _register_system_audio_ports ();
 360     int _register_system_midi_ports ();
 361
 362     int _read_midi_data_from_devices ();
 363     int _write_midi_data_to_devices (pframes_t);
 364
 365     pframes_t _ms_to_sample_time (int32_t time_ms) const;
 366     int32_t _sample_time_to_ms (pframes_t sample_time) const ;
 367
 368     void _read_audio_data_from_device (const float* input_buffer, pframes_t nframes);
 369     void _write_audio_data_to_device (float* output_buffer, pframes_t nframes);
 370
 371     void _unregister_system_audio_ports ();
 372     void _unregister_system_midi_ports ();
 373
 374     WavesDataPort* _register_port (const std::string& port_name, ARDOUR::DataType type, ARDOUR::PortFlags flags);
 375     inline bool _registered (PortHandle  port_handle) const
 376     {
 377         return std::find (_ports.begin (), _ports.end (), (WavesDataPort*)port_handle) != _ports.end ();
 378     }
 379
 380     WavesDataPort* _find_port (const std::string& port_name) const;
 381     void _freewheel_thread ();
 382
 383     std::vector<WavesAudioPort*> _physical_audio_inputs;
 384     std::vector<WavesAudioPort*> _physical_audio_outputs;
 385     std::vector<WavesMidiPort*> _physical_midi_inputs;
 386     std::vector<WavesMidiPort*> _physical_midi_outputs;
 387     std::vector<WavesDataPort*> _ports;
 388     static AudioBackendInfo __backend_info;
 389
 390 #if defined (PLATFORM_WINDOWS)
 391         static uint64_t __performance_counter_frequency;
 392 #endif
 393         uint64_t _cycle_start_time_nanos;
 394     framepos_t _sample_time_at_cycle_start;
 395
 396     bool _freewheeling;
 397     bool _freewheel_thread_active;
 398
 399     friend class WavesMidiDeviceManager;
 400
 401     std::list<uint64_t> _dsp_load_history;
 402     size_t _dsp_load_history_length;
 403     uint64_t _dsp_load_accumulator;
 404     float _audio_cycle_period_nanos;
 405     void _init_dsp_load_history();
 406 };
 407
 408 } // namespace
 409
 410 #endif /* __libardour_waves_audiobackend_h__ */
 411