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