Gitiles
Code Review Sign In
review.jami.net / jami-client-android / ec71b2d0acf6e348a7ebe9386f10fecf10b3b49f / . / jni / libopus / silk / fixed / main_FIX.h
blob: 369b31ee396c84bacb3257f3b17184badf1e221b [file] [log] [blame]
Alexandre Lision744f7422013-09-25 11:39:37 -0400[diff] [blame]1/***********************************************************************
2Copyright (c) 2006-2011, Skype Limited. All rights reserved.
3Redistribution and use in source and binary forms, with or without
4modification, are permitted provided that the following conditions
5are met:
6- Redistributions of source code must retain the above copyright notice,
7this list of conditions and the following disclaimer.
8- Redistributions in binary form must reproduce the above copyright
9notice, this list of conditions and the following disclaimer in the
10documentation and/or other materials provided with the distribution.
11- Neither the name of Internet Society, IETF or IETF Trust, nor the
12names of specific contributors, may be used to endorse or promote
13products derived from this software without specific prior written
14permission.
15THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS”
16AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
19LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25POSSIBILITY 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
41extern "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 */
55void silk_HP_variable_cutoff(
56 silk_encoder_state_Fxx state_Fxx[] /* I/O Encoder states */
57);
58
59/* Encoder main function */
60void 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 */
65opus_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 */
75opus_int silk_init_encoder(
76 silk_encoder_state_Fxx *psEnc /* I/O Pointer to Silk FIX encoder state */
77);
78
79/* Control the Silk encoder */
80opus_int silk_control_encoder(
81 silk_encoder_state_Fxx *psEnc, /* I/O Pointer to Silk encoder state */
82 silk_EncControlStruct *encControl, /* I Control structure */
83 const opus_int32 TargetRate_bps, /* I Target max bitrate (bps) */
84 const opus_int allow_bw_switch, /* I Flag to allow switching audio bandwidth */
85 const opus_int channelNb, /* I Channel number */
86 const opus_int force_fs_kHz
87);
88
89/****************/
90/* Prefiltering */
91/****************/
92void silk_prefilter_FIX(
93 silk_encoder_state_FIX *psEnc, /* I/O Encoder state */
94 const silk_encoder_control_FIX *psEncCtrl, /* I Encoder control */
95 opus_int32 xw_Q10[], /* O Weighted signal */
96 const opus_int16 x[] /* I Speech signal */
97);
98
99/**************************/
100/* Noise shaping analysis */
101/**************************/
102/* Compute noise shaping coefficients and initial gain values */
103void silk_noise_shape_analysis_FIX(
104 silk_encoder_state_FIX *psEnc, /* I/O Encoder state FIX */
105 silk_encoder_control_FIX *psEncCtrl, /* I/O Encoder control FIX */
106 const opus_int16 *pitch_res, /* I LPC residual from pitch analysis */
107 const opus_int16 *x /* I Input signal [ frame_length + la_shape ] */
108);
109
110/* Autocorrelations for a warped frequency axis */
111void silk_warped_autocorrelation_FIX(
112 opus_int32 *corr, /* O Result [order + 1] */
113 opus_int *scale, /* O Scaling of the correlation vector */
114 const opus_int16 *input, /* I Input data to correlate */
115 const opus_int warping_Q16, /* I Warping coefficient */
116 const opus_int length, /* I Length of input */
117 const opus_int order /* I Correlation order (even) */
118);
119
120/* Calculation of LTP state scaling */
121void silk_LTP_scale_ctrl_FIX(
122 silk_encoder_state_FIX *psEnc, /* I/O encoder state */
123 silk_encoder_control_FIX *psEncCtrl, /* I/O encoder control */
124 opus_int condCoding /* I The type of conditional coding to use */
125);
126
127/**********************************************/
128/* Prediction Analysis */
129/**********************************************/
130/* Find pitch lags */
131void silk_find_pitch_lags_FIX(
132 silk_encoder_state_FIX *psEnc, /* I/O encoder state */
133 silk_encoder_control_FIX *psEncCtrl, /* I/O encoder control */
134 opus_int16 res[], /* O residual */
135 const opus_int16 x[] /* I Speech signal */
136);
137
138/* Find LPC and LTP coefficients */
139void silk_find_pred_coefs_FIX(
140 silk_encoder_state_FIX *psEnc, /* I/O encoder state */
141 silk_encoder_control_FIX *psEncCtrl, /* I/O encoder control */
142 const opus_int16 res_pitch[], /* I Residual from pitch analysis */
143 const opus_int16 x[], /* I Speech signal */
144 opus_int condCoding /* I The type of conditional coding to use */
145);
146
147/* LPC analysis */
148void silk_find_LPC_FIX(
149 silk_encoder_state *psEncC, /* I/O Encoder state */
150 opus_int16 NLSF_Q15[], /* O NLSFs */
151 const opus_int16 x[], /* I Input signal */
152 const opus_int32 minInvGain_Q30 /* I Inverse of max prediction gain */
153);
154
155/* LTP analysis */
156void silk_find_LTP_FIX(
157 opus_int16 b_Q14[ MAX_NB_SUBFR * LTP_ORDER ], /* O LTP coefs */
158 opus_int32 WLTP[ MAX_NB_SUBFR * LTP_ORDER * LTP_ORDER ], /* O Weight for LTP quantization */
159 opus_int *LTPredCodGain_Q7, /* O LTP coding gain */
160 const opus_int16 r_lpc[], /* I residual signal after LPC signal + state for first 10 ms */
161 const opus_int lag[ MAX_NB_SUBFR ], /* I LTP lags */
162 const opus_int32 Wght_Q15[ MAX_NB_SUBFR ], /* I weights */
163 const opus_int subfr_length, /* I subframe length */
164 const opus_int nb_subfr, /* I number of subframes */
165 const opus_int mem_offset, /* I number of samples in LTP memory */
166 opus_int corr_rshifts[ MAX_NB_SUBFR ] /* O right shifts applied to correlations */
167);
168
169void silk_LTP_analysis_filter_FIX(
170 opus_int16 *LTP_res, /* O LTP residual signal of length MAX_NB_SUBFR * ( pre_length + subfr_length ) */
171 const opus_int16 *x, /* I Pointer to input signal with at least max( pitchL ) preceding samples */
172 const opus_int16 LTPCoef_Q14[ LTP_ORDER * MAX_NB_SUBFR ],/* I LTP_ORDER LTP coefficients for each MAX_NB_SUBFR subframe */
173 const opus_int pitchL[ MAX_NB_SUBFR ], /* I Pitch lag, one for each subframe */
174 const opus_int32 invGains_Q16[ MAX_NB_SUBFR ], /* I Inverse quantization gains, one for each subframe */
175 const opus_int subfr_length, /* I Length of each subframe */
176 const opus_int nb_subfr, /* I Number of subframes */
177 const opus_int pre_length /* I Length of the preceding samples starting at &x[0] for each subframe */
178);
179
180/* Calculates residual energies of input subframes where all subframes have LPC_order */
181/* of preceding samples */
182void silk_residual_energy_FIX(
183 opus_int32 nrgs[ MAX_NB_SUBFR ], /* O Residual energy per subframe */
184 opus_int nrgsQ[ MAX_NB_SUBFR ], /* O Q value per subframe */
185 const opus_int16 x[], /* I Input signal */
186 opus_int16 a_Q12[ 2 ][ MAX_LPC_ORDER ], /* I AR coefs for each frame half */
187 const opus_int32 gains[ MAX_NB_SUBFR ], /* I Quantization gains */
188 const opus_int subfr_length, /* I Subframe length */
189 const opus_int nb_subfr, /* I Number of subframes */
190 const opus_int LPC_order /* I LPC order */
191);
192
193/* Residual energy: nrg = wxx - 2 * wXx * c + c' * wXX * c */
194opus_int32 silk_residual_energy16_covar_FIX(
195 const opus_int16 *c, /* I Prediction vector */
196 const opus_int32 *wXX, /* I Correlation matrix */
197 const opus_int32 *wXx, /* I Correlation vector */
198 opus_int32 wxx, /* I Signal energy */
199 opus_int D, /* I Dimension */
200 opus_int cQ /* I Q value for c vector 0 - 15 */
201);
202
203/* Processing of gains */
204void silk_process_gains_FIX(
205 silk_encoder_state_FIX *psEnc, /* I/O Encoder state */
206 silk_encoder_control_FIX *psEncCtrl, /* I/O Encoder control */
207 opus_int condCoding /* I The type of conditional coding to use */
208);
209
210/******************/
211/* Linear Algebra */
212/******************/
213/* Calculates correlation matrix X'*X */
214void silk_corrMatrix_FIX(
215 const opus_int16 *x, /* I x vector [L + order - 1] used to form data matrix X */
216 const opus_int L, /* I Length of vectors */
217 const opus_int order, /* I Max lag for correlation */
218 const opus_int head_room, /* I Desired headroom */
219 opus_int32 *XX, /* O Pointer to X'*X correlation matrix [ order x order ] */
220 opus_int *rshifts /* I/O Right shifts of correlations */
221);
222
223/* Calculates correlation vector X'*t */
224void silk_corrVector_FIX(
225 const opus_int16 *x, /* I x vector [L + order - 1] used to form data matrix X */
226 const opus_int16 *t, /* I Target vector [L] */
227 const opus_int L, /* I Length of vectors */
228 const opus_int order, /* I Max lag for correlation */
229 opus_int32 *Xt, /* O Pointer to X'*t correlation vector [order] */
230 const opus_int rshifts /* I Right shifts of correlations */
231);
232
233/* Add noise to matrix diagonal */
234void silk_regularize_correlations_FIX(
235 opus_int32 *XX, /* I/O Correlation matrices */
236 opus_int32 *xx, /* I/O Correlation values */
237 opus_int32 noise, /* I Noise to add */
238 opus_int D /* I Dimension of XX */
239);
240
241/* Solves Ax = b, assuming A is symmetric */
242void silk_solve_LDL_FIX(
243 opus_int32 *A, /* I Pointer to symetric square matrix A */
244 opus_int M, /* I Size of matrix */
245 const opus_int32 *b, /* I Pointer to b vector */
246 opus_int32 *x_Q16 /* O Pointer to x solution vector */
247);
248
249#ifndef FORCE_CPP_BUILD
250#ifdef __cplusplus
251}
252#endif /* __cplusplus */
253#endif /* FORCE_CPP_BUILD */
254#endif /* SILK_MAIN_FIX_H */