generic streaming engine More...

#include <dx_stream_engine.h>

Inheritance diagram for dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >:

Collaboration diagram for dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >:

Public Types
typedef device_t::desc_t	desc
typedef decltype(matching_ids)	match
typedef decltype(matching_ids)	match

Public Member Functions
virtual DX_PRAGMA_IGNORE_RETURN_VALUE_END bool	boot () 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)
void	conclude () noexcept override
	conclude notification: object will be removed. If you overwrite conclude() you also need to overwrite destructor and check if its needed to be called from there.
template<typename desc_t>
void	create (const std::string &, const desc_t &)
virtual void	detach () noexcept
	dx_catchall_rethrow () virtual operator bool() const noexcept
DX_PRAGMA_IGNORE_RETURN_VALUE_END void	exception (const class exception &exception, bool filtered=false) const noexcept override try
	notification exception handler
virtual void	exception (const exception &exception, bool filtered=false) const noexcept=0
	notification exception handler
virtual DX_PRAGMA_IGNORE_RETURN_VALUE_END void	free () noexcept
DX_PRAGMA_IGNORE_RETURN_VALUE_END void	halt () noexcept override
	stop streaming engine
DX_PRAGMA_IGNORE_RETURN_VALUE_END void	info (std::ostream &os) noexcept override
	log object class information
template<unsigned int max_channels>
void	initialize (uint32_t iosize, const uint64_t(&channel_map)[2][(max_channels+63)/64]) try
void	launch () override try
	launch notification: object mounted and ready to use
virtual void	launch () try
	launch notification: object mounted and ready to use
void	run () override try
	start streaming engine
DX_PRAGMA_IGNORE_RETURN_VALUE_END uint32_t	samplerate () const try
void	samplerate (uint32_t samplerate) try
virtual bool	shutdown () try
	client driver::shutdown/boot(): override to shutdown/boot host driver

Public Attributes
cf::string	connection_id = ::IOObjectCopyBundleIdentifierForClass(cf::string{this->product_id}.retain())
T	elements
	STL member.
K	keys
	STL member.
bool	launched
log	log
decltype(device<>::preference)	preference
const char *	product_id
io::registry	registry
std::deque< setup >	setup
uint32_t	version

Static Public Attributes
static constexpr auto	connection_id = class_name

Protected Types
typedef decltype(device_t::id)	device_id_t
typedef device<>	device_t

Protected Member Functions
virtual void	add (const decltype(device<>::id) &)=0
	adds a new device to the device list
virtual void	add (const decltype(device<>::id) &)=0
	adds a new device to the device list
void	add (const device_id_t &device_id) override try
	adds a new device to the device list
dx_catchall_handler(this,) using super void	arrived () override try
	notify device arrivals completed stub
	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)
	catch (const std::exception &__std_exception)
	catch (const std::exception &__std_exception)
	catch (const std::exception &__std_exception)
DX_PRAGMA_IGNORE_RETURN_VALUE_END void	clear () noexcept try
	replaces std::map::clear to call virtual notification methods
	dx_catchall_handler (this,) virtual driver &operator<<(std
	restores device settings
	engine (const typename super::match &matching_ids, const char *id)
virtual void	notify (uint32_t) noexcept
	notify sample rate change from device
virtual driver &	operator<< (const char *file)
virtual driver &	operator>> (std::ostream &ostream) const
	saves device tree
virtual void	overload () noexcept
DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN virtual DX_PRAGMA_IGNORE_RETURN_VALUE_END void	process (int64_t timestamp) noexcept=0
virtual void	remove (const decltype(device<>::id) &)=0
	finds and removes a device from the device list
virtual void	remove (const decltype(device<>::id) &)=0
	finds and removes a device from the device list
DX_PRAGMA_IGNORE_RETURN_VALUE_END void	remove (const device_id_t &device_id) override try
	finds and removes a device from the device list
void	removed (device_t &device) noexcept override
void	sleep () override
	< notify system will sleep
void	sync (const std::chrono::high_resolution_clock::time_point &now) override try
DX_PRAGMA_IGNORE_RETURN_VALUE_END void	tick () override try
void	update () noexcept try
void	wake () override
	~engine () override

Protected Attributes
struct {
circular_t * circular [direction::directions]
force_read force_read
force_write force_write
struct {
struct {
uint32_t interval
	clock resolution: HW stream frame size in samples More...
uint32_t linesize
uint32_t safety_offset
} io [direction::directions]
direction::direction reference
uint32_t samplerate
int64_t trigger
	resync condition More...
} sync
}	cache
std::shared_ptr< device_t >	device
uint64_t	frame = 0
bool	hw_clock = false
io_t **	io [direction::directions][2] {}
uint32_t	iosize = 0
bool	kernel_streaming = false
std::vector<::GUID >	matching_ids
dx::stream::clock::monitor *	monitor = nullptr
	io[directions][double buffer][channel][sample]
struct dx::proxy::driver::notification	notification
DX_PRAGMA_IGNORE_RETURN_VALUE_END std::shared_ptr< pin_t >	pin [direction::directions]

Detailed Description

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>
class dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >

generic streaming engine

Exceptions

in	case of an error returned by the underlaying API the device class throws a dx::exception.

Member Typedef Documentation

◆ desc

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

typedef device_t::desc_t dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::desc

◆ device_id_t

typedef decltype(device_t::id) dx::map::driver< device<> >::device_id_t

protectedinherited

◆ device_t

typedef device<> dx::map::driver< device<> >::device_t

protectedinherited

◆ match [1/2]

template<typename device_t = device<>>

typedef decltype(matching_ids) dx::proxy::driver< device_t >::match

inherited

◆ match [2/2]

template<typename device_t = device<>>

typedef decltype(matching_ids) dx::proxy::driver< device_t >::match

inherited

Todo: proxy::driver::connection_id: reflect driver presence

Constructor & Destructor Documentation

◆ engine()

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::engine	(	const typename super::match &	matching_ids,
		const char *	id )

inlineprotected

◆ ~engine()

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::~engine ( )

inlineoverrideprotected

Member Function Documentation

◆ add() [1/3]

virtual void dx::driver< decltype(device<>::id), decltype(device<>::preference) >::add ( const decltype(device<>::id) & )

protectedpure virtualinherited

adds a new device to the device list

Exceptions

dx::exception

◆ add() [2/3]

virtual void dx::driver< decltype(device<>::id), decltype(device<>::preference) >::add ( const decltype(device<>::id) & )

protectedpure virtualinherited

adds a new device to the device list

Exceptions

dx::exception

◆ add() [3/3]

void dx::map::driver< device<> >::add ( const device_id_t & device_id )

inlineoverrideprotectedinherited

adds a new device to the device list

Exceptions

dx::exception

Here is the caller graph for this function:

◆ arrived()

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

dx_catchall_handler(this,) using super void dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::arrived ( )

inlineoverrideprotectedvirtual

notify device arrivals completed stub

pin creation exception caught here to allow device inspection even if streaming is not possible - most likely due to exclusive access.

Todo: forward pin creation exception to be thrown at engine::start()

Reimplemented from dx::map::driver< device<> >.

◆ boot()

virtual DX_PRAGMA_IGNORE_RETURN_VALUE_END bool dx::driver< decltype(device<>::id), decltype(device<>::preference) >::boot ( )

inlinevirtualinherited

◆ catch() [1/21]

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::catch ( ... )

inline

◆ catch() [2/21]

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::catch ( ... )

inline

◆ catch() [3/21]

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::catch ( ... )

inline

◆ catch() [4/21]

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::catch ( ... )

inline

◆ catch() [5/21]

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::catch ( ... )

inlineprotected

◆ catch() [6/21]

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::catch ( ... )

inlineprotected

◆ catch() [7/21]

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::catch ( ... )

inlineprotected

◆ catch() [8/21]

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::catch ( const dx::exception & __dx_exception )

inline

◆ catch() [9/21]

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::catch ( const dx::exception & __dx_exception )

inline

◆ catch() [10/21]

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::catch ( const dx::exception & __dx_exception )

inline

◆ catch() [11/21]

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::catch ( const dx::exception & __dx_exception )

inline

◆ catch() [12/21]

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::catch ( const dx::exception & __dx_exception )

inlineprotected

◆ catch() [13/21]

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::catch ( const dx::exception & __dx_exception )

inlineprotected

◆ catch() [14/21]

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::catch ( const dx::exception & __dx_exception )

inlineprotected

◆ catch() [15/21]

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::catch ( const std::exception & __std_exception )

inline

◆ catch() [16/21]

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::catch ( const std::exception & __std_exception )

inline

◆ catch() [17/21]

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::catch ( const std::exception & __std_exception )

inline

◆ catch() [18/21]

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::catch ( const std::exception & __std_exception )

inline

◆ catch() [19/21]

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::catch ( const std::exception & __std_exception )

inlineprotected

◆ catch() [20/21]

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::catch ( const std::exception & __std_exception )

inlineprotected

◆ catch() [21/21]

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::catch ( const std::exception & __std_exception )

inlineprotected

◆ clear()

DX_PRAGMA_IGNORE_RETURN_VALUE_END void dx::map::driver< device<> >::clear ( )

inlineprotectednoexceptinherited

replaces std::map::clear to call virtual notification methods

◆ conclude()

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

void dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::conclude ( )

inlineoverridevirtualnoexcept

conclude notification: object will be removed. If you overwrite conclude() you also need to overwrite destructor and check if its needed to be called from there.

Reimplemented from dx::map::driver< device<> >.

◆ create()

template<typename device_t = device<>>

template<typename desc_t>

void dx::proxy::driver< device_t >::create	(	const std::string &	,
		const desc_t &	)

inlineinherited

Todo: proxy::driver::operator bool() check if driver is installed

◆ detach()

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

virtual void dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::detach ( )

inlinevirtualnoexcept

◆ dx_catchall_handler()

dx::map::driver< device<> >::dx_catchall_handler ( this ) &

inlineprotectedinherited

restores device settings

◆ dx_catchall_rethrow()

template<typename device_t = device<>>

dx::proxy::driver< device_t >::dx_catchall_rethrow ( ) const

inlinenoexceptinherited

◆ exception() [1/2]

DX_PRAGMA_IGNORE_RETURN_VALUE_END void dx::driver< decltype(device<>::id), decltype(device<>::preference) >::exception	(	const class exception &	exception,
		bool	filtered = false ) const

inlineoverridenoexceptinherited

notification exception handler

◆ exception() [2/2]

virtual void dx::object::exception	(	const exception &	exception,
		bool	filtered = false ) const

pure virtualnoexceptinherited

notification exception handler

◆ free()

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

virtual DX_PRAGMA_IGNORE_RETURN_VALUE_END void dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::free ( )

inlinevirtualnoexcept

Todo: replace test for valid pin by overwise keeping track of allocated channels

◆ halt()

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

DX_PRAGMA_IGNORE_RETURN_VALUE_END void dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::halt ( )

inlineoverridenoexcept

stop streaming engine

◆ info()

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

DX_PRAGMA_IGNORE_RETURN_VALUE_END void dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::info ( std::ostream & os )

inlineoverridevirtualnoexcept

log object class information

Reimplemented from dx::map::driver< device<> >.

◆ initialize()

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

template<unsigned int max_channels>

void dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::initialize	(	uint32_t	iosize,
		const uint64_t(&)	channel_map[2][(max_channels+63)/64] )

inline

Todo: clock already runnning with different iosize: check if engine should be initialized with current iosize

Todo: stream::engine::initialize(): define sync reference pin

◆ launch() [1/2]

template<typename device_t = device<>>

void dx::proxy::driver< device_t >::launch ( )

inlineoverridevirtualinherited

launch notification: object mounted and ready to use

Reimplemented from dx::map::driver< device<> >.

Here is the call graph for this function:

◆ launch() [2/2]

template<typename device_t = device<>>

virtual void dx::proxy::driver< device_t >::launch ( )

inlinevirtualinherited

launch notification: object mounted and ready to use

Reimplemented from dx::map::driver< device<> >.

Here is the call graph for this function:

◆ notify()

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

virtual void dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::notify ( uint32_t )

inlineprotectedvirtualnoexcept

notify sample rate change from device

Reimplemented in dx::asio::driver< device_t, pin_t, driver_t >.

◆ operator<<()

virtual driver & dx::map::driver< device<> >::operator<< ( const char * file )

inlineprotectedvirtualinherited

◆ operator>>()

virtual driver & dx::map::driver< device<> >::operator>> ( std::ostream & ostream ) const

inlineprotectedvirtualinherited

saves device tree

◆ overload()

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

virtual void dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::overload ( )

inlineprotectedvirtualnoexcept

Reimplemented in dx::asio::driver< device_t, pin_t, driver_t >.

◆ process()

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

DX_PRAGMA_IGNORE_RETURN_VALUE_BEGIN virtual DX_PRAGMA_IGNORE_RETURN_VALUE_END void dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::process ( int64_t timestamp )

protectedpure virtualnoexcept

Implemented in dx::asio::driver< device_t, pin_t, driver_t >.

◆ remove() [1/3]

virtual void dx::driver< decltype(device<>::id), decltype(device<>::preference) >::remove ( const decltype(device<>::id) & )

protectedpure virtualinherited

finds and removes a device from the device list

◆ remove() [2/3]

virtual void dx::driver< decltype(device<>::id), decltype(device<>::preference) >::remove ( const decltype(device<>::id) & )

protectedpure virtualinherited

finds and removes a device from the device list

◆ remove() [3/3]

DX_PRAGMA_IGNORE_RETURN_VALUE_END void dx::map::driver< device<> >::remove ( const device_id_t & device_id )

inlineoverrideprotectedinherited

finds and removes a device from the device list

Exceptions

dx::exception

◆ removed()

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

void dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::removed ( device_t & device )

inlineoverrideprotectednoexcept

◆ run()

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

void dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::run ( )

inlineoverride

start streaming engine

◆ samplerate() [1/2]

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

DX_PRAGMA_IGNORE_RETURN_VALUE_END uint32_t dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::samplerate ( ) const

inline

◆ samplerate() [2/2]

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

void dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::samplerate ( uint32_t samplerate )

inline

◆ shutdown()

virtual bool dx::driver< decltype(device<>::id), decltype(device<>::preference) >::shutdown ( )

inlinevirtualinherited

client driver::shutdown/boot(): override to shutdown/boot host driver

◆ sleep()

void dx::map::driver< device<> >::sleep ( )

inlineoverrideprotectedinherited

< notify system will sleep

notify system wake completed stub

◆ sync()

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

void dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::sync ( const std::chrono::high_resolution_clock::time_point & now )

inlineoverrideprotected

◆ tick()

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

DX_PRAGMA_IGNORE_RETURN_VALUE_END void dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::tick ( )

inlineoverrideprotected

Todo: enable re-sync with correct rx/tx position dependent clock event time point

◆ update()

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

void dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::update ( )

inlineprotectednoexcept

◆ wake()

void dx::map::driver< device<> >::wake ( )

inlineoverrideprotectedinherited

Member Data Documentation

◆ [struct]

struct { ... } dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::cache

◆ circular

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

circular_t* dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::circular[direction::directions]

◆ connection_id [1/2]

template<typename device_t = device<>>

cf::string dx::proxy::driver< device_t >::connection_id = ::IOObjectCopyBundleIdentifierForClass(cf::string{this->product_id}.retain())

inherited

◆ connection_id [2/2]

template<typename device_t = device<>>

auto dx::proxy::driver< device_t >::connection_id = class_name

staticconstexprinherited

◆ device

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

std::shared_ptr<device_t> dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::device

protected

◆ elements

T std::map< K, T >::elements

inherited

STL member.

◆ force_read

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

force_read dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::force_read

◆ force_write

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

force_write dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::force_write

◆ frame

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

uint64_t dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::frame = 0

protected

◆ hw_clock

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

bool dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::hw_clock = false

protected

◆ interval

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

uint32_t dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::interval

clock resolution: HW stream frame size in samples

◆ [struct] [1/2]

struct { ... } dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::io[direction::directions]

◆ io [2/2]

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

io_t** dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::io[direction::directions][2] {}

protected

◆ iosize

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

uint32_t dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::iosize = 0

protected

◆ kernel_streaming

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

bool dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::kernel_streaming = false

protected

◆ keys

K std::map< K, T >::keys

inherited

STL member.

◆ launched

bool dx::object::launched

inherited

◆ linesize

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

uint32_t dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::linesize

◆ log

log dx::driver< decltype(device<>::id), decltype(device<>::preference) >::log

inherited

◆ matching_ids

template<typename device_t = device<>>

std::vector<::GUID> dx::proxy::driver< device_t >::matching_ids

protectedinherited

◆ monitor

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

dx::stream::clock::monitor* dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::monitor = nullptr

protected

io[directions][double buffer][channel][sample]

◆ notification

template<typename device_t = device<>>

struct dx::proxy::driver::notification dx::proxy::driver< device_t >::notification

protectedinherited

◆ pin

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

DX_PRAGMA_IGNORE_RETURN_VALUE_END std::shared_ptr<pin_t> dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::pin[direction::directions]

protected

◆ preference

decltype(device<>::preference) dx::driver< decltype(device<>::id), decltype(device<>::preference) >::preference

inherited

◆ product_id

const char* dx::driver< decltype(device<>::id), decltype(device<>::preference) >::product_id

inherited

◆ reference

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

direction::direction dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::reference

◆ registry

template<typename device_t = device<>>

io::registry dx::proxy::driver< device_t >::registry

inherited

◆ safety_offset

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

uint32_t dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::safety_offset {}

◆ samplerate

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

uint32_t dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::samplerate

◆ setup

template<typename device_t = device<>>

std::deque<setup> dx::proxy::driver< device_t >::setup

inherited

◆ [struct]

struct { ... } dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::sync

◆ trigger

template<typename device_t, typename pin_t, typename driver_t = proxy::driver<device_t>, typename io_t = int32_t, typename circular_t = typename pin_t::circular_t>

int64_t dx::stream::engine< device_t, pin_t, driver_t, io_t, circular_t >::trigger

resync condition

◆ version

uint32_t dx::driver< decltype(device<>::id), decltype(device<>::preference) >::version

inherited

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

dx_stream_engine.h

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ desc

◆ device_id_t

◆ device_t

◆ match [1/2]

◆ match [2/2]

Constructor & Destructor Documentation

◆ engine()

◆ ~engine()

Member Function Documentation

◆ add() [1/3]

◆ add() [2/3]

◆ add() [3/3]

◆ arrived()

◆ boot()

◆ catch() [1/21]

◆ catch() [2/21]

◆ catch() [3/21]

◆ catch() [4/21]

◆ catch() [5/21]

◆ catch() [6/21]

◆ catch() [7/21]

◆ catch() [8/21]

◆ catch() [9/21]

◆ catch() [10/21]

◆ catch() [11/21]

◆ catch() [12/21]

◆ catch() [13/21]

◆ catch() [14/21]

◆ catch() [15/21]

◆ catch() [16/21]

◆ catch() [17/21]

◆ catch() [18/21]

◆ catch() [19/21]

◆ catch() [20/21]

◆ catch() [21/21]

◆ clear()

◆ conclude()

◆ create()

◆ detach()

◆ dx_catchall_handler()

◆ dx_catchall_rethrow()

◆ exception() [1/2]

◆ exception() [2/2]

◆ free()

◆ halt()

◆ info()

◆ initialize()

◆ launch() [1/2]

◆ launch() [2/2]

◆ notify()

◆ operator<<()

◆ operator>>()

◆ overload()

◆ process()

◆ remove() [1/3]

◆ remove() [2/3]

◆ remove() [3/3]

◆ removed()

◆ run()

◆ samplerate() [1/2]

◆ samplerate() [2/2]

◆ shutdown()

◆ sleep()

◆ sync()

◆ tick()

◆ update()

◆ wake()

Member Data Documentation

◆ [struct]

◆ circular

◆ connection_id [1/2]