Using random noise in upper bands when signal is "normal"
[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, 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    if (K==0)
174    {
175       if (lowband != NULL && resynth)
176       {
177          for (j=0;j<N;j++)
178             X[j] = lowband[j];
179       } else {
180          /* This is important for encoding the side in stereo mode */
181          for (j=0;j<N;j++)
182          {
183             *seed = lcg_rand(*seed);
184             X[j] = (int)(*seed)>>20;
185          }
186       }
187       renormalise_vector(X, Q15ONE, N, 1);
188       return;
189    }
190    K = get_pulses(K);
191 #ifdef FIXED_POINT
192    yshift = 13-celt_ilog2(K);
193 #endif
194
195    ALLOC(y, N, celt_norm);
196    ALLOC(iy, N, int);
197    ALLOC(signx, N, celt_word16);
198    N_1 = 512/N;
199    
200    if (spread)
201       exp_rotation(X, N, 1, spread, K);
202
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 #ifdef FIXED_POINT
228       if (sum <= K)
229 #else
230       if (sum <= EPSILON)
231 #endif
232       {
233          X[0] = QCONST16(1.f,14);
234          j=1; do
235             X[j]=0;
236          while (++j<N);
237          sum = QCONST16(1.f,14);
238       }
239       /* Do we have sufficient accuracy here? */
240       rcp = EXTRACT16(MULT16_32_Q16(K-1, celt_rcp(sum)));
241       j=0; do {
242 #ifdef FIXED_POINT
243          /* It's really important to round *towards zero* here */
244          iy[j] = MULT16_16_Q15(X[j],rcp);
245 #else
246          iy[j] = floor(rcp*X[j]);
247 #endif
248          y[j] = SHL16(iy[j],yshift);
249          yy = MAC16_16(yy, y[j],y[j]);
250          xy = MAC16_16(xy, X[j],y[j]);
251          y[j] *= 2;
252          pulsesLeft -= iy[j];
253       }  while (++j<N);
254    }
255    celt_assert2(pulsesLeft>=1, "Allocated too many pulses in the quick pass");
256
257    while (pulsesLeft > 0)
258    {
259       int pulsesAtOnce=1;
260       int best_id;
261       celt_word16 magnitude;
262       celt_word32 best_num = -VERY_LARGE16;
263       celt_word16 best_den = 0;
264 #ifdef FIXED_POINT
265       int rshift;
266 #endif
267       /* Decide on how many pulses to find at once */
268       pulsesAtOnce = (pulsesLeft*N_1)>>9; /* pulsesLeft/N */
269       if (pulsesAtOnce<1)
270          pulsesAtOnce = 1;
271 #ifdef FIXED_POINT
272       rshift = yshift+1+celt_ilog2(K-pulsesLeft+pulsesAtOnce);
273 #endif
274       magnitude = SHL16(pulsesAtOnce, yshift);
275
276       best_id = 0;
277       /* The squared magnitude term gets added anyway, so we might as well 
278          add it outside the loop */
279       yy = MAC16_16(yy, magnitude,magnitude);
280       /* Choose between fast and accurate strategy depending on where we are in the search */
281          /* This should ensure that anything we can process will have a better score */
282       j=0;
283       do {
284          celt_word16 Rxy, Ryy;
285          /* Select sign based on X[j] alone */
286          s = magnitude;
287          /* Temporary sums of the new pulse(s) */
288          Rxy = EXTRACT16(SHR32(MAC16_16(xy, s,X[j]),rshift));
289          /* We're multiplying y[j] by two so we don't have to do it here */
290          Ryy = EXTRACT16(SHR32(MAC16_16(yy, s,y[j]),rshift));
291             
292             /* Approximate score: we maximise Rxy/sqrt(Ryy) (we're guaranteed that 
293          Rxy is positive because the sign is pre-computed) */
294          Rxy = MULT16_16_Q15(Rxy,Rxy);
295             /* The idea is to check for num/den >= best_num/best_den, but that way
296          we can do it without any division */
297          /* OPT: Make sure to use conditional moves here */
298          if (MULT16_16(best_den, Rxy) > MULT16_16(Ryy, best_num))
299          {
300             best_den = Ryy;
301             best_num = Rxy;
302             best_id = j;
303          }
304       } while (++j<N);
305       
306       j = best_id;
307       is = pulsesAtOnce;
308       s = SHL16(is, yshift);
309
310       /* Updating the sums of the new pulse(s) */
311       xy = xy + MULT16_16(s,X[j]);
312       /* We're multiplying y[j] by two so we don't have to do it here */
313       yy = yy + MULT16_16(s,y[j]);
314
315       /* Only now that we've made the final choice, update y/iy */
316       /* Multiplying y[j] by 2 so we don't have to do it everywhere else */
317       y[j] += 2*s;
318       iy[j] += is;
319       pulsesLeft -= pulsesAtOnce;
320    }
321    j=0;
322    do {
323       X[j] = MULT16_16(signx[j],X[j]);
324       if (signx[j] < 0)
325          iy[j] = -iy[j];
326    } while (++j<N);
327    encode_pulses(iy, N, K, enc);
328    
329    /* Recompute the gain in one pass to reduce the encoder-decoder mismatch
330    due to the recursive computation used in quantisation. */
331    if (resynth)
332    {
333       normalise_residual(iy, X, N, K, EXTRACT16(SHR32(yy,2*yshift)));
334       if (spread)
335          exp_rotation(X, N, -1, spread, K);
336    }
337    RESTORE_STACK;
338 }
339
340
341 /** Decode pulse vector and combine the result with the pitch vector to produce
342     the final normalised signal in the current band. */
343 void alg_unquant(celt_norm *X, int N, int K, int spread, celt_norm *lowband, ec_dec *dec, celt_int32 *seed)
344 {
345    int i;
346    celt_word32 Ryy;
347    VARDECL(int, iy);
348    SAVE_STACK;
349    if (K==0)
350    {
351       if (lowband != NULL)
352       {
353          for (i=0;i<N;i++)
354             X[i] = lowband[i];
355       } else {
356          /* This is important for encoding the side in stereo mode */
357          for (i=0;i<N;i++)
358          {
359             *seed = lcg_rand(*seed);
360             X[i] = (int)(*seed)>>20;
361          }
362       }
363       renormalise_vector(X, Q15ONE, N, 1);
364       return;
365    }
366    K = get_pulses(K);
367    ALLOC(iy, N, int);
368    decode_pulses(iy, N, K, dec);
369    Ryy = 0;
370    i=0;
371    do {
372       Ryy = MAC16_16(Ryy, iy[i], iy[i]);
373    } while (++i < N);
374    normalise_residual(iy, X, N, K, Ryy);
375    if (spread)
376       exp_rotation(X, N, -1, spread, K);
377    RESTORE_STACK;
378 }
379
380 celt_word16 renormalise_vector(celt_norm *X, celt_word16 value, int N, int stride)
381 {
382    int i;
383 #ifdef FIXED_POINT
384    int k;
385 #endif
386    celt_word32 E = EPSILON;
387    celt_word16 g;
388    celt_word32 t;
389    celt_norm *xptr = X;
390    for (i=0;i<N;i++)
391    {
392       E = MAC16_16(E, *xptr, *xptr);
393       xptr += stride;
394    }
395 #ifdef FIXED_POINT
396    k = celt_ilog2(E)>>1;
397 #endif
398    t = VSHR32(E, (k-7)<<1);
399    g = MULT16_16_Q15(value, celt_rsqrt_norm(t));
400
401    xptr = X;
402    for (i=0;i<N;i++)
403    {
404       *xptr = EXTRACT16(PSHR32(MULT16_16(g, *xptr), k+1));
405       xptr += stride;
406    }
407    return celt_sqrt(E);
408 }
409