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_coreaudio_backend_h__
21 #define __libbackend_coreaudio_backend_h__
31 #include <boost/shared_ptr.hpp>
33 #include "ardour/audio_backend.h"
34 #include "ardour/types.h"
36 #include "coreaudio_pcmio.h"
37 #include "coremidi_io.h"
41 class CoreAudioBackend;
45 CoreMidiEvent (const pframes_t timestamp, const uint8_t* data, size_t size);
46 CoreMidiEvent (const CoreMidiEvent& other);
48 size_t size () const { return _size; };
49 pframes_t timestamp () const { return _timestamp; };
50 const unsigned char* const_data () const { return _data; };
51 unsigned char* data () { return _data; };
52 bool operator< (const CoreMidiEvent &other) const { return timestamp () < other.timestamp (); };
59 typedef std::vector<boost::shared_ptr<CoreMidiEvent> > CoreMidiBuffer;
61 class CoreBackendPort {
63 CoreBackendPort (CoreAudioBackend &b, const std::string&, PortFlags);
65 virtual ~CoreBackendPort ();
67 const std::string& name () const { return _name; }
68 PortFlags flags () const { return _flags; }
70 int set_name (const std::string &name) { _name = name; return 0; }
72 virtual DataType type () const = 0;
74 bool is_input () const { return flags () & IsInput; }
75 bool is_output () const { return flags () & IsOutput; }
76 bool is_physical () const { return flags () & IsPhysical; }
77 bool is_terminal () const { return flags () & IsTerminal; }
78 bool is_connected () const { return _connections.size () != 0; }
79 bool is_connected (const CoreBackendPort *port) const;
80 bool is_physically_connected () const;
82 const std::vector<CoreBackendPort *>& get_connections () const { return _connections; }
84 int connect (CoreBackendPort *port);
85 int disconnect (CoreBackendPort *port);
86 void disconnect_all ();
88 virtual void* get_buffer (pframes_t nframes) = 0;
90 const LatencyRange& latency_range (bool for_playback) const
92 return for_playback ? _playback_latency_range : _capture_latency_range;
95 void set_latency_range (const LatencyRange &latency_range, bool for_playback)
99 _playback_latency_range = latency_range;
103 _capture_latency_range = latency_range;
108 CoreAudioBackend &_osx_backend;
110 const PortFlags _flags;
111 LatencyRange _capture_latency_range;
112 LatencyRange _playback_latency_range;
113 std::vector<CoreBackendPort*> _connections;
115 void _connect (CoreBackendPort* , bool);
116 void _disconnect (CoreBackendPort* , bool);
118 }; // class CoreBackendPort
120 class CoreAudioPort : public CoreBackendPort {
122 CoreAudioPort (CoreAudioBackend &b, const std::string&, PortFlags);
125 DataType type () const { return DataType::AUDIO; };
127 Sample* buffer () { return _buffer; }
128 const Sample* const_buffer () const { return _buffer; }
129 void* get_buffer (pframes_t nframes);
132 Sample _buffer[8192];
133 }; // class CoreAudioPort
135 class CoreMidiPort : public CoreBackendPort {
137 CoreMidiPort (CoreAudioBackend &b, const std::string&, PortFlags);
140 DataType type () const { return DataType::MIDI; };
142 void* get_buffer (pframes_t nframes);
143 const CoreMidiBuffer * const_buffer () const { return & _buffer[_bufperiod]; }
145 void next_period() { if (_n_periods > 1) { get_buffer(0); _bufperiod = (_bufperiod + 1) % _n_periods; } }
146 void set_n_periods(int n) { if (n > 0 && n < 3) { _n_periods = n; } }
149 CoreMidiBuffer _buffer[2];
152 }; // class CoreMidiPort
154 class CoreAudioBackend : public AudioBackend {
155 friend class CoreBackendPort;
157 CoreAudioBackend (AudioEngine& e, AudioBackendInfo& info);
158 ~CoreAudioBackend ();
160 /* AUDIOBACKEND API */
162 std::string name () const;
163 bool is_realtime () const;
165 std::vector<DeviceStatus> enumerate_devices () const;
166 std::vector<float> available_sample_rates (const std::string& device) const;
167 std::vector<uint32_t> available_buffer_sizes (const std::string& device) const;
168 uint32_t available_input_channel_count (const std::string& device) const;
169 uint32_t available_output_channel_count (const std::string& device) const;
171 bool can_change_sample_rate_when_running () const;
172 bool can_change_buffer_size_when_running () const;
174 int set_device_name (const std::string&);
175 int set_sample_rate (float);
176 int set_buffer_size (uint32_t);
177 int set_interleaved (bool yn);
178 int set_input_channels (uint32_t);
179 int set_output_channels (uint32_t);
180 int set_systemic_input_latency (uint32_t);
181 int set_systemic_output_latency (uint32_t);
182 int set_systemic_midi_input_latency (std::string const, uint32_t);
183 int set_systemic_midi_output_latency (std::string const, uint32_t);
185 int reset_device () { return 0; };
187 /* Retrieving parameters */
188 std::string device_name () const;
189 float sample_rate () const;
190 uint32_t buffer_size () const;
191 bool interleaved () const;
192 uint32_t input_channels () const;
193 uint32_t output_channels () const;
194 uint32_t systemic_input_latency () const;
195 uint32_t systemic_output_latency () const;
196 uint32_t systemic_midi_input_latency (std::string const) const;
197 uint32_t systemic_midi_output_latency (std::string const) const;
199 bool can_set_systemic_midi_latencies () const { return false; /* XXX */}
201 /* External control app */
202 std::string control_app_name () const { return std::string (); }
203 void launch_control_app () {}
206 std::vector<std::string> enumerate_midi_options () const;
207 int set_midi_option (const std::string&);
208 std::string midi_option () const;
210 std::vector<DeviceStatus> enumerate_midi_devices () const;
211 int set_midi_device_enabled (std::string const, bool);
212 bool midi_device_enabled (std::string const) const;
214 // really private, but needing static access:
215 int process_callback();
216 void error_callback();
220 int _start (bool for_latency_measurement);
223 int freewheel (bool);
224 float dsp_load () const;
225 size_t raw_buffer_size (DataType t);
228 framepos_t sample_time ();
229 framepos_t sample_time_at_cycle_start ();
230 pframes_t samples_since_cycle_start ();
232 int create_process_thread (boost::function<void()> func);
233 int join_process_threads ();
234 bool in_process_thread ();
235 uint32_t process_thread_count ();
237 void update_latencies ();
241 void* private_handle () const;
242 const std::string& my_name () const;
243 bool available () const;
244 uint32_t port_name_size () const;
246 int set_port_name (PortHandle, const std::string&);
247 std::string get_port_name (PortHandle) const;
248 PortHandle get_port_by_name (const std::string&) const;
250 int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&) const;
252 DataType port_data_type (PortHandle) const;
254 PortHandle register_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
255 void unregister_port (PortHandle);
257 int connect (const std::string& src, const std::string& dst);
258 int disconnect (const std::string& src, const std::string& dst);
259 int connect (PortHandle, const std::string&);
260 int disconnect (PortHandle, const std::string&);
261 int disconnect_all (PortHandle);
263 bool connected (PortHandle, bool process_callback_safe);
264 bool connected_to (PortHandle, const std::string&, bool process_callback_safe);
265 bool physically_connected (PortHandle, bool process_callback_safe);
266 int get_connections (PortHandle, std::vector<std::string>&, bool process_callback_safe);
269 int midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index);
270 int midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
271 uint32_t get_midi_event_count (void* port_buffer);
272 void midi_clear (void* port_buffer);
276 bool can_monitor_input () const;
277 int request_input_monitoring (PortHandle, bool);
278 int ensure_input_monitoring (PortHandle, bool);
279 bool monitoring_input (PortHandle);
281 /* Latency management */
283 void set_latency_range (PortHandle, bool for_playback, LatencyRange);
284 LatencyRange get_latency_range (PortHandle, bool for_playback);
286 /* Discovering physical ports */
288 bool port_is_physical (PortHandle) const;
289 void get_physical_outputs (DataType type, std::vector<std::string>&);
290 void get_physical_inputs (DataType type, std::vector<std::string>&);
291 ChanCount n_physical_outputs () const;
292 ChanCount n_physical_inputs () const;
294 /* Getting access to the data buffer for a port */
296 void* get_buffer (PortHandle, pframes_t);
298 void* freewheel_thread ();
299 void post_process ();
300 void coremidi_rediscover ();
303 std::string _instance_name;
304 CoreAudioPCM *_pcmio;
307 bool _run; /* keep going or stop, ardour thread */
308 bool _active_ca; /* is running, process thread */
309 bool _active_fw; /* is running, process thread */
314 bool _reinit_thread_callback;
315 bool _measure_latency;
316 pthread_mutex_t _process_callback_mutex;
318 static std::vector<std::string> _midi_options;
319 static std::vector<AudioBackend::DeviceStatus> _audio_device_status;
320 static std::vector<AudioBackend::DeviceStatus> _midi_device_status;
322 mutable std::string _audio_device;
323 std::string _midi_driver_option;
327 size_t _samples_per_period;
328 static size_t _max_buffer_size;
333 uint32_t _systemic_audio_input_latency;
334 uint32_t _systemic_audio_output_latency;
337 struct CoreMidiDeviceInfo {
339 uint32_t systemic_input_latency;
340 uint32_t systemic_output_latency;
343 , systemic_input_latency (0)
344 , systemic_output_latency (0)
348 mutable std::map<std::string, struct CoreMidiDeviceInfo *> _midi_devices;
349 struct CoreMidiDeviceInfo * midi_device_info(std::string const) const;
353 uint64_t _processed_samples;
355 pthread_t _main_thread;
356 pthread_t _freeewheel_thread;
358 /* process threads */
359 static void* coreaudio_process_thread (void *);
360 std::vector<pthread_t> _threads;
363 CoreAudioBackend* engine;
364 boost::function<void ()> f;
367 ThreadData (CoreAudioBackend* e, boost::function<void ()> fp, size_t stacksz)
368 : engine (e) , f (fp) , stacksize (stacksz) {}
372 PortHandle add_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
373 int register_system_audio_ports ();
374 int register_system_midi_ports ();
375 void unregister_ports (bool system_only = false);
377 std::vector<CoreBackendPort *> _ports;
378 std::vector<CoreBackendPort *> _system_inputs;
379 std::vector<CoreBackendPort *> _system_outputs;
380 std::vector<CoreBackendPort *> _system_midi_in;
381 std::vector<CoreBackendPort *> _system_midi_out;
383 //std::vector<CoreMidiOut *> _rmidi_out;
384 //std::vector<CoreMidiIn *> _rmidi_in;
386 struct PortConnectData {
391 PortConnectData (const std::string& a, const std::string& b, bool c)
392 : a (a) , b (b) , c (c) {}
395 std::vector<PortConnectData *> _port_connection_queue;
396 pthread_mutex_t _port_callback_mutex;
397 bool _port_change_flag;
399 void port_connect_callback (const std::string& a, const std::string& b, bool conn) {
400 pthread_mutex_lock (&_port_callback_mutex);
401 _port_connection_queue.push_back(new PortConnectData(a, b, conn));
402 pthread_mutex_unlock (&_port_callback_mutex);
405 void port_connect_add_remove_callback () {
406 pthread_mutex_lock (&_port_callback_mutex);
407 _port_change_flag = true;
408 pthread_mutex_unlock (&_port_callback_mutex);
411 bool valid_port (PortHandle port) const {
412 return std::find (_ports.begin (), _ports.end (), (CoreBackendPort*)port) != _ports.end ();
415 CoreBackendPort * find_port (const std::string& port_name) const {
416 for (std::vector<CoreBackendPort*>::const_iterator it = _ports.begin (); it != _ports.end (); ++it) {
417 if ((*it)->name () == port_name) {
424 }; // class CoreAudioBackend
428 #endif /* __libbackend_coreaudio_backend_h__ */