decoder excitation now in 16-bit precision (was 32), which saves quite a bit
[speexdsp.git] / libspeex / ltp.h
1 /* Copyright (C) 2002 Jean-Marc Valin */
2 /**
3    @file ltp.h
4    @brief Long-Term Prediction functions
5 */
6 /*
7    Redistribution and use in source and binary forms, with or without
8    modification, are permitted provided that the following conditions
9    are met:
10    
11    - Redistributions of source code must retain the above copyright
12    notice, this list of conditions and the following disclaimer.
13    
14    - Redistributions in binary form must reproduce the above copyright
15    notice, this list of conditions and the following disclaimer in the
16    documentation and/or other materials provided with the distribution.
17    
18    - Neither the name of the Xiph.org Foundation nor the names of its
19    contributors may be used to endorse or promote products derived from
20    this software without specific prior written permission.
21    
22    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
26    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
27    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
28    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
29    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 */
34
35 #include <speex/speex_bits.h>
36 #include "misc.h"
37
38 /** LTP parameters. */
39 typedef struct {
40    const signed char *gain_cdbk;
41    int     gain_bits;
42    int     pitch_bits;
43 } ltp_params;
44
45 #ifdef FIXED_POINT
46 #define gain_3tap_to_1tap(g) (ABS(g[1]) + (g[0]>0 ? g[0] : -SHR16(g[0],1)) + (g[2]>0 ? g[2] : -SHR16(g[2],1)))
47 #else
48 #define gain_3tap_to_1tap(g) (ABS(g[1]) + (g[0]>0 ? g[0] : -.5*g[0]) + (g[2]>0 ? g[2] : -.5*g[2]))
49 #endif
50
51 spx_word32_t inner_prod(const spx_word16_t *x, const spx_word16_t *y, int len);
52 void pitch_xcorr(const spx_word16_t *_x, const spx_word16_t *_y, spx_word32_t *corr, int len, int nb_pitch, char *stack);
53
54 void open_loop_nbest_pitch(spx_word16_t *sw, int start, int end, int len, int *pitch, spx_word16_t *gain, int N, char *stack);
55
56
57 /** Finds the best quantized 3-tap pitch predictor by analysis by synthesis */
58 int pitch_search_3tap(
59 spx_sig_t target[],                 /* Target vector */
60 spx_word16_t *sw,
61 spx_coef_t ak[],                     /* LPCs for this subframe */
62 spx_coef_t awk1[],                   /* Weighted LPCs #1 for this subframe */
63 spx_coef_t awk2[],                   /* Weighted LPCs #2 for this subframe */
64 spx_sig_t exc[],                    /* Overlapping codebook */
65 const void *par,
66 int   start,                    /* Smallest pitch value allowed */
67 int   end,                      /* Largest pitch value allowed */
68 spx_word16_t pitch_coef,               /* Voicing (pitch) coefficient */
69 int   p,                        /* Number of LPC coeffs */
70 int   nsf,                      /* Number of samples in subframe */
71 SpeexBits *bits,
72 char *stack,
73 spx_sig_t *exc2,
74 spx_word16_t *r,
75 int   complexity,
76 int   cdbk_offset,
77 int plc_tuning
78 );
79
80 /*Unquantize adaptive codebook and update pitch contribution*/
81 void pitch_unquant_3tap(
82 spx_word16_t exc[],             /* Input excitation */
83 spx_word32_t exc_out[],         /* Output excitation */
84 int   start,                    /* Smallest pitch value allowed */
85 int   end,                      /* Largest pitch value allowed */
86 spx_word16_t pitch_coef,        /* Voicing (pitch) coefficient */
87 const void *par,
88 int   nsf,                      /* Number of samples in subframe */
89 int *pitch_val,
90 spx_word16_t *gain_val,
91 SpeexBits *bits,
92 char *stack,
93 int lost,
94 int subframe_offset,
95 spx_word16_t last_pitch_gain,
96 int cdbk_offset
97 );
98
99 /** Forced pitch delay and gain */
100 int forced_pitch_quant(
101 spx_sig_t target[],                 /* Target vector */
102 spx_word16_t *sw,
103 spx_coef_t ak[],                     /* LPCs for this subframe */
104 spx_coef_t awk1[],                   /* Weighted LPCs #1 for this subframe */
105 spx_coef_t awk2[],                   /* Weighted LPCs #2 for this subframe */
106 spx_sig_t exc[],                    /* Excitation */
107 const void *par,
108 int   start,                    /* Smallest pitch value allowed */
109 int   end,                      /* Largest pitch value allowed */
110 spx_word16_t pitch_coef,               /* Voicing (pitch) coefficient */
111 int   p,                        /* Number of LPC coeffs */
112 int   nsf,                      /* Number of samples in subframe */
113 SpeexBits *bits,
114 char *stack,
115 spx_sig_t *exc2,
116 spx_word16_t *r,
117 int complexity,
118 int cdbk_offset,
119 int plc_tuning
120 );
121
122 /** Unquantize forced pitch delay and gain */
123 void forced_pitch_unquant(
124 spx_word16_t exc[],             /* Input excitation */
125 spx_word32_t exc_out[],         /* Output excitation */
126 int   start,                    /* Smallest pitch value allowed */
127 int   end,                      /* Largest pitch value allowed */
128 spx_word16_t pitch_coef,        /* Voicing (pitch) coefficient */
129 const void *par,
130 int   nsf,                      /* Number of samples in subframe */
131 int *pitch_val,
132 spx_word16_t *gain_val,
133 SpeexBits *bits,
134 char *stack,
135 int lost,
136 int subframe_offset,
137 spx_word16_t last_pitch_gain,
138 int cdbk_offset
139 );