removed prefilter
[opus.git] / silk / fixed / main_FIX.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_FIX_H
29 #define SILK_MAIN_FIX_H
30
31 #include "SigProc_FIX.h"
32 #include "structs_FIX.h"
33 #include "control.h"
34 #include "main.h"
35 #include "PLC.h"
36 #include "debug.h"
37 #include "entenc.h"
38
39 #ifndef FORCE_CPP_BUILD
40 #ifdef __cplusplus
41 extern "C"
42 {
43 #endif
44 #endif
45
46 #define silk_encoder_state_Fxx      silk_encoder_state_FIX
47 #define silk_encode_do_VAD_Fxx      silk_encode_do_VAD_FIX
48 #define silk_encode_frame_Fxx       silk_encode_frame_FIX
49
50 /*********************/
51 /* Encoder Functions */
52 /*********************/
53
54 /* High-pass filter with cutoff frequency adaptation based on pitch lag statistics */
55 void silk_HP_variable_cutoff(
56     silk_encoder_state_Fxx          state_Fxx[]                             /* I/O  Encoder states                                                              */
57 );
58
59 /* Encoder main function */
60 void silk_encode_do_VAD_FIX(
61     silk_encoder_state_FIX          *psEnc                                  /* I/O  Pointer to Silk FIX encoder state                                           */
62 );
63
64 /* Encoder main function */
65 opus_int silk_encode_frame_FIX(
66     silk_encoder_state_FIX          *psEnc,                                 /* I/O  Pointer to Silk FIX encoder state                                           */
67     opus_int32                      *pnBytesOut,                            /* O    Pointer to number of payload bytes;                                         */
68     ec_enc                          *psRangeEnc,                            /* I/O  compressor data structure                                                   */
69     opus_int                        condCoding,                             /* I    The type of conditional coding to use                                       */
70     opus_int                        maxBits,                                /* I    If > 0: maximum number of output bits                                       */
71     opus_int                        useCBR                                  /* I    Flag to force constant-bitrate operation                                    */
72 );
73
74 /* Initializes the Silk encoder state */
75 opus_int silk_init_encoder(
76     silk_encoder_state_Fxx          *psEnc,                                 /* I/O  Pointer to Silk FIX encoder state                                           */
77     int                              arch                                   /* I    Run-time architecture                                                       */
78 );
79
80 /* Control the Silk encoder */
81 opus_int silk_control_encoder(
82     silk_encoder_state_Fxx          *psEnc,                                 /* I/O  Pointer to Silk encoder state                                               */
83     silk_EncControlStruct           *encControl,                            /* I    Control structure                                                           */
84     const opus_int32                TargetRate_bps,                         /* I    Target max bitrate (bps)                                                    */
85     const opus_int                  allow_bw_switch,                        /* I    Flag to allow switching audio bandwidth                                     */
86     const opus_int                  channelNb,                              /* I    Channel number                                                              */
87     const opus_int                  force_fs_kHz
88 );
89
90 /**************************/
91 /* Noise shaping analysis */
92 /**************************/
93 /* Compute noise shaping coefficients and initial gain values */
94 void silk_noise_shape_analysis_FIX(
95     silk_encoder_state_FIX          *psEnc,                                 /* I/O  Encoder state FIX                                                           */
96     silk_encoder_control_FIX        *psEncCtrl,                             /* I/O  Encoder control FIX                                                         */
97     const opus_int16                *pitch_res,                             /* I    LPC residual from pitch analysis                                            */
98     const opus_int16                *x,                                     /* I    Input signal [ frame_length + la_shape ]                                    */
99     int                              arch                                   /* I    Run-time architecture                                                       */
100 );
101
102 /* Autocorrelations for a warped frequency axis */
103 void silk_warped_autocorrelation_FIX(
104           opus_int32                *corr,                                  /* O    Result [order + 1]                                                          */
105           opus_int                  *scale,                                 /* O    Scaling of the correlation vector                                           */
106     const opus_int16                *input,                                 /* I    Input data to correlate                                                     */
107     const opus_int                  warping_Q16,                            /* I    Warping coefficient                                                         */
108     const opus_int                  length,                                 /* I    Length of input                                                             */
109     const opus_int                  order                                   /* I    Correlation order (even)                                                    */
110 );
111
112 /* Calculation of LTP state scaling */
113 void silk_LTP_scale_ctrl_FIX(
114     silk_encoder_state_FIX          *psEnc,                                 /* I/O  encoder state                                                               */
115     silk_encoder_control_FIX        *psEncCtrl,                             /* I/O  encoder control                                                             */
116     opus_int                        condCoding                              /* I    The type of conditional coding to use                                       */
117 );
118
119 /**********************************************/
120 /* Prediction Analysis                        */
121 /**********************************************/
122 /* Find pitch lags */
123 void silk_find_pitch_lags_FIX(
124     silk_encoder_state_FIX          *psEnc,                                 /* I/O  encoder state                                                               */
125     silk_encoder_control_FIX        *psEncCtrl,                             /* I/O  encoder control                                                             */
126     opus_int16                      res[],                                  /* O    residual                                                                    */
127     const opus_int16                x[],                                    /* I    Speech signal                                                               */
128     int                             arch                                    /* I    Run-time architecture                                                       */
129 );
130
131 /* Find LPC and LTP coefficients */
132 void silk_find_pred_coefs_FIX(
133     silk_encoder_state_FIX          *psEnc,                                 /* I/O  encoder state                                                               */
134     silk_encoder_control_FIX        *psEncCtrl,                             /* I/O  encoder control                                                             */
135     const opus_int16                res_pitch[],                            /* I    Residual from pitch analysis                                                */
136     const opus_int16                x[],                                    /* I    Speech signal                                                               */
137     opus_int                        condCoding                              /* I    The type of conditional coding to use                                       */
138 );
139
140 /* LPC analysis */
141 void silk_find_LPC_FIX(
142     silk_encoder_state              *psEncC,                                /* I/O  Encoder state                                                               */
143     opus_int16                      NLSF_Q15[],                             /* O    NLSFs                                                                       */
144     const opus_int16                x[],                                    /* I    Input signal                                                                */
145     const opus_int32                minInvGain_Q30                          /* I    Inverse of max prediction gain                                              */
146 );
147
148 /* LTP analysis */
149 void silk_find_LTP_FIX(
150     opus_int32                      XXLTP_Q17[ MAX_NB_SUBFR * LTP_ORDER * LTP_ORDER ], /* O    Correlation matrix                                                                                               */
151     opus_int32                      xXLTP_Q17[ MAX_NB_SUBFR * LTP_ORDER ],      /* O    Correlation vector                                                                                                                      */
152     const opus_int16                r_lpc[],                                /* I    Residual signal after LPC                                                                               */
153     const opus_int                  lag[ MAX_NB_SUBFR ],                    /* I    LTP lags                                                                    */
154     const opus_int                  subfr_length,                           /* I    Subframe length                                                             */
155     const opus_int                  nb_subfr,                               /* I    Number of subframes                                                         */
156     int                             arch                                    /* I    Run-time architecture                                                       */
157 );
158
159 void silk_LTP_analysis_filter_FIX(
160     opus_int16                      *LTP_res,                               /* O    LTP residual signal of length MAX_NB_SUBFR * ( pre_length + subfr_length )  */
161     const opus_int16                *x,                                     /* I    Pointer to input signal with at least max( pitchL ) preceding samples       */
162     const opus_int16                LTPCoef_Q14[ LTP_ORDER * MAX_NB_SUBFR ],/* I    LTP_ORDER LTP coefficients for each MAX_NB_SUBFR subframe                   */
163     const opus_int                  pitchL[ MAX_NB_SUBFR ],                 /* I    Pitch lag, one for each subframe                                            */
164     const opus_int32                invGains_Q16[ MAX_NB_SUBFR ],           /* I    Inverse quantization gains, one for each subframe                           */
165     const opus_int                  subfr_length,                           /* I    Length of each subframe                                                     */
166     const opus_int                  nb_subfr,                               /* I    Number of subframes                                                         */
167     const opus_int                  pre_length                              /* I    Length of the preceding samples starting at &x[0] for each subframe         */
168 );
169
170 /* Calculates residual energies of input subframes where all subframes have LPC_order   */
171 /* of preceding samples                                                                 */
172 void silk_residual_energy_FIX(
173           opus_int32                nrgs[ MAX_NB_SUBFR ],                   /* O    Residual energy per subframe                                                */
174           opus_int                  nrgsQ[ MAX_NB_SUBFR ],                  /* O    Q value per subframe                                                        */
175     const opus_int16                x[],                                    /* I    Input signal                                                                */
176           opus_int16                a_Q12[ 2 ][ MAX_LPC_ORDER ],            /* I    AR coefs for each frame half                                                */
177     const opus_int32                gains[ MAX_NB_SUBFR ],                  /* I    Quantization gains                                                          */
178     const opus_int                  subfr_length,                           /* I    Subframe length                                                             */
179     const opus_int                  nb_subfr,                               /* I    Number of subframes                                                         */
180     const opus_int                  LPC_order,                              /* I    LPC order                                                                   */
181     int                             arch                                    /* I    Run-time architecture                                                       */
182 );
183
184 /* Residual energy: nrg = wxx - 2 * wXx * c + c' * wXX * c */
185 opus_int32 silk_residual_energy16_covar_FIX(
186     const opus_int16                *c,                                     /* I    Prediction vector                                                           */
187     const opus_int32                *wXX,                                   /* I    Correlation matrix                                                          */
188     const opus_int32                *wXx,                                   /* I    Correlation vector                                                          */
189     opus_int32                      wxx,                                    /* I    Signal energy                                                               */
190     opus_int                        D,                                      /* I    Dimension                                                                   */
191     opus_int                        cQ                                      /* I    Q value for c vector 0 - 15                                                 */
192 );
193
194 /* Processing of gains */
195 void silk_process_gains_FIX(
196     silk_encoder_state_FIX          *psEnc,                                 /* I/O  Encoder state                                                               */
197     silk_encoder_control_FIX        *psEncCtrl,                             /* I/O  Encoder control                                                             */
198     opus_int                        condCoding                              /* I    The type of conditional coding to use                                       */
199 );
200
201 /******************/
202 /* Linear Algebra */
203 /******************/
204 /* Calculates correlation matrix X'*X */
205 void silk_corrMatrix_FIX(
206     const opus_int16                *x,                                     /* I    x vector [L + order - 1] used to form data matrix X                         */
207     const opus_int                  L,                                      /* I    Length of vectors                                                           */
208     const opus_int                  order,                                  /* I    Max lag for correlation                                                     */
209     opus_int32                      *XX,                                    /* O    Pointer to X'*X correlation matrix [ order x order ]                        */
210         opus_int32                      *nrg,                                                                   /* O    Energy of x vector                                                                                                                      */
211     opus_int                        *rshifts,                               /* O    Right shifts of correlations                                                */
212     int                              arch                                   /* I    Run-time architecture                                                       */
213 );
214
215 /* Calculates correlation vector X'*t */
216 void silk_corrVector_FIX(
217     const opus_int16                *x,                                     /* I    x vector [L + order - 1] used to form data matrix X                         */
218     const opus_int16                *t,                                     /* I    Target vector [L]                                                           */
219     const opus_int                  L,                                      /* I    Length of vectors                                                           */
220     const opus_int                  order,                                  /* I    Max lag for correlation                                                     */
221     opus_int32                      *Xt,                                    /* O    Pointer to X'*t correlation vector [order]                                  */
222     const opus_int                  rshifts,                                /* I    Right shifts of correlations                                                */
223     int                             arch                                    /* I    Run-time architecture                                                       */
224 );
225
226 #ifndef FORCE_CPP_BUILD
227 #ifdef __cplusplus
228 }
229 #endif /* __cplusplus */
230 #endif /* FORCE_CPP_BUILD */
231 #endif /* SILK_MAIN_FIX_H */