Updated README
[opus.git] / silk / fixed / SKP_Silk_main_FIX.h
1 /***********************************************************************\r
2 Copyright (c) 2006-2011, 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_control.h"\r
34 #include "SKP_Silk_main.h"\r
35 #include "SKP_Silk_PLC.h"\r
36 #include "SKP_debug.h"\r
37 #include "entenc.h"\r
38 \r
39 #ifndef FORCE_CPP_BUILD\r
40 #ifdef __cplusplus\r
41 extern "C"\r
42 {\r
43 #endif\r
44 #endif\r
45 \r
46 /*********************/\r
47 /* Encoder Functions */\r
48 /*********************/\r
49 \r
50 /* Encoder main function */\r
51 SKP_int SKP_Silk_encode_frame_FIX( \r
52     SKP_Silk_encoder_state_FIX      *psEnc,             /* I/O  Pointer to Silk FIX encoder state       */\r
53     SKP_int32                       *pnBytesOut,        /*   O  Pointer to number of payload bytes;     */\r
54     ec_enc                          *psRangeEnc         /* I/O  compressor data structure               */\r
55 );\r
56 \r
57 /* Low Bitrate Redundancy (LBRR) encoding. Reuse all parameters but encode with lower bitrate           */\r
58 void SKP_Silk_LBRR_encode_FIX(\r
59     SKP_Silk_encoder_state_FIX      *psEnc,             /* I/O  Pointer to Silk FIX encoder state           */\r
60     SKP_Silk_encoder_control_FIX    *psEncCtrl,         /* I/O  Pointer to Silk FIX encoder control struct  */\r
61     const SKP_int16                 xfw[]               /* I    Input signal                                */\r
62 );\r
63 \r
64 /* Initializes the Silk encoder state */\r
65 SKP_int SKP_Silk_init_encoder(\r
66     SKP_Silk_encoder_state_FIX      *psEnc              /* I/O  Pointer to Silk FIX encoder state           */\r
67 );\r
68 \r
69 /* Control the Silk encoder */\r
70 SKP_int SKP_Silk_control_encoder( \r
71     SKP_Silk_encoder_state_FIX      *psEnc,             /* I/O  Pointer to Silk encoder state           */\r
72     SKP_SILK_SDK_EncControlStruct   *encControl,        /* I:   Control structure                       */\r
73     const SKP_int32                 TargetRate_bps,     /* I    Target max bitrate (bps)                */\r
74     const SKP_int                   allow_bw_switch,    /* I    Flag to allow switching audio bandwidth */\r
75     const SKP_int                   channelNb           /* I    Channel number                          */\r
76 );\r
77 \r
78 /****************/\r
79 /* Prefiltering */\r
80 /****************/\r
81 void SKP_Silk_prefilter_FIX(\r
82     SKP_Silk_encoder_state_FIX          *psEnc,         /* I/O  Encoder state                               */\r
83     const SKP_Silk_encoder_control_FIX  *psEncCtrl,     /* I    Encoder control                             */\r
84     SKP_int16                           xw[],           /* O    Weighted signal                             */\r
85     const SKP_int16                     x[]             /* I    Speech signal                               */\r
86 );\r
87 \r
88 /**************************/\r
89 /* Noise shaping analysis */\r
90 /**************************/\r
91 /* Compute noise shaping coefficients and initial gain values */\r
92 void SKP_Silk_noise_shape_analysis_FIX(\r
93     SKP_Silk_encoder_state_FIX      *psEnc,         /* I/O  Encoder state FIX                           */\r
94     SKP_Silk_encoder_control_FIX    *psEncCtrl,     /* I/O  Encoder control FIX                         */\r
95     const SKP_int16                 *pitch_res,     /* I    LPC residual from pitch analysis            */\r
96     const SKP_int16                 *x              /* I    Input signal [ frame_length + la_shape ]    */\r
97 );\r
98 \r
99 /* Autocorrelations for a warped frequency axis */\r
100 void SKP_Silk_warped_autocorrelation_FIX(\r
101           SKP_int32                 *corr,              /* O    Result [order + 1]                      */\r
102           SKP_int                   *scale,             /* O    Scaling of the correlation vector       */\r
103     const SKP_int16                 *input,             /* I    Input data to correlate                 */\r
104     const SKP_int                   warping_Q16,        /* I    Warping coefficient                     */\r
105     const SKP_int                   length,             /* I    Length of input                         */\r
106     const SKP_int                   order               /* I    Correlation order (even)                */\r
107 );\r
108 \r
109 /* Calculation of LTP state scaling */\r
110 void SKP_Silk_LTP_scale_ctrl_FIX(\r
111     SKP_Silk_encoder_state_FIX      *psEnc,         /* I/O  encoder state                               */\r
112     SKP_Silk_encoder_control_FIX    *psEncCtrl      /* I/O  encoder control                             */\r
113 );\r
114 \r
115 /**********************************************/\r
116 /* Prediction Analysis                        */\r
117 /**********************************************/\r
118 /* Find pitch lags */\r
119 void SKP_Silk_find_pitch_lags_FIX(\r
120     SKP_Silk_encoder_state_FIX      *psEnc,         /* I/O  encoder state                               */\r
121     SKP_Silk_encoder_control_FIX    *psEncCtrl,     /* I/O  encoder control                             */\r
122     SKP_int16                       res[],          /* O    residual                                    */\r
123     const SKP_int16                 x[]             /* I    Speech signal                               */\r
124 );\r
125 \r
126 /* Find LPC and LTP coefficients */\r
127 void SKP_Silk_find_pred_coefs_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     const SKP_int16                 res_pitch[],    /* I    Residual from pitch analysis                */\r
131     const SKP_int16                 x[]             /* I    Speech signal                               */\r
132 );\r
133 \r
134 /* LPC analysis */\r
135 void SKP_Silk_find_LPC_FIX(\r
136     SKP_int16                       NLSF_Q15[],             /* O    NLSFs                                                           */\r
137     SKP_int8                        *interpIndex,           /* O    NLSF interpolation index, only used for NLSF interpolation      */\r
138     const SKP_int16                 prev_NLSFq_Q15[],       /* I    previous NLSFs, only used for NLSF interpolation                */\r
139     const SKP_int                   useInterpNLSFs,         /* I    Flag                                                            */\r
140     const SKP_int                   firstFrameAfterReset,   /* I    Flag                                                            */\r
141     const SKP_int                   LPC_order,              /* I    LPC order                                                       */\r
142     const SKP_int16                 x[],                    /* I    Input signal                                                    */\r
143     const SKP_int                   subfr_length,           /* I    Input signal subframe length including preceeding samples       */\r
144     const SKP_int                   nb_subfr                /* I:   Number of subframes                                             */\r
145 );\r
146 \r
147 /* LTP analysis */\r
148 void SKP_Silk_find_LTP_FIX(\r
149     SKP_int16           b_Q14[ MAX_NB_SUBFR * LTP_ORDER ],              /* O    LTP coefs                                                   */\r
150     SKP_int32           WLTP[ MAX_NB_SUBFR * LTP_ORDER * LTP_ORDER ],   /* O    Weight for LTP quantization                                 */\r
151     SKP_int             *LTPredCodGain_Q7,                              /* O    LTP coding gain                                             */\r
152     const SKP_int16     r_lpc[],                                        /* I    residual signal after LPC signal + state for first 10 ms    */\r
153     const SKP_int       lag[ MAX_NB_SUBFR ],                            /* I    LTP lags                                                    */\r
154     const SKP_int32     Wght_Q15[ MAX_NB_SUBFR ],                       /* I    weights                                                     */\r
155     const SKP_int       subfr_length,                                   /* I    subframe length                                             */\r
156     const SKP_int       nb_subfr,                                       /* I    number of subframes                                         */\r
157     const SKP_int       mem_offset,                                     /* I    number of samples in LTP memory                             */\r
158     SKP_int             corr_rshifts[ MAX_NB_SUBFR ]                    /* O    right shifts applied to correlations                        */\r
159 );\r
160 \r
161 void SKP_Silk_LTP_analysis_filter_FIX(\r
162     SKP_int16           *LTP_res,                               /* O:   LTP residual signal of length MAX_NB_SUBFR * ( pre_length + subfr_length )  */\r
163     const SKP_int16     *x,                                     /* I:   Pointer to input signal with at least max( pitchL ) preceeding samples      */\r
164     const SKP_int16     LTPCoef_Q14[ LTP_ORDER * MAX_NB_SUBFR ],/* I:   LTP_ORDER LTP coefficients for each MAX_NB_SUBFR subframe                   */\r
165     const SKP_int       pitchL[ MAX_NB_SUBFR ],                 /* I:   Pitch lag, one for each subframe                                            */\r
166     const SKP_int32     invGains_Q16[ MAX_NB_SUBFR ],           /* I:   Inverse quantization gains, one for each subframe                           */\r
167     const SKP_int       subfr_length,                           /* I:   Length of each subframe                                                     */\r
168     const SKP_int       nb_subfr,                               /* I:   Number of subframes                                                         */\r
169     const SKP_int       pre_length                              /* I:   Length of the preceeding samples starting at &x[0] for each subframe        */\r
170 );\r
171 \r
172 /* Calculates residual energies of input subframes where all subframes have LPC_order   */\r
173 /* of preceeding samples                                                                */\r
174 void SKP_Silk_residual_energy_FIX(\r
175           SKP_int32 nrgs[ MAX_NB_SUBFR ],           /* O    Residual energy per subframe    */\r
176           SKP_int   nrgsQ[ MAX_NB_SUBFR ],          /* O    Q value per subframe            */\r
177     const SKP_int16 x[],                            /* I    Input signal                    */\r
178     const SKP_int16 a_Q12[ 2 ][ MAX_LPC_ORDER ],    /* I    AR coefs for each frame half    */\r
179     const SKP_int32 gains[ MAX_NB_SUBFR ],          /* I    Quantization gains              */\r
180     const SKP_int   subfr_length,                   /* I    Subframe length                 */\r
181     const SKP_int   nb_subfr,                       /* I    Number of subframes             */\r
182     const SKP_int   LPC_order                       /* I    LPC order                       */\r
183 );\r
184 \r
185 /* Residual energy: nrg = wxx - 2 * wXx * c + c' * wXX * c */\r
186 SKP_int32 SKP_Silk_residual_energy16_covar_FIX(\r
187     const SKP_int16                 *c,                 /* I    Prediction vector                           */\r
188     const SKP_int32                 *wXX,               /* I    Correlation matrix                          */\r
189     const SKP_int32                 *wXx,               /* I    Correlation vector                          */\r
190     SKP_int32                       wxx,                /* I    Signal energy                               */\r
191     SKP_int                         D,                  /* I    Dimension                                   */\r
192     SKP_int                         cQ                  /* I    Q value for c vector 0 - 15                 */\r
193 );\r
194 \r
195 /* Processing of gains */\r
196 void SKP_Silk_process_gains_FIX(\r
197     SKP_Silk_encoder_state_FIX      *psEnc,         /* I/O  Encoder state                               */\r
198     SKP_Silk_encoder_control_FIX    *psEncCtrl      /* I/O  Encoder control                             */\r
199 );\r
200 \r
201 /******************/\r
202 /* Linear Algebra */\r
203 /******************/\r
204 /* Calculates correlation matrix X'*X */\r
205 void SKP_Silk_corrMatrix_FIX(\r
206     const SKP_int16                 *x,         /* I    x vector [L + order - 1] used to form data matrix X */\r
207     const SKP_int                   L,          /* I    Length of vectors                                   */\r
208     const SKP_int                   order,      /* I    Max lag for correlation                             */\r
209     const SKP_int                   head_room,  /* I    Desired headroom                                    */\r
210     SKP_int32                       *XX,        /* O    Pointer to X'*X correlation matrix [ order x order ]*/\r
211     SKP_int                         *rshifts    /* I/O  Right shifts of correlations                        */\r
212 );\r
213 \r
214 /* Calculates correlation vector X'*t */\r
215 void SKP_Silk_corrVector_FIX(\r
216     const SKP_int16                 *x,         /* I    x vector [L + order - 1] used to form data matrix X */\r
217     const SKP_int16                 *t,         /* I    Target vector [L]                                   */\r
218     const SKP_int                   L,          /* I    Length of vectors                                   */\r
219     const SKP_int                   order,      /* I    Max lag for correlation                             */\r
220     SKP_int32                       *Xt,        /* O    Pointer to X'*t correlation vector [order]          */\r
221     const SKP_int                   rshifts     /* I    Right shifts of correlations                        */\r
222 );\r
223 \r
224 /* Add noise to matrix diagonal */\r
225 void SKP_Silk_regularize_correlations_FIX(\r
226     SKP_int32                       *XX,                /* I/O  Correlation matrices                        */\r
227     SKP_int32                       *xx,                /* I/O  Correlation values                          */\r
228     SKP_int32                       noise,              /* I    Noise to add                                */\r
229     SKP_int                         D                   /* I    Dimension of XX                             */\r
230 );\r
231 \r
232 /* Solves Ax = b, assuming A is symmetric */\r
233 void SKP_Silk_solve_LDL_FIX(\r
234     SKP_int32                       *A,                 /* I    Pointer to symetric square matrix A         */\r
235     SKP_int                         M,                  /* I    Size of matrix                              */\r
236     const SKP_int32                 *b,                 /* I    Pointer to b vector                         */\r
237     SKP_int32                       *x_Q16              /* O    Pointer to x solution vector                */\r
238 );\r
239 \r
240 #ifndef FORCE_CPP_BUILD\r
241 #ifdef __cplusplus\r
242 }\r
243 #endif /* __cplusplus */\r
244 #endif /* FORCE_CPP_BUILD */\r
245 #endif /* SKP_SILK_MAIN_FIX_H */\r