dx::stream::format Struct Reference

what one sample frame looks like, container and content apart: the resolution inside the container's size, its alignment there and its endianness. operator == is a match against a wish, not an identity: a member left at zero in the asked format matches anything, which is how a pin states audio alone and a ring adopts the one format its participants agree on (dx::stream::format::align). The named constants below are the formats the converters of dx_circular.h move - dx::stream::sample keys them. More...

#include <dx_stream.h>

Public Types
enum class	alignment : bool { high , low }
enum class	endian : bool { little , big }
enum class	midi : uint8_t { none , bytes , ump }

Public Member Functions
const format &	align (const format &format) const
	aligns a requested format to what a ring adopts when its participants disagree: the wider container, float over int at equal width
named	alignments () const
named	endians () const
named	midis () const
bool	operator< (const format &format) const
bool	operator== (const format &format) const
named	reals () const
named	resolutions () const
named	sizes () const

Public Attributes
enum dx::stream::format::alignment	alignment
bool	audio: 1{}
enum dx::stream::format::endian	endian
enum dx::stream::format::midi	midi
	the MIDI 1.0 byte stream, or Universal MIDI Packets: whole 32 bit words, the group inside the word
bool	real: 1{}
	encoded in floating point
uint8_t	resolution: 8{}
	significant bits
uint8_t	size: 8{}
	sample frame size in bytes

Detailed Description

what one sample frame looks like, container and content apart: the resolution inside the container's size, its alignment there and its endianness. operator == is a match against a wish, not an identity: a member left at zero in the asked format matches anything, which is how a pin states audio alone and a ring adopts the one format its participants agree on (dx::stream::format::align). The named constants below are the formats the converters of dx_circular.h move - dx::stream::sample keys them.

Member Enumeration Documentation

alignment

enum class dx::stream::format::alignment : bool

strong

Enumerator
high
low

endian

enum class dx::stream::format::endian : bool

strong

Enumerator
little
big

midi

enum class dx::stream::format::midi : uint8_t

strong

Enumerator
none
bytes
ump

Member Function Documentation

align()

const format & dx::stream::format::align ( const format & format ) const

inline

aligns a requested format to what a ring adopts when its participants disagree: the wider container, float over int at equal width

alignments()

named dx::stream::format::alignments ( ) const

inline

endians()

named dx::stream::format::endians ( ) const

inline

midis()

named dx::stream::format::midis ( ) const

inline

what the format allows each member as it stands: the resolutions its size and encoding carry, the encodings its resolution and size admit, the sizes that hold its resolution, congruous where the size is the resolution's or which end it sits at

operator<()

bool dx::stream::format::operator< ( const format & format ) const

inline

Here is the call graph for this function:

operator==()

bool dx::stream::format::operator== ( const format & format ) const

inline

Here is the caller graph for this function:

reals()

named dx::stream::format::reals ( ) const

inline

resolutions()

named dx::stream::format::resolutions ( ) const

inline

sizes()

named dx::stream::format::sizes ( ) const

inline

Member Data Documentation

alignment

enum dx::stream::format::alignment dx::stream::format::alignment

audio

bool dx::stream::format::audio

endian

enum dx::stream::format::endian dx::stream::format::endian

midi

enum dx::stream::format::midi dx::stream::format::midi

the MIDI 1.0 byte stream, or Universal MIDI Packets: whole 32 bit words, the group inside the word

real

bool dx::stream::format::real

encoded in floating point

resolution

uint8_t dx::stream::format::resolution

significant bits

size

uint8_t dx::stream::format::size

sample frame size in bytes

---

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

• dx_stream.h