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