Starting (still incomplete) average bit-rate (ABR) implementation
[speexdsp.git] / libspeex / ltp.h
1 /* Copyright (C) 2002 Jean-Marc Valin 
2    File: ltp.h
3    Lont-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_bits.h"
34
35
36 typedef struct ltp_params {
37    float  *gain_cdbk;
38    int     gain_bits;
39    int     pitch_bits;
40 } ltp_params;
41
42
43 void open_loop_nbest_pitch(float *sw, int start, int end, int len, int *pitch, float *gain, int N, void *stack);
44
45
46 /** Finds the best quantized 3-tap pitch predictor by analysis by synthesis */
47 int pitch_search_3tap(
48 float target[],                 /* Target vector */
49 float *sw,
50 float ak[],                     /* LPCs for this subframe */
51 float awk1[],                   /* Weighted LPCs #1 for this subframe */
52 float awk2[],                   /* Weighted LPCs #2 for this subframe */
53 float exc[],                    /* Overlapping codebook */
54 void *par,
55 int   start,                    /* Smallest pitch value allowed */
56 int   end,                      /* Largest pitch value allowed */
57 float pitch_coef,               /* Voicing (pitch) coefficient */
58 int   p,                        /* Number of LPC coeffs */
59 int   nsf,                      /* Number of samples in subframe */
60 SpeexBits *bits,
61 void *stack,
62 float *exc2,
63 float *r,
64 int   complexity
65 );
66
67 /*Unquantize adaptive codebook and update pitch contribution*/
68 void pitch_unquant_3tap(
69 float exc[],                    /* Excitation */
70 int   start,                    /* Smallest pitch value allowed */
71 int   end,                      /* Largest pitch value allowed */
72 float pitch_coef,               /* Voicing (pitch) coefficient */
73 void *par,
74 int   nsf,                      /* Number of samples in subframe */
75 int *pitch_val,
76 float *gain_val,
77 SpeexBits *bits,
78 void *stack,
79 int lost,
80 int subframe_offset,
81 float last_pitch_gain
82 );
83
84 float pitch_gain_search_3tap(
85 float target[],                 /* Target vector */
86 float ak[],                     /* LPCs for this subframe */
87 float awk1[],                   /* Weighted LPCs #1 for this subframe */
88 float awk2[],                   /* Weighted LPCs #2 for this subframe */
89 float exc[],                    /* Excitation */
90 void *par,
91 int   pitch,                    /* Pitch value */
92 int   p,                        /* Number of LPC coeffs */
93 int   nsf,                      /* Number of samples in subframe */
94 SpeexBits *bits,
95 void *stack,
96 float *exc2,
97 float *r,
98 int  *cdbk_index
99 );
100
101
102 /** Forced pitch delay and gain */
103 int forced_pitch_quant(
104 float target[],                 /* Target vector */
105 float *sw,
106 float ak[],                     /* LPCs for this subframe */
107 float awk1[],                   /* Weighted LPCs #1 for this subframe */
108 float awk2[],                   /* Weighted LPCs #2 for this subframe */
109 float exc[],                    /* Excitation */
110 void *par,
111 int   start,                    /* Smallest pitch value allowed */
112 int   end,                      /* Largest pitch value allowed */
113 float pitch_coef,               /* Voicing (pitch) coefficient */
114 int   p,                        /* Number of LPC coeffs */
115 int   nsf,                      /* Number of samples in subframe */
116 SpeexBits *bits,
117 void *stack,
118 float *exc2,
119 float *r,
120 int complexity
121 );
122
123 /** Unquantize forced pitch delay and gain */
124 void forced_pitch_unquant(
125 float exc[],                    /* Excitation */
126 int   start,                    /* Smallest pitch value allowed */
127 int   end,                      /* Largest pitch value allowed */
128 float pitch_coef,               /* Voicing (pitch) coefficient */
129 void *par,
130 int   nsf,                      /* Number of samples in subframe */
131 int *pitch_val,
132 float *gain_val,
133 SpeexBits *bits,
134 void *stack,
135 int lost,
136 int subframe_offset,
137 float last_pitch_gain
138 );