1 /* 2 * Copyright (C) 2004-2010 NXP Software 3 * Copyright (C) 2010 The Android Open Source Project 4 * 5 * Licensed under the Apache License, Version 2.0 (the "License"); 6 * you may not use this file except in compliance with the License. 7 * You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 */ 17 18 #ifndef _LVPSA_PRIVATE_H_ 19 #define _LVPSA_PRIVATE_H_ 20 21 #include "LVPSA.h" 22 #include "BIQUAD.h" 23 #include "LVPSA_QPD.h" 24 #include "LVM_Macros.h" 25 26 /********************************************************************************** 27 CONSTANT DEFINITIONS 28 ***********************************************************************************/ 29 30 /* Memory */ 31 #define LVPSA_INSTANCE_ALIGN 4 /* 32-bit alignment for structures */ 32 #define LVPSA_SCRATCH_ALIGN 4 /* 32-bit alignment for long data */ 33 #define LVPSA_COEF_ALIGN 4 /* 32-bit alignment for long words */ 34 #define LVPSA_DATA_ALIGN 4 /* 32-bit alignment for long data */ 35 36 #define LVPSA_MEMREGION_INSTANCE 0 /* Offset to instance memory region in memory table */ 37 #define LVPSA_MEMREGION_PERSISTENT_COEF 1 /* Offset to persistent coefficients memory region in memory table */ 38 #define LVPSA_MEMREGION_PERSISTENT_DATA 2 /* Offset to persistent taps memory region in memory table */ 39 #define LVPSA_MEMREGION_SCRATCH 3 /* Offset to scratch memory region in memory table */ 40 #define LVPSA_NR_SUPPORTED_RATE 13 /* From 8000Hz to 192000Hz*/ 41 #define LVPSA_NR_SUPPORTED_SPEED 3 /* LOW, MEDIUM, HIGH */ 42 43 #define LVPSA_MAXBUFFERDURATION 4000 /* Maximum length in ms of the levels buffer */ 44 #define LVPSA_MAXINPUTBLOCKSIZE 5000 /* Maximum length in mono samples of the block to process */ 45 #define LVPSA_NBANDSMIN 1 /* Minimum number of frequency band */ 46 #define LVPSA_NBANDSMAX 30 /* Maximum number of frequency band */ 47 #define LVPSA_MAXCENTERFREQ 20000 /* Maximum possible center frequency */ 48 #define LVPSA_MINPOSTGAIN (-15) /* Minimum possible post gain */ 49 #define LVPSA_MAXPOSTGAIN 15 /* Maximum possible post gain */ 50 #define LVPSA_MINQFACTOR 25 /* Minimum possible Q factor */ 51 #define LVPSA_MAXQFACTOR 1200 /* Maximum possible Q factor */ 52 53 #define LVPSA_MAXLEVELDECAYFACTOR 0x4111 /* Decay factor for the maximum values calculation */ 54 #define LVPSA_MAXLEVELDECAYSHIFT 14 /* Decay shift for the maximum values calculation */ 55 56 #define LVPSA_MAXUNSIGNEDCHAR 0xFF 57 58 #define LVPSA_FsInvertShift 31 59 #define LVPSA_GAINSHIFT 11 60 #define LVPSA_FREQSHIFT 25 61 62 /********************************************************************************** 63 TYPES DEFINITIONS 64 ***********************************************************************************/ 65 66 #define LVPSA_InternalRefreshTime 0x0014 /* 20 ms (50Hz) in Q16.0 */ 67 #define LVPSA_InternalRefreshTimeInv 0x0666 /* 1/20ms left shifted by 15 */ 68 #define LVPSA_InternalRefreshTimeShift 15 69 70 /* Precision of the filter */ 71 typedef enum 72 { 73 LVPSA_SimplePrecisionFilter, /* Simple precision */ 74 LVPSA_DoublePrecisionFilter /* Double precision */ 75 } LVPSA_BPFilterPrecision_en; 76 77 typedef struct 78 { 79 LVM_CHAR bControlPending; /* Flag incating a change of the control parameters */ 80 LVM_UINT16 nBands; /* Number of bands of the spectrum analyzer */ 81 LVM_UINT16 MaxInputBlockSize; /* Maximum input data buffer size */ 82 83 LVPSA_ControlParams_t CurrentParams; /* Current control parameters of the module */ 84 LVPSA_ControlParams_t NewParams; /* New control parameters given by the user */ 85 LVPSA_MemTab_t MemoryTable; 86 87 LVPSA_BPFilterPrecision_en *pBPFiltersPrecision; /* Points a nBands elements array that contains the filter precision for each band */ 88 Biquad_FLOAT_Instance_t *pBP_Instances; 89 /* Points a nBands elements array that contains the band pass filter taps for each band */ 90 Biquad_1I_Order2_FLOAT_Taps_t *pBP_Taps; 91 /* Points a nBands elements array that contains the QPD filter instance for each band */ 92 QPD_FLOAT_State_t *pQPD_States; 93 /* Points a nBands elements array that contains the QPD filter taps for each band */ 94 QPD_FLOAT_Taps_t *pQPD_Taps; 95 96 /* Points a nBands elements array that contains the post-filter gains for each band */ 97 LVM_FLOAT *pPostGains; 98 LVPSA_FilterParam_t *pFiltersParams; /* Copy of the filters parameters from the input parameters */ 99 100 LVM_UINT16 nSamplesBufferUpdate; /* Number of samples to make 20ms */ 101 LVM_INT32 BufferUpdateSamplesCount; /* Counter used to know when to put a new value in the buffer */ 102 LVM_UINT16 nRelevantFilters; /* Number of relevent filters depending on sampling frequency and bands center frequency */ 103 LVM_UINT16 LocalSamplesCount; /* Counter used to update the SpectralDataBufferAudioTime */ 104 105 LVM_UINT16 DownSamplingFactor; /* Down sampling factor depending on the sampling frequency */ 106 LVM_UINT16 DownSamplingCount; /* Counter used for the downsampling handling */ 107 108 LVM_UINT16 SpectralDataBufferDuration; /* Length of the buffer in time (ms) defined by the application */ 109 LVM_UINT8 *pSpectralDataBufferStart; /* Starting address of the buffer */ 110 LVM_UINT8 *pSpectralDataBufferWritePointer; /* Current position of the writting pointer of the buffer */ 111 LVPSA_Time SpectralDataBufferAudioTime; /* AudioTime at which the last value save occured in the buffer */ 112 LVM_UINT32 SpectralDataBufferLength; /* Number of spectrum data value that the buffer can contain (per band) 113 = SpectralDataBufferDuration/20ms */ 114 115 LVM_UINT8 *pPreviousPeaks; /* Points to a nBands elements array that contains the previous peak value of the level 116 detection. Those values are decremented after each call to the GetSpectrum function */ 117 118 }LVPSA_InstancePr_t, *pLVPSA_InstancePr_t; 119 120 /********************************************************************************** 121 FUNCTIONS PROTOTYPE 122 ***********************************************************************************/ 123 /************************************************************************************/ 124 /* */ 125 /* FUNCTION: LVPSA_ApplyNewSettings */ 126 /* */ 127 /* DESCRIPTION: */ 128 /* Reinitialize some parameters and changes filters' coefficients if */ 129 /* some control parameters have changed. */ 130 /* */ 131 /* PARAMETERS: */ 132 /* pInst Pointer to the instance */ 133 /* */ 134 /* RETURNS: */ 135 /* LVPSA_OK Always succeeds */ 136 /* */ 137 /************************************************************************************/ 138 LVPSA_RETURN LVPSA_ApplyNewSettings (LVPSA_InstancePr_t *pInst); 139 140 #endif /* _LVPSA_PRIVATE_H */ 141