dxd - dynax driver framework 2.1.0d49
cross platform open source driver development framework
Loading...
Searching...
No Matches
dx::usb::midi< buffer_t > Struct Template Reference

USB MIDI packetizer. More...

#include <dx_usb_audio.h>

+ Inheritance diagram for dx::usb::midi< buffer_t >:
+ Collaboration diagram for dx::usb::midi< buffer_t >:

Classes

union  msg
 USB MIDI endpoint element types: defining the element size for a single USB MIDI pipe request. More...
 

Public Member Functions

size_t decode (uint64_t &rx, union msg &msg, uint8_t cable)
 USB MIDI msg word to OS MIDI stream format decoder.
 
uint64_t empty () const
 
uint64_t empty (uint64_t position) const
 
bool encode (const uint8_t *os_midi_package, size_t length, uint8_t cable)
 OS MIDI stream to USB MIDI msg word format encoder.
 
template<typename ext_t , typename circular_t = ext_t>
hide_if_ptr< ext_t > force_read (ext_t *const *dst, uint64_t bulk=1, uint32_t channels_circular=1, uint32_t channels_dst=1, uint32_t circular_offset=0, uint32_t interleaved=1)
 
template<typename ext_t , typename circular_t = ext_t>
hide_if_ptr< ext_t > force_read (ext_t *dst, uint64_t bulk=1, uint32_t channels_circular=1, uint32_t circular_offset=0, uint32_t interleaved=1)
 
template<typename ext_t , typename circular_t = ext_t>
bool force_read (volatile uint64_t &position, ext_t *const *dst, uint64_t bulk, uint32_t channels_circular=1, uint32_t channels_dst=1, uint32_t circular_offset=0, uint32_t interleaved=1)
 multi channel interleaved bulk read from circular buffer with format conversion if applicable
 
template<typename ext_t , typename circular_t = ext_t>
hide_if_ptr< ext_t > force_read (volatile uint64_t &position, ext_t *dst, uint64_t bulk=1, uint32_t channels_circular=1, uint32_t circular_offset=0, uint32_t interleaved=1)
 
template<typename ext_t , typename circular_t = ext_t>
bool force_write (const ext_t *const *src, uint64_t bulk=1, uint32_t channels_circular=1, uint32_t channels_src=1, uint32_t circular_offset=0, uint32_t interleaved=1)
 
template<typename ext_t , typename circular_t = ext_t>
hide_if_ptr< ext_t > force_write (const ext_t *src, uint64_t bulk=1, uint32_t channels_circular=1, uint32_t circular_offset=0, uint32_t interleaved=1)
 
template<typename data_t >
bool force_write (data_t *const *const *src, uint64_t clients, uint64_t channels, uint64_t bulk)
 
template<typename circular_t , typename src_t >
bool force_write (src_t *const *const *src, uint32_t clients, uint32_t channels=1, uint64_t bulk=1)
 multi channel multi client bulk mix into circular buffer with format conversion if applicable src[client][channel][sample]
 
template<typename ext_t , typename circular_t = ext_t>
bool force_write (volatile uint64_t &position, const ext_t *const *src, uint64_t bulk, uint32_t channels_circular=1, uint32_t channels_src=1, uint32_t circular_offset=0, uint32_t interleaved=1)
 multi channel interleaved bulk write into circular buffer with format conversion if applicable
 
template<typename ext_t , typename circular_t = ext_t>
hide_if_ptr< ext_t > force_write (volatile uint64_t &position, const ext_t *src, uint64_t bulk=1, uint32_t channels_circular=1, uint32_t circular_offset=0, uint32_t interleaved=1)
 single channel convenience access templates
 
void initialize ()
 
void initialize (uint64_t backingstore_size)
 
uint64_t loop () const
 
template<typename callback_t >
void move (callback_t &callback, uint64_t max)
 
template<typename data_t >
hide_if_ptr< data_t > operator<< (const data_t &src)
 
template<typename data_t >
hide_if_ptr< data_t > operator>> (data_t &dst)
 
template<typename ext_t , typename circular_t = ext_t>
hide_if_ptr< ext_t > read (ext_t *const *dst, uint64_t bulk=1, uint32_t channels_circular=1, uint32_t channels_dst=1, uint32_t circular_offset=0, uint32_t interleaved=1)
 
template<typename ext_t , typename circular_t = ext_t>
hide_if_ptr< ext_t > read (ext_t *dst, uint64_t bulk=1, uint32_t channels_circular=1, uint32_t circular_offset=0, uint32_t interleaved=1)
 
template<typename ext_t , typename circular_t = ext_t>
hide_if_ptr< ext_t > read (volatile uint64_t &position, ext_t *const *dst, uint64_t bulk=1, uint32_t channels_circular=1, uint32_t channels_dst=1, uint32_t circular_offset=0, uint32_t interleaved=1)
 
template<typename ext_t , typename circular_t = ext_t>
hide_if_ptr< ext_t > read (volatile uint64_t &position, ext_t *dst, uint64_t bulk=1, uint32_t channels_circular=1, uint32_t circular_offset=0, uint32_t interleaved=1)
 
template<typename dst_t = uint8_t>
dst_t * simulate_read (uint64_t bulk=1)
 
template<typename dst_t = uint8_t>
dst_t * simulate_read (volatile uint64_t &position, uint64_t bulk)
 
uint8_tsimulate_write (uint64_t bulk)
 simulate write by advancing write idx and take care of wrap write optimization
 
uint64_t used () const
 
uint64_t used (uint64_t position) const
 
template<typename ext_t , typename circular_t = ext_t>
bool write (const ext_t *const *src, uint64_t bulk=1, uint32_t channels_circular=1, uint32_t channels_src=1, uint32_t circular_offset=0, uint32_t interleaved=1)
 
template<typename ext_t , typename circular_t = ext_t>
hide_if_ptr< ext_t > write (const ext_t *src, uint64_t bulk=1, uint32_t channels_circular=1, uint32_t circular_offset=0, uint32_t interleaved=1)
 
template<typename ext_t , typename circular_t = ext_t>
bool write (volatile uint64_t &position, const ext_t *const *src, uint64_t bulk=1, uint32_t channels_circular=1, uint32_t channels_src=1, uint32_t circular_offset=0, uint32_t interleaved=1)
 bulk write into circular buffer with format conversion if applicable
 
template<typename ext_t , typename circular_t = ext_t>
hide_if_ptr< ext_t > write (volatile uint64_t &position, const ext_t *src, uint64_t bulk=1, uint32_t channels_circular=1, uint32_t circular_offset=0, uint32_t interleaved=1)
 

Public Attributes

struct { 
 
   volatile uint64_t   count 
 cycle counter More...
 
   volatile uint64_t   reference 
 sample reference of taken timestamp More...
 
   volatile uint64_t   size 
 cycle length in bytes (each cycle length bytes a new timestamp is generated) More...
 
   volatile int64_t   timestamp 
 timestamp of current timestamp cycle More...
 
cycle 
 
uint8_t data [1]
 
volatile uint64_t dropout
 dropout counter
 
volatile uint64_t rx
 single consumers current read index
 
uint64_t size
 size of buffer in bytes
 
volatile int64_t timestamp
 current rx/tx timestamp
 
volatile uint64_t tx
 producers current write index
 

Static Public Attributes

static constexpr format any = {}
 
static constexpr format audio = {.audio= true,}
 
static constexpr format float32 = {.audio= true, .real=true, .resolution= 32, .size= sizeof(float),}
 
static constexpr format float64 = {.audio= true, .real=true, .resolution= 64, .size= sizeof(double),}
 
static constexpr format invalid = {}
 
static constexpr format midi = {.midi= true,}
 
static constexpr format pcm16 = {.audio= true, .resolution= 16, .size= sizeof(int16_t),}
 
static constexpr format pcm24 = {.audio= true, .resolution= 24, .size= sizeof(dx::int24),}
 
static constexpr format pcm24in32hi = {.audio= true, .resolution= 24, .size= sizeof(int32_t),}
 
static constexpr format pcm24in32lo = {.audio= true, .resolution= 24, .size= sizeof(int32_t), .alignment= format::alignment::low,}
 
static constexpr format pcm32 = {.audio= true, .resolution= 32, .size= sizeof(int32_t),}
 

Detailed Description

template<class buffer_t = dx::circular>
struct dx::usb::midi< buffer_t >

USB MIDI packetizer.

Member Function Documentation

◆ decode()

template<class buffer_t = dx::circular>
size_t dx::usb::midi< buffer_t >::decode ( uint64_t & rx,
union msg & msg,
uint8_t cable )
inline

USB MIDI msg word to OS MIDI stream format decoder.

Pops a corresponding MIDI msg from the backing store

filters MIDI data only for this cable number and ignores: CIN misc function, future use & cable events,

generates event size out of USB-MIDI CIN (code index) classification look-up table,

Parameters
cableUSB MIDI cable number

◆ empty() [1/2]

uint64_t dx::circular::empty ( ) const
inlineinherited
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ empty() [2/2]

uint64_t dx::circular::empty ( uint64_t position) const
inlineinherited
+ Here is the call graph for this function:

◆ encode()

template<class buffer_t = dx::circular>
bool dx::usb::midi< buffer_t >::encode ( const uint8_t * os_midi_package,
size_t length,
uint8_t cable )
inline

OS MIDI stream to USB MIDI msg word format encoder.

Encodes USB midi message from OS MIDI package and pushes it to USB MIDI backingstore buffer. It does not signal the buffer though so encode can be called for multiple MIDI packages and then manually signalled together. Although generally unusual handles SYSEX midi and any combination of general MIDI and SYSEX in the same OS package.

checks OS MIDI msg type validy,

handles SYSEX data

Todo
cleanup issue with stl not available in kernel:

checks for sysex termination prior end of os_midi_stream

checks if USB SYSEX msg fits and pushes msg to the backingstore without signalization.

handles general USB MIDI messages

computes USB MIDI msg nibbles,

checks OS MIDI msg size,

selects MIDI cable number and synthesize USB MIDI msg word,

checks if USB MIDI msg fits and pushes msg to the backingstore without signalization.

Parameters
os_midi_packageOS MIDI package
lengthlength of the OS MIDI package
cableUSB MIDI cable number

◆ force_read() [1/4]

template<typename ext_t , typename circular_t = ext_t>
hide_if_ptr< ext_t > dx::circular::force_read ( ext_t *const * dst,
uint64_t bulk = 1,
uint32_t channels_circular = 1,
uint32_t channels_dst = 1,
uint32_t circular_offset = 0,
uint32_t interleaved = 1 )
inlineinherited

◆ force_read() [2/4]

template<typename ext_t , typename circular_t = ext_t>
hide_if_ptr< ext_t > dx::circular::force_read ( ext_t * dst,
uint64_t bulk = 1,
uint32_t channels_circular = 1,
uint32_t circular_offset = 0,
uint32_t interleaved = 1 )
inlineinherited

◆ force_read() [3/4]

template<typename ext_t , typename circular_t = ext_t>
bool dx::circular::force_read ( volatile uint64_t & position,
ext_t *const * dst,
uint64_t bulk,
uint32_t channels_circular = 1,
uint32_t channels_dst = 1,
uint32_t circular_offset = 0,
uint32_t interleaved = 1 )
inlineinherited

multi channel interleaved bulk read from circular buffer with format conversion if applicable

return true if enough data is available in circular space

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ force_read() [4/4]

template<typename ext_t , typename circular_t = ext_t>
hide_if_ptr< ext_t > dx::circular::force_read ( volatile uint64_t & position,
ext_t * dst,
uint64_t bulk = 1,
uint32_t channels_circular = 1,
uint32_t circular_offset = 0,
uint32_t interleaved = 1 )
inlineinherited

◆ force_write() [1/6]

template<typename ext_t , typename circular_t = ext_t>
bool dx::circular::force_write ( const ext_t *const * src,
uint64_t bulk = 1,
uint32_t channels_circular = 1,
uint32_t channels_src = 1,
uint32_t circular_offset = 0,
uint32_t interleaved = 1 )
inlineinherited

◆ force_write() [2/6]

template<typename ext_t , typename circular_t = ext_t>
hide_if_ptr< ext_t > dx::circular::force_write ( const ext_t * src,
uint64_t bulk = 1,
uint32_t channels_circular = 1,
uint32_t circular_offset = 0,
uint32_t interleaved = 1 )
inlineinherited

◆ force_write() [3/6]

template<typename data_t >
bool dx::circular::force_write ( data_t *const *const * src,
uint64_t clients,
uint64_t channels,
uint64_t bulk )
inlineinherited

◆ force_write() [4/6]

template<typename circular_t , typename src_t >
bool dx::circular::force_write ( src_t *const *const * src,
uint32_t clients,
uint32_t channels = 1,
uint64_t bulk = 1 )
inlineinherited

multi channel multi client bulk mix into circular buffer with format conversion if applicable src[client][channel][sample]

return true if data fit into empty space

◆ force_write() [5/6]

template<typename ext_t , typename circular_t = ext_t>
bool dx::circular::force_write ( volatile uint64_t & position,
const ext_t *const * src,
uint64_t bulk,
uint32_t channels_circular = 1,
uint32_t channels_src = 1,
uint32_t circular_offset = 0,
uint32_t interleaved = 1 )
inlineinherited

multi channel interleaved bulk write into circular buffer with format conversion if applicable

return true if data fit into circular space false if data fit not or older data had to be overwritten

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ force_write() [6/6]

template<typename ext_t , typename circular_t = ext_t>
hide_if_ptr< ext_t > dx::circular::force_write ( volatile uint64_t & position,
const ext_t * src,
uint64_t bulk = 1,
uint32_t channels_circular = 1,
uint32_t circular_offset = 0,
uint32_t interleaved = 1 )
inlineinherited

single channel convenience access templates

◆ initialize() [1/2]

void dx::circular::initialize ( )
inlineinherited

◆ initialize() [2/2]

void dx::circular::initialize ( uint64_t backingstore_size)
inlineinherited
+ Here is the caller graph for this function:

◆ loop()

uint64_t dx::circular::loop ( ) const
inlineinherited

◆ move()

template<typename callback_t >
void dx::circular::move ( callback_t & callback,
uint64_t max )
inlineinherited
+ Here is the call graph for this function:

◆ operator<<()

template<typename data_t >
hide_if_ptr< data_t > dx::circular::operator<< ( const data_t & src)
inlineinherited
+ Here is the call graph for this function:

◆ operator>>()

template<typename data_t >
hide_if_ptr< data_t > dx::circular::operator>> ( data_t & dst)
inlineinherited
+ Here is the caller graph for this function:

◆ read() [1/4]

template<typename ext_t , typename circular_t = ext_t>
hide_if_ptr< ext_t > dx::circular::read ( ext_t *const * dst,
uint64_t bulk = 1,
uint32_t channels_circular = 1,
uint32_t channels_dst = 1,
uint32_t circular_offset = 0,
uint32_t interleaved = 1 )
inlineinherited
+ Here is the call graph for this function:

◆ read() [2/4]

template<typename ext_t , typename circular_t = ext_t>
hide_if_ptr< ext_t > dx::circular::read ( ext_t * dst,
uint64_t bulk = 1,
uint32_t channels_circular = 1,
uint32_t circular_offset = 0,
uint32_t interleaved = 1 )
inlineinherited

◆ read() [3/4]

template<typename ext_t , typename circular_t = ext_t>
hide_if_ptr< ext_t > dx::circular::read ( volatile uint64_t & position,
ext_t *const * dst,
uint64_t bulk = 1,
uint32_t channels_circular = 1,
uint32_t channels_dst = 1,
uint32_t circular_offset = 0,
uint32_t interleaved = 1 )
inlineinherited
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ read() [4/4]

template<typename ext_t , typename circular_t = ext_t>
hide_if_ptr< ext_t > dx::circular::read ( volatile uint64_t & position,
ext_t * dst,
uint64_t bulk = 1,
uint32_t channels_circular = 1,
uint32_t circular_offset = 0,
uint32_t interleaved = 1 )
inlineinherited

◆ simulate_read() [1/2]

template<typename dst_t = uint8_t>
dst_t * dx::circular::simulate_read ( uint64_t bulk = 1)
inlineinherited

◆ simulate_read() [2/2]

template<typename dst_t = uint8_t>
dst_t * dx::circular::simulate_read ( volatile uint64_t & position,
uint64_t bulk )
inlineinherited
+ Here is the call graph for this function:

◆ simulate_write()

uint8_t * dx::circular::simulate_write ( uint64_t bulk)
inlineinherited

simulate write by advancing write idx and take care of wrap write optimization

+ Here is the caller graph for this function:

◆ used() [1/2]

uint64_t dx::circular::used ( ) const
inlineinherited
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ used() [2/2]

uint64_t dx::circular::used ( uint64_t position) const
inlineinherited
+ Here is the call graph for this function:

◆ write() [1/4]

template<typename ext_t , typename circular_t = ext_t>
bool dx::circular::write ( const ext_t *const * src,
uint64_t bulk = 1,
uint32_t channels_circular = 1,
uint32_t channels_src = 1,
uint32_t circular_offset = 0,
uint32_t interleaved = 1 )
inlineinherited
+ Here is the call graph for this function:

◆ write() [2/4]

template<typename ext_t , typename circular_t = ext_t>
hide_if_ptr< ext_t > dx::circular::write ( const ext_t * src,
uint64_t bulk = 1,
uint32_t channels_circular = 1,
uint32_t circular_offset = 0,
uint32_t interleaved = 1 )
inlineinherited

◆ write() [3/4]

template<typename ext_t , typename circular_t = ext_t>
bool dx::circular::write ( volatile uint64_t & position,
const ext_t *const * src,
uint64_t bulk = 1,
uint32_t channels_circular = 1,
uint32_t channels_src = 1,
uint32_t circular_offset = 0,
uint32_t interleaved = 1 )
inlineinherited

bulk write into circular buffer with format conversion if applicable

return true if data fit into empty space

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ write() [4/4]

template<typename ext_t , typename circular_t = ext_t>
hide_if_ptr< ext_t > dx::circular::write ( volatile uint64_t & position,
const ext_t * src,
uint64_t bulk = 1,
uint32_t channels_circular = 1,
uint32_t circular_offset = 0,
uint32_t interleaved = 1 )
inlineinherited

Member Data Documentation

◆ any

constexpr format dx::circular::any = {}
staticconstexprinherited

◆ audio

constexpr format dx::circular::audio = {.audio= true,}
staticconstexprinherited

◆ count

volatile uint64_t dx::circular::count
inherited

cycle counter

◆ [struct]

struct { ... } dx::circular::cycle

◆ data

uint8_t dx::circular::data[1]
inherited

◆ dropout

volatile uint64_t dx::circular::dropout
inherited

dropout counter

◆ float32

constexpr format dx::circular::float32 = {.audio= true, .real=true, .resolution= 32, .size= sizeof(float),}
staticconstexprinherited

◆ float64

constexpr format dx::circular::float64 = {.audio= true, .real=true, .resolution= 64, .size= sizeof(double),}
staticconstexprinherited

◆ invalid

constexpr format dx::circular::invalid = {}
staticconstexprinherited

◆ midi

constexpr format dx::circular::midi = {.midi= true,}
staticconstexprinherited

◆ pcm16

constexpr format dx::circular::pcm16 = {.audio= true, .resolution= 16, .size= sizeof(int16_t),}
staticconstexprinherited

◆ pcm24

constexpr format dx::circular::pcm24 = {.audio= true, .resolution= 24, .size= sizeof(dx::int24),}
staticconstexprinherited

◆ pcm24in32hi

constexpr format dx::circular::pcm24in32hi = {.audio= true, .resolution= 24, .size= sizeof(int32_t),}
staticconstexprinherited

◆ pcm24in32lo

constexpr format dx::circular::pcm24in32lo = {.audio= true, .resolution= 24, .size= sizeof(int32_t), .alignment= format::alignment::low,}
staticconstexprinherited

◆ pcm32

constexpr format dx::circular::pcm32 = {.audio= true, .resolution= 32, .size= sizeof(int32_t),}
staticconstexprinherited

◆ reference

volatile uint64_t dx::circular::reference
inherited

sample reference of taken timestamp

◆ rx

volatile uint64_t dx::circular::rx
inherited

single consumers current read index

◆ size [1/2]

uint64_t dx::circular::size
inherited

size of buffer in bytes

◆ size [2/2]

volatile uint64_t dx::circular::size
inherited

cycle length in bytes (each cycle length bytes a new timestamp is generated)

◆ timestamp

volatile int64_t dx::circular::timestamp
inherited

current rx/tx timestamp

timestamp of current timestamp cycle

◆ tx

volatile uint64_t dx::circular::tx
inherited

producers current write index


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

(c) copyright 2009 dynamic acoustics e.U. generated on Wed Feb 28 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.