Fix the side frame conditional coding rules.
[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_frame_Fxx       silk_encode_frame_FIX
48
49 /*********************/
50 /* Encoder Functions */
51 /*********************/
52
53 /* High-pass filter with cutoff frequency adaptation based on pitch lag statistics */
54 void silk_HP_variable_cutoff(
55     silk_encoder_state_Fxx          state_Fxx[]    /* I/O  Encoder states                              */
56 );
57
58 /* Encoder main function */
59 opus_int silk_encode_frame_FIX(
60     silk_encoder_state_FIX          *psEnc,             /* I/O  Pointer to Silk FIX encoder state       */
61     opus_int32                       *pnBytesOut,        /*   O  Pointer to number of payload bytes;     */
62     ec_enc                          *psRangeEnc,        /* I/O  compressor data structure               */
63     opus_int                         condCoding         /* I    The type of conditional coding to use   */
64 );
65
66 /* Low Bitrate Redundancy (LBRR) encoding. Reuse all parameters but encode with lower bitrate           */
67 void silk_LBRR_encode_FIX(
68     silk_encoder_state_FIX          *psEnc,             /* I/O  Pointer to Silk FIX encoder state           */
69     silk_encoder_control_FIX        *psEncCtrl,         /* I/O  Pointer to Silk FIX encoder control struct  */
70     const opus_int16                 xfw[]               /* I    Input signal                                */
71 );
72
73 /* Initializes the Silk encoder state */
74 opus_int silk_init_encoder(
75     silk_encoder_state_FIX          *psEnc              /* I/O  Pointer to Silk FIX encoder state           */
76 );
77
78 /* Control the Silk encoder */
79 opus_int silk_control_encoder(
80     silk_encoder_state_FIX          *psEnc,             /* I/O  Pointer to Silk encoder state           */
81     silk_EncControlStruct           *encControl,        /* I:   Control structure                       */
82     const opus_int32                 TargetRate_bps,     /* I    Target max bitrate (bps)                */
83     const opus_int                   allow_bw_switch,    /* I    Flag to allow switching audio bandwidth */
84     const opus_int                   channelNb,           /* I    Channel number                          */
85     const opus_int                   force_fs_kHz
86 );
87
88 /****************/
89 /* Prefiltering */
90 /****************/
91 void silk_prefilter_FIX(
92     silk_encoder_state_FIX              *psEnc,         /* I/O  Encoder state                               */
93     const silk_encoder_control_FIX      *psEncCtrl,     /* I    Encoder control                             */
94     opus_int16                           xw[],           /* O    Weighted signal                             */
95     const opus_int16                     x[]             /* I    Speech signal                               */
96 );
97
98 /**************************/
99 /* Noise shaping analysis */
100 /**************************/
101 /* Compute noise shaping coefficients and initial gain values */
102 void silk_noise_shape_analysis_FIX(
103     silk_encoder_state_FIX          *psEnc,         /* I/O  Encoder state FIX                           */
104     silk_encoder_control_FIX        *psEncCtrl,     /* I/O  Encoder control FIX                         */
105     const opus_int16                 *pitch_res,     /* I    LPC residual from pitch analysis            */
106     const opus_int16                 *x              /* I    Input signal [ frame_length + la_shape ]    */
107 );
108
109 /* Autocorrelations for a warped frequency axis */
110 void silk_warped_autocorrelation_FIX(
111           opus_int32                 *corr,              /* O    Result [order + 1]                      */
112           opus_int                   *scale,             /* O    Scaling of the correlation vector       */
113     const opus_int16                 *input,             /* I    Input data to correlate                 */
114     const opus_int                   warping_Q16,        /* I    Warping coefficient                     */
115     const opus_int                   length,             /* I    Length of input                         */
116     const opus_int                   order               /* I    Correlation order (even)                */
117 );
118
119 /* Calculation of LTP state scaling */
120 void silk_LTP_scale_ctrl_FIX(
121     silk_encoder_state_FIX          *psEnc,         /* I/O  encoder state                               */
122     silk_encoder_control_FIX        *psEncCtrl,     /* I/O  encoder control                             */
123     opus_int                         condCoding     /* I    The type of conditional coding to use       */
124 );
125
126 /**********************************************/
127 /* Prediction Analysis                        */
128 /**********************************************/
129 /* Find pitch lags */
130 void silk_find_pitch_lags_FIX(
131     silk_encoder_state_FIX          *psEnc,         /* I/O  encoder state                               */
132     silk_encoder_control_FIX        *psEncCtrl,     /* I/O  encoder control                             */
133     opus_int16                       res[],          /* O    residual                                    */
134     const opus_int16                 x[]             /* I    Speech signal                               */
135 );
136
137 /* Find LPC and LTP coefficients */
138 void silk_find_pred_coefs_FIX(
139     silk_encoder_state_FIX          *psEnc,         /* I/O  encoder state                               */
140     silk_encoder_control_FIX        *psEncCtrl,     /* I/O  encoder control                             */
141     const opus_int16                 res_pitch[],    /* I    Residual from pitch analysis                */
142     const opus_int16                 x[],            /* I    Speech signal                               */
143     opus_int                         condCoding      /* I    The type of conditional coding to use       */
144 );
145
146 /* LPC analysis */
147 void silk_find_LPC_FIX(
148     opus_int16                       NLSF_Q15[],             /* O    NLSFs                                                           */
149     opus_int8                        *interpIndex,           /* O    NLSF interpolation index, only used for NLSF interpolation      */
150     const opus_int16                 prev_NLSFq_Q15[],       /* I    previous NLSFs, only used for NLSF interpolation                */
151     const opus_int                   useInterpNLSFs,         /* I    Flag                                                            */
152     const opus_int                   firstFrameAfterReset,   /* I    Flag                                                            */
153     const opus_int                   LPC_order,              /* I    LPC order                                                       */
154     const opus_int16                 x[],                    /* I    Input signal                                                    */
155     const opus_int                   subfr_length,           /* I    Input signal subframe length including preceeding samples       */
156     const opus_int                   nb_subfr                /* I:   Number of subframes                                             */
157 );
158
159 /* LTP analysis */
160 void silk_find_LTP_FIX(
161     opus_int16           b_Q14[ MAX_NB_SUBFR * LTP_ORDER ],              /* O    LTP coefs                                                   */
162     opus_int32           WLTP[ MAX_NB_SUBFR * LTP_ORDER * LTP_ORDER ],   /* O    Weight for LTP quantization                                 */
163     opus_int             *LTPredCodGain_Q7,                              /* O    LTP coding gain                                             */
164     const opus_int16     r_lpc[],                                        /* I    residual signal after LPC signal + state for first 10 ms    */
165     const opus_int       lag[ MAX_NB_SUBFR ],                            /* I    LTP lags                                                    */
166     const opus_int32     Wght_Q15[ MAX_NB_SUBFR ],                       /* I    weights                                                     */
167     const opus_int       subfr_length,                                   /* I    subframe length                                             */
168     const opus_int       nb_subfr,                                       /* I    number of subframes                                         */
169     const opus_int       mem_offset,                                     /* I    number of samples in LTP memory                             */
170     opus_int             corr_rshifts[ MAX_NB_SUBFR ]                    /* O    right shifts applied to correlations                        */
171 );
172
173 void silk_LTP_analysis_filter_FIX(
174     opus_int16           *LTP_res,                               /* O:   LTP residual signal of length MAX_NB_SUBFR * ( pre_length + subfr_length )  */
175     const opus_int16     *x,                                     /* I:   Pointer to input signal with at least max( pitchL ) preceeding samples      */
176     const opus_int16     LTPCoef_Q14[ LTP_ORDER * MAX_NB_SUBFR ],/* I:   LTP_ORDER LTP coefficients for each MAX_NB_SUBFR subframe                   */
177     const opus_int       pitchL[ MAX_NB_SUBFR ],                 /* I:   Pitch lag, one for each subframe                                            */
178     const opus_int32     invGains_Q16[ MAX_NB_SUBFR ],           /* I:   Inverse quantization gains, one for each subframe                           */
179     const opus_int       subfr_length,                           /* I:   Length of each subframe                                                     */
180     const opus_int       nb_subfr,                               /* I:   Number of subframes                                                         */
181     const opus_int       pre_length                              /* I:   Length of the preceeding samples starting at &x[0] for each subframe        */
182 );
183
184 /* Calculates residual energies of input subframes where all subframes have LPC_order   */
185 /* of preceeding samples                                                                */
186 void silk_residual_energy_FIX(
187           opus_int32 nrgs[ MAX_NB_SUBFR ],           /* O    Residual energy per subframe    */
188           opus_int   nrgsQ[ MAX_NB_SUBFR ],          /* O    Q value per subframe            */
189     const opus_int16 x[],                            /* I    Input signal                    */
190           opus_int16 a_Q12[ 2 ][ MAX_LPC_ORDER ],    /* I    AR coefs for each frame half    */
191     const opus_int32 gains[ MAX_NB_SUBFR ],          /* I    Quantization gains              */
192     const opus_int   subfr_length,                   /* I    Subframe length                 */
193     const opus_int   nb_subfr,                       /* I    Number of subframes             */
194     const opus_int   LPC_order                       /* I    LPC order                       */
195 );
196
197 /* Residual energy: nrg = wxx - 2 * wXx * c + c' * wXX * c */
198 opus_int32 silk_residual_energy16_covar_FIX(
199     const opus_int16                 *c,                 /* I    Prediction vector                           */
200     const opus_int32                 *wXX,               /* I    Correlation matrix                          */
201     const opus_int32                 *wXx,               /* I    Correlation vector                          */
202     opus_int32                       wxx,                /* I    Signal energy                               */
203     opus_int                         D,                  /* I    Dimension                                   */
204     opus_int                         cQ                  /* I    Q value for c vector 0 - 15                 */
205 );
206
207 /* Processing of gains */
208 void silk_process_gains_FIX(
209     silk_encoder_state_FIX          *psEnc,         /* I/O  Encoder state                               */
210     silk_encoder_control_FIX        *psEncCtrl,     /* I/O  Encoder control                             */
211     opus_int                         condCoding     /* I    The type of conditional coding to use       */
212 );
213
214 /******************/
215 /* Linear Algebra */
216 /******************/
217 /* Calculates correlation matrix X'*X */
218 void silk_corrMatrix_FIX(
219     const opus_int16                 *x,         /* I    x vector [L + order - 1] used to form data matrix X */
220     const opus_int                   L,          /* I    Length of vectors                                   */
221     const opus_int                   order,      /* I    Max lag for correlation                             */
222     const opus_int                   head_room,  /* I    Desired headroom                                    */
223     opus_int32                       *XX,        /* O    Pointer to X'*X correlation matrix [ order x order ]*/
224     opus_int                         *rshifts    /* I/O  Right shifts of correlations                        */
225 );
226
227 /* Calculates correlation vector X'*t */
228 void silk_corrVector_FIX(
229     const opus_int16                 *x,         /* I    x vector [L + order - 1] used to form data matrix X */
230     const opus_int16                 *t,         /* I    Target vector [L]                                   */
231     const opus_int                   L,          /* I    Length of vectors                                   */
232     const opus_int                   order,      /* I    Max lag for correlation                             */
233     opus_int32                       *Xt,        /* O    Pointer to X'*t correlation vector [order]          */
234     const opus_int                   rshifts     /* I    Right shifts of correlations                        */
235 );
236
237 /* Add noise to matrix diagonal */
238 void silk_regularize_correlations_FIX(
239     opus_int32                       *XX,                /* I/O  Correlation matrices                        */
240     opus_int32                       *xx,                /* I/O  Correlation values                          */
241     opus_int32                       noise,              /* I    Noise to add                                */
242     opus_int                         D                   /* I    Dimension of XX                             */
243 );
244
245 /* Solves Ax = b, assuming A is symmetric */
246 void silk_solve_LDL_FIX(
247     opus_int32                       *A,                 /* I    Pointer to symetric square matrix A         */
248     opus_int                         M,                  /* I    Size of matrix                              */
249     const opus_int32                 *b,                 /* I    Pointer to b vector                         */
250     opus_int32                       *x_Q16              /* O    Pointer to x solution vector                */
251 );
252
253 #ifndef FORCE_CPP_BUILD
254 #ifdef __cplusplus
255 }
256 #endif /* __cplusplus */
257 #endif /* FORCE_CPP_BUILD */
258 #endif /* SILK_MAIN_FIX_H */