2 * Copyright (C) 2014 Robin Gareus <robin@gareus.org>
3 * Copyright (C) 2013 Paul Davis
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef __libbackend_dummy_audiobackend_h__
21 #define __libbackend_dummy_audiobackend_h__
31 #include <boost/shared_ptr.hpp>
33 #include "ardour/types.h"
34 #include "ardour/audio_backend.h"
38 class DummyAudioBackend;
40 namespace DummyMidiData {
41 typedef struct _MIDISequence {
47 class DummyMidiEvent {
49 DummyMidiEvent (const pframes_t timestamp, const uint8_t* data, size_t size);
50 DummyMidiEvent (const DummyMidiEvent& other);
52 size_t size () const { return _size; };
53 pframes_t timestamp () const { return _timestamp; };
54 const unsigned char* const_data () const { return _data; };
55 unsigned char* data () { return _data; };
56 bool operator< (const DummyMidiEvent &other) const { return timestamp () < other.timestamp (); };
63 typedef std::vector<boost::shared_ptr<DummyMidiEvent> > DummyMidiBuffer;
67 DummyPort (DummyAudioBackend &b, const std::string&, PortFlags);
69 virtual ~DummyPort ();
71 const std::string& name () const { return _name; }
72 PortFlags flags () const { return _flags; }
74 int set_name (const std::string &name) { _name = name; return 0; }
76 virtual DataType type () const = 0;
78 bool is_input () const { return flags () & IsInput; }
79 bool is_output () const { return flags () & IsOutput; }
80 bool is_physical () const { return flags () & IsPhysical; }
81 bool is_terminal () const { return flags () & IsTerminal; }
82 bool is_connected () const { return _connections.size () != 0; }
83 bool is_connected (const DummyPort *port) const;
84 bool is_physically_connected () const;
86 const std::vector<DummyPort *>& get_connections () const { return _connections; }
88 int connect (DummyPort *port);
89 int disconnect (DummyPort *port);
90 void disconnect_all ();
92 virtual void* get_buffer (pframes_t nframes) = 0;
93 void next_period () { _gen_cycle = false; }
95 const LatencyRange& latency_range (bool for_playback) const
97 return for_playback ? _playback_latency_range : _capture_latency_range;
100 void set_latency_range (const LatencyRange &latency_range, bool for_playback)
104 _playback_latency_range = latency_range;
108 _capture_latency_range = latency_range;
113 DummyAudioBackend &_dummy_backend;
115 const PortFlags _flags;
116 LatencyRange _capture_latency_range;
117 LatencyRange _playback_latency_range;
118 std::vector<DummyPort*> _connections;
120 void _connect (DummyPort* , bool);
121 void _disconnect (DummyPort* , bool);
124 // random number generator
125 void setup_random_number_generator ();
126 inline float randf ();
127 inline uint32_t randi ();
131 volatile bool _gen_cycle;
132 Glib::Threads::Mutex generator_lock;
134 }; // class DummyPort
136 class DummyAudioPort : public DummyPort {
138 DummyAudioPort (DummyAudioBackend &b, const std::string&, PortFlags);
141 DataType type () const { return DataType::AUDIO; };
143 Sample* buffer () { return _buffer; }
144 const Sample* const_buffer () const { return _buffer; }
145 void* get_buffer (pframes_t nframes);
160 void setup_generator (GeneratorType const, float const);
161 void fill_wavetable (const float* d, size_t n_samples) { assert(_wavetable != 0); memcpy(_wavetable, d, n_samples * sizeof(float)); }
164 Sample _buffer[8192];
166 // signal generator ('fake' physical inputs)
167 void generate (const pframes_t n_samples);
168 GeneratorType _gen_type;
171 // pink-noise filters
172 float _b0, _b1, _b2, _b3, _b4, _b5, _b6;
173 // generated sinf() samples
175 uint32_t _gen_period;
176 uint32_t _gen_offset;
177 uint32_t _gen_perio2;
178 uint32_t _gen_count2;
180 // gaussian noise generator
185 }; // class DummyAudioPort
187 class DummyMidiPort : public DummyPort {
189 DummyMidiPort (DummyAudioBackend &b, const std::string&, PortFlags);
192 DataType type () const { return DataType::MIDI; };
194 void* get_buffer (pframes_t nframes);
195 const DummyMidiBuffer const_buffer () const { return _buffer; }
197 void setup_generator (int, float const);
200 DummyMidiBuffer _buffer;
202 // midi event generator ('fake' physical inputs)
203 void midi_generate (const pframes_t n_samples);
204 float _midi_seq_spb; // samples per beat
205 int32_t _midi_seq_time;
206 uint32_t _midi_seq_pos;
207 DummyMidiData::MIDISequence const * _midi_seq_dat;
208 }; // class DummyMidiPort
210 class DummyAudioBackend : public AudioBackend {
211 friend class DummyPort;
213 DummyAudioBackend (AudioEngine& e, AudioBackendInfo& info);
214 ~DummyAudioBackend ();
216 /* AUDIOBACKEND API */
218 std::string name () const;
219 bool is_realtime () const;
221 std::vector<DeviceStatus> enumerate_devices () const;
222 std::vector<float> available_sample_rates (const std::string& device) const;
223 std::vector<uint32_t> available_buffer_sizes (const std::string& device) const;
224 uint32_t available_input_channel_count (const std::string& device) const;
225 uint32_t available_output_channel_count (const std::string& device) const;
227 bool can_change_sample_rate_when_running () const;
228 bool can_change_buffer_size_when_running () const;
230 int set_device_name (const std::string&);
231 int set_sample_rate (float);
232 int set_buffer_size (uint32_t);
233 int set_interleaved (bool yn);
234 int set_input_channels (uint32_t);
235 int set_output_channels (uint32_t);
236 int set_systemic_input_latency (uint32_t);
237 int set_systemic_output_latency (uint32_t);
238 int set_systemic_midi_input_latency (std::string const, uint32_t) { return 0; }
239 int set_systemic_midi_output_latency (std::string const, uint32_t) { return 0; }
241 int reset_device () { return 0; };
243 /* Retrieving parameters */
244 std::string device_name () const;
245 float sample_rate () const;
246 uint32_t buffer_size () const;
247 bool interleaved () const;
248 uint32_t input_channels () const;
249 uint32_t output_channels () const;
250 uint32_t systemic_input_latency () const;
251 uint32_t systemic_output_latency () const;
252 uint32_t systemic_midi_input_latency (std::string const) const { return 0; }
253 uint32_t systemic_midi_output_latency (std::string const) const { return 0; }
255 /* External control app */
256 std::string control_app_name () const { return std::string (); }
257 void launch_control_app () {}
260 std::vector<std::string> enumerate_midi_options () const;
261 int set_midi_option (const std::string&);
262 std::string midi_option () const;
264 std::vector<DeviceStatus> enumerate_midi_devices () const {
265 return std::vector<AudioBackend::DeviceStatus> ();
267 int set_midi_device_enabled (std::string const, bool) {
270 bool midi_device_enabled (std::string const) const {
273 bool can_set_systemic_midi_latencies () const {
279 int _start (bool for_latency_measurement);
282 int freewheel (bool);
283 float dsp_load () const;
284 size_t raw_buffer_size (DataType t);
287 pframes_t sample_time ();
288 pframes_t sample_time_at_cycle_start ();
289 pframes_t samples_since_cycle_start ();
291 int create_process_thread (boost::function<void()> func);
292 int join_process_threads ();
293 bool in_process_thread ();
294 uint32_t process_thread_count ();
296 void update_latencies ();
300 void* private_handle () const;
301 const std::string& my_name () const;
302 bool available () const;
303 uint32_t port_name_size () const;
305 int set_port_name (PortHandle, const std::string&);
306 std::string get_port_name (PortHandle) const;
307 PortHandle get_port_by_name (const std::string&) const;
309 int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&) const;
311 DataType port_data_type (PortHandle) const;
313 PortHandle register_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
314 void unregister_port (PortHandle);
316 int connect (const std::string& src, const std::string& dst);
317 int disconnect (const std::string& src, const std::string& dst);
318 int connect (PortHandle, const std::string&);
319 int disconnect (PortHandle, const std::string&);
320 int disconnect_all (PortHandle);
322 bool connected (PortHandle, bool process_callback_safe);
323 bool connected_to (PortHandle, const std::string&, bool process_callback_safe);
324 bool physically_connected (PortHandle, bool process_callback_safe);
325 int get_connections (PortHandle, std::vector<std::string>&, bool process_callback_safe);
328 int midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index);
329 int midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
330 uint32_t get_midi_event_count (void* port_buffer);
331 void midi_clear (void* port_buffer);
335 bool can_monitor_input () const;
336 int request_input_monitoring (PortHandle, bool);
337 int ensure_input_monitoring (PortHandle, bool);
338 bool monitoring_input (PortHandle);
340 /* Latency management */
342 void set_latency_range (PortHandle, bool for_playback, LatencyRange);
343 LatencyRange get_latency_range (PortHandle, bool for_playback);
345 /* Discovering physical ports */
347 bool port_is_physical (PortHandle) const;
348 void get_physical_outputs (DataType type, std::vector<std::string>&);
349 void get_physical_inputs (DataType type, std::vector<std::string>&);
350 ChanCount n_physical_outputs () const;
351 ChanCount n_physical_inputs () const;
353 /* Getting access to the data buffer for a port */
355 void* get_buffer (PortHandle, pframes_t);
357 void* main_process_thread ();
359 static size_t max_buffer_size() {return _max_buffer_size;}
362 std::string _instance_name;
363 static std::vector<std::string> _midi_options;
364 static std::vector<AudioBackend::DeviceStatus> _device_status;
372 size_t _samples_per_period;
374 static size_t _max_buffer_size;
379 uint32_t _n_midi_inputs;
380 uint32_t _n_midi_outputs;
381 bool _enable_midi_generators;
383 uint32_t _systemic_input_latency;
384 uint32_t _systemic_output_latency;
386 uint64_t _processed_samples;
388 pthread_t _main_thread;
390 /* process threads */
391 static void* dummy_process_thread (void *);
392 std::vector<pthread_t> _threads;
395 DummyAudioBackend* engine;
396 boost::function<void ()> f;
399 ThreadData (DummyAudioBackend* e, boost::function<void ()> fp, size_t stacksz)
400 : engine (e) , f (fp) , stacksize (stacksz) {}
404 PortHandle add_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
405 int register_system_ports ();
406 void unregister_ports (bool system_only = false);
408 std::vector<DummyAudioPort *> _system_inputs;
409 std::vector<DummyAudioPort *> _system_outputs;
410 std::vector<DummyMidiPort *> _system_midi_in;
411 std::vector<DummyMidiPort *> _system_midi_out;
412 std::vector<DummyPort *> _ports;
414 struct PortConnectData {
419 PortConnectData (const std::string& a, const std::string& b, bool c)
420 : a (a) , b (b) , c (c) {}
423 std::vector<PortConnectData *> _port_connection_queue;
424 pthread_mutex_t _port_callback_mutex;
425 bool _port_change_flag;
427 void port_connect_callback (const std::string& a, const std::string& b, bool conn) {
428 pthread_mutex_lock (&_port_callback_mutex);
429 _port_connection_queue.push_back(new PortConnectData(a, b, conn));
430 pthread_mutex_unlock (&_port_callback_mutex);
433 void port_connect_add_remove_callback () {
434 pthread_mutex_lock (&_port_callback_mutex);
435 _port_change_flag = true;
436 pthread_mutex_unlock (&_port_callback_mutex);
439 bool valid_port (PortHandle port) const {
440 return std::find (_ports.begin (), _ports.end (), (DummyPort*)port) != _ports.end ();
443 DummyPort * find_port (const std::string& port_name) const {
444 for (std::vector<DummyPort*>::const_iterator it = _ports.begin (); it != _ports.end (); ++it) {
445 if ((*it)->name () == port_name) {
452 }; // class DummyAudioBackend
456 #endif /* __libbackend_dummy_audiobackend_h__ */