dxd - dynax driver framework  2981
cross platform open source driver development framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
dx::coremidi::device< io_t, bus_t, desc_t > Class Template Reference

CoreMIDI device. More...

#include <dx_coremidi.h>

+ Inheritance diagram for dx::coremidi::device< io_t, bus_t, desc_t >:
+ Collaboration diagram for dx::coremidi::device< io_t, bus_t, desc_t >:

Public Member Functions

void conclude () noexceptoverride
 removes dx::device from CoreMIDI plugin More...
 
void ctl (unsigned int ioctl) const
 
 device (::io_service_t io_service)
 MIDI streaming device constructor. More...
 
::CFTypeRef get (::CFStringRef key) const
 
::CFTypeRef get (::CFStringRef key,::CFTypeRef dflt) const noexcept
 
template<typename value_t , typename = typename cf::enable_if_convertible<value_t>::type>
value_t get (::CFStringRef key) const
 
template<typename value_t , typename = typename cf::enable_if_convertible<value_t>::type>
value_t get (::CFStringRef key,::CFTypeRef dflt) const noexcept
 
template<typename value_t , typename = typename cf::enable_if_convertible<value_t>::type>
value_t get (::CFStringRef key, value_t dflt) const noexcept
 
template<typename key_t , typename = typename cf::enable_if_convertible<key_t>::type>
::CFTypeRef get (key_t key) const
 
template<typename key_t , typename value_t , typename = typename cf::enable_if_convertible<key_t>::type, typename = typename cf::enable_if_convertible<value_t>::type>
value_t get (key_t key) const
 
template<typename rx_t >
rx_t ictl (unsigned int ioctl) const
 Windows: member ioctl. More...
 
template<typename rx_t >
size_t ictl (unsigned int ioctl, rx_t &rx) const
 
tx_t size_t ioctl (unsigned int ioctl, const tx_t &tx, rx_t &rx) const
 
template<typename rx_t , typename tx_t >
rx_t ioctl (unsigned int ioctl, const tx_t &tx) const
 
size_t ioctl (unsigned int ioctl, const void *tx=nullptr, size_t tx_size=0, void *rx=nullptr, size_t rx_size=0) const
 
template<typename tx_t , typename rx_t >
size_t ioctl (unsigned int ioctl, const tx_t &tx, rx_t &rx) const
 
template<typename rx_t , typename tx_t >
rx_t ioctl (unsigned int ioctl, const tx_t &tx) const
 
void launch () override
 creates dx::device to CoreMIDI plugin as CoreMIDI device More...
 
template<typename tx_t >
void octl (unsigned int ioctl, const tx_t &tx) const
 
 operator const io_registry_entry_t & () const
 auto converter into const object More...
 
 operator io_registry_entry_t & ()
 auto converter into object More...
 
 operator uint64_t () const
 
 operator::CFMutableDictionaryRef () const
 
 operator::HANDLE () const
 
void operator= (::MIDIDriverRef plugin) noexcept
 attaches CoreMIDI plugin parent More...
 
bool operator== (io_registry_entry_tobject) const noexcept
 
::CFTypeRef operator[] (::CFStringRef key) const
 
template<typename key_t , typename = typename std::enable_if<std::is_pod<key_t>::value>>
::CFTypeRef operator[] (key_t key) const
 
registryset (::CFTypeRef properties)
 Setting properties in a registry entry is not generally supported, it is more common to support setting of properties of the connection based property setting of dx::device. More...
 
registryset (::CFStringRef key,::CFTypeRef value) noexcept
 
template<typename value_t , typename = typename cf::enable_if_convertible<value_t>::type>
registryset (::CFStringRef key, value_t value)
 
template<typename key_t , typename = typename cf::enable_if_convertible<key_t>::type>
registryset (key_t key,::CFTypeRef value)
 
template<typename key_t , typename value_t , typename = typename cf::enable_if_convertible<key_t>::type, typename = typename cf::enable_if_convertible<value_t>::type>
registryset (key_t key, value_t value)
 

Public Attributes

::MIDIDeviceRef coremidi_device =0
 
typedef::io_service_t creator
 
bool removed =false
 
 typename
 
 value_t
 

Protected Member Functions

::CFRunLoopRef runloop () noexcept
 

Protected Attributes

struct {
   cf::type< const char * >   bundle_id
 
   cf::type< const char * >   class_name
 
kernel
 
io::port port
 

Detailed Description

template<typename io_t, typename bus_t, typename desc_t>
class dx::coremidi::device< io_t, bus_t, desc_t >

CoreMIDI device.

the CoreMIDI dx::midi::device<> is based on dx::device<> and features the auto generation of shared MIDI streams for all its MIDI pins. Limitation: all MIDI streams supported by this device instanciation need to be of the same bus type and MIDI pin data organisation. (Other non-MIDI streams or pins that are not used by this CoreMIDI plugin don't violete that restriction.

Constructor & Destructor Documentation

template<typename io_t , typename bus_t , typename desc_t >
dx::coremidi::device< io_t, bus_t, desc_t >::device ( ::io_service_t  io_service)
inline

MIDI streaming device constructor.

Todo:
make coremidi_device private

+ Here is the call graph for this function:

Member Function Documentation

template<typename io_t , typename bus_t , typename desc_t >
void dx::coremidi::device< io_t, bus_t, desc_t >::conclude ( )
inlineoverridevirtualnoexcept

removes dx::device from CoreMIDI plugin

Reimplemented from dx::device.

+ Here is the call graph for this function:

void dx::device::ctl ( unsigned int  ioctl) const
inlineinherited
::CFTypeRef dx::io::registry::get ( ::CFStringRef  key) const
inlineinherited
::CFTypeRef dx::io::registry::get ( ::CFStringRef  key,
::CFTypeRef  dflt 
) const
inlinenoexceptinherited
template<typename value_t , typename = typename cf::enable_if_convertible<value_t>::type>
value_t dx::io::registry::get ( ::CFStringRef  key) const
inlineinherited
template<typename value_t , typename = typename cf::enable_if_convertible<value_t>::type>
value_t dx::io::registry::get ( ::CFStringRef  key,
::CFTypeRef  dflt 
) const
inlinenoexceptinherited
template<typename value_t , typename = typename cf::enable_if_convertible<value_t>::type>
value_t dx::io::registry::get ( ::CFStringRef  key,
value_t  dflt 
) const
inlinenoexceptinherited
template<typename key_t , typename = typename cf::enable_if_convertible<key_t>::type>
::CFTypeRef dx::io::registry::get ( key_t  key) const
inlineinherited
template<typename key_t , typename value_t , typename = typename cf::enable_if_convertible<key_t>::type, typename = typename cf::enable_if_convertible<value_t>::type>
value_t dx::io::registry::get ( key_t  key) const
inlineinherited
template<typename rx_t >
rx_t dx::device::ictl ( unsigned int  ioctl) const
inlineinherited

Windows: member ioctl.

this member retreives data from the device by providing an IOCTL code. the template argument defines the type of data to be retreived. this member is intended as a convinient way to retreive only small amounts of data since there is an intermediate stack copy involved in returning the data.

the underlaying windows API is DeviceIoControl(). for detailed information see http://msdn.microsoft.com/en-us/library/aa363216(VS.85).aspx

Exceptions
n/amicrosoft does not give information about what possible errors values are provided by its OS other than
ERROR_INSUFFICIENT_BUFFERif the output buffer is too small to receive any data

+ Here is the caller graph for this function:

template<typename rx_t >
size_t dx::device::ictl ( unsigned int  ioctl,
rx_t &  rx 
) const
inlineinherited
tx_t size_t dx::device::ioctl ( unsigned int  ioctl,
const tx_t &  tx,
rx_t &  rx 
) const
inlineinherited
template<typename rx_t , typename tx_t >
rx_t dx::device::ioctl ( unsigned int  ioctl,
const tx_t &  tx 
) const
inlineinherited
size_t dx::device::ioctl ( unsigned int  ioctl,
const void *  tx = nullptr,
size_t  tx_size = 0,
void *  rx = nullptr,
size_t  rx_size = 0 
) const
inlineinherited
template<typename tx_t , typename rx_t >
size_t dx::device::ioctl ( unsigned int  ioctl,
const tx_t &  tx,
rx_t &  rx 
) const
inlineinherited
template<typename rx_t , typename tx_t >
rx_t dx::device::ioctl ( unsigned int  ioctl,
const tx_t &  tx 
) const
inlineinherited
template<typename io_t , typename bus_t , typename desc_t >
void dx::coremidi::device< io_t, bus_t, desc_t >::launch ( )
inlineoverridevirtual

creates dx::device to CoreMIDI plugin as CoreMIDI device

Todo:
remove operator=(::MIDIDriverRef)

Creates a CoreMIDI entity for each pin, binds the pin to the CoreMIDI endpoint and attaches the CoreMIDI endpoint to the entity. Another option could be to creat a single CoreMIDI entity and attach all CoreMIDI endpoints to it.

creates CoreMIDI device

creates pins from dxd::device description and adds it as CoreMIDI entity to the CoreMIDI device

Reimplemented from dx::device.

+ Here is the call graph for this function:

template<typename tx_t >
void dx::device::octl ( unsigned int  ioctl,
const tx_t &  tx 
) const
inlineinherited
dx::io::reference< io_registry_entry_t >::operator const io_registry_entry_t & ( ) const
inlineinherited

auto converter into const object

dx::io::reference< io_registry_entry_t >::operator io_registry_entry_t & ( )
inlineinherited

auto converter into object

dx::io::registry::operator uint64_t ( ) const
inlineinherited
dx::io::registry::operator::CFMutableDictionaryRef ( ) const
inlineinherited
dx::device::operator::HANDLE ( ) const
inlineinherited

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

template<typename io_t , typename bus_t , typename desc_t >
void dx::coremidi::device< io_t, bus_t, desc_t >::operator= ( ::MIDIDriverRef  plugin)
inlinenoexcept

attaches CoreMIDI plugin parent

bool dx::io::reference< io_registry_entry_t >::operator== ( io_registry_entry_t  object) const
inlinenoexceptinherited
::CFTypeRef dx::io::registry::operator[] ( ::CFStringRef  key) const
inlineinherited
template<typename key_t , typename = typename std::enable_if<std::is_pod<key_t>::value>>
::CFTypeRef dx::io::registry::operator[] ( key_t  key) const
inlineinherited
template<typename io_t , typename bus_t , typename desc_t >
::CFRunLoopRef dx::coremidi::device< io_t, bus_t, desc_t >::runloop ( )
inlineprotectednoexcept
registry& dx::io::registry::set ( ::CFTypeRef  properties)
inlineinherited

Setting properties in a registry entry is not generally supported, it is more common to support setting of properties of the connection based property setting of dx::device.

+ Here is the caller graph for this function:

registry& dx::io::registry::set ( ::CFStringRef  key,
::CFTypeRef  value 
)
inlinenoexceptinherited
template<typename value_t , typename = typename cf::enable_if_convertible<value_t>::type>
registry& dx::io::registry::set ( ::CFStringRef  key,
value_t  value 
)
inlineinherited

+ Here is the call graph for this function:

template<typename key_t , typename = typename cf::enable_if_convertible<key_t>::type>
registry& dx::io::registry::set ( key_t  key,
::CFTypeRef  value 
)
inlineinherited

+ Here is the call graph for this function:

template<typename key_t , typename value_t , typename = typename cf::enable_if_convertible<key_t>::type, typename = typename cf::enable_if_convertible<value_t>::type>
registry& dx::io::registry::set ( key_t  key,
value_t  value 
)
inlineinherited

+ Here is the call graph for this function:

Member Data Documentation

cf::type<const char*> dx::device::bundle_id
inherited
cf::type<const char*> dx::device::class_name
inherited
template<typename io_t , typename bus_t , typename desc_t >
::MIDIDeviceRef dx::coremidi::device< io_t, bus_t, desc_t >::coremidi_device =0
typedef::io_service_t dx::device::creator
inherited
struct { ... } dx::device::kernel
io::port dx::device::port
protectedinherited
bool dx::device::removed =false
inherited
dx::device::typename
inherited
Initial value:
= typename cf::enable_if_convertible<value_t>::type>
registry& set (::CFStringRef key, value_t value) {
return set (key, cf::type<value_t>(value));
}
template<typename key_t
dx::device::value_t
inherited

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

(c) copyright 2009 dynamic acoustics e.U. generated on Tue Nov 19 2019

a closed source license may be obtained by requesting a written permission from dynamic acoustics e.U.
however - governmental use generally and military use especially is strictly prohibited though.