dxd - dynax driver framework 2.1.0d48
cross platform open source driver development framework
Loading...
Searching...
No Matches
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

std::string describe (uint32_t samplerate=0) const
 
uint32_t interval (uint32_t samplerate) const
 returns clock interval in samples
 

Static Public Member Functions

static std::string describe (uint32_t interval, uint32_t ticks)
 describes config as channels*format/[in|out] #idx:plug
 

Public Attributes

dx::stream::clock::bitmap bitmap
 supported sample rates bit field
 
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 { 
 
      uint32_t   hw_min_ticks 
 default presceduled transactions - override by property::sync::cycle::ticks More...
 
   }   sync_cycle 
 
defaults 
 
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

◆ describe() [1/2]

template<typename target_t , 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::describe ( uint32_t interval,
uint32_t ticks )
inlinestatic

describes config as channels*format/[in|out] #idx:plug

+ Here is the caller graph for this function:

◆ describe() [2/2]

template<typename target_t , int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1>
std::string dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations >::clock::describe ( uint32_t samplerate = 0) const
inline
+ Here is the call graph for this function:

◆ interval()

template<typename target_t , 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) const
inline

returns clock interval in samples

+ Here is the caller graph for this function:

Member Data Documentation

◆ bitmap

template<typename target_t , 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::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 , 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 , 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 , 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 , 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 , 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

◆ resolution

template<typename target_t , 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 , 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 , 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 , 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_cycle

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

(c) copyright 2009 dynamic acoustics e.U. generated on Fri Feb 23 2024

a closed source license may be obtained by requesting a written permission from dynamic acoustics e.U.
however - governmental use generally and military use especially is strictly prohibited though.