382443e2eeba5298985b98bbf369dfdd18bc38f6
[opus.git] / src_FIX / SKP_Silk_main_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_MAIN_FIX_H\r
29 #define SKP_SILK_MAIN_FIX_H\r
30 \r
31 #include "SKP_Silk_SigProc_FIX.h"\r
32 #include "SKP_Silk_structs_FIX.h"\r
33 #include "SKP_Silk_main.h"\r
34 #include "SKP_Silk_PLC.h"\r
35 #include "SKP_debug.h"\r
36 #include "entenc.h"\r
37 \r
38 #ifndef FORCE_CPP_BUILD\r
39 #ifdef __cplusplus\r
40 extern "C"\r
41 {\r
42 #endif\r
43 #endif\r
44 \r
45 /*********************/\r
46 /* Encoder Functions */\r
47 /*********************/\r
48 \r
49 /* High-pass filter with cutoff frequency adaptation based on pitch lag statistics */\r
50 void SKP_Silk_HP_variable_cutoff_FIX(\r
51     SKP_Silk_encoder_state_FIX      *psEnc,         /* I/O  Encoder state                               */\r
52     SKP_Silk_encoder_control_FIX    *psEncCtrl,     /* I/O  Encoder control                             */\r
53     SKP_int16                       *out,           /* O    high-pass filtered output signal            */\r
54     const SKP_int16                 *in             /* I    input signal                                */\r
55 );\r
56 \r
57 /* Encoder main function */\r
58 SKP_int SKP_Silk_encode_frame_FIX( \r
59     SKP_Silk_encoder_state_FIX      *psEnc,             /* I/O  Pointer to Silk FIX encoder state       */\r
60     SKP_int32                       *pnBytesOut,        /* I/O  Pointer to number of payload bytes;     */\r
61                                                         /*      input: max length; output: used         */\r
62     ec_enc                          *psRangeEnc,        /* I/O  compressor data structure               */\r
63     const SKP_int16                 *pIn                /* I    Pointer to input speech frame           */\r
64 );\r
65 \r
66 /* Low Bitrate Redundancy (LBRR) encoding. Reuse all parameters but encode with lower bitrate           */\r
67 void SKP_Silk_LBRR_encode_FIX(\r
68     SKP_Silk_encoder_state_FIX      *psEnc,         /* I/O  Pointer to Silk FIX encoder state           */\r
69     SKP_Silk_encoder_control_FIX    *psEncCtrl,     /* I/O  Pointer to Silk FIX encoder control struct  */\r
70     SKP_uint8                       *pCode,         /* O    Pointer to payload                          */\r
71     SKP_int32                       *pnBytesOut,    /* I/O  Pointer to number of payload bytes          */\r
72     SKP_int16                       xfw[]           /* I    Input signal                                */\r
73 );\r
74 \r
75 /* Initializes the Silk encoder state */\r
76 SKP_int SKP_Silk_init_encoder_FIX(\r
77     SKP_Silk_encoder_state_FIX  *psEnc              /* I/O  Pointer to Silk FIX encoder state           */\r
78 );\r
79 \r
80 /* Control the Silk encoder */\r
81 SKP_int SKP_Silk_control_encoder_FIX( \r
82     SKP_Silk_encoder_state_FIX  *psEnc,                 /* I/O  Pointer to Silk encoder state           */\r
83     const SKP_int               PacketSize_ms,          /* I    Packet length (ms)                      */\r
84     const SKP_int32             TargetRate_bps,         /* I    Target max bitrate (bps)                */\r
85     const SKP_int               PacketLoss_perc,        /* I    Packet loss rate (in percent)           */\r
86     const SKP_int               Complexity              /* I    Complexity (0-10)                       */\r
87 );\r
88 \r
89 /****************/\r
90 /* Prefiltering */\r
91 /****************/\r
92 void SKP_Silk_prefilter_FIX(\r
93     SKP_Silk_encoder_state_FIX          *psEnc,         /* I/O  Encoder state                               */\r
94     const SKP_Silk_encoder_control_FIX  *psEncCtrl,     /* I    Encoder control                             */\r
95     SKP_int16                           xw[],           /* O    Weighted signal                             */\r
96     const SKP_int16                     x[]             /* I    Speech signal                               */\r
97 );\r
98 \r
99 /**************************/\r
100 /* Noise shaping analysis */\r
101 /**************************/\r
102 /* Compute noise shaping coefficients and initial gain values */\r
103 void SKP_Silk_noise_shape_analysis_FIX(\r
104     SKP_Silk_encoder_state_FIX      *psEnc,         /* I/O  Encoder state FIX                           */\r
105     SKP_Silk_encoder_control_FIX    *psEncCtrl,     /* I/O  Encoder control FIX                         */\r
106     const SKP_int16                 *pitch_res,     /* I    LPC residual from pitch analysis            */\r
107     const SKP_int16                 *x              /* I    Input signal [ frame_length + la_shape ]    */\r
108 );\r
109 \r
110 /* Autocorrelations for a warped frequency axis */\r
111 void SKP_Silk_warped_autocorrelation_FIX(\r
112           SKP_int32                 *corr,              /* O    Result [order + 1]                      */\r
113           SKP_int                   *scale,             /* O    Scaling of the correlation vector       */\r
114     const SKP_int16                 *input,             /* I    Input data to correlate                 */\r
115     const SKP_int                   warping_Q16,        /* I    Warping coefficient                     */\r
116     const SKP_int                   length,             /* I    Length of input                         */\r
117     const SKP_int                   order               /* I    Correlation order (even)                */\r
118 );\r
119 \r
120 /* Calculation of LTP state scaling */\r
121 void SKP_Silk_LTP_scale_ctrl_FIX(\r
122     SKP_Silk_encoder_state_FIX      *psEnc,         /* I/O  encoder state                               */\r
123     SKP_Silk_encoder_control_FIX    *psEncCtrl      /* I/O  encoder control                             */\r
124 );\r
125 \r
126 /**********************************************/\r
127 /* Prediction Analysis                        */\r
128 /**********************************************/\r
129 /* Find pitch lags */\r
130 void SKP_Silk_find_pitch_lags_FIX(\r
131     SKP_Silk_encoder_state_FIX      *psEnc,         /* I/O  encoder state                               */\r
132     SKP_Silk_encoder_control_FIX    *psEncCtrl,     /* I/O  encoder control                             */\r
133     SKP_int16                       res[],          /* O    residual                                    */\r
134     const SKP_int16                 x[]             /* I    Speech signal                               */\r
135 );\r
136 \r
137 /* Find LPC and LTP coefficients */\r
138 void SKP_Silk_find_pred_coefs_FIX(\r
139     SKP_Silk_encoder_state_FIX      *psEnc,         /* I/O  encoder state                               */\r
140     SKP_Silk_encoder_control_FIX    *psEncCtrl,     /* I/O  encoder control                             */\r
141     const SKP_int16                 res_pitch[],    /* I    Residual from pitch analysis                */\r
142     const SKP_int16                 x[]             /* I    Speech signal                               */\r
143 );\r
144 \r
145 /* LPC analysis */\r
146 void SKP_Silk_find_LPC_FIX(\r
147     SKP_int             NLSF_Q15[],                 /* O    NLSFs                                                                       */\r
148     SKP_int             *interpIndex,               /* O    NLSF interpolation index, only used for NLSF interpolation                  */\r
149     const SKP_int       prev_NLSFq_Q15[],           /* I    previous NLSFs, only used for NLSF interpolation                            */\r
150     const SKP_int       useInterpolatedNLSFs,       /* I    Flag                                                                        */\r
151     const SKP_int       LPC_order,                  /* I    LPC order                                                                   */\r
152     const SKP_int16     x[],                        /* I    Input signal                                                                */\r
153     const SKP_int       subfr_length,               /* I    Input signal subframe length including preceeding samples                   */\r
154     const SKP_int       nb_subfr                    /* I:   Number of subframes                                                         */\r
155 );\r
156 \r
157 /* LTP analysis */\r
158 void SKP_Silk_find_LTP_FIX(\r
159     SKP_int16           b_Q14[ MAX_NB_SUBFR * LTP_ORDER ],              /* O    LTP coefs                                                   */\r
160     SKP_int32           WLTP[ MAX_NB_SUBFR * LTP_ORDER * LTP_ORDER ],   /* O    Weight for LTP quantization                                 */\r
161     SKP_int             *LTPredCodGain_Q7,                              /* O    LTP coding gain                                             */\r
162     const SKP_int16     r_lpc[],                                        /* I    residual signal after LPC signal + state for first 10 ms    */\r
163     const SKP_int       lag[ MAX_NB_SUBFR ],                            /* I    LTP lags                                                    */\r
164     const SKP_int32     Wght_Q15[ MAX_NB_SUBFR ],                       /* I    weights                                                     */\r
165     const SKP_int       subfr_length,                                   /* I    subframe length                                             */\r
166     const SKP_int       nb_subfr,                                       /* I    number of subframes                                         */\r
167     const SKP_int       mem_offset,                                     /* I    number of samples in LTP memory                             */\r
168     SKP_int             corr_rshifts[ MAX_NB_SUBFR ]                    /* O    right shifts applied to correlations                        */\r
169 );\r
170 \r
171 void SKP_Silk_LTP_analysis_filter_FIX(\r
172     SKP_int16           *LTP_res,                               /* O:   LTP residual signal of length MAX_NB_SUBFR * ( pre_length + subfr_length )  */\r
173     const SKP_int16     *x,                                     /* I:   Pointer to input signal with at least max( pitchL ) preceeding samples      */\r
174     const SKP_int16     LTPCoef_Q14[ LTP_ORDER * MAX_NB_SUBFR ],/* I:   LTP_ORDER LTP coefficients for each MAX_NB_SUBFR subframe                   */\r
175     const SKP_int       pitchL[ MAX_NB_SUBFR ],                 /* I:   Pitch lag, one for each subframe                                            */\r
176     const SKP_int32     invGains_Q16[ MAX_NB_SUBFR ],           /* I:   Inverse quantization gains, one for each subframe                           */\r
177     const SKP_int       subfr_length,                           /* I:   Length of each subframe                                                     */\r
178     const SKP_int       nb_subfr,                               /* I:   Number of subframes                                                         */\r
179     const SKP_int       pre_length                              /* I:   Length of the preceeding samples starting at &x[0] for each subframe        */\r
180 );\r
181 \r
182 /* Calculates residual energies of input subframes where all subframes have LPC_order   */\r
183 /* of preceeding samples                                                                */\r
184 void SKP_Silk_residual_energy_FIX(\r
185           SKP_int32 nrgs[ MAX_NB_SUBFR ],           /* O    Residual energy per subframe    */\r
186           SKP_int   nrgsQ[ MAX_NB_SUBFR ],          /* O    Q value per subframe            */\r
187     const SKP_int16 x[],                            /* I    Input signal                    */\r
188     const SKP_int16 a_Q12[ 2 ][ MAX_LPC_ORDER ],    /* I    AR coefs for each frame half    */\r
189     const SKP_int32 gains[ MAX_NB_SUBFR ],          /* I    Quantization gains              */\r
190     const SKP_int   subfr_length,                   /* I    Subframe length                 */\r
191     const SKP_int   nb_subfr,                       /* I    Number of subframes             */\r
192     const SKP_int   LPC_order                       /* I    LPC order                       */\r
193 );\r
194 \r
195 /******************/\r
196 /* NLSF Quantizer */\r
197 /******************/\r
198 /* Limit, stabilize, convert and quantize NLSFs.    */ \r
199 void SKP_Silk_process_NLSFs_FIX(\r
200     SKP_Silk_encoder_state_FIX      *psEnc,     /* I/O  encoder state                               */\r
201     SKP_Silk_encoder_control_FIX    *psEncCtrl, /* I/O  encoder control                             */\r
202     SKP_int                         *pNLSF_Q15  /* I/O  Normalized LSFs (quant out) (0 - (2^15-1))  */\r
203 );\r
204 \r
205 /* NLSF vector encoder */\r
206 void SKP_Silk_NLSF_MSVQ_encode_FIX(\r
207           SKP_int                   *NLSFIndices,           /* O    Codebook path vector [ CB_STAGES ]      */\r
208           SKP_int                   *pNLSF_Q15,             /* I/O  Quantized NLSF vector [ LPC_ORDER ]     */\r
209     const SKP_Silk_NLSF_CB_struct   *psNLSF_CB,             /* I    Codebook object                         */\r
210     const SKP_int                   *pNLSF_q_Q15_prev,      /* I    Prev. quantized NLSF vector [LPC_ORDER] */\r
211     const SKP_int                   *pW_Q6,                 /* I    NLSF weight vector [ LPC_ORDER ]        */\r
212     const SKP_int                   NLSF_mu_Q15,            /* I    Rate weight for the RD optimization     */\r
213     const SKP_int                   NLSF_mu_fluc_red_Q16,   /* I    Fluctuation reduction error weight      */\r
214     const SKP_int                   NLSF_MSVQ_Survivors,    /* I    Max survivors from each stage           */\r
215     const SKP_int                   LPC_order,              /* I    LPC order                               */\r
216     const SKP_int                   deactivate_fluc_red     /* I    Deactivate fluctuation reduction        */\r
217 );\r
218 \r
219 /* Rate-Distortion calculations for multiple input data vectors */\r
220 void SKP_Silk_NLSF_VQ_rate_distortion_FIX(\r
221     SKP_int32                       *pRD_Q20,           /* O    Rate-distortion values [psNLSF_CBS->nVectors*N] */\r
222     const SKP_Silk_NLSF_CBS         *psNLSF_CBS,        /* I    NLSF codebook stage struct                      */\r
223     const SKP_int                   *in_Q15,            /* I    Input vectors to be quantized                   */\r
224     const SKP_int                   *w_Q6,              /* I    Weight vector                                   */\r
225     const SKP_int32                 *rate_acc_Q5,       /* I    Accumulated rates from previous stage           */\r
226     const SKP_int                   mu_Q15,             /* I    Weight between weighted error and rate          */\r
227     const SKP_int                   N,                  /* I    Number of input vectors to be quantized         */\r
228     const SKP_int                   LPC_order           /* I    LPC order                                       */\r
229 );\r
230 \r
231 /* Compute weighted quantization errors for an LPC_order element input vector, over one codebook stage */\r
232 void SKP_Silk_NLSF_VQ_sum_error_FIX(\r
233     SKP_int32                       *err_Q20,           /* O    Weighted quantization errors  [N*K]         */\r
234     const SKP_int                   *in_Q15,            /* I    Input vectors to be quantized [N*LPC_order] */\r
235     const SKP_int                   *w_Q6,              /* I    Weighting vectors             [N*LPC_order] */\r
236     const SKP_int8                  *pCB_Q9,            /* I    Codebook vectors              [K*LPC_order] */\r
237     const SKP_int                   N,                  /* I    Number of input vectors                     */\r
238     const SKP_int                   K,                  /* I    Number of codebook vectors                  */\r
239     const SKP_int                   LPC_order           /* I    Number of LPCs                              */\r
240 );\r
241 \r
242 /* Residual energy: nrg = wxx - 2 * wXx * c + c' * wXX * c */\r
243 SKP_int32 SKP_Silk_residual_energy16_covar_FIX(\r
244     const SKP_int16                 *c,                 /* I    Prediction vector                           */\r
245     const SKP_int32                 *wXX,               /* I    Correlation matrix                          */\r
246     const SKP_int32                 *wXx,               /* I    Correlation vector                          */\r
247     SKP_int32                       wxx,                /* I    Signal energy                               */\r
248     SKP_int                         D,                  /* I    Dimension                                   */\r
249     SKP_int                         cQ                  /* I    Q value for c vector 0 - 15                 */\r
250 );\r
251 \r
252 /* Processing of gains */\r
253 void SKP_Silk_process_gains_FIX(\r
254     SKP_Silk_encoder_state_FIX      *psEnc,         /* I/O  Encoder state                               */\r
255     SKP_Silk_encoder_control_FIX    *psEncCtrl      /* I/O  Encoder control                             */\r
256 );\r
257 \r
258 /******************/\r
259 /* Linear Algebra */\r
260 /******************/\r
261 /* Calculates correlation matrix X'*X */\r
262 void SKP_Silk_corrMatrix_FIX(\r
263     const SKP_int16                 *x,         /* I    x vector [L + order - 1] used to form data matrix X */\r
264     const SKP_int                   L,          /* I    Length of vectors                                   */\r
265     const SKP_int                   order,      /* I    Max lag for correlation                             */\r
266     const SKP_int                   head_room,  /* I    Desired headroom                                    */\r
267     SKP_int32                       *XX,        /* O    Pointer to X'*X correlation matrix [ order x order ]*/\r
268     SKP_int                         *rshifts    /* I/O  Right shifts of correlations                        */\r
269 );\r
270 \r
271 /* Calculates correlation vector X'*t */\r
272 void SKP_Silk_corrVector_FIX(\r
273     const SKP_int16                 *x,         /* I    x vector [L + order - 1] used to form data matrix X */\r
274     const SKP_int16                 *t,         /* I    Target vector [L]                                   */\r
275     const SKP_int                   L,          /* I    Length of vectors                                   */\r
276     const SKP_int                   order,      /* I    Max lag for correlation                             */\r
277     SKP_int32                       *Xt,        /* O    Pointer to X'*t correlation vector [order]          */\r
278     const SKP_int                   rshifts     /* I    Right shifts of correlations                        */\r
279 );\r
280 \r
281 /* Add noise to matrix diagonal */\r
282 void SKP_Silk_regularize_correlations_FIX(\r
283     SKP_int32                       *XX,                /* I/O  Correlation matrices                        */\r
284     SKP_int32                       *xx,                /* I/O  Correlation values                          */\r
285     SKP_int32                       noise,              /* I    Noise to add                                */\r
286     SKP_int                         D                   /* I    Dimension of XX                             */\r
287 );\r
288 \r
289 /* Solves Ax = b, assuming A is symmetric */\r
290 void SKP_Silk_solve_LDL_FIX(\r
291     SKP_int32                       *A,                 /* I    Pointer to symetric square matrix A         */\r
292     SKP_int                         M,                  /* I    Size of matrix                              */\r
293     const SKP_int32                 *b,                 /* I    Pointer to b vector                         */\r
294     SKP_int32                       *x_Q16              /* O    Pointer to x solution vector                */\r
295 );\r
296 \r
297 #ifndef FORCE_CPP_BUILD\r
298 #ifdef __cplusplus\r
299 }\r
300 #endif /* __cplusplus */\r
301 #endif /* FORCE_CPP_BUILD */\r
302 #endif /* SKP_SILK_MAIN_FIX_H */\r