dx::coreaudio::stream::stream< device_t, circular_t > Class Template Reference

#include <dx_coreaudio_stream_device.h>

Inheritance diagram for dx::coreaudio::stream::stream< device_t, circular_t >:

Collaboration diagram for dx::coreaudio::stream::stream< device_t, circular_t >:

Public Types
typedef struct device_t::desc::stream	desc
typedef event< user >	event_t

Public Member Functions
stream &	attach (channel_t **[2], const std::vector< bool > &) try
DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN	catch (const dx::exception &__dx_exception)
	dx_catchall_handler (this,) ~stream() override
virtual bool	encoder (dx::stream::encoder::index::type, unsigned int, float)
void	exception (const class exception &exception, bool filtered=false) const noexcept override
DX_PRAGMA_IGNORE_RETURN_VALUE_END void	flush () override
void	info (std::ostream &os) noexcept override try
virtual DX_PRAGMA_IGNORE_RETURN_VALUE_END void	initialize () try
void	launch () override try
	operator dx::circular * () const noexcept
DX_PRAGMA_IGNORE_RETURN_VALUE_END dx::circular *	operator-> () const noexcept
bool	start (uint64_t frame, unsigned int starting=1) override try
virtual bool	submit (dx::stream::encoder::index::type, unsigned int, uint8_t)
	submit encoder stage to device return true if successfully submitted; if false is returned the encode state machine will not update the stage value (i.e. if the stage can't be submitted during streaming pause), given the chance to submit the stage at start().

Public Attributes
struct {
uint32_t   granularity
uint32_t   linesize
dx::stream::clock::monitor *   monitor
os_result   status
}	cache
event_t	data [direction::directions]
	event signalising data arrival(in) or draining(out)
uint32_t	granularity
const decltype(desc::target.idx())	id
promoted::property< uint32_t >	latency
uint32_t	linesize
dx::stream::clock::monitor *	monitor
decltype(device_t::samplerate) &	samplerate
os_result	status

Protected Member Functions
virtual void	alloc (size_t size, bool free=true)
virtual void	free () noexcept
	overrides may release further alloc()-acquired resources (request buffers, isoc pools, shared-memory attachments) alongside circular; called only from alloc()'s own self-cleanup or the destructor - never from halt()/stop(), so everything alloc() acquires stays live for the object's full lifetime
void	halt () noexcept override

Protected Attributes
dx::circular *	circular
	allocated once by initialize()/alloc(); released only by free()

Member Typedef Documentation

desc

typedef struct device_t::desc::stream dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::desc

inherited

event_t

typedef event<user> dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::event_t

inherited

Member Function Documentation

alloc()

virtual void dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::alloc ( size_t size, bool free = true )

inlineprotectedvirtualinherited

attach()

stream & dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::attach ( channel_t ** [2], const std::vector< bool > &  )

inlineinherited

catch()

DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::catch ( const dx::exception & __dx_exception )

inlineinherited

dx_catchall_handler()

dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::dx_catchall_handler ( this )

inlineoverrideinherited

encoder()

virtual bool dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::encoder ( dx::stream< device_t, dx::circular >::encoder::index::type , unsigned int , float  )

inlinevirtualinherited

exception()

void dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::exception ( const class exception & exception, bool filtered = false ) const

inlineoverridenoexceptinherited

flush()

DX_PRAGMA_IGNORE_RETURN_VALUE_END void dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::flush ( )

inlineoverrideinherited

free()

virtual void dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::free ( )

inlineprotectedvirtualnoexceptinherited

overrides may release further alloc()-acquired resources (request buffers, isoc pools, shared-memory attachments) alongside circular; called only from alloc()'s own self-cleanup or the destructor - never from halt()/stop(), so everything alloc() acquires stays live for the object's full lifetime

halt()

void dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::halt ( )

inlineoverrideprotectednoexceptinherited

info()

void dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::info ( std::ostream< device_t, dx::circular > & os )

inlineoverridenoexceptinherited

initialize()

virtual DX_PRAGMA_IGNORE_RETURN_VALUE_END void dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::initialize ( )

inlinevirtualinherited

launch()

void dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::launch ( )

inlineoverrideinherited

operator dx::circular *()

dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::operator dx::circular * ( ) const

inlinenoexceptinherited

operator->()

DX_PRAGMA_IGNORE_RETURN_VALUE_END dx::circular * dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::operator-> ( ) const

inlinenoexceptinherited

start()

bool dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::start ( uint64_t frame, unsigned int starting = 1 )

inlineoverrideinherited

submit()

virtual bool dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::submit ( dx::stream< device_t, dx::circular >::encoder::index::type , unsigned int , uint8_t  )

inlinevirtualinherited

submit encoder stage to device return true if successfully submitted; if false is returned the encode state machine will not update the stage value (i.e. if the stage can't be submitted during streaming pause), given the chance to submit the stage at start().

Member Data Documentation

[struct]

struct { ... } dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::cache

Todo

: stream::stream::cache needs to be made protected (coreaudio::device requires cache access)

circular

dx::circular* dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::circular

protectedinherited

allocated once by initialize()/alloc(); released only by free()

data

event_t dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::data[direction::directions]

inherited

event signalising data arrival(in) or draining(out)

granularity

uint32_t dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::granularity

inherited

id

const decltype(desc::target.idx()) dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::id

inherited

latency

template<typename device_t, typename circular_t = dx::circular>

promoted::property<uint32_t> dx::coreaudio::stream::stream< device_t, circular_t >::latency

Initial value:

{this->device.id,{
        .mSelector= ::kAudioDevicePropertyLatency,
        .mScope= dx::stream::direction::to::AudioObjectPropertyScope[this->target.direction]}}

linesize

uint32_t dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::linesize

inherited

monitor

dx::stream::clock::monitor* dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::monitor

inherited

samplerate

decltype(device_t::samplerate) & dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::samplerate

inherited

status

os_result dx::stream::stream< device_t, dx::circular, control<object<device_t>>, event<user> >::status

inherited

---

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

• dx_coreaudio_stream_device.h