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