dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::clock Struct Reference

#include <dx_stream.h>

Public Member Functions
uint32_t	align (uint32_t samplerate) const
	align samplerate to closest supported samplerate
void	describe (std::ostream &os, uint32_t granularity=1, uint32_t samplerate=0) const
uint32_t	interval (uint32_t samplerate, uint32_t granularity=1) const
	returns clock interval in samples

Static Public Member Functions
static std::string	interval_ticks (uint32_t interval, uint32_t ticks=1)
	describes clock as interval ticks

Public Attributes
dx::stream::clock::bitmap	bitmap
struct {
struct {
uint32_t   hw_max_ticks
	max user iosize in HW clock ticks More...
uint32_t   hw_min_ticks
	min user iosize in HW clock ticks More...
uint32_t   hw_ticks
	default user iosize in HW clock ticks More...
}   iosize
uint32_t   safety_offset [2]
	default safety_offset[out|in] - override by property::safety_offset[direction] More...
uint32_t   samplerate
	default sample rate More...
struct {
struct {
uint32_t   hw_min_ticks
	default presceduled transactions - override by property::sync::cycle::ticks More...
}   cycle
uint32_t   reference
	default sync reference - override by property::sync::reference More...
}   sync
}	defaults
char	name [0x20]
	clock setting name
uint32_t	resolution
struct {
struct {
bool   locked: 1
	clock can be externally locked by device (i.e. SPDif) More...
}   external
char   name [0x40]
	clock setting name More...
}	setting [max_clock_settings]
uint32_t	settings
	number of clock settings

Member Function Documentation

align()

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::clock::align ( uint32_t samplerate ) const

inline

align samplerate to closest supported samplerate

describe()

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

void dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::clock::describe ( std::ostream & os, uint32_t granularity = 1, uint32_t samplerate = 0 ) const

inline

Here is the call graph for this function:

interval()

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::clock::interval ( uint32_t samplerate, uint32_t granularity = 1 ) const

inline

returns clock interval in samples

Here is the caller graph for this function:

interval_ticks()

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

static std::string dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::clock::interval_ticks ( uint32_t interval, uint32_t ticks = 1 )

inlinestatic

describes clock as interval ticks

Member Data Documentation

bitmap

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

dx::stream::clock::bitmap dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::clock::bitmap

supported sample rates bit field

[struct]

struct { ... } dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::clock::cycle

[struct]

struct { ... } dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::clock::defaults

[struct]

struct { ... } dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::clock::external

hw_max_ticks

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::clock::hw_max_ticks

max user iosize in HW clock ticks

hw_min_ticks

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::clock::hw_min_ticks

default presceduled transactions - override by property::sync::cycle::ticks

min user iosize in HW clock ticks

hw_ticks

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::clock::hw_ticks

default user iosize in HW clock ticks

[struct]

struct { ... } dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::clock::iosize

locked

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

bool dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::clock::locked

clock can be externally locked by device (i.e. SPDif)

name

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

char dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::clock::name[0x40]

clock setting name

reference

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::clock::reference

default sync reference - override by property::sync::reference

resolution

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::clock::resolution

isochonous clock ticks per second; maybe 0 -> use stream::transaction::granularity

safety_offset

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::clock::safety_offset[2]

default safety_offset[out|in] - override by property::safety_offset[direction]

samplerate

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::clock::samplerate

default sample rate

[struct]

struct { ... } dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::clock::setting[max_clock_settings]

settings

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>

uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::clock::settings

number of clock settings

[struct]

struct { ... } dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::clock::sync

---

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

• dx_stream.h