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/dsp_load_calculator.h"
35 #include "ardour/types.h"
37 #include "coreaudio_pcmio.h"
38 #include "coremidi_io.h"
42 class CoreAudioBackend;
46 CoreMidiEvent (const pframes_t timestamp, const uint8_t* data, size_t size);
47 CoreMidiEvent (const CoreMidiEvent& other);
49 size_t size () const { return _size; };
50 pframes_t timestamp () const { return _timestamp; };
51 const unsigned char* const_data () const { return _data; };
52 unsigned char* data () { return _data; };
53 bool operator< (const CoreMidiEvent &other) const { return timestamp () < other.timestamp (); };
60 typedef std::vector<boost::shared_ptr<CoreMidiEvent> > CoreMidiBuffer;
62 class CoreBackendPort {
64 CoreBackendPort (CoreAudioBackend &b, const std::string&, PortFlags);
66 virtual ~CoreBackendPort ();
68 const std::string& name () const { return _name; }
69 const std::string& pretty_name () const { return _pretty_name; }
70 PortFlags flags () const { return _flags; }
72 int set_name (const std::string &name) { _name = name; return 0; }
73 int set_pretty_name (const std::string &name) { _pretty_name = name; return 0; }
75 virtual DataType type () const = 0;
77 bool is_input () const { return flags () & IsInput; }
78 bool is_output () const { return flags () & IsOutput; }
79 bool is_physical () const { return flags () & IsPhysical; }
80 bool is_terminal () const { return flags () & IsTerminal; }
81 bool is_connected () const { return _connections.size () != 0; }
82 bool is_connected (const CoreBackendPort *port) const;
83 bool is_physically_connected () const;
85 const std::vector<CoreBackendPort *>& get_connections () const { return _connections; }
87 int connect (CoreBackendPort *port);
88 int disconnect (CoreBackendPort *port);
89 void disconnect_all ();
91 virtual void* get_buffer (pframes_t nframes) = 0;
93 const LatencyRange latency_range (bool for_playback) const
95 return for_playback ? _playback_latency_range : _capture_latency_range;
98 void set_latency_range (const LatencyRange &latency_range, bool for_playback)
102 _playback_latency_range = latency_range;
106 _capture_latency_range = latency_range;
111 CoreAudioBackend &_osx_backend;
113 std::string _pretty_name;
114 const PortFlags _flags;
115 LatencyRange _capture_latency_range;
116 LatencyRange _playback_latency_range;
117 std::vector<CoreBackendPort*> _connections;
119 void _connect (CoreBackendPort* , bool);
120 void _disconnect (CoreBackendPort* , bool);
122 }; // class CoreBackendPort
124 class CoreAudioPort : public CoreBackendPort {
126 CoreAudioPort (CoreAudioBackend &b, const std::string&, PortFlags);
129 DataType type () const { return DataType::AUDIO; };
131 Sample* buffer () { return _buffer; }
132 const Sample* const_buffer () const { return _buffer; }
133 void* get_buffer (pframes_t nframes);
136 Sample _buffer[8192];
137 }; // class CoreAudioPort
139 class CoreMidiPort : public CoreBackendPort {
141 CoreMidiPort (CoreAudioBackend &b, const std::string&, PortFlags);
144 DataType type () const { return DataType::MIDI; };
146 void* get_buffer (pframes_t nframes);
147 const CoreMidiBuffer * const_buffer () const { return & _buffer[_bufperiod]; }
149 void next_period() { if (_n_periods > 1) { get_buffer(0); _bufperiod = (_bufperiod + 1) % _n_periods; } }
150 void set_n_periods(int n) { if (n > 0 && n < 3) { _n_periods = n; } }
153 CoreMidiBuffer _buffer[2];
156 }; // class CoreMidiPort
158 class CoreAudioBackend : public AudioBackend {
159 friend class CoreBackendPort;
161 CoreAudioBackend (AudioEngine& e, AudioBackendInfo& info);
162 ~CoreAudioBackend ();
164 /* AUDIOBACKEND API */
166 std::string name () const;
167 bool is_realtime () const;
169 bool use_separate_input_and_output_devices () const { return true; }
170 std::vector<DeviceStatus> enumerate_devices () const;
171 std::vector<DeviceStatus> enumerate_input_devices () const;
172 std::vector<DeviceStatus> enumerate_output_devices () const;
174 std::vector<float> available_sample_rates (const std::string& device) const;
175 std::vector<float> available_sample_rates2 (const std::string&, const std::string&) const;
176 std::vector<uint32_t> available_buffer_sizes (const std::string& device) const;
177 std::vector<uint32_t> available_buffer_sizes2 (const std::string&, const std::string&) const;
178 uint32_t available_input_channel_count (const std::string& device) const;
179 uint32_t available_output_channel_count (const std::string& device) const;
181 bool can_change_sample_rate_when_running () const;
182 bool can_change_buffer_size_when_running () const;
184 int set_device_name (const std::string&);
185 int set_input_device_name (const std::string&);
186 int set_output_device_name (const std::string&);
187 int set_sample_rate (float);
188 int set_buffer_size (uint32_t);
189 int set_interleaved (bool yn);
190 int set_input_channels (uint32_t);
191 int set_output_channels (uint32_t);
192 int set_systemic_input_latency (uint32_t);
193 int set_systemic_output_latency (uint32_t);
194 int set_systemic_midi_input_latency (std::string const, uint32_t) { return 0; }
195 int set_systemic_midi_output_latency (std::string const, uint32_t) { return 0; }
197 int reset_device () { return 0; };
199 /* Retrieving parameters */
200 std::string device_name () const;
201 std::string input_device_name () const;
202 std::string output_device_name () const;
203 float sample_rate () const;
204 uint32_t buffer_size () const;
205 bool interleaved () const;
206 uint32_t input_channels () const;
207 uint32_t output_channels () const;
208 uint32_t systemic_input_latency () const;
209 uint32_t systemic_output_latency () const;
210 uint32_t systemic_midi_input_latency (std::string const) const { return 0; }
211 uint32_t systemic_midi_output_latency (std::string const) const { return 0; }
213 bool can_set_systemic_midi_latencies () const { return false; /* XXX */}
215 /* External control app */
216 std::string control_app_name () const { return std::string ("Apple"); }
217 void launch_control_app ();
220 std::vector<std::string> enumerate_midi_options () const;
221 int set_midi_option (const std::string&);
222 std::string midi_option () const;
224 std::vector<DeviceStatus> enumerate_midi_devices () const {
225 return std::vector<AudioBackend::DeviceStatus> ();
227 int set_midi_device_enabled (std::string const, bool) {
230 bool midi_device_enabled (std::string const) const {
234 // really private, but needing static access:
235 int process_callback(uint32_t, uint64_t);
236 void error_callback();
237 void xrun_callback();
238 void buffer_size_callback();
239 void sample_rate_callback();
240 void hw_changed_callback();
244 int _start (bool for_latency_measurement);
247 int freewheel (bool);
248 float dsp_load () const;
249 size_t raw_buffer_size (DataType t);
252 framepos_t sample_time ();
253 framepos_t sample_time_at_cycle_start ();
254 pframes_t samples_since_cycle_start ();
256 int create_process_thread (boost::function<void()> func);
257 int join_process_threads ();
258 bool in_process_thread ();
259 uint32_t process_thread_count ();
261 void update_latencies ();
265 void* private_handle () const;
266 const std::string& my_name () const;
267 bool available () const;
268 uint32_t port_name_size () const;
270 int set_port_name (PortHandle, const std::string&);
271 std::string get_port_name (PortHandle) const;
272 PortHandle get_port_by_name (const std::string&) const;
273 int get_port_property (PortHandle, const std::string& key, std::string& value, std::string& type) const;
275 int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&) const;
277 DataType port_data_type (PortHandle) const;
279 PortHandle register_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
280 void unregister_port (PortHandle);
282 int connect (const std::string& src, const std::string& dst);
283 int disconnect (const std::string& src, const std::string& dst);
284 int connect (PortHandle, const std::string&);
285 int disconnect (PortHandle, const std::string&);
286 int disconnect_all (PortHandle);
288 bool connected (PortHandle, bool process_callback_safe);
289 bool connected_to (PortHandle, const std::string&, bool process_callback_safe);
290 bool physically_connected (PortHandle, bool process_callback_safe);
291 int get_connections (PortHandle, std::vector<std::string>&, bool process_callback_safe);
294 int midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index);
295 int midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
296 uint32_t get_midi_event_count (void* port_buffer);
297 void midi_clear (void* port_buffer);
301 bool can_monitor_input () const;
302 int request_input_monitoring (PortHandle, bool);
303 int ensure_input_monitoring (PortHandle, bool);
304 bool monitoring_input (PortHandle);
306 /* Latency management */
308 void set_latency_range (PortHandle, bool for_playback, LatencyRange);
309 LatencyRange get_latency_range (PortHandle, bool for_playback);
311 /* Discovering physical ports */
313 bool port_is_physical (PortHandle) const;
314 void get_physical_outputs (DataType type, std::vector<std::string>&);
315 void get_physical_inputs (DataType type, std::vector<std::string>&);
316 ChanCount n_physical_outputs () const;
317 ChanCount n_physical_inputs () const;
319 /* Getting access to the data buffer for a port */
321 void* get_buffer (PortHandle, pframes_t);
323 void* freewheel_thread ();
325 void coremidi_rediscover ();
328 std::string _instance_name;
329 CoreAudioPCM *_pcmio;
332 bool _run; /* keep going or stop, ardour thread */
333 bool _active_ca; /* is running, process thread */
334 bool _active_fw; /* is running, process thread */
339 bool _reinit_thread_callback;
340 bool _measure_latency;
342 uint64_t _last_process_start;
344 pthread_mutex_t _process_callback_mutex;
346 pthread_mutex_t _freewheel_mutex;
347 pthread_cond_t _freewheel_signal;
349 static std::vector<std::string> _midi_options;
350 static std::vector<AudioBackend::DeviceStatus> _input_audio_device_status;
351 static std::vector<AudioBackend::DeviceStatus> _output_audio_device_status;
352 static std::vector<AudioBackend::DeviceStatus> _duplex_audio_device_status;
353 static std::vector<AudioBackend::DeviceStatus> _midi_device_status;
355 mutable std::string _input_audio_device;
356 mutable std::string _output_audio_device;
357 std::string _midi_driver_option;
361 size_t _samples_per_period;
362 static size_t _max_buffer_size;
367 uint32_t _systemic_audio_input_latency;
368 uint32_t _systemic_audio_output_latency;
370 /* coreaudio specific */
371 uint32_t name_to_id(std::string) const;
375 ARDOUR::DSPLoadCalculator _dsp_load_calc;
376 uint64_t _processed_samples;
378 pthread_t _main_thread;
379 pthread_t _freeewheel_thread;
381 /* process threads */
382 static void* coreaudio_process_thread (void *);
383 std::vector<pthread_t> _threads;
386 CoreAudioBackend* engine;
387 boost::function<void ()> f;
390 ThreadData (CoreAudioBackend* e, boost::function<void ()> fp, size_t stacksz)
391 : engine (e) , f (fp) , stacksize (stacksz) {}
395 PortHandle add_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
396 int register_system_audio_ports ();
397 void unregister_ports (bool system_only = false);
399 std::vector<CoreBackendPort *> _ports;
400 std::vector<CoreBackendPort *> _system_inputs;
401 std::vector<CoreBackendPort *> _system_outputs;
402 std::vector<CoreBackendPort *> _system_midi_in;
403 std::vector<CoreBackendPort *> _system_midi_out;
405 struct PortConnectData {
410 PortConnectData (const std::string& a, const std::string& b, bool c)
411 : a (a) , b (b) , c (c) {}
414 std::vector<PortConnectData *> _port_connection_queue;
415 pthread_mutex_t _port_callback_mutex;
416 bool _port_change_flag;
418 void port_connect_callback (const std::string& a, const std::string& b, bool conn) {
419 pthread_mutex_lock (&_port_callback_mutex);
420 _port_connection_queue.push_back(new PortConnectData(a, b, conn));
421 pthread_mutex_unlock (&_port_callback_mutex);
424 void port_connect_add_remove_callback () {
425 pthread_mutex_lock (&_port_callback_mutex);
426 _port_change_flag = true;
427 pthread_mutex_unlock (&_port_callback_mutex);
430 bool valid_port (PortHandle port) const {
431 return std::find (_ports.begin (), _ports.end (), (CoreBackendPort*)port) != _ports.end ();
434 CoreBackendPort * find_port (const std::string& port_name) const {
435 for (std::vector<CoreBackendPort*>::const_iterator it = _ports.begin (); it != _ports.end (); ++it) {
436 if ((*it)->name () == port_name) {
443 CoreBackendPort * find_port_in (std::vector<CoreBackendPort *> plist, const std::string& port_name) const {
444 for (std::vector<CoreBackendPort*>::const_iterator it = plist.begin (); it != plist.end (); ++it) {
445 if ((*it)->name () == port_name) {
452 #ifdef USE_MIDI_PARSER
454 bool midi_process_byte (const uint8_t);
456 void midi_record_byte (uint8_t byte) {
457 if (_total_bytes < sizeof (_parser_buffer)) {
458 _parser_buffer[_total_bytes] = byte;
465 void midi_prepare_byte_event (const uint8_t byte) {
466 _parser_buffer[0] = byte;
470 bool midi_prepare_buffered_event () {
471 const bool result = _unbuffered_bytes == 0;
473 _parser_bytes = _total_bytes;
476 _unbuffered_bytes = 0;
477 if (_status_byte >= 0xf0) {
484 size_t _unbuffered_bytes;
486 size_t _expected_bytes;
487 uint8_t _status_byte;
488 uint8_t _parser_buffer[128];
489 uint8_t _parser_bytes;
492 }; // class CoreAudioBackend
496 #endif /* __libbackend_coreaudio_backend_h__ */