Unb0rked a fixed-point regression caused in 7bb339d
[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_word16_t ryp, ryy, rpp;
49    celt_word32_t g;
50    VARDECL(celt_norm_t, y);
51 #ifdef FIXED_POINT
52    int yshift;
53 #endif
54    SAVE_STACK;
55 #ifdef FIXED_POINT
56    yshift = 13-celt_ilog2(K);
57 #endif
58    ALLOC(y, N, celt_norm_t);
59
60    /*for (i=0;i<N;i++)
61    printf ("%d ", iy[i]);*/
62    Rpp = 0;
63    i=0;
64    do {
65       Rpp = MAC16_16(Rpp,P[i],P[i]);
66       y[i] = SHL16(iy[i],yshift);
67    } while (++i < N);
68
69    Ryp = 0;
70    Ryy = 0;
71    /* If this doesn't generate a dual MAC (on supported archs), fire the compiler guy */
72    i=0;
73    do {
74       Ryp = MAC16_16(Ryp, y[i], P[i]);
75       Ryy = MAC16_16(Ryy, y[i], y[i]);
76    } while (++i < N);
77
78    ryp = ROUND16(Ryp,14);
79    ryy = ROUND16(Ryy,14);
80    rpp = ROUND16(Rpp,14);
81    /* g = (sqrt(Ryp^2 + Ryy - Rpp*Ryy)-Ryp)/Ryy */
82    g = MULT16_32_Q15(celt_sqrt(MAC16_16(Ryy, ryp,ryp) - MULT16_16(ryy,rpp)) - ryp,
83                      celt_rcp(SHR32(Ryy,9)));
84
85    i=0;
86    do 
87       X[i] = ADD16(P[i], ROUND16(MULT16_16(y[i], g),11));
88    while (++i < N);
89
90    RESTORE_STACK;
91 }
92
93
94 void alg_quant(celt_norm_t *X, celt_mask_t *W, int N, int K, const celt_norm_t *P, ec_enc *enc)
95 {
96    VARDECL(celt_norm_t, y);
97    VARDECL(int, iy);
98    VARDECL(celt_word16_t, signx);
99    int j, is;
100    celt_word16_t s;
101    int pulsesLeft;
102    celt_word32_t sum;
103    celt_word32_t xy, yy, yp;
104    celt_word16_t Rpp;
105    int N_1; /* Inverse of N, in Q14 format (even for float) */
106 #ifdef FIXED_POINT
107    int yshift;
108 #endif
109    SAVE_STACK;
110
111 #ifdef FIXED_POINT
112    yshift = 13-celt_ilog2(K);
113 #endif
114
115    ALLOC(y, N, celt_norm_t);
116    ALLOC(iy, N, int);
117    ALLOC(signx, N, celt_word16_t);
118    N_1 = 512/N;
119
120    sum = 0;
121    j=0; do {
122       X[j] -= P[j];
123       if (X[j]>0)
124          signx[j]=1;
125       else
126          signx[j]=-1;
127       iy[j] = 0;
128       y[j] = 0;
129       sum = MAC16_16(sum, P[j],P[j]);
130    } while (++j<N);
131    Rpp = ROUND16(sum, NORM_SHIFT);
132
133    celt_assert2(Rpp<=NORM_SCALING, "Rpp should never have a norm greater than unity");
134
135    xy = yy = yp = 0;
136
137    pulsesLeft = K;
138    while (pulsesLeft > 1)
139    {
140       int pulsesAtOnce=1;
141       int best_id;
142       celt_word16_t magnitude;
143       celt_word32_t best_num = -VERY_LARGE16;
144       celt_word16_t best_den = 0;
145 #ifdef FIXED_POINT
146       int rshift;
147 #endif
148       /* Decide on how many pulses to find at once */
149       pulsesAtOnce = (pulsesLeft*N_1)>>9; /* pulsesLeft/N */
150       if (pulsesAtOnce<1)
151          pulsesAtOnce = 1;
152 #ifdef FIXED_POINT
153       rshift = yshift+1+celt_ilog2(K-pulsesLeft+pulsesAtOnce);
154 #endif
155       magnitude = SHL16(pulsesAtOnce, yshift);
156
157       best_id = 0;
158       /* The squared magnitude term gets added anyway, so we might as well 
159          add it outside the loop */
160       yy = MAC16_16(yy, magnitude,magnitude);
161       /* Choose between fast and accurate strategy depending on where we are in the search */
162          /* This should ensure that anything we can process will have a better score */
163       j=0;
164       do {
165          celt_word16_t Rxy, Ryy;
166          /* Select sign based on X[j] alone */
167          s = MULT16_16(signx[j],magnitude);
168          /* Temporary sums of the new pulse(s) */
169          Rxy = EXTRACT16(SHR32(MAC16_16(xy, s,X[j]),rshift));
170          /* We're multiplying y[j] by two so we don't have to do it here */
171          Ryy = EXTRACT16(SHR32(MAC16_16(yy, s,y[j]),rshift));
172             
173             /* Approximate score: we maximise Rxy/sqrt(Ryy) (we're guaranteed that 
174          Rxy is positive because the sign is pre-computed) */
175          Rxy = MULT16_16_Q15(Rxy,Rxy);
176             /* The idea is to check for num/den >= best_num/best_den, but that way
177          we can do it without any division */
178          /* OPT: Make sure to use conditional moves here */
179          if (MULT16_16(best_den, Rxy) > MULT16_16(Ryy, best_num))
180          {
181             best_den = Ryy;
182             best_num = Rxy;
183             best_id = j;
184          }
185       } while (++j<N);
186       
187       j = best_id;
188       is = MULT16_16(signx[j],pulsesAtOnce);
189       s = SHL16(is, yshift);
190
191       /* Updating the sums of the new pulse(s) */
192       xy = xy + MULT16_16(s,X[j]);
193       /* We're multiplying y[j] by two so we don't have to do it here */
194       yy = yy + MULT16_16(s,y[j]);
195       yp = yp + MULT16_16(s, P[j]);
196
197       /* Only now that we've made the final choice, update y/iy */
198       /* Multiplying y[j] by 2 so we don't have to do it everywhere else */
199       y[j] += 2*s;
200       iy[j] += is;
201       pulsesLeft -= pulsesAtOnce;
202    }
203    
204    {
205       celt_word16_t g;
206       celt_word16_t best_num = -VERY_LARGE16;
207       celt_word16_t best_den = 0;
208       int best_id = 0;
209       celt_word16_t magnitude = SHL16(1, yshift);
210
211       /* The squared magnitude term gets added anyway, so we might as well 
212       add it outside the loop */
213       yy = MAC16_16(yy, magnitude,magnitude);
214       j=0;
215       do {
216          celt_word16_t Rxy, Ryy, Ryp;
217          celt_word16_t num;
218          /* Select sign based on X[j] alone */
219          s = MULT16_16(signx[j],magnitude);
220          /* Temporary sums of the new pulse(s) */
221          Rxy = ROUND16(MAC16_16(xy, s,X[j]), 14);
222          /* We're multiplying y[j] by two so we don't have to do it here */
223          Ryy = ROUND16(MAC16_16(yy, s,y[j]), 14);
224          Ryp = ROUND16(MAC16_16(yp, s,P[j]), 14);
225
226             /* Compute the gain such that ||p + g*y|| = 1 
227          ...but instead, we compute g*Ryy to avoid dividing */
228          g = celt_psqrt(MULT16_16(Ryp,Ryp) + MULT16_16(Ryy,QCONST16(1.f,14)-Rpp)) - Ryp;
229             /* Knowing that gain, what's the error: (x-g*y)^2 
230          (result is negated and we discard x^2 because it's constant) */
231          /* score = 2*g*Rxy - g*g*Ryy;*/
232 #ifdef FIXED_POINT
233          /* No need to multiply Rxy by 2 because we did it earlier */
234          num = MULT16_16_Q15(ADD16(SUB16(Rxy,g),Rxy),g);
235 #else
236          num = g*(2*Rxy-g);
237 #endif
238          if (MULT16_16(best_den, num) > MULT16_16(Ryy, best_num))
239          {
240             best_den = Ryy;
241             best_num = num;
242             best_id = j;
243          }
244       } while (++j<N);
245       iy[best_id] += signx[best_id];
246    }
247    encode_pulses(iy, N, K, enc);
248    
249    /* Recompute the gain in one pass to reduce the encoder-decoder mismatch
250    due to the recursive computation used in quantisation. */
251    mix_pitch_and_residual(iy, X, N, K, P);
252    RESTORE_STACK;
253 }
254
255
256 /** Decode pulse vector and combine the result with the pitch vector to produce
257     the final normalised signal in the current band. */
258 void alg_unquant(celt_norm_t *X, int N, int K, celt_norm_t *P, ec_dec *dec)
259 {
260    VARDECL(int, iy);
261    SAVE_STACK;
262    ALLOC(iy, N, int);
263    decode_pulses(iy, N, K, dec);
264    mix_pitch_and_residual(iy, X, N, K, P);
265    RESTORE_STACK;
266 }
267
268 void renormalise_vector(celt_norm_t *X, celt_word16_t value, int N, int stride)
269 {
270    int i;
271    celt_word32_t E = EPSILON;
272    celt_word16_t g;
273    celt_norm_t *xptr = X;
274    for (i=0;i<N;i++)
275    {
276       E = MAC16_16(E, *xptr, *xptr);
277       xptr += stride;
278    }
279
280    g = MULT16_16_Q15(value,celt_rcp(SHL32(celt_sqrt(E),9)));
281    xptr = X;
282    for (i=0;i<N;i++)
283    {
284       *xptr = PSHR32(MULT16_16(g, *xptr),8);
285       xptr += stride;
286    }
287 }
288
289 static void fold(const CELTMode *m, int N, celt_norm_t *Y, celt_norm_t * restrict P, int N0, int B)
290 {
291    int j;
292    const int C = CHANNELS(m);
293    int id = N0 % (C*B);
294    /* Here, we assume that id will never be greater than N0, i.e. that 
295       no band is wider than N0. In the unlikely case it happens, we set
296       everything to zero */
297    if (id+C*N>N0)
298       for (j=0;j<C*N;j++)
299          P[j] = 0;
300    else
301       for (j=0;j<C*N;j++)
302          P[j] = Y[id++];
303 }
304
305 #define KGAIN 6
306
307 void intra_prediction(const CELTMode *m, celt_norm_t * restrict x, celt_mask_t *W, int N, int K, celt_norm_t *Y, celt_norm_t * restrict P, int N0, int B, ec_enc *enc)
308 {
309    int j;
310    celt_word16_t s = 1;
311    int sign;
312    celt_word16_t pred_gain;
313    celt_word32_t xy=0;
314    const int C = CHANNELS(m);
315
316    pred_gain = celt_div((celt_word32_t)MULT16_16(Q15_ONE,N),(celt_word32_t)(N+KGAIN*K));
317
318    fold(m, N, Y, P, N0, B);
319
320    for (j=0;j<C*N;j++)
321       xy = MAC16_16(xy, P[j], x[j]);
322    if (xy<0)
323    {
324       s = -1;
325       sign = 1;
326    } else {
327       s = 1;
328       sign = 0;
329    }
330    ec_enc_bits(enc,sign,1);
331
332    renormalise_vector(P, s*pred_gain, C*N, 1);
333 }
334
335 void intra_unquant(const CELTMode *m, celt_norm_t *x, int N, int K, celt_norm_t *Y, celt_norm_t * restrict P, int N0, int B, ec_dec *dec)
336 {
337    celt_word16_t s;
338    celt_word16_t pred_gain;
339    const int C = CHANNELS(m);
340       
341    if (ec_dec_bits(dec, 1) == 0)
342       s = 1;
343    else
344       s = -1;
345    
346    pred_gain = celt_div((celt_word32_t)MULT16_16(Q15_ONE,N),(celt_word32_t)(N+KGAIN*K));
347    
348    fold(m, N, Y, P, N0, B);
349    
350    renormalise_vector(P, s*pred_gain, C*N, 1);
351 }
352
353 void intra_fold(const CELTMode *m, celt_norm_t *x, int N, celt_norm_t *Y, celt_norm_t * restrict P, int N0, int B)
354 {
355    const int C = CHANNELS(m);
356
357    fold(m, N, Y, P, N0, B);
358    
359    renormalise_vector(P, Q15ONE, C*N, 1);
360 }
361