SILK update
[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->low; 1->medium; 2->high) */\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 /* Control low bitrate redundancy usage */\r
121 void SKP_Silk_LBRR_ctrl_FIX(\r
122     SKP_Silk_encoder_state_FIX      *psEnc,         /* I/O  encoder state                               */\r
123     SKP_Silk_encoder_control        *psEncCtrlC     /* I/O  encoder control                             */\r
124 );\r
125 \r
126 /* Calculation of LTP state scaling */\r
127 void SKP_Silk_LTP_scale_ctrl_FIX(\r
128     SKP_Silk_encoder_state_FIX      *psEnc,         /* I/O  encoder state                               */\r
129     SKP_Silk_encoder_control_FIX    *psEncCtrl      /* I/O  encoder control                             */\r
130 );\r
131 \r
132 /**********************************************/\r
133 /* Prediction Analysis                        */\r
134 /**********************************************/\r
135 /* Find pitch lags */\r
136 void SKP_Silk_find_pitch_lags_FIX(\r
137     SKP_Silk_encoder_state_FIX      *psEnc,         /* I/O  encoder state                               */\r
138     SKP_Silk_encoder_control_FIX    *psEncCtrl,     /* I/O  encoder control                             */\r
139     SKP_int16                       res[],          /* O    residual                                    */\r
140     const SKP_int16                 x[]             /* I    Speech signal                               */\r
141 );\r
142 \r
143 /* Find LPC and LTP coefficients */\r
144 void SKP_Silk_find_pred_coefs_FIX(\r
145     SKP_Silk_encoder_state_FIX      *psEnc,         /* I/O  encoder state                               */\r
146     SKP_Silk_encoder_control_FIX    *psEncCtrl,     /* I/O  encoder control                             */\r
147     const SKP_int16                 res_pitch[]     /* I    Residual from pitch analysis                */\r
148 );\r
149 \r
150 /* LPC analysis */\r
151 void SKP_Silk_find_LPC_FIX(\r
152     SKP_int             NLSF_Q15[],                 /* O    NLSFs                                                                       */\r
153     SKP_int             *interpIndex,               /* O    NLSF interpolation index, only used for NLSF interpolation                  */\r
154     const SKP_int       prev_NLSFq_Q15[],           /* I    previous NLSFs, only used for NLSF interpolation                            */\r
155     const SKP_int       useInterpolatedNLSFs,       /* I    Flag                                                                        */\r
156     const SKP_int       LPC_order,                  /* I    LPC order                                                                   */\r
157     const SKP_int16     x[],                        /* I    Input signal                                                                */\r
158     const SKP_int       subfr_length,               /* I    Input signal subframe length including preceeding samples                   */\r
159     const SKP_int       nb_subfr                    /* I:   Number of subframes                                                         */\r
160 );\r
161 \r
162 /* LTP analysis */\r
163 void SKP_Silk_find_LTP_FIX(\r
164     SKP_int16           b_Q14[ MAX_NB_SUBFR * LTP_ORDER ],              /* O    LTP coefs                                                   */\r
165     SKP_int32           WLTP[ MAX_NB_SUBFR * LTP_ORDER * LTP_ORDER ],   /* O    Weight for LTP quantization                                 */\r
166     SKP_int             *LTPredCodGain_Q7,                              /* O    LTP coding gain                                             */\r
167     const SKP_int16     r_lpc[],                                        /* I    residual signal after LPC signal + state for first 10 ms    */\r
168     const SKP_int       lag[ MAX_NB_SUBFR ],                            /* I    LTP lags                                                    */\r
169     const SKP_int32     Wght_Q15[ MAX_NB_SUBFR ],                       /* I    weights                                                     */\r
170     const SKP_int       subfr_length,                                   /* I    subframe length                                             */\r
171     const SKP_int       nb_subfr,                                       /* I    number of subframes                                         */\r
172     const SKP_int       mem_offset,                                     /* I    number of samples in LTP memory                             */\r
173     SKP_int             corr_rshifts[ MAX_NB_SUBFR ]                    /* O    right shifts applied to correlations                        */\r
174 );\r
175 \r
176 void SKP_Silk_LTP_analysis_filter_FIX(\r
177     SKP_int16           *LTP_res,                               /* O:   LTP residual signal of length MAX_NB_SUBFR * ( pre_length + subfr_length )  */\r
178     const SKP_int16     *x,                                     /* I:   Pointer to input signal with at least max( pitchL ) preceeding samples      */\r
179     const SKP_int16     LTPCoef_Q14[ LTP_ORDER * MAX_NB_SUBFR ],/* I:   LTP_ORDER LTP coefficients for each MAX_NB_SUBFR subframe                   */\r
180     const SKP_int       pitchL[ MAX_NB_SUBFR ],                 /* I:   Pitch lag, one for each subframe                                            */\r
181     const SKP_int32     invGains_Q16[ MAX_NB_SUBFR ],           /* I:   Inverse quantization gains, one for each subframe                           */\r
182     const SKP_int       subfr_length,                           /* I:   Length of each subframe                                                     */\r
183     const SKP_int       nb_subfr,                               /* I:   Number of subframes                                                         */\r
184     const SKP_int       pre_length                              /* I:   Length of the preceeding samples starting at &x[0] for each subframe        */\r
185 );\r
186 \r
187 /* Calculates residual energies of input subframes where all subframes have LPC_order   */\r
188 /* of preceeding samples                                                                */\r
189 void SKP_Silk_residual_energy_FIX(\r
190           SKP_int32 nrgs[ MAX_NB_SUBFR ],           /* O    Residual energy per subframe    */\r
191           SKP_int   nrgsQ[ MAX_NB_SUBFR ],          /* O    Q value per subframe            */\r
192     const SKP_int16 x[],                            /* I    Input signal                    */\r
193     const SKP_int16 a_Q12[ 2 ][ MAX_LPC_ORDER ],    /* I    AR coefs for each frame half    */\r
194     const SKP_int32 gains[ MAX_NB_SUBFR ],          /* I    Quantization gains              */\r
195     const SKP_int   subfr_length,                   /* I    Subframe length                 */\r
196     const SKP_int   nb_subfr,                       /* I    Number of subframes             */\r
197     const SKP_int   LPC_order                       /* I    LPC order                       */\r
198 );\r
199 \r
200 /* LTP tap quantizer */\r
201 void SKP_Silk_quant_LTP_gains_FIX(\r
202     SKP_int16           B_Q14[],                /* I/O  (un)quantized LTP gains     */\r
203     SKP_int             cbk_index[],            /* O    Codebook Index              */\r
204     SKP_int             *periodicity_index,     /* O    Periodicity Index           */\r
205     const SKP_int32     W_Q18[],                /* I    Error Weights in Q18        */\r
206     SKP_int             mu_Q8,                  /* I    Mu value (R/D tradeoff)     */\r
207     SKP_int             lowComplexity,          /* I    Flag for low complexity     */\r
208     const SKP_int       nb_subfr                /* I    number of subframes         */\r
209 );\r
210 \r
211 /******************/\r
212 /* NLSF Quantizer */\r
213 /******************/\r
214 /* Limit, stabilize, convert and quantize NLSFs.    */ \r
215 void SKP_Silk_process_NLSFs_FIX(\r
216     SKP_Silk_encoder_state_FIX      *psEnc,     /* I/O  encoder state                               */\r
217     SKP_Silk_encoder_control_FIX    *psEncCtrl, /* I/O  encoder control                             */\r
218     SKP_int                         *pNLSF_Q15  /* I/O  Normalized LSFs (quant out) (0 - (2^15-1))  */\r
219 );\r
220 \r
221 /* NLSF vector encoder */\r
222 void SKP_Silk_NLSF_MSVQ_encode_FIX(\r
223           SKP_int                   *NLSFIndices,           /* O    Codebook path vector [ CB_STAGES ]      */\r
224           SKP_int                   *pNLSF_Q15,             /* I/O  Quantized NLSF vector [ LPC_ORDER ]     */\r
225     const SKP_Silk_NLSF_CB_struct   *psNLSF_CB,             /* I    Codebook object                         */\r
226     const SKP_int                   *pNLSF_q_Q15_prev,      /* I    Prev. quantized NLSF vector [LPC_ORDER] */\r
227     const SKP_int                   *pW_Q6,                 /* I    NLSF weight vector [ LPC_ORDER ]        */\r
228     const SKP_int                   NLSF_mu_Q15,            /* I    Rate weight for the RD optimization     */\r
229     const SKP_int                   NLSF_mu_fluc_red_Q16,   /* I    Fluctuation reduction error weight      */\r
230     const SKP_int                   NLSF_MSVQ_Survivors,    /* I    Max survivors from each stage           */\r
231     const SKP_int                   LPC_order,              /* I    LPC order                               */\r
232     const SKP_int                   deactivate_fluc_red     /* I    Deactivate fluctuation reduction        */\r
233 );\r
234 \r
235 /* Rate-Distortion calculations for multiple input data vectors */\r
236 void SKP_Silk_NLSF_VQ_rate_distortion_FIX(\r
237     SKP_int32                       *pRD_Q20,           /* O    Rate-distortion values [psNLSF_CBS->nVectors*N] */\r
238     const SKP_Silk_NLSF_CBS         *psNLSF_CBS,        /* I    NLSF codebook stage struct                      */\r
239     const SKP_int                   *in_Q15,            /* I    Input vectors to be quantized                   */\r
240     const SKP_int                   *w_Q6,              /* I    Weight vector                                   */\r
241     const SKP_int32                 *rate_acc_Q5,       /* I    Accumulated rates from previous stage           */\r
242     const SKP_int                   mu_Q15,             /* I    Weight between weighted error and rate          */\r
243     const SKP_int                   N,                  /* I    Number of input vectors to be quantized         */\r
244     const SKP_int                   LPC_order           /* I    LPC order                                       */\r
245 );\r
246 \r
247 /* Compute weighted quantization errors for an LPC_order element input vector, over one codebook stage */\r
248 void SKP_Silk_NLSF_VQ_sum_error_FIX(\r
249     SKP_int32                       *err_Q20,           /* O    Weighted quantization errors  [N*K]         */\r
250     const SKP_int                   *in_Q15,            /* I    Input vectors to be quantized [N*LPC_order] */\r
251     const SKP_int                   *w_Q6,              /* I    Weighting vectors             [N*LPC_order] */\r
252     const SKP_int8                  *pCB_Q9,            /* I    Codebook vectors              [K*LPC_order] */\r
253     const SKP_int                   N,                  /* I    Number of input vectors                     */\r
254     const SKP_int                   K,                  /* I    Number of codebook vectors                  */\r
255     const SKP_int                   LPC_order           /* I    Number of LPCs                              */\r
256 );\r
257 \r
258 /* Residual energy: nrg = wxx - 2 * wXx * c + c' * wXX * c */\r
259 SKP_int32 SKP_Silk_residual_energy16_covar_FIX(\r
260     const SKP_int16                 *c,                 /* I    Prediction vector                           */\r
261     const SKP_int32                 *wXX,               /* I    Correlation matrix                          */\r
262     const SKP_int32                 *wXx,               /* I    Correlation vector                          */\r
263     SKP_int32                       wxx,                /* I    Signal energy                               */\r
264     SKP_int                         D,                  /* I    Dimension                                   */\r
265     SKP_int                         cQ                  /* I    Q value for c vector 0 - 15                 */\r
266 );\r
267 \r
268 /* Entropy constrained MATRIX-weighted VQ, for a single input data vector */\r
269 void SKP_Silk_VQ_WMat_EC_FIX(\r
270     SKP_int                         *ind,               /* O    index of best codebook vector               */\r
271     SKP_int32                       *rate_dist_Q14,     /* O    best weighted quantization error + mu * rate*/\r
272     const SKP_int16                 *in_Q14,            /* I    input vector to be quantized                */\r
273     const SKP_int32                 *W_Q18,             /* I    weighting matrix                            */\r
274     const SKP_int16                 *cb_Q14,            /* I    codebook                                    */\r
275     const SKP_int16                 *cl_Q6,             /* I    code length for each codebook vector        */\r
276     const SKP_int                   mu_Q8,              /* I    tradeoff between weighted error and rate    */\r
277     SKP_int                         L                   /* I    number of vectors in codebook               */\r
278 );\r
279 \r
280 /* Processing of gains */\r
281 void SKP_Silk_process_gains_FIX(\r
282     SKP_Silk_encoder_state_FIX      *psEnc,         /* I/O  Encoder state                               */\r
283     SKP_Silk_encoder_control_FIX    *psEncCtrl      /* I/O  Encoder control                             */\r
284 );\r
285 \r
286 /******************/\r
287 /* Linear Algebra */\r
288 /******************/\r
289 /* Calculates correlation matrix X'*X */\r
290 void SKP_Silk_corrMatrix_FIX(\r
291     const SKP_int16                 *x,         /* I    x vector [L + order - 1] used to form data matrix X */\r
292     const SKP_int                   L,          /* I    Length of vectors                                   */\r
293     const SKP_int                   order,      /* I    Max lag for correlation                             */\r
294     const SKP_int                   head_room,  /* I    Desired headroom                                    */\r
295     SKP_int32                       *XX,        /* O    Pointer to X'*X correlation matrix [ order x order ]*/\r
296     SKP_int                         *rshifts    /* I/O  Right shifts of correlations                        */\r
297 );\r
298 \r
299 /* Calculates correlation vector X'*t */\r
300 void SKP_Silk_corrVector_FIX(\r
301     const SKP_int16                 *x,         /* I    x vector [L + order - 1] used to form data matrix X */\r
302     const SKP_int16                 *t,         /* I    Target vector [L]                                   */\r
303     const SKP_int                   L,          /* I    Length of vectors                                   */\r
304     const SKP_int                   order,      /* I    Max lag for correlation                             */\r
305     SKP_int32                       *Xt,        /* O    Pointer to X'*t correlation vector [order]          */\r
306     const SKP_int                   rshifts     /* I    Right shifts of correlations                        */\r
307 );\r
308 \r
309 /* Add noise to matrix diagonal */\r
310 void SKP_Silk_regularize_correlations_FIX(\r
311     SKP_int32                       *XX,                /* I/O  Correlation matrices                        */\r
312     SKP_int32                       *xx,                /* I/O  Correlation values                          */\r
313     SKP_int32                       noise,              /* I    Noise to add                                */\r
314     SKP_int                         D                   /* I    Dimension of XX                             */\r
315 );\r
316 \r
317 /* Solves Ax = b, assuming A is symmetric */\r
318 void SKP_Silk_solve_LDL_FIX(\r
319     SKP_int32                       *A,                 /* I    Pointer to symetric square matrix A         */\r
320     SKP_int                         M,                  /* I    Size of matrix                              */\r
321     const SKP_int32                 *b,                 /* I    Pointer to b vector                         */\r
322     SKP_int32                       *x_Q16              /* O    Pointer to x solution vector                */\r
323 );\r
324 \r
325 #ifndef FORCE_CPP_BUILD\r
326 #ifdef __cplusplus\r
327 }\r
328 #endif /* __cplusplus */\r
329 #endif /* FORCE_CPP_BUILD */\r
330 #endif /* SKP_SILK_MAIN_FIX_H */\r