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