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