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