This fixes a potential assertion failure with some very weak signals
[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, 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          X[j]=-X[j];
128          P[j]=-P[j];
129       }
130       iy[j] = 0;
131       y[j] = 0;
132       sum = MAC16_16(sum, P[j],P[j]);
133    } while (++j<N);
134    Rpp = ROUND16(sum, NORM_SHIFT);
135
136    celt_assert2(Rpp<=NORM_SCALING, "Rpp should never have a norm greater than unity");
137
138    xy = yy = yp = 0;
139
140    pulsesLeft = K;
141
142    /* Do a pre-search by projecting on the pyramid */
143    if (K > (N>>1))
144    {
145       celt_word16_t rcp;
146       sum=0;
147       j=0; do {
148          sum += X[j];
149       }  while (++j<N);
150
151 #ifdef FIXED_POINT
152       if (sum <= K)
153 #else
154       if (sum <= EPSILON)
155 #endif
156       {
157          X[0] = 16384;
158          j=1; do
159             X[j]=0;
160          while (++j<N);
161          sum = 16384;
162       }
163       /* Do we have sufficient accuracy here? */
164       rcp = EXTRACT16(MULT16_32_Q16(K-1, celt_rcp(sum)));
165       /*rcp = DIV32(SHL32(EXTEND32(K-1),15),EPSILON+sum);*/
166       /*printf ("%d (%d %d)\n", rcp, N, K);*/
167       j=0; do {
168 #ifdef FIXED_POINT
169          /* It's really important to round *towards zero* here */
170          iy[j] = MULT16_16_Q15(X[j],rcp);
171 #else
172          iy[j] = floor(rcp*X[j]);
173 #endif
174          y[j] = SHL16(iy[j],yshift);
175          yy = MAC16_16(yy, y[j],y[j]);
176          xy = MAC16_16(xy, X[j],y[j]);
177          yp += P[j]*y[j];
178          y[j] *= 2;
179          pulsesLeft -= iy[j];
180       }  while (++j<N);
181    }
182    /*if (pulsesLeft > N+2)
183       printf ("%d / %d (%d)\n", pulsesLeft, K, N);*/
184    celt_assert2(pulsesLeft>=1, "Allocated too many pulses in the quick pass");
185
186    while (pulsesLeft > 1)
187    {
188       int pulsesAtOnce=1;
189       int best_id;
190       celt_word16_t magnitude;
191       celt_word32_t best_num = -VERY_LARGE16;
192       celt_word16_t best_den = 0;
193 #ifdef FIXED_POINT
194       int rshift;
195 #endif
196       /* Decide on how many pulses to find at once */
197       pulsesAtOnce = (pulsesLeft*N_1)>>9; /* pulsesLeft/N */
198       if (pulsesAtOnce<1)
199          pulsesAtOnce = 1;
200 #ifdef FIXED_POINT
201       rshift = yshift+1+celt_ilog2(K-pulsesLeft+pulsesAtOnce);
202 #endif
203       magnitude = SHL16(pulsesAtOnce, yshift);
204
205       best_id = 0;
206       /* The squared magnitude term gets added anyway, so we might as well 
207          add it outside the loop */
208       yy = MAC16_16(yy, magnitude,magnitude);
209       /* Choose between fast and accurate strategy depending on where we are in the search */
210          /* This should ensure that anything we can process will have a better score */
211       j=0;
212       do {
213          celt_word16_t Rxy, Ryy;
214          /* Select sign based on X[j] alone */
215          s = magnitude;
216          /* Temporary sums of the new pulse(s) */
217          Rxy = EXTRACT16(SHR32(MAC16_16(xy, s,X[j]),rshift));
218          /* We're multiplying y[j] by two so we don't have to do it here */
219          Ryy = EXTRACT16(SHR32(MAC16_16(yy, s,y[j]),rshift));
220             
221             /* Approximate score: we maximise Rxy/sqrt(Ryy) (we're guaranteed that 
222          Rxy is positive because the sign is pre-computed) */
223          Rxy = MULT16_16_Q15(Rxy,Rxy);
224             /* The idea is to check for num/den >= best_num/best_den, but that way
225          we can do it without any division */
226          /* OPT: Make sure to use conditional moves here */
227          if (MULT16_16(best_den, Rxy) > MULT16_16(Ryy, best_num))
228          {
229             best_den = Ryy;
230             best_num = Rxy;
231             best_id = j;
232          }
233       } while (++j<N);
234       
235       j = best_id;
236       is = pulsesAtOnce;
237       s = SHL16(is, yshift);
238
239       /* Updating the sums of the new pulse(s) */
240       xy = xy + MULT16_16(s,X[j]);
241       /* We're multiplying y[j] by two so we don't have to do it here */
242       yy = yy + MULT16_16(s,y[j]);
243       yp = yp + MULT16_16(s, P[j]);
244
245       /* Only now that we've made the final choice, update y/iy */
246       /* Multiplying y[j] by 2 so we don't have to do it everywhere else */
247       y[j] += 2*s;
248       iy[j] += is;
249       pulsesLeft -= pulsesAtOnce;
250    }
251    
252    if (pulsesLeft > 0)
253    {
254       celt_word16_t g;
255       celt_word16_t best_num = -VERY_LARGE16;
256       celt_word16_t best_den = 0;
257       int best_id = 0;
258       celt_word16_t magnitude = SHL16(1, yshift);
259
260       /* The squared magnitude term gets added anyway, so we might as well 
261       add it outside the loop */
262       yy = MAC16_16(yy, magnitude,magnitude);
263       j=0;
264       do {
265          celt_word16_t Rxy, Ryy, Ryp;
266          celt_word16_t num;
267          /* Select sign based on X[j] alone */
268          s = magnitude;
269          /* Temporary sums of the new pulse(s) */
270          Rxy = ROUND16(MAC16_16(xy, s,X[j]), 14);
271          /* We're multiplying y[j] by two so we don't have to do it here */
272          Ryy = ROUND16(MAC16_16(yy, s,y[j]), 14);
273          Ryp = ROUND16(MAC16_16(yp, s,P[j]), 14);
274
275             /* Compute the gain such that ||p + g*y|| = 1 
276          ...but instead, we compute g*Ryy to avoid dividing */
277          g = celt_psqrt(MULT16_16(Ryp,Ryp) + MULT16_16(Ryy,QCONST16(1.f,14)-Rpp)) - Ryp;
278             /* Knowing that gain, what's the error: (x-g*y)^2 
279          (result is negated and we discard x^2 because it's constant) */
280          /* score = 2*g*Rxy - g*g*Ryy;*/
281 #ifdef FIXED_POINT
282          /* No need to multiply Rxy by 2 because we did it earlier */
283          num = MULT16_16_Q15(ADD16(SUB16(Rxy,g),Rxy),g);
284 #else
285          num = g*(2*Rxy-g);
286 #endif
287          if (MULT16_16(best_den, num) > MULT16_16(Ryy, best_num))
288          {
289             best_den = Ryy;
290             best_num = num;
291             best_id = j;
292          }
293       } while (++j<N);
294       iy[best_id] += 1;
295    }
296    j=0;
297    do {
298       P[j] = MULT16_16(signx[j],P[j]);
299       X[j] = MULT16_16(signx[j],X[j]);
300       if (signx[j] < 0)
301          iy[j] = -iy[j];
302    } while (++j<N);
303    encode_pulses(iy, N, K, enc);
304    
305    /* Recompute the gain in one pass to reduce the encoder-decoder mismatch
306    due to the recursive computation used in quantisation. */
307    mix_pitch_and_residual(iy, X, N, K, P);
308    RESTORE_STACK;
309 }
310
311
312 /** Decode pulse vector and combine the result with the pitch vector to produce
313     the final normalised signal in the current band. */
314 void alg_unquant(celt_norm_t *X, int N, int K, celt_norm_t *P, ec_dec *dec)
315 {
316    VARDECL(int, iy);
317    SAVE_STACK;
318    ALLOC(iy, N, int);
319    decode_pulses(iy, N, K, dec);
320    mix_pitch_and_residual(iy, X, N, K, P);
321    RESTORE_STACK;
322 }
323
324 celt_word16_t renormalise_vector(celt_norm_t *X, celt_word16_t value, int N, int stride)
325 {
326    int i;
327    celt_word32_t E = EPSILON;
328    celt_word16_t rE;
329    celt_word16_t g;
330    celt_norm_t *xptr = X;
331    for (i=0;i<N;i++)
332    {
333       E = MAC16_16(E, *xptr, *xptr);
334       xptr += stride;
335    }
336
337    rE = celt_sqrt(E);
338    g = MULT16_16_Q15(value,celt_rcp(SHL32(rE,9)));
339    xptr = X;
340    for (i=0;i<N;i++)
341    {
342       *xptr = PSHR32(MULT16_16(g, *xptr),8);
343       xptr += stride;
344    }
345    return rE;
346 }
347
348 static void fold(const CELTMode *m, int N, celt_norm_t *Y, celt_norm_t * restrict P, int N0, int B)
349 {
350    int j;
351    const int C = CHANNELS(m);
352    int id = (N0*C) % (C*B);
353    /* Here, we assume that id will never be greater than N0, i.e. that 
354       no band is wider than N0. In the unlikely case it happens, we set
355       everything to zero */
356    if (id+C*N>N0*C)
357       for (j=0;j<C*N;j++)
358          P[j] = 0;
359    else
360       for (j=0;j<C*N;j++)
361          P[j] = Y[id++];
362 }
363
364 #define KGAIN 6
365
366 void intra_fold(const CELTMode *m, celt_norm_t * restrict x, int N, int K, celt_norm_t *Y, celt_norm_t * restrict P, int N0, int B)
367 {
368    celt_word16_t pred_gain;
369    const int C = CHANNELS(m);
370
371    if (K==0)
372       pred_gain = Q15ONE;
373    else
374       pred_gain = celt_div((celt_word32_t)MULT16_16(Q15_ONE,N),(celt_word32_t)(N+KGAIN*K));
375
376    fold(m, N, Y, P, N0, B);
377
378    renormalise_vector(P, pred_gain, C*N, 1);
379 }
380