Big SILK update
[opus.git] / src_FIX / SKP_Silk_structs_FIX.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_FIX_H\r
29 #define SKP_SILK_STRUCTS_FIX_H\r
30 \r
31 #include "SKP_Silk_typedef.h"\r
32 #include "SKP_Silk_main.h"\r
33 #include "SKP_Silk_structs.h"\r
34 \r
35 #ifdef __cplusplus\r
36 extern "C"\r
37 {\r
38 #endif\r
39 \r
40 /********************************/\r
41 /* Noise shaping analysis state */\r
42 /********************************/\r
43 typedef struct {\r
44     SKP_int     LastGainIndex;\r
45     SKP_int32   HarmBoost_smth_Q16;\r
46     SKP_int32   HarmShapeGain_smth_Q16;\r
47     SKP_int32   Tilt_smth_Q16;\r
48 } SKP_Silk_shape_state_FIX;\r
49 \r
50 /********************************/\r
51 /* Prefilter state              */\r
52 /********************************/\r
53 typedef struct {\r
54     SKP_int16   sLTP_shp[ LTP_BUF_LENGTH ];\r
55     SKP_int32   sAR_shp[ MAX_SHAPE_LPC_ORDER + 1 ];\r
56     SKP_int     sLTP_shp_buf_idx;\r
57     SKP_int32   sLF_AR_shp_Q12;\r
58     SKP_int32   sLF_MA_shp_Q12;\r
59     SKP_int     sHarmHP;\r
60     SKP_int32   rand_seed;\r
61     SKP_int     lagPrev;\r
62 } SKP_Silk_prefilter_state_FIX;\r
63 \r
64 /*****************************/\r
65 /* Prediction analysis state */\r
66 /*****************************/\r
67 typedef struct {\r
68     SKP_int   pitch_LPC_win_length;\r
69     SKP_int   min_pitch_lag;                                        /* Lowest possible pitch lag (samples)  */\r
70     SKP_int   max_pitch_lag;                                        /* Highest possible pitch lag (samples) */\r
71     SKP_int   prev_NLSFq_Q15[ MAX_LPC_ORDER ];                      /* Previously quantized NLSF vector     */\r
72 } SKP_Silk_predict_state_FIX;\r
73 \r
74 \r
75 /********************************/\r
76 /* Encoder state FIX            */\r
77 /********************************/\r
78 typedef struct {\r
79     SKP_Silk_encoder_state          sCmn;                           /* Common struct, shared with floating-point code */\r
80 \r
81 #if HIGH_PASS_INPUT\r
82     SKP_int32                       variable_HP_smth1_Q15;          /* State of first smoother                                              */\r
83     SKP_int32                       variable_HP_smth2_Q15;          /* State of second smoother                                             */\r
84 #endif\r
85     SKP_Silk_shape_state_FIX        sShape;                         /* Shape state                                                          */\r
86     SKP_Silk_prefilter_state_FIX    sPrefilt;                       /* Prefilter State                                                      */\r
87     SKP_Silk_predict_state_FIX      sPred;                          /* Prediction state                                                     */\r
88     SKP_Silk_nsq_state              sNSQ;                           /* Noise Shape Quantizer State                                          */\r
89     SKP_Silk_nsq_state              sNSQ_LBRR;                      /* Noise Shape Quantizer State ( for low bitrate redundancy )           */\r
90 \r
91     /* Buffer for find pitch and noise shape analysis */\r
92     SKP_DWORD_ALIGN SKP_int16 x_buf[ 2 * MAX_FRAME_LENGTH + LA_SHAPE_MAX ];\r
93     SKP_int                         LTPCorr_Q15;                    /* Normalized correlation from pitch lag estimator                      */\r
94     SKP_int32                       SNR_dB_Q7;                      /* Quality setting                                                      */\r
95     SKP_int                         BufferedInChannel_ms;           /* Simulated number of ms buffer because of exceeded TargetRate_bps     */\r
96     SKP_int                         speech_activity_Q8;             /* Speech activity in Q8                                                */\r
97 \r
98     /* Parameters For LTP scaling Control */\r
99     SKP_int                         prevLTPredCodGain_Q7;\r
100     SKP_int                         HPLTPredCodGain_Q7;\r
101 \r
102     SKP_int32                       inBandFEC_SNR_comp_Q8;          /* Compensation to SNR_dB when using inband FEC Voiced      */\r
103 \r
104 } SKP_Silk_encoder_state_FIX;\r
105 \r
106 /************************/\r
107 /* Encoder control FIX  */\r
108 /************************/\r
109 typedef struct {\r
110     SKP_Silk_encoder_control        sCmn;                           /* Common struct, shared with floating-point code */\r
111 \r
112     /* Prediction and coding parameters */\r
113     SKP_int32                   Gains_Q16[ MAX_NB_SUBFR ];\r
114     SKP_DWORD_ALIGN SKP_int16   PredCoef_Q12[ 2 ][ MAX_LPC_ORDER ];\r
115     SKP_int16                   LTPCoef_Q14[ LTP_ORDER * MAX_NB_SUBFR ];\r
116     SKP_int                     LTP_scale_Q14;\r
117 \r
118     /* Noise shaping parameters */\r
119     /* Testing */\r
120     SKP_DWORD_ALIGN SKP_int16 AR1_Q13[ MAX_NB_SUBFR * MAX_SHAPE_LPC_ORDER ];\r
121     SKP_DWORD_ALIGN SKP_int16 AR2_Q13[ MAX_NB_SUBFR * MAX_SHAPE_LPC_ORDER ];\r
122     SKP_int32   LF_shp_Q14[        MAX_NB_SUBFR ];          /* Packs two int16 coefficients per int32 value             */\r
123     SKP_int     GainsPre_Q14[      MAX_NB_SUBFR ];\r
124     SKP_int     HarmBoost_Q14[     MAX_NB_SUBFR ];\r
125     SKP_int     Tilt_Q14[          MAX_NB_SUBFR ];\r
126     SKP_int     HarmShapeGain_Q14[ MAX_NB_SUBFR ];\r
127     SKP_int     Lambda_Q10;\r
128     SKP_int     input_quality_Q14;\r
129     SKP_int     coding_quality_Q14;\r
130     SKP_int32   pitch_freq_low_Hz;\r
131     SKP_int     current_SNR_dB_Q7;\r
132 \r
133     /* measures */\r
134     SKP_int     sparseness_Q8;\r
135     SKP_int32   predGain_Q16;\r
136     SKP_int     LTPredCodGain_Q7;\r
137     SKP_int     input_quality_bands_Q15[ VAD_N_BANDS ];\r
138     SKP_int     input_tilt_Q15;\r
139     SKP_int32   ResNrg[ MAX_NB_SUBFR ];             /* Residual energy per subframe                             */\r
140     SKP_int     ResNrgQ[ MAX_NB_SUBFR ];            /* Q domain for the residual energy > 0                     */\r
141     \r
142 } SKP_Silk_encoder_control_FIX;\r
143 \r
144 \r
145 #ifdef __cplusplus\r
146 }\r
147 #endif\r
148 \r
149 #endif\r