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