removed unneeded variable shifts from alg_quant()
[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
42 /** Takes the pitch vector and the decoded residual vector, computes the gain
43     that will give ||p+g*y||=1 and mixes the residual with the pitch. */
44 static void mix_pitch_and_residual(int * restrict iy, celt_norm_t * restrict X, int N, int K, const celt_norm_t * restrict P)
45 {
46    int i;
47    celt_word32_t Ryp, Ryy, Rpp;
48    celt_word32_t g;
49    VARDECL(celt_norm_t, y);
50 #ifdef FIXED_POINT
51    int yshift;
52 #endif
53    SAVE_STACK;
54 #ifdef FIXED_POINT
55    yshift = 13-celt_ilog2(K);
56 #endif
57    ALLOC(y, N, celt_norm_t);
58
59    /*for (i=0;i<N;i++)
60    printf ("%d ", iy[i]);*/
61    Rpp = 0;
62    i=0;
63    do {
64       Rpp = MAC16_16(Rpp,P[i],P[i]);
65       y[i] = SHL16(iy[i],yshift);
66    } while (++i < N);
67
68    Ryp = 0;
69    Ryy = 0;
70    /* If this doesn't generate a dual MAC (on supported archs), fire the compiler guy */
71    i=0;
72    do {
73       Ryp = MAC16_16(Ryp, y[i], P[i]);
74       Ryy = MAC16_16(Ryy, y[i], y[i]);
75    } while (++i < N);
76
77    /* g = (sqrt(Ryp^2 + Ryy - Rpp*Ryy)-Ryp)/Ryy */
78    g = MULT16_32_Q15(
79             celt_sqrt(MULT16_16(ROUND16(Ryp,14),ROUND16(Ryp,14)) + Ryy -
80                       MULT16_16(ROUND16(Ryy,14),ROUND16(Rpp,14)))
81             - ROUND16(Ryp,14),
82        celt_rcp(SHR32(Ryy,9)));
83
84    i=0;
85    do 
86       X[i] = P[i] + ROUND16(MULT16_16(y[i], g),11);
87    while (++i < N);
88
89    RESTORE_STACK;
90 }
91
92
93 void alg_quant(celt_norm_t *X, celt_mask_t *W, int N, int K, const celt_norm_t *P, ec_enc *enc)
94 {
95    VARDECL(celt_norm_t, y);
96    VARDECL(int, iy);
97    VARDECL(int, signx);
98    int j, is;
99    celt_word16_t s;
100    int pulsesLeft;
101    celt_word32_t sum;
102    celt_word32_t xy, yy, yp;
103    celt_word16_t Rpp;
104    int N_1; /* Inverse of N, in Q14 format (even for float) */
105 #ifdef FIXED_POINT
106    int yshift;
107 #endif
108    SAVE_STACK;
109
110 #ifdef FIXED_POINT
111    yshift = 13-celt_ilog2(K);
112 #endif
113
114    ALLOC(y, N, celt_norm_t);
115    ALLOC(iy, N, int);
116    ALLOC(signx, N, int);
117    N_1 = 512/N;
118
119    sum = 0;
120    for (j=0;j<N;j++)
121    {
122       if (X[j]>0)
123          signx[j]=1;
124       else
125          signx[j]=-1;
126       iy[j] = 0;
127       y[j] = 0;
128       sum = MAC16_16(sum, P[j],P[j]);
129    }
130    Rpp = ROUND16(sum, NORM_SHIFT);
131
132    celt_assert2(Rpp<=NORM_SCALING, "Rpp should never have a norm greater than unity");
133
134    xy = yy = yp = 0;
135
136    pulsesLeft = K;
137    while (pulsesLeft > 0)
138    {
139       int pulsesAtOnce=1;
140       int best_id;
141       celt_word16_t magnitude;
142       /* Decide on how many pulses to find at once */
143       pulsesAtOnce = (pulsesLeft*N_1)>>9; /* pulsesLeft/N */
144       if (pulsesAtOnce<1)
145          pulsesAtOnce = 1;
146       magnitude = SHL16(pulsesAtOnce, yshift);
147
148       best_id = 0;
149       /* The squared magnitude term gets added anyway, so we might as well 
150          add it outside the loop */
151       yy = ADD32(yy, MULT16_16(magnitude,magnitude));
152       /* Choose between fast and accurate strategy depending on where we are in the search */
153       if (pulsesLeft>1)
154       {
155          /* This should ensure that anything we can process will have a better score */
156          celt_word32_t best_num = -VERY_LARGE16;
157          celt_word16_t best_den = 0;
158          j=0;
159          do {
160             celt_word16_t Rxy, Ryy;
161             /* Select sign based on X[j] alone */
162             s = signx[j]*magnitude;
163             /* Temporary sums of the new pulse(s) */
164             Rxy = EXTRACT16(SHR32(xy + MULT16_16(s,X[j]),14));
165             /* We're multiplying y[j] by two so we don't have to do it here */
166             Ryy = EXTRACT16(SHR32(yy + MULT16_16(s,y[j]),14));
167             
168             /* Approximate score: we maximise Rxy/sqrt(Ryy) (we're guaranteed that 
169                Rxy is positive because the sign is pre-computed) */
170             Rxy = MULT16_16_Q15(Rxy,Rxy);
171             /* The idea is to check for num/den >= best_num/best_den, but that way
172                we can do it without any division */
173             /* OPT: Make sure to use conditional moves here */
174             if (MULT16_16(best_den, Rxy) > MULT16_16(Ryy, best_num))
175             {
176                best_den = Ryy;
177                best_num = Rxy;
178                best_id = j;
179             }
180          } while (++j<N);
181       } else {
182          celt_word16_t g;
183          celt_word16_t best_num = -VERY_LARGE16;
184          celt_word16_t best_den = 0;
185          j=0;
186          do {
187             celt_word16_t Rxy, Ryy, Ryp;
188             celt_word16_t num;
189             /* Select sign based on X[j] alone */
190             s = signx[j]*magnitude;
191             /* Temporary sums of the new pulse(s) */
192             /* We only shift by 13 so we don't have to multiply by 2 later */
193             Rxy = ROUND16(xy + MULT16_16(s,X[j]), 13);
194             /* We're multiplying y[j] by two so we don't have to do it here */
195             Ryy = ROUND16(yy + MULT16_16(s,y[j]), 14);
196             Ryp = ROUND16(yp + MULT16_16(s,P[j]), 14);
197
198             /* Compute the gain such that ||p + g*y|| = 1 
199                ...but instead, we compute g*Ryy to avoid dividing */
200             g = celt_psqrt(MULT16_16(Ryp,Ryp) + MULT16_16(Ryy,QCONST16(1.f,14)-Rpp)) - Ryp;
201             /* Knowing that gain, what's the error: (x-g*y)^2 
202                (result is negated and we discard x^2 because it's constant) */
203             /* score = 2*g*Rxy - g*g*Ryy;*/
204 #ifdef FIXED_POINT
205             /* No need to multiply Rxy by 2 because we did it earlier */
206             num = MULT16_16_Q15(SUB16(Rxy,g),g);
207 #else
208             num = g*(2*Rxy-g);
209 #endif
210             if (MULT16_16(best_den, num) > MULT16_16(Ryy, best_num))
211             {
212                best_den = Ryy;
213                best_num = num;
214                best_id = j;
215             }
216          } while (++j<N);
217       }
218       
219       j = best_id;
220       is = signx[j]*pulsesAtOnce;
221       s = SHL16(is, yshift);
222
223       /* Updating the sums of the new pulse(s) */
224       xy = xy + MULT16_16(s,X[j]);
225       /* We're multiplying y[j] by two so we don't have to do it here */
226       yy = yy + MULT16_16(s,y[j]);
227       yp = yp + MULT16_16(s, P[j]);
228
229       /* Only now that we've made the final choice, update y/iy */
230       /* Multiplying y[j] by 2 so we don't have to do it everywhere else */
231       y[j] += 2*s;
232       iy[j] += is;
233       pulsesLeft -= pulsesAtOnce;
234    }
235    
236    encode_pulses(iy, N, K, enc);
237    
238    /* Recompute the gain in one pass to reduce the encoder-decoder mismatch
239    due to the recursive computation used in quantisation. */
240    mix_pitch_and_residual(iy, X, N, K, P);
241    RESTORE_STACK;
242 }
243
244
245 /** Decode pulse vector and combine the result with the pitch vector to produce
246     the final normalised signal in the current band. */
247 void alg_unquant(celt_norm_t *X, int N, int K, celt_norm_t *P, ec_dec *dec)
248 {
249    VARDECL(int, iy);
250    SAVE_STACK;
251    ALLOC(iy, N, int);
252    decode_pulses(iy, N, K, dec);
253    mix_pitch_and_residual(iy, X, N, K, P);
254    RESTORE_STACK;
255 }
256
257 #ifdef FIXED_POINT
258 static const celt_word16_t pg[11] = {32767, 24576, 21299, 19661, 19661, 19661, 18022, 18022, 16384, 16384, 16384};
259 #else
260 static const celt_word16_t pg[11] = {1.f, .75f, .65f, 0.6f, 0.6f, .6f, .55f, .55f, .5f, .5f, .5f};
261 #endif
262
263 #define MAX_INTRA 32
264 #define LOG_MAX_INTRA 5
265       
266 void intra_prediction(celt_norm_t *x, celt_mask_t *W, int N, int K, celt_norm_t *Y, celt_norm_t * restrict P, int B, int N0, ec_enc *enc)
267 {
268    int i,j,c;
269    int best=0;
270    celt_word16_t best_num=-VERY_LARGE16;
271    celt_word16_t best_den=0;
272    celt_word16_t s = 1;
273    int sign;
274    celt_word32_t E;
275    celt_word16_t pred_gain;
276    int max_pos = N0-N;
277    celt_word32_t yy=0;
278    VARDECL(celt_norm_t, Xr);
279    SAVE_STACK;
280
281    ALLOC(Xr, B*N, celt_norm_t);
282    
283    if (max_pos > MAX_INTRA)
284       max_pos = MAX_INTRA;
285
286    /* Reverse the samples of x without reversing the channels */
287    for (c=0;c<B;c++)
288       for (j=0;j<N;j++)
289          Xr[B*N-B*j-B+c] = x[B*j+c];
290
291    /* Compute yy for i=0 */
292    j=0;
293    do {
294       yy = MAC16_16(yy, Y[j], Y[j]);
295    } while (++j<B*N); /* Promises we loop at least once */
296
297    for (i=0;i<max_pos;i++)
298    {
299       celt_word32_t xy=0;
300       celt_word16_t num, den;
301       const celt_word16_t * restrict xp = Xr;
302       const celt_word16_t * restrict yp = Y+B*i;
303       j=0;
304       do {
305          xy = MAC16_16(xy, *xp++, *yp++);
306       } while (++j<B*N); /* Promises we loop at least once */
307       /* Using xy^2/yy as the score but without having to do the division */
308       num = MULT16_16_Q15(ROUND16(xy,14),ROUND16(xy,14));
309       den = ROUND16(yy,14);
310       /* If you're really desperate for speed, just use xy as the score */
311       /* OPT: Make sure to use a conditional move here */
312       if (MULT16_16(best_den, num) >  MULT16_16(den, best_num))
313       {
314          best_num = num;
315          best_den = den;
316          best = i;
317          /* Store xy as the sign. We'll normalise it to +/- 1 later. */
318          s = ROUND16(xy,14);
319       }
320       /* Update yy for the next iteration */
321       yp = Y+B*i;
322       j=0;
323       do {
324          yy = yy - MULT16_16(*yp, *yp) + MULT16_16(yp[B*N], yp[B*N]);
325          yp++;
326       } while (++j<B);
327    }
328    if (s<0)
329    {
330       s = -1;
331       sign = 1;
332    } else {
333       s = 1;
334       sign = 0;
335    }
336    /*printf ("%d %d ", sign, best);*/
337    ec_enc_bits(enc,sign,1);
338    if (max_pos == MAX_INTRA)
339       ec_enc_bits(enc,best,LOG_MAX_INTRA);
340    else
341       ec_enc_uint(enc,best,max_pos);
342
343    /*printf ("%d %f\n", best, best_score);*/
344    
345    if (K>10)
346       pred_gain = pg[10];
347    else
348       pred_gain = pg[K];
349    E = EPSILON;
350    for (c=0;c<B;c++)
351    {
352       for (j=0;j<N;j++)
353       {
354          P[B*j+c] = s*Y[B*best+B*(N-j-1)+c];
355          E = MAC16_16(E, P[B*j+c],P[B*j+c]);
356       }
357    }
358    /*pred_gain = pred_gain/sqrt(E);*/
359    pred_gain = MULT16_16_Q15(pred_gain,celt_rcp(SHL32(celt_sqrt(E),9)));
360    for (j=0;j<B*N;j++)
361       P[j] = PSHR32(MULT16_16(pred_gain, P[j]),8);
362    if (K>0)
363    {
364       for (j=0;j<B*N;j++)
365          x[j] -= P[j];
366    } else {
367       for (j=0;j<B*N;j++)
368          x[j] = P[j];
369    }
370    /*printf ("quant ");*/
371    /*for (j=0;j<N;j++) printf ("%f ", P[j]);*/
372    RESTORE_STACK;
373 }
374
375 void intra_unquant(celt_norm_t *x, int N, int K, celt_norm_t *Y, celt_norm_t * restrict P, int B, int N0, ec_dec *dec)
376 {
377    int j, c;
378    int sign;
379    celt_word16_t s;
380    int best;
381    celt_word32_t E;
382    celt_word16_t pred_gain;
383    int max_pos = N0-N;
384    if (max_pos > MAX_INTRA)
385       max_pos = MAX_INTRA;
386    
387    sign = ec_dec_bits(dec, 1);
388    if (sign == 0)
389       s = 1;
390    else
391       s = -1;
392    
393    if (max_pos == MAX_INTRA)
394       best = B*ec_dec_bits(dec, LOG_MAX_INTRA);
395    else
396       best = B*ec_dec_uint(dec, max_pos);
397    /*printf ("%d %d ", sign, best);*/
398
399    if (K>10)
400       pred_gain = pg[10];
401    else
402       pred_gain = pg[K];
403    E = EPSILON;
404    for (c=0;c<B;c++)
405    {
406       for (j=0;j<N;j++)
407       {
408          P[B*j+c] = s*Y[best+B*(N-j-1)+c];
409          E = MAC16_16(E, P[B*j+c],P[B*j+c]);
410       }
411    }
412    /*pred_gain = pred_gain/sqrt(E);*/
413    pred_gain = MULT16_16_Q15(pred_gain,celt_rcp(SHL32(celt_sqrt(E),9)));
414    for (j=0;j<B*N;j++)
415       P[j] = PSHR32(MULT16_16(pred_gain, P[j]),8);
416    if (K==0)
417    {
418       for (j=0;j<B*N;j++)
419          x[j] = P[j];
420    }
421 }
422
423 void intra_fold(celt_norm_t *x, int N, celt_norm_t *Y, celt_norm_t * restrict P, int B, int N0, int Nmax)
424 {
425    int i, j;
426    celt_word32_t E;
427    celt_word16_t g;
428    
429    E = EPSILON;
430    if (N0 >= (Nmax>>1))
431    {
432       for (i=0;i<B;i++)
433       {
434          for (j=0;j<N;j++)
435          {
436             P[j*B+i] = Y[(Nmax-N0-j-1)*B+i];
437             E += P[j*B+i]*P[j*B+i];
438          }
439       }
440    } else {
441       for (j=0;j<B*N;j++)
442       {
443          P[j] = Y[j];
444          E = MAC16_16(E, P[j],P[j]);
445       }
446    }
447    g = celt_rcp(SHL32(celt_sqrt(E),9));
448    for (j=0;j<B*N;j++)
449       P[j] = PSHR32(MULT16_16(g, P[j]),8);
450    for (j=0;j<B*N;j++)
451       x[j] = P[j];
452 }
453