Removed code that is no longer necessary with denorm pitch and spreading
[opus.git] / libcelt / vq.c
1 /* (C) 2007-2008 Jean-Marc Valin, CSIRO
2 */
3 /*
4    Redistribution and use in source and binary forms, with or without
5    modification, are permitted provided that the following conditions
6    are met:
7    
8    - Redistributions of source code must retain the above copyright
9    notice, this list of conditions and the following disclaimer.
10    
11    - Redistributions in binary form must reproduce the above copyright
12    notice, this list of conditions and the following disclaimer in the
13    documentation and/or other materials provided with the distribution.
14    
15    - Neither the name of the Xiph.org Foundation nor the names of its
16    contributors may be used to endorse or promote products derived from
17    this software without specific prior written permission.
18    
19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
23    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 #ifdef HAVE_CONFIG_H
33 #include "config.h"
34 #endif
35
36 #include "mathops.h"
37 #include "cwrs.h"
38 #include "vq.h"
39 #include "arch.h"
40 #include "os_support.h"
41 #include "rate.h"
42
43 static void exp_rotation(celt_norm_t *X, int len, int dir, int stride, int K)
44 {
45    int i, k, iter;
46    celt_word16_t c, s;
47    celt_word16_t gain, theta;
48    celt_norm_t *Xptr;
49    gain = celt_div((celt_word32_t)MULT16_16(Q15_ONE,len),(celt_word32_t)(len+2*K*((K>>1)+1)));
50    /* FIXME: Make that HALF16 instead of HALF32 */
51    theta = SUB16(Q15ONE, HALF32(MULT16_16_Q15(gain,gain)));
52    /*if (len==30)
53    {
54    for (i=0;i<len;i++)
55    X[i] = 0;
56    X[14] = 1;
57 }*/ 
58    c = celt_cos_norm(EXTEND32(theta));
59    s = dir*celt_cos_norm(EXTEND32(SUB16(Q15ONE,theta))); /*  sin(theta) */
60    if (stride == 1)
61       stride = 2;
62    iter = 1;
63    for (k=0;k<iter;k++)
64    {
65       /* We could use MULT16_16_P15 instead of MULT16_16_Q15 for more accuracy, 
66       but at this point, I really don't think it's necessary */
67       Xptr = X;
68       for (i=0;i<len-stride;i++)
69       {
70          celt_norm_t x1, x2;
71          x1 = Xptr[0];
72          x2 = Xptr[stride];
73          Xptr[stride] = MULT16_16_Q15(c,x2) + MULT16_16_Q15(s,x1);
74          *Xptr++      = MULT16_16_Q15(c,x1) - MULT16_16_Q15(s,x2);
75       }
76       Xptr = &X[len-2*stride-1];
77       for (i=len-2*stride-1;i>=0;i--)
78       {
79          celt_norm_t x1, x2;
80          x1 = Xptr[0];
81          x2 = Xptr[stride];
82          Xptr[stride] = MULT16_16_Q15(c,x2) + MULT16_16_Q15(s,x1);
83          *Xptr--      = MULT16_16_Q15(c,x1) - MULT16_16_Q15(s,x2);
84       }
85    }
86    /*if (len==30)
87    {
88    for (i=0;i<len;i++)
89    printf ("%f ", X[i]);
90    printf ("\n");
91    exit(0);
92 }*/
93 }
94
95
96 /** Takes the pitch vector and the decoded residual vector, computes the gain
97     that will give ||p+g*y||=1 and mixes the residual with the pitch. */
98 static void mix_pitch_and_residual(int * restrict iy, celt_norm_t * restrict X, int N, int K)
99 {
100    int i;
101    celt_word32_t Ryy;
102    celt_word32_t g;
103    VARDECL(celt_norm_t, y);
104 #ifdef FIXED_POINT
105    int yshift;
106 #endif
107    SAVE_STACK;
108 #ifdef FIXED_POINT
109    yshift = 13-celt_ilog2(K);
110 #endif
111    ALLOC(y, N, celt_norm_t);
112
113    i=0;
114    Ryy = 0;
115    do {
116       y[i] = SHL16(iy[i],yshift);
117       Ryy = MAC16_16(Ryy, y[i], y[i]);
118    } while (++i < N);
119
120    g = MULT16_32_Q15(celt_sqrt(Ryy), celt_rcp(SHR32(Ryy,9)));
121
122    i=0;
123    do 
124       X[i] = ROUND16(MULT16_16(y[i], g),11);
125    while (++i < N);
126
127    RESTORE_STACK;
128 }
129
130
131 void alg_quant(celt_norm_t *X, int N, int K, int spread, ec_enc *enc)
132 {
133    VARDECL(celt_norm_t, y);
134    VARDECL(int, iy);
135    VARDECL(celt_word16_t, signx);
136    int j, is;
137    celt_word16_t s;
138    int pulsesLeft;
139    celt_word32_t sum;
140    celt_word32_t xy, yy;
141    int N_1; /* Inverse of N, in Q14 format (even for float) */
142 #ifdef FIXED_POINT
143    int yshift;
144 #endif
145    SAVE_STACK;
146
147    K = get_pulses(K);
148 #ifdef FIXED_POINT
149    yshift = 13-celt_ilog2(K);
150 #endif
151
152    ALLOC(y, N, celt_norm_t);
153    ALLOC(iy, N, int);
154    ALLOC(signx, N, celt_word16_t);
155    N_1 = 512/N;
156    
157    if (spread)
158       exp_rotation(X, N, 1, spread, K);
159
160    sum = 0;
161    j=0; do {
162       if (X[j]>0)
163          signx[j]=1;
164       else {
165          signx[j]=-1;
166          X[j]=-X[j];
167       }
168       iy[j] = 0;
169       y[j] = 0;
170    } while (++j<N);
171
172    celt_assert2(Rpp<=NORM_SCALING, "Rpp should never have a norm greater than unity");
173
174    xy = yy = 0;
175
176    pulsesLeft = K;
177
178    /* Do a pre-search by projecting on the pyramid */
179    if (K > (N>>1))
180    {
181       celt_word16_t rcp;
182       sum=0;
183       j=0; do {
184          sum += X[j];
185       }  while (++j<N);
186
187 #ifdef FIXED_POINT
188       if (sum <= K)
189 #else
190       if (sum <= EPSILON)
191 #endif
192       {
193          X[0] = QCONST16(1.f,14);
194          j=1; do
195             X[j]=0;
196          while (++j<N);
197          sum = QCONST16(1.f,14);
198       }
199       /* Do we have sufficient accuracy here? */
200       rcp = EXTRACT16(MULT16_32_Q16(K-1, celt_rcp(sum)));
201       j=0; do {
202 #ifdef FIXED_POINT
203          /* It's really important to round *towards zero* here */
204          iy[j] = MULT16_16_Q15(X[j],rcp);
205 #else
206          iy[j] = floor(rcp*X[j]);
207 #endif
208          y[j] = SHL16(iy[j],yshift);
209          yy = MAC16_16(yy, y[j],y[j]);
210          xy = MAC16_16(xy, X[j],y[j]);
211          y[j] *= 2;
212          pulsesLeft -= iy[j];
213       }  while (++j<N);
214    }
215    celt_assert2(pulsesLeft>=1, "Allocated too many pulses in the quick pass");
216
217    while (pulsesLeft > 0)
218    {
219       int pulsesAtOnce=1;
220       int best_id;
221       celt_word16_t magnitude;
222       celt_word32_t best_num = -VERY_LARGE16;
223       celt_word16_t best_den = 0;
224 #ifdef FIXED_POINT
225       int rshift;
226 #endif
227       /* Decide on how many pulses to find at once */
228       pulsesAtOnce = (pulsesLeft*N_1)>>9; /* pulsesLeft/N */
229       if (pulsesAtOnce<1)
230          pulsesAtOnce = 1;
231 #ifdef FIXED_POINT
232       rshift = yshift+1+celt_ilog2(K-pulsesLeft+pulsesAtOnce);
233 #endif
234       magnitude = SHL16(pulsesAtOnce, yshift);
235
236       best_id = 0;
237       /* The squared magnitude term gets added anyway, so we might as well 
238          add it outside the loop */
239       yy = MAC16_16(yy, magnitude,magnitude);
240       /* Choose between fast and accurate strategy depending on where we are in the search */
241          /* This should ensure that anything we can process will have a better score */
242       j=0;
243       do {
244          celt_word16_t Rxy, Ryy;
245          /* Select sign based on X[j] alone */
246          s = magnitude;
247          /* Temporary sums of the new pulse(s) */
248          Rxy = EXTRACT16(SHR32(MAC16_16(xy, s,X[j]),rshift));
249          /* We're multiplying y[j] by two so we don't have to do it here */
250          Ryy = EXTRACT16(SHR32(MAC16_16(yy, s,y[j]),rshift));
251             
252             /* Approximate score: we maximise Rxy/sqrt(Ryy) (we're guaranteed that 
253          Rxy is positive because the sign is pre-computed) */
254          Rxy = MULT16_16_Q15(Rxy,Rxy);
255             /* The idea is to check for num/den >= best_num/best_den, but that way
256          we can do it without any division */
257          /* OPT: Make sure to use conditional moves here */
258          if (MULT16_16(best_den, Rxy) > MULT16_16(Ryy, best_num))
259          {
260             best_den = Ryy;
261             best_num = Rxy;
262             best_id = j;
263          }
264       } while (++j<N);
265       
266       j = best_id;
267       is = pulsesAtOnce;
268       s = SHL16(is, yshift);
269
270       /* Updating the sums of the new pulse(s) */
271       xy = xy + MULT16_16(s,X[j]);
272       /* We're multiplying y[j] by two so we don't have to do it here */
273       yy = yy + MULT16_16(s,y[j]);
274
275       /* Only now that we've made the final choice, update y/iy */
276       /* Multiplying y[j] by 2 so we don't have to do it everywhere else */
277       y[j] += 2*s;
278       iy[j] += is;
279       pulsesLeft -= pulsesAtOnce;
280    }
281    j=0;
282    do {
283       X[j] = MULT16_16(signx[j],X[j]);
284       if (signx[j] < 0)
285          iy[j] = -iy[j];
286    } while (++j<N);
287    encode_pulses(iy, N, K, enc);
288    
289    /* Recompute the gain in one pass to reduce the encoder-decoder mismatch
290    due to the recursive computation used in quantisation. */
291    mix_pitch_and_residual(iy, X, N, K);
292    if (spread)
293       exp_rotation(X, N, -1, spread, K);
294    RESTORE_STACK;
295 }
296
297
298 /** Decode pulse vector and combine the result with the pitch vector to produce
299     the final normalised signal in the current band. */
300 void alg_unquant(celt_norm_t *X, int N, int K, int spread, ec_dec *dec)
301 {
302    VARDECL(int, iy);
303    SAVE_STACK;
304    K = get_pulses(K);
305    ALLOC(iy, N, int);
306    decode_pulses(iy, N, K, dec);
307    mix_pitch_and_residual(iy, X, N, K);
308    if (spread)
309       exp_rotation(X, N, -1, spread, K);
310    RESTORE_STACK;
311 }
312
313 celt_word16_t renormalise_vector(celt_norm_t *X, celt_word16_t value, int N, int stride)
314 {
315    int i;
316    celt_word32_t E = EPSILON;
317    celt_word16_t rE;
318    celt_word16_t g;
319    celt_norm_t *xptr = X;
320    for (i=0;i<N;i++)
321    {
322       E = MAC16_16(E, *xptr, *xptr);
323       xptr += stride;
324    }
325
326    rE = celt_sqrt(E);
327 #ifdef FIXED_POINT
328    if (rE <= 128)
329       g = Q15ONE;
330    else
331 #endif
332       g = MULT16_16_Q15(value,celt_rcp(SHL32(rE,9)));
333    xptr = X;
334    for (i=0;i<N;i++)
335    {
336       *xptr = PSHR32(MULT16_16(g, *xptr),8);
337       xptr += stride;
338    }
339    return rE;
340 }
341
342 static void fold(const CELTMode *m, int N, celt_norm_t *Y, celt_norm_t * restrict P, int N0, int B)
343 {
344    int j;
345    const int C = CHANNELS(m);
346    int id = (N0*C) % (C*B);
347    /* Here, we assume that id will never be greater than N0, i.e. that 
348       no band is wider than N0. In the unlikely case it happens, we set
349       everything to zero */
350    /*{
351            int offset = (N0*C - (id+C*N))/2;
352            if (offset > C*N0/16)
353                    offset = C*N0/16;
354            offset -= offset % (C*B);
355            if (offset < 0)
356                    offset = 0;
357            //printf ("%d\n", offset);
358            id += offset;
359    }*/
360    if (id+C*N>N0*C)
361       for (j=0;j<C*N;j++)
362          P[j] = 0;
363    else
364       for (j=0;j<C*N;j++)
365          P[j] = Y[id++];
366 }
367
368 void intra_fold(const CELTMode *m, celt_norm_t * restrict x, int N, celt_norm_t *Y, celt_norm_t * restrict P, int N0, int B)
369 {
370    int c;
371    const int C = CHANNELS(m);
372
373    fold(m, N, Y, P, N0, B);
374    c=0;
375    do {
376       renormalise_vector(P+c, Q15ONE, N, C);
377    } while (++c < C);
378 }
379