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; } }
152 void parse_events (const uint64_t time, const uint8_t *data, const size_t size);
153 void clear_events ();
156 CoreMidiBuffer _buffer[2];
160 int queue_event (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
161 bool process_byte (const uint64_t, const uint8_t);
163 void record_byte(uint8_t byte) {
164 if (_total_bytes < sizeof(_parser_buffer)) {
165 _parser_buffer[_total_bytes] = byte;
172 void prepare_byte_event(const uint64_t time, const uint8_t byte) {
173 _parser_buffer[0] = byte;
174 _event.prepare(time, 1);
177 bool prepare_buffered_event(const uint64_t time) {
178 const bool result = _unbuffered_bytes == 0;
180 _event.prepare(time, _total_bytes);
183 _unbuffered_bytes = 0;
184 if (_status_byte >= 0xf0) {
195 ParserEvent (const uint64_t time, const size_t size)
200 void prepare(const uint64_t time, const size_t size) {
208 size_t _unbuffered_bytes;
210 size_t _expected_bytes;
211 uint8_t _status_byte;
212 uint8_t _parser_buffer[1024];
214 }; // class CoreMidiPort
216 class CoreAudioBackend : public AudioBackend {
217 friend class CoreBackendPort;
219 CoreAudioBackend (AudioEngine& e, AudioBackendInfo& info);
220 ~CoreAudioBackend ();
222 /* AUDIOBACKEND API */
224 std::string name () const;
225 bool is_realtime () const;
227 bool use_separate_input_and_output_devices () const { return true; }
228 std::vector<DeviceStatus> enumerate_devices () const;
229 std::vector<DeviceStatus> enumerate_input_devices () const;
230 std::vector<DeviceStatus> enumerate_output_devices () const;
232 std::vector<float> available_sample_rates (const std::string& device) const;
233 std::vector<float> available_sample_rates2 (const std::string&, const std::string&) const;
234 std::vector<uint32_t> available_buffer_sizes (const std::string& device) const;
235 std::vector<uint32_t> available_buffer_sizes2 (const std::string&, const std::string&) const;
236 uint32_t available_input_channel_count (const std::string& device) const;
237 uint32_t available_output_channel_count (const std::string& device) const;
239 bool can_change_sample_rate_when_running () const;
240 bool can_change_buffer_size_when_running () const;
242 int set_device_name (const std::string&);
243 int set_input_device_name (const std::string&);
244 int set_output_device_name (const std::string&);
245 int set_sample_rate (float);
246 int set_buffer_size (uint32_t);
247 int set_interleaved (bool yn);
248 int set_input_channels (uint32_t);
249 int set_output_channels (uint32_t);
250 int set_systemic_input_latency (uint32_t);
251 int set_systemic_output_latency (uint32_t);
252 int set_systemic_midi_input_latency (std::string const, uint32_t) { return 0; }
253 int set_systemic_midi_output_latency (std::string const, uint32_t) { return 0; }
255 int reset_device () { return 0; };
257 /* Retrieving parameters */
258 std::string device_name () const;
259 std::string input_device_name () const;
260 std::string output_device_name () const;
261 float sample_rate () const;
262 uint32_t buffer_size () const;
263 bool interleaved () const;
264 uint32_t input_channels () const;
265 uint32_t output_channels () const;
266 uint32_t systemic_input_latency () const;
267 uint32_t systemic_output_latency () const;
268 uint32_t systemic_midi_input_latency (std::string const) const { return 0; }
269 uint32_t systemic_midi_output_latency (std::string const) const { return 0; }
271 bool can_set_systemic_midi_latencies () const { return false; /* XXX */}
273 /* External control app */
274 std::string control_app_name () const { return std::string ("Apple"); }
275 void launch_control_app ();
278 std::vector<std::string> enumerate_midi_options () const;
279 int set_midi_option (const std::string&);
280 std::string midi_option () const;
282 std::vector<DeviceStatus> enumerate_midi_devices () const {
283 return std::vector<AudioBackend::DeviceStatus> ();
285 int set_midi_device_enabled (std::string const, bool) {
288 bool midi_device_enabled (std::string const) const {
292 // really private, but needing static access:
293 int process_callback(uint32_t, uint64_t);
294 void error_callback();
295 void xrun_callback();
296 void buffer_size_callback();
297 void sample_rate_callback();
298 void hw_changed_callback();
302 int _start (bool for_latency_measurement);
305 int freewheel (bool);
306 float dsp_load () const;
307 size_t raw_buffer_size (DataType t);
310 framepos_t sample_time ();
311 framepos_t sample_time_at_cycle_start ();
312 pframes_t samples_since_cycle_start ();
314 int create_process_thread (boost::function<void()> func);
315 int join_process_threads ();
316 bool in_process_thread ();
317 uint32_t process_thread_count ();
319 void update_latencies ();
323 void* private_handle () const;
324 const std::string& my_name () const;
325 bool available () const;
326 uint32_t port_name_size () const;
328 int set_port_name (PortHandle, const std::string&);
329 std::string get_port_name (PortHandle) const;
330 PortHandle get_port_by_name (const std::string&) const;
331 int get_port_property (PortHandle, const std::string& key, std::string& value, std::string& type) const;
333 int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&) const;
335 DataType port_data_type (PortHandle) const;
337 PortHandle register_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
338 void unregister_port (PortHandle);
340 int connect (const std::string& src, const std::string& dst);
341 int disconnect (const std::string& src, const std::string& dst);
342 int connect (PortHandle, const std::string&);
343 int disconnect (PortHandle, const std::string&);
344 int disconnect_all (PortHandle);
346 bool connected (PortHandle, bool process_callback_safe);
347 bool connected_to (PortHandle, const std::string&, bool process_callback_safe);
348 bool physically_connected (PortHandle, bool process_callback_safe);
349 int get_connections (PortHandle, std::vector<std::string>&, bool process_callback_safe);
352 int midi_event_get (pframes_t& timestamp, size_t& size, uint8_t** buf, void* port_buffer, uint32_t event_index);
353 int midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size) {
354 return _midi_event_put (port_buffer, timestamp, buffer, size);
357 uint32_t get_midi_event_count (void* port_buffer);
358 void midi_clear (void* port_buffer);
362 bool can_monitor_input () const;
363 int request_input_monitoring (PortHandle, bool);
364 int ensure_input_monitoring (PortHandle, bool);
365 bool monitoring_input (PortHandle);
367 /* Latency management */
369 void set_latency_range (PortHandle, bool for_playback, LatencyRange);
370 LatencyRange get_latency_range (PortHandle, bool for_playback);
372 /* Discovering physical ports */
374 bool port_is_physical (PortHandle) const;
375 void get_physical_outputs (DataType type, std::vector<std::string>&);
376 void get_physical_inputs (DataType type, std::vector<std::string>&);
377 ChanCount n_physical_outputs () const;
378 ChanCount n_physical_inputs () const;
380 /* Getting access to the data buffer for a port */
382 void* get_buffer (PortHandle, pframes_t);
384 void* freewheel_thread ();
386 void coremidi_rediscover ();
388 static int _midi_event_put (void* port_buffer, pframes_t timestamp, const uint8_t* buffer, size_t size);
391 std::string _instance_name;
392 CoreAudioPCM *_pcmio;
395 bool _run; /* keep going or stop, ardour thread */
396 bool _active_ca; /* is running, process thread */
397 bool _active_fw; /* is running, process thread */
402 bool _reinit_thread_callback;
403 bool _measure_latency;
405 uint64_t _last_process_start;
407 pthread_mutex_t _process_callback_mutex;
409 pthread_mutex_t _freewheel_mutex;
410 pthread_cond_t _freewheel_signal;
412 static std::vector<std::string> _midi_options;
413 static std::vector<AudioBackend::DeviceStatus> _input_audio_device_status;
414 static std::vector<AudioBackend::DeviceStatus> _output_audio_device_status;
415 static std::vector<AudioBackend::DeviceStatus> _duplex_audio_device_status;
416 static std::vector<AudioBackend::DeviceStatus> _midi_device_status;
418 mutable std::string _input_audio_device;
419 mutable std::string _output_audio_device;
420 std::string _midi_driver_option;
424 size_t _samples_per_period;
425 static size_t _max_buffer_size;
430 uint32_t _systemic_audio_input_latency;
431 uint32_t _systemic_audio_output_latency;
433 /* coreaudio specific */
434 uint32_t name_to_id(std::string) const;
438 ARDOUR::DSPLoadCalculator _dsp_load_calc;
439 uint64_t _processed_samples;
441 pthread_t _main_thread;
442 pthread_t _freeewheel_thread;
444 /* process threads */
445 static void* coreaudio_process_thread (void *);
446 std::vector<pthread_t> _threads;
449 CoreAudioBackend* engine;
450 boost::function<void ()> f;
453 ThreadData (CoreAudioBackend* e, boost::function<void ()> fp, size_t stacksz)
454 : engine (e) , f (fp) , stacksize (stacksz) {}
458 PortHandle add_port (const std::string& shortname, ARDOUR::DataType, ARDOUR::PortFlags);
459 int register_system_audio_ports ();
460 void unregister_ports (bool system_only = false);
462 std::vector<CoreBackendPort *> _ports;
463 std::vector<CoreBackendPort *> _system_inputs;
464 std::vector<CoreBackendPort *> _system_outputs;
465 std::vector<CoreBackendPort *> _system_midi_in;
466 std::vector<CoreBackendPort *> _system_midi_out;
468 struct PortConnectData {
473 PortConnectData (const std::string& a, const std::string& b, bool c)
474 : a (a) , b (b) , c (c) {}
477 std::vector<PortConnectData *> _port_connection_queue;
478 pthread_mutex_t _port_callback_mutex;
479 bool _port_change_flag;
481 void port_connect_callback (const std::string& a, const std::string& b, bool conn) {
482 pthread_mutex_lock (&_port_callback_mutex);
483 _port_connection_queue.push_back(new PortConnectData(a, b, conn));
484 pthread_mutex_unlock (&_port_callback_mutex);
487 void port_connect_add_remove_callback () {
488 pthread_mutex_lock (&_port_callback_mutex);
489 _port_change_flag = true;
490 pthread_mutex_unlock (&_port_callback_mutex);
493 bool valid_port (PortHandle port) const {
494 return std::find (_ports.begin (), _ports.end (), (CoreBackendPort*)port) != _ports.end ();
497 CoreBackendPort * find_port (const std::string& port_name) const {
498 for (std::vector<CoreBackendPort*>::const_iterator it = _ports.begin (); it != _ports.end (); ++it) {
499 if ((*it)->name () == port_name) {
506 CoreBackendPort * find_port_in (std::vector<CoreBackendPort *> plist, const std::string& port_name) const {
507 for (std::vector<CoreBackendPort*>::const_iterator it = plist.begin (); it != plist.end (); ++it) {
508 if ((*it)->name () == port_name) {
515 }; // class CoreAudioBackend
519 #endif /* __libbackend_coreaudio_backend_h__ */