rtnr.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright(c) 2021 Realtek Semiconductor Corp. All rights reserved.
 *
 * Author: Ming Jen Tai <mingjen_tai@realtek.com>
 */
 
#ifndef __SOF_AUDIO_RTNR_RTNR_H__
#define __SOF_AUDIO_RTNR_RTNR_H__
 
#include <sof/audio/module_adapter/module/generic.h>
#include <sof/audio/component.h>
#include <sof/platform.h>
#include <ipc/stream.h>
#include <user/rtnr.h>
#include <stdint.h>
#include <stdbool.h>

 
/* for RTNR internal use */
struct audio_stream_rtnr {
    /* runtime data */
    uint32_t size;  
    uint32_t avail; 
    uint32_t free;  
    void *w_ptr;    
    void *r_ptr;    
    void *addr; 
    void *end_addr; 
 
    /* runtime stream params */
    enum sof_ipc_frame frame_fmt;   
 
    uint32_t rate;      
    uint16_t channels;  
 
    bool overrun_permitted; 
    bool underrun_permitted; 
};
 
typedef void (*rtnr_func)(struct processing_module *mod,
              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;
    struct sof_rtnr_config config;      
    enum sof_ipc_frame source_format;
    enum sof_ipc_frame sink_format;
    enum sof_ipc_frame ref_format;
    int source_channel;
    int reference_channel;
    uint32_t sink_rate;
    uint32_t source_rate;
    bool process_enable;
    uint32_t process_sample_rate;
    int ref_shift;
    bool ref_32bits;
    bool ref_active;
    rtnr_func rtnr_func; 
    void *rtk_agl;
    struct audio_stream_rtnr sources_stream[RTNR_MAX_SOURCES];
    struct audio_stream_rtnr sink_stream;
    bool reconfigure;
};
 
/* Called by the processing library for debugging purpose */
void rtnr_printf(int a, int b, int c, int d, int e);
 
/*
 * Called by the processing library to redirect memory allocation/deallocation to
 * sof memory APIs
 */
void *rtk_rballoc(unsigned int flags, unsigned int caps, unsigned int bytes);
void rtk_rfree(void *ptr);
 
#endif /* __SOF_AUDIO_RTNR_RTNR_H__ */