* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
-#ifndef FFMPEG_ACELP_VECTORS_H
-#define FFMPEG_ACELP_VECTORS_H
+#ifndef AVCODEC_ACELP_VECTORS_H
+#define AVCODEC_ACELP_VECTORS_H
#include <stdint.h>
-/*
+/**
* Track|Pulse| Positions
* -------------------------------------------------------------------------
* 1 | 0 | 0, 5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 65, 70, 75
*/
extern const uint8_t ff_fc_4pulses_8bits_tracks_13[16];
-/*
+/**
* Track|Pulse| Positions
* -------------------------------------------------------------------------
* 4 | 3 | 3, 8, 13, 18, 23, 28, 33, 38, 43, 48, 53, 58, 63, 68, 73, 78
* | | 4, 9, 14, 19, 24, 29, 34, 39, 44, 49, 54, 59, 64, 69, 74, 79
* -------------------------------------------------------------------------
*
- * \remark Track in the table should be read top-to-bottom, left-to-right.
+ * @remark Track in the table should be read top-to-bottom, left-to-right.
*
* Used in G.729 @8k, G.729 @4.4k, AMR @7.95k, AMR @7.40k
*/
extern const uint8_t ff_fc_4pulses_8bits_track_4[32];
-/*
+/**
* Track|Pulse| Positions
* -----------------------------------------
* 1 | 0 | 1, 6, 11, 16, 21, 26, 31, 36
* | | 3, 8, 13, 18, 23, 28, 33, 38
* -----------------------------------------
*
- * \remark Track in the table should be read top-to-bottom, left-to-right.
+ * @remark Track in the table should be read top-to-bottom, left-to-right.
*
- * \note (EE) Reference G.729D code also uses gray decoding for each
+ * @note (EE) Reference G.729D code also uses gray decoding for each
* pulse index before looking up the value in the table.
*
* Used in G.729 @6.4k (with gray coding), AMR @5.9k (without gray coding)
extern const uint8_t ff_fc_2pulses_9bits_track1[16];
extern const uint8_t ff_fc_2pulses_9bits_track1_gray[16];
-/*
+/**
* Track|Pulse| Positions
* -----------------------------------------
* 2 | 1 | 0, 7, 14, 20, 27, 34, 1, 21
* | | 5,12, 19, 25, 32, 39, 16, 36
* -----------------------------------------
*
- * \remark Track in the table should be read top-to-bottom, left-to-right.
+ * @remark Track in the table should be read top-to-bottom, left-to-right.
*
- * \note (EE.1) This table (from the reference code) does not comply with
+ * @note (EE.1) This table (from the reference code) does not comply with
* the specification.
* The specification contains the following table:
*
*
* -----------------------------------------
*
- * \note (EE.2) Reference G.729D code also uses gray decoding for each
+ * @note (EE.2) Reference G.729D code also uses gray decoding for each
* pulse index before looking up the value in the table.
*
* Used in G.729 @6.4k (with gray coding)
extern const uint8_t ff_fc_2pulses_9bits_track2_gray[32];
/**
- * \brief Decode fixed-codebook vector (3.8 and D.5.8 of G.729, 5.7.1 of AMR).
- * \param fc_v [out] decoded fixed codebook vector (2.13)
- * \param tab1 table used for first pulse_count pulses
- * \param tab2 table used for last pulse
- * \param pulse_indexes fixed codebook indexes
- * \param pulse_signs signs of the excitation pulses (0 bit value
+ * Decode fixed-codebook vector (3.8 and D.5.8 of G.729, 5.7.1 of AMR).
+ * @param fc_v [out] decoded fixed codebook vector (2.13)
+ * @param tab1 table used for first pulse_count pulses
+ * @param tab2 table used for last pulse
+ * @param pulse_indexes fixed codebook indexes
+ * @param pulse_signs signs of the excitation pulses (0 bit value
* means negative sign)
- * \param bits number of bits per one pulse index
- * \param pulse_count number of pulses decoded using first table
- * \param bits length of one pulse index in bits
+ * @param bits number of bits per one pulse index
+ * @param pulse_count number of pulses decoded using first table
+ * @param bits length of one pulse index in bits
*
* Used in G.729 @8k, G.729 @4.4k, G.729 @6.4k, AMR @7.95k, AMR @7.40k
*/
int bits);
/**
- * \brief weighted sum of two vectors with rounding
- * \param out [out] result of addition
- * \param in_a first vector
- * \param in_b second vector
- * \param weight_coeff_a first vector weight coefficient
- * \param weight_coeff_a second vector weight coefficient
- * \param rounder this value will be added to the sum of the two vectors
- * \param shift result will be shifted to right by this value
- * \param length vectors length
- *
- * \note It is safe to pass the same buffer for out and in_a or in_b.
- *
- * out[i] = (in_a[i]*weight_a+in_b[i]*weight_b+rounder) >> shift
+ * weighted sum of two vectors with rounding.
+ * @param out [out] result of addition
+ * @param in_a first vector
+ * @param in_b second vector
+ * @param weight_coeff_a first vector weight coefficient
+ * @param weight_coeff_a second vector weight coefficient
+ * @param rounder this value will be added to the sum of the two vectors
+ * @param shift result will be shifted to right by this value
+ * @param length vectors length
+ *
+ * @note It is safe to pass the same buffer for out and in_a or in_b.
+ *
+ * out[i] = (in_a[i]*weight_a + in_b[i]*weight_b + rounder) >> shift
*/
void ff_acelp_weighted_vector_sum(
int16_t* out,
int shift,
int length);
-#endif /* FFMPEG_ACELP_VECTORS_H */
+/**
+ * float implementation of weighted sum of two vectors.
+ * @param out [out] result of addition
+ * @param in_a first vector
+ * @param in_b second vector
+ * @param weight_coeff_a first vector weight coefficient
+ * @param weight_coeff_a second vector weight coefficient
+ * @param length vectors length
+ *
+ * @note It is safe to pass the same buffer for out and in_a or in_b.
+ */
+void ff_weighted_vector_sumf(float *out, const float *in_a, const float *in_b,
+ float weight_coeff_a, float weight_coeff_b, int length);
+
+/**
+ * Adaptative gain control (as used in AMR postfiltering)
+ *
+ * @param buf_out the input speech buffer
+ * @param speech_energ input energy
+ * @param size the input buffer size
+ * @param alpha exponential filter factor
+ * @param gain_mem a pointer to the filter memory (single float of size)
+ */
+void ff_adaptative_gain_control(float *buf_out, float speech_energ,
+ int size, float alpha, float *gain_mem);
+
+#endif /* AVCODEC_ACELP_VECTORS_H */