Many improvements (hopefully) to packet loss concealing, part of it from a
[speexdsp.git] / libspeex / ltp.h
index 2844881..d7f133e 100644 (file)
 /* Copyright (C) 2002 Jean-Marc Valin 
    File: ltp.h
    Lont-Term Prediction functions
+
+   Redistribution and use in source and binary forms, with or without
+   modification, are permitted provided that the following conditions
+   are met:
+   
+   - Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+   
+   - Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+   
+   - Neither the name of the Xiph.org Foundation nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+   
+   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+   ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+   A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
+   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+   PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+   PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
+#include "speex_bits.h"
+
+
+typedef struct ltp_params {
+   float  *gain_cdbk;
+   int     gain_bits;
+   int     pitch_bits;
+} ltp_params;
+
 
-extern float gain_cdbk_nb[];
+void open_loop_nbest_pitch(float *sw, int start, int end, int len, int *pitch, float *gain, int N, void *stack);
 
-/** Computes the open-loop pitch prediction. Returns pitch period and pitch gain */
-int open_loop_ltp(float *x, int len, int start, int end, float *gain);
 
+/** Finds the best quantized 3-tap pitch predictor by analysis by synthesis */
+int pitch_search_3tap(
+float target[],                 /* Target vector */
+float *sw,
+float ak[],                     /* LPCs for this subframe */
+float awk1[],                   /* Weighted LPCs #1 for this subframe */
+float awk2[],                   /* Weighted LPCs #2 for this subframe */
+float exc[],                    /* Overlapping codebook */
+void *par,
+int   start,                    /* Smallest pitch value allowed */
+int   end,                      /* Largest pitch value allowed */
+float pitch_coef,               /* Voicing (pitch) coefficient */
+int   p,                        /* Number of LPC coeffs */
+int   nsf,                      /* Number of samples in subframe */
+SpeexBits *bits,
+void *stack,
+float *exc2,
+float *r,
+int   complexity
+);
 
-/** Computes a 3-tap pitch predictor */
-int three_tap_ltp(float *x, int len, int start, int end, float *gain);
+/*Unquantize adaptive codebook and update pitch contribution*/
+void pitch_unquant_3tap(
+float exc[],                    /* Excitation */
+int   start,                    /* Smallest pitch value allowed */
+int   end,                      /* Largest pitch value allowed */
+float pitch_coef,               /* Voicing (pitch) coefficient */
+void *par,
+int   nsf,                      /* Number of samples in subframe */
+int *pitch_val,
+float *gain_val,
+SpeexBits *bits,
+void *stack,
+int lost,
+int subframe_offset,
+float last_pitch_gain
+);
 
-/** Finds the best 3-tap pitch predictor from a codebook*/
-int ltp_closed_loop(float *x, int len, int start, int end, float *gain);
+float pitch_gain_search_3tap(
+float target[],                 /* Target vector */
+float ak[],                     /* LPCs for this subframe */
+float awk1[],                   /* Weighted LPCs #1 for this subframe */
+float awk2[],                   /* Weighted LPCs #2 for this subframe */
+float exc[],                    /* Excitation */
+void *par,
+int   pitch,                    /* Pitch value */
+int   p,                        /* Number of LPC coeffs */
+int   nsf,                      /* Number of samples in subframe */
+SpeexBits *bits,
+void *stack,
+float *exc2,
+float *r,
+int  *cdbk_index
+);
 
-/** In place 3-tap pitch predictor (FIR)*/
-void predictor_three_tap(float *x, int len, int period, float *gain);
 
+/** Forced pitch delay and gain */
+int forced_pitch_quant(
+float target[],                 /* Target vector */
+float *sw,
+float ak[],                     /* LPCs for this subframe */
+float awk1[],                   /* Weighted LPCs #1 for this subframe */
+float awk2[],                   /* Weighted LPCs #2 for this subframe */
+float exc[],                    /* Excitation */
+void *par,
+int   start,                    /* Smallest pitch value allowed */
+int   end,                      /* Largest pitch value allowed */
+float pitch_coef,               /* Voicing (pitch) coefficient */
+int   p,                        /* Number of LPC coeffs */
+int   nsf,                      /* Number of samples in subframe */
+SpeexBits *bits,
+void *stack,
+float *exc2,
+float *r,
+int complexity
+);
 
-/** In place 3-tap inverse pitch predictor (IIR)*/
-void inverse_three_tap(float *x, int len, int period, float *gain);
+/** Unquantize forced pitch delay and gain */
+void forced_pitch_unquant(
+float exc[],                    /* Excitation */
+int   start,                    /* Smallest pitch value allowed */
+int   end,                      /* Largest pitch value allowed */
+float pitch_coef,               /* Voicing (pitch) coefficient */
+void *par,
+int   nsf,                      /* Number of samples in subframe */
+int *pitch_val,
+float *gain_val,
+SpeexBits *bits,
+void *stack,
+int lost,
+int subframe_offset,
+float last_pitch_gain
+);