Type definition for the RTNR processing function. More...

#include <rtnr.h>

Data Fields
uint32_t	size
	Runtime buffer size in bytes (period multiple).
uint32_t	avail
	Available bytes for reading.
uint32_t	free
	Free bytes for writing.
void *	w_ptr
	Buffer write pointer.
void *	r_ptr
	Buffer read position.
void *	addr
	Buffer base address.
void *	end_addr
	Buffer end address.
enum sof_ipc_frame	frame_fmt
	Sample data format.
uint32_t	rate
	Number of data frames per second [Hz].
uint16_t	channels
	Number of samples in each frame.
bool	overrun_permitted
	indicates whether overrun is permitted
bool	underrun_permitted
	indicates whether underrun is permitted

Detailed Description

Type definition for the RTNR processing function.

Field Documentation

◆ addr

void* audio_stream_rtnr::addr

Buffer base address.

◆ avail

uint32_t audio_stream_rtnr::avail

Available bytes for reading.

◆ channels

uint16_t audio_stream_rtnr::channels

Number of samples in each frame.

◆ end_addr

void* audio_stream_rtnr::end_addr

Buffer end address.

◆ frame_fmt

enum sof_ipc_frame audio_stream_rtnr::frame_fmt

Sample data format.

◆ free

uint32_t audio_stream_rtnr::free

Free bytes for writing.

◆ overrun_permitted

bool audio_stream_rtnr::overrun_permitted

indicates whether overrun is permitted

◆ r_ptr

void* audio_stream_rtnr::r_ptr

Buffer read position.

◆ rate

uint32_t audio_stream_rtnr::rate

Number of data frames per second [Hz].

◆ size

uint32_t audio_stream_rtnr::size

Runtime buffer size in bytes (period multiple).

◆ underrun_permitted

bool audio_stream_rtnr::underrun_permitted

indicates whether underrun is permitted

◆ w_ptr

void* audio_stream_rtnr::w_ptr

Buffer write pointer.

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

/home/lrg/work/sof-dox-work/src/include/sof/audio/rtnr/rtnr.h

Data Fields