Updated Doxygen comments, removed an incorrectly placed LGPL header (we own
[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 #ifdef HAVE_CONFIG_H
33 #include "config.h"
34 #endif
35
36 #include <math.h>
37 #include "bands.h"
38 #include "modes.h"
39 #include "vq.h"
40 #include "cwrs.h"
41
42 /* Applies a series of rotations so that pulses are spread like a two-sided
43 exponential. The effect of this is to reduce the tonal noise created by the
44 sparse spectrum resulting from the pulse codebook */
45 static void exp_rotation(float *X, int len, float theta, int dir, int stride, int iter)
46 {
47    int i, k;
48    float c, s;
49    c = cos(theta);
50    s = dir*sin(theta);
51    for (k=0;k<iter;k++)
52    {
53       for (i=0;i<len-stride;i++)
54       {
55          float x1, x2;
56          x1 = X[i];
57          x2 = X[i+stride];
58          X[i] = c*x1 - s*x2;
59          X[i+stride] = c*x2 + s*x1;
60       }
61       for (i=len-2*stride-1;i>=0;i--)
62       {
63          float x1, x2;
64          x1 = X[i];
65          x2 = X[i+stride];
66          X[i] = c*x1 - s*x2;
67          X[i+stride] = c*x2 + s*x1;
68       }
69    }
70 }
71
72 /* Compute the amplitude (sqrt energy) in each of the bands */
73 void compute_band_energies(const CELTMode *m, float *X, float *bank)
74 {
75    int i, c, B, C;
76    const int *eBands = m->eBands;
77    B = m->nbMdctBlocks;
78    C = m->nbChannels;
79    for (c=0;c<C;c++)
80    {
81       for (i=0;i<m->nbEBands;i++)
82       {
83          int j;
84          float sum = 1e-10;
85          for (j=B*eBands[i];j<B*eBands[i+1];j++)
86             sum += X[j*C+c]*X[j*C+c];
87          bank[i*C+c] = sqrt(C*sum);
88          /*printf ("%f ", bank[i*C+c]);*/
89       }
90    }
91    /*printf ("\n");*/
92 }
93
94 /* Normalise each band such that the energy is one. */
95 void normalise_bands(const CELTMode *m, float *X, float *bank)
96 {
97    int i, c, B, C;
98    const int *eBands = m->eBands;
99    B = m->nbMdctBlocks;
100    C = m->nbChannels;
101    for (c=0;c<C;c++)
102    {
103       for (i=0;i<m->nbEBands;i++)
104       {
105          int j;
106          float g = 1.f/(1e-10+bank[i*C+c]);
107          for (j=B*eBands[i];j<B*eBands[i+1];j++)
108             X[j*C+c] *= g;
109       }
110    }
111    for (i=B*C*eBands[m->nbEBands];i<B*C*eBands[m->nbEBands+1];i++)
112       X[i] = 0;
113 }
114
115 void renormalise_bands(const CELTMode *m, float *X)
116 {
117    VARDECL(float *tmpE);
118    ALLOC(tmpE, m->nbEBands*m->nbChannels, float);
119    compute_band_energies(m, X, tmpE);
120    normalise_bands(m, X, tmpE);
121 }
122
123 /* De-normalise the energy to produce the synthesis from the unit-energy bands */
124 void denormalise_bands(const CELTMode *m, float *X, float *bank)
125 {
126    int i, c, B, C;
127    const int *eBands = m->eBands;
128    B = m->nbMdctBlocks;
129    C = m->nbChannels;
130    for (c=0;c<C;c++)
131    {
132       for (i=0;i<m->nbEBands;i++)
133       {
134          int j;
135          float g = bank[i*C+c];
136          for (j=B*eBands[i];j<B*eBands[i+1];j++)
137             X[j*C+c] *= g;
138       }
139    }
140    for (i=B*C*eBands[m->nbEBands];i<B*C*eBands[m->nbEBands+1];i++)
141       X[i] = 0;
142 }
143
144
145 /* Compute the best gain for each "pitch band" */
146 void compute_pitch_gain(const CELTMode *m, float *X, float *P, float *gains, float *bank)
147 {
148    int i, B;
149    const int *eBands = m->eBands;
150    const int *pBands = m->pBands;
151    VARDECL(float *w);
152    B = m->nbMdctBlocks*m->nbChannels;
153    ALLOC(w, B*eBands[m->nbEBands], float);
154    for (i=0;i<m->nbEBands;i++)
155    {
156       int j;
157       for (j=B*eBands[i];j<B*eBands[i+1];j++)
158          w[j] = bank[i];
159    }
160
161    
162    for (i=0;i<m->nbPBands;i++)
163    {
164       float Sxy=0;
165       float Sxx = 0;
166       int j;
167       float gain;
168       for (j=B*pBands[i];j<B*pBands[i+1];j++)
169       {
170          Sxy += X[j]*P[j]*w[j];
171          Sxx += X[j]*X[j]*w[j];
172       }
173       gain = Sxy/(1e-10+Sxx);
174       if (gain > 1.f)
175          gain = 1.f;
176       if (gain < 0.0f)
177          gain = 0.0f;
178       /* We need to be a bit conservative, otherwise residual doesn't quantise well */
179       gain *= .9f;
180       gains[i] = gain;
181       /*printf ("%f ", 1-sqrt(1-gain*gain));*/
182    }
183    /*if(rand()%10==0)
184    {
185       for (i=0;i<m->nbPBands;i++)
186          printf ("%f ", 1-sqrt(1-gains[i]*gains[i]));
187       printf ("\n");
188    }*/
189    for (i=B*pBands[m->nbPBands];i<B*pBands[m->nbPBands+1];i++)
190       P[i] = 0;
191 }
192
193 /* Apply the (quantised) gain to each "pitch band" */
194 void pitch_quant_bands(const CELTMode *m, float *X, float *P, float *gains)
195 {
196    int i, B;
197    const int *pBands = m->pBands;
198    B = m->nbMdctBlocks*m->nbChannels;
199    for (i=0;i<m->nbPBands;i++)
200    {
201       int j;
202       for (j=B*pBands[i];j<B*pBands[i+1];j++)
203          P[j] *= gains[i];
204       /*printf ("%f ", gain);*/
205    }
206    for (i=B*pBands[m->nbPBands];i<B*pBands[m->nbPBands+1];i++)
207       P[i] = 0;
208 }
209
210
211 /* Quantisation of the residual */
212 void quant_bands(const CELTMode *m, float *X, float *P, float *W, int total_bits, ec_enc *enc)
213 {
214    int i, j, B, bits;
215    const int *eBands = m->eBands;
216    float alpha = .7;
217    VARDECL(float *norm);
218    VARDECL(int *pulses);
219    VARDECL(int *offsets);
220    
221    B = m->nbMdctBlocks*m->nbChannels;
222    
223    ALLOC(norm, B*eBands[m->nbEBands+1], float);
224    ALLOC(pulses, m->nbEBands, int);
225    ALLOC(offsets, m->nbEBands, int);
226
227    for (i=0;i<m->nbEBands;i++)
228       offsets[i] = 0;
229    /* Use a single-bit margin to guard against overrunning (make sure it's enough) */
230    bits = total_bits - ec_enc_tell(enc, 0) - 1;
231    compute_allocation(m, offsets, bits, pulses);
232    
233    /*printf("bits left: %d\n", bits);
234    for (i=0;i<m->nbEBands;i++)
235       printf ("%d ", pulses[i]);
236    printf ("\n");*/
237    /*printf ("%d %d\n", ec_enc_tell(enc, 0), compute_allocation(m, m->nbPulses));*/
238    for (i=0;i<m->nbEBands;i++)
239    {
240       int q;
241       float theta, n;
242       q = pulses[i];
243       n = sqrt(B*(eBands[i+1]-eBands[i]));
244       theta = .007*(B*(eBands[i+1]-eBands[i]))/(.1f+q);
245
246       /* If pitch isn't available, use intra-frame prediction */
247       if (eBands[i] >= m->pitchEnd || q<=0)
248       {
249          q -= 1;
250          alpha = 0;
251          if (q<0)
252             intra_fold(X+B*eBands[i], B*(eBands[i+1]-eBands[i]), norm, P+B*eBands[i], B, eBands[i], eBands[m->nbEBands+1]);
253          else
254             intra_prediction(X+B*eBands[i], W+B*eBands[i], B*(eBands[i+1]-eBands[i]), q, norm, P+B*eBands[i], B, eBands[i], enc);
255       } else {
256          alpha = .7;
257       }
258       
259       if (q > 0)
260       {
261          exp_rotation(P+B*eBands[i], B*(eBands[i+1]-eBands[i]), theta, -1, B, 8);
262          exp_rotation(X+B*eBands[i], B*(eBands[i+1]-eBands[i]), theta, -1, B, 8);
263          alg_quant(X+B*eBands[i], W+B*eBands[i], B*(eBands[i+1]-eBands[i]), q, P+B*eBands[i], alpha, enc);
264          exp_rotation(X+B*eBands[i], B*(eBands[i+1]-eBands[i]), theta, 1, B, 8);
265       }
266       for (j=B*eBands[i];j<B*eBands[i+1];j++)
267          norm[j] = X[j] * n;
268    }
269    for (i=B*eBands[m->nbEBands];i<B*eBands[m->nbEBands+1];i++)
270       X[i] = 0;
271 }
272
273 /* Decoding of the residual */
274 void unquant_bands(const CELTMode *m, float *X, float *P, int total_bits, ec_dec *dec)
275 {
276    int i, j, B, bits;
277    const int *eBands = m->eBands;
278    float alpha = .7;
279    VARDECL(float *norm);
280    VARDECL(int *pulses);
281    VARDECL(int *offsets);
282    
283    B = m->nbMdctBlocks*m->nbChannels;
284    
285    ALLOC(norm, B*eBands[m->nbEBands+1], float);
286    ALLOC(pulses, m->nbEBands, int);
287    ALLOC(offsets, m->nbEBands, int);
288
289    for (i=0;i<m->nbEBands;i++)
290       offsets[i] = 0;
291    /* Use a single-bit margin to guard against overrunning (make sure it's enough) */
292    bits = total_bits - ec_dec_tell(dec, 0) - 1;
293    compute_allocation(m, offsets, bits, pulses);
294
295    for (i=0;i<m->nbEBands;i++)
296    {
297       int q;
298       float theta, n;
299       q = pulses[i];
300       n = sqrt(B*(eBands[i+1]-eBands[i]));
301       theta = .007*(B*(eBands[i+1]-eBands[i]))/(.1f+q);
302
303       /* If pitch isn't available, use intra-frame prediction */
304       if (eBands[i] >= m->pitchEnd || q<=0)
305       {
306          q -= 1;
307          alpha = 0;
308          if (q<0)
309             intra_fold(X+B*eBands[i], B*(eBands[i+1]-eBands[i]), norm, P+B*eBands[i], B, eBands[i], eBands[m->nbEBands+1]);
310          else
311             intra_unquant(X+B*eBands[i], B*(eBands[i+1]-eBands[i]), q, norm, P+B*eBands[i], B, eBands[i], dec);
312       } else {
313          alpha = .7;
314       }
315       
316       if (q > 0)
317       {
318          exp_rotation(P+B*eBands[i], B*(eBands[i+1]-eBands[i]), theta, -1, B, 8);
319          alg_unquant(X+B*eBands[i], B*(eBands[i+1]-eBands[i]), q, P+B*eBands[i], alpha, dec);
320          exp_rotation(X+B*eBands[i], B*(eBands[i+1]-eBands[i]), theta, 1, B, 8);
321       }
322       for (j=B*eBands[i];j<B*eBands[i+1];j++)
323          norm[j] = X[j] * n;
324    }
325    for (i=B*eBands[m->nbEBands];i<B*eBands[m->nbEBands+1];i++)
326       X[i] = 0;
327 }
328
329 void stereo_mix(const CELTMode *m, float *X, float *bank, int dir)
330 {
331    int i, B, C;
332    const int *eBands = m->eBands;
333    B = m->nbMdctBlocks;
334    C = m->nbChannels;
335    for (i=0;i<m->nbEBands;i++)
336    {
337       int j;
338       float left, right;
339       float a1, a2;
340       left = bank[i*C];
341       right = bank[i*C+1];
342       a1 = left/sqrt(.01+left*left+right*right);
343       a2 = dir*right/sqrt(.01+left*left+right*right);
344       for (j=B*eBands[i];j<B*eBands[i+1];j++)
345       {
346          float r, l;
347          l = X[j*C];
348          r = X[j*C+1];         
349          X[j*C] = a1*l + a2*r;
350          X[j*C+1] = a1*r - a2*l;
351       }
352    }
353    for (i=B*C*eBands[m->nbEBands];i<B*C*eBands[m->nbEBands+1];i++)
354       X[i] = 0;
355
356 }