libavcodec/acelp_filters.h

   1 /*
   2  * various filters 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_FILTERS_H
  24 #define FFMPEG_ACELP_FILTERS_H
  25
  26 #include <stdint.h>
  27
  28 /**
  29  * low-pass Finite Impulse Response filter coefficients.
  30  *
  31  * Hamming windowed sinc filter with cutoff freq 3/40 of the sampling freq,
  32  * the coefficients are scaled by 2^15.
  33  * This array only contains the right half of the filter.
  34  * This filter is likely identical to the one used in G.729, though this
  35  * could not be determined from the original comments with certainity.
  36  */
  37 extern const int16_t ff_acelp_interp_filter[61];
  38
  39 /**
  40  * Generic interpolation routine.
  41  * @param out [out] buffer for interpolated data
  42  * @param in input data
  43  * @param filter_coeffs interpolation filter coefficients (0.15)
  44  * @param precision filter is able to interpolate with 1/precision precision of pitch delay
  45  * @param pitch_delay_frac pitch delay, fractional part [0..precision-1]
  46  * @param filter_length filter length
  47  * @param length length of output
  48  *
  49  * filter_coeffs contains coefficients of the right half of the symmetric
  50  * interpolation filter. filter_coeffs[0] should the central (unpaired) coefficient.
  51  * See ff_acelp_interp_filter for an example.
  52  *
  53  */
  54 void ff_acelp_interpolate(
  55         int16_t* out,
  56         const int16_t* in,
  57         const int16_t* filter_coeffs,
  58         int precision,
  59         int pitch_delay_frac,
  60         int filter_length,
  61         int length);
  62
  63 /**
  64  * Circularly convolve fixed vector with a phase dispersion impulse
  65  *        response filter (D.6.2 of G.729 and 6.1.5 of AMR).
  66  * @param fc_out vector with filter applied
  67  * @param fc_in source vector
  68  * @param filter phase filter coefficients
  69  *
  70  *  fc_out[n] = sum(i,0,len-1){ fc_in[i] * filter[(len + n - i)%len] }
  71  *
  72  * \note fc_in and fc_out should not overlap!
  73  */
  74 void ff_acelp_convolve_circ(
  75         int16_t* fc_out,
  76         const int16_t* fc_in,
  77         const int16_t* filter,
  78         int subframe_size);
  79
  80 /**
  81  * LP synthesis filter.
  82  * @param out [out] pointer to output buffer
  83  * @param filter_coeffs filter coefficients (-0x8000 <= (3.12) < 0x8000)
  84  * @param in input signal
  85  * @param buffer_length amount of data to process
  86  * @param filter_length filter length (10 for 10th order LP filter)
  87  * @param stop_on_overflow   1 - return immediately if overflow occurs
  88  *                           0 - ignore overflows
  89  * @param rounder the amount to add for rounding (usually 0x800 or 0xfff)
  90  *
  91  * @return 1 if overflow occurred, 0 - otherwise
  92  *
  93  * @note Output buffer must contain 10 samples of past
  94  *       speech data before pointer.
  95  *
  96  * Routine applies 1/A(z) filter to given speech data.
  97  */
  98 int ff_acelp_lp_synthesis_filter(
  99         int16_t *out,
 100         const int16_t* filter_coeffs,
 101         const int16_t* in,
 102         int buffer_length,
 103         int filter_length,
 104         int stop_on_overflow,
 105         int rounder);
 106
 107 /**
 108  * Calculates coefficients of weighted A(z/weight) filter.
 109  * @param out [out] weighted A(z/weight) result
 110  *                  filter (-0x8000 <= (3.12) < 0x8000)
 111  * @param in source filter (-0x8000 <= (3.12) < 0x8000)
 112  * @param weight_pow array containing weight^i (-0x8000 <= (0.15) < 0x8000)
 113  * @param filter_length filter length (11 for 10th order LP filter)
 114  *
 115  * out[i]=weight_pow[i]*in[i] , i=0..9
 116  */
 117 void ff_acelp_weighted_filter(
 118         int16_t *out,
 119         const int16_t* in,
 120         const int16_t *weight_pow,
 121         int filter_length);
 122
 123 /**
 124  * high-pass filtering and upscaling (4.2.5 of G.729).
 125  * @param out [out] output buffer for filtered speech data
 126  * @param hpf_f [in/out] past filtered data from previous (2 items long)
 127  *                       frames (-0x20000000 <= (14.13) < 0x20000000)
 128  * @param in speech data to process
 129  * @param length input data size
 130  *
 131  * out[i] = 0.93980581 * in[i] - 1.8795834 * in[i-1] + 0.93980581 * in[i-2] +
 132  *          1.9330735 * out[i-1] - 0.93589199 * out[i-2]
 133  *
 134  * The filter has a cut-off frequency of 100Hz
 135  *
 136  * @note Two items before the top of the out buffer must contain two items from the
 137  *       tail of the previous subframe.
 138  *
 139  * @remark It is safe to pass the same array in in and out parameters.
 140  *
 141  * @remark AMR uses mostly the same filter (cut-off frequency 60Hz, same formula,
 142  *         but constants differs in 5th sign after comma). Fortunately in
 143  *         fixed-point all coefficients are the same as in G.729. Thus this
 144  *         routine can be used for the fixed-point AMR decoder, too.
 145  */
 146 void ff_acelp_high_pass_filter(
 147         int16_t* out,
 148         int hpf_f[2],
 149         const int16_t* in,
 150         int length);
 151
 152 #endif /* FFMPEG_ACELP_FILTERS_H */