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

#include <dx_proxy_stream_device.h>

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

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

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

Public Member Functions
	__dx_catchall (std::cerr<< exception<< std::endl;,) virtual ~stream() noexcept
template<unsigned int channels, typename channel_t >
stream &	attach (channel_t **io[2], uint64_t channel_map[(channels+63)/64])
	catch (...)
	catch (const dx::exception &__dx_exception)
	catch (const std::exception &__std_exception)
	dx_catchall_handler (this,) ~stream() noexcept override
virtual float	encoder (dx::stream::encoder::index::type type, unsigned int index) const
virtual bool	encoder (dx::stream::encoder::index::type type, unsigned int index, float value)
void	exception (const class exception &exception, bool filtered=false) const noexcept override
virtual bool	flush () noexcept
void	halt () noexcept override try
void	info (std::ostream &os) noexcept override try
virtual void	initialize ()
virtual uint32_t	latency () noexcept
void	launch () override
	operator circular_t * () const noexcept
circular_t *	operator-> () const noexcept
virtual uint32_t	samplerate () try
	provisional sample rate handler: needs to move into clock class
virtual uint32_t	samplerate (uint32_t samplerate) try
bool	start (uint64_t frame, unsigned int starting=1) override try
virtual os_result	status () noexcept
	stream (device_t &device, const decltype(super::id)&id, const super::desc &desc)
	creates circular streaming backing store and frame buffers
virtual uint8_t	submit (dx::stream::encoder::index::type type, unsigned int index) const
virtual bool	submit (dx::stream::encoder::index::type type, unsigned int index, uint8_t value)
	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 dx::stream::stream::cache	cache
const decltype(device_t::desc::stream::desc::target.idx())	id

Protected Member Functions
virtual void	alloc (size_t size)
virtual void	free () noexcept

Protected Attributes
circular_t *	circular {}

Member Typedef Documentation

desc

template<typename device_t , typename circular_t = dx::circular, typename super_stream_t = dx::stream::control<dx::stream::object<device_t>>>

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

inherited

Constructor & Destructor Documentation

stream()

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

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

inline

creates circular streaming backing store and frame buffers

Here is the call graph for this function:

Member Function Documentation

__dx_catchall()

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

dx::proxy::stream::stream< device_t, circular_t >::__dx_catchall ( std::cerr<< exception<< std::endl; )

inlinenoexcept

alloc()

template<typename device_t , typename circular_t = dx::circular, typename super_stream_t = dx::stream::control<dx::stream::object<device_t>>>

virtual void dx::stream::stream< device_t, circular_t, super_stream_t >::alloc ( size_t size )

inlineprotectedvirtualinherited

Reimplemented in dx::stream::shared::stream< device_t, circular_t >, and dx::stream::shared::stream< device< desc, dx::stream::shared::stream > >.

attach()

template<typename device_t , typename circular_t = dx::circular, typename super_stream_t = dx::stream::control<dx::stream::object<device_t>>>

template<unsigned int channels, typename channel_t >

stream & dx::stream::stream< device_t, circular_t, super_stream_t >::attach ( channel_t ** io[2], uint64_t channel_map[(channels+63)/64] )

inlineinherited

catch() [1/3]

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

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

inline

catch() [2/3]

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

dx::proxy::stream::stream< device_t, circular_t >::catch ( const dx::exception & __dx_exception )

inline

catch() [3/3]

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

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

inline

dx_catchall_handler()

template<typename device_t , typename circular_t = dx::circular, typename super_stream_t = dx::stream::control<dx::stream::object<device_t>>>

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

inlineoverridenoexceptinherited

encoder() [1/2]

template<typename device_t , typename circular_t = dx::circular, typename super_stream_t = dx::stream::control<dx::stream::object<device_t>>>

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

inlinevirtualinherited

Reimplemented in dx::usb::stream::pipe< device_t, circular_t >, and dx::usb::stream::pipe< device< desc_t, pipe > >.

encoder() [2/2]

template<typename device_t , typename circular_t = dx::circular, typename super_stream_t = dx::stream::control<dx::stream::object<device_t>>>

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

inlinevirtualinherited

Reimplemented in dx::usb::stream::pipe< device_t, circular_t >, and dx::usb::stream::pipe< device< desc_t, pipe > >.

Here is the caller graph for this function:

exception()

template<typename device_t , typename circular_t = dx::circular, typename super_stream_t = dx::stream::control<dx::stream::object<device_t>>>

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

inlineoverridenoexceptinherited

Here is the caller graph for this function:

flush()

template<typename device_t , typename circular_t = dx::circular, typename super_stream_t = dx::stream::control<dx::stream::object<device_t>>>

virtual bool dx::stream::stream< device_t, circular_t, super_stream_t >::flush ( )

inlinevirtualnoexceptinherited

Reimplemented in dx::usb::stream::pipe< device_t, circular_t >, and dx::usb::stream::pipe< device< desc_t, pipe > >.

free()

template<typename device_t , typename circular_t = dx::circular, typename super_stream_t = dx::stream::control<dx::stream::object<device_t>>>

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

inlineprotectedvirtualnoexceptinherited

Reimplemented in dx::stream::shared::stream< device_t, circular_t >, and dx::stream::shared::stream< device< desc, dx::stream::shared::stream > >.

halt()

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

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

inlineoverridenoexcept

Here is the call graph for this function:

info()

template<typename device_t , typename circular_t = dx::circular, typename super_stream_t = dx::stream::control<dx::stream::object<device_t>>>

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

inlineoverridenoexceptinherited

initialize()

template<typename device_t , typename circular_t = dx::circular, typename super_stream_t = dx::stream::control<dx::stream::object<device_t>>>

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

inlinevirtualinherited

Here is the call graph for this function:

latency()

template<typename device_t , typename circular_t = dx::circular, typename super_stream_t = dx::stream::control<dx::stream::object<device_t>>>

virtual uint32_t dx::stream::stream< device_t, circular_t, super_stream_t >::latency ( )

inlinevirtualnoexceptinherited

Reimplemented in dx::usb::stream::pipe< device_t, circular_t >, and dx::usb::stream::pipe< device< desc_t, pipe > >.

launch()

template<typename device_t , typename circular_t = dx::circular, typename super_stream_t = dx::stream::control<dx::stream::object<device_t>>>

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

inlineoverrideinherited

operator circular_t *()

template<typename device_t , typename circular_t = dx::circular, typename super_stream_t = dx::stream::control<dx::stream::object<device_t>>>

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

inlinenoexceptinherited

operator->()

template<typename device_t , typename circular_t = dx::circular, typename super_stream_t = dx::stream::control<dx::stream::object<device_t>>>

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

inlinenoexceptinherited

samplerate() [1/2]

template<typename device_t , typename circular_t = dx::circular, typename super_stream_t = dx::stream::control<dx::stream::object<device_t>>>

virtual uint32_t dx::stream::stream< device_t, circular_t, super_stream_t >::samplerate ( )

inlinevirtualinherited

provisional sample rate handler: needs to move into clock class

Todo

reference dedicated stream::clock class

Reimplemented in dx::usb::stream::pipe< device_t, circular_t >, and dx::usb::stream::pipe< device< desc_t, pipe > >.

samplerate() [2/2]

template<typename device_t , typename circular_t = dx::circular, typename super_stream_t = dx::stream::control<dx::stream::object<device_t>>>

virtual uint32_t dx::stream::stream< device_t, circular_t, super_stream_t >::samplerate ( uint32_t samplerate )

inlinevirtualinherited

Reimplemented in dx::usb::stream::pipe< device_t, circular_t >, and dx::usb::stream::pipe< device< desc_t, pipe > >.

start()

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

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

inlineoverride

Here is the call graph for this function:

status()

template<typename device_t , typename circular_t = dx::circular, typename super_stream_t = dx::stream::control<dx::stream::object<device_t>>>

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

inlinevirtualnoexceptinherited

submit() [1/2]

template<typename device_t , typename circular_t = dx::circular, typename super_stream_t = dx::stream::control<dx::stream::object<device_t>>>

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

inlinevirtualinherited

submit() [2/2]

template<typename device_t , typename circular_t = dx::circular, typename super_stream_t = dx::stream::control<dx::stream::object<device_t>>>

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

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

cache

template<typename device_t , typename circular_t = dx::circular, typename super_stream_t = dx::stream::control<dx::stream::object<device_t>>>

struct dx::stream::stream::cache dx::stream::stream< device_t, circular_t, super_stream_t >::cache

inherited

circular

template<typename device_t , typename circular_t = dx::circular, typename super_stream_t = dx::stream::control<dx::stream::object<device_t>>>

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

protectedinherited

id

template<typename device_t , typename circular_t = dx::circular, typename super_stream_t = dx::stream::control<dx::stream::object<device_t>>>

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

inherited

---

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

• dx_proxy_stream_device.h