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);
155 void setup_generator (GeneratorType const, float const);
158 Sample _buffer[8192];
160 // signal generator ('fake' physical inputs)
161 void generate (const pframes_t n_samples);
162 GeneratorType _gen_type;
165 // pink-noise filters
166 float _b0, _b1, _b2, _b3, _b4, _b5, _b6;
167 // generated sinf() samples
169 uint32_t _tbl_length;
170 uint32_t _tbl_offset;
172 // gaussian noise generator
177 }; // class DummyAudioPort
179 class DummyMidiPort : public DummyPort {
181 DummyMidiPort (DummyAudioBackend &b, const std::string&, PortFlags);
184 DataType type () const { return DataType::MIDI; };
186 void* get_buffer (pframes_t nframes);
187 const DummyMidiBuffer const_buffer () const { return _buffer; }
189 void setup_generator (int, float const);
192 DummyMidiBuffer _buffer;
194 // midi event generator ('fake' physical inputs)
195 void midi_generate (const pframes_t n_samples);
196 float _midi_seq_spb; // samples per beat
197 int32_t _midi_seq_time;
198 uint32_t _midi_seq_pos;
199 DummyMidiData::MIDISequence const * _midi_seq_dat;
200 }; // class DummyMidiPort
202 class DummyAudioBackend : public AudioBackend {
203 friend class DummyPort;
205 DummyAudioBackend (AudioEngine& e, AudioBackendInfo& info);
206 ~DummyAudioBackend ();
208 /* AUDIOBACKEND API */
210 std::string name () const;
211 bool is_realtime () const;
213 std::vector<DeviceStatus> enumerate_devices () const;
214 std::vector<float> available_sample_rates (const std::string& device) const;
215 std::vector<uint32_t> available_buffer_sizes (const std::string& device) const;
216 uint32_t available_input_channel_count (const std::string& device) const;
217 uint32_t available_output_channel_count (const std::string& device) const;
219 bool can_change_sample_rate_when_running () const;
220 bool can_change_buffer_size_when_running () const;
222 int set_device_name (const std::string&);
223 int set_sample_rate (float);
224 int set_buffer_size (uint32_t);
225 int set_interleaved (bool yn);
226 int set_input_channels (uint32_t);
227 int set_output_channels (uint32_t);
228 int set_systemic_input_latency (uint32_t);
229 int set_systemic_output_latency (uint32_t);
230 int set_systemic_midi_input_latency (std::string const, uint32_t) { return 0; }
231 int set_systemic_midi_output_latency (std::string const, uint32_t) { return 0; }
233 /* Retrieving parameters */
234 std::string device_name () const;
235 float sample_rate () const;
236 uint32_t buffer_size () const;
237 bool interleaved () const;
238 uint32_t input_channels () const;
239 uint32_t output_channels () const;
240 uint32_t systemic_input_latency () const;
241 uint32_t systemic_output_latency () const;
242 uint32_t systemic_midi_input_latency (std::string const) const { return 0; }
243 uint32_t systemic_midi_output_latency (std::string const) const { return 0; }
245 /* External control app */
246 std::string control_app_name () const { return std::string (); }
247 void launch_control_app () {}
250 std::vector<std::string> enumerate_midi_options () const;
251 int set_midi_option (const std::string&);
252 std::string midi_option () const;
254 std::vector<DeviceStatus> enumerate_midi_devices () const {
255 return std::vector<AudioBackend::DeviceStatus> ();
257 int set_midi_device_enabled (std::string const, bool) {
260 bool midi_device_enabled (std::string const) const {
263 bool can_set_systemic_midi_latencies () const {
269 int _start (bool for_latency_measurement);
272 int freewheel (bool);
273 float dsp_load () const;
274 size_t raw_buffer_size (DataType t);
277 pframes_t sample_time ();
278 pframes_t sample_time_at_cycle_start ();
279 pframes_t samples_since_cycle_start ();
281 int create_process_thread (boost::function<void()> func);
282 int join_process_threads ();
283 bool in_process_thread ();
284 uint32_t process_thread_count ();
286 void update_latencies ();
290 void* private_handle () const;
291 const std::string& my_name () const;
292 bool available () const;
293 uint32_t port_name_size () const;
295 int set_port_name (PortHandle, const std::string&);
296 std::string get_port_name (PortHandle) const;
297 PortHandle get_port_by_name (const std::string&) const;
299 int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&) const;
301 DataType port_data_type (PortHandle) const;
303 PortHandle register_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
304 void unregister_port (PortHandle);
306 int connect (const std::string& src, const std::string& dst);
307 int disconnect (const std::string& src, const std::string& dst);
308 int connect (PortHandle, const std::string&);
309 int disconnect (PortHandle, const std::string&);
310 int disconnect_all (PortHandle);
312 bool connected (PortHandle, bool process_callback_safe);
313 bool connected_to (PortHandle, const std::string&, bool process_callback_safe);
314 bool physically_connected (PortHandle, bool process_callback_safe);
315 int get_connections (PortHandle, std::vector<std::string>&, bool process_callback_safe);
318 int midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index);
319 int midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
320 uint32_t get_midi_event_count (void* port_buffer);
321 void midi_clear (void* port_buffer);
325 bool can_monitor_input () const;
326 int request_input_monitoring (PortHandle, bool);
327 int ensure_input_monitoring (PortHandle, bool);
328 bool monitoring_input (PortHandle);
330 /* Latency management */
332 void set_latency_range (PortHandle, bool for_playback, LatencyRange);
333 LatencyRange get_latency_range (PortHandle, bool for_playback);
335 /* Discovering physical ports */
337 bool port_is_physical (PortHandle) const;
338 void get_physical_outputs (DataType type, std::vector<std::string>&);
339 void get_physical_inputs (DataType type, std::vector<std::string>&);
340 ChanCount n_physical_outputs () const;
341 ChanCount n_physical_inputs () const;
343 /* Getting access to the data buffer for a port */
345 void* get_buffer (PortHandle, pframes_t);
347 void* main_process_thread ();
350 std::string _instance_name;
351 static std::vector<std::string> _midi_options;
352 static std::vector<AudioBackend::DeviceStatus> _device_status;
360 size_t _samples_per_period;
362 static size_t _max_buffer_size;
367 uint32_t _n_midi_inputs;
368 uint32_t _n_midi_outputs;
369 bool _enable_midi_generators;
371 uint32_t _systemic_input_latency;
372 uint32_t _systemic_output_latency;
374 uint64_t _processed_samples;
376 pthread_t _main_thread;
378 /* process threads */
379 static void* dummy_process_thread (void *);
380 std::vector<pthread_t> _threads;
383 DummyAudioBackend* engine;
384 boost::function<void ()> f;
387 ThreadData (DummyAudioBackend* e, boost::function<void ()> fp, size_t stacksz)
388 : engine (e) , f (fp) , stacksize (stacksz) {}
392 PortHandle add_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
393 int register_system_ports ();
394 void unregister_ports (bool system_only = false);
396 std::vector<DummyAudioPort *> _system_inputs;
397 std::vector<DummyMidiPort *> _system_midi_in;
398 std::vector<DummyPort *> _ports;
400 struct PortConnectData {
405 PortConnectData (const std::string& a, const std::string& b, bool c)
406 : a (a) , b (b) , c (c) {}
409 std::vector<PortConnectData *> _port_connection_queue;
410 pthread_mutex_t _port_callback_mutex;
411 bool _port_change_flag;
413 void port_connect_callback (const std::string& a, const std::string& b, bool conn) {
414 pthread_mutex_lock (&_port_callback_mutex);
415 _port_connection_queue.push_back(new PortConnectData(a, b, conn));
416 pthread_mutex_unlock (&_port_callback_mutex);
419 void port_connect_add_remove_callback () {
420 pthread_mutex_lock (&_port_callback_mutex);
421 _port_change_flag = true;
422 pthread_mutex_unlock (&_port_callback_mutex);
425 bool valid_port (PortHandle port) const {
426 return std::find (_ports.begin (), _ports.end (), (DummyPort*)port) != _ports.end ();
429 DummyPort * find_port (const std::string& port_name) const {
430 for (std::vector<DummyPort*>::const_iterator it = _ports.begin (); it != _ports.end (); ++it) {
431 if ((*it)->name () == port_name) {
438 }; // class DummyAudioBackend
442 #endif /* __libbackend_dummy_audiobackend_h__ */