ffv1dec: support decoding older 1.3 bitstream variant
[ffmpeg.git] / libavcodec / acelp_vectors.h
index 2cc5f36..d92f288 100644 (file)
 
 #include <stdint.h>
 
+typedef struct ACELPVContext {
+    /**
+     * 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 (should be a multiple of two)
+     *
+     * @note It is safe to pass the same buffer for out and in_a or in_b.
+     */
+    void (*weighted_vector_sumf)(float *out, const float *in_a, const float *in_b,
+                                 float weight_coeff_a, float weight_coeff_b,
+                                 int length);
+
+}ACELPVContext;
+
+/**
+ * Initialize ACELPVContext.
+ */
+void ff_acelp_vectors_init(ACELPVContext *c);
+void ff_acelp_vectors_init_mips(ACELPVContext *c);
+
 /** Sparse representation for the algebraic codebook (fixed) vector */
 typedef struct {
     int      n;
@@ -47,7 +71,7 @@ typedef struct {
  *
  * Table contains only first the pulse indexes.
  *
- * Used in G.729 @8k, G.729 @4.4k, AMR @7.95k, AMR @7.40k
+ * Used in G.729 @@8k, G.729 @@4.4k, AMR @@7.95k, AMR @@7.40k
  */
 extern const uint8_t ff_fc_4pulses_8bits_tracks_13[16];
 
@@ -60,7 +84,7 @@ extern const uint8_t ff_fc_4pulses_8bits_tracks_13[16];
  *
  * @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
+ * 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];
 
@@ -76,7 +100,7 @@ extern const uint8_t ff_fc_4pulses_8bits_track_4[32];
  * @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)
+ * 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];
@@ -108,7 +132,7 @@ extern const uint8_t ff_fc_2pulses_9bits_track1_gray[16];
  * @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)
+ * Used in G.729 @@6.4k (with gray coding)
  */
 extern const uint8_t ff_fc_2pulses_9bits_track2_gray[32];
 
@@ -134,7 +158,7 @@ extern const float ff_pow_0_55[10];
 
 /**
  * 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[out] fc_v 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
@@ -144,7 +168,7 @@ extern const float ff_pow_0_55[10];
  * @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
+ * Used in G.729 @@8k, G.729 @@4.4k, G.729 @@6.4k, AMR @@7.95k, AMR @@7.40k
  */
 void ff_acelp_fc_pulse_per_track(int16_t* fc_v,
                                  const uint8_t *tab1,
@@ -174,7 +198,7 @@ void ff_decode_10_pulses_35bits(const int16_t *fixed_index,
 
 /**
  * weighted sum of two vectors with rounding.
- * @param out [out] result of addition
+ * @param[out] out result of addition
  * @param in_a first vector
  * @param in_b second vector
  * @param weight_coeff_a first vector weight coefficient
@@ -198,7 +222,7 @@ void ff_acelp_weighted_vector_sum(int16_t* out,
 
 /**
  * float implementation of weighted sum of two vectors.
- * @param out [out] result of addition
+ * @param[out] out result of addition
  * @param in_a first vector
  * @param in_b second vector
  * @param weight_coeff_a first vector weight coefficient
@@ -212,16 +236,17 @@ void ff_weighted_vector_sumf(float *out, const float *in_a, const float *in_b,
                              int length);
 
 /**
- * Adaptative gain control (as used in AMR postfiltering)
+ * Adaptive gain control (as used in AMR postfiltering)
  *
- * @param buf_out the input speech buffer
+ * @param out output buffer for filtered speech data
+ * @param in the input speech buffer (may be the same as out)
  * @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);
+void ff_adaptive_gain_control(float *out, const float *in, float speech_energ,
+                              int size, float alpha, float *gain_mem);
 
 /**
  * Set the sum of squares of a signal by scaling