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