Optimize silk_LPC_inverse_pred_gain() for ARM NEON
[opus.git] / silk / float / main_FLP.h
1 /***********************************************************************
2 Copyright (c) 2006-2011, Skype Limited. All rights reserved.
3 Redistribution and use in source and binary forms, with or without
4 modification, are permitted provided that the following conditions
5 are met:
6 - Redistributions of source code must retain the above copyright notice,
7 this list of conditions and the following disclaimer.
8 - Redistributions in binary form must reproduce the above copyright
9 notice, this list of conditions and the following disclaimer in the
10 documentation and/or other materials provided with the distribution.
11 - Neither the name of Internet Society, IETF or IETF Trust, nor the
12 names of specific contributors, may be used to endorse or promote
13 products derived from this software without specific prior written
14 permission.
15 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
19 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25 POSSIBILITY OF SUCH DAMAGE.
26 ***********************************************************************/
27
28 #ifndef SILK_MAIN_FLP_H
29 #define SILK_MAIN_FLP_H
30
31 #include "SigProc_FLP.h"
32 #include "SigProc_FIX.h"
33 #include "structs_FLP.h"
34 #include "main.h"
35 #include "define.h"
36 #include "debug.h"
37 #include "entenc.h"
38
39 #ifdef __cplusplus
40 extern "C"
41 {
42 #endif
43
44 #define silk_encoder_state_Fxx      silk_encoder_state_FLP
45 #define silk_encode_do_VAD_Fxx      silk_encode_do_VAD_FLP
46 #define silk_encode_frame_Fxx       silk_encode_frame_FLP
47
48 /*********************/
49 /* Encoder Functions */
50 /*********************/
51
52 /* High-pass filter with cutoff frequency adaptation based on pitch lag statistics */
53 void silk_HP_variable_cutoff(
54     silk_encoder_state_Fxx          state_Fxx[]                         /* I/O  Encoder states                              */
55 );
56
57 /* Encoder main function */
58 void silk_encode_do_VAD_FLP(
59     silk_encoder_state_FLP          *psEnc                              /* I/O  Encoder state FLP                           */
60 );
61
62 /* Encoder main function */
63 opus_int silk_encode_frame_FLP(
64     silk_encoder_state_FLP          *psEnc,                             /* I/O  Encoder state FLP                           */
65     opus_int32                      *pnBytesOut,                        /* O    Number of payload bytes;                    */
66     ec_enc                          *psRangeEnc,                        /* I/O  compressor data structure                   */
67     opus_int                        condCoding,                         /* I    The type of conditional coding to use       */
68     opus_int                        maxBits,                            /* I    If > 0: maximum number of output bits       */
69     opus_int                        useCBR                              /* I    Flag to force constant-bitrate operation    */
70 );
71
72 /* Initializes the Silk encoder state */
73 opus_int silk_init_encoder(
74     silk_encoder_state_FLP          *psEnc,                             /* I/O  Encoder state FLP                           */
75     int                              arch                               /* I    Run-tim architecture                        */
76 );
77
78 /* Control the Silk encoder */
79 opus_int silk_control_encoder(
80     silk_encoder_state_FLP          *psEnc,                             /* I/O  Pointer to Silk encoder state FLP           */
81     silk_EncControlStruct           *encControl,                        /* I    Control structure                           */
82     const opus_int                  allow_bw_switch,                    /* I    Flag to allow switching audio bandwidth     */
83     const opus_int                  channelNb,                          /* I    Channel number                              */
84     const opus_int                  force_fs_kHz
85 );
86
87 /**************************/
88 /* Noise shaping analysis */
89 /**************************/
90 /* Compute noise shaping coefficients and initial gain values */
91 void silk_noise_shape_analysis_FLP(
92     silk_encoder_state_FLP          *psEnc,                             /* I/O  Encoder state FLP                           */
93     silk_encoder_control_FLP        *psEncCtrl,                         /* I/O  Encoder control FLP                         */
94     const silk_float                *pitch_res,                         /* I    LPC residual from pitch analysis            */
95     const silk_float                *x                                  /* I    Input signal [frame_length + la_shape]      */
96 );
97
98 /* Autocorrelations for a warped frequency axis */
99 void silk_warped_autocorrelation_FLP(
100     silk_float                      *corr,                              /* O    Result [order + 1]                          */
101     const silk_float                *input,                             /* I    Input data to correlate                     */
102     const silk_float                warping,                            /* I    Warping coefficient                         */
103     const opus_int                  length,                             /* I    Length of input                             */
104     const opus_int                  order                               /* I    Correlation order (even)                    */
105 );
106
107 /* Calculation of LTP state scaling */
108 void silk_LTP_scale_ctrl_FLP(
109     silk_encoder_state_FLP          *psEnc,                             /* I/O  Encoder state FLP                           */
110     silk_encoder_control_FLP        *psEncCtrl,                         /* I/O  Encoder control FLP                         */
111     opus_int                        condCoding                          /* I    The type of conditional coding to use       */
112 );
113
114 /**********************************************/
115 /* Prediction Analysis                        */
116 /**********************************************/
117 /* Find pitch lags */
118 void silk_find_pitch_lags_FLP(
119     silk_encoder_state_FLP          *psEnc,                             /* I/O  Encoder state FLP                           */
120     silk_encoder_control_FLP        *psEncCtrl,                         /* I/O  Encoder control FLP                         */
121     silk_float                      res[],                              /* O    Residual                                    */
122     const silk_float                x[],                                /* I    Speech signal                               */
123     int                             arch                                /* I    Run-time architecture                       */
124 );
125
126 /* Find LPC and LTP coefficients */
127 void silk_find_pred_coefs_FLP(
128     silk_encoder_state_FLP          *psEnc,                             /* I/O  Encoder state FLP                           */
129     silk_encoder_control_FLP        *psEncCtrl,                         /* I/O  Encoder control FLP                         */
130     const silk_float                res_pitch[],                        /* I    Residual from pitch analysis                */
131     const silk_float                x[],                                /* I    Speech signal                               */
132     opus_int                        condCoding                          /* I    The type of conditional coding to use       */
133 );
134
135 /* LPC analysis */
136 void silk_find_LPC_FLP(
137     silk_encoder_state              *psEncC,                            /* I/O  Encoder state                               */
138     opus_int16                      NLSF_Q15[],                         /* O    NLSFs                                       */
139     const silk_float                x[],                                /* I    Input signal                                */
140     const silk_float                minInvGain                          /* I    Prediction gain from LTP (dB)               */
141 );
142
143 /* LTP analysis */
144 void silk_find_LTP_FLP(
145     silk_float                      XX[ MAX_NB_SUBFR * LTP_ORDER * LTP_ORDER ], /* O    Weight for LTP quantization         */
146     silk_float                      xX[ MAX_NB_SUBFR * LTP_ORDER ],     /* O    Weight for LTP quantization                 */
147     const silk_float                r_ptr[],                            /* I    LPC residual                                */
148     const opus_int                  lag[  MAX_NB_SUBFR ],               /* I    LTP lags                                    */
149     const opus_int                  subfr_length,                       /* I    Subframe length                             */
150     const opus_int                  nb_subfr                            /* I    number of subframes                         */
151 );
152
153 void silk_LTP_analysis_filter_FLP(
154     silk_float                      *LTP_res,                           /* O    LTP res MAX_NB_SUBFR*(pre_lgth+subfr_lngth) */
155     const silk_float                *x,                                 /* I    Input signal, with preceding samples        */
156     const silk_float                B[ LTP_ORDER * MAX_NB_SUBFR ],      /* I    LTP coefficients for each subframe          */
157     const opus_int                  pitchL[   MAX_NB_SUBFR ],           /* I    Pitch lags                                  */
158     const silk_float                invGains[ MAX_NB_SUBFR ],           /* I    Inverse quantization gains                  */
159     const opus_int                  subfr_length,                       /* I    Length of each subframe                     */
160     const opus_int                  nb_subfr,                           /* I    number of subframes                         */
161     const opus_int                  pre_length                          /* I    Preceding samples for each subframe         */
162 );
163
164 /* Calculates residual energies of input subframes where all subframes have LPC_order   */
165 /* of preceding samples                                                                 */
166 void silk_residual_energy_FLP(
167     silk_float                      nrgs[ MAX_NB_SUBFR ],               /* O    Residual energy per subframe                */
168     const silk_float                x[],                                /* I    Input signal                                */
169     silk_float                      a[ 2 ][ MAX_LPC_ORDER ],            /* I    AR coefs for each frame half                */
170     const silk_float                gains[],                            /* I    Quantization gains                          */
171     const opus_int                  subfr_length,                       /* I    Subframe length                             */
172     const opus_int                  nb_subfr,                           /* I    number of subframes                         */
173     const opus_int                  LPC_order                           /* I    LPC order                                   */
174 );
175
176 /* 16th order LPC analysis filter */
177 void silk_LPC_analysis_filter_FLP(
178     silk_float                      r_LPC[],                            /* O    LPC residual signal                         */
179     const silk_float                PredCoef[],                         /* I    LPC coefficients                            */
180     const silk_float                s[],                                /* I    Input signal                                */
181     const opus_int                  length,                             /* I    Length of input signal                      */
182     const opus_int                  Order                               /* I    LPC order                                   */
183 );
184
185 /* LTP tap quantizer */
186 void silk_quant_LTP_gains_FLP(
187     silk_float                      B[ MAX_NB_SUBFR * LTP_ORDER ],      /* O    Quantized LTP gains                         */
188     opus_int8                       cbk_index[ MAX_NB_SUBFR ],          /* O    Codebook index                              */
189     opus_int8                       *periodicity_index,                 /* O    Periodicity index                           */
190     opus_int32                      *sum_log_gain_Q7,                   /* I/O  Cumulative max prediction gain  */
191     silk_float                      *pred_gain_dB,                      /* O    LTP prediction gain                         */
192     const silk_float                XX[ MAX_NB_SUBFR * LTP_ORDER * LTP_ORDER ], /* I    Correlation matrix                  */
193     const silk_float                xX[ MAX_NB_SUBFR * LTP_ORDER ],     /* I    Correlation vector                          */
194     const opus_int                  subfr_len,                          /* I    Number of samples per subframe              */
195     const opus_int                  nb_subfr,                           /* I    Number of subframes                         */
196     int                             arch                                /* I    Run-time architecture                       */
197 );
198
199 /* Residual energy: nrg = wxx - 2 * wXx * c + c' * wXX * c */
200 silk_float silk_residual_energy_covar_FLP(                              /* O    Weighted residual energy                    */
201     const silk_float                *c,                                 /* I    Filter coefficients                         */
202     silk_float                      *wXX,                               /* I/O  Weighted correlation matrix, reg. out       */
203     const silk_float                *wXx,                               /* I    Weighted correlation vector                 */
204     const silk_float                wxx,                                /* I    Weighted correlation value                  */
205     const opus_int                  D                                   /* I    Dimension                                   */
206 );
207
208 /* Processing of gains */
209 void silk_process_gains_FLP(
210     silk_encoder_state_FLP          *psEnc,                             /* I/O  Encoder state FLP                           */
211     silk_encoder_control_FLP        *psEncCtrl,                         /* I/O  Encoder control FLP                         */
212     opus_int                        condCoding                          /* I    The type of conditional coding to use       */
213 );
214
215 /******************/
216 /* Linear Algebra */
217 /******************/
218 /* Calculates correlation matrix X'*X */
219 void silk_corrMatrix_FLP(
220     const silk_float                *x,                                 /* I    x vector [ L+order-1 ] used to create X     */
221     const opus_int                  L,                                  /* I    Length of vectors                           */
222     const opus_int                  Order,                              /* I    Max lag for correlation                     */
223     silk_float                      *XX                                 /* O    X'*X correlation matrix [order x order]     */
224 );
225
226 /* Calculates correlation vector X'*t */
227 void silk_corrVector_FLP(
228     const silk_float                *x,                                 /* I    x vector [L+order-1] used to create X       */
229     const silk_float                *t,                                 /* I    Target vector [L]                           */
230     const opus_int                  L,                                  /* I    Length of vecors                            */
231     const opus_int                  Order,                              /* I    Max lag for correlation                     */
232     silk_float                      *Xt                                 /* O    X'*t correlation vector [order]             */
233 );
234
235 /* Apply sine window to signal vector.  */
236 /* Window types:                        */
237 /*  1 -> sine window from 0 to pi/2     */
238 /*  2 -> sine window from pi/2 to pi    */
239 void silk_apply_sine_window_FLP(
240     silk_float                      px_win[],                           /* O    Pointer to windowed signal                  */
241     const silk_float                px[],                               /* I    Pointer to input signal                     */
242     const opus_int                  win_type,                           /* I    Selects a window type                       */
243     const opus_int                  length                              /* I    Window length, multiple of 4                */
244 );
245
246 /* Wrapper functions. Call flp / fix code */
247
248 /* Convert AR filter coefficients to NLSF parameters */
249 void silk_A2NLSF_FLP(
250     opus_int16                      *NLSF_Q15,                          /* O    NLSF vector      [ LPC_order ]              */
251     const silk_float                *pAR,                               /* I    LPC coefficients [ LPC_order ]              */
252     const opus_int                  LPC_order                           /* I    LPC order                                   */
253 );
254
255 /* Convert NLSF parameters to AR prediction filter coefficients */
256 void silk_NLSF2A_FLP(
257     silk_float                      *pAR,                               /* O    LPC coefficients [ LPC_order ]              */
258     const opus_int16                *NLSF_Q15,                          /* I    NLSF vector      [ LPC_order ]              */
259     const opus_int                  LPC_order,                          /* I    LPC order                                   */
260     int                             arch                                /* I    Run-time architecture                       */
261 );
262
263 /* Limit, stabilize, and quantize NLSFs */
264 void silk_process_NLSFs_FLP(
265     silk_encoder_state              *psEncC,                            /* I/O  Encoder state                               */
266     silk_float                      PredCoef[ 2 ][ MAX_LPC_ORDER ],     /* O    Prediction coefficients                     */
267     opus_int16                      NLSF_Q15[      MAX_LPC_ORDER ],     /* I/O  Normalized LSFs (quant out) (0 - (2^15-1))  */
268     const opus_int16                prev_NLSF_Q15[ MAX_LPC_ORDER ]      /* I    Previous Normalized LSFs (0 - (2^15-1))     */
269 );
270
271 /* Floating-point Silk NSQ wrapper      */
272 void silk_NSQ_wrapper_FLP(
273     silk_encoder_state_FLP          *psEnc,                             /* I/O  Encoder state FLP                           */
274     silk_encoder_control_FLP        *psEncCtrl,                         /* I/O  Encoder control FLP                         */
275     SideInfoIndices                 *psIndices,                         /* I/O  Quantization indices                        */
276     silk_nsq_state                  *psNSQ,                             /* I/O  Noise Shaping Quantzation state             */
277     opus_int8                       pulses[],                           /* O    Quantized pulse signal                      */
278     const silk_float                x[]                                 /* I    Prefiltered input signal                    */
279 );
280
281 #ifdef __cplusplus
282 }
283 #endif
284
285 #endif