More VQ search simplifications
[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;
175    celt_word16 yy;
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    
208    exp_rotation(X, N, 1, B, K, spread);
209
210    /* Get rid of the sign */
211    sum = 0;
212    j=0; do {
213       if (X[j]>0)
214          signx[j]=1;
215       else {
216          signx[j]=-1;
217          X[j]=-X[j];
218       }
219       iy[j] = 0;
220       y[j] = 0;
221    } while (++j<N);
222
223    xy = yy = 0;
224
225    pulsesLeft = K;
226
227    /* Do a pre-search by projecting on the pyramid */
228    if (K > (N>>1))
229    {
230       celt_word16 rcp;
231       j=0; do {
232          sum += X[j];
233       }  while (++j<N);
234
235       /* If X is too small, just replace it with a pulse at 0 */
236 #ifdef FIXED_POINT
237       if (sum <= K)
238 #else
239       if (sum <= EPSILON)
240 #endif
241       {
242          X[0] = QCONST16(1.f,14);
243          j=1; do
244             X[j]=0;
245          while (++j<N);
246          sum = QCONST16(1.f,14);
247       }
248       /* Do we have sufficient accuracy here? */
249       rcp = EXTRACT16(MULT16_32_Q16(K-1, celt_rcp(sum)));
250       j=0; do {
251 #ifdef FIXED_POINT
252          /* It's really important to round *towards zero* here */
253          iy[j] = MULT16_16_Q15(X[j],rcp);
254 #else
255          iy[j] = (int)floor(rcp*X[j]);
256 #endif
257          y[j] = iy[j];
258          yy = MAC16_16(yy, y[j],y[j]);
259          xy = MAC16_16(xy, X[j],y[j]);
260          y[j] *= 2;
261          pulsesLeft -= iy[j];
262       }  while (++j<N);
263    }
264    celt_assert2(pulsesLeft>=1, "Allocated too many pulses in the quick pass");
265
266    /* This should never happen, but just in case it does (e.g. on silence)
267       we fill the first bin with pulses. */
268 #ifdef FIXED_POINT_DEBUG
269    celt_assert2(pulsesLeft<=N+3, "Not enough pulses in the quick pass");
270 #endif
271    if (pulsesLeft > N+3)
272    {
273       celt_word16 tmp = pulsesLeft;
274       yy = MAC16_16(yy, tmp, tmp);
275       yy = MAC16_16(yy, tmp, y[0]);
276       iy[0] += pulsesLeft;
277       pulsesLeft=0;
278    }
279
280    s = 1;
281    for (i=0;i<pulsesLeft;i++)
282    {
283       int best_id;
284       celt_word32 best_num = -VERY_LARGE16;
285       celt_word16 best_den = 0;
286 #ifdef FIXED_POINT
287       int rshift;
288 #endif
289 #ifdef FIXED_POINT
290       rshift = 1+celt_ilog2(K-pulsesLeft+i+1);
291 #endif
292       best_id = 0;
293       /* The squared magnitude term gets added anyway, so we might as well 
294          add it outside the loop */
295       yy = ADD32(yy, 1);
296       j=0;
297       do {
298          celt_word16 Rxy, Ryy;
299          /* Temporary sums of the new pulse(s) */
300          Rxy = EXTRACT16(SHR32(ADD32(xy, EXTEND32(X[j])),rshift));
301          /* We're multiplying y[j] by two so we don't have to do it here */
302          Ryy = ADD16(yy, y[j]);
303
304          /* Approximate score: we maximise Rxy/sqrt(Ryy) (we're guaranteed that
305             Rxy is positive because the sign is pre-computed) */
306          Rxy = MULT16_16_Q15(Rxy,Rxy);
307          /* The idea is to check for num/den >= best_num/best_den, but that way
308             we can do it without any division */
309          /* OPT: Make sure to use conditional moves here */
310          if (MULT16_16(best_den, Rxy) > MULT16_16(Ryy, best_num))
311          {
312             best_den = Ryy;
313             best_num = Rxy;
314             best_id = j;
315          }
316       } while (++j<N);
317       
318       /* Updating the sums of the new pulse(s) */
319       xy = ADD32(xy, EXTEND32(X[best_id]));
320       /* We're multiplying y[j] by two so we don't have to do it here */
321       yy = ADD16(yy, y[best_id]);
322
323       /* Only now that we've made the final choice, update y/iy */
324       /* Multiplying y[j] by 2 so we don't have to do it everywhere else */
325       y[best_id] += 2*s;
326       iy[best_id]++;
327    }
328
329    /* Put the original sign back */
330    j=0;
331    do {
332       X[j] = MULT16_16(signx[j],X[j]);
333       if (signx[j] < 0)
334          iy[j] = -iy[j];
335    } while (++j<N);
336    encode_pulses(iy, N, K, enc);
337    
338    if (resynth)
339    {
340       normalise_residual(iy, X, N, K, yy, gain);
341       exp_rotation(X, N, -1, B, K, spread);
342    }
343    RESTORE_STACK;
344 }
345
346
347 /** Decode pulse vector and combine the result with the pitch vector to produce
348     the final normalised signal in the current band. */
349 void alg_unquant(celt_norm *X, int N, int K, int spread, int B,
350       celt_norm *lowband, ec_dec *dec, celt_int32 *seed, celt_word16 gain)
351 {
352    int i;
353    celt_word32 Ryy;
354    VARDECL(int, iy);
355    SAVE_STACK;
356
357    if (K==0)
358    {
359       if (lowband != NULL)
360       {
361          if (spread==2 && B<=1)
362          {
363             for (i=0;i<N;i++)
364             {
365                *seed = lcg_rand(*seed);
366                X[i] = (int)(*seed)>>20;
367             }
368          } else {
369             for (i=0;i<N;i++)
370                X[i] = lowband[i];
371          }
372          renormalise_vector(X, N, gain);
373       } else {
374          /* This is important for encoding the side in stereo mode */
375          for (i=0;i<N;i++)
376             X[i] = 0;
377       }
378       return;
379    }
380    K = get_pulses(K);
381    ALLOC(iy, N, int);
382    decode_pulses(iy, N, K, dec);
383    Ryy = 0;
384    i=0;
385    do {
386       Ryy = MAC16_16(Ryy, iy[i], iy[i]);
387    } while (++i < N);
388    normalise_residual(iy, X, N, K, Ryy, gain);
389    exp_rotation(X, N, -1, B, K, spread);
390    RESTORE_STACK;
391 }
392
393 celt_word16 vector_norm(const celt_norm *X, int N)
394 {
395    int i;
396    celt_word32 E = EPSILON;
397    const celt_norm *xptr = X;
398    for (i=0;i<N;i++)
399    {
400       E = MAC16_16(E, *xptr, *xptr);
401       xptr++;
402    }
403    return celt_sqrt(E);
404 }
405
406 void renormalise_vector(celt_norm *X, int N, celt_word16 gain)
407 {
408    int i;
409 #ifdef FIXED_POINT
410    int k;
411 #endif
412    celt_word32 E = EPSILON;
413    celt_word16 g;
414    celt_word32 t;
415    celt_norm *xptr = X;
416    for (i=0;i<N;i++)
417    {
418       E = MAC16_16(E, *xptr, *xptr);
419       xptr++;
420    }
421 #ifdef FIXED_POINT
422    k = celt_ilog2(E)>>1;
423 #endif
424    t = VSHR32(E, (k-7)<<1);
425    g = MULT16_16_P15(celt_rsqrt_norm(t),gain);
426
427    xptr = X;
428    for (i=0;i<N;i++)
429    {
430       *xptr = EXTRACT16(PSHR32(MULT16_16(g, *xptr), k+1));
431       xptr++;
432    }
433    /*return celt_sqrt(E);*/
434 }
435