Skip to content

rtnr: Add audio stream layer between sof and RTNR #5543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cujomalainey merged 1 commit into from
May 13, 2022
Merged

rtnr: Add audio stream layer between sof and RTNR #5543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 59 additions & 13 deletions src/audio/rtnr/rtnr.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@

Copy link
Collaborator

@dbaluta dbaluta May 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

preferred format for subject is:

rtnr: Add audio stream layer...

instead of

[RTNR] Add ...

Copy link
Contributor Author

@MingJenTai MingJenTai May 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed this. Thank you!

Copy link
Contributor Author

@MingJenTai MingJenTai May 11, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cujomalainey Can this PR be merged? Thanks.

#define RTNR_BLK_LENGTH 4 /* Must be power of 2 */
#define RTNR_BLK_LENGTH_MASK (RTNR_BLK_LENGTH - 1)
#define RTNR_MAX_SOURCES 1 /* Microphone stream */

static const struct comp_driver comp_rtnr;

Expand Down Expand Up @@ -100,9 +99,8 @@ void rtk_rfree(void *ptr)

#if CONFIG_FORMAT_S16LE

static void rtnr_s16_default(struct comp_dev *dev, const struct audio_stream **sources,
struct audio_stream *sink, int frames)

static void rtnr_s16_default(struct comp_dev *dev, struct audio_stream_rtnr **sources,
struct audio_stream_rtnr *sink, int frames)
{
struct comp_data *cd = comp_get_drvdata(dev);

Expand All @@ -115,9 +113,8 @@ static void rtnr_s16_default(struct comp_dev *dev, const struct audio_stream **s

#if CONFIG_FORMAT_S24LE

static void rtnr_s24_default(struct comp_dev *dev, const struct audio_stream **sources,
struct audio_stream *sink, int frames)

static void rtnr_s24_default(struct comp_dev *dev, struct audio_stream_rtnr **sources,
struct audio_stream_rtnr *sink, int frames)
{
struct comp_data *cd = comp_get_drvdata(dev);

Expand All @@ -130,9 +127,8 @@ static void rtnr_s24_default(struct comp_dev *dev, const struct audio_stream **s

#if CONFIG_FORMAT_S32LE

static void rtnr_s32_default(struct comp_dev *dev, const struct audio_stream **sources,
struct audio_stream *sink, int frames)

static void rtnr_s32_default(struct comp_dev *dev, struct audio_stream_rtnr **sources,
struct audio_stream_rtnr *sink, int frames)
{
struct comp_data *cd = comp_get_drvdata(dev);

Expand Down Expand Up @@ -352,6 +348,8 @@ static int rtnr_params(struct comp_dev *dev, struct sof_ipc_stream_params *param
/* set source/sink_frames/rate */
cd->source_rate = sourceb->stream.rate;
cd->sink_rate = sinkb->stream.rate;
cd->sources_stream[0].rate = sourceb->stream.rate;
cd->sink_stream.rate = sinkb->stream.rate;
if (!cd->sink_rate) {
comp_err(dev, "rtnr_nr_params(), zero sink rate");
return -EINVAL;
Expand All @@ -376,6 +374,16 @@ static int rtnr_params(struct comp_dev *dev, struct sof_ipc_stream_params *param
return -EINVAL;
}

/* set source/sink stream channels */
cd->sources_stream[0].channels = sourceb->stream.channels;
cd->sink_stream.channels = sinkb->stream.channels;

/* set source/sink stream overrun/underrun permitted */
cd->sources_stream[0].overrun_permitted = sourceb->stream.overrun_permitted;
cd->sink_stream.overrun_permitted = sinkb->stream.overrun_permitted;
cd->sources_stream[0].underrun_permitted = sourceb->stream.underrun_permitted;
cd->sink_stream.underrun_permitted = sinkb->stream.underrun_permitted;

return 0;
}

Expand Down Expand Up @@ -521,6 +529,29 @@ static int rtnr_trigger(struct comp_dev *dev, int cmd)
return comp_set_state(dev, cmd);
}

static void rtnr_copy_from_sof_stream(struct audio_stream_rtnr *dst, struct audio_stream *src)
{

dst->size = src->size;
dst->avail = src->avail;
dst->free = src->free;
dst->w_ptr = src->w_ptr;
dst->r_ptr = src->r_ptr;
dst->addr = src->addr;
dst->end_addr = src->end_addr;
}

static void rtnr_copy_to_sof_stream(struct audio_stream *dst, struct audio_stream_rtnr *src)
{
dst->size = src->size;
dst->avail = src->avail;
dst->free = src->free;
dst->w_ptr = src->w_ptr;
dst->r_ptr = src->r_ptr;
dst->addr = src->addr;
dst->end_addr = src->end_addr;
}

/* copy and process stream data from source to sink buffers */
static int rtnr_copy(struct comp_dev *dev)
{
Expand All @@ -529,11 +560,16 @@ static int rtnr_copy(struct comp_dev *dev)
int frames;
int sink_bytes;
int source_bytes;
const struct audio_stream *sources_stream[RTNR_MAX_SOURCES] = { NULL };
struct comp_data *cd = comp_get_drvdata(dev);
struct audio_stream_rtnr *sources_stream[RTNR_MAX_SOURCES];
struct audio_stream_rtnr *sink_stream = &cd->sink_stream;
int32_t i;

comp_dbg(dev, "rtnr_copy()");

for (i = 0; i < RTNR_MAX_SOURCES; ++i)
sources_stream[i] = &cd->sources_stream[i];

source = list_first_item(&dev->bsource_list, struct comp_buffer, sink_list);

/* put empty data into output queue*/
Expand All @@ -559,15 +595,24 @@ static int rtnr_copy(struct comp_dev *dev)
* Processing function uses an array of pointers to source streams
* as parameter.
*/
sources_stream[0] = &source->stream;
cd->rtnr_func(dev, sources_stream, &sink->stream, frames);

/* copy required data from sof audio stream to RTNR audio stream */
rtnr_copy_from_sof_stream(sources_stream[0], &source->stream);
rtnr_copy_from_sof_stream(sink_stream, &sink->stream);

cd->rtnr_func(dev, (struct audio_stream_rtnr **)&sources_stream, sink_stream,
frames);

/*
* real process function of rtnr, consume/produce data from internal queue
* instead of component buffer
*/
RTKMA_API_Process(cd->rtk_agl, 0, cd->source_rate, MicNum);

/* copy required data from RTNR audio stream to sof audio stream */
rtnr_copy_to_sof_stream(&source->stream, sources_stream[0]);
rtnr_copy_to_sof_stream(&sink->stream, sink_stream);

buffer_stream_writeback(sink, sink_bytes);

/* Track consume and produce */
Expand Down Expand Up @@ -597,6 +642,7 @@ static int rtnr_prepare(struct comp_dev *dev)
/* Get sink data format */
sinkb = list_first_item(&dev->bsink_list, struct comp_buffer, source_list);
cd->sink_format = sinkb->stream.frame_fmt;
cd->sink_stream.frame_fmt = sinkb->stream.frame_fmt;

/* Check source and sink PCM format and get copy function */
comp_info(dev, "rtnr_prepare(), sink_format=%d", cd->sink_format);
Expand Down
20 changes: 14 additions & 6 deletions src/include/sof/audio/rtnr/rtklib/include/RTK_MA_API.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@
extern "C" {
#endif

void RTKMA_API_S16_Default(void *Context, const struct audio_stream **sources,
struct audio_stream *sink, int frames,
void RTKMA_API_S16_Default(void *Context, struct audio_stream_rtnr **sources,
struct audio_stream_rtnr *sink, int frames,
_Bool ref_active, int in_idx, int ref_idx,
int ref_32bits, int ref_shift);
void RTKMA_API_S24_Default(void *Context, const struct audio_stream **sources,
struct audio_stream *sink, int frames,
void RTKMA_API_S24_Default(void *Context, struct audio_stream_rtnr **sources,
struct audio_stream_rtnr *sink, int frames,
_Bool ref_active, int in_idx, int ref_idx,
int ref_32bits, int ref_shift);
void RTKMA_API_S32_Default(void *Context, const struct audio_stream **sources,
struct audio_stream *sink, int frames,
void RTKMA_API_S32_Default(void *Context, struct audio_stream_rtnr **sources,
struct audio_stream_rtnr *sink, int frames,
_Bool ref_active, int in_idx, int ref_idx,
int ref_32bits, int ref_shift);

Expand All @@ -44,6 +44,14 @@ int RTKMA_API_Set(void *Context, const void *pParameters, int size, unsigned int

int RTKMA_API_Get(void *Context, void *pParameters, int size, unsigned int IDs);

int RTKMA_API_Set_Preset_Data(void *Context, unsigned int *data,
unsigned int msg_index, unsigned int num_elms,
unsigned int elems_remaining);

int RTKMA_API_Set_Model_Data(void *Context, unsigned int *data,
unsigned int msg_index, unsigned int num_elms,
unsigned int elems_remaining);

#ifdef __cplusplus
}
#endif
Expand Down
30 changes: 28 additions & 2 deletions src/include/sof/audio/rtnr/rtnr.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,35 @@
* \brief Type definition for the RTNR processing function
*
*/

/* for RTNR internal use */
struct audio_stream_rtnr {
/* runtime data */
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 */

/* runtime stream params */
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 */
};

typedef void (*rtnr_func)(struct comp_dev *dev,
const struct audio_stream **sources,
struct audio_stream *sink,
struct audio_stream_rtnr **sources,
struct audio_stream_rtnr *sink,
int frames);

#define RTNR_MAX_SOURCES 1 /* Microphone stream */

/* RTNR component private data */
struct comp_data {
struct comp_data_blob_handler *model_handler;
Expand All @@ -40,6 +64,8 @@ struct comp_data {
bool ref_active;
rtnr_func rtnr_func; /** Processing function */
void *rtk_agl;
struct audio_stream_rtnr sources_stream[RTNR_MAX_SOURCES];
struct audio_stream_rtnr sink_stream;
};

/* Called by the processing library for debugging purpose */
Expand Down