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