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