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