dx::stream::stream< device_t, circular_t, super_stream_t, _event_t > Class Template Reference

#include <dx_stream_stream.h>

Inheritance diagram for dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >:

Collaboration diagram for dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >:

Public Types
typedef struct device_t::desc::stream	desc
typedef _event_t	event_t

Public Member Functions
template<typename channel_t>
stream &	attach (channel_t **[2], const std::vector< bool > &) try
	catch (...)
	catch (...)
	catch (...)
	catch (...)
DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN	catch (const dx::exception &__dx_exception)
DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN	catch (const dx::exception &__dx_exception)
DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN	catch (const dx::exception &__dx_exception)
DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN	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)
	dx_catchall_handler (this,) ~stream() override
virtual float	encoder (dx::stream::encoder::index::type, unsigned int) const
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 circular_t * () const noexcept
DX_PRAGMA_IGNORE_RETURN_VALUE_END circular_t *	operator-> () const noexcept
bool	start (uint64_t frame, unsigned int starting=1) override try
virtual DX_PRAGMA_IGNORE_RETURN_VALUE_END os_result	status () noexcept
	stream (device_t &device, const decltype(id)&id, const desc &desc)
	creates circular streaming backing store and frame buffers
virtual uint8_t	submit (dx::stream::encoder::index::type, unsigned int) const
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)
const decltype(desc::target.idx())	id
uint32_t	latency {}
decltype(device_t::samplerate) &	samplerate

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
circular_t *	circular {}
	allocated once by initialize()/alloc(); released only by free()

Member Typedef Documentation

desc

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

typedef struct device_t::desc::stream dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::desc

event_t

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

typedef _event_t dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::event_t

Constructor & Destructor Documentation

stream()

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::stream ( device_t & device, const decltype(id)& id, const desc & desc )

inline

creates circular streaming backing store and frame buffers

Member Function Documentation

alloc()

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

virtual void dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::alloc ( size_t size, bool free = true )

inlineprotectedvirtual

Reimplemented in dx::stream::shared::stream< device_t, circular_t, super_stream_t, event_t >, and dx::usb::stream::pipe< device_t, circular_t, stream_t >.

attach()

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

template<typename channel_t>

stream & dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::attach ( channel_t ** [2], const std::vector< bool > &  )

inline

catch() [1/12]

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::catch ( ... )

inline

catch() [2/12]

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::catch ( ... )

inline

catch() [3/12]

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::catch ( ... )

inline

catch() [4/12]

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::catch ( ... )

inline

catch() [5/12]

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::catch ( const dx::exception & __dx_exception )

inline

catch() [6/12]

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::catch ( const dx::exception & __dx_exception )

inline

catch() [7/12]

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::catch ( const dx::exception & __dx_exception )

inline

catch() [8/12]

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::catch ( const dx::exception & __dx_exception )

inline

catch() [9/12]

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::catch ( const std::exception & __std_exception )

inline

catch() [10/12]

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::catch ( const std::exception & __std_exception )

inline

catch() [11/12]

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::catch ( const std::exception & __std_exception )

inline

catch() [12/12]

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::catch ( const std::exception & __std_exception )

inline

dx_catchall_handler()

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::dx_catchall_handler ( this )

inlineoverride

encoder() [1/2]

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

virtual float dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::encoder ( dx::stream< device_t, circular_t, super_stream_t, _event_t >::encoder::index::type , unsigned int  ) const

inlinevirtual

encoder() [2/2]

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

virtual bool dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::encoder ( dx::stream< device_t, circular_t, super_stream_t, _event_t >::encoder::index::type , unsigned int , float  )

inlinevirtual

Reimplemented in dx::usb::stream::pipe< device_t, circular_t, stream_t >.

exception()

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

void dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::exception ( const class exception & exception, bool filtered = false ) const

inlineoverridenoexcept

flush()

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

DX_PRAGMA_IGNORE_RETURN_VALUE_END void dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::flush ( )

inlineoverride

free()

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

virtual void dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::free ( )

inlineprotectedvirtualnoexcept

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

Reimplemented in dx::stream::shared::stream< device_t, circular_t, super_stream_t, event_t >, and dx::usb::stream::pipe< device_t, circular_t, stream_t >.

halt()

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

void dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::halt ( )

inlineoverrideprotectednoexcept

Reimplemented in dx::usb::stream::pipe< device_t, circular_t, stream_t >.

info()

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

void dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::info ( std::ostream< device_t, circular_t, super_stream_t, _event_t > & os )

inlineoverridenoexcept

Reimplemented in dx::usb::stream::pipe< device_t, circular_t, stream_t >.

initialize()

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

virtual DX_PRAGMA_IGNORE_RETURN_VALUE_END void dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::initialize ( )

inlinevirtual

Reimplemented in dx::usb::stream::pipe< device_t, circular_t, stream_t >.

launch()

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

void dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::launch ( )

inlineoverride

operator circular_t *()

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::operator circular_t * ( ) const

inlinenoexcept

operator->()

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

DX_PRAGMA_IGNORE_RETURN_VALUE_END circular_t * dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::operator-> ( ) const

inlinenoexcept

start()

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

bool dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::start ( uint64_t frame, unsigned int starting = 1 )

inlineoverride

Reimplemented in dx::usb::stream::pipe< device_t, circular_t, stream_t >.

status()

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

virtual DX_PRAGMA_IGNORE_RETURN_VALUE_END os_result dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::status ( )

inlinevirtualnoexcept

submit() [1/2]

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

virtual uint8_t dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::submit ( dx::stream< device_t, circular_t, super_stream_t, _event_t >::encoder::index::type , unsigned int  ) const

inlinevirtual

submit() [2/2]

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

virtual bool dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::submit ( dx::stream< device_t, circular_t, super_stream_t, _event_t >::encoder::index::type , unsigned int , uint8_t  )

inlinevirtual

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, circular_t, super_stream_t, _event_t >::cache

Todo

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

circular

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

circular_t* dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::circular {}

protected

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

data

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

event_t dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::data[direction::directions]

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

granularity

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

uint32_t dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::granularity

id

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

const decltype(desc::target.idx()) dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::id

latency

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

uint32_t dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::latency {}

linesize

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

uint32_t dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::linesize

monitor

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

dx::stream::clock::monitor* dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::monitor

samplerate

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

decltype(device_t::samplerate) & dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::samplerate

status

template<typename device_t, typename circular_t = circular, typename super_stream_t = control<object<device_t>>, typename _event_t = event<user>>

os_result dx::stream::stream< device_t, circular_t, super_stream_t, _event_t >::status

---

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

• dx_stream_stream.h