SILK update
[opus.git] / src_FLP / SKP_Silk_structs_FLP.h
1 /***********************************************************************\r
2 Copyright (c) 2006-2010, Skype Limited. All rights reserved. \r
3 Redistribution and use in source and binary forms, with or without \r
4 modification, (subject to the limitations in the disclaimer below) \r
5 are permitted provided that the following conditions are met:\r
6 - Redistributions of source code must retain the above copyright notice,\r
7 this list of conditions and the following disclaimer.\r
8 - Redistributions in binary form must reproduce the above copyright \r
9 notice, this list of conditions and the following disclaimer in the \r
10 documentation and/or other materials provided with the distribution.\r
11 - Neither the name of Skype Limited, nor the names of specific \r
12 contributors, may be used to endorse or promote products derived from \r
13 this software without specific prior written permission.\r
14 NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED \r
15 BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND \r
16 CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,\r
17 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND \r
18 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE \r
19 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, \r
20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT\r
21 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF \r
22 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON \r
23 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT \r
24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE \r
25 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
26 ***********************************************************************/\r
27 \r
28 #ifndef SKP_SILK_STRUCTS_FLP_H\r
29 #define SKP_SILK_STRUCTS_FLP_H\r
30 \r
31 #include "SKP_Silk_typedef.h"\r
32 #include "SKP_Silk_main.h"\r
33 \r
34 #ifdef __cplusplus\r
35 extern "C"\r
36 {\r
37 #endif\r
38 \r
39 /********************************/\r
40 /* Noise shaping analysis state */\r
41 /********************************/\r
42 typedef struct {\r
43     SKP_int     LastGainIndex;\r
44     SKP_float   HarmBoost_smth;\r
45     SKP_float   HarmShapeGain_smth;\r
46     SKP_float   Tilt_smth;\r
47 } SKP_Silk_shape_state_FLP;\r
48 \r
49 /********************************/\r
50 /* Prefilter state              */\r
51 /********************************/\r
52 typedef struct {\r
53     SKP_float   sLTP_shp[ LTP_BUF_LENGTH ];\r
54     SKP_float   sAR_shp[ MAX_SHAPE_LPC_ORDER + 1 ];\r
55     SKP_int     sLTP_shp_buf_idx;\r
56     SKP_float   sLF_AR_shp;\r
57     SKP_float   sLF_MA_shp;\r
58     SKP_float   sHarmHP;\r
59     SKP_int32   rand_seed;\r
60     SKP_int     lagPrev;\r
61 } SKP_Silk_prefilter_state_FLP;\r
62 \r
63 /*****************************/\r
64 /* Prediction analysis state */\r
65 /*****************************/\r
66 typedef struct {\r
67     SKP_int     pitch_LPC_win_length;\r
68     SKP_int     min_pitch_lag;                      /* Lowest possible pitch lag (samples)  */\r
69     SKP_int     max_pitch_lag;                      /* Highest possible pitch lag (samples) */\r
70     SKP_float   prev_NLSFq[ MAX_LPC_ORDER ];        /* Previously quantized NLSF vector     */\r
71 } SKP_Silk_predict_state_FLP;\r
72 \r
73 /*******************************************/\r
74 /* Structure containing NLSF MSVQ codebook */\r
75 /*******************************************/\r
76 /* structure for one stage of MSVQ */\r
77 typedef struct {\r
78     const SKP_int32     nVectors;\r
79     const SKP_float     *CB;\r
80     const SKP_float     *Rates;\r
81 } SKP_Silk_NLSF_CBS_FLP;\r
82 \r
83 typedef struct {\r
84     const SKP_int32                         nStages;\r
85 \r
86     /* fields for (de)quantizing */\r
87     const SKP_Silk_NLSF_CBS_FLP *CBStages;\r
88     const SKP_float                         *NDeltaMin;\r
89 \r
90     /* fields for arithmetic (de)coding */\r
91     const SKP_uint16                        *CDF;\r
92     const SKP_uint16 * const                *StartPtr;\r
93     const SKP_int                           *MiddleIx;\r
94 } SKP_Silk_NLSF_CB_FLP;\r
95 \r
96 /********************************/\r
97 /* Encoder state FLP            */\r
98 /********************************/\r
99 typedef struct {\r
100     SKP_Silk_encoder_state              sCmn;                       /* Common struct, shared with fixed-point code */\r
101 \r
102     SKP_float                           variable_HP_smth1;          /* State of first smoother */\r
103     SKP_float                           variable_HP_smth2;          /* State of second smoother */\r
104 \r
105     SKP_Silk_shape_state_FLP            sShape;                     /* Noise shaping state */\r
106     SKP_Silk_prefilter_state_FLP        sPrefilt;                   /* Prefilter State */\r
107     SKP_Silk_predict_state_FLP          sPred;                      /* Prediction State */\r
108     SKP_Silk_nsq_state                  sNSQ;                       /* Noise Shape Quantizer State */\r
109     SKP_Silk_nsq_state                  sNSQ_LBRR;                  /* Noise Shape Quantizer State ( for low bitrate redundancy )*/\r
110 \r
111     /* Buffer for find pitch and noise shape analysis */\r
112     SKP_float                           x_buf[ 2 * MAX_FRAME_LENGTH + LA_SHAPE_MAX ];/* Buffer for find pitch and noise shape analysis */\r
113     SKP_float                           LTPCorr;                    /* Normalized correlation from pitch lag estimator */\r
114     SKP_float                           mu_LTP;                     /* Rate-distortion tradeoff in LTP quantization */\r
115     SKP_float                           SNR_dB;                     /* Quality setting */\r
116     SKP_float                           avgGain;                    /* average gain during active speech */\r
117     SKP_float                           BufferedInChannel_ms;       /* Simulated number of ms buffer in channel because of exceeded TargetRate_bps */\r
118     SKP_float                           speech_activity;            /* Speech activity */\r
119 \r
120     /* Parameters for LTP scaling control */\r
121     SKP_float                           prevLTPredCodGain;\r
122     SKP_float                           HPLTPredCodGain;\r
123 \r
124     SKP_float                           inBandFEC_SNR_comp;         /* Compensation to SNR_DB when using inband FEC Voiced */\r
125 \r
126     const SKP_Silk_NLSF_CB_FLP  *psNLSF_CB_FLP[ 2 ];        /* Pointers to voiced/unvoiced NLSF codebooks */\r
127 } SKP_Silk_encoder_state_FLP;\r
128 \r
129 \r
130 /************************/\r
131 /* Encoder control FLP  */\r
132 /************************/\r
133 typedef struct {\r
134     SKP_Silk_encoder_control    sCmn;                               /* Common struct, shared with fixed-point code */\r
135 \r
136     /* Prediction and coding parameters */\r
137         SKP_float                                       Gains[MAX_NB_SUBFR];\r
138         SKP_float                                       PredCoef[ 2 ][ MAX_LPC_ORDER ];         /* holds interpolated and final coefficients */\r
139         SKP_float                                       LTPCoef[LTP_ORDER * MAX_NB_SUBFR];\r
140         SKP_float                                       LTP_scale;\r
141 \r
142     /* Noise shaping parameters */\r
143         SKP_float                                       AR1[ MAX_NB_SUBFR * MAX_SHAPE_LPC_ORDER ];\r
144         SKP_float                                       AR2[ MAX_NB_SUBFR * MAX_SHAPE_LPC_ORDER ];\r
145         SKP_float                                       LF_MA_shp[     MAX_NB_SUBFR ];\r
146         SKP_float                                       LF_AR_shp[     MAX_NB_SUBFR ];\r
147         SKP_float                                       GainsPre[      MAX_NB_SUBFR ];\r
148         SKP_float                                       HarmBoost[     MAX_NB_SUBFR ];\r
149         SKP_float                                       Tilt[          MAX_NB_SUBFR ];\r
150         SKP_float                                       HarmShapeGain[ MAX_NB_SUBFR ];\r
151         SKP_float                                       Lambda;\r
152         SKP_float                                       input_quality;\r
153         SKP_float                                       coding_quality;\r
154         SKP_float                                       pitch_freq_low_Hz;\r
155         SKP_float                                       current_SNR_dB;\r
156 \r
157         /* Measures */\r
158         SKP_float                                       sparseness;\r
159     SKP_float                   predGain;\r
160         SKP_float                                       LTPredCodGain;\r
161         SKP_float                                       input_quality_bands[ VAD_N_BANDS ];\r
162         SKP_float                                       input_tilt;\r
163         SKP_float                                       ResNrg[ MAX_NB_SUBFR ];                                 /* Residual energy per subframe */\r
164 } SKP_Silk_encoder_control_FLP;\r
165 \r
166 #ifdef __cplusplus\r
167 }\r
168 #endif\r
169 \r
170 #endif\r