Using previous range coder state for PRNG
[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 "bands.h"
43 #include "rate.h"
44
45 #ifndef M_PI
46 #define M_PI 3.141592653
47 #endif
48
49 static void exp_rotation1(celt_norm *X, int len, int stride, celt_word16 c, celt_word16 s)
50 {
51    int i;
52    celt_norm *Xptr;
53    Xptr = X;
54    for (i=0;i<len-stride;i++)
55    {
56       celt_norm x1, x2;
57       x1 = Xptr[0];
58       x2 = Xptr[stride];
59       Xptr[stride] = EXTRACT16(SHR32(MULT16_16(c,x2) + MULT16_16(s,x1), 15));
60       *Xptr++      = EXTRACT16(SHR32(MULT16_16(c,x1) - MULT16_16(s,x2), 15));
61    }
62    Xptr = &X[len-2*stride-1];
63    for (i=len-2*stride-1;i>=0;i--)
64    {
65       celt_norm x1, x2;
66       x1 = Xptr[0];
67       x2 = Xptr[stride];
68       Xptr[stride] = EXTRACT16(SHR32(MULT16_16(c,x2) + MULT16_16(s,x1), 15));
69       *Xptr--      = EXTRACT16(SHR32(MULT16_16(c,x1) - MULT16_16(s,x2), 15));
70    }
71 }
72
73 static void exp_rotation(celt_norm *X, int len, int dir, int stride, int K, int spread)
74 {
75    static const int SPREAD_FACTOR[3]={5,10,15};
76    int i;
77    celt_word16 c, s;
78    celt_word16 gain, theta;
79    int stride2=0;
80    int factor;
81    /*int i;
82    if (len>=30)
83    {
84       for (i=0;i<len;i++)
85          X[i] = 0;
86       X[14] = 1;
87       K=5;
88    }*/
89    if (2*K>=len || spread==SPREAD_NONE)
90       return;
91    factor = SPREAD_FACTOR[spread-1];
92
93    gain = celt_div((celt_word32)MULT16_16(Q15_ONE,len),(celt_word32)(len+factor*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    /*TODO: We should be passing around log2(B), not B, for both this and for
110       extract_collapse_mask().*/
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, stride2, s, c);
118          exp_rotation1(X+i*len, len, 1, c, s);
119       } else {
120          exp_rotation1(X+i*len, len, 1, c, -s);
121          if (stride2)
122             exp_rotation1(X+i*len, len, 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,
137       int N, int K, celt_word32 Ryy, celt_word16 gain)
138 {
139    int i;
140 #ifdef FIXED_POINT
141    int k;
142 #endif
143    celt_word32 t;
144    celt_word16 g;
145
146 #ifdef FIXED_POINT
147    k = celt_ilog2(Ryy)>>1;
148 #endif
149    t = VSHR32(Ryy, (k-7)<<1);
150    g = MULT16_16_P15(celt_rsqrt_norm(t),gain);
151
152    i=0;
153    do
154       X[i] = EXTRACT16(PSHR32(MULT16_16(g, iy[i]), k+1));
155    while (++i < N);
156 }
157
158 static unsigned extract_collapse_mask(int *iy, int N, int B)
159 {
160    unsigned collapse_mask;
161    int N0;
162    int i;
163    if (B<=1)
164       return 1;
165    /*TODO: We should be passing around log2(B), not B, for both this and for
166       exp_rotation().*/
167    N0 = N/B;
168    collapse_mask = 0;
169    i=0; do {
170       int j;
171       j=0; do {
172          collapse_mask |= (iy[i*N0+j]!=0)<<i;
173       } while (++j<N0);
174    } while (++i<B);
175    return collapse_mask;
176 }
177
178 unsigned alg_quant(celt_norm *X, int N, int K, int spread, int B, celt_norm *lowband,
179       int resynth, ec_enc *enc, celt_word16 gain)
180 {
181    VARDECL(celt_norm, y);
182    VARDECL(int, iy);
183    VARDECL(celt_word16, signx);
184    int i, j;
185    celt_word16 s;
186    int pulsesLeft;
187    celt_word32 sum;
188    celt_word32 xy;
189    celt_word16 yy;
190    unsigned collapse_mask;
191    SAVE_STACK;
192
193    celt_assert2(K!=0, "alg_quant() needs at least one pulse");
194
195    ALLOC(y, N, celt_norm);
196    ALLOC(iy, N, int);
197    ALLOC(signx, N, celt_word16);
198    
199    exp_rotation(X, N, 1, B, K, spread);
200
201    /* Get rid of the sign */
202    sum = 0;
203    j=0; do {
204       if (X[j]>0)
205          signx[j]=1;
206       else {
207          signx[j]=-1;
208          X[j]=-X[j];
209       }
210       iy[j] = 0;
211       y[j] = 0;
212    } while (++j<N);
213
214    xy = yy = 0;
215
216    pulsesLeft = K;
217
218    /* Do a pre-search by projecting on the pyramid */
219    if (K > (N>>1))
220    {
221       celt_word16 rcp;
222       j=0; do {
223          sum += X[j];
224       }  while (++j<N);
225
226       /* If X is too small, just replace it with a pulse at 0 */
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] = (int)floor(rcp*X[j]);
247 #endif
248          y[j] = iy[j];
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    /* This should never happen, but just in case it does (e.g. on silence)
258       we fill the first bin with pulses. */
259 #ifdef FIXED_POINT_DEBUG
260    celt_assert2(pulsesLeft<=N+3, "Not enough pulses in the quick pass");
261 #endif
262    if (pulsesLeft > N+3)
263    {
264       celt_word16 tmp = pulsesLeft;
265       yy = MAC16_16(yy, tmp, tmp);
266       yy = MAC16_16(yy, tmp, y[0]);
267       iy[0] += pulsesLeft;
268       pulsesLeft=0;
269    }
270
271    s = 1;
272    for (i=0;i<pulsesLeft;i++)
273    {
274       int best_id;
275       celt_word32 best_num = -VERY_LARGE16;
276       celt_word16 best_den = 0;
277 #ifdef FIXED_POINT
278       int rshift;
279 #endif
280 #ifdef FIXED_POINT
281       rshift = 1+celt_ilog2(K-pulsesLeft+i+1);
282 #endif
283       best_id = 0;
284       /* The squared magnitude term gets added anyway, so we might as well 
285          add it outside the loop */
286       yy = ADD32(yy, 1);
287       j=0;
288       do {
289          celt_word16 Rxy, Ryy;
290          /* Temporary sums of the new pulse(s) */
291          Rxy = EXTRACT16(SHR32(ADD32(xy, EXTEND32(X[j])),rshift));
292          /* We're multiplying y[j] by two so we don't have to do it here */
293          Ryy = ADD16(yy, y[j]);
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       /* Updating the sums of the new pulse(s) */
310       xy = ADD32(xy, EXTEND32(X[best_id]));
311       /* We're multiplying y[j] by two so we don't have to do it here */
312       yy = ADD16(yy, y[best_id]);
313
314       /* Only now that we've made the final choice, update y/iy */
315       /* Multiplying y[j] by 2 so we don't have to do it everywhere else */
316       y[best_id] += 2*s;
317       iy[best_id]++;
318    }
319
320    /* Put the original sign back */
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    if (resynth)
330    {
331       normalise_residual(iy, X, N, K, yy, gain);
332       exp_rotation(X, N, -1, B, K, spread);
333    }
334    collapse_mask = extract_collapse_mask(iy, N, B);
335    RESTORE_STACK;
336    return collapse_mask;
337 }
338
339
340 /** Decode pulse vector and combine the result with the pitch vector to produce
341     the final normalised signal in the current band. */
342 unsigned alg_unquant(celt_norm *X, int N, int K, int spread, int B,
343       celt_norm *lowband, ec_dec *dec, celt_word16 gain)
344 {
345    int i;
346    celt_word32 Ryy;
347    unsigned collapse_mask;
348    VARDECL(int, iy);
349    SAVE_STACK;
350
351    celt_assert2(K!=0, "alg_unquant() needs at least one pulse");
352    ALLOC(iy, N, int);
353    decode_pulses(iy, N, K, dec);
354    Ryy = 0;
355    i=0;
356    do {
357       Ryy = MAC16_16(Ryy, iy[i], iy[i]);
358    } while (++i < N);
359    normalise_residual(iy, X, N, K, Ryy, gain);
360    exp_rotation(X, N, -1, B, K, spread);
361    collapse_mask = extract_collapse_mask(iy, N, B);
362    RESTORE_STACK;
363    return collapse_mask;
364 }
365
366 void renormalise_vector(celt_norm *X, int N, celt_word16 gain)
367 {
368    int i;
369 #ifdef FIXED_POINT
370    int k;
371 #endif
372    celt_word32 E = EPSILON;
373    celt_word16 g;
374    celt_word32 t;
375    celt_norm *xptr = X;
376    for (i=0;i<N;i++)
377    {
378       E = MAC16_16(E, *xptr, *xptr);
379       xptr++;
380    }
381 #ifdef FIXED_POINT
382    k = celt_ilog2(E)>>1;
383 #endif
384    t = VSHR32(E, (k-7)<<1);
385    g = MULT16_16_P15(celt_rsqrt_norm(t),gain);
386
387    xptr = X;
388    for (i=0;i<N;i++)
389    {
390       *xptr = EXTRACT16(PSHR32(MULT16_16(g, *xptr), k+1));
391       xptr++;
392    }
393    /*return celt_sqrt(E);*/
394 }
395
396 int stereo_itheta(celt_norm *X, celt_norm *Y, int stereo, int N)
397 {
398    int i;
399    int itheta;
400    celt_word16 mid, side;
401    celt_word32 Emid, Eside;
402
403    Emid = Eside = EPSILON;
404    if (stereo)
405    {
406       for (i=0;i<N;i++)
407       {
408          celt_norm m, s;
409          m = ADD16(SHR16(X[i],1),SHR16(Y[i],1));
410          s = SUB16(SHR16(X[i],1),SHR16(Y[i],1));
411          Emid = MAC16_16(Emid, m, m);
412          Eside = MAC16_16(Eside, s, s);
413       }
414    } else {
415       for (i=0;i<N;i++)
416       {
417          celt_norm m, s;
418          m = X[i];
419          s = Y[i];
420          Emid = MAC16_16(Emid, m, m);
421          Eside = MAC16_16(Eside, s, s);
422       }
423    }
424    mid = celt_sqrt(Emid);
425    side = celt_sqrt(Eside);
426 #ifdef FIXED_POINT
427    /* 0.63662 = 2/pi */
428    itheta = MULT16_16_Q15(QCONST16(0.63662f,15),celt_atan2p(side, mid));
429 #else
430    itheta = (int)floor(.5f+16384*0.63662f*atan2(side,mid));
431 #endif
432
433    return itheta;
434 }