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