dx::coreaudio::driver< device_t > Class Template Reference

#include <dx_coreaudio_driver.h>

Inheritance diagram for dx::coreaudio::driver< device_t >:

Collaboration diagram for dx::coreaudio::driver< device_t >:

Public Member Functions
virtual bool	boot () try
void	exception (const class exception &exception, bool filtered=false) noexcept override try
	notification exception handler
virtual void	exception (const exception &exception, bool filtered=false) noexcept=0
	notification exception handler
virtual bool	shutdown () try
	client driver::shutdown/boot(): override to shutdown/boot host driver

Public Attributes
T	elements
	STL member.
K	keys
	STL member.
bool	launched {}
log	log
decltype(device_t::preference)	preference
const char *	product_id
uint32_t	version

Protected Types
typedef decltype(device_t::id)	device_id_t

Protected Member Functions
void	add (const device_id_t &device_id) override try
	adds a new device to the device list
dx_catchall_rethrow() using super void	add (const std::string &id, const typename device_t::desc_t &desc) try
virtual void	arrived ()
	notify device arrivals completed stub
dx_catchall_rethrow() using super void	arrived (device_t &device) override try
	notify specific device arrival stub
	catch (...)
	catch (...)
	catch (...)
	catch (...)
	catch (const dx::exception &__dx_exception)
	catch (const dx::exception &__dx_exception)
	catch (const dx::exception &__dx_exception)
	catch (const dx::exception &__dx_exception)
	catch (const std::exception &__std_exception)
	catch (const std::exception &__std_exception)
	catch (const std::exception &__std_exception)
	catch (const std::exception &__std_exception)
void	clear () noexcept try
	replaces std::map::clear to call virtual notification methods
void	conclude () noexcept override try
	conclude notification: object will be removed. If you overwrite conclude() you also need to overwrite destructor and check if its needed to be called from there.
	driver (const match &matching_ids, const char *product_id, dx::log log={})
	the driver interface class constructor
	dx_catchall_handler (this,) virtual void operator<<(std
	restores device settings
	dx_catchall_rethrow () bool connect() try
	connect to matching CoreAudio server plugin root
	dx_catchall_rethrow () void launch() override try
void	info (std::ostream &os) noexcept override
	log object class information
void	launch () override try
	launch notification: object mounted and ready to use
virtual void	notify (::AudioObjectID id, const property::addresses &addresses) try
dx::log	operator= (const dx::log &log) override try
virtual void	operator>> (std::ostream &ostream) const
	saves device tree
dx_catchall_rethrow() using typename super std::shared_ptr< device_t >	operator[] (const std::string &id) try
void	remove (const device_id_t &device_id) override try
	finds and removes a device from the device list
dx_catchall_rethrow() using super void	remove (const std::string &id) try
virtual void	removed () noexcept
	notify device removals completed stub
virtual void	removed (device_t &) noexcept
	notify specific device removal stub
virtual void	scan () try

Protected Attributes
dx_catchall_rethrow() public ::AudioObjectID	connection_id = 0
dx_catchall_rethrow() std std::map<::AudioObjectPropertySelector, property::listen >	listen

Member Typedef Documentation

device_id_t

template<typename device_t >

typedef decltype(device_t::id) dx::map::driver< device_t >::device_id_t

protectedinherited

Constructor & Destructor Documentation

driver()

template<class device_t >

dx::coreaudio::driver< device_t >::driver ( const match & matching_ids, const char * product_id, dx::log log = {} )

inlineprotected

the driver interface class constructor

Todo

handle kext blocking https://developer.apple.com/library/content/technotes/tn2459/_index.html

Parameters

matching_ids	the matching dictionaries identifying the driver interface
product_id	drivers bundle ID

Member Function Documentation

add() [1/2]

template<typename device_t >

void dx::map::driver< device_t >::add ( const device_id_t & device_id )

inlineoverrideprotectedvirtualinherited

adds a new device to the device list

Exceptions

dx::exception

Implements dx::driver< decltype(device_t::id), decltype(device_t::preference)>.

Reimplemented in dx::virtuel::driver< device_t >, and dx::proxy::driver< device_t >.

Here is the call graph for this function:

add() [2/2]

template<class device_t >

dx_catchall_rethrow() using super void dx::coreaudio::driver< device_t >::add ( const std::string & id, const typename device_t::desc_t & desc )

inlineprotected

Here is the caller graph for this function:

arrived() [1/2]

template<typename device_t >

virtual void dx::driver< device_id_t, preference_t >::arrived ( )

inlineprotectedvirtualinherited

notify device arrivals completed stub

Reimplemented from dx::driver< decltype(device_t::id), decltype(device_t::preference)>.

Reimplemented in dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >, dx::stream::engine< device< super_device_t >, audio_pin_t, dx::proxy::driver< device< super_device_t > >, int32_t >, dx::stream::engine< dx::test::device< super_device_t >, audio_pin_t, dx::proxy::driver< dx::test::device< super_device_t > >, int32_t >, dx::stream::engine< dx::test::device< super_device_t >, audio_pin_t, dx::virtuel::driver< dx::test::device< super_device_t > >, int32_t >, and dx::stream::engine< dx::test::midi::device< super_device_t >, audio_pin_t, dx::proxy::driver< dx::test::midi::device< super_device_t > >, int32_t >.

Here is the caller graph for this function:

arrived() [2/2]

template<class device_t >

dx_catchall_rethrow() using super void dx::coreaudio::driver< device_t >::arrived ( device_t & )

inlineoverrideprotectedvirtual

notify specific device arrival stub

Reimplemented from dx::map::driver< device_t >.

boot()

virtual bool dx::driver< decltype(device_t::id) , decltype(device_t::preference) >::boot ( )

inlinevirtualinherited

catch() [1/12]

template<typename device_t >

dx::map::driver< device_t >::catch ( ... )

inlineprotectedinherited

catch() [2/12]

template<typename device_t >

dx::map::driver< device_t >::catch ( ... )

inlineprotectedinherited

catch() [3/12]

template<typename device_t >

dx::map::driver< device_t >::catch ( ... )

inlineprotectedinherited

catch() [4/12]

template<typename device_t >

dx::map::driver< device_t >::catch ( ... )

inlineprotectedinherited

catch() [5/12]

template<typename device_t >

dx::map::driver< device_t >::catch ( const dx::exception & __dx_exception )

inlineprotectedinherited

catch() [6/12]

template<typename device_t >

dx::map::driver< device_t >::catch ( const dx::exception & __dx_exception )

inlineprotectedinherited

catch() [7/12]

template<typename device_t >

dx::map::driver< device_t >::catch ( const dx::exception & __dx_exception )

inlineprotectedinherited

catch() [8/12]

template<typename device_t >

dx::map::driver< device_t >::catch ( const dx::exception & __dx_exception )

inlineprotectedinherited

catch() [9/12]

template<typename device_t >

dx::map::driver< device_t >::catch ( const std::exception & __std_exception )

inlineprotectedinherited

catch() [10/12]

template<typename device_t >

dx::map::driver< device_t >::catch ( const std::exception & __std_exception )

inlineprotectedinherited

catch() [11/12]

template<typename device_t >

dx::map::driver< device_t >::catch ( const std::exception & __std_exception )

inlineprotectedinherited

catch() [12/12]

template<typename device_t >

dx::map::driver< device_t >::catch ( const std::exception & __std_exception )

inlineprotectedinherited

clear()

template<typename device_t >

void dx::map::driver< device_t >::clear ( )

inlineprotectednoexceptinherited

replaces std::map::clear to call virtual notification methods

Here is the call graph for this function:

Here is the caller graph for this function:

conclude()

template<typename device_t >

void dx::map::driver< device_t >::conclude ( )

inlineoverrideprotectedvirtualnoexceptinherited

conclude notification: object will be removed. If you overwrite conclude() you also need to overwrite destructor and check if its needed to be called from there.

Reimplemented from dx::object.

Here is the call graph for this function:

Here is the caller graph for this function:

dx_catchall_handler()

template<typename device_t >

dx::map::driver< device_t >::dx_catchall_handler ( this )

inlineprotectedinherited

restores device settings

dx_catchall_rethrow() [1/2]

template<class device_t >

dx::coreaudio::driver< device_t >::dx_catchall_rethrow ( )

inlineprotected

connect to matching CoreAudio server plugin root

dx_catchall_rethrow() [2/2]

template<class device_t >

dx::coreaudio::driver< device_t >::dx_catchall_rethrow ( )

inlineoverrideprotected

exception() [1/2]

void dx::driver< decltype(device_t::id) , decltype(device_t::preference) >::exception ( const class exception & exception, bool filtered = false )

inlineoverridenoexceptinherited

notification exception handler

exception() [2/2]

virtual void dx::object::exception ( const exception & exception, bool filtered = false )

pure virtualnoexceptinherited

notification exception handler

Implemented in dx::device< dx::guid, dx::preference >, dx::device< dx::guid, preference_t >, dx::device< std::string, dx::preference >, dx::device< std::string, preference_t >, dx::device<::AudioObjectID, cf::preference >, dx::device<::AudioObjectID, preference_t >, dx::device<::io_service_t, dx::preference >, dx::device<::io_service_t, preference_t >, dx::device<::MIDIDeviceRef, cf::preference >, dx::device<::MIDIDeviceRef, preference_t >, dx::device< id_t, preference_t >, dx::stream::pin< device_t, _circular_t >, dx::virtuel::stream::_device< desc_t, preference_t, stream_t >, dx::usb::platform::device< preference_t >, dx::asio::client::_device< desc_t, preference_t, stream_t >, dx::proxy::device< dx::preference >, dx::proxy::device<>, and dx::proxy::device< preference_t >.

Here is the caller graph for this function:

info()

template<typename device_t >

void dx::map::driver< device_t >::info ( std::ostream & os )

inlineoverrideprotectedvirtualnoexceptinherited

log object class information

Reimplemented from dx::object.

Reimplemented in dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >, dx::stream::engine< device< super_device_t >, audio_pin_t, dx::proxy::driver< device< super_device_t > >, int32_t >, dx::stream::engine< dx::test::device< super_device_t >, audio_pin_t, dx::proxy::driver< dx::test::device< super_device_t > >, int32_t >, dx::stream::engine< dx::test::device< super_device_t >, audio_pin_t, dx::virtuel::driver< dx::test::device< super_device_t > >, int32_t >, dx::stream::engine< dx::test::midi::device< super_device_t >, audio_pin_t, dx::proxy::driver< dx::test::midi::device< super_device_t > >, int32_t >, dx::virtuel::driver< device_t >, dx::test::driver< super_device_t, audio_pin_t, io_t, device_t, driver_t, engine_t >, and dx::test::usb::driver< super_device_t, audio_pin_t, io_t, device_t, driver_t, engine_t >.

Here is the call graph for this function:

Here is the caller graph for this function:

launch()

template<typename device_t >

void dx::map::driver< device_t >::launch ( )

inlineoverrideprotectedvirtualinherited

launch notification: object mounted and ready to use

Reimplemented from dx::object.

Reimplemented in dx::virtuel::driver< device_t >, dx::proxy::driver< device_t >, and dx::proxy::driver< device_t >.

Here is the call graph for this function:

Here is the caller graph for this function:

notify()

template<class device_t >

virtual void dx::coreaudio::driver< device_t >::notify ( ::AudioObjectID id, const property::addresses & addresses )

inlineprotectedvirtual

Todo

coreaudio::driver::notify(): evaluate other synchronization options

Here is the call graph for this function:

operator=()

template<class device_t >

dx::log dx::coreaudio::driver< device_t >::operator= ( const dx::log & log )

inlineoverrideprotectedvirtual

Reimplemented from dx::driver< decltype(device_t::id), decltype(device_t::preference)>.

operator>>()

template<typename device_t >

virtual void dx::map::driver< device_t >::operator>> ( std::ostream & ostream ) const

inlineprotectedvirtualinherited

saves device tree

operator[]()

template<class device_t >

dx_catchall_rethrow() using typename super std::shared_ptr< device_t > dx::coreaudio::driver< device_t >::operator[] ( const std::string & id )

inlineprotected

remove() [1/2]

template<typename device_t >

void dx::map::driver< device_t >::remove ( const device_id_t & device_id )

inlineoverrideprotectedvirtualinherited

finds and removes a device from the device list

Exceptions

dx::exception

Implements dx::driver< decltype(device_t::id), decltype(device_t::preference)>.

Here is the call graph for this function:

Here is the caller graph for this function:

remove() [2/2]

template<class device_t >

dx_catchall_rethrow() using super void dx::coreaudio::driver< device_t >::remove ( const std::string & id )

inlineprotected

Here is the caller graph for this function:

removed() [1/2]

template<typename device_t >

virtual void dx::driver< device_id_t, preference_t >::removed ( )

inlineprotectedvirtualnoexceptinherited

notify device removals completed stub

Reimplemented from dx::driver< decltype(device_t::id), decltype(device_t::preference)>.

Here is the caller graph for this function:

removed() [2/2]

template<typename device_t >

virtual void dx::map::driver< device_t >::removed ( device_t & )

inlineprotectedvirtualnoexceptinherited

notify specific device removal stub

Reimplemented in dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >.

scan()

template<class device_t >

virtual void dx::coreaudio::driver< device_t >::scan ( )

inlineprotectedvirtual

Here is the call graph for this function:

Here is the caller graph for this function:

shutdown()

virtual bool dx::driver< decltype(device_t::id) , decltype(device_t::preference) >::shutdown ( )

inlinevirtualinherited

client driver::shutdown/boot(): override to shutdown/boot host driver

Member Data Documentation

connection_id

template<class device_t >

dx_catchall_rethrow () public ::AudioObjectID dx::coreaudio::driver< device_t >::connection_id = 0

protected

elements

T std::map< K, T >::elements

inherited

STL member.

keys

K std::map< K, T >::keys

inherited

STL member.

launched

bool dx::object::launched {}

inherited

listen

template<class device_t >

dx_catchall_rethrow () std std::map<::AudioObjectPropertySelector, property::listen> dx::coreaudio::driver< device_t >::listen

protected

Initial value:

{
        {::kAudioHardwarePropertyPlugInList,
            {kAudioObjectSystemObject, {.mSelector= ::kAudioHardwarePropertyPlugInList},
                std::bind(&driver::notify, this, std::placeholders::_1, std::placeholders::_2)}},
        {::kAudioHardwarePropertyDevices,
            {::kAudioObjectSystemObject, {.mSelector= ::kAudioHardwarePropertyDevices},
                std::bind(&driver::notify, this, std::placeholders::_1, std::placeholders::_2)}},
    }

log

log dx::driver< decltype(device_t::id) , decltype(device_t::preference) >::log

inherited

preference

decltype(device_t::preference) dx::driver< decltype(device_t::id) , decltype(device_t::preference) >::preference

inherited

product_id

const char* dx::driver< decltype(device_t::id) , decltype(device_t::preference) >::product_id

inherited

version

uint32_t dx::driver< decltype(device_t::id) , decltype(device_t::preference) >::version

inherited

---

The documentation for this class was generated from the following file:

• dx_coreaudio_driver.h