Gitiles
Code Review Sign In
review.jami.net / jami-client-android / 4df961d4cc4bdcad3facefc72cb399329593545c / . / jni / libopus / silk / main.h
blob: 32675f693100c0f67277f2bca7393c749c8601a7 [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_H
29#define SILK_MAIN_H
30
31#include "SigProc_FIX.h"
32#include "define.h"
33#include "structs.h"
34#include "tables.h"
35#include "PLC.h"
36#include "control.h"
37#include "debug.h"
38#include "entenc.h"
39#include "entdec.h"
40
41/* Convert Left/Right stereo signal to adaptive Mid/Side representation */
42void silk_stereo_LR_to_MS(
43 stereo_enc_state *state, /* I/O State */
44 opus_int16 x1[], /* I/O Left input signal, becomes mid signal */
45 opus_int16 x2[], /* I/O Right input signal, becomes side signal */
46 opus_int8 ix[ 2 ][ 3 ], /* O Quantization indices */
47 opus_int8 *mid_only_flag, /* O Flag: only mid signal coded */
48 opus_int32 mid_side_rates_bps[], /* O Bitrates for mid and side signals */
49 opus_int32 total_rate_bps, /* I Total bitrate */
50 opus_int prev_speech_act_Q8, /* I Speech activity level in previous frame */
51 opus_int toMono, /* I Last frame before a stereo->mono transition */
52 opus_int fs_kHz, /* I Sample rate (kHz) */
53 opus_int frame_length /* I Number of samples */
54);
55
56/* Convert adaptive Mid/Side representation to Left/Right stereo signal */
57void silk_stereo_MS_to_LR(
58 stereo_dec_state *state, /* I/O State */
59 opus_int16 x1[], /* I/O Left input signal, becomes mid signal */
60 opus_int16 x2[], /* I/O Right input signal, becomes side signal */
61 const opus_int32 pred_Q13[], /* I Predictors */
62 opus_int fs_kHz, /* I Samples rate (kHz) */
63 opus_int frame_length /* I Number of samples */
64);
65
66/* Find least-squares prediction gain for one signal based on another and quantize it */
67opus_int32 silk_stereo_find_predictor( /* O Returns predictor in Q13 */
68 opus_int32 *ratio_Q14, /* O Ratio of residual and mid energies */
69 const opus_int16 x[], /* I Basis signal */
70 const opus_int16 y[], /* I Target signal */
71 opus_int32 mid_res_amp_Q0[], /* I/O Smoothed mid, residual norms */
72 opus_int length, /* I Number of samples */
73 opus_int smooth_coef_Q16 /* I Smoothing coefficient */
74);
75
76/* Quantize mid/side predictors */
77void silk_stereo_quant_pred(
78 opus_int32 pred_Q13[], /* I/O Predictors (out: quantized) */
79 opus_int8 ix[ 2 ][ 3 ] /* O Quantization indices */
80);
81
82/* Entropy code the mid/side quantization indices */
83void silk_stereo_encode_pred(
84 ec_enc *psRangeEnc, /* I/O Compressor data structure */
85 opus_int8 ix[ 2 ][ 3 ] /* I Quantization indices */
86);
87
88/* Entropy code the mid-only flag */
89void silk_stereo_encode_mid_only(
90 ec_enc *psRangeEnc, /* I/O Compressor data structure */
91 opus_int8 mid_only_flag
92);
93
94/* Decode mid/side predictors */
95void silk_stereo_decode_pred(
96 ec_dec *psRangeDec, /* I/O Compressor data structure */
97 opus_int32 pred_Q13[] /* O Predictors */
98);
99
100/* Decode mid-only flag */
101void silk_stereo_decode_mid_only(
102 ec_dec *psRangeDec, /* I/O Compressor data structure */
103 opus_int *decode_only_mid /* O Flag that only mid channel has been coded */
104);
105
106/* Encodes signs of excitation */
107void silk_encode_signs(
108 ec_enc *psRangeEnc, /* I/O Compressor data structure */
109 const opus_int8 pulses[], /* I pulse signal */
110 opus_int length, /* I length of input */
111 const opus_int signalType, /* I Signal type */
112 const opus_int quantOffsetType, /* I Quantization offset type */
113 const opus_int sum_pulses[ MAX_NB_SHELL_BLOCKS ] /* I Sum of absolute pulses per block */
114);
115
116/* Decodes signs of excitation */
117void silk_decode_signs(
118 ec_dec *psRangeDec, /* I/O Compressor data structure */
119 opus_int pulses[], /* I/O pulse signal */
120 opus_int length, /* I length of input */
121 const opus_int signalType, /* I Signal type */
122 const opus_int quantOffsetType, /* I Quantization offset type */
123 const opus_int sum_pulses[ MAX_NB_SHELL_BLOCKS ] /* I Sum of absolute pulses per block */
124);
125
126/* Check encoder control struct */
127opus_int check_control_input(
128 silk_EncControlStruct *encControl /* I Control structure */
129);
130
131/* Control internal sampling rate */
132opus_int silk_control_audio_bandwidth(
133 silk_encoder_state *psEncC, /* I/O Pointer to Silk encoder state */
134 silk_EncControlStruct *encControl /* I Control structure */
135);
136
137/* Control SNR of redidual quantizer */
138opus_int silk_control_SNR(
139 silk_encoder_state *psEncC, /* I/O Pointer to Silk encoder state */
140 opus_int32 TargetRate_bps /* I Target max bitrate (bps) */
141);
142
143/***************/
144/* Shell coder */
145/***************/
146
147/* Encode quantization indices of excitation */
148void silk_encode_pulses(
149 ec_enc *psRangeEnc, /* I/O compressor data structure */
150 const opus_int signalType, /* I Signal type */
151 const opus_int quantOffsetType, /* I quantOffsetType */
152 opus_int8 pulses[], /* I quantization indices */
153 const opus_int frame_length /* I Frame length */
154);
155
156/* Shell encoder, operates on one shell code frame of 16 pulses */
157void silk_shell_encoder(
158 ec_enc *psRangeEnc, /* I/O compressor data structure */
159 const opus_int *pulses0 /* I data: nonnegative pulse amplitudes */
160);
161
162/* Shell decoder, operates on one shell code frame of 16 pulses */
163void silk_shell_decoder(
164 opus_int *pulses0, /* O data: nonnegative pulse amplitudes */
165 ec_dec *psRangeDec, /* I/O Compressor data structure */
166 const opus_int pulses4 /* I number of pulses per pulse-subframe */
167);
168
169/* Gain scalar quantization with hysteresis, uniform on log scale */
170void silk_gains_quant(
171 opus_int8 ind[ MAX_NB_SUBFR ], /* O gain indices */
172 opus_int32 gain_Q16[ MAX_NB_SUBFR ], /* I/O gains (quantized out) */
173 opus_int8 *prev_ind, /* I/O last index in previous frame */
174 const opus_int conditional, /* I first gain is delta coded if 1 */
175 const opus_int nb_subfr /* I number of subframes */
176);
177
178/* Gains scalar dequantization, uniform on log scale */
179void silk_gains_dequant(
180 opus_int32 gain_Q16[ MAX_NB_SUBFR ], /* O quantized gains */
181 const opus_int8 ind[ MAX_NB_SUBFR ], /* I gain indices */
182 opus_int8 *prev_ind, /* I/O last index in previous frame */
183 const opus_int conditional, /* I first gain is delta coded if 1 */
184 const opus_int nb_subfr /* I number of subframes */
185);
186
187/* Compute unique identifier of gain indices vector */
188opus_int32 silk_gains_ID( /* O returns unique identifier of gains */
189 const opus_int8 ind[ MAX_NB_SUBFR ], /* I gain indices */
190 const opus_int nb_subfr /* I number of subframes */
191);
192
193/* Interpolate two vectors */
194void silk_interpolate(
195 opus_int16 xi[ MAX_LPC_ORDER ], /* O interpolated vector */
196 const opus_int16 x0[ MAX_LPC_ORDER ], /* I first vector */
197 const opus_int16 x1[ MAX_LPC_ORDER ], /* I second vector */
198 const opus_int ifact_Q2, /* I interp. factor, weight on 2nd vector */
199 const opus_int d /* I number of parameters */
200);
201
202/* LTP tap quantizer */
203void silk_quant_LTP_gains(
204 opus_int16 B_Q14[ MAX_NB_SUBFR * LTP_ORDER ], /* I/O (un)quantized LTP gains */
205 opus_int8 cbk_index[ MAX_NB_SUBFR ], /* O Codebook Index */
206 opus_int8 *periodicity_index, /* O Periodicity Index */
207 const opus_int32 W_Q18[ MAX_NB_SUBFR*LTP_ORDER*LTP_ORDER ], /* I Error Weights in Q18 */
208 opus_int mu_Q9, /* I Mu value (R/D tradeoff) */
209 opus_int lowComplexity, /* I Flag for low complexity */
210 const opus_int nb_subfr /* I number of subframes */
211);
212
213/* Entropy constrained matrix-weighted VQ, for a single input data vector */
214void silk_VQ_WMat_EC(
215 opus_int8 *ind, /* O index of best codebook vector */
216 opus_int32 *rate_dist_Q14, /* O best weighted quant error + mu * rate */
217 const opus_int16 *in_Q14, /* I input vector to be quantized */
218 const opus_int32 *W_Q18, /* I weighting matrix */
219 const opus_int8 *cb_Q7, /* I codebook */
220 const opus_uint8 *cl_Q5, /* I code length for each codebook vector */
221 const opus_int mu_Q9, /* I tradeoff betw. weighted error and rate */
222 opus_int L /* I number of vectors in codebook */
223);
224
225/************************************/
226/* Noise shaping quantization (NSQ) */
227/************************************/
228void silk_NSQ(
229 const silk_encoder_state *psEncC, /* I/O Encoder State */
230 silk_nsq_state *NSQ, /* I/O NSQ state */
231 SideInfoIndices *psIndices, /* I/O Quantization Indices */
232 const opus_int32 x_Q3[], /* I Prefiltered input signal */
233 opus_int8 pulses[], /* O Quantized pulse signal */
234 const opus_int16 PredCoef_Q12[ 2 * MAX_LPC_ORDER ], /* I Short term prediction coefs */
235 const opus_int16 LTPCoef_Q14[ LTP_ORDER * MAX_NB_SUBFR ], /* I Long term prediction coefs */
236 const opus_int16 AR2_Q13[ MAX_NB_SUBFR * MAX_SHAPE_LPC_ORDER ], /* I Noise shaping coefs */
237 const opus_int HarmShapeGain_Q14[ MAX_NB_SUBFR ], /* I Long term shaping coefs */
238 const opus_int Tilt_Q14[ MAX_NB_SUBFR ], /* I Spectral tilt */
239 const opus_int32 LF_shp_Q14[ MAX_NB_SUBFR ], /* I Low frequency shaping coefs */
240 const opus_int32 Gains_Q16[ MAX_NB_SUBFR ], /* I Quantization step sizes */
241 const opus_int pitchL[ MAX_NB_SUBFR ], /* I Pitch lags */
242 const opus_int Lambda_Q10, /* I Rate/distortion tradeoff */
243 const opus_int LTP_scale_Q14 /* I LTP state scaling */
244);
245
246/* Noise shaping using delayed decision */
247void silk_NSQ_del_dec(
248 const silk_encoder_state *psEncC, /* I/O Encoder State */
249 silk_nsq_state *NSQ, /* I/O NSQ state */
250 SideInfoIndices *psIndices, /* I/O Quantization Indices */
251 const opus_int32 x_Q3[], /* I Prefiltered input signal */
252 opus_int8 pulses[], /* O Quantized pulse signal */
253 const opus_int16 PredCoef_Q12[ 2 * MAX_LPC_ORDER ], /* I Short term prediction coefs */
254 const opus_int16 LTPCoef_Q14[ LTP_ORDER * MAX_NB_SUBFR ], /* I Long term prediction coefs */
255 const opus_int16 AR2_Q13[ MAX_NB_SUBFR * MAX_SHAPE_LPC_ORDER ], /* I Noise shaping coefs */
256 const opus_int HarmShapeGain_Q14[ MAX_NB_SUBFR ], /* I Long term shaping coefs */
257 const opus_int Tilt_Q14[ MAX_NB_SUBFR ], /* I Spectral tilt */
258 const opus_int32 LF_shp_Q14[ MAX_NB_SUBFR ], /* I Low frequency shaping coefs */
259 const opus_int32 Gains_Q16[ MAX_NB_SUBFR ], /* I Quantization step sizes */
260 const opus_int pitchL[ MAX_NB_SUBFR ], /* I Pitch lags */
261 const opus_int Lambda_Q10, /* I Rate/distortion tradeoff */
262 const opus_int LTP_scale_Q14 /* I LTP state scaling */
263);
264
265/************/
266/* Silk VAD */
267/************/
268/* Initialize the Silk VAD */
269opus_int silk_VAD_Init( /* O Return value, 0 if success */
270 silk_VAD_state *psSilk_VAD /* I/O Pointer to Silk VAD state */
271);
272
273/* Get speech activity level in Q8 */
274opus_int silk_VAD_GetSA_Q8( /* O Return value, 0 if success */
275 silk_encoder_state *psEncC, /* I/O Encoder state */
276 const opus_int16 pIn[] /* I PCM input */
277);
278
279/* Low-pass filter with variable cutoff frequency based on */
280/* piece-wise linear interpolation between elliptic filters */
281/* Start by setting transition_frame_no = 1; */
282void silk_LP_variable_cutoff(
283 silk_LP_state *psLP, /* I/O LP filter state */
284 opus_int16 *frame, /* I/O Low-pass filtered output signal */
285 const opus_int frame_length /* I Frame length */
286);
287
288/******************/
289/* NLSF Quantizer */
290/******************/
291/* Limit, stabilize, convert and quantize NLSFs */
292void silk_process_NLSFs(
293 silk_encoder_state *psEncC, /* I/O Encoder state */
294 opus_int16 PredCoef_Q12[ 2 ][ MAX_LPC_ORDER ], /* O Prediction coefficients */
295 opus_int16 pNLSF_Q15[ MAX_LPC_ORDER ], /* I/O Normalized LSFs (quant out) (0 - (2^15-1)) */
296 const opus_int16 prev_NLSFq_Q15[ MAX_LPC_ORDER ] /* I Previous Normalized LSFs (0 - (2^15-1)) */
297);
298
299opus_int32 silk_NLSF_encode( /* O Returns RD value in Q25 */
300 opus_int8 *NLSFIndices, /* I Codebook path vector [ LPC_ORDER + 1 ] */
301 opus_int16 *pNLSF_Q15, /* I/O Quantized NLSF vector [ LPC_ORDER ] */
302 const silk_NLSF_CB_struct *psNLSF_CB, /* I Codebook object */
303 const opus_int16 *pW_QW, /* I NLSF weight vector [ LPC_ORDER ] */
304 const opus_int NLSF_mu_Q20, /* I Rate weight for the RD optimization */
305 const opus_int nSurvivors, /* I Max survivors after first stage */
306 const opus_int signalType /* I Signal type: 0/1/2 */
307);
308
309/* Compute quantization errors for an LPC_order element input vector for a VQ codebook */
310void silk_NLSF_VQ(
311 opus_int32 err_Q26[], /* O Quantization errors [K] */
312 const opus_int16 in_Q15[], /* I Input vectors to be quantized [LPC_order] */
313 const opus_uint8 pCB_Q8[], /* I Codebook vectors [K*LPC_order] */
314 const opus_int K, /* I Number of codebook vectors */
315 const opus_int LPC_order /* I Number of LPCs */
316);
317
318/* Delayed-decision quantizer for NLSF residuals */
319opus_int32 silk_NLSF_del_dec_quant( /* O Returns RD value in Q25 */
320 opus_int8 indices[], /* O Quantization indices [ order ] */
321 const opus_int16 x_Q10[], /* I Input [ order ] */
322 const opus_int16 w_Q5[], /* I Weights [ order ] */
323 const opus_uint8 pred_coef_Q8[], /* I Backward predictor coefs [ order ] */
324 const opus_int16 ec_ix[], /* I Indices to entropy coding tables [ order ] */
325 const opus_uint8 ec_rates_Q5[], /* I Rates [] */
326 const opus_int quant_step_size_Q16, /* I Quantization step size */
327 const opus_int16 inv_quant_step_size_Q6, /* I Inverse quantization step size */
328 const opus_int32 mu_Q20, /* I R/D tradeoff */
329 const opus_int16 order /* I Number of input values */
330);
331
332/* Unpack predictor values and indices for entropy coding tables */
333void silk_NLSF_unpack(
334 opus_int16 ec_ix[], /* O Indices to entropy tables [ LPC_ORDER ] */
335 opus_uint8 pred_Q8[], /* O LSF predictor [ LPC_ORDER ] */
336 const silk_NLSF_CB_struct *psNLSF_CB, /* I Codebook object */
337 const opus_int CB1_index /* I Index of vector in first LSF codebook */
338);
339
340/***********************/
341/* NLSF vector decoder */
342/***********************/
343void silk_NLSF_decode(
344 opus_int16 *pNLSF_Q15, /* O Quantized NLSF vector [ LPC_ORDER ] */
345 opus_int8 *NLSFIndices, /* I Codebook path vector [ LPC_ORDER + 1 ] */
346 const silk_NLSF_CB_struct *psNLSF_CB /* I Codebook object */
347);
348
349/****************************************************/
350/* Decoder Functions */
351/****************************************************/
352opus_int silk_init_decoder(
353 silk_decoder_state *psDec /* I/O Decoder state pointer */
354);
355
356/* Set decoder sampling rate */
357opus_int silk_decoder_set_fs(
358 silk_decoder_state *psDec, /* I/O Decoder state pointer */
359 opus_int fs_kHz, /* I Sampling frequency (kHz) */
360 opus_int32 fs_API_Hz /* I API Sampling frequency (Hz) */
361);
362
363/****************/
364/* Decode frame */
365/****************/
366opus_int silk_decode_frame(
367 silk_decoder_state *psDec, /* I/O Pointer to Silk decoder state */
368 ec_dec *psRangeDec, /* I/O Compressor data structure */
369 opus_int16 pOut[], /* O Pointer to output speech frame */
370 opus_int32 *pN, /* O Pointer to size of output frame */
371 opus_int lostFlag, /* I 0: no loss, 1 loss, 2 decode fec */
372 opus_int condCoding /* I The type of conditional coding to use */
373);
374
375/* Decode indices from bitstream */
376void silk_decode_indices(
377 silk_decoder_state *psDec, /* I/O State */
378 ec_dec *psRangeDec, /* I/O Compressor data structure */
379 opus_int FrameIndex, /* I Frame number */
380 opus_int decode_LBRR, /* I Flag indicating LBRR data is being decoded */
381 opus_int condCoding /* I The type of conditional coding to use */
382);
383
384/* Decode parameters from payload */
385void silk_decode_parameters(
386 silk_decoder_state *psDec, /* I/O State */
387 silk_decoder_control *psDecCtrl, /* I/O Decoder control */
388 opus_int condCoding /* I The type of conditional coding to use */
389);
390
391/* Core decoder. Performs inverse NSQ operation LTP + LPC */
392void silk_decode_core(
393 silk_decoder_state *psDec, /* I/O Decoder state */
394 silk_decoder_control *psDecCtrl, /* I Decoder control */
395 opus_int16 xq[], /* O Decoded speech */
396 const opus_int pulses[ MAX_FRAME_LENGTH ] /* I Pulse signal */
397);
398
399/* Decode quantization indices of excitation (Shell coding) */
400void silk_decode_pulses(
401 ec_dec *psRangeDec, /* I/O Compressor data structure */
402 opus_int pulses[], /* O Excitation signal */
403 const opus_int signalType, /* I Sigtype */
404 const opus_int quantOffsetType, /* I quantOffsetType */
405 const opus_int frame_length /* I Frame length */
406);
407
408/******************/
409/* CNG */
410/******************/
411
412/* Reset CNG */
413void silk_CNG_Reset(
414 silk_decoder_state *psDec /* I/O Decoder state */
415);
416
417/* Updates CNG estimate, and applies the CNG when packet was lost */
418void silk_CNG(
419 silk_decoder_state *psDec, /* I/O Decoder state */
420 silk_decoder_control *psDecCtrl, /* I/O Decoder control */
421 opus_int16 frame[], /* I/O Signal */
422 opus_int length /* I Length of residual */
423);
424
425/* Encoding of various parameters */
426void silk_encode_indices(
427 silk_encoder_state *psEncC, /* I/O Encoder state */
428 ec_enc *psRangeEnc, /* I/O Compressor data structure */
429 opus_int FrameIndex, /* I Frame number */
430 opus_int encode_LBRR, /* I Flag indicating LBRR data is being encoded */
431 opus_int condCoding /* I The type of conditional coding to use */
432);
433
434#endif