1e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent/* 2e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent * Copyright (c) 2011 The WebRTC project authors. All Rights Reserved. 3e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent * 4e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent * Use of this source code is governed by a BSD-style license 5e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent * that can be found in the LICENSE file in the root of the source 6e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent * tree. An additional intellectual property rights grant can be found 7e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent * in the file PATENTS. All contributing project authors may 8e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent * be found in the AUTHORS file in the root of the source tree. 9e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent */ 10e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent 11e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent#ifndef WEBRTC_MODULES_AUDIO_PROCESSING_AGC_MAIN_SOURCE_ANALOG_AGC_H_ 12e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent#define WEBRTC_MODULES_AUDIO_PROCESSING_AGC_MAIN_SOURCE_ANALOG_AGC_H_ 13e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent 14e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent#include "typedefs.h" 15e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent#include "gain_control.h" 16e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent#include "digital_agc.h" 17e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent 18e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent//#define AGC_DEBUG 19e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent//#define MIC_LEVEL_FEEDBACK 20e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent#ifdef AGC_DEBUG 21e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent#include <stdio.h> 22e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent#endif 23e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent 24e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent/* Analog Automatic Gain Control variables: 25e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent * Constant declarations (inner limits inside which no changes are done) 26e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent * In the beginning the range is narrower to widen as soon as the measure 27e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent * 'Rxx160_LP' is inside it. Currently the starting limits are -22.2+/-1dBm0 28e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent * and the final limits -22.2+/-2.5dBm0. These levels makes the speech signal 29e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent * go towards -25.4dBm0 (-31.4dBov). Tuned with wbfile-31.4dBov.pcm 30e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent * The limits are created by running the AGC with a file having the desired 31e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent * signal level and thereafter plotting Rxx160_LP in the dBm0-domain defined 32e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent * by out=10*log10(in/260537279.7); Set the target level to the average level 33e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent * of our measure Rxx160_LP. Remember that the levels are in blocks of 16 in 34e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent * Q(-7). (Example matlab code: round(db2pow(-21.2)*16/2^7) ) 35e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent */ 36e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent#define RXX_BUFFER_LEN 10 37e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent 38e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurentstatic const WebRtc_Word16 kMsecSpeechInner = 520; 39e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurentstatic const WebRtc_Word16 kMsecSpeechOuter = 340; 40e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent 41e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurentstatic const WebRtc_Word16 kNormalVadThreshold = 400; 42e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent 43e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurentstatic const WebRtc_Word16 kAlphaShortTerm = 6; // 1 >> 6 = 0.0156 44e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurentstatic const WebRtc_Word16 kAlphaLongTerm = 10; // 1 >> 10 = 0.000977 45e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent 46e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurenttypedef struct 47e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent{ 48e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent // Configurable parameters/variables 49e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_UWord32 fs; // Sampling frequency 50e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word16 compressionGaindB; // Fixed gain level in dB 51e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word16 targetLevelDbfs; // Target level in -dBfs of envelope (default -3) 52e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word16 agcMode; // Hard coded mode (adaptAna/adaptDig/fixedDig) 53e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_UWord8 limiterEnable; // Enabling limiter (on/off (default off)) 54e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtcAgc_config_t defaultConfig; 55e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtcAgc_config_t usedConfig; 56e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent 57e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent // General variables 58e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word16 initFlag; 59e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word16 lastError; 60e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent 61e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent // Target level parameters 62e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent // Based on the above: analogTargetLevel = round((32767*10^(-22/20))^2*16/2^7) 63e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 analogTargetLevel; // = RXX_BUFFER_LEN * 846805; -22 dBfs 64e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 startUpperLimit; // = RXX_BUFFER_LEN * 1066064; -21 dBfs 65e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 startLowerLimit; // = RXX_BUFFER_LEN * 672641; -23 dBfs 66e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 upperPrimaryLimit; // = RXX_BUFFER_LEN * 1342095; -20 dBfs 67e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 lowerPrimaryLimit; // = RXX_BUFFER_LEN * 534298; -24 dBfs 68e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 upperSecondaryLimit;// = RXX_BUFFER_LEN * 2677832; -17 dBfs 69e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 lowerSecondaryLimit;// = RXX_BUFFER_LEN * 267783; -27 dBfs 70e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_UWord16 targetIdx; // Table index for corresponding target level 71e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent#ifdef MIC_LEVEL_FEEDBACK 72e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_UWord16 targetIdxOffset; // Table index offset for level compensation 73e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent#endif 74e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word16 analogTarget; // Digital reference level in ENV scale 75e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent 76e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent // Analog AGC specific variables 77e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 filterState[8]; // For downsampling wb to nb 78e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 upperLimit; // Upper limit for mic energy 79e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 lowerLimit; // Lower limit for mic energy 80e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 Rxx160w32; // Average energy for one frame 81e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 Rxx16_LPw32; // Low pass filtered subframe energies 82e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 Rxx160_LPw32; // Low pass filtered frame energies 83e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 Rxx16_LPw32Max; // Keeps track of largest energy subframe 84e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 Rxx16_vectorw32[RXX_BUFFER_LEN];// Array with subframe energies 85e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 Rxx16w32_array[2][5];// Energy values of microphone signal 86e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 env[2][10]; // Envelope values of subframes 87e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent 88e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word16 Rxx16pos; // Current position in the Rxx16_vectorw32 89e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word16 envSum; // Filtered scaled envelope in subframes 90e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word16 vadThreshold; // Threshold for VAD decision 91e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word16 inActive; // Inactive time in milliseconds 92e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word16 msTooLow; // Milliseconds of speech at a too low level 93e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word16 msTooHigh; // Milliseconds of speech at a too high level 94e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word16 changeToSlowMode; // Change to slow mode after some time at target 95e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word16 firstCall; // First call to the process-function 96e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word16 msZero; // Milliseconds of zero input 97e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word16 msecSpeechOuterChange;// Min ms of speech between volume changes 98e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word16 msecSpeechInnerChange;// Min ms of speech between volume changes 99e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word16 activeSpeech; // Milliseconds of active speech 100e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word16 muteGuardMs; // Counter to prevent mute action 101e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word16 inQueue; // 10 ms batch indicator 102e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent 103e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent // Microphone level variables 104e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 micRef; // Remember ref. mic level for virtual mic 105e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_UWord16 gainTableIdx; // Current position in virtual gain table 106e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 micGainIdx; // Gain index of mic level to increase slowly 107e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 micVol; // Remember volume between frames 108e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 maxLevel; // Max possible vol level, incl dig gain 109e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 maxAnalog; // Maximum possible analog volume level 110e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 maxInit; // Initial value of "max" 111e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 minLevel; // Minimum possible volume level 112e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 minOutput; // Minimum output volume level 113e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 zeroCtrlMax; // Remember max gain => don't amp low input 114e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent 115e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word16 scale; // Scale factor for internal volume levels 116e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent#ifdef MIC_LEVEL_FEEDBACK 117e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word16 numBlocksMicLvlSat; 118e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_UWord8 micLvlSat; 119e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent#endif 120e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent // Structs for VAD and digital_agc 121e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent AgcVad_t vadMic; 122e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent DigitalAgc_t digitalAgc; 123e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent 124e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent#ifdef AGC_DEBUG 125e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent FILE* fpt; 126e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent FILE* agcLog; 127e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word32 fcount; 128e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent#endif 129e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent 130e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent WebRtc_Word16 lowLevelSignal; 131e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent} Agc_t; 132e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent 133e48d5845c8b35de2ab73ea055c18a61fa3a9f0beEric Laurent#endif // WEBRTC_MODULES_AUDIO_PROCESSING_AGC_MAIN_SOURCE_ANALOG_AGC_H_ 134