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