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 class DummyMidiEvent {
42 DummyMidiEvent (const pframes_t timestamp, const uint8_t* data, size_t size);
43 DummyMidiEvent (const DummyMidiEvent& other);
45 size_t size () const { return _size; };
46 pframes_t timestamp () const { return _timestamp; };
47 const unsigned char* const_data () const { return _data; };
48 unsigned char* data () { return _data; };
49 bool operator< (const DummyMidiEvent &other) const { return timestamp () < other.timestamp (); };
56 typedef std::vector<boost::shared_ptr<DummyMidiEvent> > DummyMidiBuffer;
60 DummyPort (DummyAudioBackend &b, const std::string&, PortFlags);
62 virtual ~DummyPort ();
64 const std::string& name () const { return _name; }
65 PortFlags flags () const { return _flags; }
67 int set_name (const std::string &name) { _name = name; return 0; }
69 virtual DataType type () const = 0;
71 bool is_input () const { return flags () & IsInput; }
72 bool is_output () const { return flags () & IsOutput; }
73 bool is_physical () const { return flags () & IsPhysical; }
74 bool is_terminal () const { return flags () & IsTerminal; }
75 bool is_connected () const { return _connections.size () != 0; }
76 bool is_connected (const DummyPort *port) const;
77 bool is_physically_connected () const;
79 const std::vector<DummyPort *>& get_connections () const { return _connections; }
81 int connect (DummyPort *port);
82 int disconnect (DummyPort *port);
83 void disconnect_all ();
85 virtual void* get_buffer (pframes_t nframes) = 0;
87 const LatencyRange& latency_range (bool for_playback) const
89 return for_playback ? _playback_latency_range : _capture_latency_range;
92 void set_latency_range (const LatencyRange &latency_range, bool for_playback)
96 _playback_latency_range = latency_range;
100 _capture_latency_range = latency_range;
105 DummyAudioBackend &_dummy_backend;
107 const PortFlags _flags;
108 LatencyRange _capture_latency_range;
109 LatencyRange _playback_latency_range;
110 std::vector<DummyPort*> _connections;
112 void _connect (DummyPort* , bool);
113 void _disconnect (DummyPort* , bool);
115 }; // class DummyPort
117 class DummyAudioPort : public DummyPort {
119 DummyAudioPort (DummyAudioBackend &b, const std::string&, PortFlags);
122 DataType type () const { return DataType::AUDIO; };
124 Sample* buffer () { return _buffer; }
125 const Sample* const_buffer () const { return _buffer; }
126 void* get_buffer (pframes_t nframes);
129 Sample _buffer[8192];
130 }; // class DummyAudioPort
132 class DummyMidiPort : public DummyPort {
134 DummyMidiPort (DummyAudioBackend &b, const std::string&, PortFlags);
137 DataType type () const { return DataType::MIDI; };
139 void* get_buffer (pframes_t nframes);
140 const DummyMidiBuffer const_buffer () const { return _buffer; }
143 DummyMidiBuffer _buffer;
144 }; // class DummyMidiPort
146 class DummyAudioBackend : public AudioBackend {
147 friend class DummyPort;
149 DummyAudioBackend (AudioEngine& e, AudioBackendInfo& info);
150 ~DummyAudioBackend ();
152 /* AUDIOBACKEND API */
154 std::string name () const;
155 bool is_realtime () const;
157 std::vector<DeviceStatus> enumerate_devices () const;
158 std::vector<float> available_sample_rates (const std::string& device) const;
159 std::vector<uint32_t> available_buffer_sizes (const std::string& device) const;
160 uint32_t available_input_channel_count (const std::string& device) const;
161 uint32_t available_output_channel_count (const std::string& device) const;
163 bool can_change_sample_rate_when_running () const;
164 bool can_change_buffer_size_when_running () const;
166 int set_device_name (const std::string&);
167 int set_sample_rate (float);
168 int set_buffer_size (uint32_t);
169 int set_interleaved (bool yn);
170 int set_input_channels (uint32_t);
171 int set_output_channels (uint32_t);
172 int set_systemic_input_latency (uint32_t);
173 int set_systemic_output_latency (uint32_t);
174 int set_systemic_midi_input_latency (std::string const, uint32_t) { return 0; }
175 int set_systemic_midi_output_latency (std::string const, uint32_t) { return 0; }
177 /* Retrieving parameters */
178 std::string device_name () const;
179 float sample_rate () const;
180 uint32_t buffer_size () const;
181 bool interleaved () const;
182 uint32_t input_channels () const;
183 uint32_t output_channels () const;
184 uint32_t systemic_input_latency () const;
185 uint32_t systemic_output_latency () const;
186 uint32_t systemic_midi_input_latency (std::string const) const { return 0; }
187 uint32_t systemic_midi_output_latency (std::string const) const { return 0; }
189 /* External control app */
190 std::string control_app_name () const { return std::string (); }
191 void launch_control_app () {}
194 std::vector<std::string> enumerate_midi_options () const;
195 int set_midi_option (const std::string&);
196 std::string midi_option () const;
198 std::vector<DeviceStatus> enumerate_midi_devices () const {
199 return std::vector<AudioBackend::DeviceStatus> ();
201 int set_midi_device_enabled (std::string const, bool) {
204 bool midi_device_enabled (std::string const) const {
207 bool can_set_systemic_midi_latencies () const {
213 int _start (bool for_latency_measurement);
216 int freewheel (bool);
217 float dsp_load () const;
218 size_t raw_buffer_size (DataType t);
221 pframes_t sample_time ();
222 pframes_t sample_time_at_cycle_start ();
223 pframes_t samples_since_cycle_start ();
225 int create_process_thread (boost::function<void()> func);
226 int join_process_threads ();
227 bool in_process_thread ();
228 uint32_t process_thread_count ();
230 void update_latencies ();
234 void* private_handle () const;
235 const std::string& my_name () const;
236 bool available () const;
237 uint32_t port_name_size () const;
239 int set_port_name (PortHandle, const std::string&);
240 std::string get_port_name (PortHandle) const;
241 PortHandle get_port_by_name (const std::string&) const;
243 int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&) const;
245 DataType port_data_type (PortHandle) const;
247 PortHandle register_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
248 void unregister_port (PortHandle);
250 int connect (const std::string& src, const std::string& dst);
251 int disconnect (const std::string& src, const std::string& dst);
252 int connect (PortHandle, const std::string&);
253 int disconnect (PortHandle, const std::string&);
254 int disconnect_all (PortHandle);
256 bool connected (PortHandle, bool process_callback_safe);
257 bool connected_to (PortHandle, const std::string&, bool process_callback_safe);
258 bool physically_connected (PortHandle, bool process_callback_safe);
259 int get_connections (PortHandle, std::vector<std::string>&, bool process_callback_safe);
262 int midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index);
263 int midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
264 uint32_t get_midi_event_count (void* port_buffer);
265 void midi_clear (void* port_buffer);
269 bool can_monitor_input () const;
270 int request_input_monitoring (PortHandle, bool);
271 int ensure_input_monitoring (PortHandle, bool);
272 bool monitoring_input (PortHandle);
274 /* Latency management */
276 void set_latency_range (PortHandle, bool for_playback, LatencyRange);
277 LatencyRange get_latency_range (PortHandle, bool for_playback);
279 /* Discovering physical ports */
281 bool port_is_physical (PortHandle) const;
282 void get_physical_outputs (DataType type, std::vector<std::string>&);
283 void get_physical_inputs (DataType type, std::vector<std::string>&);
284 ChanCount n_physical_outputs () const;
285 ChanCount n_physical_inputs () const;
287 /* Getting access to the data buffer for a port */
289 void* get_buffer (PortHandle, pframes_t);
291 void* main_process_thread ();
294 std::string _instance_name;
299 size_t _samples_per_period;
301 static size_t _max_buffer_size;
306 uint32_t _n_midi_inputs;
307 uint32_t _n_midi_outputs;
309 uint32_t _systemic_input_latency;
310 uint32_t _systemic_output_latency;
312 uint64_t _processed_samples;
314 pthread_t _main_thread;
316 /* process threads */
317 static void* dummy_process_thread (void *);
318 std::vector<pthread_t> _threads;
321 DummyAudioBackend* engine;
322 boost::function<void ()> f;
325 ThreadData (DummyAudioBackend* e, boost::function<void ()> fp, size_t stacksz)
326 : engine (e) , f (fp) , stacksize (stacksz) {}
330 PortHandle add_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
331 int register_system_ports ();
332 void unregister_system_ports ();
334 std::vector<DummyPort *> _ports;
337 struct PortConnectData {
342 PortConnectData (const std::string& a, const std::string& b, bool c)
343 : a (a) , b (b) , c (c) {}
346 std::vector<PortConnectData *> _port_connection_queue;
347 pthread_mutex_t _port_callback_mutex;
348 bool _port_change_flag;
350 void port_connect_callback (const std::string& a, const std::string& b, bool conn) {
351 pthread_mutex_lock (&_port_callback_mutex);
352 _port_connection_queue.push_back(new PortConnectData(a, b, conn));
353 pthread_mutex_unlock (&_port_callback_mutex);
356 void port_connect_add_remove_callback () {
357 pthread_mutex_lock (&_port_callback_mutex);
358 _port_change_flag = true;
359 pthread_mutex_unlock (&_port_callback_mutex);
362 bool valid_port (PortHandle port) const {
363 return std::find (_ports.begin (), _ports.end (), (DummyPort*)port) != _ports.end ();
366 DummyPort * find_port (const std::string& port_name) const {
367 for (std::vector<DummyPort*>::const_iterator it = _ports.begin (); it != _ports.end (); ++it) {
368 if ((*it)->name () == port_name) {
375 }; // class DummyAudioBackend
379 #endif /* __libbackend_dummy_audiobackend_h__ */