dxd - dynax driver framework  3211
cross platform open source driver development framework
dxd::wavecyclic::stream< circular_t, bus_t, stream_desc_t > Class Template Reference

wavecyclic::stream class More...

#include <dxd_portcls_audio.h>

+ Inheritance diagram for dxd::wavecyclic::stream< circular_t, bus_t, stream_desc_t >:
+ Collaboration diagram for dxd::wavecyclic::stream< circular_t, bus_t, stream_desc_t >:

Public Types

typedef bus_t bus
 
typedef stream_desc_t stream_desc
 

Public Member Functions

virtual os_result start ()
 
virtual void stop ()
 
 stream (::IUnknown *unknown, const ::DEVICE_OBJECT *wdm_bus, const dx::stream::open< bus_t > &open, const stream_desc_t &stream_desc, unsigned int idx, const ::WAVEFORMATEXTENSIBLE &wave)
 audio stream constructor More...
 
 ~stream ()
 

Public Attributes

os_result status =not_initialized
 

Protected Member Functions

bool cancel ()
 
virtual void completion (os_result)
 
os_result ctl (unsigned int ioctl, bool internal=false)
 
os_result ictl (unsigned int ioctl, receipt_t &receipt, bool internal=false)
 
os_result ioctl (const void *post, size_t post_size, unsigned int ioctl, void *receipt, size_t receipt_size, bool internal=false)
 IOCTL IRP http://msdn.microsoft.com/en-us/library/windows/hardware/ff540663(v=vs.85).aspx. More...
 
os_result ioctl (const post_t &post, unsigned int ioctl, receipt_t &receipt, bool internal=false)
 
os_result octl (const post_t &post, unsigned int ioctl, bool internal=false)
 
os_result octl (unsigned int post, unsigned int ioctl, bool internal=false)
 
os_result submit (unsigned int ioctl, void *others)
 submit other IRP More...
 

Protected Attributes

os_event data
 data available event More...
 
os_event gap
 space available event More...
 
circular_t * io
 define the I/O class for shared memory More...
 
uint64_t rx =0
 
bool started =false
 

Detailed Description

template<typename circular_t, typename bus_t, typename stream_desc_t>
class dxd::wavecyclic::stream< circular_t, bus_t, stream_desc_t >

wavecyclic::stream class

generic_audio.png

Member Typedef Documentation

◆ bus

template<typename circular_t , typename bus_t , typename stream_desc_t >
typedef bus_t dxd::wavecyclic::stream< circular_t, bus_t, stream_desc_t >::bus

◆ stream_desc

template<typename circular_t , typename bus_t , typename stream_desc_t >
typedef stream_desc_t dxd::portcls::stream< circular_t, bus_t, stream_desc_t >::stream_desc
inherited

Constructor & Destructor Documentation

◆ stream()

template<typename circular_t , typename bus_t , typename stream_desc_t >
dxd::wavecyclic::stream< circular_t, bus_t, stream_desc_t >::stream ( ::IUnknown *  unknown,
const ::DEVICE_OBJECT *  wdm_bus,
const dx::stream< circular_t, bus_t, stream_desc_t >::open< bus_t > &  open,
const stream_desc_t &  stream_desc,
unsigned int  idx,
const ::WAVEFORMATEXTENSIBLE &  wave 
)
inline

audio stream constructor

◆ ~stream()

template<typename circular_t , typename bus_t , typename stream_desc_t >
dxd::wavecyclic::stream< circular_t, bus_t, stream_desc_t >::~stream ( )
inline

Member Function Documentation

◆ cancel()

bool dxd::wdm::irp< synchrony::sync >::cancel ( )
inlineinherited

◆ completion()

virtual void dxd::wdm::irp< synchrony::sync >::completion ( os_result  )
inlineprotectedvirtualinherited

◆ ctl()

os_result dxd::wdm::irp< synchrony::sync >::ctl ( unsigned int  ioctl,
bool  internal = false 
)
inlineinherited

◆ ictl()

os_result dxd::wdm::irp< synchrony::sync >::ictl ( unsigned int  ioctl,
receipt_t &  receipt,
bool  internal = false 
)
inlineinherited

◆ ioctl() [1/2]

os_result dxd::wdm::irp< synchrony::sync >::ioctl ( const void *  post,
size_t  post_size,
unsigned int  ioctl,
void *  receipt,
size_t  receipt_size,
bool  internal = false 
)
inlineinherited

IOCTL IRP http://msdn.microsoft.com/en-us/library/windows/hardware/ff540663(v=vs.85).aspx.

Todo:
: check and refuse IRQL; handle completion
Todo:
:for asynchronous IRP request: move buffered copy into completion!

◆ ioctl() [2/2]

os_result dxd::wdm::irp< synchrony::sync >::ioctl ( const post_t &  post,
unsigned int  ioctl,
receipt_t &  receipt,
bool  internal = false 
)
inlineinherited

◆ octl() [1/2]

os_result dxd::wdm::irp< synchrony::sync >::octl ( const post_t &  post,
unsigned int  ioctl,
bool  internal = false 
)
inlineinherited

◆ octl() [2/2]

os_result dxd::wdm::irp< synchrony::sync >::octl ( unsigned int  post,
unsigned int  ioctl,
bool  internal = false 
)
inlineinherited

◆ start()

template<typename circular_t , typename bus_t , typename stream_desc_t >
virtual os_result dxd::portcls::stream< circular_t, bus_t, stream_desc_t >::start ( )
inlinevirtualinherited

starts base driver streaming

◆ stop()

template<typename circular_t , typename bus_t , typename stream_desc_t >
virtual void dxd::portcls::stream< circular_t, bus_t, stream_desc_t >::stop ( )
inlinevirtualinherited

stops the underlaying base driver streaming

◆ submit()

os_result dxd::wdm::irp< synchrony::sync >::submit ( unsigned int  ioctl,
void *  others 
)
inlineinherited

submit other IRP

Member Data Documentation

◆ data

os_event dxd::stream::opened< circular_t >::data
inherited

data available event

◆ gap

os_event dxd::stream::opened< circular_t >::gap
inherited

space available event

◆ io

circular_t * dxd::stream::opened< circular_t >::io
inherited

define the I/O class for shared memory

◆ rx

template<typename circular_t , typename bus_t , typename stream_desc_t >
uint64_t dxd::portcls::stream< circular_t, bus_t, stream_desc_t >::rx =0
protectedinherited

◆ started

template<typename circular_t , typename bus_t , typename stream_desc_t >
bool dxd::portcls::stream< circular_t, bus_t, stream_desc_t >::started =false
protectedinherited

◆ status

template<typename circular_t , typename bus_t , typename stream_desc_t >
os_result dxd::portcls::stream< circular_t, bus_t, stream_desc_t >::status =not_initialized
inherited

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

(c) copyright 2009 dynamic acoustics e.U. generated on Sat Aug 22 2020

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.