File size: 7,516 Bytes
b50f2a2 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 |
//
// Copyright © 2025 Agora
// This file is part of TEN Framework, an open source project.
// Licensed under the Apache License, Version 2.0, with certain conditions.
// Refer to the "LICENSE" file in the root directory for more information.
//
#ifndef __AED_H__
#define __AED_H__
#include <stdint.h>
#include <stdlib.h>
#define AUP_AED_MAX_FFT_SZ (1024) // the max. fft-size supported by VAD module
#define AUP_AED_MAX_NBINS ((AUP_AED_MAX_FFT_SZ >> 1) + 1)
#define AUP_AED_FS (16000) // assumed input freq.
// Configuration Parameters, which impacts dynamic memory occupation, can only
// be set during allocation
typedef struct Aed_StaticCfg_ {
int enableFlag; // flag to enable or disable this module
// 0: disable, o.w.: enable
size_t fftSz; // fft-size, only support: 128, 256, 512, 1024
size_t hopSz; // fft-Hop Size, will be used to check
size_t anaWindowSz; // fft-window Size, will be used to calc rms
int frqInputAvailableFlag; // whether Aed_InputData will contain external
// freq. power-sepctra
} Aed_StaticCfg;
// Configuraiton parameters which can be modified/set every frames
typedef struct Aed_DynamCfg_ {
float extVoiceThr; // threshold for ai based voice decision [0,1]
float extMusicThr; // threshold for ai based music decision [0,1]
float extEnergyThr; // threshold for energy based vad decision [0, ---]
size_t resetFrameNum; // frame number for aivad reset [1875, 75000]
float pitchEstVoicedThr; // threshold for pitch-estimator to output estimated
// pitch
} Aed_DynamCfg;
// Spectrum are assumed to be generated with time-domain samples in [-32768,
// 32767] with or without pre-emphasis operation
typedef struct Aed_InputData_ {
const float* binPower; // [NBins], power spectrum of 16KHz samples
int nBins;
const float*
timeSignal; // [hopSz] // this frame's input signal, in [-32768, 32767]
int hopSz; // should be equal to StaticCfg->hopSz
} Aed_InputData;
// return data from statistical ns module
typedef struct Aed_OutputData_ {
float frameEnergy; // frame energy for input normalized data
float frameRms; // rms for input int16 data
int energyVadRes; // vad res 0/1 with extEnergyThreshold based on input frame
// energy
float voiceProb; // vad score [0,1]
int vadRes; // vad res 0/1 with extVoiceThr based on ai method, t + 16ms res
// correspond to the t input
float pitchFreq; // estimated pitch freq.
} Aed_OutputData;
#ifdef __cplusplus
extern "C" {
#endif
/****************************************************************************
* AUP_Aed_Create(...)
*
* This function creats a state handler from nothing, which is NOT ready for
* processing
*
* Input:
*
* Output:
* - stPtr : buffer to store the returned state handler
*
* Return value : 0 - Ok
* -1 - Error
*/
int AUP_Aed_create(void** stPtr);
/****************************************************************************
* AUP_Aed_Destroy(...)
*
* destroy VAD instance, and releasing all the dynamically allocated memory
* this interface will also release ainsFactory, which was
* created externally and passed to VAD module through memAllocate interface
*
* Input:
* - stPtr : buffer of State Handler, after this method, this
* handler won't be usable anymore
*
* Output:
*
* Return value : 0 - Ok
* -1 - Error
*/
int AUP_Aed_destroy(void** stPtr);
/****************************************************************************
* AUP_Aed_MemAllocate(...)
*
* This function sets Static Config params and does memory allocation
* operation, will lose the dynamCfg values
*
* Input:
* - stPtr : State Handler which was returned by _create
* - pCfg : static configuration parameters
*
* Output:
*
* Return value : 0 - Ok
* -1 - Error
*/
int AUP_Aed_memAllocate(void* stPtr, const Aed_StaticCfg* pCfg);
/****************************************************************************
* AUP_Aed_init(...)
*
* This function resets (initialize) the VAD module and gets it prepared for
* processing
*
* Input:
* - stPtr : State Handler which has gone through create and
* memAllocate
*
* Output:
*
* Return value : 0 - Ok
* -1 - Error
*/
int AUP_Aed_init(void* stPtr);
/****************************************************************************
* AUP_Aed_setDynamCfg(...)
*
* This function set dynamic (per-frame variable) configuration
*
* Input:
* - stPtr : State Handler which has gone through create and
* memAllocate
* - pCfg : configuration content
*
* Output:
*
* Return value : 0 - Ok
* -1 - Error
*/
int AUP_Aed_setDynamCfg(void* stPtr, const Aed_DynamCfg* pCfg);
/****************************************************************************
* AUP_Aed_getStaticCfg(...)
*
* This function get static configuration status from VAD module
*
* Input:
* - stPtr : State Handler which has gone through create and
* memAllocate
*
* Output:
* - pCfg : configuration content
*
* Return value : 0 - Ok
* -1 - Error
*/
int AUP_Aed_getStaticCfg(const void* stPtr, Aed_StaticCfg* pCfg);
/****************************************************************************
* AUP_Aed_getDynamCfg(...)
*
* This function get dynamic (per-frame variable) configuration status from
* VAD module
*
* Input:
* - stPtr : State Handler which has gone through create and
* memAllocate
*
* Output:
* - pCfg : configuration content
*
* Return value : 0 - Ok
* -1 - Error
*/
int AUP_Aed_getDynamCfg(const void* stPtr, Aed_DynamCfg* pCfg);
/****************************************************************************
* AUP_Aed_getAlgDelay(...)
*
* This function get algorithm delay from VAD module
*
* Input:
* - stPtr : State Handler which has gone through create and
* memAllocate
*
* Output:
* - delayInFrms : algorithm delay in terms of frames
*
* Return value : 0 - Ok
* -1 - Error
*/
int AUP_Aed_getAlgDelay(const void* stPtr, int* delayInFrms);
/****************************************************************************
* AUP_Aed_proc(...)
*
* process a single frame
*
* Input:
* - stPtr : State Handler which has gone through create and
* memAllocate and reset
* - pCtrl : per-frame variable control parameters
* - pIn : input data stream
*
* Output:
* - pOut : output data (mask, highband time-domain gain etc.)
*
* Return value : 0 - Ok
* -1 - Error
*/
int AUP_Aed_proc(void* stPtr, const Aed_InputData* pIn, Aed_OutputData* pOut);
#ifdef __cplusplus
}
#endif
#endif
|