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