Commit functions used by both AMRNB and SIPR
[ffmpeg.git] / libavcodec / acelp_vectors.h
1 /*
2  * adaptive and fixed codebook vector operations for ACELP-based codecs
3  *
4  * Copyright (c) 2008 Vladimir Voroshilov
5  *
6  * This file is part of FFmpeg.
7  *
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.
12  *
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.
17  *
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
21  */
22
23 #ifndef AVCODEC_ACELP_VECTORS_H
24 #define AVCODEC_ACELP_VECTORS_H
25
26 #include <stdint.h>
27
28 /** Sparse representation for the algebraic codebook (fixed) vector */
29 typedef struct {
30     int      n;
31     int      x[10];
32     float    y[10];
33     int      pitch_lag;
34     float    pitch_fac;
35 } AMRFixed;
36
37 /**
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  * -------------------------------------------------------------------------
46  *
47  * Table contains only first the pulse indexes.
48  *
49  * Used in G.729 @8k, G.729 @4.4k, AMR @7.95k, AMR @7.40k
50  */
51 extern const uint8_t ff_fc_4pulses_8bits_tracks_13[16];
52
53 /**
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  * -------------------------------------------------------------------------
59  *
60  * @remark Track in the table should be read top-to-bottom, left-to-right.
61  *
62  * Used in G.729 @8k, G.729 @4.4k, AMR @7.95k, AMR @7.40k
63  */
64 extern const uint8_t ff_fc_4pulses_8bits_track_4[32];
65
66 /**
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  * -----------------------------------------
72  *
73  * @remark Track in the table should be read top-to-bottom, left-to-right.
74  *
75  * @note (EE) Reference G.729D code also uses gray decoding for each
76  *            pulse index before looking up the value in the table.
77  *
78  * Used in G.729 @6.4k (with gray coding), AMR @5.9k (without gray coding)
79  */
80 extern const uint8_t ff_fc_2pulses_9bits_track1[16];
81 extern const uint8_t ff_fc_2pulses_9bits_track1_gray[16];
82
83 /**
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  * -----------------------------------------
91  *
92  * @remark Track in the table should be read top-to-bottom, left-to-right.
93  *
94  * @note (EE.1) This table (from the reference code) does not comply with
95  *              the specification.
96  *              The specification contains the following table:
97  *
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
104  *
105  * -----------------------------------------
106  *
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.
109  *
110  * Used in G.729 @6.4k (with gray coding)
111  */
112 extern const uint8_t ff_fc_2pulses_9bits_track2_gray[32];
113
114 /**
115  * Decode fixed-codebook vector (3.8 and D.5.8 of G.729, 5.7.1 of AMR).
116  * @param fc_v [out] decoded fixed codebook vector (2.13)
117  * @param tab1 table used for first pulse_count pulses
118  * @param tab2 table used for last pulse
119  * @param pulse_indexes fixed codebook indexes
120  * @param pulse_signs signs of the excitation pulses (0 bit value
121  *                     means negative sign)
122  * @param bits number of bits per one pulse index
123  * @param pulse_count number of pulses decoded using first table
124  * @param bits length of one pulse index in bits
125  *
126  * Used in G.729 @8k, G.729 @4.4k, G.729 @6.4k, AMR @7.95k, AMR @7.40k
127  */
128 void ff_acelp_fc_pulse_per_track(
129         int16_t* fc_v,
130         const uint8_t *tab1,
131         const uint8_t *tab2,
132         int pulse_indexes,
133         int pulse_signs,
134         int pulse_count,
135         int bits);
136
137 /**
138  * Decode the algebraic codebook index to pulse positions and signs and
139  * construct the algebraic codebook vector for MODE_12k2.
140  *
141  * @note: The positions and signs are explicitly coded in MODE_12k2.
142  *
143  * @param fixed_index          positions of the ten pulses
144  * @param fixed_sparse         pointer to the algebraic codebook vector
145  * @param gray_decode          gray decoding table
146  * @param half_pulse_count     number of couples of pulses
147  * @param bits                 length of one pulse index in bits
148  */
149 void ff_decode_10_pulses_35bits(const int16_t *fixed_index,
150                                 AMRFixed *fixed_sparse,
151                                 const uint8_t *gray_decode,
152                                 int half_pulse_count, int bits);
153
154
155 /**
156  * weighted sum of two vectors with rounding.
157  * @param out [out] result of addition
158  * @param in_a first vector
159  * @param in_b second vector
160  * @param weight_coeff_a first vector weight coefficient
161  * @param weight_coeff_a second vector weight coefficient
162  * @param rounder this value will be added to the sum of the two vectors
163  * @param shift result will be shifted to right by this value
164  * @param length vectors length
165  *
166  * @note It is safe to pass the same buffer for out and in_a or in_b.
167  *
168  *  out[i] = (in_a[i]*weight_a + in_b[i]*weight_b + rounder) >> shift
169  */
170 void ff_acelp_weighted_vector_sum(
171         int16_t* out,
172         const int16_t *in_a,
173         const int16_t *in_b,
174         int16_t weight_coeff_a,
175         int16_t weight_coeff_b,
176         int16_t rounder,
177         int shift,
178         int length);
179
180 /**
181  * float implementation of weighted sum of two vectors.
182  * @param out [out] result of addition
183  * @param in_a first vector
184  * @param in_b second vector
185  * @param weight_coeff_a first vector weight coefficient
186  * @param weight_coeff_a second vector weight coefficient
187  * @param length vectors length
188  *
189  * @note It is safe to pass the same buffer for out and in_a or in_b.
190  */
191 void ff_weighted_vector_sumf(float *out, const float *in_a, const float *in_b,
192                              float weight_coeff_a, float weight_coeff_b, int length);
193
194 /**
195  * Adaptative gain control (as used in AMR postfiltering)
196  *
197  * @param buf_out the input speech buffer
198  * @param speech_energ input energy
199  * @param size the input buffer size
200  * @param alpha exponential filter factor
201  * @param gain_mem a pointer to the filter memory (single float of size)
202  */
203 void ff_adaptative_gain_control(float *buf_out, float speech_energ,
204                                 int size, float alpha, float *gain_mem);
205
206 /**
207  * Set the sum of squares of a signal by scaling
208  *
209  * @param out output samples
210  * @param in input samples
211  * @param sum_of_squares new sum of squares
212  * @param n number of samples
213  *
214  * @note If the input is zero (or its energy underflows), the output is zero.
215  *       This is the behavior of AGC in the AMR reference decoder. The QCELP
216  *       reference decoder seems to have undefined behavior.
217  *
218  * TIA/EIA/IS-733 2.4.8.3-2/3/4/5, 2.4.8.6
219  * 3GPP TS 26.090 6.1 (6)
220  */
221 void ff_scale_vector_to_given_sum_of_squares(float *out, const float *in,
222                                              float sum_of_squares, const int n);
223
224 /**
225  * Add fixed vector to an array from a sparse representation
226  *
227  * @param out fixed vector with pitch sharpening
228  * @param in sparse fixed vector
229  * @param scale number to multiply the fixed vector by
230  * @param size the output vector size
231  */
232 void ff_set_fixed_vector(float *out, const AMRFixed *in, float scale, int size);
233
234 /**
235  * Clear array values set by set_fixed_vector
236  *
237  * @param out fixed vector to be cleared
238  * @param in sparse fixed vector
239  * @param size the output vector size
240  */
241 void ff_clear_fixed_vector(float *out, const AMRFixed *in, int size);
242
243 #endif /* AVCODEC_ACELP_VECTORS_H */