2 * adaptive and fixed codebook vector operations for ACELP-based codecs
4 * Copyright (c) 2008 Vladimir Voroshilov
6 * This file is part of FFmpeg.
8 * FFmpeg is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * FFmpeg is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with FFmpeg; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 #ifndef AVCODEC_ACELP_VECTORS_H
24 #define AVCODEC_ACELP_VECTORS_H
28 /** Sparse representation for the algebraic codebook (fixed) vector */
38 * Track|Pulse| Positions
39 * -------------------------------------------------------------------------
40 * 1 | 0 | 0, 5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 65, 70, 75
41 * -------------------------------------------------------------------------
42 * 2 | 1 | 1, 6, 11, 16, 21, 26, 31, 36, 41, 46, 51, 56, 61, 66, 71, 76
43 * -------------------------------------------------------------------------
44 * 3 | 2 | 2, 7, 12, 17, 22, 27, 32, 37, 42, 47, 52, 57, 62, 67, 72, 77
45 * -------------------------------------------------------------------------
47 * Table contains only first the pulse indexes.
49 * Used in G.729 @8k, G.729 @4.4k, AMR @7.95k, AMR @7.40k
51 extern const uint8_t ff_fc_4pulses_8bits_tracks_13[16];
54 * Track|Pulse| Positions
55 * -------------------------------------------------------------------------
56 * 4 | 3 | 3, 8, 13, 18, 23, 28, 33, 38, 43, 48, 53, 58, 63, 68, 73, 78
57 * | | 4, 9, 14, 19, 24, 29, 34, 39, 44, 49, 54, 59, 64, 69, 74, 79
58 * -------------------------------------------------------------------------
60 * @remark Track in the table should be read top-to-bottom, left-to-right.
62 * Used in G.729 @8k, G.729 @4.4k, AMR @7.95k, AMR @7.40k
64 extern const uint8_t ff_fc_4pulses_8bits_track_4[32];
67 * Track|Pulse| Positions
68 * -----------------------------------------
69 * 1 | 0 | 1, 6, 11, 16, 21, 26, 31, 36
70 * | | 3, 8, 13, 18, 23, 28, 33, 38
71 * -----------------------------------------
73 * @remark Track in the table should be read top-to-bottom, left-to-right.
75 * @note (EE) Reference G.729D code also uses gray decoding for each
76 * pulse index before looking up the value in the table.
78 * Used in G.729 @6.4k (with gray coding), AMR @5.9k (without gray coding)
80 extern const uint8_t ff_fc_2pulses_9bits_track1[16];
81 extern const uint8_t ff_fc_2pulses_9bits_track1_gray[16];
84 * Track|Pulse| Positions
85 * -----------------------------------------
86 * 2 | 1 | 0, 7, 14, 20, 27, 34, 1, 21
87 * | | 2, 9, 15, 22, 29, 35, 6, 26
88 * | | 4,10, 17, 24, 30, 37, 11, 31
89 * | | 5,12, 19, 25, 32, 39, 16, 36
90 * -----------------------------------------
92 * @remark Track in the table should be read top-to-bottom, left-to-right.
94 * @note (EE.1) This table (from the reference code) does not comply with
96 * The specification contains the following table:
98 * Track|Pulse| Positions
99 * -----------------------------------------
100 * 2 | 1 | 0, 5, 10, 15, 20, 25, 30, 35
101 * | | 1, 6, 11, 16, 21, 26, 31, 36
102 * | | 2, 7, 12, 17, 22, 27, 32, 37
103 * | | 4, 9, 14, 19, 24, 29, 34, 39
105 * -----------------------------------------
107 * @note (EE.2) Reference G.729D code also uses gray decoding for each
108 * pulse index before looking up the value in the table.
110 * Used in G.729 @6.4k (with gray coding)
112 extern const uint8_t ff_fc_2pulses_9bits_track2_gray[32];
115 * b60 hamming windowed sinc function coefficients
117 extern const float ff_b60_sinc[61];
120 * Table of pow(0.7,n)
122 extern const float ff_pow_0_7[10];
125 * Table of pow(0.75,n)
127 extern const float ff_pow_0_75[10];
130 * Table of pow(0.55,n)
132 extern const float ff_pow_0_55[10];
135 * Decode fixed-codebook vector (3.8 and D.5.8 of G.729, 5.7.1 of AMR).
136 * @param fc_v [out] decoded fixed codebook vector (2.13)
137 * @param tab1 table used for first pulse_count pulses
138 * @param tab2 table used for last pulse
139 * @param pulse_indexes fixed codebook indexes
140 * @param pulse_signs signs of the excitation pulses (0 bit value
141 * means negative sign)
142 * @param bits number of bits per one pulse index
143 * @param pulse_count number of pulses decoded using first table
144 * @param bits length of one pulse index in bits
146 * Used in G.729 @8k, G.729 @4.4k, G.729 @6.4k, AMR @7.95k, AMR @7.40k
148 void ff_acelp_fc_pulse_per_track(int16_t* fc_v,
157 * Decode the algebraic codebook index to pulse positions and signs and
158 * construct the algebraic codebook vector for MODE_12k2.
160 * @note: The positions and signs are explicitly coded in MODE_12k2.
162 * @param fixed_index positions of the ten pulses
163 * @param fixed_sparse pointer to the algebraic codebook vector
164 * @param gray_decode gray decoding table
165 * @param half_pulse_count number of couples of pulses
166 * @param bits length of one pulse index in bits
168 void ff_decode_10_pulses_35bits(const int16_t *fixed_index,
169 AMRFixed *fixed_sparse,
170 const uint8_t *gray_decode,
171 int half_pulse_count, int bits);
175 * weighted sum of two vectors with rounding.
176 * @param out [out] result of addition
177 * @param in_a first vector
178 * @param in_b second vector
179 * @param weight_coeff_a first vector weight coefficient
180 * @param weight_coeff_a second vector weight coefficient
181 * @param rounder this value will be added to the sum of the two vectors
182 * @param shift result will be shifted to right by this value
183 * @param length vectors length
185 * @note It is safe to pass the same buffer for out and in_a or in_b.
187 * out[i] = (in_a[i]*weight_a + in_b[i]*weight_b + rounder) >> shift
189 void ff_acelp_weighted_vector_sum(int16_t* out,
192 int16_t weight_coeff_a,
193 int16_t weight_coeff_b,
199 * float implementation of weighted sum of two vectors.
200 * @param out [out] result of addition
201 * @param in_a first vector
202 * @param in_b second vector
203 * @param weight_coeff_a first vector weight coefficient
204 * @param weight_coeff_a second vector weight coefficient
205 * @param length vectors length
207 * @note It is safe to pass the same buffer for out and in_a or in_b.
209 void ff_weighted_vector_sumf(float *out, const float *in_a, const float *in_b,
210 float weight_coeff_a, float weight_coeff_b,
214 * Adaptative gain control (as used in AMR postfiltering)
216 * @param buf_out the input speech buffer
217 * @param speech_energ input energy
218 * @param size the input buffer size
219 * @param alpha exponential filter factor
220 * @param gain_mem a pointer to the filter memory (single float of size)
222 void ff_adaptative_gain_control(float *buf_out, float speech_energ,
223 int size, float alpha, float *gain_mem);
226 * Set the sum of squares of a signal by scaling
228 * @param out output samples
229 * @param in input samples
230 * @param sum_of_squares new sum of squares
231 * @param n number of samples
233 * @note If the input is zero (or its energy underflows), the output is zero.
234 * This is the behavior of AGC in the AMR reference decoder. The QCELP
235 * reference decoder seems to have undefined behavior.
237 * TIA/EIA/IS-733 2.4.8.3-2/3/4/5, 2.4.8.6
238 * 3GPP TS 26.090 6.1 (6)
240 void ff_scale_vector_to_given_sum_of_squares(float *out, const float *in,
241 float sum_of_squares, const int n);
244 * Add fixed vector to an array from a sparse representation
246 * @param out fixed vector with pitch sharpening
247 * @param in sparse fixed vector
248 * @param scale number to multiply the fixed vector by
249 * @param size the output vector size
251 void ff_set_fixed_vector(float *out, const AMRFixed *in, float scale, int size);
254 * Clear array values set by set_fixed_vector
256 * @param out fixed vector to be cleared
257 * @param in sparse fixed vector
258 * @param size the output vector size
260 void ff_clear_fixed_vector(float *out, const AMRFixed *in, int size);
262 #endif /* AVCODEC_ACELP_VECTORS_H */