Remove redundant mid-only flag when side VAD flag is set.
[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, (subject to the limitations in the disclaimer below)
5 are permitted provided that the following conditions 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 Skype Limited, nor the names of specific
12 contributors, may be used to endorse or promote products derived from
13 this software without specific prior written permission.
14 NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
15 BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
16 CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
17 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
18 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
22 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
23 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 OF THIS SOFTWARE, EVEN IF ADVISED OF THE 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 );
71
72 /* Initializes the Silk encoder state */
73 opus_int silk_init_encoder(
74     silk_encoder_state_FIX          *psEnc              /* I/O  Pointer to Silk FIX encoder state           */
75 );
76
77 /* Control the Silk encoder */
78 opus_int silk_control_encoder(
79     silk_encoder_state_FIX          *psEnc,             /* I/O  Pointer to Silk encoder state           */
80     silk_EncControlStruct           *encControl,        /* I:   Control structure                       */
81     const opus_int32                 TargetRate_bps,     /* I    Target max bitrate (bps)                */
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 /* Prefiltering */
89 /****************/
90 void silk_prefilter_FIX(
91     silk_encoder_state_FIX              *psEnc,         /* I/O  Encoder state                               */
92     const silk_encoder_control_FIX      *psEncCtrl,     /* I    Encoder control                             */
93     opus_int16                           xw[],           /* O    Weighted signal                             */
94     const opus_int16                     x[]             /* I    Speech signal                               */
95 );
96
97 /**************************/
98 /* Noise shaping analysis */
99 /**************************/
100 /* Compute noise shaping coefficients and initial gain values */
101 void silk_noise_shape_analysis_FIX(
102     silk_encoder_state_FIX          *psEnc,         /* I/O  Encoder state FIX                           */
103     silk_encoder_control_FIX        *psEncCtrl,     /* I/O  Encoder control FIX                         */
104     const opus_int16                 *pitch_res,     /* I    LPC residual from pitch analysis            */
105     const opus_int16                 *x              /* I    Input signal [ frame_length + la_shape ]    */
106 );
107
108 /* Autocorrelations for a warped frequency axis */
109 void silk_warped_autocorrelation_FIX(
110           opus_int32                 *corr,              /* O    Result [order + 1]                      */
111           opus_int                   *scale,             /* O    Scaling of the correlation vector       */
112     const opus_int16                 *input,             /* I    Input data to correlate                 */
113     const opus_int                   warping_Q16,        /* I    Warping coefficient                     */
114     const opus_int                   length,             /* I    Length of input                         */
115     const opus_int                   order               /* I    Correlation order (even)                */
116 );
117
118 /* Calculation of LTP state scaling */
119 void silk_LTP_scale_ctrl_FIX(
120     silk_encoder_state_FIX          *psEnc,         /* I/O  encoder state                               */
121     silk_encoder_control_FIX        *psEncCtrl,     /* I/O  encoder control                             */
122     opus_int                         condCoding     /* I    The type of conditional coding to use       */
123 );
124
125 /**********************************************/
126 /* Prediction Analysis                        */
127 /**********************************************/
128 /* Find pitch lags */
129 void silk_find_pitch_lags_FIX(
130     silk_encoder_state_FIX          *psEnc,         /* I/O  encoder state                               */
131     silk_encoder_control_FIX        *psEncCtrl,     /* I/O  encoder control                             */
132     opus_int16                       res[],          /* O    residual                                    */
133     const opus_int16                 x[]             /* I    Speech signal                               */
134 );
135
136 /* Find LPC and LTP coefficients */
137 void silk_find_pred_coefs_FIX(
138     silk_encoder_state_FIX          *psEnc,         /* I/O  encoder state                               */
139     silk_encoder_control_FIX        *psEncCtrl,     /* I/O  encoder control                             */
140     const opus_int16                 res_pitch[],    /* I    Residual from pitch analysis                */
141     const opus_int16                 x[],            /* I    Speech signal                               */
142     opus_int                         condCoding      /* I    The type of conditional coding to use       */
143 );
144
145 /* LPC analysis */
146 void silk_find_LPC_FIX(
147     opus_int16                       NLSF_Q15[],             /* O    NLSFs                                                           */
148     opus_int8                        *interpIndex,           /* O    NLSF interpolation index, only used for NLSF interpolation      */
149     const opus_int16                 prev_NLSFq_Q15[],       /* I    previous NLSFs, only used for NLSF interpolation                */
150     const opus_int                   useInterpNLSFs,         /* I    Flag                                                            */
151     const opus_int                   firstFrameAfterReset,   /* I    Flag                                                            */
152     const opus_int                   LPC_order,              /* I    LPC order                                                       */
153     const opus_int16                 x[],                    /* I    Input signal                                                    */
154     const opus_int                   subfr_length,           /* I    Input signal subframe length including preceeding samples       */
155     const opus_int                   nb_subfr                /* I:   Number of subframes                                             */
156 );
157
158 /* LTP analysis */
159 void silk_find_LTP_FIX(
160     opus_int16           b_Q14[ MAX_NB_SUBFR * LTP_ORDER ],              /* O    LTP coefs                                                   */
161     opus_int32           WLTP[ MAX_NB_SUBFR * LTP_ORDER * LTP_ORDER ],   /* O    Weight for LTP quantization                                 */
162     opus_int             *LTPredCodGain_Q7,                              /* O    LTP coding gain                                             */
163     const opus_int16     r_lpc[],                                        /* I    residual signal after LPC signal + state for first 10 ms    */
164     const opus_int       lag[ MAX_NB_SUBFR ],                            /* I    LTP lags                                                    */
165     const opus_int32     Wght_Q15[ MAX_NB_SUBFR ],                       /* I    weights                                                     */
166     const opus_int       subfr_length,                                   /* I    subframe length                                             */
167     const opus_int       nb_subfr,                                       /* I    number of subframes                                         */
168     const opus_int       mem_offset,                                     /* I    number of samples in LTP memory                             */
169     opus_int             corr_rshifts[ MAX_NB_SUBFR ]                    /* O    right shifts applied to correlations                        */
170 );
171
172 void silk_LTP_analysis_filter_FIX(
173     opus_int16           *LTP_res,                               /* O:   LTP residual signal of length MAX_NB_SUBFR * ( pre_length + subfr_length )  */
174     const opus_int16     *x,                                     /* I:   Pointer to input signal with at least max( pitchL ) preceeding samples      */
175     const opus_int16     LTPCoef_Q14[ LTP_ORDER * MAX_NB_SUBFR ],/* I:   LTP_ORDER LTP coefficients for each MAX_NB_SUBFR subframe                   */
176     const opus_int       pitchL[ MAX_NB_SUBFR ],                 /* I:   Pitch lag, one for each subframe                                            */
177     const opus_int32     invGains_Q16[ MAX_NB_SUBFR ],           /* I:   Inverse quantization gains, one for each subframe                           */
178     const opus_int       subfr_length,                           /* I:   Length of each subframe                                                     */
179     const opus_int       nb_subfr,                               /* I:   Number of subframes                                                         */
180     const opus_int       pre_length                              /* I:   Length of the preceeding samples starting at &x[0] for each subframe        */
181 );
182
183 /* Calculates residual energies of input subframes where all subframes have LPC_order   */
184 /* of preceeding samples                                                                */
185 void silk_residual_energy_FIX(
186           opus_int32 nrgs[ MAX_NB_SUBFR ],           /* O    Residual energy per subframe    */
187           opus_int   nrgsQ[ MAX_NB_SUBFR ],          /* O    Q value per subframe            */
188     const opus_int16 x[],                            /* I    Input signal                    */
189           opus_int16 a_Q12[ 2 ][ MAX_LPC_ORDER ],    /* I    AR coefs for each frame half    */
190     const opus_int32 gains[ MAX_NB_SUBFR ],          /* I    Quantization gains              */
191     const opus_int   subfr_length,                   /* I    Subframe length                 */
192     const opus_int   nb_subfr,                       /* I    Number of subframes             */
193     const opus_int   LPC_order                       /* I    LPC order                       */
194 );
195
196 /* Residual energy: nrg = wxx - 2 * wXx * c + c' * wXX * c */
197 opus_int32 silk_residual_energy16_covar_FIX(
198     const opus_int16                 *c,                 /* I    Prediction vector                           */
199     const opus_int32                 *wXX,               /* I    Correlation matrix                          */
200     const opus_int32                 *wXx,               /* I    Correlation vector                          */
201     opus_int32                       wxx,                /* I    Signal energy                               */
202     opus_int                         D,                  /* I    Dimension                                   */
203     opus_int                         cQ                  /* I    Q value for c vector 0 - 15                 */
204 );
205
206 /* Processing of gains */
207 void silk_process_gains_FIX(
208     silk_encoder_state_FIX          *psEnc,         /* I/O  Encoder state                               */
209     silk_encoder_control_FIX        *psEncCtrl,     /* I/O  Encoder control                             */
210     opus_int                         condCoding     /* I    The type of conditional coding to use       */
211 );
212
213 /******************/
214 /* Linear Algebra */
215 /******************/
216 /* Calculates correlation matrix X'*X */
217 void silk_corrMatrix_FIX(
218     const opus_int16                 *x,         /* I    x vector [L + order - 1] used to form data matrix X */
219     const opus_int                   L,          /* I    Length of vectors                                   */
220     const opus_int                   order,      /* I    Max lag for correlation                             */
221     const opus_int                   head_room,  /* I    Desired headroom                                    */
222     opus_int32                       *XX,        /* O    Pointer to X'*X correlation matrix [ order x order ]*/
223     opus_int                         *rshifts    /* I/O  Right shifts of correlations                        */
224 );
225
226 /* Calculates correlation vector X'*t */
227 void silk_corrVector_FIX(
228     const opus_int16                 *x,         /* I    x vector [L + order - 1] used to form data matrix X */
229     const opus_int16                 *t,         /* I    Target vector [L]                                   */
230     const opus_int                   L,          /* I    Length of vectors                                   */
231     const opus_int                   order,      /* I    Max lag for correlation                             */
232     opus_int32                       *Xt,        /* O    Pointer to X'*t correlation vector [order]          */
233     const opus_int                   rshifts     /* I    Right shifts of correlations                        */
234 );
235
236 /* Add noise to matrix diagonal */
237 void silk_regularize_correlations_FIX(
238     opus_int32                       *XX,                /* I/O  Correlation matrices                        */
239     opus_int32                       *xx,                /* I/O  Correlation values                          */
240     opus_int32                       noise,              /* I    Noise to add                                */
241     opus_int                         D                   /* I    Dimension of XX                             */
242 );
243
244 /* Solves Ax = b, assuming A is symmetric */
245 void silk_solve_LDL_FIX(
246     opus_int32                       *A,                 /* I    Pointer to symetric square matrix A         */
247     opus_int                         M,                  /* I    Size of matrix                              */
248     const opus_int32                 *b,                 /* I    Pointer to b vector                         */
249     opus_int32                       *x_Q16              /* O    Pointer to x solution vector                */
250 );
251
252 #ifndef FORCE_CPP_BUILD
253 #ifdef __cplusplus
254 }
255 #endif /* __cplusplus */
256 #endif /* FORCE_CPP_BUILD */
257 #endif /* SILK_MAIN_FIX_H */