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