Slightly less arbitrary gains for intra prediction.
[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       if (X[j]>0)
122          signx[j]=1;
123       else
124          signx[j]=-1;
125       iy[j] = 0;
126       y[j] = 0;
127       sum = MAC16_16(sum, P[j],P[j]);
128    } while (++j<N);
129    Rpp = ROUND16(sum, NORM_SHIFT);
130
131    celt_assert2(Rpp<=NORM_SCALING, "Rpp should never have a norm greater than unity");
132
133    xy = yy = yp = 0;
134
135    pulsesLeft = K;
136    while (pulsesLeft > 0)
137    {
138       int pulsesAtOnce=1;
139       int best_id;
140       celt_word16_t magnitude;
141 #ifdef FIXED_POINT
142       int rshift;
143 #endif
144       /* Decide on how many pulses to find at once */
145       pulsesAtOnce = (pulsesLeft*N_1)>>9; /* pulsesLeft/N */
146       if (pulsesAtOnce<1)
147          pulsesAtOnce = 1;
148 #ifdef FIXED_POINT
149       rshift = yshift+1+celt_ilog2(K-pulsesLeft+pulsesAtOnce);
150 #endif
151       magnitude = SHL16(pulsesAtOnce, yshift);
152
153       best_id = 0;
154       /* The squared magnitude term gets added anyway, so we might as well 
155          add it outside the loop */
156       yy = ADD32(yy, MULT16_16(magnitude,magnitude));
157       /* Choose between fast and accurate strategy depending on where we are in the search */
158       if (pulsesLeft>1)
159       {
160          /* This should ensure that anything we can process will have a better score */
161          celt_word32_t best_num = -VERY_LARGE16;
162          celt_word16_t best_den = 0;
163          j=0;
164          do {
165             celt_word16_t Rxy, Ryy;
166             /* Select sign based on X[j] alone */
167             s = signx[j]*magnitude;
168             /* Temporary sums of the new pulse(s) */
169             Rxy = EXTRACT16(SHR32(xy + MULT16_16(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(yy + MULT16_16(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       } else {
187          celt_word16_t g;
188          celt_word16_t best_num = -VERY_LARGE16;
189          celt_word16_t best_den = 0;
190          j=0;
191          do {
192             celt_word16_t Rxy, Ryy, Ryp;
193             celt_word16_t num;
194             /* Select sign based on X[j] alone */
195             s = signx[j]*magnitude;
196             /* Temporary sums of the new pulse(s) */
197             Rxy = ROUND16(xy + MULT16_16(s,X[j]), 14);
198             /* We're multiplying y[j] by two so we don't have to do it here */
199             Ryy = ROUND16(yy + MULT16_16(s,y[j]), 14);
200             Ryp = ROUND16(yp + MULT16_16(s,P[j]), 14);
201
202             /* Compute the gain such that ||p + g*y|| = 1 
203                ...but instead, we compute g*Ryy to avoid dividing */
204             g = celt_psqrt(MULT16_16(Ryp,Ryp) + MULT16_16(Ryy,QCONST16(1.f,14)-Rpp)) - Ryp;
205             /* Knowing that gain, what's the error: (x-g*y)^2 
206                (result is negated and we discard x^2 because it's constant) */
207             /* score = 2*g*Rxy - g*g*Ryy;*/
208 #ifdef FIXED_POINT
209             /* No need to multiply Rxy by 2 because we did it earlier */
210             num = MULT16_16_Q15(ADD16(SUB16(Rxy,g),Rxy),g);
211 #else
212             num = g*(2*Rxy-g);
213 #endif
214             if (MULT16_16(best_den, num) > MULT16_16(Ryy, best_num))
215             {
216                best_den = Ryy;
217                best_num = num;
218                best_id = j;
219             }
220          } while (++j<N);
221       }
222       
223       j = best_id;
224       is = signx[j]*pulsesAtOnce;
225       s = SHL16(is, yshift);
226
227       /* Updating the sums of the new pulse(s) */
228       xy = xy + MULT16_16(s,X[j]);
229       /* We're multiplying y[j] by two so we don't have to do it here */
230       yy = yy + MULT16_16(s,y[j]);
231       yp = yp + MULT16_16(s, P[j]);
232
233       /* Only now that we've made the final choice, update y/iy */
234       /* Multiplying y[j] by 2 so we don't have to do it everywhere else */
235       y[j] += 2*s;
236       iy[j] += is;
237       pulsesLeft -= pulsesAtOnce;
238    }
239    
240    encode_pulses(iy, N, K, enc);
241    
242    /* Recompute the gain in one pass to reduce the encoder-decoder mismatch
243    due to the recursive computation used in quantisation. */
244    mix_pitch_and_residual(iy, X, N, K, P);
245    RESTORE_STACK;
246 }
247
248
249 /** Decode pulse vector and combine the result with the pitch vector to produce
250     the final normalised signal in the current band. */
251 void alg_unquant(celt_norm_t *X, int N, int K, celt_norm_t *P, ec_dec *dec)
252 {
253    VARDECL(int, iy);
254    SAVE_STACK;
255    ALLOC(iy, N, int);
256    decode_pulses(iy, N, K, dec);
257    mix_pitch_and_residual(iy, X, N, K, P);
258    RESTORE_STACK;
259 }
260
261
262 #define KGAIN 6
263
264 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 Nmax, ec_enc *enc)
265 {
266    int i,j;
267    celt_word16_t s = 1;
268    int sign;
269    celt_word32_t E;
270    celt_word16_t pred_gain;
271    celt_word32_t xy=0;
272    const int C = CHANNELS(m);
273    
274    pred_gain = celt_div((celt_word32_t)MULT16_16(Q15_ONE,N),(celt_word32_t)(N+KGAIN*K));
275    
276    E = EPSILON;
277    if (N0 >= (Nmax>>1))
278    {
279       for (i=0;i<C;i++)
280       {
281          for (j=0;j<N;j++)
282          {
283             P[j*C+i] = Y[(Nmax-N0-j-1)*C+i];
284             E += P[j*C+i]*P[j*C+i];
285          }
286       }
287    } else {
288       for (j=0;j<C*N;j++)
289       {
290          P[j] = Y[j];
291          E = MAC16_16(E, P[j],P[j]);
292       }
293    }
294    for (j=0;j<C*N;j++)
295       xy = MAC16_16(xy, P[j], x[j]);
296    if (xy<0)
297    {
298       s = -1;
299       sign = 1;
300    } else {
301       s = 1;
302       sign = 0;
303    }
304    ec_enc_bits(enc,sign,1);
305
306    /*pred_gain = pred_gain/sqrt(E);*/
307    pred_gain = s*MULT16_16_Q15(pred_gain,celt_rcp(SHL32(celt_sqrt(E),9)));
308    for (j=0;j<C*N;j++)
309       P[j] = PSHR32(MULT16_16(pred_gain, P[j]),8);
310    if (K>0)
311    {
312       for (j=0;j<C*N;j++)
313          x[j] -= P[j];
314    } else {
315       for (j=0;j<C*N;j++)
316          x[j] = P[j];
317    }
318 }
319
320 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 Nmax, ec_dec *dec)
321 {
322    int i, j;
323    celt_word16_t s;
324    celt_word32_t E;
325    celt_word16_t pred_gain;
326    const int C = CHANNELS(m);
327       
328    if (ec_dec_bits(dec, 1) == 0)
329       s = 1;
330    else
331       s = -1;
332    
333    pred_gain = celt_div((celt_word32_t)MULT16_16(Q15_ONE,N),(celt_word32_t)(N+KGAIN*K));
334    E = EPSILON;
335    if (N0 >= (Nmax>>1))
336    {
337       for (i=0;i<C;i++)
338       {
339          for (j=0;j<N;j++)
340          {
341             P[j*C+i] = Y[(Nmax-N0-j-1)*C+i];
342             E += P[j*C+i]*P[j*C+i];
343          }
344       }
345    } else {
346       for (j=0;j<C*N;j++)
347       {
348          P[j] = Y[j];
349          E = MAC16_16(E, P[j],P[j]);
350       }
351    }
352    /*pred_gain = pred_gain/sqrt(E);*/
353    pred_gain = s*MULT16_16_Q15(pred_gain,celt_rcp(SHL32(celt_sqrt(E),9)));
354    for (j=0;j<C*N;j++)
355       P[j] = PSHR32(MULT16_16(pred_gain, P[j]),8);
356    if (K==0)
357    {
358       for (j=0;j<C*N;j++)
359          x[j] = P[j];
360    }
361 }
362
363 void intra_fold(const CELTMode *m, celt_norm_t *x, int N, celt_norm_t *Y, celt_norm_t * restrict P, int N0, int Nmax)
364 {
365    int i, j;
366    celt_word32_t E;
367    celt_word16_t g;
368    const int C = CHANNELS(m);
369
370    E = EPSILON;
371    if (N0 >= (Nmax>>1))
372    {
373       for (i=0;i<C;i++)
374       {
375          for (j=0;j<N;j++)
376          {
377             P[j*C+i] = Y[(Nmax-N0-j-1)*C+i];
378             E += P[j*C+i]*P[j*C+i];
379          }
380       }
381    } else {
382       for (j=0;j<C*N;j++)
383       {
384          P[j] = Y[j];
385          E = MAC16_16(E, P[j],P[j]);
386       }
387    }
388    g = celt_rcp(SHL32(celt_sqrt(E),9));
389    for (j=0;j<C*N;j++)
390       P[j] = PSHR32(MULT16_16(g, P[j]),8);
391    for (j=0;j<C*N;j++)
392       x[j] = P[j];
393 }
394