Fixes a fixed-point overflow in stereo angle calculation
[opus.git] / libcelt / vq.c
1 /* Copyright (c) 2007-2008 CSIRO
2    Copyright (c) 2007-2009 Xiph.Org Foundation
3    Written by Jean-Marc Valin */
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 #ifdef HAVE_CONFIG_H
34 #include "config.h"
35 #endif
36
37 #include "mathops.h"
38 #include "cwrs.h"
39 #include "vq.h"
40 #include "arch.h"
41 #include "os_support.h"
42 #include "rate.h"
43
44 #ifndef M_PI
45 #define M_PI 3.141592653
46 #endif
47
48 static void exp_rotation1(celt_norm *X, int len, int stride, celt_word16 c, celt_word16 s)
49 {
50    int i;
51    celt_norm *Xptr;
52    Xptr = X;
53    for (i=0;i<len-stride;i++)
54    {
55       celt_norm x1, x2;
56       x1 = Xptr[0];
57       x2 = Xptr[stride];
58       Xptr[stride] = EXTRACT16(SHR32(MULT16_16(c,x2) + MULT16_16(s,x1), 15));
59       *Xptr++      = EXTRACT16(SHR32(MULT16_16(c,x1) - MULT16_16(s,x2), 15));
60    }
61    Xptr = &X[len-2*stride-1];
62    for (i=len-2*stride-1;i>=0;i--)
63    {
64       celt_norm x1, x2;
65       x1 = Xptr[0];
66       x2 = Xptr[stride];
67       Xptr[stride] = EXTRACT16(SHR32(MULT16_16(c,x2) + MULT16_16(s,x1), 15));
68       *Xptr--      = EXTRACT16(SHR32(MULT16_16(c,x1) - MULT16_16(s,x2), 15));
69    }
70 }
71
72 static void exp_rotation(celt_norm *X, int len, int dir, int stride, int K, int spread)
73 {
74    int i;
75    celt_word16 c, s;
76    celt_word16 gain, theta;
77    int stride2=0;
78    int factor;
79    /*int i;
80    if (len>=30)
81    {
82       for (i=0;i<len;i++)
83          X[i] = 0;
84       X[14] = 1;
85       K=5;
86    }*/
87    if (2*K>=len || spread==0)
88       return;
89    if (spread==1)
90       factor=10;
91    else if (spread==2)
92       factor=5;
93    else
94       factor=15;
95
96    gain = celt_div((celt_word32)MULT16_16(Q15_ONE,len),(celt_word32)(len+factor*K));
97    /* FIXME: Make that HALF16 instead of HALF32 */
98    theta = HALF32(MULT16_16_Q15(gain,gain));
99
100    c = celt_cos_norm(EXTEND32(theta));
101    s = celt_cos_norm(EXTEND32(SUB16(Q15ONE,theta))); /*  sin(theta) */
102
103    if (len>=8*stride)
104    {
105       stride2 = 1;
106       /* This is just a simple way of computing sqrt(len/stride) with rounding.
107          It's basically incrementing long as (stride2+0.5)^2 < len/stride.
108          I _think_ it is bit-exact */
109       while ((stride2*stride2+stride2)*stride + (stride>>2) < len)
110          stride2++;
111    }
112    len /= stride;
113    for (i=0;i<stride;i++)
114    {
115       if (dir < 0)
116       {
117          if (stride2)
118             exp_rotation1(X+i*len, len, stride2, s, c);
119          exp_rotation1(X+i*len, len, 1, c, s);
120       } else {
121          exp_rotation1(X+i*len, len, 1, c, -s);
122          if (stride2)
123             exp_rotation1(X+i*len, len, stride2, s, -c);
124       }
125    }
126    /*if (len>=30)
127    {
128       for (i=0;i<len;i++)
129          printf ("%f ", X[i]);
130       printf ("\n");
131       exit(0);
132    }*/
133 }
134
135 /** Takes the pitch vector and the decoded residual vector, computes the gain
136     that will give ||p+g*y||=1 and mixes the residual with the pitch. */
137 static void normalise_residual(int * restrict iy, celt_norm * restrict X,
138       int N, int K, celt_word32 Ryy, celt_word16 gain)
139 {
140    int i;
141 #ifdef FIXED_POINT
142    int k;
143 #endif
144    celt_word32 t;
145    celt_word16 g;
146
147 #ifdef FIXED_POINT
148    k = celt_ilog2(Ryy)>>1;
149 #endif
150    t = VSHR32(Ryy, (k-7)<<1);
151    g = MULT16_16_P15(celt_rsqrt_norm(t),gain);
152
153    i=0;
154    do
155       X[i] = EXTRACT16(PSHR32(MULT16_16(g, iy[i]), k+1));
156    while (++i < N);
157 }
158
159 void alg_quant(celt_norm *X, int N, int K, int spread, int B, celt_norm *lowband,
160       int resynth, ec_enc *enc, celt_int32 *seed, celt_word16 gain)
161 {
162    VARDECL(celt_norm, y);
163    VARDECL(int, iy);
164    VARDECL(celt_word16, signx);
165    int i, j;
166    celt_word16 s;
167    int pulsesLeft;
168    celt_word32 sum;
169    celt_word32 xy;
170    celt_word16 yy;
171    SAVE_STACK;
172
173    celt_assert2(K!=0, "alg_quant() needs at least one pulse");
174
175    ALLOC(y, N, celt_norm);
176    ALLOC(iy, N, int);
177    ALLOC(signx, N, celt_word16);
178    
179    exp_rotation(X, N, 1, B, K, spread);
180
181    /* Get rid of the sign */
182    sum = 0;
183    j=0; do {
184       if (X[j]>0)
185          signx[j]=1;
186       else {
187          signx[j]=-1;
188          X[j]=-X[j];
189       }
190       iy[j] = 0;
191       y[j] = 0;
192    } while (++j<N);
193
194    xy = yy = 0;
195
196    pulsesLeft = K;
197
198    /* Do a pre-search by projecting on the pyramid */
199    if (K > (N>>1))
200    {
201       celt_word16 rcp;
202       j=0; do {
203          sum += X[j];
204       }  while (++j<N);
205
206       /* If X is too small, just replace it with a pulse at 0 */
207 #ifdef FIXED_POINT
208       if (sum <= K)
209 #else
210       if (sum <= EPSILON)
211 #endif
212       {
213          X[0] = QCONST16(1.f,14);
214          j=1; do
215             X[j]=0;
216          while (++j<N);
217          sum = QCONST16(1.f,14);
218       }
219       /* Do we have sufficient accuracy here? */
220       rcp = EXTRACT16(MULT16_32_Q16(K-1, celt_rcp(sum)));
221       j=0; do {
222 #ifdef FIXED_POINT
223          /* It's really important to round *towards zero* here */
224          iy[j] = MULT16_16_Q15(X[j],rcp);
225 #else
226          iy[j] = (int)floor(rcp*X[j]);
227 #endif
228          y[j] = iy[j];
229          yy = MAC16_16(yy, y[j],y[j]);
230          xy = MAC16_16(xy, X[j],y[j]);
231          y[j] *= 2;
232          pulsesLeft -= iy[j];
233       }  while (++j<N);
234    }
235    celt_assert2(pulsesLeft>=1, "Allocated too many pulses in the quick pass");
236
237    /* This should never happen, but just in case it does (e.g. on silence)
238       we fill the first bin with pulses. */
239 #ifdef FIXED_POINT_DEBUG
240    celt_assert2(pulsesLeft<=N+3, "Not enough pulses in the quick pass");
241 #endif
242    if (pulsesLeft > N+3)
243    {
244       celt_word16 tmp = pulsesLeft;
245       yy = MAC16_16(yy, tmp, tmp);
246       yy = MAC16_16(yy, tmp, y[0]);
247       iy[0] += pulsesLeft;
248       pulsesLeft=0;
249    }
250
251    s = 1;
252    for (i=0;i<pulsesLeft;i++)
253    {
254       int best_id;
255       celt_word32 best_num = -VERY_LARGE16;
256       celt_word16 best_den = 0;
257 #ifdef FIXED_POINT
258       int rshift;
259 #endif
260 #ifdef FIXED_POINT
261       rshift = 1+celt_ilog2(K-pulsesLeft+i+1);
262 #endif
263       best_id = 0;
264       /* The squared magnitude term gets added anyway, so we might as well 
265          add it outside the loop */
266       yy = ADD32(yy, 1);
267       j=0;
268       do {
269          celt_word16 Rxy, Ryy;
270          /* Temporary sums of the new pulse(s) */
271          Rxy = EXTRACT16(SHR32(ADD32(xy, EXTEND32(X[j])),rshift));
272          /* We're multiplying y[j] by two so we don't have to do it here */
273          Ryy = ADD16(yy, y[j]);
274
275          /* Approximate score: we maximise Rxy/sqrt(Ryy) (we're guaranteed that
276             Rxy is positive because the sign is pre-computed) */
277          Rxy = MULT16_16_Q15(Rxy,Rxy);
278          /* The idea is to check for num/den >= best_num/best_den, but that way
279             we can do it without any division */
280          /* OPT: Make sure to use conditional moves here */
281          if (MULT16_16(best_den, Rxy) > MULT16_16(Ryy, best_num))
282          {
283             best_den = Ryy;
284             best_num = Rxy;
285             best_id = j;
286          }
287       } while (++j<N);
288       
289       /* Updating the sums of the new pulse(s) */
290       xy = ADD32(xy, EXTEND32(X[best_id]));
291       /* We're multiplying y[j] by two so we don't have to do it here */
292       yy = ADD16(yy, y[best_id]);
293
294       /* Only now that we've made the final choice, update y/iy */
295       /* Multiplying y[j] by 2 so we don't have to do it everywhere else */
296       y[best_id] += 2*s;
297       iy[best_id]++;
298    }
299
300    /* Put the original sign back */
301    j=0;
302    do {
303       X[j] = MULT16_16(signx[j],X[j]);
304       if (signx[j] < 0)
305          iy[j] = -iy[j];
306    } while (++j<N);
307    encode_pulses(iy, N, K, enc);
308    
309    if (resynth)
310    {
311       normalise_residual(iy, X, N, K, yy, gain);
312       exp_rotation(X, N, -1, B, K, spread);
313    }
314    RESTORE_STACK;
315 }
316
317
318 /** Decode pulse vector and combine the result with the pitch vector to produce
319     the final normalised signal in the current band. */
320 void alg_unquant(celt_norm *X, int N, int K, int spread, int B,
321       celt_norm *lowband, ec_dec *dec, celt_int32 *seed, celt_word16 gain)
322 {
323    int i;
324    celt_word32 Ryy;
325    VARDECL(int, iy);
326    SAVE_STACK;
327
328    celt_assert2(K!=0, "alg_unquant() needs at least one pulse");
329    ALLOC(iy, N, int);
330    decode_pulses(iy, N, K, dec);
331    Ryy = 0;
332    i=0;
333    do {
334       Ryy = MAC16_16(Ryy, iy[i], iy[i]);
335    } while (++i < N);
336    normalise_residual(iy, X, N, K, Ryy, gain);
337    exp_rotation(X, N, -1, B, K, spread);
338    RESTORE_STACK;
339 }
340
341 void renormalise_vector(celt_norm *X, int N, celt_word16 gain)
342 {
343    int i;
344 #ifdef FIXED_POINT
345    int k;
346 #endif
347    celt_word32 E = EPSILON;
348    celt_word16 g;
349    celt_word32 t;
350    celt_norm *xptr = X;
351    for (i=0;i<N;i++)
352    {
353       E = MAC16_16(E, *xptr, *xptr);
354       xptr++;
355    }
356 #ifdef FIXED_POINT
357    k = celt_ilog2(E)>>1;
358 #endif
359    t = VSHR32(E, (k-7)<<1);
360    g = MULT16_16_P15(celt_rsqrt_norm(t),gain);
361
362    xptr = X;
363    for (i=0;i<N;i++)
364    {
365       *xptr = EXTRACT16(PSHR32(MULT16_16(g, *xptr), k+1));
366       xptr++;
367    }
368    /*return celt_sqrt(E);*/
369 }
370
371 int stereo_itheta(celt_norm *X, celt_norm *Y, int stereo, int N)
372 {
373    int i;
374    int itheta;
375    celt_word16 mid, side;
376    celt_word32 Emid, Eside;
377
378    Emid = Eside = EPSILON;
379    if (stereo)
380    {
381       for (i=0;i<N;i++)
382       {
383          celt_norm m, s;
384          m = ADD16(SHR16(X[i],1),SHR16(Y[i],1));
385          s = SUB16(SHR16(X[i],1),SHR16(Y[i],1));
386          Emid = MAC16_16(Emid, m, m);
387          Eside = MAC16_16(Eside, s, s);
388       }
389    } else {
390       for (i=0;i<N;i++)
391       {
392          celt_norm m, s;
393          m = X[i];
394          s = Y[i];
395          Emid = MAC16_16(Emid, m, m);
396          Eside = MAC16_16(Eside, s, s);
397       }
398    }
399    mid = celt_sqrt(Emid);
400    side = celt_sqrt(Eside);
401 #ifdef FIXED_POINT
402    /* 0.63662 = 2/pi */
403    itheta = MULT16_16_Q15(QCONST16(0.63662f,15),celt_atan2p(side, mid));
404 #else
405    itheta = (int)floor(.5f+16384*0.63662f*atan2(side,mid));
406 #endif
407
408    return itheta;
409 }