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