Vector quantisation of the residual (copied from Ghost/ceft)
[opus.git] / libcelt / bands.c
1 /* (C) 2007 Jean-Marc Valin, CSIRO
2 */
3 /*
4    Redistribution and use in source and binary forms, with or without
5    modification, are permitted provided that the following conditions
6    are met:
7    
8    - Redistributions of source code must retain the above copyright
9    notice, this list of conditions and the following disclaimer.
10    
11    - Redistributions in binary form must reproduce the above copyright
12    notice, this list of conditions and the following disclaimer in the
13    documentation and/or other materials provided with the distribution.
14    
15    - Neither the name of the Xiph.org Foundation nor the names of its
16    contributors may be used to endorse or promote products derived from
17    this software without specific prior written permission.
18    
19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
23    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 #include <math.h>
33 #include "bands.h"
34 #include "vq.h"
35
36 const int qbank[NBANDS+2] =   {0, 2, 4, 6, 8, 12, 16, 20, 24, 28, 36, 44, 52, 68, 84, 116, 128};
37 int qpulses[] = {4, 5, 4, 4, 3,  3,  3,  3,  3,  4,  4,  4,  0,  0,  0}; //c: 134 bits
38 #define WAVEFORM_END 52
39
40 /* Start frequency of each band */
41 int pbank[] = {0, 4, 8, 12, 20, WAVEFORM_END, 128};
42
43 /* Compute the energy in each of the bands */
44 void compute_bands(float *X, int B, float *bank)
45 {
46    int i;
47    for (i=0;i<NBANDS;i++)
48    {
49       int j;
50       bank[i] = 1e-10;
51       for (j=B*qbank[i];j<B*qbank[i+1];j++)
52          bank[i] += X[j]*X[j];
53       bank[i] = sqrt(bank[i]);
54    }
55 }
56
57 /* Normalise each band such that the energy is one. */
58 void normalise_bands(float *X, int B, float *bank)
59 {
60    int i;
61    for (i=0;i<NBANDS;i++)
62    {
63       int j;
64       float x = 1.f/(1e-10+bank[i]);
65       for (j=B*qbank[i];j<B*qbank[i+1];j++)
66          X[j] *= x;
67    }
68    for (i=B*qbank[NBANDS];i<B*qbank[NBANDS+1];i++)
69       X[i] = 0;
70 }
71
72 /* De-normalise the energy to produce the synthesis from the unit-energy bands */
73 void denormalise_bands(float *X, int B, float *bank)
74 {
75    int i;
76    for (i=0;i<NBANDS;i++)
77    {
78       int j;
79       float x = bank[i];
80       for (j=B*qbank[i];j<B*qbank[i+1];j++)
81          X[j] *= x;
82    }
83    for (i=B*qbank[NBANDS];i<B*qbank[NBANDS+1];i++)
84       X[i] = 0;
85 }
86
87
88 /* Compute the best gain for each "pitch band" */
89 void compute_pitch_gain(float *X, int B, float *P, float *gains, float *bank)
90 {
91    int i;
92    float w[B*qbank[NBANDS]];
93    for (i=0;i<NBANDS;i++)
94    {
95       int j;
96       for (j=B*qbank[i];j<B*qbank[i+1];j++)
97          w[j] = bank[i];
98    }
99
100    
101    for (i=0;i<PBANDS;i++)
102    {
103       float Sxy=0;
104       float Sxx = 0;
105       int j;
106       float gain;
107       for (j=B*pbank[i];j<B*pbank[i+1];j++)
108       {
109          Sxy += X[j]*P[j]*w[j];
110          Sxx += X[j]*X[j]*w[j];
111       }
112       gain = Sxy/(1e-10+Sxx);
113       //gain = Sxy/(2*(pbank[i+1]-pbank[i]));
114       //if (i<3)
115       //gain *= 1+.02*gain;
116       if (gain > .90)
117          gain = .90;
118       if (gain < 0.0)
119          gain = 0.0;
120       
121       gains[i] = gain;
122    }
123    for (i=B*pbank[PBANDS];i<B*pbank[PBANDS+1];i++)
124       P[i] = 0;
125 }
126
127 /* Apply the (quantised) gain to each "pitch band" */
128 void pitch_quant_bands(float *X, int B, float *P, float *gains)
129 {
130    int i;
131    for (i=0;i<PBANDS;i++)
132    {
133       int j;
134       for (j=B*pbank[i];j<B*pbank[i+1];j++)
135          P[j] *= gains[i];
136       //printf ("%f ", gain);
137    }
138    for (i=B*pbank[PBANDS];i<B*pbank[PBANDS+1];i++)
139       P[i] = 0;
140 }
141
142 void quant_bands(float *X, int B, float *P)
143 {
144    int i;
145    for (i=0;i<NBANDS;i++)
146    {
147       int q;
148       q =qpulses[i];
149       if (q) {
150          alg_quant2(X+B*qbank[i], B*(qbank[i+1]-qbank[i]), q, P+B*qbank[i]);
151       } else {
152          noise_quant(X+B*qbank[i], B*(qbank[i+1]-qbank[i]), q, P+B*qbank[i]);
153       }
154    }
155    for (i=B*qbank[NBANDS];i<B*qbank[NBANDS+1];i++)
156       X[i] = 0;
157 }
158
159
160 /* Scales the pulse-codebook entry in each band such that unit-energy is conserved when 
161    adding the pitch */
162 void pitch_renormalise_bands(float *X, int B, float *P)
163 {
164    int i;
165    for (i=0;i<NBANDS;i++)
166    {
167       int j;
168       float Rpp=0;
169       float Rxp=0;
170       float Rxx=0;
171       float gain1;
172       for (j=B*qbank[i];j<B*qbank[i+1];j++)
173       {
174          Rxp += X[j]*P[j];
175          Rpp += P[j]*P[j];
176          Rxx += X[j]*X[j];
177       }
178       float arg = Rxp*Rxp + 1 - Rpp;
179       gain1 = sqrt(arg)-Rxp;
180       if (Rpp>.9999)
181          Rpp = .9999;
182       Rxx = 0;
183       for (j=B*qbank[i];j<B*qbank[i+1];j++)
184       {
185          X[j] = P[j]+gain1*X[j];
186          Rxx += X[j]*X[j];
187       }
188    }
189    for (i=B*qbank[NBANDS];i<B*qbank[NBANDS+1];i++)
190       X[i] = 0;
191 }
192