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