gst-libs/ext/ffmpeg/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      no_repeat_mask;
  34     int      pitch_lag;
  35     float    pitch_fac;
  36 } AMRFixed;
  37
  38 /**
  39  * Track|Pulse|        Positions
  40  * -------------------------------------------------------------------------
  41  *  1   | 0   | 0, 5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 65, 70, 75
  42  * -------------------------------------------------------------------------
  43  *  2   | 1   | 1, 6, 11, 16, 21, 26, 31, 36, 41, 46, 51, 56, 61, 66, 71, 76
  44  * -------------------------------------------------------------------------
  45  *  3   | 2   | 2, 7, 12, 17, 22, 27, 32, 37, 42, 47, 52, 57, 62, 67, 72, 77
  46  * -------------------------------------------------------------------------
  47  *
  48  * Table contains only first the pulse indexes.
  49  *
  50  * Used in G.729 @8k, G.729 @4.4k, AMR @7.95k, AMR @7.40k
  51  */
  52 extern const uint8_t ff_fc_4pulses_8bits_tracks_13[16];
  53
  54 /**
  55  * Track|Pulse|        Positions
  56  * -------------------------------------------------------------------------
  57  *  4   | 3   | 3, 8, 13, 18, 23, 28, 33, 38, 43, 48, 53, 58, 63, 68, 73, 78
  58  *      |     | 4, 9, 14, 19, 24, 29, 34, 39, 44, 49, 54, 59, 64, 69, 74, 79
  59  * -------------------------------------------------------------------------
  60  *
  61  * @remark Track in the table should be read top-to-bottom, left-to-right.
  62  *
  63  * Used in G.729 @8k, G.729 @4.4k, AMR @7.95k, AMR @7.40k
  64  */
  65 extern const uint8_t ff_fc_4pulses_8bits_track_4[32];
  66
  67 /**
  68  * Track|Pulse|        Positions
  69  * -----------------------------------------
  70  *  1   | 0   | 1, 6, 11, 16, 21, 26, 31, 36
  71  *      |     | 3, 8, 13, 18, 23, 28, 33, 38
  72  * -----------------------------------------
  73  *
  74  * @remark Track in the table should be read top-to-bottom, left-to-right.
  75  *
  76  * @note (EE) Reference G.729D code also uses gray decoding for each
  77  *            pulse index before looking up the value in the table.
  78  *
  79  * Used in G.729 @6.4k (with gray coding), AMR @5.9k (without gray coding)
  80  */
  81 extern const uint8_t ff_fc_2pulses_9bits_track1[16];
  82 extern const uint8_t ff_fc_2pulses_9bits_track1_gray[16];
  83
  84 /**
  85  * Track|Pulse|        Positions
  86  * -----------------------------------------
  87  *  2   | 1   | 0, 7, 14, 20, 27, 34,  1, 21
  88  *      |     | 2, 9, 15, 22, 29, 35,  6, 26
  89  *      |     | 4,10, 17, 24, 30, 37, 11, 31
  90  *      |     | 5,12, 19, 25, 32, 39, 16, 36
  91  * -----------------------------------------
  92  *
  93  * @remark Track in the table should be read top-to-bottom, left-to-right.
  94  *
  95  * @note (EE.1) This table (from the reference code) does not comply with
  96  *              the specification.
  97  *              The specification contains the following table:
  98  *
  99  * Track|Pulse|        Positions
 100  * -----------------------------------------
 101  *  2   | 1   | 0, 5, 10, 15, 20, 25, 30, 35
 102  *      |     | 1, 6, 11, 16, 21, 26, 31, 36
 103  *      |     | 2, 7, 12, 17, 22, 27, 32, 37
 104  *      |     | 4, 9, 14, 19, 24, 29, 34, 39
 105  *
 106  * -----------------------------------------
 107  *
 108  * @note (EE.2) Reference G.729D code also uses gray decoding for each
 109  *              pulse index before looking up the value in the table.
 110  *
 111  * Used in G.729 @6.4k (with gray coding)
 112  */
 113 extern const uint8_t ff_fc_2pulses_9bits_track2_gray[32];
 114
 115 /**
 116  * b60 hamming windowed sinc function coefficients
 117  */
 118 extern const float ff_b60_sinc[61];
 119
 120 /**
 121  * Table of pow(0.7,n)
 122  */
 123 extern const float ff_pow_0_7[10];
 124
 125 /**
 126  * Table of pow(0.75,n)
 127  */
 128 extern const float ff_pow_0_75[10];
 129
 130 /**
 131  * Table of pow(0.55,n)
 132  */
 133 extern const float ff_pow_0_55[10];
 134
 135 /**
 136  * Decode fixed-codebook vector (3.8 and D.5.8 of G.729, 5.7.1 of AMR).
 137  * @param fc_v [out] decoded fixed codebook vector (2.13)
 138  * @param tab1 table used for first pulse_count pulses
 139  * @param tab2 table used for last pulse
 140  * @param pulse_indexes fixed codebook indexes
 141  * @param pulse_signs signs of the excitation pulses (0 bit value
 142  *                     means negative sign)
 143  * @param bits number of bits per one pulse index
 144  * @param pulse_count number of pulses decoded using first table
 145  * @param bits length of one pulse index in bits
 146  *
 147  * Used in G.729 @8k, G.729 @4.4k, G.729 @6.4k, AMR @7.95k, AMR @7.40k
 148  */
 149 void ff_acelp_fc_pulse_per_track(int16_t* fc_v,
 150                                  const uint8_t *tab1,
 151                                  const uint8_t *tab2,
 152                                  int pulse_indexes,
 153                                  int pulse_signs,
 154                                  int pulse_count,
 155                                  int bits);
 156
 157 /**
 158  * Decode the algebraic codebook index to pulse positions and signs and
 159  * construct the algebraic codebook vector for MODE_12k2.
 160  *
 161  * @note: The positions and signs are explicitly coded in MODE_12k2.
 162  *
 163  * @param fixed_index          positions of the ten pulses
 164  * @param fixed_sparse         pointer to the algebraic codebook vector
 165  * @param gray_decode          gray decoding table
 166  * @param half_pulse_count     number of couples of pulses
 167  * @param bits                 length of one pulse index in bits
 168  */
 169 void ff_decode_10_pulses_35bits(const int16_t *fixed_index,
 170                                 AMRFixed *fixed_sparse,
 171                                 const uint8_t *gray_decode,
 172                                 int half_pulse_count, int bits);
 173
 174
 175 /**
 176  * weighted sum of two vectors with rounding.
 177  * @param out [out] result of addition
 178  * @param in_a first vector
 179  * @param in_b second vector
 180  * @param weight_coeff_a first vector weight coefficient
 181  * @param weight_coeff_a second vector weight coefficient
 182  * @param rounder this value will be added to the sum of the two vectors
 183  * @param shift result will be shifted to right by this value
 184  * @param length vectors length
 185  *
 186  * @note It is safe to pass the same buffer for out and in_a or in_b.
 187  *
 188  *  out[i] = (in_a[i]*weight_a + in_b[i]*weight_b + rounder) >> shift
 189  */
 190 void ff_acelp_weighted_vector_sum(int16_t* out,
 191                                   const int16_t *in_a,
 192                                   const int16_t *in_b,
 193                                   int16_t weight_coeff_a,
 194                                   int16_t weight_coeff_b,
 195                                   int16_t rounder,
 196                                   int shift,
 197                                   int length);
 198
 199 /**
 200  * float implementation of weighted sum of two vectors.
 201  * @param out [out] result of addition
 202  * @param in_a first vector
 203  * @param in_b second vector
 204  * @param weight_coeff_a first vector weight coefficient
 205  * @param weight_coeff_a second vector weight coefficient
 206  * @param length vectors length
 207  *
 208  * @note It is safe to pass the same buffer for out and in_a or in_b.
 209  */
 210 void ff_weighted_vector_sumf(float *out, const float *in_a, const float *in_b,
 211                              float weight_coeff_a, float weight_coeff_b,
 212                              int length);
 213
 214 /**
 215  * Adaptive gain control (as used in AMR postfiltering)
 216  *
 217  * @param out output buffer for filtered speech data
 218  * @param in the input speech buffer (may be the same as out)
 219  * @param speech_energ input energy
 220  * @param size the input buffer size
 221  * @param alpha exponential filter factor
 222  * @param gain_mem a pointer to the filter memory (single float of size)
 223  */
 224 void ff_adaptive_gain_control(float *out, const float *in, float speech_energ,
 225                               int size, float alpha, float *gain_mem);
 226
 227 /**
 228  * Set the sum of squares of a signal by scaling
 229  *
 230  * @param out output samples
 231  * @param in input samples
 232  * @param sum_of_squares new sum of squares
 233  * @param n number of samples
 234  *
 235  * @note If the input is zero (or its energy underflows), the output is zero.
 236  *       This is the behavior of AGC in the AMR reference decoder. The QCELP
 237  *       reference decoder seems to have undefined behavior.
 238  *
 239  * TIA/EIA/IS-733 2.4.8.3-2/3/4/5, 2.4.8.6
 240  * 3GPP TS 26.090 6.1 (6)
 241  */
 242 void ff_scale_vector_to_given_sum_of_squares(float *out, const float *in,
 243                                              float sum_of_squares, const int n);
 244
 245 /**
 246  * Add fixed vector to an array from a sparse representation
 247  *
 248  * @param out fixed vector with pitch sharpening
 249  * @param in sparse fixed vector
 250  * @param scale number to multiply the fixed vector by
 251  * @param size the output vector size
 252  */
 253 void ff_set_fixed_vector(float *out, const AMRFixed *in, float scale, int size);
 254
 255 /**
 256  * Clear array values set by set_fixed_vector
 257  *
 258  * @param out fixed vector to be cleared
 259  * @param in sparse fixed vector
 260  * @param size the output vector size
 261  */
 262 void ff_clear_fixed_vector(float *out, const AMRFixed *in, int size);
 263
 264 #endif /* AVCODEC_ACELP_VECTORS_H */