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