|
dxd - dynax driver framework 3.0.1d223
cross platform open source driver development framework
|
CoreAudio client device. More...
#include <dx_coreaudio_device.h>
Classes | |
| struct | mirror |
| a setting the device's host keeps (dx::stream::setting) mirrored: a promoted property of the plugin's device, addressed by the setting and its stream's index - as service::client::device::mirror over the pipe More... | |
Public Types | |
| typedef dx::virtuel::stream::desc | desc_t |
| typedef event | event_t |
| typedef promoted< uint32_t >::template preference< decltype(super_device_t::preference)> | source_t |
| typedef dx::stream::stream< device< dx::virtuel::stream::desc, cf::preference, dx::stream::stream, group, false > > | stream_t |
| typedef dx::device<::AudioObjectID, cf::preference > | super_device_t |
| the device this streaming device sits on: its own operations of a name this class takes for itself (a USB device's configuration()) are reached through it | |
| typedef desc | value_t |
Public Member Functions | |
| struct stream * | align (struct stream *sync_reference) |
| the given stream where it may be the sync reference, else the first one that may - what a stored reference is aligned to when the desc changed under it | |
| uint32_t | align (uint32_t sync_reference) const |
| virtual desc_t::configuration | align (const typename desc_t::configuration &value, const typename desc_t::configuration &) |
| a configuration the device can run: every stream's index within its configurations, one past them the stream off - a bus device narrows it to what its bus carries, the streams value leaves as current has them standing | |
| void | attach (channel_t **io[dx::stream::direction::directions][2], const std::vector< bool >(&channel_map)[2]) |
| configuration | bound (configuration value, const configuration ¤t, align_t &&align, bind_t &&bind) const |
| virtual uint64_t | budget (const typename desc_t::configuration &) |
| the periodic bus time the configuration takes, in ns - a bus device with a periodic budget states it | |
| void | conclude () noexcept override |
| ends every group's session before the device's resources go; the start counts stay with their holders | |
| uint32_t | enumerate (const format &format=any) const |
| enumerate typified pins | |
| void | exception (const dx::exception &exception, bool filtered=false) const noexcept override |
| notification exception handler | |
| struct stream * | find (const decltype(stream::target.idx())&target) |
| struct stream * | find (const format &format=any, enum direction::direction direction=direction::any) |
| struct stream * | find (const target &target) |
| struct stream * | find (uint32_t &pin, const format &format=any, enum direction::direction direction=direction::any) |
| finds and returns the stream description and pin idx into this stream | |
| virtual uint64_t | frame () const |
| virtual void | hw_clock (abstract::event *hw_clock, uint32_t iosize) |
| registers a consumer with the device's clock: it is signalled every iosize samples of the clock's own advance. A bus whose driver owns the clock hands the registration on instead | |
| std::shared_ptr< stream_t > | open (const typename dx::virtuel::stream::desc::stream::desc &desc) |
| the desc's stream: the registered one, else created, registered and launched | |
| const struct desc_t::stream::config & | operator() (const struct desc_t::stream &stream) |
| the stream configuration the device runs the stream in: the stream is one of the desc's | |
| bool | operator== (const desc &desc) const |
| virtual device & | operator>> (std::ostream &) const |
| the device's own diagnostics, beyond its operator << | |
| group_t & | operator[] (const typename dx::virtuel::stream::desc::stream::desc &stream) |
| the stream's group, created on first use | |
| configuration | preferred (align_t &&align) const |
| virtual _device & | reset () |
| void | setting (dx::stream::setting setting, uint32_t index, f_t &&f) |
| the setting a host keeps for its clients handed to f as its promoted: the transport settings the sync reference's group's, the source the one of the stream whose target index is index | |
| virtual void | sleep () |
| notify system will sleep stub | |
| virtual std::pair< source_t &, bool > | source (const struct dx::virtuel::stream::desc::stream &stream) |
| the stream's source selector, created on first use: the preference by stream target, the value an index into the stream's sources | |
| std::string | string (uint8_t idx) |
| uint32_t | sync_reference (struct stream *sync_reference) |
| struct stream * | sync_reference (uint32_t sync_reference) |
| the n-th stream qualifying as sync reference, and the twin below the index of a given one - the two directions of the preference's value | |
| bool | try_conclude () noexcept |
| atomically conclude()s if currently launched; returns whether this call did it | |
| bool | try_launch () |
| atomically launch()es if not already launched; returns whether this call did it. A launch() that throws is concluded before the exception leaves: the object never claims a launch it did not finish | |
| void | wake () override |
Public Attributes | |
| dx::stream::bus::bus | bus |
| the bus this device hangs on | |
| promoted::property< typename super::client_map, typename super::client_map::value_t, false > | clients |
| struct dx::stream::desc::clock | clock [1] |
| uint32_t | clocks |
| promoted< uint32_t >::preference< decltype(super::preference)> | clocksource |
| promoted< typenamedesc_t::configuration >::template preference< decltype(super::preference)> | configuration |
| the device's configuration: per stream the stream configuration it runs, the richest by default - a bus device narrows it to what its bus carries (align()), and it stands while a group is started | |
| bool | dflt |
| can be selected as default (OS audio) device | |
| dx::driver< decltype(id), cf::preference > & | driver |
| bool | editable |
| can be edited | |
| struct dx::stream::desc::firmware | firmware |
| std::map< decltype(dx::virtuel::stream::desc::stream::group), group_t > | group |
| bool | hidden |
| hide device | |
| struct dx::stream::device:: { ... } | hw |
| promoted::property< icon, ::CFURLRef, false > | icon |
| dx::coreaudio::_device::clocksource | id |
| promoted< uint32_t >::preference< decltype(super::preference)> | iosize |
| std::atomic< bool > | launched |
| struct dx::stream::desc::name_id | model |
| dx::stream::device::monitor | monitor |
| bool | persistence |
| device has capability to store persistent settings (i.e. sample rate; clock source; etc.) | |
| cf::preference | preference |
| std::string | puid |
| persistent UID - system unique - could change with location | |
| std::string | puuid |
| persistent universal UID - universally unique ID (i.e. serial number) | |
| promoted::property<::Float64 > | samplerate |
| std::map< decltype(dx::virtuel::stream::desc::stream::target.idx()), source_t > | sources |
| direction::direction | start_stop_order |
| struct dx::stream::desc::stream | stream [max_streams] |
| uint32_t | streams |
| number of streams | |
| promoted< structdesc_t::stream * >::template preference< decltype(super::preference), uint32_t > | sync_reference |
| struct dx::stream::desc::name_id | vendor |
| dx::stream::device::monitor | version |
Static Public Attributes | |
| static constexpr bool | hosted = _hosted |
Protected Member Functions | |
| virtual void | grouped (group_t &) |
| operator[](): a group just came into existence, a host wires its per-group transports here | |
| virtual void | launch () |
| launch notification: object mounted and ready to use. Called only through try_launch() - never call this directly from outside the class hierarchy. | |
| virtual void | process (const ::AudioTimeStamp *, const ::AudioBufferList *, const ::AudioTimeStamp *, ::AudioBufferList *, const ::AudioTimeStamp *) |
Protected Attributes | |
| std::vector< std::shared_ptr< typename super::dx::stream::stream< device< dx::virtuel::stream::desc, cf::preference, dx::stream::stream, group, false > > > > | io_streams |
| the streams process() iterates: fixed between AudioDeviceStart and AudioDeviceStop and held for it, so the IOProc never touches the mutable streams map nor a stream its client let go | |
CoreAudio client device.
< the rings and transport settings are another process' (the pod's counterpart) the bus's device as a product composes it; _hosted marks the one whose rings and transport settings belong to another process - the pod's counterpart, which mirrors them through mirror below
| group_t | the app's consumer group (dx::stream::engine::group) wraps this bus's own |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
the device this streaming device sits on: its own operations of a name this class takes for itself (a USB device's configuration()) are reached through it
|
inherited |
|
inlineinherited |
the given stream where it may be the sync reference, else the first one that may - what a stored reference is aligned to when the desc changed under it
|
inlineinherited |
|
inlinevirtualinherited |
a configuration the device can run: every stream's index within its configurations, one past them the stream off - a bus device narrows it to what its bus carries, the streams value leaves as current has them standing
|
inlineinherited |
|
inlineinherited |
the configuration align(value, current) answers for the wish that the streams carry: bind(idx, config) moves a stream to its aligned stream configuration, one it refuses stands as current has it and the wish is aligned around it again - the result is an answer of align
|
inlinevirtualinherited |
the periodic bus time the configuration takes, in ns - a bus device with a periodic budget states it
|
inlineoverridevirtualnoexceptinherited |
ends every group's session before the device's resources go; the start counts stay with their holders
Reimplemented from dx::object.
|
inlineinherited |
enumerate typified pins
|
inlineoverridevirtualnoexceptinherited |
notification exception handler
Implements dx::object.
|
inlineinherited |
|
inlineinherited |
| format | search stream format filter |
| direction | search stream direction filter |
|
inlineinherited |
|
inlineinherited |
finds and returns the stream description and pin idx into this stream
| pin | in: global pin index, out: pin index into returned stream description |
| format | search stream format filter |
| direction | search stream direction filter |
|
inlinevirtualinherited |
|
inlineprotectedvirtualinherited |
operator[](): a group just came into existence, a host wires its per-group transports here
|
inlinevirtualinherited |
registers a consumer with the device's clock: it is signalled every iosize samples of the clock's own advance. A bus whose driver owns the clock hands the registration on instead
|
inlineprotectedvirtualinherited |
launch notification: object mounted and ready to use. Called only through try_launch() - never call this directly from outside the class hierarchy.
|
inlineinherited |
the desc's stream: the registered one, else created, registered and launched
|
inlineinherited |
the stream configuration the device runs the stream in: the stream is one of the desc's
|
inlineinherited |
|
inlinevirtualinherited |
the device's own diagnostics, beyond its operator <<
|
inlineinherited |
the stream's group, created on first use
|
inlineinherited |
the richest configuration align admits (it returns the candidate as it stands): the largest sum of channels times bits over the streams that run, on a tie the richer stream configuration to the smaller stream index - every combination is tried
|
inlineprotectedvirtualinherited |
|
inlinevirtualinherited |
|
inlineinherited |
the setting a host keeps for its clients handed to f as its promoted: the transport settings the sync reference's group's, the source the one of the stream whose target index is index
|
inlinevirtualinherited |
notify system will sleep stub
|
inlinevirtualinherited |
the stream's source selector, created on first use: the preference by stream target, the value an index into the stream's sources
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
the n-th stream qualifying as sync reference, and the twin below the index of a given one - the two directions of the preference's value
|
inlinenoexceptinherited |
atomically conclude()s if currently launched; returns whether this call did it
|
inlineinherited |
|
inlineoverridevirtualinherited |
Reimplemented from dx::device<::AudioObjectID, cf::preference >.
|
inherited |
the bus this device hangs on
|
inherited |
|
inherited |
|
inherited |
number of independent clocks [currenlty only single clock support]
|
inherited |
|
inherited |
the device's configuration: per stream the stream configuration it runs, the richest by default - a bus device narrows it to what its bus carries (align()), and it stands while a group is started
|
inherited |
can be selected as default (OS audio) device
|
inherited |
|
inherited |
can be edited
|
inherited |
|
inherited |
streaming groups by desc::stream::group id: every stream of this device is registered with its group - behind the settings its groups listen to, so they go first
|
inherited |
hide device
|
staticconstexpr |
| struct { ... } dx::stream::device< dx::device<::AudioObjectID, cf::preference >, dx::virtuel::stream::desc, dx::stream::stream< device< dx::virtuel::stream::desc, cf::preference, dx::stream::stream, group, false > >, group< device< dx::virtuel::stream::desc, cf::preference, dx::stream::stream, group, false > > >::hw |
|
inherited |
| inherited |
|
protectedinherited |
the streams process() iterates: fixed between AudioDeviceStart and AudioDeviceStop and held for it, so the IOProc never touches the mutable streams map nor a stream its client let go
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
device has capability to store persistent settings (i.e. sample rate; clock source; etc.)
|
inherited |
|
inherited |
persistent UID - system unique - could change with location
|
inherited |
persistent universal UID - universally unique ID (i.e. serial number)
|
inherited |
|
inherited |
source selectors by stream target: a stream with sources gets its own on first use
|
inherited |
|
inherited |
|
inherited |
number of streams
|
inherited |
|
inherited |
|
inherited |
| (c) copyright 2009 dynamic acoustics e.U. | generated on |