consistency cosmetics: indices --> indexes
[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 FFMPEG_ACELP_VECTORS_H
24 #define FFMPEG_ACELP_VECTORS_H
25
26 /*
27  * Track|Pulse|        Positions
28  * -------------------------------------------------------------------------
29  *  1   | 0   | 0, 5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 65, 70, 75
30  * -------------------------------------------------------------------------
31  *  2   | 1   | 1, 6, 11, 16, 21, 26, 31, 36, 41, 46, 51, 56, 61, 66, 71, 76
32  * -------------------------------------------------------------------------
33  *  3   | 2   | 2, 7, 12, 17, 22, 27, 32, 37, 42, 47, 52, 57, 62, 67, 72, 77
34  * -------------------------------------------------------------------------
35  *
36  * Table contains only first the pulse indexes.
37  *
38  * Used in G.729 @8k, G.729 @4.4k, AMR @7.95k, AMR @7.40k
39  */
40 extern const uint8_t ff_fc_4pulses_8bits_tracks_13[16];
41
42 /*
43  * Track|Pulse|        Positions
44  * -------------------------------------------------------------------------
45  *  4   | 3   | 3, 8, 13, 18, 23, 28, 33, 38, 43, 48, 53, 58, 63, 68, 73, 78
46  *      |     | 4, 9, 14, 19, 24, 29, 34, 39, 44, 49, 54, 59, 64, 69, 74, 79
47  * -------------------------------------------------------------------------
48  *
49  * \remark Track in the table should be read top-to-bottom, left-to-right.
50  *
51  * Used in G.729 @8k, G.729 @4.4k, AMR @7.95k, AMR @7.40k
52  */
53 extern const uint8_t ff_fc_4pulses_8bits_track_4[32];
54
55 /*
56  * Track|Pulse|        Positions
57  * -----------------------------------------
58  *  1   | 0   | 1, 6, 11, 16, 21, 26, 31, 36
59  *      |     | 3, 8, 13, 18, 23, 28, 33, 38
60  * -----------------------------------------
61  *
62  * \remark Track in the table should be read top-to-bottom, left-to-right.
63  *
64  * \note (EE) Reference G.729D code also uses gray decoding for each
65  *            pulse index before looking up the value in the table.
66  *
67  * Used in G.729 @6.4k (with gray coding), AMD @5.9k (without gray coding)
68  */
69 extern const uint8_t ff_fc_2pulses_9bits_track1[16];
70 extern const uint8_t ff_fc_2pulses_9bits_track1_gray[16];
71
72 /*
73  * Track|Pulse|        Positions
74  * -----------------------------------------
75  *  2   | 1   | 0, 7, 14, 20, 27, 34,  1, 21
76  *      |     | 2, 9, 15, 22, 29, 35,  6, 26
77  *      |     | 4,10, 17, 24, 30, 37, 11, 31
78  *      |     | 5,12, 19, 25, 32, 39, 16, 36
79  * -----------------------------------------
80  *
81  * \remark Track in the table should be read top-to-bottom, left-to-right.
82  *
83  * \note (EE.1) This table (from the reference code) does not comply with
84  *              the specification.
85  *              The specification contains the following table:
86  *
87  * Track|Pulse|        Positions
88  * -----------------------------------------
89  *  2   | 1   | 0, 5, 10, 15, 20, 25, 30, 35
90  *      |     | 1, 6, 11, 16, 21, 26, 31, 36
91  *      |     | 2, 7, 12, 17, 22, 27, 32, 37
92  *      |     | 4, 9, 14, 19, 24, 29, 34, 39
93  *
94  * -----------------------------------------
95  *
96  * \note (EE.2) Reference G.729D code also uses gray decoding for each
97  *              pulse index before looking up the value in the table.
98  *
99  * Used in G.729 @6.4k (with gray coding)
100  */
101 extern const uint8_t ff_fc_2pulses_9bits_track2_gray[32];
102
103 /**
104  * \brief Decode fixed-codebook vector (3.8 and D.5.8 of G.729, 5.7.1 of AMR).
105  * \param fc_v [out] decoded fixed codebook vector (2.13)
106  * \param tab1 table used for first pulse_count pulses
107  * \param tab2 table used for last pulse
108  * \param pulse_indices fixed codebook indexes
109  * \param pulse_signs signs of the excitation pulses (0 bit value
110  *                     means negative sign)
111  * \param bits number of bits per one pulse index
112  * \param pulse_count number of pulses decoded using first table
113  * \param bits length of one pulse index in bits
114  *
115  * Used in G.729 @8k, G.729 @4.4k, G.729 @6.4k, AMR @7.95k, AMR @7.40k
116  */
117 void ff_acelp_fc_pulse_per_track(
118         int16_t* fc_v,
119         const uint8_t *tab1,
120         const uint8_t *tab2,
121         int pulse_indices,
122         int pulse_signs,
123         int pulse_count,
124         int bits);
125
126 /**
127  * \brief weighted sum of two vectors with rounding
128  * \param out [out] result of addition
129  * \param in_a first vector
130  * \param in_b second vector
131  * \param weight_coeff_a first vector weight coefficient
132  * \param weight_coeff_a second vector weight coefficient
133  * \param rounder this value will be added to the sum of the two vectors
134  * \param shift result will be shifted to right by this value
135  * \param length vectors length
136  *
137  * \note It is safe to pass the same buffer for out and in_a or in_b.
138  *
139  *  out[i] = (in_a[i]*weight_a+in_b[i]*weight_b+rounder) >> shift
140  */
141 void ff_acelp_weighted_vector_sum(
142         int16_t* out,
143         const int16_t *in_a,
144         const int16_t *in_b,
145         int16_t weight_coeff_a,
146         int16_t weight_coeff_b,
147         int16_t rounder,
148         int shift,
149         int length);
150
151 #endif /* FFMPEG_ACELP_VECTORS_H */