dxd - dynax driver framework  2675
cross platform open source driver development framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
dx::stream::desc< target_t, max_streams, max_configurations, max_pins, vendor_t >::stream::config Struct Reference

stream interface descriptor More...

#include <dx_stream.h>

Public Types

enum  rate : unsigned int {
  rate::none =0, rate::rate8 =1<<0, rate::rate16 =1<<1, rate::rate22 =1<<2,
  rate::rate32 =1<<3, rate::rate44 =1<<4, rate::rate48 =1<<5, rate::rate88 =1<<6,
  rate::rate96 =1<<7, rate::rate176 =1<<8, rate::rate192 =1<<9, rate::rate352 =1<<10,
  rate::rate384 =1<<11, rate::rates =12, rate::lo =rate44|rate48, rate::mid =rate88|rate96,
  rate::hi =rate176|rate192, rate::ex =rate352|rate384, rate::std =hi|mid|lo
}
 

Public Member Functions

std::string describe () const
 describes config as channels*format/[in|out] #idx:plug More...
 
unsigned int line_size () const
 total length of the samples of all channels More...
 

Static Public Member Functions

static unsigned int frequency (unsigned int shift)
 frequency helper functions returns the numerical frequency from given sample rate bit field More...
 
static dx_enum_prefix rate shift (unsigned int frequency)
 frequency helper functions returns the sample rate bit field from given numerical frequency More...
 

Public Attributes

unsigned int channels
 amount of channels in interface (forms the lines size together with word_length) More...
 
enum
dx::stream::desc::stream::config::rate 
rate
 supported sample rates bit field More...
 
unsigned int word_length
 total length of one sample in the stream More...
 

Detailed Description

template<typename target_t, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
struct dx::stream::desc< target_t, max_streams, max_configurations, max_pins, vendor_t >::stream::config

stream interface descriptor

A stream can have various configuration with varying supported samples rates, number of channels and data formats.

Member Enumeration Documentation

template<typename target_t, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
enum dx::stream::desc::stream::config::rate : unsigned int
strong
Enumerator
none 
rate8 
rate16 
rate22 
rate32 
rate44 
rate48 
rate88 
rate96 
rate176 
rate192 
rate352 
rate384 
rates 
lo 
mid 
hi 
ex 
std 

Member Function Documentation

template<typename target_t, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
std::string dx::stream::desc< target_t, max_streams, max_configurations, max_pins, vendor_t >::stream::config::describe ( ) const
inline

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

template<typename target_t, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
static unsigned int dx::stream::desc< target_t, max_streams, max_configurations, max_pins, vendor_t >::stream::config::frequency ( unsigned int  shift)
inlinestatic

frequency helper functions returns the numerical frequency from given sample rate bit field

+ Here is the call graph for this function:

template<typename target_t, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
unsigned int dx::stream::desc< target_t, max_streams, max_configurations, max_pins, vendor_t >::stream::config::line_size ( ) const
inline

total length of the samples of all channels

+ Here is the caller graph for this function:

template<typename target_t, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
static dx_enum_prefix rate dx::stream::desc< target_t, max_streams, max_configurations, max_pins, vendor_t >::stream::config::shift ( unsigned int  frequency)
inlinestatic

frequency helper functions returns the sample rate bit field from given numerical frequency

+ Here is the caller graph for this function:

Member Data Documentation

template<typename target_t, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
unsigned int dx::stream::desc< target_t, max_streams, max_configurations, max_pins, vendor_t >::stream::config::channels

amount of channels in interface (forms the lines size together with word_length)

template<typename target_t, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
enum dx::stream::desc::stream::config::rate dx::stream::desc< target_t, max_streams, max_configurations, max_pins, vendor_t >::stream::config::rate

supported sample rates bit field

template<typename target_t, int max_streams = 2, int max_configurations = 1, int max_pins = 8, typename vendor_t = void_struct>
unsigned int dx::stream::desc< target_t, max_streams, max_configurations, max_pins, vendor_t >::stream::config::word_length

total length of one sample in the stream


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

(c) copyright 2009 dynamic acoustics e.U. generated on Tue Dec 4 2018

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.